From cbf05470ad5f27968df275493809202e433fe488 Mon Sep 17 00:00:00 2001 From: Jeffrey Aven Date: Thu, 2 May 2024 18:18:47 +1000 Subject: [PATCH 1/2] new aws --- .github/workflows/build-docs.yaml | 2 +- README.md | 1 - ci-scripts/get-providers-to-deploy.js | 1 - docs/aws-docs/index.md | 380 ++++++++++++++---- .../aws/accessanalyzer/analyzer/index.md | 104 +++++ .../aws/accessanalyzer/analyzers/index.md | 81 ++++ .../providers/aws/accessanalyzer/index.md | 39 ++ .../providers/aws/acmpca/certificate/index.md | 98 +++++ .../acmpca/certificate_authorities/index.md | 82 ++++ .../aws/acmpca/certificate_authority/index.md | 113 ++++++ .../certificate_authority_activation/index.md | 97 +++++ .../index.md | 68 ++++ .../aws/acmpca/certificates/index.md | 70 ++++ docs/aws-docs/providers/aws/acmpca/index.md | 45 +++ .../providers/aws/acmpca/permission/index.md | 83 ++++ .../providers/aws/acmpca/permissions/index.md | 70 ++++ .../providers/aws/amplify/app/index.md | 144 +++++++ .../providers/aws/amplify/apps/index.md | 88 ++++ .../providers/aws/amplify/branch/index.md | 141 +++++++ .../providers/aws/amplify/branches/index.md | 92 +++++ .../providers/aws/amplify/domain/index.md | 122 ++++++ .../providers/aws/amplify/domains/index.md | 83 ++++ docs/aws-docs/providers/aws/amplify/index.md | 43 ++ .../aws/amplifyuibuilder/component/index.md | 127 ++++++ .../aws/amplifyuibuilder/components/index.md | 85 ++++ .../aws/amplifyuibuilder/form/index.md | 120 ++++++ .../aws/amplifyuibuilder/forms/index.md | 86 ++++ .../providers/aws/amplifyuibuilder/index.md | 43 ++ .../aws/amplifyuibuilder/theme/index.md | 110 +++++ .../aws/amplifyuibuilder/themes/index.md | 85 ++++ .../providers/aws/apigateway/account/index.md | 86 ++++ .../aws/apigateway/accounts/index.md | 69 ++++ .../providers/aws/apigateway/api_key/index.md | 107 +++++ .../aws/apigateway/api_keys/index.md | 79 ++++ .../aws/apigateway/authorizer/index.md | 109 +++++ .../aws/apigateway/authorizers/index.md | 80 ++++ .../aws/apigateway/base_path_mapping/index.md | 95 +++++ .../apigateway/base_path_mappings/index.md | 80 ++++ .../apigateway/client_certificate/index.md | 94 +++++ .../apigateway/client_certificates/index.md | 79 ++++ .../aws/apigateway/deployment/index.md | 101 +++++ .../aws/apigateway/deployments/index.md | 82 ++++ .../apigateway/documentation_part/index.md | 94 +++++ .../apigateway/documentation_parts/index.md | 80 ++++ .../apigateway/documentation_version/index.md | 92 +++++ .../documentation_versions/index.md | 80 ++++ .../aws/apigateway/domain_name/index.md | 109 +++++ .../aws/apigateway/domain_names/index.md | 77 ++++ .../providers/aws/apigateway/index.md | 73 ++++ .../providers/aws/apigateway/method/index.md | 114 ++++++ .../providers/aws/apigateway/methods/index.md | 73 ++++ .../providers/aws/apigateway/model/index.md | 97 +++++ .../providers/aws/apigateway/models/index.md | 80 ++++ .../aws/apigateway/request_validator/index.md | 96 +++++ .../apigateway/request_validators/index.md | 80 ++++ .../aws/apigateway/resource/index.md | 94 +++++ .../aws/apigateway/resources/index.md | 79 ++++ .../aws/apigateway/rest_api/index.md | 125 ++++++ .../aws/apigateway/rest_apis/index.md | 83 ++++ .../providers/aws/apigateway/stage/index.md | 116 ++++++ .../providers/aws/apigateway/stages/index.md | 82 ++++ .../aws/apigateway/usage_plan/index.md | 104 +++++ .../aws/apigateway/usage_plan_key/index.md | 84 ++++ .../aws/apigateway/usage_plan_keys/index.md | 78 ++++ .../aws/apigateway/usage_plans/index.md | 79 ++++ .../aws/apigateway/vpc_link/index.md | 111 +++++ .../aws/apigateway/vpc_links/index.md | 87 ++++ .../providers/aws/apigatewayv2/api/index.md | 130 ++++++ .../aws/apigatewayv2/api_mapping/index.md | 97 +++++ .../aws/apigatewayv2/api_mappings/index.md | 79 ++++ .../providers/aws/apigatewayv2/apis/index.md | 80 ++++ .../aws/apigatewayv2/authorizer/index.md | 113 ++++++ .../aws/apigatewayv2/authorizers/index.md | 80 ++++ .../aws/apigatewayv2/deployment/index.md | 96 +++++ .../aws/apigatewayv2/deployments/index.md | 79 ++++ .../aws/apigatewayv2/domain_name/index.md | 100 +++++ .../aws/apigatewayv2/domain_names/index.md | 79 ++++ .../providers/aws/apigatewayv2/index.md | 57 +++ .../integration_response/index.md | 104 +++++ .../integration_responses/index.md | 81 ++++ .../providers/aws/apigatewayv2/model/index.md | 100 +++++ .../aws/apigatewayv2/models/index.md | 79 ++++ .../providers/aws/apigatewayv2/route/index.md | 114 ++++++ .../aws/apigatewayv2/route_response/index.md | 102 +++++ .../aws/apigatewayv2/route_responses/index.md | 81 ++++ .../aws/apigatewayv2/routes/index.md | 79 ++++ .../aws/apigatewayv2/vpc_link/index.md | 108 +++++ .../aws/apigatewayv2/vpc_links/index.md | 85 ++++ .../aws/appconfig/application/index.md | 97 +++++ .../aws/appconfig/applications/index.md | 80 ++++ .../appconfig/configuration_profile/index.md | 111 +++++ .../appconfig/configuration_profiles/index.md | 83 ++++ .../aws/appconfig/environment/index.md | 102 +++++ .../aws/appconfig/environments/index.md | 83 ++++ .../aws/appconfig/extension/index.md | 106 +++++ .../appconfig/extension_association/index.md | 106 +++++ .../appconfig/extension_associations/index.md | 78 ++++ .../aws/appconfig/extensions/index.md | 79 ++++ .../hosted_configuration_version/index.md | 91 +++++ .../hosted_configuration_versions/index.md | 81 ++++ .../aws-docs/providers/aws/appconfig/index.md | 49 +++ .../providers/aws/appflow/connector/index.md | 96 +++++ .../aws/appflow/connector_profile/index.md | 110 +++++ .../aws/appflow/connector_profiles/index.md | 86 ++++ .../providers/aws/appflow/connectors/index.md | 78 ++++ .../providers/aws/appflow/flow/index.md | 121 ++++++ .../providers/aws/appflow/flows/index.md | 92 +++++ docs/aws-docs/providers/aws/appflow/index.md | 43 ++ .../aws/appintegrations/application/index.md | 104 +++++ .../aws/appintegrations/applications/index.md | 79 ++++ .../appintegrations/data_integration/index.md | 132 ++++++ .../data_integrations/index.md | 93 +++++ .../event_integration/index.md | 101 +++++ .../event_integrations/index.md | 78 ++++ .../providers/aws/appintegrations/index.md | 43 ++ .../aws/applicationautoscaling/index.md | 41 ++ .../scalable_target/index.md | 114 ++++++ .../scalable_targets/index.md | 92 +++++ .../scaling_policies/index.md | 80 ++++ .../scaling_policy/index.md | 105 +++++ .../applicationinsights/application/index.md | 109 +++++ .../applicationinsights/applications/index.md | 77 ++++ .../aws/applicationinsights/index.md | 39 ++ .../auto_scaling_configuration/index.md | 91 +++++ .../auto_scaling_configurations/index.md | 79 ++++ .../aws-docs/providers/aws/apprunner/index.md | 47 +++ .../observability_configuration/index.md | 87 ++++ .../observability_configurations/index.md | 79 ++++ .../providers/aws/apprunner/service/index.md | 112 ++++++ .../providers/aws/apprunner/services/index.md | 88 ++++ .../aws/apprunner/vpc_connector/index.md | 87 ++++ .../aws/apprunner/vpc_connectors/index.md | 82 ++++ .../apprunner/vpc_ingress_connection/index.md | 99 +++++ .../vpc_ingress_connections/index.md | 82 ++++ .../aws/appstream/app_block/index.md | 95 +++++ .../aws/appstream/app_block_builder/index.md | 124 ++++++ .../aws/appstream/app_block_builders/index.md | 83 ++++ .../aws/appstream/app_blocks/index.md | 71 ++++ .../aws/appstream/application/index.md | 114 ++++++ .../index.md | 82 ++++ .../index.md | 72 ++++ .../application_fleet_association/index.md | 80 ++++ .../application_fleet_associations/index.md | 70 ++++ .../aws/appstream/applications/index.md | 69 ++++ .../aws/appstream/directory_config/index.md | 111 +++++ .../aws/appstream/directory_configs/index.md | 89 ++++ .../aws/appstream/entitlement/index.md | 99 +++++ .../aws/appstream/entitlements/index.md | 69 ++++ .../aws/appstream/image_builder/index.md | 121 ++++++ .../aws/appstream/image_builders/index.md | 95 +++++ .../aws-docs/providers/aws/appstream/index.md | 53 +++ .../aws/appsync/domain_name/index.md | 96 +++++ .../domain_name_api_association/index.md | 93 +++++ .../domain_name_api_associations/index.md | 68 ++++ .../aws/appsync/domain_names/index.md | 80 ++++ .../appsync/function_configuration/index.md | 118 ++++++ .../appsync/function_configurations/index.md | 78 ++++ docs/aws-docs/providers/aws/appsync/index.md | 47 +++ .../providers/aws/appsync/resolver/index.md | 122 ++++++ .../providers/aws/appsync/resolvers/index.md | 79 ++++ .../appsync/source_api_association/index.md | 117 ++++++ .../appsync/source_api_associations/index.md | 79 ++++ docs/aws-docs/providers/aws/aps/index.md | 43 ++ .../aws/aps/rule_groups_namespace/index.md | 101 +++++ .../aws/aps/rule_groups_namespaces/index.md | 80 ++++ .../providers/aws/aps/scraper/index.md | 112 ++++++ .../providers/aws/aps/scrapers/index.md | 87 ++++ .../providers/aws/aps/workspace/index.md | 125 ++++++ .../providers/aws/aps/workspaces/index.md | 90 +++++ .../providers/aws/arczonalshift/index.md | 39 ++ .../zonal_autoshift_configuration/index.md | 96 +++++ .../zonal_autoshift_configurations/index.md | 81 ++++ .../aws/athena/capacity_reservation/index.md | 111 +++++ .../aws/athena/capacity_reservations/index.md | 81 ++++ .../aws/athena/data_catalog/index.md | 100 +++++ .../aws/athena/data_catalogs/index.md | 78 ++++ docs/aws-docs/providers/aws/athena/index.md | 47 +++ .../aws/athena/named_queries/index.md | 77 ++++ .../providers/aws/athena/named_query/index.md | 87 ++++ .../aws/athena/prepared_statement/index.md | 94 +++++ .../aws/athena/prepared_statements/index.md | 80 ++++ .../providers/aws/athena/work_group/index.md | 116 ++++++ .../providers/aws/athena/work_groups/index.md | 88 ++++ .../aws/auditmanager/assessment/index.md | 114 ++++++ .../aws/auditmanager/assessments/index.md | 81 ++++ .../providers/aws/auditmanager/index.md | 39 ++ .../autoscaling/auto_scaling_group/index.md | 177 ++++++++ .../autoscaling/auto_scaling_groups/index.md | 93 +++++ .../providers/aws/autoscaling/index.md | 49 +++ .../autoscaling/launch_configuration/index.md | 114 ++++++ .../launch_configurations/index.md | 79 ++++ .../aws/autoscaling/lifecycle_hook/index.md | 104 +++++ .../aws/autoscaling/lifecycle_hooks/index.md | 81 ++++ .../aws/autoscaling/scaling_policies/index.md | 79 ++++ .../aws/autoscaling/scaling_policy/index.md | 114 ++++++ .../aws/autoscaling/scheduled_action/index.md | 104 +++++ .../autoscaling/scheduled_actions/index.md | 80 ++++ .../aws/autoscaling/warm_pool/index.md | 98 +++++ .../aws/autoscaling/warm_pools/index.md | 69 ++++ .../providers/aws/b2bi/capabilities/index.md | 92 +++++ .../providers/aws/b2bi/capability/index.md | 106 +++++ docs/aws-docs/providers/aws/b2bi/index.md | 45 +++ .../providers/aws/b2bi/partnership/index.md | 110 +++++ .../providers/aws/b2bi/partnerships/index.md | 79 ++++ .../providers/aws/b2bi/profile/index.md | 112 ++++++ .../providers/aws/b2bi/profiles/index.md | 87 ++++ .../providers/aws/b2bi/transformer/index.md | 112 ++++++ .../providers/aws/b2bi/transformers/index.md | 88 ++++ .../providers/aws/backup/backup_plan/index.md | 100 +++++ .../aws/backup/backup_plans/index.md | 79 ++++ .../aws/backup/backup_selection/index.md | 84 ++++ .../aws/backup/backup_selections/index.md | 80 ++++ .../aws/backup/backup_vault/index.md | 111 +++++ .../aws/backup/backup_vaults/index.md | 88 ++++ .../providers/aws/backup/framework/index.md | 107 +++++ .../providers/aws/backup/frameworks/index.md | 81 ++++ docs/aws-docs/providers/aws/backup/index.md | 51 +++ .../providers/aws/backup/report_plan/index.md | 103 +++++ .../aws/backup/report_plans/index.md | 81 ++++ .../aws/backup/restore_testing_plan/index.md | 105 +++++ .../aws/backup/restore_testing_plans/index.md | 80 ++++ .../backup/restore_testing_selection/index.md | 104 +++++ .../restore_testing_selections/index.md | 81 ++++ .../aws/backupgateway/hypervisor/index.md | 108 +++++ .../aws/backupgateway/hypervisors/index.md | 83 ++++ .../providers/aws/backupgateway/index.md | 39 ++ .../aws/batch/compute_environment/index.md | 116 ++++++ .../aws/batch/compute_environments/index.md | 82 ++++ docs/aws-docs/providers/aws/batch/index.md | 43 ++ .../providers/aws/batch/job_queue/index.md | 106 +++++ .../providers/aws/batch/job_queues/index.md | 79 ++++ .../aws/batch/scheduling_policies/index.md | 79 ++++ .../aws/batch/scheduling_policy/index.md | 96 +++++ .../aws/bcmdataexports/export/index.md | 96 +++++ .../aws/bcmdataexports/exports/index.md | 81 ++++ .../providers/aws/bcmdataexports/index.md | 39 ++ .../providers/aws/bedrock/agent/index.md | 151 +++++++ .../aws/bedrock/agent_alias/index.md | 114 ++++++ .../aws/bedrock/agent_aliases/index.md | 84 ++++ .../providers/aws/bedrock/agents/index.md | 88 ++++ .../aws/bedrock/data_source/index.md | 107 +++++ .../aws/bedrock/data_sources/index.md | 81 ++++ docs/aws-docs/providers/aws/bedrock/index.md | 45 +++ .../aws/bedrock/knowledge_base/index.md | 118 ++++++ .../aws/bedrock/knowledge_bases/index.md | 82 ++++ .../billingconductor/billing_group/index.md | 122 ++++++ .../billingconductor/billing_groups/index.md | 84 ++++ .../custom_line_item/index.md | 124 ++++++ .../custom_line_items/index.md | 83 ++++ .../providers/aws/billingconductor/index.md | 45 +++ .../billingconductor/pricing_plan/index.md | 111 +++++ .../billingconductor/pricing_plans/index.md | 83 ++++ .../billingconductor/pricing_rule/index.md | 121 ++++++ .../billingconductor/pricing_rules/index.md | 81 ++++ .../aws/budgets/budgets_action/index.md | 104 +++++ .../aws/budgets/budgets_actions/index.md | 81 ++++ docs/aws-docs/providers/aws/budgets/index.md | 39 ++ .../aws-docs/providers/aws/cassandra/index.md | 41 ++ .../providers/aws/cassandra/keyspace/index.md | 102 +++++ .../aws/cassandra/keyspaces/index.md | 84 ++++ .../providers/aws/cassandra/table/index.md | 153 +++++++ .../providers/aws/cassandra/tables/index.md | 107 +++++ .../providers/aws/ce/anomaly_monitor/index.md | 105 +++++ .../aws/ce/anomaly_monitors/index.md | 78 ++++ .../aws/ce/anomaly_subscription/index.md | 103 +++++ .../aws/ce/anomaly_subscriptions/index.md | 78 ++++ .../providers/aws/ce/cost_categories/index.md | 77 ++++ .../providers/aws/ce/cost_category/index.md | 99 +++++ docs/aws-docs/providers/aws/ce/index.md | 43 ++ .../aws/certificatemanager/account/index.md | 91 +++++ .../aws/certificatemanager/accounts/index.md | 68 ++++ .../providers/aws/certificatemanager/index.md | 39 ++ docs/aws-docs/providers/aws/chatbot/index.md | 41 ++ .../index.md | 107 +++++ .../index.md | 79 ++++ .../slack_channel_configuration/index.md | 104 +++++ .../slack_channel_configurations/index.md | 79 ++++ .../aws/cleanrooms/analysis_template/index.md | 120 ++++++ .../cleanrooms/analysis_templates/index.md | 83 ++++ .../aws/cleanrooms/collaboration/index.md | 119 ++++++ .../aws/cleanrooms/collaborations/index.md | 83 ++++ .../aws/cleanrooms/configured_table/index.md | 135 +++++++ .../configured_table_association/index.md | 111 +++++ .../configured_table_associations/index.md | 84 ++++ .../aws/cleanrooms/configured_tables/index.md | 93 +++++ .../providers/aws/cleanrooms/index.md | 49 +++ .../aws/cleanrooms/membership/index.md | 129 ++++++ .../aws/cleanrooms/memberships/index.md | 91 +++++ .../privacy_budget_template/index.md | 114 ++++++ .../privacy_budget_templates/index.md | 83 ++++ .../providers/aws/cleanroomsml/index.md | 39 ++ .../cleanroomsml/training_dataset/index.md | 100 +++++ .../cleanroomsml/training_datasets/index.md | 80 ++++ .../providers/aws/cloud_control/index.md | 2 +- .../hook_default_version/index.md | 88 ++++ .../hook_default_versions/index.md | 77 ++++ .../cloudformation/hook_type_config/index.md | 95 +++++ .../cloudformation/hook_type_configs/index.md | 78 ++++ .../aws/cloudformation/hook_version/index.md | 94 +++++ .../aws/cloudformation/hook_versions/index.md | 84 ++++ .../providers/aws/cloudformation/index.md | 61 +++ .../module_default_version/index.md | 76 ++++ .../module_default_versions/index.md | 78 ++++ .../cloudformation/module_version/index.md | 96 +++++ .../cloudformation/module_versions/index.md | 72 ++++ .../public_type_version/index.md | 87 ++++ .../public_type_versions/index.md | 82 ++++ .../aws/cloudformation/publisher/index.md | 82 ++++ .../aws/cloudformation/publishers/index.md | 80 ++++ .../resource_default_version/index.md | 93 +++++ .../resource_default_versions/index.md | 77 ++++ .../cloudformation/resource_version/index.md | 96 +++++ .../cloudformation/resource_versions/index.md | 85 ++++ .../aws/cloudformation/stack/index.md | 138 +++++++ .../aws/cloudformation/stack_set/index.md | 134 ++++++ .../aws/cloudformation/stack_sets/index.md | 86 ++++ .../aws/cloudformation/stacks/index.md | 79 ++++ .../cloudformation/type_activation/index.md | 110 +++++ .../cloudformation/type_activations/index.md | 79 ++++ .../aws/cloudfront/cache_policies/index.md | 77 ++++ .../aws/cloudfront/cache_policy/index.md | 93 +++++ .../index.md | 77 ++++ .../index.md | 93 +++++ .../continuous_deployment_policies/index.md | 77 ++++ .../continuous_deployment_policy/index.md | 93 +++++ .../aws/cloudfront/distribution/index.md | 102 +++++ .../aws/cloudfront/distributions/index.md | 81 ++++ .../aws/cloudfront/function/index.md | 103 +++++ .../aws/cloudfront/functions/index.md | 79 ++++ .../providers/aws/cloudfront/index.md | 63 +++ .../aws/cloudfront/key_group/index.md | 93 +++++ .../aws/cloudfront/key_groups/index.md | 77 ++++ .../aws/cloudfront/key_value_store/index.md | 99 +++++ .../aws/cloudfront/key_value_stores/index.md | 81 ++++ .../monitoring_subscription/index.md | 79 ++++ .../monitoring_subscriptions/index.md | 67 +++ .../cloudfront/origin_access_control/index.md | 91 +++++ .../origin_access_controls/index.md | 77 ++++ .../origin_request_policies/index.md | 77 ++++ .../cloudfront/origin_request_policy/index.md | 93 +++++ .../aws/cloudfront/public_key/index.md | 93 +++++ .../aws/cloudfront/public_keys/index.md | 77 ++++ .../cloudfront/realtime_log_config/index.md | 98 +++++ .../cloudfront/realtime_log_configs/index.md | 78 ++++ .../response_headers_policies/index.md | 77 ++++ .../response_headers_policy/index.md | 93 +++++ .../providers/aws/cloudhsm/backups/index.md | 48 +++ .../providers/aws/cloudhsm/clusters/index.md | 52 +++ .../providers/aws/cloudhsm/hsm/index.md | 33 ++ docs/aws-docs/providers/aws/cloudhsm/index.md | 49 +++ .../providers/aws/cloudhsm/tags/index.md | 37 ++ .../providers/aws/cloudtrail/channel/index.md | 99 +++++ .../aws/cloudtrail/channels/index.md | 78 ++++ .../aws/cloudtrail/event_data_store/index.md | 150 +++++++ .../aws/cloudtrail/event_data_stores/index.md | 95 +++++ .../providers/aws/cloudtrail/index.md | 45 +++ .../aws/cloudtrail/resource_policies/index.md | 68 ++++ .../aws/cloudtrail/resource_policy/index.md | 90 +++++ .../providers/aws/cloudtrail/trail/index.md | 139 +++++++ .../providers/aws/cloudtrail/trails/index.md | 92 +++++ .../providers/aws/cloudwatch/alarm/index.md | 136 +++++++ .../providers/aws/cloudwatch/alarms/index.md | 79 ++++ .../aws/cloudwatch/composite_alarm/index.md | 114 ++++++ .../aws/cloudwatch/composite_alarms/index.md | 79 ++++ .../providers/aws/cloudwatch/index.md | 43 ++ .../aws/cloudwatch/metric_stream/index.md | 116 ++++++ .../aws/cloudwatch/metric_streams/index.md | 80 ++++ .../providers/aws/cloudwatch_api/index.md | 46 +++ .../aws/cloudwatch_api/log_events/index.md | 36 ++ .../aws/codeartifact/domain/index.md | 106 +++++ .../aws/codeartifact/domains/index.md | 81 ++++ .../providers/aws/codeartifact/index.md | 43 ++ .../aws/codeartifact/package_group/index.md | 110 +++++ .../aws/codeartifact/package_groups/index.md | 83 ++++ .../aws/codeartifact/repositories/index.md | 82 ++++ .../aws/codeartifact/repository/index.md | 116 ++++++ .../providers/aws/codebuild/fleet/index.md | 99 +++++ .../providers/aws/codebuild/fleets/index.md | 78 ++++ .../aws-docs/providers/aws/codebuild/index.md | 39 ++ .../aws/codeconnections/connection/index.md | 102 +++++ .../aws/codeconnections/connections/index.md | 79 ++++ .../providers/aws/codeconnections/index.md | 39 ++ .../aws/codedeploy/application/index.md | 94 +++++ .../aws/codedeploy/applications/index.md | 78 ++++ .../aws/codedeploy/deployment_config/index.md | 86 ++++ .../codedeploy/deployment_configs/index.md | 77 ++++ .../providers/aws/codedeploy/index.md | 41 ++ .../providers/aws/codeguruprofiler/index.md | 39 ++ .../codeguruprofiler/profiling_group/index.md | 107 +++++ .../profiling_groups/index.md | 82 ++++ .../providers/aws/codegurureviewer/index.md | 39 ++ .../repository_association/index.md | 96 +++++ .../repository_associations/index.md | 92 +++++ .../codepipeline/custom_action_type/index.md | 107 +++++ .../codepipeline/custom_action_types/index.md | 83 ++++ .../providers/aws/codepipeline/index.md | 39 ++ .../codestarconnections/connection/index.md | 102 +++++ .../codestarconnections/connections/index.md | 79 ++++ .../aws/codestarconnections/index.md | 43 ++ .../repository_link/index.md | 111 +++++ .../repository_links/index.md | 83 ++++ .../sync_configuration/index.md | 110 +++++ .../sync_configurations/index.md | 82 ++++ .../aws/codestarnotifications/index.md | 39 ++ .../notification_rule/index.md | 110 +++++ .../notification_rules/index.md | 77 ++++ .../aws/cognito/identity_pool/index.md | 115 ++++++ .../identity_pool_principal_tag/index.md | 95 +++++ .../identity_pool_principal_tags/index.md | 80 ++++ .../identity_pool_role_attachment/index.md | 96 +++++ .../identity_pool_role_attachments/index.md | 79 ++++ .../aws/cognito/identity_pools/index.md | 80 ++++ docs/aws-docs/providers/aws/cognito/index.md | 57 +++ .../log_delivery_configuration/index.md | 109 +++++ .../log_delivery_configurations/index.md | 76 ++++ .../providers/aws/cognito/user_pool/index.md | 148 +++++++ .../aws/cognito/user_pool_client/index.md | 139 +++++++ .../aws/cognito/user_pool_clients/index.md | 82 ++++ .../aws/cognito/user_pool_group/index.md | 99 +++++ .../aws/cognito/user_pool_groups/index.md | 82 ++++ .../index.md | 98 +++++ .../index.md | 71 ++++ .../aws/cognito/user_pool_user/index.md | 91 +++++ .../index.md | 82 ++++ .../index.md | 72 ++++ .../aws/cognito/user_pool_users/index.md | 81 ++++ .../providers/aws/cognito/user_pools/index.md | 82 ++++ .../comprehend/document_classifier/index.md | 121 ++++++ .../comprehend/document_classifiers/index.md | 82 ++++ .../aws/comprehend/flywheel/index.md | 110 +++++ .../aws/comprehend/flywheels/index.md | 80 ++++ .../providers/aws/comprehend/index.md | 41 ++ .../config/aggregation_authorization/index.md | 99 +++++ .../aggregation_authorizations/index.md | 81 ++++ .../providers/aws/config/config_rule/index.md | 108 +++++ .../aws/config/config_rules/index.md | 78 ++++ .../config/configuration_aggregator/index.md | 104 +++++ .../config/configuration_aggregators/index.md | 82 ++++ .../aws/config/conformance_pack/index.md | 105 +++++ .../aws/config/conformance_packs/index.md | 83 ++++ docs/aws-docs/providers/aws/config/index.md | 49 +++ .../organization_conformance_pack/index.md | 110 +++++ .../organization_conformance_packs/index.md | 86 ++++ .../aws/config/stored_queries/index.md | 79 ++++ .../aws/config/stored_query/index.md | 103 +++++ .../aws/connect/approved_origin/index.md | 85 ++++ .../aws/connect/approved_origins/index.md | 80 ++++ .../aws/connect/contact_flow/index.md | 105 +++++ .../aws/connect/contact_flow_module/index.md | 105 +++++ .../aws/connect/contact_flow_modules/index.md | 78 ++++ .../aws/connect/contact_flows/index.md | 78 ++++ .../aws/connect/evaluation_form/index.md | 108 +++++ .../aws/connect/evaluation_forms/index.md | 79 ++++ .../aws/connect/hours_of_operation/index.md | 102 +++++ .../aws/connect/hours_of_operations/index.md | 78 ++++ docs/aws-docs/providers/aws/connect/index.md | 81 ++++ .../providers/aws/connect/instance/index.md | 117 ++++++ .../connect/instance_storage_config/index.md | 119 ++++++ .../connect/instance_storage_configs/index.md | 92 +++++ .../providers/aws/connect/instances/index.md | 92 +++++ .../connect/integration_association/index.md | 108 +++++ .../connect/integration_associations/index.md | 112 ++++++ .../aws/connect/predefined_attribute/index.md | 95 +++++ .../connect/predefined_attributes/index.md | 79 ++++ .../providers/aws/connect/prompt/index.md | 99 +++++ .../providers/aws/connect/prompts/index.md | 81 ++++ .../providers/aws/connect/queue/index.md | 117 ++++++ .../providers/aws/connect/queues/index.md | 79 ++++ .../aws/connect/quick_connect/index.md | 103 +++++ .../aws/connect/quick_connects/index.md | 78 ++++ .../aws/connect/routing_profile/index.md | 114 ++++++ .../aws/connect/routing_profiles/index.md | 79 ++++ .../providers/aws/connect/rule/index.md | 107 +++++ .../providers/aws/connect/rules/index.md | 70 ++++ .../aws/connect/security_key/index.md | 86 ++++ .../aws/connect/security_keys/index.md | 79 ++++ .../aws/connect/security_profile/index.md | 116 ++++++ .../aws/connect/security_profiles/index.md | 78 ++++ .../aws/connect/task_template/index.md | 111 +++++ .../aws/connect/task_templates/index.md | 78 ++++ .../traffic_distribution_group/index.md | 102 +++++ .../traffic_distribution_groups/index.md | 79 ++++ .../providers/aws/connect/user/index.md | 120 ++++++ .../aws/connect/user_hierarchy_group/index.md | 98 +++++ .../connect/user_hierarchy_groups/index.md | 78 ++++ .../providers/aws/connect/users/index.md | 79 ++++ .../providers/aws/connect/view/index.md | 107 +++++ .../aws/connect/view_version/index.md | 90 +++++ .../aws/connect/view_versions/index.md | 77 ++++ .../providers/aws/connect/views/index.md | 78 ++++ .../aws/connectcampaigns/campaign/index.md | 102 +++++ .../aws/connectcampaigns/campaigns/index.md | 82 ++++ .../providers/aws/connectcampaigns/index.md | 39 ++ .../controltower/enabled_baseline/index.md | 148 +++++++ .../controltower/enabled_baselines/index.md | 103 +++++ .../aws/controltower/enabled_control/index.md | 116 ++++++ .../controltower/enabled_controls/index.md | 90 +++++ .../providers/aws/controltower/index.md | 43 ++ .../aws/controltower/landing_zone/index.md | 154 +++++++ .../aws/controltower/landing_zones/index.md | 107 +++++ docs/aws-docs/providers/aws/cur/index.md | 39 ++ .../aws/cur/report_definition/index.md | 111 +++++ .../aws/cur/report_definitions/index.md | 77 ++++ .../calculated_attribute_definition/index.md | 108 +++++ .../calculated_attribute_definitions/index.md | 80 ++++ .../aws/customerprofiles/domain/index.md | 108 +++++ .../aws/customerprofiles/domains/index.md | 78 ++++ .../customerprofiles/event_stream/index.md | 106 +++++ .../customerprofiles/event_streams/index.md | 82 ++++ .../providers/aws/customerprofiles/index.md | 47 +++ .../aws/customerprofiles/integration/index.md | 121 ++++++ .../customerprofiles/integrations/index.md | 88 ++++ .../aws/customerprofiles/object_type/index.md | 114 ++++++ .../customerprofiles/object_types/index.md | 81 ++++ .../providers/aws/databrew/dataset/index.md | 101 +++++ .../providers/aws/databrew/datasets/index.md | 84 ++++ docs/aws-docs/providers/aws/databrew/index.md | 49 +++ .../providers/aws/databrew/job/index.md | 129 ++++++ .../providers/aws/databrew/jobs/index.md | 83 ++++ .../providers/aws/databrew/project/index.md | 100 +++++ .../providers/aws/databrew/projects/index.md | 82 ++++ .../providers/aws/databrew/recipe/index.md | 95 +++++ .../providers/aws/databrew/recipes/index.md | 82 ++++ .../providers/aws/databrew/ruleset/index.md | 97 +++++ .../providers/aws/databrew/rulesets/index.md | 82 ++++ .../providers/aws/databrew/schedule/index.md | 95 +++++ .../providers/aws/databrew/schedules/index.md | 82 ++++ .../providers/aws/datapipeline/index.md | 39 ++ .../aws/datapipeline/pipeline/index.md | 115 ++++++ .../aws/datapipeline/pipelines/index.md | 84 ++++ .../providers/aws/datasync/agent/index.md | 106 +++++ .../providers/aws/datasync/agents/index.md | 84 ++++ docs/aws-docs/providers/aws/datasync/index.md | 60 +++ .../aws/datasync/location_azure_blob/index.md | 110 +++++ .../datasync/location_azure_blobs/index.md | 80 ++++ .../aws/datasync/location_efs/index.md | 107 +++++ .../aws/datasync/location_hdfs/index.md | 120 ++++++ .../aws/datasync/location_nfs/index.md | 104 +++++ .../datasync/location_object_storage/index.md | 114 ++++++ .../location_object_storages/index.md | 80 ++++ .../aws/datasync/location_s3/index.md | 103 +++++ .../aws/datasync/location_s3s/index.md | 84 ++++ .../aws/datasync/location_smb/index.md | 110 +++++ .../aws/datasync/location_smbs/index.md | 80 ++++ .../aws/datasync/locationf_sx_lustre/index.md | 101 +++++ .../datasync/locationf_sx_lustres/index.md | 84 ++++ .../aws/datasync/locationf_sx_ontap/index.md | 105 +++++ .../aws/datasync/locationf_sx_ontaps/index.md | 85 ++++ .../datasync/locationf_sx_open_zfs/index.md | 103 +++++ .../datasync/locationf_sx_windows/index.md | 107 +++++ .../aws/datasync/storage_system/index.md | 116 ++++++ .../aws/datasync/storage_systems/index.md | 83 ++++ .../providers/aws/datasync/task/index.md | 130 ++++++ .../providers/aws/datasync/tasks/index.md | 97 +++++ .../aws/datazone/data_source/index.md | 132 ++++++ .../aws/datazone/data_sources/index.md | 82 ++++ .../providers/aws/datazone/domain/index.md | 118 ++++++ .../providers/aws/datazone/domains/index.md | 83 ++++ .../aws/datazone/environment/index.md | 126 ++++++ .../index.md | 109 +++++ .../index.md | 82 ++++ .../aws/datazone/environment_profile/index.md | 117 ++++++ .../datazone/environment_profiles/index.md | 80 ++++ .../aws/datazone/environments/index.md | 81 ++++ docs/aws-docs/providers/aws/datazone/index.md | 51 +++ .../providers/aws/datazone/project/index.md | 105 +++++ .../providers/aws/datazone/projects/index.md | 80 ++++ .../aws/datazone/subscription_target/index.md | 121 ++++++ .../datazone/subscription_targets/index.md | 83 ++++ .../providers/aws/deadline/farm/index.md | 112 ++++++ .../providers/aws/deadline/farms/index.md | 83 ++++ .../providers/aws/deadline/fleet/index.md | 115 ++++++ .../providers/aws/deadline/fleets/index.md | 84 ++++ docs/aws-docs/providers/aws/deadline/index.md | 53 +++ .../aws/deadline/license_endpoint/index.md | 94 +++++ .../aws/deadline/license_endpoints/index.md | 81 ++++ .../aws/deadline/metered_product/index.md | 89 ++++ .../aws/deadline/metered_products/index.md | 78 ++++ .../providers/aws/deadline/queue/index.md | 115 ++++++ .../aws/deadline/queue_environment/index.md | 103 +++++ .../aws/deadline/queue_environments/index.md | 83 ++++ .../deadline/queue_fleet_association/index.md | 85 ++++ .../queue_fleet_associations/index.md | 84 ++++ .../providers/aws/deadline/queues/index.md | 85 ++++ .../aws/deadline/storage_profile/index.md | 100 +++++ .../aws/deadline/storage_profiles/index.md | 82 ++++ .../providers/aws/detective/graph/index.md | 98 +++++ .../providers/aws/detective/graphs/index.md | 82 ++++ .../aws-docs/providers/aws/detective/index.md | 43 ++ .../aws/detective/member_invitation/index.md | 90 +++++ .../aws/detective/member_invitations/index.md | 81 ++++ .../aws/detective/organization_admin/index.md | 87 ++++ .../detective/organization_admins/index.md | 84 ++++ .../providers/aws/devopsguru/index.md | 43 ++ .../index.md | 92 +++++ .../index.md | 80 ++++ .../devopsguru/notification_channel/index.md | 80 ++++ .../devopsguru/notification_channels/index.md | 81 ++++ .../devopsguru/resource_collection/index.md | 91 +++++ .../devopsguru/resource_collections/index.md | 78 ++++ .../providers/aws/directoryservice/index.md | 39 ++ .../aws/directoryservice/simple_ad/index.md | 116 ++++++ .../aws/directoryservice/simple_ads/index.md | 88 ++++ .../providers/aws/dms/data_provider/index.md | 109 +++++ .../providers/aws/dms/data_providers/index.md | 83 ++++ docs/aws-docs/providers/aws/dms/index.md | 45 +++ .../aws/dms/instance_profile/index.md | 115 ++++++ .../aws/dms/instance_profiles/index.md | 83 ++++ .../aws/dms/migration_project/index.md | 118 ++++++ .../aws/dms/migration_projects/index.md | 84 ++++ .../aws/dms/replication_config/index.md | 119 ++++++ .../aws/dms/replication_configs/index.md | 84 ++++ .../aws/docdbelastic/cluster/index.md | 149 +++++++ .../aws/docdbelastic/clusters/index.md | 99 +++++ .../providers/aws/docdbelastic/index.md | 39 ++ .../aws/dynamodb/global_table/index.md | 166 ++++++++ .../aws/dynamodb/global_tables/index.md | 115 ++++++ docs/aws-docs/providers/aws/dynamodb/index.md | 41 ++ .../providers/aws/dynamodb/table/index.md | 155 +++++++ .../providers/aws/dynamodb/tables/index.md | 112 ++++++ .../aws/ec2/account_attributes/index.md | 35 -- .../providers/aws/ec2/address/index.md | 35 -- .../aws/ec2/address_attribute/index.md | 33 -- .../aws/ec2/address_to_classic/index.md | 32 -- .../providers/aws/ec2/address_to_vpc/index.md | 32 -- .../providers/aws/ec2/addresses/index.md | 47 --- .../aws/ec2/addresses_attribute/index.md | 37 -- .../aws/ec2/aggregate_id_format/index.md | 36 -- .../index.md | 37 -- .../ec2/associated_ipv6_pool_cidrs/index.md | 35 -- .../aws/ec2/availability_zone_group/index.md | 32 -- .../aws/ec2/availability_zones/index.md | 44 -- .../providers/aws/ec2/bundle_tasks/index.md | 42 -- .../aws/ec2/byoip_cidr_to_ipam/index.md | 32 -- .../providers/aws/ec2/byoip_cidrs/index.md | 41 -- .../aws/ec2/capacity_reservation/index.md | 125 ++++++ .../ec2/capacity_reservation_fleet/index.md | 123 ++++++ .../ec2/capacity_reservation_fleets/index.md | 86 ++-- .../ec2/capacity_reservation_usage/index.md | 40 -- .../aws/ec2/capacity_reservations/index.md | 88 ++-- .../aws/ec2/carrier_gateway/index.md | 98 +++++ .../aws/ec2/carrier_gateways/index.md | 69 +++- .../aws/ec2/classic_link_instances/index.md | 37 -- .../aws/ec2/classic_link_vpc/index.md | 33 -- .../client_vpn_authorization_rules/index.md | 39 -- .../index.md | 33 -- .../client_vpn_client_configuration/index.md | 32 -- .../aws/ec2/client_vpn_connections/index.md | 48 --- .../aws/ec2/client_vpn_endpoints/index.md | 59 --- .../aws/ec2/client_vpn_ingress/index.md | 33 -- .../aws/ec2/client_vpn_routes/index.md | 42 -- .../ec2/client_vpn_target_networks/index.md | 41 -- .../aws/ec2/coip_pool_usage/index.md | 37 -- .../providers/aws/ec2/coip_pools/index.md | 38 -- .../providers/aws/ec2/console_output/index.md | 36 -- .../aws/ec2/console_screenshot/index.md | 35 -- .../aws/ec2/conversion_tasks/index.md | 41 -- .../aws/ec2/customer_gateway/index.md | 103 +++++ .../aws/ec2/customer_gateways/index.md | 72 +++- .../ec2/default_credit_specification/index.md | 36 -- .../providers/aws/ec2/default_subnet/index.md | 32 -- .../providers/aws/ec2/default_vpc/index.md | 32 -- .../providers/aws/ec2/dhcp_options/index.md | 96 ++++- .../aws/ec2/diagnostic_interrupt/index.md | 32 -- .../aws/ec2/ebs_default_kms_key_id/index.md | 33 -- .../ec2/ebs_encryption_by_default/index.md | 33 -- .../providers/aws/ec2/ec2fleet/index.md | 113 ++++++ .../providers/aws/ec2/ec2fleets/index.md | 78 ++++ .../ec2/egress_only_internet_gateway/index.md | 81 ++++ .../egress_only_internet_gateways/index.md | 66 ++- docs/aws-docs/providers/aws/ec2/eip/index.md | 107 +++++ .../aws/ec2/eip_association/index.md | 88 ++++ .../aws/ec2/eip_associations/index.md | 78 ++++ docs/aws-docs/providers/aws/ec2/eips/index.md | 83 ++++ .../providers/aws/ec2/elastic_gpus/index.md | 40 -- .../ec2/enclave_certificate_iam_role/index.md | 33 -- .../index.md | 85 ++++ .../index.md | 79 ++++ .../aws/ec2/export_image_tasks/index.md | 41 -- .../providers/aws/ec2/export_tasks/index.md | 41 -- .../providers/aws/ec2/fast_launch/index.md | 33 -- .../aws/ec2/fast_launch_images/index.md | 42 -- .../aws/ec2/fast_snapshot_restores/index.md | 46 --- .../providers/aws/ec2/fleet_history/index.md | 38 -- .../aws/ec2/fleet_instances/index.md | 37 -- .../providers/aws/ec2/fleets/index.md | 57 --- .../providers/aws/ec2/flow_log/index.md | 115 ++++++ .../providers/aws/ec2/flow_logs/index.md | 83 ++-- .../flow_logs_integration_template/index.md | 31 -- .../aws/ec2/fpga_image_attribute/index.md | 33 -- .../providers/aws/ec2/fpga_images/index.md | 51 --- .../gateway_route_table_association/index.md | 93 +++++ .../gateway_route_table_associations/index.md | 68 ++++ .../groups_for_capacity_reservation/index.md | 35 -- docs/aws-docs/providers/aws/ec2/host/index.md | 105 +++++ .../ec2/host_reservation_offerings/index.md | 40 -- .../index.md | 37 -- .../aws/ec2/host_reservations/index.md | 48 --- .../aws-docs/providers/aws/ec2/hosts/index.md | 82 ++-- .../aws/ec2/iam_instance_profile/index.md | 33 -- .../index.md | 39 -- .../providers/aws/ec2/id_format/index.md | 37 -- .../aws/ec2/identity_id_format/index.md | 37 -- .../aws/ec2/image_attribute/index.md | 47 --- .../aws/ec2/image_deprecation/index.md | 33 -- .../aws/ec2/image_from_recycle_bin/index.md | 32 -- .../providers/aws/ec2/images/index.md | 37 -- .../aws/ec2/images_in_recycle_bin/index.md | 38 -- .../aws/ec2/import_image_tasks/index.md | 50 --- .../aws/ec2/import_snapshot_tasks/index.md | 37 -- .../providers/aws/ec2/import_task/index.md | 32 -- docs/aws-docs/providers/aws/ec2/index.md | 308 +++++--------- .../providers/aws/ec2/instance/index.md | 228 +++++++++++ .../aws/ec2/instance_attribute/index.md | 51 --- .../index.md | 32 -- .../ec2/instance_connect_endpoint/index.md | 100 +++++ .../ec2/instance_connect_endpoints/index.md | 81 ++++ .../instance_credit_specifications/index.md | 36 -- .../index.md | 33 -- .../ec2/instance_event_start_time/index.md | 32 -- .../aws/ec2/instance_event_windows/index.md | 45 --- .../aws/ec2/instance_export_task/index.md | 32 -- .../ec2/instance_maintenance_options/index.md | 32 -- .../ec2/instance_metadata_options/index.md | 32 -- .../aws/ec2/instance_placement/index.md | 32 -- .../aws/ec2/instance_status/index.md | 41 -- .../aws/ec2/instance_type_offerings/index.md | 36 -- .../providers/aws/ec2/instance_types/index.md | 57 --- .../index.md | 31 -- .../aws/ec2/instance_uefi_data/index.md | 35 -- .../providers/aws/ec2/instances/index.md | 155 +++---- .../aws/ec2/internet_gateway/index.md | 92 +++++ .../aws/ec2/internet_gateways/index.md | 70 +++- docs/aws-docs/providers/aws/ec2/ipam/index.md | 114 ++++++ .../aws/ec2/ipam_address_history/index.md | 44 -- .../aws/ec2/ipam_allocation/index.md | 85 ++++ .../aws/ec2/ipam_allocations/index.md | 82 ++++ .../ipam_organization_admin_account/index.md | 33 -- .../providers/aws/ec2/ipam_pool/index.md | 144 +++++++ .../aws/ec2/ipam_pool_allocations/index.md | 41 -- .../providers/aws/ec2/ipam_pool_cidr/index.md | 86 ++++ .../aws/ec2/ipam_pool_cidrs/index.md | 69 +++- .../providers/aws/ec2/ipam_pools/index.md | 89 ++-- .../aws/ec2/ipam_resource_cidrs/index.md | 49 --- .../ec2/ipam_resource_discoveries/index.md | 79 ++++ .../aws/ec2/ipam_resource_discovery/index.md | 108 +++++ .../index.md | 111 +++++ .../index.md | 79 ++++ .../providers/aws/ec2/ipam_scope/index.md | 108 +++++ .../providers/aws/ec2/ipam_scopes/index.md | 76 +++- .../aws-docs/providers/aws/ec2/ipams/index.md | 77 +++- .../providers/aws/ec2/ipv6_addresses/index.md | 33 -- .../providers/aws/ec2/ipv6_pools/index.md | 37 -- .../providers/aws/ec2/key_pair/index.md | 91 +++++ .../providers/aws/ec2/key_pairs/index.md | 64 ++- .../aws/ec2/launch_template/index.md | 101 +++++ .../aws/ec2/launch_template_data/index.md | 31 -- .../aws/ec2/launch_template_versions/index.md | 43 -- .../aws/ec2/launch_templates/index.md | 71 +++- .../aws/ec2/local_gateway_route/index.md | 99 +++++ .../ec2/local_gateway_route_table/index.md | 105 +++++ .../index.md | 105 +++++ .../index.md | 70 +++- .../index.md | 43 -- .../ec2/local_gateway_route_tables/index.md | 69 +++- .../index.md | 101 +++++ .../index.md | 79 ++++ .../aws/ec2/local_gateway_routes/index.md | 65 ++- .../index.md | 38 -- .../local_gateway_virtual_interfaces/index.md | 42 -- .../providers/aws/ec2/local_gateways/index.md | 38 -- .../managed_prefix_list_associations/index.md | 35 -- .../ec2/managed_prefix_list_entries/index.md | 35 -- .../ec2/managed_prefix_list_version/index.md | 32 -- .../aws/ec2/managed_prefix_lists/index.md | 46 --- .../aws/ec2/moving_addresses/index.md | 35 -- .../providers/aws/ec2/nat_gateway/index.md | 112 ++++++ .../providers/aws/ec2/nat_gateways/index.md | 76 +++- .../providers/aws/ec2/network_acl/index.md | 96 +++++ .../aws/ec2/network_acl_association/index.md | 32 -- .../aws/ec2/network_acl_entry/index.md | 34 -- .../providers/aws/ec2/network_acls/index.md | 71 +++- .../network_insights_access_scope/index.md | 104 +++++ .../index.md | 79 +++- .../index.md | 91 ++++- .../index.md | 37 -- .../index.md | 31 -- .../network_insights_access_scopes/index.md | 69 +++- .../ec2/network_insights_analyses/index.md | 84 +++- .../ec2/network_insights_analysis/index.md | 101 ++++- .../aws/ec2/network_insights_path/index.md | 116 ++++++ .../aws/ec2/network_insights_paths/index.md | 73 +++- .../aws/ec2/network_interface/index.md | 137 +++++++ .../ec2/network_interface_attachment/index.md | 101 +++++ .../network_interface_attachments/index.md | 79 ++++ .../ec2/network_interface_attribute/index.md | 40 -- .../network_interface_permissions/index.md | 41 -- .../aws/ec2/network_interfaces/index.md | 93 +++-- .../index.md | 84 ++++ .../index.md | 84 ++++ .../providers/aws/ec2/password_data/index.md | 36 -- .../aws/ec2/placement_group/index.md | 86 ++++ .../aws/ec2/placement_groups/index.md | 71 +++- .../providers/aws/ec2/prefix_list/index.md | 109 +++++ .../providers/aws/ec2/prefix_lists/index.md | 66 ++- .../aws/ec2/principal_id_format/index.md | 35 -- .../aws/ec2/private_dns_name_options/index.md | 32 -- .../aws/ec2/private_ip_addresses/index.md | 33 -- .../aws/ec2/product_instance/index.md | 32 -- .../aws/ec2/public_ipv4_pool_cidr/index.md | 33 -- .../aws/ec2/public_ipv4_pools/index.md | 42 -- .../ec2/queued_reserved_instances/index.md | 32 -- .../providers/aws/ec2/regions/index.md | 36 -- .../ec2/replace_root_volume_tasks/index.md | 40 -- .../aws/ec2/reserved_instances/index.md | 52 --- .../index.md | 43 -- .../ec2/reserved_instances_listings/index.md | 45 --- .../reserved_instances_modifications/index.md | 42 -- .../ec2/reserved_instances_offerings/index.md | 49 --- .../aws/ec2/restore_image_task/index.md | 32 -- .../aws-docs/providers/aws/ec2/route/index.md | 104 ++++- .../providers/aws/ec2/route_table/index.md | 94 +++++ .../aws/ec2/route_table_association/index.md | 32 -- .../providers/aws/ec2/route_tables/index.md | 73 +++- .../providers/aws/ec2/routes/index.md | 81 ++++ .../scheduled_instance_availability/index.md | 46 --- .../aws/ec2/scheduled_instances/index.md | 50 --- .../providers/aws/ec2/security_group/index.md | 108 +++++ .../aws/ec2/security_group_egress/index.md | 89 +++- .../aws/ec2/security_group_egresses/index.md | 79 ++++ .../aws/ec2/security_group_ingress/index.md | 96 ++++- .../aws/ec2/security_group_ingresses/index.md | 78 ++++ .../ec2/security_group_references/index.md | 36 -- .../index.md | 32 -- .../index.md | 32 -- .../aws/ec2/security_group_rules/index.md | 47 --- .../aws/ec2/security_groups/index.md | 75 +++- .../index.md | 32 -- .../aws/ec2/serial_console_access/index.md | 33 -- .../ec2/serial_console_access_status/index.md | 31 -- .../aws/ec2/snapshot_attribute/index.md | 38 -- .../ec2/snapshot_block_public_access/index.md | 91 +++++ .../snapshot_block_public_accesses/index.md | 78 ++++ .../ec2/snapshot_from_recycle_bin/index.md | 32 -- .../providers/aws/ec2/snapshot_tier/index.md | 33 -- .../aws/ec2/snapshot_tier_status/index.md | 45 --- .../providers/aws/ec2/snapshots/index.md | 100 +++-- .../aws/ec2/snapshots_in_recycle_bin/index.md | 38 -- .../ec2/spot_datafeed_subscription/index.md | 40 -- .../providers/aws/ec2/spot_fleet/index.md | 73 +++- .../aws/ec2/spot_fleet_instances/index.md | 37 -- .../ec2/spot_fleet_request_history/index.md | 36 -- .../aws/ec2/spot_fleet_requests/index.md | 41 -- .../providers/aws/ec2/spot_fleets/index.md | 81 ++++ .../aws/ec2/spot_instance_requests/index.md | 53 --- .../providers/aws/ec2/spot_instances/index.md | 32 -- .../aws/ec2/spot_placement_scores/index.md | 36 -- .../aws/ec2/spot_price_history/index.md | 38 -- .../aws/ec2/stale_security_groups/index.md | 39 -- .../aws/ec2/store_image_tasks/index.md | 41 -- .../providers/aws/ec2/subnet/index.md | 132 ++++++ .../aws/ec2/subnet_attribute/index.md | 32 -- .../aws/ec2/subnet_cidr_block/index.md | 69 +++- .../aws/ec2/subnet_cidr_blocks/index.md | 78 ++++ .../aws/ec2/subnet_cidr_reservations/index.md | 38 -- .../subnet_network_acl_association/index.md | 82 ++++ .../subnet_network_acl_associations/index.md | 78 ++++ .../subnet_route_table_association/index.md | 83 ++++ .../subnet_route_table_associations/index.md | 80 ++++ .../providers/aws/ec2/subnets/index.md | 87 ++-- docs/aws-docs/providers/aws/ec2/tags/index.md | 39 -- .../index.md | 32 -- .../ec2/traffic_mirror_filter_rule/index.md | 34 -- .../aws/ec2/traffic_mirror_filters/index.md | 41 -- .../aws/ec2/traffic_mirror_sessions/index.md | 46 --- .../aws/ec2/traffic_mirror_targets/index.md | 43 -- .../aws/ec2/transit_gateway/index.md | 134 ++++++ .../ec2/transit_gateway_attachment/index.md | 120 ++++++ .../index.md | 35 -- .../ec2/transit_gateway_attachments/index.md | 85 +++- .../aws/ec2/transit_gateway_connect/index.md | 103 +++++ .../transit_gateway_connect_peers/index.md | 41 -- .../aws/ec2/transit_gateway_connects/index.md | 71 +++- .../transit_gateway_multicast_domain/index.md | 103 +++++ .../index.md | 88 ++++ .../index.md | 72 +++- .../index.md | 74 +++- .../index.md | 98 +++++ .../index.md | 65 ++- .../index.md | 98 +++++ .../index.md | 65 ++- .../transit_gateway_multicast_groups/index.md | 32 -- .../index.md | 104 +++++ .../index.md | 72 +++- .../index.md | 42 -- .../ec2/transit_gateway_route_table/index.md | 84 ++++ .../index.md | 80 ++++ .../index.md | 67 ++- .../index.md | 39 -- .../ec2/transit_gateway_route_tables/index.md | 73 +++- .../aws/ec2/transit_gateway_routes/index.md | 36 -- .../transit_gateway_vpc_attachment/index.md | 124 ++++++ .../transit_gateway_vpc_attachments/index.md | 89 +++- .../aws/ec2/transit_gateways/index.md | 85 +++- .../aws/ec2/trunk_interface/index.md | 33 -- .../ec2/trunk_interface_associations/index.md | 40 -- .../aws/ec2/verified_access_endpoint/index.md | 220 ++++++++++ .../ec2/verified_access_endpoints/index.md | 139 +++++++ .../aws/ec2/verified_access_group/index.md | 133 ++++++ .../aws/ec2/verified_access_groups/index.md | 92 +++++ .../aws/ec2/verified_access_instance/index.md | 142 +++++++ .../ec2/verified_access_instances/index.md | 104 +++++ .../verified_access_trust_provider/index.md | 130 ++++++ .../verified_access_trust_providers/index.md | 90 +++++ .../aws/ec2/vgw_route_propagation/index.md | 33 -- .../providers/aws/ec2/volume/index.md | 123 ++++++ .../aws/ec2/volume_attachment/index.md | 82 ++++ .../aws/ec2/volume_attachments/index.md | 80 ++++ .../aws/ec2/volume_attribute/index.md | 37 -- .../providers/aws/ec2/volume_i_o/index.md | 32 -- .../providers/aws/ec2/volume_status/index.md | 40 -- .../providers/aws/ec2/volumes/index.md | 90 +++-- .../aws/ec2/volumes_modifications/index.md | 49 --- docs/aws-docs/providers/aws/ec2/vpc/index.md | 116 ++++++ .../providers/aws/ec2/vpc_attribute/index.md | 37 -- .../providers/aws/ec2/vpc_cidr_block/index.md | 79 +++- .../aws/ec2/vpc_cidr_blocks/index.md | 81 ++++ .../aws/ec2/vpc_classic_link/index.md | 38 -- .../ec2/vpc_classic_link_dns_support/index.md | 37 -- .../providers/aws/ec2/vpc_endpoint/index.md | 111 +++++ .../index.md | 96 +++++ .../index.md | 70 +++- .../aws/ec2/vpc_endpoint_connections/index.md | 44 -- .../aws/ec2/vpc_endpoint_service/index.md | 107 +++++ .../index.md | 51 --- .../index.md | 32 -- .../vpc_endpoint_service_permissions/index.md | 84 +++- .../index.md | 32 -- .../aws/ec2/vpc_endpoint_services/index.md | 82 ++-- .../providers/aws/ec2/vpc_endpoints/index.md | 83 ++-- .../aws/ec2/vpc_gateway_attachment/index.md | 102 +++++ .../aws/ec2/vpc_gateway_attachments/index.md | 83 ++++ .../aws/ec2/vpc_peering_connection/index.md | 102 +++++ .../vpc_peering_connection_options/index.md | 32 -- .../aws/ec2/vpc_peering_connections/index.md | 74 +++- .../providers/aws/ec2/vpc_tenancy/index.md | 32 -- .../ec2/vpcdhcp_options_association/index.md | 89 ++++ .../ec2/vpcdhcp_options_associations/index.md | 79 ++++ docs/aws-docs/providers/aws/ec2/vpcs/index.md | 75 +++- .../providers/aws/ec2/vpn_connection/index.md | 105 +++++ .../index.md | 31 -- .../ec2/vpn_connection_device_types/index.md | 37 -- .../aws/ec2/vpn_connection_options/index.md | 32 -- .../aws/ec2/vpn_connection_route/index.md | 63 ++- .../aws/ec2/vpn_connection_routes/index.md | 80 ++++ .../aws/ec2/vpn_connections/index.md | 80 ++-- .../providers/aws/ec2/vpn_gateway/index.md | 94 +++++ .../providers/aws/ec2/vpn_gateways/index.md | 72 +++- .../aws/ec2/vpn_tunnel_certificate/index.md | 32 -- .../aws/ec2/vpn_tunnel_options/index.md | 32 -- .../aws/ec2_api/account_attributes/index.md | 35 ++ .../providers/aws/ec2_api/address/index.md | 35 ++ .../aws/ec2_api/address_attribute/index.md | 33 ++ .../aws/ec2_api/address_to_classic/index.md | 32 ++ .../aws/ec2_api/address_to_vpc/index.md | 32 ++ .../providers/aws/ec2_api/addresses/index.md | 47 +++ .../aws/ec2_api/addresses_attribute/index.md | 37 ++ .../aws/ec2_api/aggregate_id_format/index.md | 36 ++ .../index.md | 37 ++ .../associated_ipv6_pool_cidrs/index.md | 35 ++ .../ec2_api/availability_zone_group/index.md | 32 ++ .../aws/ec2_api/availability_zones/index.md | 44 ++ .../aws/ec2_api/bundle_tasks/index.md | 42 ++ .../aws/ec2_api/byoip_cidr_to_ipam/index.md | 32 ++ .../aws/ec2_api/byoip_cidrs/index.md | 41 ++ .../capacity_reservation_fleets/index.md | 48 +++ .../capacity_reservation_usage/index.md | 40 ++ .../ec2_api/capacity_reservations/index.md | 58 +++ .../aws/ec2_api/carrier_gateways/index.md | 40 ++ .../ec2_api/classic_link_instances/index.md | 37 ++ .../aws/ec2_api/classic_link_vpc/index.md | 33 ++ .../client_vpn_authorization_rules/index.md | 39 ++ .../index.md | 33 ++ .../client_vpn_client_configuration/index.md | 32 ++ .../ec2_api/client_vpn_connections/index.md | 48 +++ .../aws/ec2_api/client_vpn_endpoints/index.md | 59 +++ .../aws/ec2_api/client_vpn_ingress/index.md | 33 ++ .../aws/ec2_api/client_vpn_routes/index.md | 42 ++ .../client_vpn_target_networks/index.md | 41 ++ .../aws/ec2_api/coip_pool_usage/index.md | 37 ++ .../providers/aws/ec2_api/coip_pools/index.md | 38 ++ .../aws/ec2_api/console_output/index.md | 36 ++ .../aws/ec2_api/console_screenshot/index.md | 35 ++ .../aws/ec2_api/conversion_tasks/index.md | 41 ++ .../aws/ec2_api/customer_gateways/index.md | 43 ++ .../default_credit_specification/index.md | 36 ++ .../aws/ec2_api/default_subnet/index.md | 32 ++ .../aws/ec2_api/default_vpc/index.md | 32 ++ .../aws/ec2_api/dhcp_options/index.md | 40 ++ .../aws/ec2_api/diagnostic_interrupt/index.md | 32 ++ .../ec2_api/ebs_default_kms_key_id/index.md | 33 ++ .../ebs_encryption_by_default/index.md | 33 ++ .../egress_only_internet_gateways/index.md | 38 ++ .../aws/ec2_api/elastic_gpus/index.md | 40 ++ .../enclave_certificate_iam_role/index.md | 33 ++ .../aws/ec2_api/export_image_tasks/index.md | 41 ++ .../aws/ec2_api/export_tasks/index.md | 41 ++ .../aws/ec2_api/fast_launch/index.md | 33 ++ .../aws/ec2_api/fast_launch_images/index.md | 42 ++ .../ec2_api/fast_snapshot_restores/index.md | 46 +++ .../aws/ec2_api/fleet_history/index.md | 38 ++ .../aws/ec2_api/fleet_instances/index.md | 37 ++ .../providers/aws/ec2_api/fleets/index.md | 57 +++ .../providers/aws/ec2_api/flow_logs/index.md | 50 +++ .../flow_logs_integration_template/index.md | 31 ++ .../aws/ec2_api/fpga_image_attribute/index.md | 33 ++ .../aws/ec2_api/fpga_images/index.md | 51 +++ .../groups_for_capacity_reservation/index.md | 35 ++ .../host_reservation_offerings/index.md | 40 ++ .../index.md | 37 ++ .../aws/ec2_api/host_reservations/index.md | 48 +++ .../providers/aws/ec2_api/hosts/index.md | 54 +++ .../aws/ec2_api/iam_instance_profile/index.md | 33 ++ .../index.md | 39 ++ .../providers/aws/ec2_api/id_format/index.md | 37 ++ .../aws/ec2_api/identity_id_format/index.md | 37 ++ .../aws/ec2_api/image_attribute/index.md | 47 +++ .../aws/ec2_api/image_deprecation/index.md | 33 ++ .../ec2_api/image_from_recycle_bin/index.md | 32 ++ .../providers/aws/ec2_api/images/index.md | 37 ++ .../ec2_api/images_in_recycle_bin/index.md | 38 ++ .../aws/ec2_api/import_image_tasks/index.md | 50 +++ .../ec2_api/import_snapshot_tasks/index.md | 37 ++ .../aws/ec2_api/import_task/index.md | 32 ++ docs/aws-docs/providers/aws/ec2_api/index.md | 286 +++++++++++++ .../aws/ec2_api/instance_attribute/index.md | 51 +++ .../index.md | 32 ++ .../instance_credit_specifications/index.md | 36 ++ .../index.md | 33 ++ .../instance_event_start_time/index.md | 32 ++ .../ec2_api/instance_event_windows/index.md | 45 +++ .../aws/ec2_api/instance_export_task/index.md | 32 ++ .../instance_maintenance_options/index.md | 32 ++ .../instance_metadata_options/index.md | 32 ++ .../aws/ec2_api/instance_placement/index.md | 32 ++ .../aws/ec2_api/instance_status/index.md | 41 ++ .../ec2_api/instance_type_offerings/index.md | 36 ++ .../aws/ec2_api/instance_types/index.md | 57 +++ .../index.md | 31 ++ .../aws/ec2_api/instance_uefi_data/index.md | 35 ++ .../providers/aws/ec2_api/instances/index.md | 98 +++++ .../aws/ec2_api/internet_gateways/index.md | 41 ++ .../aws/ec2_api/ipam_address_history/index.md | 44 ++ .../ipam_organization_admin_account/index.md | 33 ++ .../ec2_api/ipam_pool_allocations/index.md | 41 ++ .../aws/ec2_api/ipam_pool_cidrs/index.md | 39 ++ .../providers/aws/ec2_api/ipam_pools/index.md | 58 +++ .../aws/ec2_api/ipam_resource_cidrs/index.md | 49 +++ .../aws/ec2_api/ipam_scopes/index.md | 47 +++ .../providers/aws/ec2_api/ipams/index.md | 47 +++ .../aws/ec2_api/ipv6_addresses/index.md | 33 ++ .../providers/aws/ec2_api/ipv6_pools/index.md | 37 ++ .../providers/aws/ec2_api/key_pairs/index.md | 34 ++ .../aws/ec2_api/launch_template_data/index.md | 31 ++ .../ec2_api/launch_template_versions/index.md | 43 ++ .../aws/ec2_api/launch_templates/index.md | 43 ++ .../index.md | 41 ++ .../index.md | 43 ++ .../local_gateway_route_tables/index.md | 40 ++ .../aws/ec2_api/local_gateway_routes/index.md | 34 ++ .../index.md | 38 ++ .../local_gateway_virtual_interfaces/index.md | 42 ++ .../aws/ec2_api/local_gateways/index.md | 38 ++ .../managed_prefix_list_associations/index.md | 35 ++ .../managed_prefix_list_entries/index.md | 35 ++ .../managed_prefix_list_version/index.md | 32 ++ .../aws/ec2_api/managed_prefix_lists/index.md | 46 +++ .../aws/ec2_api/moving_addresses/index.md | 35 ++ .../aws/ec2_api/nat_gateways/index.md | 47 +++ .../ec2_api/network_acl_association/index.md | 32 ++ .../aws/ec2_api/network_acl_entry/index.md | 34 ++ .../aws/ec2_api/network_acls/index.md | 42 ++ .../index.md | 44 ++ .../index.md | 33 ++ .../index.md | 37 ++ .../index.md | 31 ++ .../network_insights_access_scopes/index.md | 40 ++ .../network_insights_analyses/index.md | 47 +++ .../network_insights_analysis/index.md | 33 ++ .../ec2_api/network_insights_paths/index.md | 45 +++ .../network_interface_attribute/index.md | 40 ++ .../network_interface_permissions/index.md | 41 ++ .../aws/ec2_api/network_interfaces/index.md | 63 +++ .../aws/ec2_api/password_data/index.md | 36 ++ .../aws/ec2_api/placement_groups/index.md | 42 ++ .../aws/ec2_api/prefix_lists/index.md | 36 ++ .../aws/ec2_api/principal_id_format/index.md | 35 ++ .../ec2_api/private_dns_name_options/index.md | 32 ++ .../aws/ec2_api/private_ip_addresses/index.md | 33 ++ .../aws/ec2_api/product_instance/index.md | 32 ++ .../ec2_api/public_ipv4_pool_cidr/index.md | 33 ++ .../aws/ec2_api/public_ipv4_pools/index.md | 42 ++ .../queued_reserved_instances/index.md | 32 ++ .../providers/aws/ec2_api/regions/index.md | 36 ++ .../replace_root_volume_tasks/index.md | 40 ++ .../aws/ec2_api/reserved_instances/index.md | 52 +++ .../index.md | 43 ++ .../reserved_instances_listings/index.md | 45 +++ .../reserved_instances_modifications/index.md | 42 ++ .../reserved_instances_offerings/index.md | 49 +++ .../aws/ec2_api/restore_image_task/index.md | 32 ++ .../providers/aws/ec2_api/route/index.md | 34 ++ .../ec2_api/route_table_association/index.md | 32 ++ .../aws/ec2_api/route_tables/index.md | 44 ++ .../scheduled_instance_availability/index.md | 46 +++ .../aws/ec2_api/scheduled_instances/index.md | 50 +++ .../ec2_api/security_group_egress/index.md | 33 ++ .../ec2_api/security_group_ingress/index.md | 33 ++ .../security_group_references/index.md | 36 ++ .../index.md | 32 ++ .../index.md | 32 ++ .../aws/ec2_api/security_group_rules/index.md | 47 +++ .../aws/ec2_api/security_groups/index.md | 43 ++ .../index.md | 32 ++ .../ec2_api/serial_console_access/index.md | 33 ++ .../serial_console_access_status/index.md | 31 ++ .../aws/ec2_api/snapshot_attribute/index.md | 38 ++ .../snapshot_from_recycle_bin/index.md | 32 ++ .../aws/ec2_api/snapshot_tier/index.md | 33 ++ .../aws/ec2_api/snapshot_tier_status/index.md | 45 +++ .../providers/aws/ec2_api/snapshots/index.md | 55 +++ .../ec2_api/snapshots_in_recycle_bin/index.md | 38 ++ .../spot_datafeed_subscription/index.md | 40 ++ .../providers/aws/ec2_api/spot_fleet/index.md | 32 ++ .../aws/ec2_api/spot_fleet_instances/index.md | 37 ++ .../spot_fleet_request_history/index.md | 36 ++ .../aws/ec2_api/spot_fleet_requests/index.md | 41 ++ .../ec2_api/spot_instance_requests/index.md | 53 +++ .../aws/ec2_api/spot_instances/index.md | 32 ++ .../ec2_api/spot_placement_scores/index.md | 36 ++ .../aws/ec2_api/spot_price_history/index.md | 38 ++ .../ec2_api/stale_security_groups/index.md | 39 ++ .../aws/ec2_api/store_image_tasks/index.md | 41 ++ .../aws/ec2_api/subnet_attribute/index.md | 32 ++ .../aws/ec2_api/subnet_cidr_block/index.md | 33 ++ .../ec2_api/subnet_cidr_reservations/index.md | 38 ++ .../providers/aws/ec2_api/subnets/index.md | 56 +++ .../providers/aws/ec2_api/tags/index.md | 39 ++ .../index.md | 32 ++ .../traffic_mirror_filter_rule/index.md | 34 ++ .../ec2_api/traffic_mirror_filters/index.md | 41 ++ .../ec2_api/traffic_mirror_sessions/index.md | 46 +++ .../ec2_api/traffic_mirror_targets/index.md | 43 ++ .../index.md | 35 ++ .../transit_gateway_attachments/index.md | 43 ++ .../transit_gateway_connect_peers/index.md | 41 ++ .../ec2_api/transit_gateway_connects/index.md | 42 ++ .../index.md | 40 ++ .../index.md | 45 +++ .../index.md | 33 ++ .../index.md | 33 ++ .../transit_gateway_multicast_groups/index.md | 32 ++ .../index.md | 44 ++ .../index.md | 42 ++ .../index.md | 37 ++ .../index.md | 39 ++ .../transit_gateway_route_tables/index.md | 44 ++ .../ec2_api/transit_gateway_routes/index.md | 36 ++ .../transit_gateway_vpc_attachments/index.md | 47 +++ .../aws/ec2_api/transit_gateways/index.md | 44 ++ .../aws/ec2_api/trunk_interface/index.md | 33 ++ .../trunk_interface_associations/index.md | 40 ++ .../ec2_api/vgw_route_propagation/index.md | 33 ++ .../aws/ec2_api/volume_attribute/index.md | 37 ++ .../providers/aws/ec2_api/volume_i_o/index.md | 32 ++ .../aws/ec2_api/volume_status/index.md | 40 ++ .../providers/aws/ec2_api/volumes/index.md | 55 +++ .../ec2_api/volumes_modifications/index.md | 49 +++ .../aws/ec2_api/vpc_attribute/index.md | 37 ++ .../aws/ec2_api/vpc_cidr_block/index.md | 33 ++ .../aws/ec2_api/vpc_classic_link/index.md | 38 ++ .../vpc_classic_link_dns_support/index.md | 37 ++ .../index.md | 43 ++ .../ec2_api/vpc_endpoint_connections/index.md | 44 ++ .../index.md | 51 +++ .../index.md | 32 ++ .../vpc_endpoint_service_permissions/index.md | 36 ++ .../index.md | 32 ++ .../ec2_api/vpc_endpoint_services/index.md | 48 +++ .../aws/ec2_api/vpc_endpoints/index.md | 55 +++ .../vpc_peering_connection_options/index.md | 32 ++ .../ec2_api/vpc_peering_connections/index.md | 43 ++ .../aws/ec2_api/vpc_tenancy/index.md | 32 ++ .../providers/aws/ec2_api/vpcs/index.md | 45 +++ .../index.md | 31 ++ .../vpn_connection_device_types/index.md | 37 ++ .../ec2_api/vpn_connection_options/index.md | 32 ++ .../aws/ec2_api/vpn_connection_route/index.md | 33 ++ .../aws/ec2_api/vpn_connections/index.md | 51 +++ .../aws/ec2_api/vpn_gateways/index.md | 44 ++ .../ec2_api/vpn_tunnel_certificate/index.md | 32 ++ .../aws/ec2_api/vpn_tunnel_options/index.md | 32 ++ docs/aws-docs/providers/aws/ecr/index.md | 49 +++ .../aws/ecr/public_repositories/index.md | 80 ++++ .../aws/ecr/public_repository/index.md | 102 +++++ .../aws/ecr/pull_through_cache_rule/index.md | 98 +++++ .../aws/ecr/pull_through_cache_rules/index.md | 81 ++++ .../aws/ecr/registry_policies/index.md | 78 ++++ .../aws/ecr/registry_policy/index.md | 90 +++++ .../ecr/replication_configuration/index.md | 93 +++++ .../ecr/replication_configurations/index.md | 79 ++++ .../providers/aws/ecr/repositories/index.md | 83 ++++ .../providers/aws/ecr/repository/index.md | 121 ++++++ .../ecr/repository_creation_template/index.md | 108 +++++ .../repository_creation_templates/index.md | 79 ++++ .../index.md | 93 +++++ docs/aws-docs/providers/aws/ecs/index.md | 46 +++ .../aws/ecs/primary_task_set/index.md | 82 ++++ .../aws/ecs/primary_task_sets/index.md | 70 ++++ .../providers/aws/ecs/service/index.md | 140 +++++++ .../providers/aws/ecs/services/index.md | 84 ++++ .../aws/ecs/task_definition/index.md | 129 ++++++ .../aws/ecs/task_definitions/index.md | 82 ++++ .../providers/aws/ecs/task_set/index.md | 113 ++++++ .../providers/aws/ecs/task_sets/index.md | 73 ++++ .../providers/aws/efs/access_point/index.md | 103 +++++ .../providers/aws/efs/access_points/index.md | 79 ++++ .../providers/aws/efs/file_system/index.md | 141 +++++++ .../providers/aws/efs/file_systems/index.md | 92 +++++ docs/aws-docs/providers/aws/efs/index.md | 43 ++ .../providers/aws/efs/mount_target/index.md | 99 +++++ .../providers/aws/efs/mount_targets/index.md | 79 ++++ .../providers/aws/eks/access_entries/index.md | 83 ++++ .../providers/aws/eks/access_entry/index.md | 109 +++++ .../aws-docs/providers/aws/eks/addon/index.md | 110 +++++ .../providers/aws/eks/addons/index.md | 82 ++++ .../providers/aws/eks/cluster/index.md | 126 ++++++ .../providers/aws/eks/clusters/index.md | 93 +++++ .../aws/eks/fargate_profile/index.md | 103 +++++ .../aws/eks/fargate_profiles/index.md | 84 ++++ .../aws/eks/identity_provider_config/index.md | 100 +++++ .../eks/identity_provider_configs/index.md | 84 ++++ docs/aws-docs/providers/aws/eks/index.md | 51 +++ .../providers/aws/eks/nodegroup/index.md | 134 ++++++ .../providers/aws/eks/nodegroups/index.md | 93 +++++ .../aws/eks/pod_identity_association/index.md | 105 +++++ .../eks/pod_identity_associations/index.md | 81 ++++ .../global_replication_group/index.md | 115 ++++++ .../global_replication_groups/index.md | 78 ++++ .../providers/aws/elasticache/index.md | 47 +++ .../aws/elasticache/serverless_cache/index.md | 132 ++++++ .../elasticache/serverless_caches/index.md | 85 ++++ .../aws/elasticache/subnet_group/index.md | 99 +++++ .../aws/elasticache/subnet_groups/index.md | 80 ++++ .../providers/aws/elasticache/user/index.md | 111 +++++ .../aws/elasticache/user_group/index.md | 105 +++++ .../aws/elasticache/user_groups/index.md | 81 ++++ .../providers/aws/elasticache/users/index.md | 81 ++++ .../aws/elasticbeanstalk/application/index.md | 92 +++++ .../application_version/index.md | 93 +++++ .../application_versions/index.md | 82 ++++ .../elasticbeanstalk/applications/index.md | 77 ++++ .../configuration_template/index.md | 102 +++++ .../configuration_templates/index.md | 79 ++++ .../aws/elasticbeanstalk/environment/index.md | 119 ++++++ .../elasticbeanstalk/environments/index.md | 79 ++++ .../providers/aws/elasticbeanstalk/index.md | 45 +++ .../aws/elasticloadbalancingv2/index.md | 49 +++ .../elasticloadbalancingv2/listener/index.md | 106 +++++ .../listener_rule/index.md | 100 +++++ .../listener_rules/index.md | 79 ++++ .../elasticloadbalancingv2/listeners/index.md | 79 ++++ .../load_balancer/index.md | 123 ++++++ .../load_balancers/index.md | 80 ++++ .../target_group/index.md | 142 +++++++ .../target_groups/index.md | 82 ++++ .../trust_store/index.md | 107 +++++ .../trust_store_revocation/index.md | 84 ++++ .../trust_store_revocations/index.md | 82 ++++ .../trust_stores/index.md | 83 ++++ docs/aws-docs/providers/aws/emr/index.md | 45 +++ .../aws/emr/security_configuration/index.md | 79 ++++ .../aws/emr/security_configurations/index.md | 78 ++++ .../providers/aws/emr/studio/index.md | 131 ++++++ .../aws/emr/studio_session_mapping/index.md | 117 ++++++ .../aws/emr/studio_session_mappings/index.md | 90 +++++ .../providers/aws/emr/studios/index.md | 82 ++++ .../providers/aws/emr/wal_workspace/index.md | 91 +++++ .../providers/aws/emr/wal_workspaces/index.md | 79 ++++ .../providers/aws/emrcontainers/index.md | 39 ++ .../emrcontainers/virtual_cluster/index.md | 98 +++++ .../emrcontainers/virtual_clusters/index.md | 79 ++++ .../aws/emrserverless/application/index.md | 141 +++++++ .../aws/emrserverless/applications/index.md | 100 +++++ .../providers/aws/emrserverless/index.md | 39 ++ .../id_mapping_workflow/index.md | 115 ++++++ .../id_mapping_workflows/index.md | 82 ++++ .../entityresolution/id_namespace/index.md | 112 ++++++ .../entityresolution/id_namespaces/index.md | 79 ++++ .../providers/aws/entityresolution/index.md | 47 +++ .../matching_workflow/index.md | 115 ++++++ .../matching_workflows/index.md | 82 ++++ .../policy_statement/index.md | 99 +++++ .../policy_statements/index.md | 79 ++++ .../entityresolution/schema_mapping/index.md | 107 +++++ .../entityresolution/schema_mappings/index.md | 79 ++++ .../aws/events/api_destination/index.md | 101 +++++ .../aws/events/api_destinations/index.md | 78 ++++ .../providers/aws/events/archive/index.md | 99 +++++ .../providers/aws/events/archives/index.md | 78 ++++ .../providers/aws/events/connection/index.md | 103 +++++ .../providers/aws/events/connections/index.md | 82 ++++ .../providers/aws/events/endpoint/index.md | 111 +++++ .../providers/aws/events/endpoints/index.md | 80 ++++ .../providers/aws/events/event_bus/index.md | 100 +++++ .../providers/aws/events/event_buses/index.md | 82 ++++ docs/aws-docs/providers/aws/events/index.md | 49 +++ .../providers/aws/events/rule/index.md | 113 ++++++ .../providers/aws/events/rules/index.md | 80 ++++ .../aws/eventschemas/discoverer/index.md | 109 +++++ .../aws/eventschemas/discoverers/index.md | 84 ++++ .../eventschemas_registry/index.md | 98 +++++ .../providers/aws/eventschemas/index.md | 45 +++ .../aws/eventschemas/registries/index.md | 79 ++++ .../eventschemas/registry_policies/index.md | 69 ++++ .../aws/eventschemas/registry_policy/index.md | 95 +++++ .../aws/eventschemas/schema/index.md | 111 +++++ .../aws/eventschemas/schemata/index.md | 80 ++++ .../aws/evidently/experiment/index.md | 119 ++++++ .../aws/evidently/experiments/index.md | 70 ++++ .../providers/aws/evidently/feature/index.md | 110 +++++ .../providers/aws/evidently/features/index.md | 69 ++++ .../aws-docs/providers/aws/evidently/index.md | 47 +++ .../providers/aws/evidently/launch/index.md | 114 ++++++ .../providers/aws/evidently/launches/index.md | 70 ++++ .../providers/aws/evidently/project/index.md | 136 +++++++ .../providers/aws/evidently/projects/index.md | 82 ++++ .../providers/aws/evidently/segment/index.md | 88 ++++ .../providers/aws/evidently/segments/index.md | 80 ++++ .../aws/finspace/environment/index.md | 116 ++++++ .../aws/finspace/environments/index.md | 80 ++++ docs/aws-docs/providers/aws/finspace/index.md | 39 ++ .../aws/fis/experiment_template/index.md | 107 +++++ .../aws/fis/experiment_templates/index.md | 80 ++++ docs/aws-docs/providers/aws/fis/index.md | 41 ++ .../fis/target_account_configuration/index.md | 93 +++++ .../target_account_configurations/index.md | 79 ++++ docs/aws-docs/providers/aws/fms/index.md | 43 ++ .../aws/fms/notification_channel/index.md | 90 +++++ .../aws/fms/notification_channels/index.md | 78 ++++ .../providers/aws/fms/policies/index.md | 90 +++++ .../providers/aws/fms/policy/index.md | 133 ++++++ .../providers/aws/fms/resource_set/index.md | 106 +++++ .../providers/aws/fms/resource_sets/index.md | 80 ++++ .../providers/aws/forecast/dataset/index.md | 91 +++++ .../aws/forecast/dataset_group/index.md | 95 +++++ .../aws/forecast/dataset_groups/index.md | 77 ++++ .../providers/aws/forecast/datasets/index.md | 77 ++++ docs/aws-docs/providers/aws/forecast/index.md | 41 ++ .../aws/frauddetector/detector/index.md | 166 ++++++++ .../aws/frauddetector/detectors/index.md | 108 +++++ .../aws/frauddetector/event_type/index.md | 134 ++++++ .../aws/frauddetector/event_types/index.md | 93 +++++ .../frauddetector/frauddetector_list/index.md | 109 +++++ .../providers/aws/frauddetector/index.md | 49 +++ .../aws/frauddetector/label/index.md | 103 +++++ .../aws/frauddetector/labels/index.md | 81 ++++ .../aws/frauddetector/lists/index.md | 84 ++++ .../aws/frauddetector/outcome/index.md | 103 +++++ .../aws/frauddetector/outcomes/index.md | 81 ++++ .../aws/frauddetector/variable/index.md | 111 +++++ .../aws/frauddetector/variables/index.md | 81 ++++ .../fsx/data_repository_association/index.md | 112 ++++++ .../fsx/data_repository_associations/index.md | 84 ++++ docs/aws-docs/providers/aws/fsx/index.md | 39 ++ .../providers/aws/gamelift/alias/index.md | 93 +++++ .../providers/aws/gamelift/aliases/index.md | 77 ++++ .../providers/aws/gamelift/build/index.md | 98 +++++ .../providers/aws/gamelift/builds/index.md | 78 ++++ .../providers/aws/gamelift/fleet/index.md | 163 ++++++++ .../providers/aws/gamelift/fleets/index.md | 83 ++++ .../aws/gamelift/game_server_group/index.md | 138 +++++++ .../aws/gamelift/game_server_groups/index.md | 101 +++++ .../aws/gamelift/game_session_queue/index.md | 110 +++++ .../aws/gamelift/game_session_queues/index.md | 79 ++++ docs/aws-docs/providers/aws/gamelift/index.md | 55 +++ .../providers/aws/gamelift/location/index.md | 95 +++++ .../providers/aws/gamelift/locations/index.md | 80 ++++ .../matchmaking_configuration/index.md | 127 ++++++ .../matchmaking_configurations/index.md | 80 ++++ .../gamelift/matchmaking_rule_set/index.md | 100 +++++ .../gamelift/matchmaking_rule_sets/index.md | 81 ++++ .../providers/aws/gamelift/script/index.md | 108 +++++ .../providers/aws/gamelift/scripts/index.md | 82 ++++ .../globalaccelerator/accelerator/index.md | 110 +++++ .../globalaccelerator/accelerators/index.md | 79 ++++ .../cross_account_attachment/index.md | 99 +++++ .../cross_account_attachments/index.md | 79 ++++ .../globalaccelerator/endpoint_group/index.md | 112 ++++++ .../endpoint_groups/index.md | 82 ++++ .../providers/aws/globalaccelerator/index.md | 45 +++ .../aws/globalaccelerator/listener/index.md | 99 +++++ .../aws/globalaccelerator/listeners/index.md | 79 ++++ docs/aws-docs/providers/aws/glue/index.md | 40 ++ .../aws/glue/schema_version/index.md | 82 ++++ .../aws/glue/schema_version_metadata/index.md | 81 ++++ .../aws/glue/schema_versions/index.md | 79 ++++ docs/aws-docs/providers/aws/grafana/index.md | 39 ++ .../providers/aws/grafana/workspace/index.md | 155 +++++++ .../providers/aws/grafana/workspaces/index.md | 95 +++++ .../greengrassv2/component_version/index.md | 101 +++++ .../greengrassv2/component_versions/index.md | 82 ++++ .../aws/greengrassv2/deployment/index.md | 112 ++++++ .../aws/greengrassv2/deployments/index.md | 92 +++++ .../providers/aws/greengrassv2/index.md | 41 ++ .../aws/groundstation/config/index.md | 102 +++++ .../aws/groundstation/configs/index.md | 79 ++++ .../dataflow_endpoint_group/index.md | 89 ++++ .../dataflow_endpoint_groups/index.md | 83 ++++ .../providers/aws/groundstation/index.md | 43 ++ .../groundstation/mission_profile/index.md | 120 ++++++ .../groundstation/mission_profiles/index.md | 84 ++++ .../providers/aws/guardduty/detector/index.md | 103 +++++ .../aws/guardduty/detectors/index.md | 81 ++++ .../providers/aws/guardduty/filter/index.md | 104 +++++ .../providers/aws/guardduty/filters/index.md | 81 ++++ .../aws-docs/providers/aws/guardduty/index.md | 49 +++ .../providers/aws/guardduty/ip_set/index.md | 107 +++++ .../providers/aws/guardduty/ip_sets/index.md | 82 ++++ .../providers/aws/guardduty/master/index.md | 81 ++++ .../providers/aws/guardduty/masters/index.md | 81 ++++ .../providers/aws/guardduty/member/index.md | 104 +++++ .../providers/aws/guardduty/members/index.md | 80 ++++ .../aws/guardduty/threat_intel_set/index.md | 106 +++++ .../aws/guardduty/threat_intel_sets/index.md | 82 ++++ .../aws/healthimaging/datastore/index.md | 98 +++++ .../aws/healthimaging/datastores/index.md | 87 ++++ .../providers/aws/healthimaging/index.md | 39 ++ .../aws/healthlake/fhir_datastore/index.md | 122 ++++++ .../aws/healthlake/fhir_datastores/index.md | 93 +++++ .../providers/aws/healthlake/index.md | 39 ++ .../aws/iam/access_key_last_useds/index.md | 35 -- .../providers/aws/iam/access_keys/index.md | 40 -- .../providers/aws/iam/account_alias/index.md | 33 -- .../aws/iam/account_aliases/index.md | 32 -- .../account_authorization_details/index.md | 39 -- .../iam/account_password_policies/index.md | 33 -- .../aws/iam/account_summaries/index.md | 31 -- .../aws/iam/assume_role_policies/index.md | 32 -- .../aws/iam/attached_group_policies/index.md | 35 -- .../aws/iam/attached_role_policies/index.md | 35 -- .../aws/iam/attached_user_policies/index.md | 35 -- .../index.md | 32 -- .../context_keys_for_custom_policies/index.md | 31 -- .../index.md | 31 -- .../aws/iam/credential_reports/index.md | 37 -- .../aws/iam/custom_policies/index.md | 32 -- .../aws/iam/default_policy_versions/index.md | 32 -- .../aws/iam/entities_for_policies/index.md | 35 -- .../aws-docs/providers/aws/iam/group/index.md | 110 +++++ .../providers/aws/iam/group_policies/index.md | 58 ++- .../providers/aws/iam/group_policy/index.md | 93 +++++ .../providers/aws/iam/groups/index.md | 73 +++- .../aws/iam/groups_for_users/index.md | 38 -- docs/aws-docs/providers/aws/iam/index.md | 93 ++--- .../aws/iam/instance_profile/index.md | 98 +++++ .../aws/iam/instance_profile_tags/index.md | 35 -- .../aws/iam/instance_profiles/index.md | 66 ++- .../iam/instance_profiles_for_roles/index.md | 40 -- .../providers/aws/iam/login_profiles/index.md | 34 -- .../aws/iam/managed_policies/index.md | 80 ++++ .../providers/aws/iam/managed_policy/index.md | 133 ++++++ .../aws/iam/mfa_device_tags/index.md | 35 -- .../providers/aws/iam/mfa_devices/index.md | 41 -- .../providers/aws/iam/oidc_provider/index.md | 101 +++++ .../providers/aws/iam/oidc_providers/index.md | 80 ++++ .../open_id_connect_provider_tags/index.md | 35 -- .../index.md | 32 -- .../iam/open_id_connect_providers/index.md | 43 -- .../iam/organizations_access_reports/index.md | 43 -- .../providers/aws/iam/passwords/index.md | 32 -- .../providers/aws/iam/policies/index.md | 71 +++- .../providers/aws/iam/policy_tags/index.md | 35 -- .../aws/iam/policy_versions/index.md | 34 -- .../aws/iam/principal_policies/index.md | 32 -- docs/aws-docs/providers/aws/iam/role/index.md | 127 ++++++ .../aws/iam/role_descriptions/index.md | 32 -- .../iam/role_from_instance_profiles/index.md | 32 -- .../iam/role_permissions_boundaries/index.md | 33 -- .../providers/aws/iam/role_policies/index.md | 58 ++- .../providers/aws/iam/role_policy/index.md | 93 +++++ .../providers/aws/iam/role_tags/index.md | 35 -- .../iam/role_to_instance_profiles/index.md | 32 -- .../aws-docs/providers/aws/iam/roles/index.md | 83 ++-- .../providers/aws/iam/saml_provider/index.md | 97 +++++ .../aws/iam/saml_provider_tags/index.md | 35 -- .../providers/aws/iam/saml_providers/index.md | 73 +++- .../index.md | 32 -- .../aws/iam/server_certificate/index.md | 102 +++++ .../aws/iam/server_certificate_tags/index.md | 35 -- .../aws/iam/server_certificates/index.md | 67 ++- .../service_last_accessed_details/index.md | 42 -- .../index.md | 40 -- .../aws/iam/service_linked_role/index.md | 96 +++++ .../index.md | 35 -- .../aws/iam/service_linked_roles/index.md | 51 ++- .../iam/service_specific_credentials/index.md | 43 -- .../aws/iam/signing_certificates/index.md | 41 -- .../aws/iam/ssh_public_keys/index.md | 35 -- docs/aws-docs/providers/aws/iam/user/index.md | 136 +++++++ .../aws/iam/user_from_groups/index.md | 32 -- .../iam/user_permissions_boundaries/index.md | 33 -- .../providers/aws/iam/user_policies/index.md | 56 ++- .../providers/aws/iam/user_policy/index.md | 93 +++++ .../providers/aws/iam/user_tags/index.md | 35 -- .../providers/aws/iam/user_to_groups/index.md | 32 -- .../aws-docs/providers/aws/iam/users/index.md | 80 +++- .../aws/iam/virtual_mfa_devices/index.md | 41 -- .../aws/iam/virtualmfa_device/index.md | 97 +++++ .../aws/iam/virtualmfa_devices/index.md | 79 ++++ .../iam_api/access_key_last_useds/index.md | 35 ++ .../aws/iam_api/access_keys/index.md | 40 ++ .../aws/iam_api/account_alias/index.md | 33 ++ .../aws/iam_api/account_aliases/index.md | 32 ++ .../account_authorization_details/index.md | 39 ++ .../account_password_policies/index.md | 33 ++ .../aws/iam_api/account_summaries/index.md | 31 ++ .../aws/iam_api/assume_role_policies/index.md | 32 ++ .../iam_api/attached_group_policies/index.md | 35 ++ .../iam_api/attached_role_policies/index.md | 35 ++ .../iam_api/attached_user_policies/index.md | 35 ++ .../index.md | 32 ++ .../context_keys_for_custom_policies/index.md | 31 ++ .../index.md | 31 ++ .../aws/iam_api/credential_reports/index.md | 37 ++ .../aws/iam_api/custom_policies/index.md | 32 ++ .../iam_api/default_policy_versions/index.md | 32 ++ .../iam_api/entities_for_policies/index.md | 35 ++ .../aws/iam_api/group_policies/index.md | 41 ++ .../providers/aws/iam_api/groups/index.md | 42 ++ .../aws/iam_api/groups_for_users/index.md | 38 ++ docs/aws-docs/providers/aws/iam_api/index.md | 107 +++++ .../iam_api/instance_profile_tags/index.md | 35 ++ .../aws/iam_api/instance_profiles/index.md | 36 ++ .../instance_profiles_for_roles/index.md | 40 ++ .../aws/iam_api/login_profiles/index.md | 34 ++ .../aws/iam_api/mfa_device_tags/index.md | 35 ++ .../aws/iam_api/mfa_devices/index.md | 41 ++ .../open_id_connect_provider_tags/index.md | 35 ++ .../index.md | 32 ++ .../open_id_connect_providers/index.md | 43 ++ .../organizations_access_reports/index.md | 43 ++ .../providers/aws/iam_api/passwords/index.md | 32 ++ .../providers/aws/iam_api/policies/index.md | 36 ++ .../aws/iam_api/policy_tags/index.md | 35 ++ .../aws/iam_api/policy_versions/index.md | 34 ++ .../aws/iam_api/principal_policies/index.md | 32 ++ .../aws/iam_api/role_descriptions/index.md | 32 ++ .../role_from_instance_profiles/index.md | 32 ++ .../role_permissions_boundaries/index.md | 33 ++ .../aws/iam_api/role_policies/index.md | 41 ++ .../providers/aws/iam_api/role_tags/index.md | 35 ++ .../role_to_instance_profiles/index.md | 32 ++ .../providers/aws/iam_api/roles/index.md | 50 +++ .../aws/iam_api/saml_provider_tags/index.md | 35 ++ .../aws/iam_api/saml_providers/index.md | 43 ++ .../index.md | 32 ++ .../iam_api/server_certificate_tags/index.md | 35 ++ .../aws/iam_api/server_certificates/index.md | 37 ++ .../service_last_accessed_details/index.md | 42 ++ .../index.md | 40 ++ .../index.md | 35 ++ .../aws/iam_api/service_linked_roles/index.md | 33 ++ .../service_specific_credentials/index.md | 43 ++ .../aws/iam_api/signing_certificates/index.md | 41 ++ .../aws/iam_api/ssh_public_keys/index.md | 35 ++ .../aws/iam_api/user_from_groups/index.md | 32 ++ .../user_permissions_boundaries/index.md | 33 ++ .../aws/iam_api/user_policies/index.md | 41 ++ .../providers/aws/iam_api/user_tags/index.md | 35 ++ .../aws/iam_api/user_to_groups/index.md | 32 ++ .../providers/aws/iam_api/users/index.md | 47 +++ .../aws/iam_api/virtual_mfa_devices/index.md | 41 ++ .../aws/identitystore/group/index.md | 95 +++++ .../identitystore/group_membership/index.md | 84 ++++ .../identitystore/group_memberships/index.md | 80 ++++ .../aws/identitystore/groups/index.md | 80 ++++ .../providers/aws/identitystore/index.md | 41 ++ .../aws/imagebuilder/component/index.md | 103 +++++ .../aws/imagebuilder/components/index.md | 87 ++++ .../imagebuilder/container_recipe/index.md | 109 +++++ .../imagebuilder/container_recipes/index.md | 92 +++++ .../distribution_configuration/index.md | 101 +++++ .../distribution_configurations/index.md | 84 ++++ .../providers/aws/imagebuilder/image/index.md | 106 +++++ .../aws/imagebuilder/image_pipeline/index.md | 120 ++++++ .../aws/imagebuilder/image_pipelines/index.md | 88 ++++ .../aws/imagebuilder/image_recipe/index.md | 97 +++++ .../aws/imagebuilder/image_recipes/index.md | 84 ++++ .../aws/imagebuilder/images/index.md | 88 ++++ .../providers/aws/imagebuilder/index.md | 55 +++ .../infrastructure_configuration/index.md | 118 ++++++ .../infrastructure_configurations/index.md | 84 ++++ .../imagebuilder/lifecycle_policies/index.md | 80 ++++ .../imagebuilder/lifecycle_policy/index.md | 107 +++++ .../aws/imagebuilder/workflow/index.md | 97 +++++ .../aws/imagebuilder/workflows/index.md | 86 ++++ .../aws/inspector/assessment_target/index.md | 92 +++++ .../aws/inspector/assessment_targets/index.md | 79 ++++ .../inspector/assessment_template/index.md | 87 ++++ .../inspector/assessment_templates/index.md | 79 ++++ .../aws-docs/providers/aws/inspector/index.md | 43 ++ .../aws/inspector/resource_group/index.md | 79 ++++ .../aws/inspector/resource_groups/index.md | 67 +++ .../cis_scan_configuration/index.md | 104 +++++ .../cis_scan_configurations/index.md | 80 ++++ .../providers/aws/inspectorv2/filter/index.md | 97 +++++ .../aws/inspectorv2/filters/index.md | 78 ++++ .../providers/aws/inspectorv2/index.md | 41 ++ .../providers/aws/internetmonitor/index.md | 39 ++ .../aws/internetmonitor/monitor/index.md | 137 +++++++ .../aws/internetmonitor/monitors/index.md | 88 ++++ .../iot/account_audit_configuration/index.md | 96 +++++ .../iot/account_audit_configurations/index.md | 79 ++++ .../providers/aws/iot/authorizer/index.md | 110 +++++ .../providers/aws/iot/authorizers/index.md | 80 ++++ .../providers/aws/iot/billing_group/index.md | 101 +++++ .../providers/aws/iot/billing_groups/index.md | 81 ++++ .../providers/aws/iot/ca_certificate/index.md | 114 ++++++ .../aws/iot/ca_certificates/index.md | 82 ++++ .../providers/aws/iot/certificate/index.md | 102 +++++ .../aws/iot/certificate_provider/index.md | 101 +++++ .../aws/iot/certificate_providers/index.md | 80 ++++ .../providers/aws/iot/certificates/index.md | 80 ++++ .../providers/aws/iot/custom_metric/index.md | 100 +++++ .../providers/aws/iot/custom_metrics/index.md | 78 ++++ .../providers/aws/iot/dimension/index.md | 100 +++++ .../providers/aws/iot/dimensions/index.md | 78 ++++ .../aws/iot/domain_configuration/index.md | 118 ++++++ .../aws/iot/domain_configurations/index.md | 82 ++++ .../providers/aws/iot/fleet_metric/index.md | 119 ++++++ .../providers/aws/iot/fleet_metrics/index.md | 79 ++++ docs/aws-docs/providers/aws/iot/index.md | 89 ++++ .../providers/aws/iot/job_template/index.md | 103 +++++ .../providers/aws/iot/job_templates/index.md | 80 ++++ .../providers/aws/iot/logging/index.md | 94 +++++ .../providers/aws/iot/loggings/index.md | 79 ++++ .../aws/iot/mitigation_action/index.md | 103 +++++ .../aws/iot/mitigation_actions/index.md | 80 ++++ .../providers/aws/iot/policies/index.md | 80 ++++ .../providers/aws/iot/policy/index.md | 106 +++++ .../aws/iot/provisioning_template/index.md | 114 ++++++ .../aws/iot/provisioning_templates/index.md | 82 ++++ .../iot/resource_specific_logging/index.md | 95 +++++ .../iot/resource_specific_loggings/index.md | 78 ++++ .../providers/aws/iot/role_alias/index.md | 105 +++++ .../providers/aws/iot/role_aliases/index.md | 82 ++++ .../aws/iot/scheduled_audit/index.md | 104 +++++ .../aws/iot/scheduled_audits/index.md | 79 ++++ .../aws/iot/security_profile/index.md | 113 ++++++ .../aws/iot/security_profiles/index.md | 81 ++++ .../aws/iot/software_package/index.md | 107 +++++ .../aws/iot/software_package_version/index.md | 110 +++++ .../iot/software_package_versions/index.md | 82 ++++ .../aws/iot/software_packages/index.md | 80 ++++ .../aws-docs/providers/aws/iot/thing/index.md | 95 +++++ .../providers/aws/iot/thing_group/index.md | 107 +++++ .../providers/aws/iot/thing_groups/index.md | 82 ++++ .../providers/aws/iot/thing_type/index.md | 105 +++++ .../providers/aws/iot/thing_types/index.md | 82 ++++ .../providers/aws/iot/things/index.md | 78 ++++ .../providers/aws/iot/topic_rule/index.md | 100 +++++ .../aws/iot/topic_rule_destination/index.md | 98 +++++ .../aws/iot/topic_rule_destinations/index.md | 80 ++++ .../providers/aws/iot/topic_rules/index.md | 81 ++++ .../aws/iotanalytics/dataset/index.md | 106 +++++ .../aws/iotanalytics/datasets/index.md | 77 ++++ .../providers/aws/iotanalytics/index.md | 41 ++ .../aws/iotanalytics/pipeline/index.md | 96 +++++ .../aws/iotanalytics/pipelines/index.md | 77 ++++ .../aws/iotcoredeviceadvisor/index.md | 39 ++ .../suite_definition/index.md | 110 +++++ .../suite_definitions/index.md | 88 ++++ .../aws/iotevents/alarm_model/index.md | 111 +++++ .../aws/iotevents/alarm_models/index.md | 82 ++++ .../aws/iotevents/detector_model/index.md | 107 +++++ .../aws/iotevents/detector_models/index.md | 82 ++++ .../aws-docs/providers/aws/iotevents/index.md | 43 ++ .../providers/aws/iotevents/input/index.md | 99 +++++ .../providers/aws/iotevents/inputs/index.md | 80 ++++ .../aws/iotfleethub/application/index.md | 114 ++++++ .../aws/iotfleethub/applications/index.md | 81 ++++ .../providers/aws/iotfleethub/index.md | 39 ++ .../aws/iotfleetwise/campaign/index.md | 133 ++++++ .../aws/iotfleetwise/campaigns/index.md | 84 ++++ .../iotfleetwise/decoder_manifest/index.md | 115 ++++++ .../iotfleetwise/decoder_manifests/index.md | 83 ++++ .../providers/aws/iotfleetwise/fleet/index.md | 105 +++++ .../aws/iotfleetwise/fleets/index.md | 81 ++++ .../providers/aws/iotfleetwise/index.md | 49 +++ .../aws/iotfleetwise/model_manifest/index.md | 111 +++++ .../aws/iotfleetwise/model_manifests/index.md | 82 ++++ .../aws/iotfleetwise/signal_catalog/index.md | 109 +++++ .../aws/iotfleetwise/signal_catalogs/index.md | 81 ++++ .../aws/iotfleetwise/vehicle/index.md | 109 +++++ .../aws/iotfleetwise/vehicles/index.md | 83 ++++ .../aws/iotsitewise/access_policies/index.md | 77 ++++ .../aws/iotsitewise/access_policy/index.md | 97 +++++ .../providers/aws/iotsitewise/asset/index.md | 130 ++++++ .../aws/iotsitewise/asset_model/index.md | 122 ++++++ .../aws/iotsitewise/asset_models/index.md | 90 +++++ .../providers/aws/iotsitewise/assets/index.md | 88 ++++ .../aws/iotsitewise/dashboard/index.md | 109 +++++ .../aws/iotsitewise/dashboards/index.md | 84 ++++ .../aws/iotsitewise/gateway/index.md | 105 +++++ .../aws/iotsitewise/gateways/index.md | 86 ++++ .../providers/aws/iotsitewise/index.md | 51 +++ .../providers/aws/iotsitewise/portal/index.md | 119 ++++++ .../aws/iotsitewise/portals/index.md | 83 ++++ .../aws/iotsitewise/project/index.md | 109 +++++ .../aws/iotsitewise/projects/index.md | 82 ++++ .../aws/iottwinmaker/component_type/index.md | 126 ++++++ .../aws/iottwinmaker/component_types/index.md | 86 ++++ .../aws/iottwinmaker/entities/index.md | 88 ++++ .../aws/iottwinmaker/entity/index.md | 128 ++++++ .../providers/aws/iottwinmaker/index.md | 47 +++ .../providers/aws/iottwinmaker/scene/index.md | 116 ++++++ .../aws/iottwinmaker/scenes/index.md | 85 ++++ .../aws/iottwinmaker/sync_job/index.md | 95 +++++ .../aws/iottwinmaker/sync_jobs/index.md | 86 ++++ .../aws/iottwinmaker/workspace/index.md | 107 +++++ .../aws/iottwinmaker/workspaces/index.md | 83 ++++ .../aws/iotwireless/destination/index.md | 103 +++++ .../aws/iotwireless/destinations/index.md | 81 ++++ .../aws/iotwireless/device_profile/index.md | 86 ++++ .../aws/iotwireless/device_profiles/index.md | 80 ++++ .../aws/iotwireless/fuota_task/index.md | 119 ++++++ .../aws/iotwireless/fuota_tasks/index.md | 82 ++++ .../providers/aws/iotwireless/index.md | 59 +++ .../aws/iotwireless/multicast_group/index.md | 108 +++++ .../aws/iotwireless/multicast_groups/index.md | 80 ++++ .../network_analyzer_configuration/index.md | 102 +++++ .../network_analyzer_configurations/index.md | 80 ++++ .../aws/iotwireless/partner_account/index.md | 106 +++++ .../aws/iotwireless/partner_accounts/index.md | 80 ++++ .../aws/iotwireless/service_profile/index.md | 86 ++++ .../aws/iotwireless/service_profiles/index.md | 80 ++++ .../aws/iotwireless/task_definition/index.md | 92 +++++ .../aws/iotwireless/task_definitions/index.md | 82 ++++ .../aws/iotwireless/wireless_device/index.md | 114 ++++++ .../wireless_device_import_task/index.md | 113 ++++++ .../wireless_device_import_tasks/index.md | 82 ++++ .../aws/iotwireless/wireless_devices/index.md | 80 ++++ .../aws/iotwireless/wireless_gateway/index.md | 108 +++++ .../iotwireless/wireless_gateways/index.md | 80 ++++ .../providers/aws/ivs/channel/index.md | 113 ++++++ .../providers/aws/ivs/channels/index.md | 79 ++++ .../aws/ivs/encoder_configuration/index.md | 98 +++++ .../aws/ivs/encoder_configurations/index.md | 79 ++++ docs/aws-docs/providers/aws/ivs/index.md | 53 +++ .../aws/ivs/playback_key_pair/index.md | 99 +++++ .../aws/ivs/playback_key_pairs/index.md | 79 ++++ .../playback_restriction_policies/index.md | 79 ++++ .../ivs/playback_restriction_policy/index.md | 103 +++++ .../aws/ivs/recording_configuration/index.md | 113 ++++++ .../aws/ivs/recording_configurations/index.md | 87 ++++ .../aws-docs/providers/aws/ivs/stage/index.md | 99 +++++ .../providers/aws/ivs/stages/index.md | 81 ++++ .../aws/ivs/storage_configuration/index.md | 102 +++++ .../aws/ivs/storage_configurations/index.md | 84 ++++ .../providers/aws/ivs/stream_key/index.md | 98 +++++ .../providers/aws/ivs/stream_keys/index.md | 80 ++++ docs/aws-docs/providers/aws/ivschat/index.md | 41 ++ .../ivschat/logging_configuration/index.md | 119 ++++++ .../ivschat/logging_configurations/index.md | 88 ++++ .../providers/aws/ivschat/room/index.md | 106 +++++ .../providers/aws/ivschat/rooms/index.md | 79 ++++ .../aws/kafkaconnect/connector/index.md | 132 ++++++ .../aws/kafkaconnect/connectors/index.md | 95 +++++ .../aws/kafkaconnect/custom_plugin/index.md | 106 +++++ .../aws/kafkaconnect/custom_plugins/index.md | 84 ++++ .../providers/aws/kafkaconnect/index.md | 43 ++ .../worker_configuration/index.md | 102 +++++ .../worker_configurations/index.md | 80 ++++ .../providers/aws/kendra/data_source/index.md | 116 ++++++ .../aws/kendra/data_sources/index.md | 83 ++++ .../providers/aws/kendra/faq/index.md | 109 +++++ .../providers/aws/kendra/faqs/index.md | 83 ++++ docs/aws-docs/providers/aws/kendra/index.md | 43 ++ .../providers/aws/kendra/index/index.md | 116 ++++++ .../providers/aws/kendra/indices/index.md | 82 ++++ .../aws/kendraranking/execution_plan/index.md | 103 +++++ .../kendraranking/execution_plans/index.md | 81 ++++ .../providers/aws/kendraranking/index.md | 39 ++ docs/aws-docs/providers/aws/kinesis/index.md | 39 ++ .../aws/kinesis/kinesis_stream/index.md | 113 ++++++ .../providers/aws/kinesis/streams/index.md | 83 ++++ .../kinesisanalyticsv2/application/index.md | 112 ++++++ .../kinesisanalyticsv2/applications/index.md | 81 ++++ .../providers/aws/kinesisanalyticsv2/index.md | 39 ++ .../kinesisfirehose/delivery_stream/index.md | 130 ++++++ .../kinesisfirehose/delivery_streams/index.md | 82 ++++ .../providers/aws/kinesisfirehose/index.md | 39 ++ .../providers/aws/kinesisvideo/index.md | 41 ++ .../kinesisvideo/kinesisvideo_stream/index.md | 102 +++++ .../kinesisvideo/signaling_channel/index.md | 97 +++++ .../kinesisvideo/signaling_channels/index.md | 68 ++++ .../aws/kinesisvideo/streams/index.md | 68 ++++ .../aws-docs/providers/aws/kms/alias/index.md | 89 ++++ .../providers/aws/kms/aliases/index.md | 77 ++++ docs/aws-docs/providers/aws/kms/index.md | 43 ++ docs/aws-docs/providers/aws/kms/key/index.md | 126 ++++++ docs/aws-docs/providers/aws/kms/keys/index.md | 82 ++++ .../providers/aws/kms/replica_key/index.md | 110 +++++ .../providers/aws/kms/replica_keys/index.md | 82 ++++ .../lakeformation/data_cells_filter/index.md | 89 ++++ .../lakeformation/data_cells_filters/index.md | 84 ++++ .../providers/aws/lakeformation/index.md | 44 ++ .../principal_permissions/index.md | 94 +++++ .../providers/aws/lakeformation/tag/index.md | 91 +++++ .../lakeformation/tag_association/index.md | 87 ++++ .../lakeformation/tag_associations/index.md | 71 ++++ .../providers/aws/lakeformation/tags/index.md | 77 ++++ .../aws/lambda/code_signing_config/index.md | 95 +++++ .../aws/lambda/code_signing_configs/index.md | 77 ++++ .../aws/lambda/event_invoke_config/index.md | 95 +++++ .../aws/lambda/event_invoke_configs/index.md | 79 ++++ .../aws/lambda/event_source_mapping/index.md | 135 +++++++ .../aws/lambda/event_source_mappings/index.md | 78 ++++ .../providers/aws/lambda/function/index.md | 171 ++++++++ .../providers/aws/lambda/functions/index.md | 101 +++++ docs/aws-docs/providers/aws/lambda/index.md | 55 +++ .../aws/lambda/layer_version/index.md | 90 +++++ .../lambda/layer_version_permission/index.md | 86 ++++ .../lambda/layer_version_permissions/index.md | 77 ++++ .../aws/lambda/layer_versions/index.md | 79 ++++ .../providers/aws/lambda/permission/index.md | 93 +++++ .../providers/aws/lambda/permissions/index.md | 79 ++++ .../providers/aws/lambda/url/index.md | 99 +++++ .../providers/aws/lambda/urls/index.md | 77 ++++ .../providers/aws/lambda/version/index.md | 97 +++++ .../providers/aws/lambda/versions/index.md | 82 ++++ docs/aws-docs/providers/aws/lex/bot/index.md | 151 +++++++ .../providers/aws/lex/bot_alias/index.md | 111 +++++ .../providers/aws/lex/bot_aliases/index.md | 80 ++++ .../providers/aws/lex/bot_version/index.md | 84 ++++ .../providers/aws/lex/bot_versions/index.md | 83 ++++ docs/aws-docs/providers/aws/lex/bots/index.md | 106 +++++ docs/aws-docs/providers/aws/lex/index.md | 45 +++ .../aws/lex/resource_policies/index.md | 78 ++++ .../aws/lex/resource_policy/index.md | 95 +++++ .../aws/licensemanager/grant/index.md | 101 +++++ .../aws/licensemanager/grants/index.md | 77 ++++ .../providers/aws/licensemanager/index.md | 41 ++ .../aws/licensemanager/license/index.md | 111 +++++ .../aws/licensemanager/licenses/index.md | 77 ++++ .../providers/aws/lightsail/alarm/index.md | 113 ++++++ .../providers/aws/lightsail/alarms/index.md | 78 ++++ .../providers/aws/lightsail/bucket/index.md | 112 ++++++ .../providers/aws/lightsail/buckets/index.md | 84 ++++ .../aws/lightsail/certificate/index.md | 100 +++++ .../aws/lightsail/certificates/index.md | 80 ++++ .../aws/lightsail/container/index.md | 112 ++++++ .../aws/lightsail/containers/index.md | 82 ++++ .../providers/aws/lightsail/database/index.md | 125 ++++++ .../aws/lightsail/databases/index.md | 84 ++++ .../aws/lightsail/distribution/index.md | 120 ++++++ .../aws/lightsail/distributions/index.md | 86 ++++ .../aws-docs/providers/aws/lightsail/index.md | 57 +++ .../providers/aws/lightsail/instance/index.md | 140 +++++++ .../aws/lightsail/instances/index.md | 90 +++++ .../aws/lightsail/load_balancer/index.md | 115 ++++++ .../load_balancer_tls_certificate/index.md | 107 +++++ .../load_balancer_tls_certificates/index.md | 84 ++++ .../aws/lightsail/load_balancers/index.md | 85 ++++ .../aws/lightsail/static_ip/index.md | 102 +++++ .../aws/lightsail/static_ips/index.md | 82 ++++ .../providers/aws/location/api_key/index.md | 124 ++++++ .../providers/aws/location/api_keys/index.md | 90 +++++ .../aws/location/geofence_collection/index.md | 113 ++++++ .../location/geofence_collections/index.md | 82 ++++ docs/aws-docs/providers/aws/location/index.md | 51 +++ .../providers/aws/location/map/index.md | 108 +++++ .../providers/aws/location/maps/index.md | 80 ++++ .../aws/location/place_index/index.md | 110 +++++ .../aws/location/place_indices/index.md | 80 ++++ .../aws/location/route_calculator/index.md | 108 +++++ .../aws/location/route_calculators/index.md | 80 ++++ .../providers/aws/location/tracker/index.md | 119 ++++++ .../aws/location/tracker_consumer/index.md | 80 ++++ .../aws/location/tracker_consumers/index.md | 80 ++++ .../providers/aws/location/trackers/index.md | 82 ++++ .../aws/logs/account_policies/index.md | 89 ++++ .../aws/logs/account_policy/index.md | 111 +++++ .../providers/aws/logs/deliveries/index.md | 84 ++++ .../providers/aws/logs/delivery/index.md | 103 +++++ .../aws/logs/delivery_destination/index.md | 107 +++++ .../aws/logs/delivery_destinations/index.md | 84 ++++ .../aws/logs/delivery_source/index.md | 104 +++++ .../aws/logs/delivery_sources/index.md | 84 ++++ .../providers/aws/logs/destination/index.md | 98 +++++ .../providers/aws/logs/destinations/index.md | 80 ++++ docs/aws-docs/providers/aws/logs/index.md | 59 +++ .../aws/logs/log_anomaly_detector/index.md | 107 +++++ .../aws/logs/log_anomaly_detectors/index.md | 77 ++++ .../providers/aws/logs/log_stream/index.md | 79 ++++ .../providers/aws/logs/log_streams/index.md | 80 ++++ .../providers/aws/logs/metric_filter/index.md | 94 +++++ .../aws/logs/metric_filters/index.md | 80 ++++ .../aws/logs/query_definition/index.md | 93 +++++ .../aws/logs/query_definitions/index.md | 77 ++++ .../aws/logs/resource_policies/index.md | 78 ++++ .../aws/logs/resource_policy/index.md | 91 +++++ .../aws/logs/subscription_filter/index.md | 99 +++++ .../aws/logs/subscription_filters/index.md | 81 ++++ .../providers/aws/lookoutequipment/index.md | 39 ++ .../inference_scheduler/index.md | 110 +++++ .../inference_schedulers/index.md | 79 ++++ .../aws/lookoutmetrics/alert/index.md | 87 ++++ .../aws/lookoutmetrics/alerts/index.md | 78 ++++ .../lookoutmetrics/anomaly_detector/index.md | 101 +++++ .../lookoutmetrics/anomaly_detectors/index.md | 80 ++++ .../providers/aws/lookoutmetrics/index.md | 41 ++ .../providers/aws/lookoutvision/index.md | 39 ++ .../aws/lookoutvision/project/index.md | 84 ++++ .../aws/lookoutvision/projects/index.md | 77 ++++ .../providers/aws/m2/application/index.md | 114 ++++++ .../providers/aws/m2/applications/index.md | 85 ++++ .../providers/aws/m2/environment/index.md | 122 ++++++ .../providers/aws/m2/environments/index.md | 95 +++++ docs/aws-docs/providers/aws/m2/index.md | 41 ++ .../providers/aws/macie/allow_list/index.md | 102 +++++ .../providers/aws/macie/allow_lists/index.md | 79 ++++ .../aws/macie/custom_data_identifier/index.md | 104 +++++ .../macie/custom_data_identifiers/index.md | 79 ++++ .../aws/macie/findings_filter/index.md | 104 +++++ .../aws/macie/findings_filters/index.md | 79 ++++ docs/aws-docs/providers/aws/macie/index.md | 45 +++ .../providers/aws/macie/session/index.md | 94 +++++ .../providers/aws/macie/sessions/index.md | 78 ++++ .../aws/managedblockchain/accessor/index.md | 104 +++++ .../aws/managedblockchain/accessors/index.md | 79 ++++ .../providers/aws/managedblockchain/index.md | 39 ++ .../aws/mediaconnect/bridge/index.md | 105 +++++ .../aws/mediaconnect/bridge_output/index.md | 92 +++++ .../aws/mediaconnect/bridge_outputs/index.md | 70 ++++ .../aws/mediaconnect/bridge_source/index.md | 94 +++++ .../aws/mediaconnect/bridge_sources/index.md | 70 ++++ .../aws/mediaconnect/bridges/index.md | 78 ++++ .../providers/aws/mediaconnect/flow/index.md | 100 +++++ .../mediaconnect/flow_entitlement/index.md | 103 +++++ .../mediaconnect/flow_entitlements/index.md | 78 ++++ .../aws/mediaconnect/flow_output/index.md | 117 ++++++ .../aws/mediaconnect/flow_outputs/index.md | 78 ++++ .../aws/mediaconnect/flow_source/index.md | 129 ++++++ .../aws/mediaconnect/flow_sources/index.md | 80 ++++ .../mediaconnect/flow_vpc_interface/index.md | 100 +++++ .../mediaconnect/flow_vpc_interfaces/index.md | 81 ++++ .../providers/aws/mediaconnect/flows/index.md | 78 ++++ .../aws/mediaconnect/gateway/index.md | 87 ++++ .../aws/mediaconnect/gateways/index.md | 79 ++++ .../providers/aws/mediaconnect/index.md | 55 +++ .../aws-docs/providers/aws/medialive/index.md | 41 ++ .../aws/medialive/multiplex/index.md | 109 +++++ .../aws/medialive/multiplexes/index.md | 79 ++++ .../aws/medialive/multiplexprogram/index.md | 101 +++++ .../aws/medialive/multiplexprograms/index.md | 80 ++++ .../providers/aws/mediapackage/asset/index.md | 94 +++++ .../aws/mediapackage/assets/index.md | 81 ++++ .../aws/mediapackage/channel/index.md | 101 +++++ .../aws/mediapackage/channels/index.md | 82 ++++ .../providers/aws/mediapackage/index.md | 47 +++ .../aws/mediapackage/origin_endpoint/index.md | 118 ++++++ .../mediapackage/origin_endpoints/index.md | 82 ++++ .../packaging_configuration/index.md | 92 +++++ .../packaging_configurations/index.md | 81 ++++ .../aws/mediapackage/packaging_group/index.md | 103 +++++ .../mediapackage/packaging_groups/index.md | 82 ++++ .../aws/mediapackagev2/channel/index.md | 105 +++++ .../aws/mediapackagev2/channel_group/index.md | 103 +++++ .../mediapackagev2/channel_groups/index.md | 78 ++++ .../mediapackagev2/channel_policies/index.md | 70 ++++ .../mediapackagev2/channel_policy/index.md | 93 +++++ .../aws/mediapackagev2/channels/index.md | 78 ++++ .../providers/aws/mediapackagev2/index.md | 47 +++ .../mediapackagev2/origin_endpoint/index.md | 116 ++++++ .../origin_endpoint_policies/index.md | 72 ++++ .../origin_endpoint_policy/index.md | 95 +++++ .../mediapackagev2/origin_endpoints/index.md | 79 ++++ .../aws/mediatailor/channel/index.md | 111 +++++ .../aws/mediatailor/channel_policies/index.md | 68 ++++ .../aws/mediatailor/channel_policy/index.md | 91 +++++ .../aws/mediatailor/channels/index.md | 81 ++++ .../providers/aws/mediatailor/index.md | 49 +++ .../aws/mediatailor/live_source/index.md | 99 +++++ .../aws/mediatailor/live_sources/index.md | 81 ++++ .../playback_configuration/index.md | 125 ++++++ .../playback_configurations/index.md | 81 ++++ .../aws/mediatailor/source_location/index.md | 106 +++++ .../aws/mediatailor/source_locations/index.md | 82 ++++ .../aws/mediatailor/vod_source/index.md | 99 +++++ .../aws/mediatailor/vod_sources/index.md | 81 ++++ .../providers/aws/memorydb/acl/index.md | 102 +++++ .../providers/aws/memorydb/acls/index.md | 81 ++++ .../providers/aws/memorydb/cluster/index.md | 147 +++++++ .../providers/aws/memorydb/clusters/index.md | 79 ++++ docs/aws-docs/providers/aws/memorydb/index.md | 47 +++ .../aws/memorydb/parameter_group/index.md | 104 +++++ .../aws/memorydb/parameter_groups/index.md | 80 ++++ .../aws/memorydb/subnet_group/index.md | 101 +++++ .../aws/memorydb/subnet_groups/index.md | 80 ++++ .../providers/aws/memorydb/user/index.md | 103 +++++ .../providers/aws/memorydb/users/index.md | 81 ++++ .../aws/msk/batch_scram_secret/index.md | 100 +++++ .../aws/msk/batch_scram_secrets/index.md | 84 ++++ .../providers/aws/msk/cluster/index.md | 145 +++++++ .../aws/msk/cluster_policies/index.md | 78 ++++ .../providers/aws/msk/cluster_policy/index.md | 93 +++++ .../providers/aws/msk/clusters/index.md | 99 +++++ .../providers/aws/msk/configuration/index.md | 99 +++++ .../providers/aws/msk/configurations/index.md | 78 ++++ docs/aws-docs/providers/aws/msk/index.md | 51 +++ .../providers/aws/msk/replicator/index.md | 109 +++++ .../providers/aws/msk/replicators/index.md | 89 ++++ .../aws/msk/serverless_cluster/index.md | 87 ++++ .../aws/msk/serverless_clusters/index.md | 86 ++++ .../providers/aws/msk/vpc_connection/index.md | 112 ++++++ .../aws/msk/vpc_connections/index.md | 96 +++++ .../providers/aws/mwaa/environment/index.md | 143 +++++++ .../providers/aws/mwaa/environments/index.md | 77 ++++ docs/aws-docs/providers/aws/mwaa/index.md | 39 ++ .../providers/aws/neptune/db_cluster/index.md | 166 ++++++++ .../aws/neptune/db_clusters/index.md | 89 ++++ docs/aws-docs/providers/aws/neptune/index.md | 39 ++ .../providers/aws/neptunegraph/graph/index.md | 121 ++++++ .../aws/neptunegraph/graphs/index.md | 89 ++++ .../providers/aws/neptunegraph/index.md | 41 ++ .../private_graph_endpoint/index.md | 108 +++++ .../private_graph_endpoints/index.md | 90 +++++ .../aws/networkfirewall/firewall/index.md | 127 ++++++ .../firewall_policies/index.md | 81 ++++ .../networkfirewall/firewall_policy/index.md | 105 +++++ .../aws/networkfirewall/firewalls/index.md | 88 ++++ .../providers/aws/networkfirewall/index.md | 47 +++ .../logging_configuration/index.md | 110 +++++ .../logging_configurations/index.md | 90 +++++ .../aws/networkfirewall/rule_group/index.md | 109 +++++ .../aws/networkfirewall/rule_groups/index.md | 82 ++++ .../tls_inspection_configuration/index.md | 103 +++++ .../tls_inspection_configurations/index.md | 80 ++++ .../connect_attachment/index.md | 123 ++++++ .../connect_attachments/index.md | 80 ++++ .../aws/networkmanager/connect_peer/index.md | 117 ++++++ .../aws/networkmanager/connect_peers/index.md | 80 ++++ .../aws/networkmanager/core_network/index.md | 120 ++++++ .../aws/networkmanager/core_networks/index.md | 81 ++++ .../customer_gateway_association/index.md | 83 ++++ .../customer_gateway_associations/index.md | 80 ++++ .../aws/networkmanager/device/index.md | 118 ++++++ .../aws/networkmanager/devices/index.md | 81 ++++ .../networkmanager/global_network/index.md | 102 +++++ .../networkmanager/global_networks/index.md | 80 ++++ .../providers/aws/networkmanager/index.md | 65 +++ .../aws/networkmanager/link/index.md | 112 ++++++ .../networkmanager/link_association/index.md | 81 ++++ .../networkmanager/link_associations/index.md | 82 ++++ .../aws/networkmanager/links/index.md | 81 ++++ .../aws/networkmanager/site/index.md | 106 +++++ .../site_to_site_vpn_attachment/index.md | 121 ++++++ .../site_to_site_vpn_attachments/index.md | 80 ++++ .../aws/networkmanager/sites/index.md | 81 ++++ .../transit_gateway_peering/index.md | 116 ++++++ .../transit_gateway_peerings/index.md | 83 ++++ .../transit_gateway_registration/index.md | 80 ++++ .../transit_gateway_registrations/index.md | 80 ++++ .../index.md | 123 ++++++ .../index.md | 81 ++++ .../networkmanager/vpc_attachment/index.md | 127 ++++++ .../networkmanager/vpc_attachments/index.md | 81 ++++ .../providers/aws/nimblestudio/index.md | 45 +++ .../aws/nimblestudio/launch_profile/index.md | 110 +++++ .../aws/nimblestudio/launch_profiles/index.md | 85 ++++ .../aws/nimblestudio/streaming_image/index.md | 119 ++++++ .../nimblestudio/streaming_images/index.md | 92 +++++ .../aws/nimblestudio/studio/index.md | 125 ++++++ .../nimblestudio/studio_component/index.md | 120 ++++++ .../nimblestudio/studio_components/index.md | 86 ++++ .../aws/nimblestudio/studios/index.md | 86 ++++ docs/aws-docs/providers/aws/oam/index.md | 41 ++ docs/aws-docs/providers/aws/oam/link/index.md | 108 +++++ .../aws-docs/providers/aws/oam/links/index.md | 83 ++++ docs/aws-docs/providers/aws/oam/sink/index.md | 100 +++++ .../aws-docs/providers/aws/oam/sinks/index.md | 80 ++++ .../aws/omics/annotation_store/index.md | 118 ++++++ .../aws/omics/annotation_stores/index.md | 84 ++++ docs/aws-docs/providers/aws/omics/index.md | 49 +++ .../aws/omics/reference_store/index.md | 90 +++++ .../aws/omics/reference_stores/index.md | 78 ++++ .../providers/aws/omics/run_group/index.md | 108 +++++ .../providers/aws/omics/run_groups/index.md | 78 ++++ .../aws/omics/sequence_store/index.md | 92 +++++ .../aws/omics/sequence_stores/index.md | 78 ++++ .../aws/omics/variant_store/index.md | 114 ++++++ .../aws/omics/variant_stores/index.md | 84 ++++ .../providers/aws/omics/workflow/index.md | 118 ++++++ .../providers/aws/omics/workflows/index.md | 89 ++++ .../access_policies/index.md | 80 ++++ .../access_policy/index.md | 95 +++++ .../opensearchserverless/collection/index.md | 105 +++++ .../opensearchserverless/collections/index.md | 79 ++++ .../aws/opensearchserverless/index.md | 49 +++ .../lifecycle_policies/index.md | 79 ++++ .../lifecycle_policy/index.md | 94 +++++ .../security_config/index.md | 96 +++++ .../security_configs/index.md | 77 ++++ .../security_policies/index.md | 82 ++++ .../security_policy/index.md | 98 +++++ .../vpc_endpoint/index.md | 129 ++++++ .../vpc_endpoints/index.md | 95 +++++ .../aws/opensearchservice/domain/index.md | 143 +++++++ .../aws/opensearchservice/domains/index.md | 70 ++++ .../providers/aws/opensearchservice/index.md | 39 ++ .../providers/aws/opsworkscm/index.md | 39 ++ .../providers/aws/opsworkscm/server/index.md | 135 +++++++ .../providers/aws/opsworkscm/servers/index.md | 80 ++++ .../aws/organizations/account/index.md | 113 ++++++ .../aws/organizations/accounts/index.md | 83 ++++ .../providers/aws/organizations/index.md | 47 +++ .../aws/organizations/organization/index.md | 96 +++++ .../organizational_unit/index.md | 102 +++++ .../organizational_units/index.md | 81 ++++ .../aws/organizations/organizations/index.md | 80 ++++ .../aws/organizations/policies/index.md | 82 ++++ .../aws/organizations/policy/index.md | 113 ++++++ .../organizations/resource_policies/index.md | 80 ++++ .../organizations/resource_policy/index.md | 98 +++++ docs/aws-docs/providers/aws/osis/index.md | 39 ++ .../providers/aws/osis/pipeline/index.md | 123 ++++++ .../providers/aws/osis/pipelines/index.md | 84 ++++ .../panorama/application_instance/index.md | 137 +++++++ .../panorama/application_instances/index.md | 89 ++++ docs/aws-docs/providers/aws/panorama/index.md | 43 ++ .../providers/aws/panorama/package/index.md | 117 ++++++ .../aws/panorama/package_version/index.md | 124 ++++++ .../aws/panorama/package_versions/index.md | 76 ++++ .../providers/aws/panorama/packages/index.md | 87 ++++ .../aws/pcaconnectorad/connector/index.md | 101 +++++ .../aws/pcaconnectorad/connectors/index.md | 86 ++++ .../directory_registration/index.md | 98 +++++ .../directory_registrations/index.md | 80 ++++ .../providers/aws/pcaconnectorad/index.md | 47 +++ .../service_principal_name/index.md | 81 ++++ .../service_principal_names/index.md | 81 ++++ .../aws/pcaconnectorad/template/index.md | 102 +++++ .../index.md | 79 ++++ .../index.md | 94 +++++ .../aws/pcaconnectorad/templates/index.md | 77 ++++ .../aws/personalize/dataset/index.md | 101 +++++ .../aws/personalize/dataset_group/index.md | 86 ++++ .../aws/personalize/dataset_groups/index.md | 79 ++++ .../aws/personalize/datasets/index.md | 81 ++++ .../providers/aws/personalize/index.md | 45 +++ .../providers/aws/personalize/schema/index.md | 84 ++++ .../aws/personalize/schemata/index.md | 78 ++++ .../aws/personalize/solution/index.md | 92 +++++ .../aws/personalize/solutions/index.md | 78 ++++ .../aws/pinpoint/in_app_template/index.md | 102 +++++ .../aws/pinpoint/in_app_templates/index.md | 80 ++++ docs/aws-docs/providers/aws/pinpoint/index.md | 39 ++ docs/aws-docs/providers/aws/pipes/index.md | 39 ++ .../providers/aws/pipes/pipe/index.md | 141 +++++++ .../providers/aws/pipes/pipes/index.md | 90 +++++ .../environment_account_connection/index.md | 118 ++++++ .../environment_account_connections/index.md | 81 ++++ .../aws/proton/environment_template/index.md | 109 +++++ .../aws/proton/environment_templates/index.md | 80 ++++ docs/aws-docs/providers/aws/proton/index.md | 43 ++ .../aws/proton/service_template/index.md | 110 +++++ .../aws/proton/service_templates/index.md | 80 ++++ docs/aws-docs/providers/aws/qldb/index.md | 39 ++ .../providers/aws/qldb/qldb_stream/index.md | 107 +++++ .../providers/aws/qldb/streams/index.md | 81 ++++ .../aws/quicksight/analyses/index.md | 87 ++++ .../aws/quicksight/analysis/index.md | 131 ++++++ .../aws/quicksight/dashboard/index.md | 137 +++++++ .../aws/quicksight/dashboards/index.md | 87 ++++ .../aws/quicksight/data_set/index.md | 151 +++++++ .../aws/quicksight/data_sets/index.md | 90 +++++ .../aws/quicksight/data_source/index.md | 128 ++++++ .../aws/quicksight/data_sources/index.md | 84 ++++ .../providers/aws/quicksight/index.md | 55 +++ .../aws/quicksight/refresh_schedule/index.md | 95 +++++ .../aws/quicksight/refresh_schedules/index.md | 82 ++++ .../aws/quicksight/template/index.md | 121 ++++++ .../aws/quicksight/templates/index.md | 85 ++++ .../providers/aws/quicksight/theme/index.md | 120 ++++++ .../providers/aws/quicksight/themes/index.md | 84 ++++ .../providers/aws/quicksight/topic/index.md | 101 +++++ .../providers/aws/quicksight/topics/index.md | 81 ++++ .../aws/quicksight/vpc_connection/index.md | 124 ++++++ .../aws/quicksight/vpc_connections/index.md | 83 ++++ docs/aws-docs/providers/aws/ram/index.md | 39 ++ .../providers/aws/ram/permission/index.md | 110 +++++ .../providers/aws/ram/permissions/index.md | 79 ++++ .../aws/rds/customdb_engine_version/index.md | 115 ++++++ .../aws/rds/customdb_engine_versions/index.md | 99 +++++ .../providers/aws/rds/db_cluster/index.md | 224 +++++++++++ .../rds/db_cluster_parameter_group/index.md | 106 +++++ .../rds/db_cluster_parameter_groups/index.md | 86 ++++ .../providers/aws/rds/db_clusters/index.md | 90 +++++ .../providers/aws/rds/db_instance/index.md | 280 +++++++++++++ .../providers/aws/rds/db_instances/index.md | 106 +++++ .../aws/rds/db_parameter_group/index.md | 105 +++++ .../aws/rds/db_parameter_groups/index.md | 85 ++++ .../providers/aws/rds/db_proxies/index.md | 79 ++++ .../providers/aws/rds/db_proxy/index.md | 115 ++++++ .../aws/rds/db_proxy_endpoint/index.md | 109 +++++ .../aws/rds/db_proxy_endpoints/index.md | 78 ++++ .../aws/rds/db_proxy_target_group/index.md | 101 +++++ .../aws/rds/db_proxy_target_groups/index.md | 80 ++++ .../aws/rds/db_subnet_group/index.md | 100 +++++ .../aws/rds/db_subnet_groups/index.md | 82 ++++ .../aws/rds/event_subscription/index.md | 107 +++++ .../aws/rds/event_subscriptions/index.md | 82 ++++ .../providers/aws/rds/global_cluster/index.md | 101 +++++ .../aws/rds/global_clusters/index.md | 79 ++++ docs/aws-docs/providers/aws/rds/index.md | 63 +++ .../providers/aws/rds/integration/index.md | 109 +++++ .../providers/aws/rds/integrations/index.md | 82 ++++ .../providers/aws/rds/option_group/index.md | 105 +++++ .../providers/aws/rds/option_groups/index.md | 83 ++++ .../providers/aws/redshift/cluster/index.md | 228 +++++++++++ .../redshift/cluster_parameter_group/index.md | 109 +++++ .../cluster_parameter_groups/index.md | 95 +++++ .../redshift/cluster_subnet_group/index.md | 130 ++++++ .../redshift/cluster_subnet_groups/index.md | 101 +++++ .../providers/aws/redshift/clusters/index.md | 109 +++++ .../aws/redshift/endpoint_access/index.md | 131 ++++++ .../aws/redshift/endpoint_accesses/index.md | 92 +++++ .../redshift/endpoint_authorization/index.md | 119 ++++++ .../redshift/endpoint_authorizations/index.md | 80 ++++ .../aws/redshift/event_subscription/index.md | 121 ++++++ .../aws/redshift/event_subscriptions/index.md | 81 ++++ docs/aws-docs/providers/aws/redshift/index.md | 51 +++ .../aws/redshift/scheduled_action/index.md | 114 ++++++ .../aws/redshift/scheduled_actions/index.md | 84 ++++ .../providers/aws/redshiftserverless/index.md | 41 ++ .../aws/redshiftserverless/namespace/index.md | 156 +++++++ .../redshiftserverless/namespaces/index.md | 101 +++++ .../aws/redshiftserverless/workgroup/index.md | 135 +++++++ .../redshiftserverless/workgroups/index.md | 93 +++++ .../aws/refactorspaces/application/index.md | 119 ++++++ .../aws/refactorspaces/applications/index.md | 105 +++++ .../aws/refactorspaces/environment/index.md | 99 +++++ .../aws/refactorspaces/environments/index.md | 104 +++++ .../providers/aws/refactorspaces/index.md | 45 +++ .../aws/refactorspaces/route/index.md | 152 +++++++ .../aws/refactorspaces/routes/index.md | 103 +++++ .../aws/refactorspaces/service/index.md | 110 +++++ .../aws/refactorspaces/services/index.md | 94 +++++ .../aws/rekognition/collection/index.md | 95 +++++ .../aws/rekognition/collections/index.md | 80 ++++ .../providers/aws/rekognition/index.md | 43 ++ .../aws/rekognition/project/index.md | 85 ++++ .../aws/rekognition/projects/index.md | 77 ++++ .../aws/rekognition/stream_processor/index.md | 121 ++++++ .../rekognition/stream_processors/index.md | 81 ++++ .../providers/aws/resiliencehub/app/index.md | 131 ++++++ .../providers/aws/resiliencehub/apps/index.md | 96 +++++ .../providers/aws/resiliencehub/index.md | 41 ++ .../resiliency_policies/index.md | 79 ++++ .../resiliencehub/resiliency_policy/index.md | 105 +++++ .../default_view_association/index.md | 91 +++++ .../default_view_associations/index.md | 68 ++++ .../providers/aws/resourceexplorer2/index.md | 43 ++ .../aws/resourceexplorer2/index/index.md | 99 +++++ .../aws/resourceexplorer2/indices/index.md | 82 ++++ .../aws/resourceexplorer2/view/index.md | 102 +++++ .../aws/resourceexplorer2/views/index.md | 78 ++++ .../aws/resourcegroups/group/index.md | 114 ++++++ .../aws/resourcegroups/groups/index.md | 82 ++++ .../providers/aws/resourcegroups/index.md | 39 ++ .../providers/aws/robomaker/fleet/index.md | 92 +++++ .../providers/aws/robomaker/fleets/index.md | 77 ++++ .../aws-docs/providers/aws/robomaker/index.md | 49 +++ .../providers/aws/robomaker/robot/index.md | 100 +++++ .../aws/robomaker/robot_application/index.md | 106 +++++ .../robot_application_version/index.md | 84 ++++ .../robot_application_versions/index.md | 73 ++++ .../aws/robomaker/robot_applications/index.md | 84 ++++ .../providers/aws/robomaker/robots/index.md | 78 ++++ .../robomaker/simulation_application/index.md | 110 +++++ .../simulation_application_version/index.md | 84 ++++ .../simulation_application_versions/index.md | 73 ++++ .../simulation_applications/index.md | 84 ++++ .../providers/aws/rolesanywhere/crl/index.md | 103 +++++ .../providers/aws/rolesanywhere/crls/index.md | 80 ++++ .../providers/aws/rolesanywhere/index.md | 43 ++ .../aws/rolesanywhere/profile/index.md | 114 ++++++ .../aws/rolesanywhere/profiles/index.md | 83 ++++ .../aws/rolesanywhere/trust_anchor/index.md | 109 +++++ .../aws/rolesanywhere/trust_anchors/index.md | 81 ++++ .../aws/route53/cidr_collection/index.md | 95 +++++ .../aws/route53/cidr_collections/index.md | 79 ++++ .../providers/aws/route53/dnssec/index.md | 82 ++++ .../providers/aws/route53/dnssecs/index.md | 83 ++++ .../aws/route53/health_check/index.md | 95 +++++ .../aws/route53/health_checks/index.md | 81 ++++ .../aws/route53/hosted_zone/index.md | 112 ++++++ .../aws/route53/hosted_zones/index.md | 86 ++++ docs/aws-docs/providers/aws/route53/index.md | 47 +++ .../aws/route53/key_signing_key/index.md | 104 +++++ .../aws/route53/key_signing_keys/index.md | 84 ++++ .../route53recoverycontrol/cluster/index.md | 87 ++++ .../route53recoverycontrol/clusters/index.md | 80 ++++ .../control_panel/index.md | 105 +++++ .../control_panels/index.md | 81 ++++ .../aws/route53recoverycontrol/index.md | 45 +++ .../routing_control/index.md | 98 +++++ .../routing_controls/index.md | 80 ++++ .../safety_rule/index.md | 107 +++++ .../safety_rules/index.md | 82 ++++ .../route53recoveryreadiness/cell/index.md | 101 +++++ .../route53recoveryreadiness/cells/index.md | 80 ++++ .../aws/route53recoveryreadiness/index.md | 45 +++ .../readiness_check/index.md | 100 +++++ .../readiness_checks/index.md | 82 ++++ .../recovery_group/index.md | 100 +++++ .../recovery_groups/index.md | 81 ++++ .../resource_set/index.md | 103 +++++ .../resource_sets/index.md | 82 ++++ .../firewall_domain_list/index.md | 126 ++++++ .../firewall_domain_lists/index.md | 87 ++++ .../firewall_rule_group/index.md | 126 ++++++ .../firewall_rule_group_association/index.md | 128 ++++++ .../firewall_rule_group_associations/index.md | 87 ++++ .../firewall_rule_groups/index.md | 87 ++++ .../providers/aws/route53resolver/index.md | 57 +++ .../route53resolver/outpost_resolver/index.md | 117 ++++++ .../outpost_resolvers/index.md | 81 ++++ .../route53resolver/resolver_config/index.md | 88 ++++ .../route53resolver/resolver_configs/index.md | 80 ++++ .../resolver_query_logging_config/index.md | 99 +++++ .../index.md | 94 +++++ .../index.md | 82 ++++ .../resolver_query_logging_configs/index.md | 90 +++++ .../route53resolver/resolver_rule/index.md | 107 +++++ .../resolver_rule_association/index.md | 84 ++++ .../resolver_rule_associations/index.md | 79 ++++ .../route53resolver/resolver_rules/index.md | 80 ++++ .../resolverdnssec_config/index.md | 87 ++++ .../resolverdnssec_configs/index.md | 81 ++++ .../providers/aws/rum/app_monitor/index.md | 142 +++++++ .../providers/aws/rum/app_monitors/index.md | 107 +++++ docs/aws-docs/providers/aws/rum/index.md | 39 ++ .../providers/aws/s3/access_grant/index.md | 105 +++++ .../providers/aws/s3/access_grants/index.md | 78 ++++ .../aws/s3/access_grants_instance/index.md | 93 +++++ .../aws/s3/access_grants_instances/index.md | 78 ++++ .../aws/s3/access_grants_location/index.md | 97 +++++ .../aws/s3/access_grants_locations/index.md | 79 ++++ .../providers/aws/s3/access_point/index.md | 109 +++++ .../providers/aws/s3/access_points/index.md | 79 ++++ .../aws-docs/providers/aws/s3/bucket/index.md | 182 +++++++++ .../bucket_accelerate_configurations/index.md | 32 -- .../providers/aws/s3/bucket_acls/index.md | 36 -- .../bucket_analytics_configurations/index.md | 34 -- .../providers/aws/s3/bucket_cors/index.md | 33 -- .../aws/s3/bucket_encryptions/index.md | 33 -- .../index.md | 34 -- .../bucket_inventory_configurations/index.md | 34 -- .../bucket_lifecycle_configurations/index.md | 32 -- .../aws/s3/bucket_lifecycles/index.md | 33 -- .../aws/s3/bucket_locations/index.md | 31 -- .../providers/aws/s3/bucket_loggings/index.md | 32 -- .../s3/bucket_metrics_configurations/index.md | 34 -- .../index.md | 38 -- .../aws/s3/bucket_notifications/index.md | 37 -- .../aws/s3/bucket_ownership_controls/index.md | 33 -- .../providers/aws/s3/bucket_policies/index.md | 62 ++- .../providers/aws/s3/bucket_policy/index.md | 91 +++++ .../aws/s3/bucket_policy_status/index.md | 31 -- .../aws/s3/bucket_replications/index.md | 33 -- .../aws/s3/bucket_request_payments/index.md | 32 -- .../providers/aws/s3/bucket_taggings/index.md | 37 -- .../aws/s3/bucket_versionings/index.md | 36 -- .../providers/aws/s3/bucket_websites/index.md | 39 -- .../providers/aws/s3/buckets/index.md | 88 +++- .../aws/s3/get_object_responses/index.md | 32 -- docs/aws-docs/providers/aws/s3/index.md | 78 ++-- .../aws/s3/multi_region_access_point/index.md | 87 ++++ .../index.md | 73 ++++ .../multi_region_access_point_policy/index.md | 94 +++++ .../s3/multi_region_access_points/index.md | 79 ++++ .../aws/s3/multipart_uploads/index.md | 34 -- .../providers/aws/s3/object_acls/index.md | 36 -- .../aws/s3/object_attributes/index.md | 38 -- .../providers/aws/s3/object_contents/index.md | 32 -- .../aws/s3/object_legal_holds/index.md | 32 -- .../s3/object_lock_configurations/index.md | 32 -- .../aws/s3/object_retentions/index.md | 32 -- .../providers/aws/s3/object_taggings/index.md | 33 -- .../providers/aws/s3/object_torrents/index.md | 31 -- .../providers/aws/s3/object_versions/index.md | 32 -- .../providers/aws/s3/objects/index.md | 45 --- .../providers/aws/s3/objects_v2s/index.md | 32 -- .../providers/aws/s3/part_copies/index.md | 32 -- docs/aws-docs/providers/aws/s3/parts/index.md | 33 -- .../aws/s3/public_access_blocks/index.md | 33 -- .../providers/aws/s3/storage_lens/index.md | 99 +++++ .../aws/s3/storage_lens_group/index.md | 98 +++++ .../aws/s3/storage_lens_groups/index.md | 80 ++++ .../bucket_accelerate_configurations/index.md | 32 ++ .../providers/aws/s3_api/bucket_acls/index.md | 36 ++ .../bucket_analytics_configurations/index.md | 34 ++ .../providers/aws/s3_api/bucket_cors/index.md | 33 ++ .../aws/s3_api/bucket_encryptions/index.md | 33 ++ .../index.md | 34 ++ .../bucket_inventory_configurations/index.md | 34 ++ .../bucket_lifecycle_configurations/index.md | 32 ++ .../aws/s3_api/bucket_lifecycles/index.md | 33 ++ .../aws/s3_api/bucket_locations/index.md | 31 ++ .../aws/s3_api/bucket_loggings/index.md | 32 ++ .../bucket_metrics_configurations/index.md | 34 ++ .../index.md | 38 ++ .../aws/s3_api/bucket_notifications/index.md | 37 ++ .../s3_api/bucket_ownership_controls/index.md | 33 ++ .../aws/s3_api/bucket_policies/index.md | 33 ++ .../aws/s3_api/bucket_policy_status/index.md | 31 ++ .../aws/s3_api/bucket_replications/index.md | 33 ++ .../s3_api/bucket_request_payments/index.md | 32 ++ .../aws/s3_api/bucket_taggings/index.md | 37 ++ .../aws/s3_api/bucket_versionings/index.md | 36 ++ .../aws/s3_api/bucket_websites/index.md | 39 ++ .../providers/aws/s3_api/buckets/index.md | 37 ++ .../aws/s3_api/get_object_responses/index.md | 32 ++ docs/aws-docs/providers/aws/s3_api/index.md | 84 ++++ .../aws/s3_api/multipart_uploads/index.md | 34 ++ .../providers/aws/s3_api/object_acls/index.md | 36 ++ .../aws/s3_api/object_attributes/index.md | 38 ++ .../aws/s3_api/object_contents/index.md | 32 ++ .../aws/s3_api/object_legal_holds/index.md | 32 ++ .../object_lock_configurations/index.md | 32 ++ .../aws/s3_api/object_retentions/index.md | 32 ++ .../aws/s3_api/object_taggings/index.md | 33 ++ .../aws/s3_api/object_torrents/index.md | 31 ++ .../aws/s3_api/object_versions/index.md | 32 ++ .../providers/aws/s3_api/objects/index.md | 45 +++ .../providers/aws/s3_api/objects_v2s/index.md | 32 ++ .../providers/aws/s3_api/part_copies/index.md | 32 ++ .../providers/aws/s3_api/parts/index.md | 33 ++ .../aws/s3_api/public_access_blocks/index.md | 33 ++ .../aws/s3express/bucket_policies/index.md | 79 ++++ .../aws/s3express/bucket_policy/index.md | 91 +++++ .../aws/s3express/directory_bucket/index.md | 84 ++++ .../aws/s3express/directory_buckets/index.md | 78 ++++ .../aws-docs/providers/aws/s3express/index.md | 41 ++ .../aws/s3objectlambda/access_point/index.md | 104 +++++ .../access_point_policies/index.md | 68 ++++ .../access_point_policy/index.md | 91 +++++ .../aws/s3objectlambda/access_points/index.md | 81 ++++ .../providers/aws/s3objectlambda/index.md | 41 ++ .../aws/s3outposts/access_point/index.md | 100 +++++ .../aws/s3outposts/access_points/index.md | 80 ++++ .../providers/aws/s3outposts/bucket/index.md | 99 +++++ .../aws/s3outposts/bucket_policies/index.md | 68 ++++ .../aws/s3outposts/bucket_policy/index.md | 91 +++++ .../providers/aws/s3outposts/buckets/index.md | 79 ++++ .../aws/s3outposts/endpoint/index.md | 99 +++++ .../aws/s3outposts/endpoints/index.md | 77 ++++ .../providers/aws/s3outposts/index.md | 45 +++ .../providers/aws/sagemaker/app/index.md | 91 +++++ .../aws/sagemaker/app_image_config/index.md | 99 +++++ .../aws/sagemaker/app_image_configs/index.md | 78 ++++ .../providers/aws/sagemaker/apps/index.md | 84 ++++ .../data_quality_job_definition/index.md | 101 +++++ .../data_quality_job_definitions/index.md | 81 ++++ .../providers/aws/sagemaker/device/index.md | 91 +++++ .../aws/sagemaker/device_fleet/index.md | 96 +++++ .../aws/sagemaker/device_fleets/index.md | 68 ++++ .../providers/aws/sagemaker/devices/index.md | 67 +++ .../aws/sagemaker/feature_group/index.md | 115 ++++++ .../aws/sagemaker/feature_groups/index.md | 87 ++++ .../providers/aws/sagemaker/image/index.md | 104 +++++ .../aws/sagemaker/image_version/index.md | 118 ++++++ .../aws/sagemaker/image_versions/index.md | 78 ++++ .../providers/aws/sagemaker/images/index.md | 81 ++++ .../aws-docs/providers/aws/sagemaker/index.md | 79 ++++ .../sagemaker/inference_component/index.md | 117 ++++++ .../sagemaker/inference_components/index.md | 82 ++++ .../sagemaker/inference_experiment/index.md | 131 ++++++ .../sagemaker/inference_experiments/index.md | 81 ++++ .../model_bias_job_definition/index.md | 101 +++++ .../model_bias_job_definitions/index.md | 81 ++++ .../aws/sagemaker/model_card/index.md | 128 ++++++ .../aws/sagemaker/model_cards/index.md | 84 ++++ .../index.md | 101 +++++ .../index.md | 81 ++++ .../aws/sagemaker/model_package/index.md | 145 +++++++ .../sagemaker/model_package_group/index.md | 111 +++++ .../sagemaker/model_package_groups/index.md | 82 ++++ .../aws/sagemaker/model_packages/index.md | 90 +++++ .../model_quality_job_definition/index.md | 101 +++++ .../model_quality_job_definitions/index.md | 81 ++++ .../sagemaker/monitoring_schedule/index.md | 107 +++++ .../sagemaker/monitoring_schedules/index.md | 79 ++++ .../providers/aws/sagemaker/pipeline/index.md | 106 +++++ .../aws/sagemaker/pipelines/index.md | 82 ++++ .../providers/aws/sagemaker/project/index.md | 110 +++++ .../providers/aws/sagemaker/projects/index.md | 85 ++++ .../providers/aws/sagemaker/space/index.md | 105 +++++ .../providers/aws/sagemaker/spaces/index.md | 80 ++++ .../aws/sagemaker/user_profile/index.md | 104 +++++ .../aws/sagemaker/user_profiles/index.md | 83 ++++ .../aws-docs/providers/aws/scheduler/index.md | 41 ++ .../providers/aws/scheduler/schedule/index.md | 112 ++++++ .../aws/scheduler/schedule_group/index.md | 103 +++++ .../aws/scheduler/schedule_groups/index.md | 80 ++++ .../aws/scheduler/schedules/index.md | 79 ++++ .../providers/aws/secretsmanager/index.md | 39 ++ .../aws/secretsmanager/secret/index.md | 110 +++++ .../aws/secretsmanager/secrets/index.md | 80 ++++ .../aws/securityhub/automation_rule/index.md | 115 ++++++ .../aws/securityhub/automation_rules/index.md | 80 ++++ .../aws/securityhub/delegated_admin/index.md | 83 ++++ .../aws/securityhub/delegated_admins/index.md | 81 ++++ .../providers/aws/securityhub/hub/index.md | 102 +++++ .../providers/aws/securityhub/hubs/index.md | 81 ++++ .../providers/aws/securityhub/index.md | 49 +++ .../aws/securityhub/insight/index.md | 94 +++++ .../aws/securityhub/insights/index.md | 77 ++++ .../securityhub/product_subscription/index.md | 80 ++++ .../product_subscriptions/index.md | 77 ++++ .../aws/securityhub/standard/index.md | 94 +++++ .../aws/securityhub/standards/index.md | 79 ++++ .../aws/securitylake/data_lake/index.md | 117 ++++++ .../aws/securitylake/data_lakes/index.md | 93 +++++ .../providers/aws/securitylake/index.md | 41 ++ .../aws/securitylake/subscriber/index.md | 162 ++++++++ .../aws/securitylake/subscribers/index.md | 97 +++++ .../index.md | 117 ++++++ .../index.md | 67 +++ .../providers/aws/servicecatalog/index.md | 43 ++ .../servicecatalog/service_action/index.md | 99 +++++ .../service_action_association/index.md | 82 ++++ .../service_action_associations/index.md | 82 ++++ .../servicecatalog/service_actions/index.md | 79 ++++ .../application/index.md | 106 +++++ .../applications/index.md | 79 ++++ .../attribute_group/index.md | 101 +++++ .../attribute_group_association/index.md | 83 ++++ .../attribute_group_associations/index.md | 79 ++++ .../attribute_groups/index.md | 78 ++++ .../aws/servicecatalogappregistry/index.md | 45 +++ .../resource_association/index.md | 85 ++++ .../resource_associations/index.md | 82 ++++ .../aws/ses/configuration_set/index.md | 105 +++++ .../index.md | 93 +++++ .../index.md | 69 ++++ .../aws/ses/configuration_sets/index.md | 77 ++++ .../providers/aws/ses/contact_list/index.md | 95 +++++ .../providers/aws/ses/contact_lists/index.md | 77 ++++ .../aws/ses/dedicated_ip_pool/index.md | 91 +++++ .../aws/ses/dedicated_ip_pools/index.md | 79 ++++ .../aws/ses/email_identities/index.md | 81 ++++ .../providers/aws/ses/email_identity/index.md | 114 ++++++ docs/aws-docs/providers/aws/ses/index.md | 50 +++ .../providers/aws/ses/template/index.md | 94 +++++ .../providers/aws/ses/templates/index.md | 81 ++++ .../providers/aws/ses/vdm_attributes/index.md | 93 +++++ .../providers/aws/shield/drt_access/index.md | 109 +++++ .../aws/shield/drt_accesses/index.md | 79 ++++ docs/aws-docs/providers/aws/shield/index.md | 45 +++ .../aws/shield/proactive_engagement/index.md | 99 +++++ .../aws/shield/proactive_engagements/index.md | 82 ++++ .../providers/aws/shield/protection/index.md | 114 ++++++ .../aws/shield/protection_group/index.md | 104 +++++ .../aws/shield/protection_groups/index.md | 78 ++++ .../providers/aws/shield/protections/index.md | 90 +++++ docs/aws-docs/providers/aws/signer/index.md | 41 ++ .../aws/signer/profile_permission/index.md | 86 ++++ .../aws/signer/profile_permissions/index.md | 81 ++++ .../aws/signer/signing_profile/index.md | 102 +++++ .../aws/signer/signing_profiles/index.md | 78 ++++ .../providers/aws/simspaceweaver/index.md | 39 ++ .../aws/simspaceweaver/simulation/index.md | 102 +++++ .../aws/simspaceweaver/simulations/index.md | 80 ++++ docs/aws-docs/providers/aws/sns/index.md | 41 ++ .../aws-docs/providers/aws/sns/topic/index.md | 126 ++++++ .../aws/sns/topic_inline_policies/index.md | 68 ++++ .../aws/sns/topic_inline_policy/index.md | 91 +++++ .../providers/aws/sns/topics/index.md | 83 ++++ docs/aws-docs/providers/aws/sqs/index.md | 41 ++ .../aws-docs/providers/aws/sqs/queue/index.md | 127 ++++++ .../aws/sqs/queue_inline_policies/index.md | 69 ++++ .../aws/sqs/queue_inline_policy/index.md | 93 +++++ .../providers/aws/sqs/queues/index.md | 81 ++++ .../providers/aws/ssm/association/index.md | 126 ++++++ .../providers/aws/ssm/associations/index.md | 82 ++++ .../providers/aws/ssm/document/index.md | 114 ++++++ .../providers/aws/ssm/documents/index.md | 82 ++++ docs/aws-docs/providers/aws/ssm/index.md | 49 +++ .../providers/aws/ssm/parameter/index.md | 106 +++++ .../providers/aws/ssm/parameters/index.md | 79 ++++ .../providers/aws/ssm/patch_baseline/index.md | 125 ++++++ .../aws/ssm/patch_baselines/index.md | 86 ++++ .../aws/ssm/resource_data_sync/index.md | 105 +++++ .../aws/ssm/resource_data_syncs/index.md | 78 ++++ .../aws/ssm/resource_policies/index.md | 79 ++++ .../aws/ssm/resource_policy/index.md | 93 +++++ .../aws/ssmcontacts/contact/index.md | 99 +++++ .../aws/ssmcontacts/contact_channel/index.md | 99 +++++ .../aws/ssmcontacts/contact_channels/index.md | 78 ++++ .../aws/ssmcontacts/contacts/index.md | 79 ++++ .../providers/aws/ssmcontacts/index.md | 45 +++ .../providers/aws/ssmcontacts/plan/index.md | 97 +++++ .../providers/aws/ssmcontacts/plans/index.md | 69 ++++ .../aws/ssmcontacts/rotation/index.md | 109 +++++ .../aws/ssmcontacts/rotations/index.md | 83 ++++ .../providers/aws/ssmincidents/index.md | 41 ++ .../aws/ssmincidents/replication_set/index.md | 101 +++++ .../ssmincidents/replication_sets/index.md | 83 ++++ .../aws/ssmincidents/response_plan/index.md | 113 ++++++ .../aws/ssmincidents/response_plans/index.md | 84 ++++ .../providers/aws/sso/assignment/index.md | 93 +++++ .../providers/aws/sso/assignments/index.md | 96 +++++ docs/aws-docs/providers/aws/sso/index.md | 43 ++ .../index.md | 93 +++++ .../index.md | 79 ++++ .../providers/aws/sso/permission_set/index.md | 130 ++++++ .../aws/sso/permission_sets/index.md | 90 +++++ .../aws/stepfunctions/activities/index.md | 67 +++ .../aws/stepfunctions/activity/index.md | 94 +++++ .../providers/aws/stepfunctions/index.md | 45 +++ .../aws/stepfunctions/state_machine/index.md | 117 ++++++ .../state_machine_alias/index.md | 98 +++++ .../state_machine_aliases/index.md | 78 ++++ .../state_machine_version/index.md | 84 ++++ .../state_machine_versions/index.md | 79 ++++ .../aws/stepfunctions/state_machines/index.md | 81 ++++ .../aws/supportapp/account_alias/index.md | 91 +++++ .../aws/supportapp/account_aliases/index.md | 78 ++++ .../providers/aws/supportapp/index.md | 43 ++ .../slack_channel_configuration/index.md | 103 +++++ .../slack_channel_configurations/index.md | 80 ++++ .../slack_workspace_configuration/index.md | 91 +++++ .../slack_workspace_configurations/index.md | 78 ++++ .../aws/synthetics/canaries/index.md | 98 +++++ .../providers/aws/synthetics/canary/index.md | 143 +++++++ .../providers/aws/synthetics/group/index.md | 101 +++++ .../providers/aws/synthetics/groups/index.md | 80 ++++ .../providers/aws/synthetics/index.md | 41 ++ .../systemsmanagersap/application/index.md | 106 +++++ .../systemsmanagersap/applications/index.md | 80 ++++ .../providers/aws/systemsmanagersap/index.md | 39 ++ .../aws/timestream/database/index.md | 100 +++++ .../aws/timestream/databases/index.md | 83 ++++ .../providers/aws/timestream/index.md | 45 +++ .../aws/timestream/influxdb_instance/index.md | 139 +++++++ .../timestream/influxdb_instances/index.md | 89 ++++ .../aws/timestream/scheduled_queries/index.md | 79 ++++ .../aws/timestream/scheduled_query/index.md | 129 ++++++ .../providers/aws/timestream/table/index.md | 114 ++++++ .../providers/aws/timestream/tables/index.md | 88 ++++ .../providers/aws/transfer/agreement/index.md | 108 +++++ .../aws/transfer/agreements/index.md | 81 ++++ .../aws/transfer/certificate/index.md | 117 ++++++ .../aws/transfer/certificates/index.md | 78 ++++ .../providers/aws/transfer/connector/index.md | 104 +++++ .../aws/transfer/connectors/index.md | 79 ++++ docs/aws-docs/providers/aws/transfer/index.md | 47 +++ .../providers/aws/transfer/profile/index.md | 99 +++++ .../providers/aws/transfer/profiles/index.md | 78 ++++ .../providers/aws/transfer/workflow/index.md | 98 +++++ .../providers/aws/transfer/workflows/index.md | 78 ++++ .../aws/transfer_api/connectors/index.md | 45 +++ .../providers/aws/transfer_api/index.md | 48 +++ .../aws/transfer_api/servers/index.md | 57 +++ .../providers/aws/transfer_api/users/index.md | 47 +++ .../identity_source/index.md | 103 +++++ .../identity_sources/index.md | 85 ++++ .../aws/verifiedpermissions/index.md | 45 +++ .../aws/verifiedpermissions/policies/index.md | 81 ++++ .../aws/verifiedpermissions/policy/index.md | 95 +++++ .../verifiedpermissions/policy_store/index.md | 100 +++++ .../policy_stores/index.md | 81 ++++ .../policy_template/index.md | 95 +++++ .../policy_templates/index.md | 81 ++++ .../providers/aws/voiceid/domain/index.md | 106 +++++ .../providers/aws/voiceid/domains/index.md | 84 ++++ docs/aws-docs/providers/aws/voiceid/index.md | 39 ++ .../access_log_subscription/index.md | 131 ++++++ .../access_log_subscriptions/index.md | 96 +++++ .../aws/vpclattice/auth_policies/index.md | 68 ++++ .../aws/vpclattice/auth_policy/index.md | 93 +++++ .../providers/aws/vpclattice/index.md | 57 +++ .../aws/vpclattice/listener/index.md | 110 +++++ .../aws/vpclattice/listeners/index.md | 80 ++++ .../aws/vpclattice/resource_policies/index.md | 68 ++++ .../aws/vpclattice/resource_policy/index.md | 91 +++++ .../providers/aws/vpclattice/rule/index.md | 107 +++++ .../providers/aws/vpclattice/rules/index.md | 80 ++++ .../providers/aws/vpclattice/service/index.md | 113 ++++++ .../aws/vpclattice/service_network/index.md | 103 +++++ .../index.md | 118 ++++++ .../index.md | 80 ++++ .../service_network_vpc_association/index.md | 116 ++++++ .../service_network_vpc_associations/index.md | 83 ++++ .../aws/vpclattice/service_networks/index.md | 81 ++++ .../aws/vpclattice/services/index.md | 83 ++++ .../aws/vpclattice/target_group/index.md | 126 ++++++ .../aws/vpclattice/target_groups/index.md | 91 +++++ docs/aws-docs/providers/aws/wafv2/index.md | 49 +++ .../providers/aws/wafv2/ip_set/index.md | 105 +++++ .../providers/aws/wafv2/ip_sets/index.md | 83 ++++ .../aws/wafv2/logging_configuration/index.md | 107 +++++ .../aws/wafv2/logging_configurations/index.md | 87 ++++ .../aws/wafv2/regex_pattern_set/index.md | 103 +++++ .../aws/wafv2/regex_pattern_sets/index.md | 83 ++++ .../providers/aws/wafv2/rule_group/index.md | 115 ++++++ .../providers/aws/wafv2/rule_groups/index.md | 83 ++++ .../providers/aws/wafv2/web_acl/index.md | 121 ++++++ .../providers/aws/wafv2/web_acls/index.md | 83 ++++ .../aws/wafv2/webacl_association/index.md | 137 +++++++ .../aws/wafv2/webacl_associations/index.md | 85 ++++ .../providers/aws/wisdom/assistant/index.md | 99 +++++ .../aws/wisdom/assistant_association/index.md | 99 +++++ .../wisdom/assistant_associations/index.md | 80 ++++ .../providers/aws/wisdom/assistants/index.md | 80 ++++ docs/aws-docs/providers/aws/wisdom/index.md | 43 ++ .../aws/wisdom/knowledge_base/index.md | 106 +++++ .../aws/wisdom/knowledge_bases/index.md | 88 ++++ .../aws/workspaces/connection_alias/index.md | 85 ++++ .../workspaces/connection_aliases/index.md | 67 +++ .../providers/aws/workspaces/index.md | 39 ++ .../workspacesthinclient/environment/index.md | 138 +++++++ .../environments/index.md | 89 ++++ .../aws/workspacesthinclient/index.md | 39 ++ .../workspacesweb/browser_settings/index.md | 117 ++++++ .../workspacesweb/identity_provider/index.md | 103 +++++ .../workspacesweb/identity_providers/index.md | 80 ++++ .../providers/aws/workspacesweb/index.md | 48 +++ .../workspacesweb/ip_access_settings/index.md | 124 ++++++ .../workspacesweb/network_settings/index.md | 104 +++++ .../aws/workspacesweb/portal/index.md | 169 ++++++++ .../aws/workspacesweb/portals/index.md | 101 +++++ .../aws/workspacesweb/trust_store/index.md | 104 +++++ .../aws/workspacesweb/trust_stores/index.md | 83 ++++ .../user_access_logging_settings/index.md | 101 +++++ .../aws/workspacesweb/user_settings/index.md | 129 ++++++ .../providers/aws/xray/group/index.md | 99 +++++ .../providers/aws/xray/groups/index.md | 79 ++++ docs/aws-docs/providers/aws/xray/index.md | 43 ++ .../aws/xray/resource_policies/index.md | 78 ++++ .../aws/xray/resource_policy/index.md | 92 +++++ .../providers/aws/xray/sampling_rule/index.md | 101 +++++ .../aws/xray/sampling_rules/index.md | 79 ++++ docs/awscc-docs/index.md | 306 -------------- .../awscc/accessanalyzer/analyzer/index.md | 82 ---- .../awscc/accessanalyzer/analyzers/index.md | 64 --- .../providers/awscc/accessanalyzer/index.md | 39 -- .../awscc/acmpca/certificate/index.md | 76 ---- .../acmpca/certificate_authorities/index.md | 65 --- .../acmpca/certificate_authority/index.md | 91 ----- .../certificate_authority_activation/index.md | 75 ---- .../providers/awscc/acmpca/index.md | 42 -- .../awscc/acmpca/permission/index.md | 66 --- .../providers/awscc/amplify/app/index.md | 122 ------ .../providers/awscc/amplify/apps/index.md | 71 ---- .../providers/awscc/amplify/branch/index.md | 119 ------ .../providers/awscc/amplify/branches/index.md | 75 ---- .../providers/awscc/amplify/domain/index.md | 100 ----- .../providers/awscc/amplify/domains/index.md | 66 --- .../providers/awscc/amplify/index.md | 43 -- .../awscc/amplifyuibuilder/component/index.md | 105 ----- .../amplifyuibuilder/components/index.md | 68 ---- .../awscc/amplifyuibuilder/form/index.md | 98 ----- .../awscc/amplifyuibuilder/forms/index.md | 69 ---- .../providers/awscc/amplifyuibuilder/index.md | 43 -- .../awscc/amplifyuibuilder/theme/index.md | 88 ---- .../awscc/amplifyuibuilder/themes/index.md | 68 ---- .../awscc/apigateway/account/index.md | 64 --- .../awscc/apigateway/api_key/index.md | 85 ---- .../awscc/apigateway/api_keys/index.md | 62 --- .../awscc/apigateway/authorizer/index.md | 87 ---- .../awscc/apigateway/authorizers/index.md | 63 --- .../apigateway/base_path_mapping/index.md | 73 ---- .../apigateway/base_path_mappings/index.md | 63 --- .../apigateway/client_certificate/index.md | 72 ---- .../apigateway/client_certificates/index.md | 62 --- .../awscc/apigateway/deployment/index.md | 79 ---- .../awscc/apigateway/deployments/index.md | 65 --- .../apigateway/documentation_part/index.md | 72 ---- .../apigateway/documentation_parts/index.md | 63 --- .../apigateway/documentation_version/index.md | 70 ---- .../documentation_versions/index.md | 63 --- .../awscc/apigateway/domain_name/index.md | 87 ---- .../awscc/apigateway/domain_names/index.md | 60 --- .../apigateway/gateway_responses/index.md | 61 --- .../providers/awscc/apigateway/index.md | 72 ---- .../awscc/apigateway/method/index.md | 92 ----- .../providers/awscc/apigateway/model/index.md | 75 ---- .../awscc/apigateway/models/index.md | 63 --- .../apigateway/request_validator/index.md | 74 ---- .../apigateway/request_validators/index.md | 63 --- .../awscc/apigateway/resource/index.md | 72 ---- .../awscc/apigateway/resources/index.md | 62 --- .../awscc/apigateway/rest_api/index.md | 103 ----- .../awscc/apigateway/rest_apis/index.md | 66 --- .../providers/awscc/apigateway/stage/index.md | 94 ----- .../awscc/apigateway/stages/index.md | 65 --- .../awscc/apigateway/usage_plan/index.md | 82 ---- .../awscc/apigateway/usage_plan_key/index.md | 67 --- .../awscc/apigateway/usage_plan_keys/index.md | 61 --- .../awscc/apigateway/usage_plans/index.md | 62 --- .../awscc/apigateway/vpc_link/index.md | 89 ---- .../awscc/apigateway/vpc_links/index.md | 70 ---- .../providers/awscc/apigatewayv2/api/index.md | 108 ----- .../awscc/apigatewayv2/api_mapping/index.md | 75 ---- .../awscc/apigatewayv2/api_mappings/index.md | 62 --- .../awscc/apigatewayv2/apis/index.md | 63 --- .../awscc/apigatewayv2/authorizer/index.md | 91 ----- .../awscc/apigatewayv2/authorizers/index.md | 63 --- .../awscc/apigatewayv2/deployment/index.md | 74 ---- .../awscc/apigatewayv2/deployments/index.md | 62 --- .../awscc/apigatewayv2/domain_name/index.md | 78 ---- .../awscc/apigatewayv2/domain_names/index.md | 62 --- .../providers/awscc/apigatewayv2/index.md | 57 --- .../integration_response/index.md | 82 ---- .../integration_responses/index.md | 64 --- .../awscc/apigatewayv2/model/index.md | 78 ---- .../awscc/apigatewayv2/models/index.md | 62 --- .../awscc/apigatewayv2/route/index.md | 92 ----- .../apigatewayv2/route_response/index.md | 80 ---- .../apigatewayv2/route_responses/index.md | 64 --- .../awscc/apigatewayv2/routes/index.md | 62 --- .../awscc/apigatewayv2/vpc_link/index.md | 86 ---- .../awscc/apigatewayv2/vpc_links/index.md | 68 ---- .../awscc/appconfig/application/index.md | 75 ---- .../awscc/appconfig/applications/index.md | 63 --- .../appconfig/configuration_profile/index.md | 89 ---- .../appconfig/configuration_profiles/index.md | 66 --- .../awscc/appconfig/environment/index.md | 80 ---- .../awscc/appconfig/environments/index.md | 66 --- .../awscc/appconfig/extension/index.md | 84 ---- .../appconfig/extension_association/index.md | 84 ---- .../appconfig/extension_associations/index.md | 61 --- .../awscc/appconfig/extensions/index.md | 62 --- .../hosted_configuration_version/index.md | 74 ---- .../hosted_configuration_versions/index.md | 64 --- .../providers/awscc/appconfig/index.md | 49 --- .../awscc/appflow/connector/index.md | 74 ---- .../awscc/appflow/connector_profile/index.md | 88 ---- .../awscc/appflow/connector_profiles/index.md | 69 ---- .../awscc/appflow/connectors/index.md | 61 --- .../providers/awscc/appflow/flow/index.md | 99 ----- .../providers/awscc/appflow/flows/index.md | 75 ---- .../providers/awscc/appflow/index.md | 43 -- .../appintegrations/data_integration/index.md | 110 ----- .../data_integrations/index.md | 76 ---- .../event_integration/index.md | 79 ---- .../event_integrations/index.md | 61 --- .../providers/awscc/appintegrations/index.md | 41 -- .../awscc/applicationautoscaling/index.md | 41 -- .../scalable_target/index.md | 92 ----- .../scalable_targets/index.md | 75 ---- .../scaling_policies/index.md | 63 --- .../scaling_policy/index.md | 83 ---- .../applicationinsights/application/index.md | 85 ---- .../applicationinsights/applications/index.md | 60 --- .../awscc/applicationinsights/index.md | 39 -- .../auto_scaling_configuration/index.md | 74 ---- .../auto_scaling_configurations/index.md | 62 --- .../providers/awscc/apprunner/index.md | 47 --- .../observability_configuration/index.md | 70 ---- .../observability_configurations/index.md | 62 --- .../awscc/apprunner/service/index.md | 90 ----- .../awscc/apprunner/services/index.md | 71 ---- .../awscc/apprunner/vpc_connector/index.md | 70 ---- .../awscc/apprunner/vpc_connectors/index.md | 65 --- .../apprunner/vpc_ingress_connection/index.md | 77 ---- .../vpc_ingress_connections/index.md | 65 --- .../awscc/appstream/app_block/index.md | 78 ---- .../appstream/app_block_builder/index.md | 102 ----- .../appstream/app_block_builders/index.md | 66 --- .../awscc/appstream/application/index.md | 92 ----- .../index.md | 65 --- .../application_fleet_association/index.md | 63 --- .../awscc/appstream/directory_config/index.md | 89 ---- .../appstream/directory_configs/index.md | 72 ---- .../awscc/appstream/entitlement/index.md | 77 ---- .../awscc/appstream/image_builder/index.md | 104 ----- .../awscc/appstream/image_builders/index.md | 78 ---- .../providers/awscc/appstream/index.md | 48 --- .../awscc/appsync/domain_name/index.md | 74 ---- .../domain_name_api_association/index.md | 71 ---- .../awscc/appsync/domain_names/index.md | 63 --- .../appsync/function_configuration/index.md | 96 ----- .../appsync/function_configurations/index.md | 61 --- .../providers/awscc/appsync/index.md | 46 --- .../providers/awscc/appsync/resolver/index.md | 100 ----- .../awscc/appsync/resolvers/index.md | 62 --- .../appsync/source_api_association/index.md | 95 ----- .../appsync/source_api_associations/index.md | 62 --- docs/awscc-docs/providers/awscc/aps/index.md | 41 -- .../awscc/aps/rule_groups_namespace/index.md | 79 ---- .../awscc/aps/rule_groups_namespaces/index.md | 63 --- .../providers/awscc/aps/workspace/index.md | 103 ----- .../providers/awscc/aps/workspaces/index.md | 73 ---- .../providers/awscc/arczonalshift/index.md | 39 -- .../zonal_autoshift_configuration/index.md | 74 ---- .../zonal_autoshift_configurations/index.md | 64 --- .../athena/capacity_reservation/index.md | 89 ---- .../athena/capacity_reservations/index.md | 64 --- .../awscc/athena/data_catalog/index.md | 78 ---- .../awscc/athena/data_catalogs/index.md | 61 --- .../providers/awscc/athena/index.md | 47 --- .../awscc/athena/named_queries/index.md | 60 --- .../awscc/athena/named_query/index.md | 70 ---- .../awscc/athena/prepared_statement/index.md | 72 ---- .../awscc/athena/prepared_statements/index.md | 63 --- .../awscc/athena/work_group/index.md | 94 ----- .../awscc/athena/work_groups/index.md | 71 ---- .../awscc/auditmanager/assessment/index.md | 92 ----- .../awscc/auditmanager/assessments/index.md | 64 --- .../providers/awscc/auditmanager/index.md | 39 -- .../autoscaling/auto_scaling_group/index.md | 139 ------- .../autoscaling/auto_scaling_groups/index.md | 71 ---- .../providers/awscc/autoscaling/index.md | 48 --- .../autoscaling/launch_configuration/index.md | 97 ----- .../launch_configurations/index.md | 62 --- .../awscc/autoscaling/lifecycle_hook/index.md | 82 ---- .../autoscaling/lifecycle_hooks/index.md | 64 --- .../autoscaling/scaling_policies/index.md | 62 --- .../awscc/autoscaling/scaling_policy/index.md | 92 ----- .../autoscaling/scheduled_action/index.md | 82 ---- .../autoscaling/scheduled_actions/index.md | 63 --- .../awscc/autoscaling/warm_pool/index.md | 76 ---- .../awscc/b2bi/capabilities/index.md | 75 ---- .../providers/awscc/b2bi/capability/index.md | 84 ---- docs/awscc-docs/providers/awscc/b2bi/index.md | 45 --- .../providers/awscc/b2bi/partnership/index.md | 88 ---- .../awscc/b2bi/partnerships/index.md | 62 --- .../providers/awscc/b2bi/profile/index.md | 90 ----- .../providers/awscc/b2bi/profiles/index.md | 70 ---- .../providers/awscc/b2bi/transformer/index.md | 90 ----- .../awscc/b2bi/transformers/index.md | 71 ---- .../awscc/backup/backup_plan/index.md | 78 ---- .../awscc/backup/backup_plans/index.md | 62 --- .../awscc/backup/backup_selection/index.md | 67 --- .../awscc/backup/backup_selections/index.md | 63 --- .../awscc/backup/backup_vault/index.md | 89 ---- .../awscc/backup/backup_vaults/index.md | 71 ---- .../providers/awscc/backup/framework/index.md | 85 ---- .../awscc/backup/frameworks/index.md | 64 --- .../providers/awscc/backup/index.md | 51 --- .../awscc/backup/report_plan/index.md | 81 ---- .../awscc/backup/report_plans/index.md | 64 --- .../backup/restore_testing_plan/index.md | 83 ---- .../backup/restore_testing_plans/index.md | 63 --- .../backup/restore_testing_selection/index.md | 82 ---- .../restore_testing_selections/index.md | 64 --- .../awscc/backupgateway/hypervisor/index.md | 86 ---- .../awscc/backupgateway/hypervisors/index.md | 66 --- .../providers/awscc/backupgateway/index.md | 39 -- .../awscc/batch/compute_environment/index.md | 94 ----- .../awscc/batch/compute_environments/index.md | 65 --- .../awscc-docs/providers/awscc/batch/index.md | 43 -- .../providers/awscc/batch/job_queue/index.md | 82 ---- .../providers/awscc/batch/job_queues/index.md | 62 --- .../awscc/batch/scheduling_policies/index.md | 62 --- .../awscc/batch/scheduling_policy/index.md | 74 ---- .../billingconductor/billing_group/index.md | 100 ----- .../billingconductor/billing_groups/index.md | 67 --- .../custom_line_item/index.md | 102 ----- .../custom_line_items/index.md | 66 --- .../providers/awscc/billingconductor/index.md | 45 --- .../billingconductor/pricing_plan/index.md | 89 ---- .../billingconductor/pricing_plans/index.md | 66 --- .../billingconductor/pricing_rule/index.md | 99 ----- .../billingconductor/pricing_rules/index.md | 64 --- .../awscc/budgets/budgets_action/index.md | 82 ---- .../awscc/budgets/budgets_actions/index.md | 64 --- .../providers/awscc/budgets/index.md | 39 -- .../providers/awscc/cassandra/index.md | 41 -- .../awscc/cassandra/keyspace/index.md | 80 ---- .../awscc/cassandra/keyspaces/index.md | 67 --- .../providers/awscc/cassandra/table/index.md | 131 ------ .../providers/awscc/cassandra/tables/index.md | 90 ----- .../awscc/ce/anomaly_monitor/index.md | 83 ---- .../awscc/ce/anomaly_monitors/index.md | 61 --- .../awscc/ce/anomaly_subscription/index.md | 81 ---- .../awscc/ce/anomaly_subscriptions/index.md | 61 --- .../awscc/ce/cost_categories/index.md | 60 --- .../providers/awscc/ce/cost_category/index.md | 77 ---- docs/awscc-docs/providers/awscc/ce/index.md | 43 -- .../awscc/certificatemanager/account/index.md | 69 ---- .../awscc/certificatemanager/index.md | 39 -- .../providers/awscc/chatbot/index.md | 41 -- .../index.md | 85 ---- .../index.md | 62 --- .../slack_channel_configuration/index.md | 82 ---- .../slack_channel_configurations/index.md | 62 --- .../cleanrooms/analysis_template/index.md | 98 ----- .../cleanrooms/analysis_templates/index.md | 66 --- .../awscc/cleanrooms/collaboration/index.md | 97 ----- .../awscc/cleanrooms/collaborations/index.md | 66 --- .../cleanrooms/configured_table/index.md | 113 ------ .../configured_table_association/index.md | 89 ---- .../configured_table_associations/index.md | 67 --- .../cleanrooms/configured_tables/index.md | 76 ---- .../providers/awscc/cleanrooms/index.md | 47 --- .../awscc/cleanrooms/membership/index.md | 107 ----- .../awscc/cleanrooms/memberships/index.md | 74 ---- .../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 | 66 --- .../hook_default_versions/index.md | 60 --- .../cloudformation/hook_type_config/index.md | 73 ---- .../cloudformation/hook_type_configs/index.md | 61 --- .../cloudformation/hook_version/index.md | 77 ---- .../cloudformation/hook_versions/index.md | 67 --- .../providers/awscc/cloudformation/index.md | 60 --- .../module_default_version/index.md | 59 --- .../module_default_versions/index.md | 61 --- .../cloudformation/module_version/index.md | 79 ---- .../public_type_version/index.md | 70 ---- .../public_type_versions/index.md | 65 --- .../awscc/cloudformation/publisher/index.md | 65 --- .../awscc/cloudformation/publishers/index.md | 63 --- .../resource_default_version/index.md | 71 ---- .../resource_default_versions/index.md | 60 --- .../cloudformation/resource_version/index.md | 79 ---- .../cloudformation/resource_versions/index.md | 68 ---- .../awscc/cloudformation/stack/index.md | 116 ------ .../awscc/cloudformation/stack_set/index.md | 112 ------ .../awscc/cloudformation/stack_sets/index.md | 69 ---- .../awscc/cloudformation/stacks/index.md | 62 --- .../cloudformation/type_activation/index.md | 88 ---- .../cloudformation/type_activations/index.md | 62 --- .../awscc/cloudfront/cache_policies/index.md | 60 --- .../awscc/cloudfront/cache_policy/index.md | 71 ---- .../index.md | 60 --- .../index.md | 71 ---- .../continuous_deployment_policies/index.md | 60 --- .../continuous_deployment_policy/index.md | 71 ---- .../awscc/cloudfront/distribution/index.md | 80 ---- .../awscc/cloudfront/distributions/index.md | 64 --- .../awscc/cloudfront/function/index.md | 81 ---- .../awscc/cloudfront/functions/index.md | 62 --- .../providers/awscc/cloudfront/index.md | 62 --- .../awscc/cloudfront/key_group/index.md | 71 ---- .../awscc/cloudfront/key_groups/index.md | 60 --- .../awscc/cloudfront/key_value_store/index.md | 77 ---- .../cloudfront/key_value_stores/index.md | 64 --- .../monitoring_subscription/index.md | 62 --- .../cloudfront/origin_access_control/index.md | 69 ---- .../origin_access_controls/index.md | 60 --- .../origin_request_policies/index.md | 60 --- .../cloudfront/origin_request_policy/index.md | 71 ---- .../awscc/cloudfront/public_key/index.md | 71 ---- .../awscc/cloudfront/public_keys/index.md | 60 --- .../cloudfront/realtime_log_config/index.md | 76 ---- .../cloudfront/realtime_log_configs/index.md | 61 --- .../response_headers_policies/index.md | 60 --- .../response_headers_policy/index.md | 71 ---- .../awscc/cloudtrail/channel/index.md | 77 ---- .../awscc/cloudtrail/channels/index.md | 61 --- .../cloudtrail/event_data_store/index.md | 128 ------ .../cloudtrail/event_data_stores/index.md | 78 ---- .../providers/awscc/cloudtrail/index.md | 44 -- .../awscc/cloudtrail/resource_policy/index.md | 68 ---- .../providers/awscc/cloudtrail/trail/index.md | 117 ------ .../awscc/cloudtrail/trails/index.md | 75 ---- .../providers/awscc/cloudwatch/alarm/index.md | 109 ----- .../awscc/cloudwatch/alarms/index.md | 61 --- .../awscc/cloudwatch/composite_alarm/index.md | 87 ---- .../cloudwatch/composite_alarms/index.md | 61 --- .../providers/awscc/cloudwatch/index.md | 43 -- .../awscc/cloudwatch/metric_stream/index.md | 94 ----- .../awscc/cloudwatch/metric_streams/index.md | 63 --- .../awscc/codeartifact/domain/index.md | 84 ---- .../awscc/codeartifact/domains/index.md | 64 --- .../providers/awscc/codeartifact/index.md | 41 -- .../awscc/codeartifact/repositories/index.md | 65 --- .../awscc/codeartifact/repository/index.md | 94 ----- .../providers/awscc/codebuild/fleet/index.md | 77 ---- .../providers/awscc/codebuild/fleets/index.md | 61 --- .../providers/awscc/codebuild/index.md | 39 -- .../awscc/codedeploy/application/index.md | 72 ---- .../awscc/codedeploy/applications/index.md | 61 --- .../codedeploy/deployment_config/index.md | 69 ---- .../codedeploy/deployment_configs/index.md | 60 --- .../providers/awscc/codedeploy/index.md | 41 -- .../providers/awscc/codeguruprofiler/index.md | 39 -- .../codeguruprofiler/profiling_group/index.md | 85 ---- .../profiling_groups/index.md | 65 --- .../providers/awscc/codegurureviewer/index.md | 39 -- .../repository_association/index.md | 79 ---- .../repository_associations/index.md | 75 ---- .../codepipeline/custom_action_type/index.md | 85 ---- .../codepipeline/custom_action_types/index.md | 66 --- .../providers/awscc/codepipeline/index.md | 39 -- .../codestarconnections/connection/index.md | 80 ---- .../codestarconnections/connections/index.md | 62 --- .../awscc/codestarconnections/index.md | 43 -- .../repository_link/index.md | 89 ---- .../repository_links/index.md | 66 --- .../sync_configuration/index.md | 84 ---- .../sync_configurations/index.md | 65 --- .../awscc/codestarnotifications/index.md | 39 -- .../notification_rule/index.md | 88 ---- .../notification_rules/index.md | 60 --- .../awscc/cognito/identity_pool/index.md | 93 ----- .../identity_pool_principal_tag/index.md | 73 ---- .../identity_pool_principal_tags/index.md | 63 --- .../identity_pool_role_attachment/index.md | 74 ---- .../identity_pool_role_attachments/index.md | 62 --- .../awscc/cognito/identity_pools/index.md | 63 --- .../providers/awscc/cognito/index.md | 54 --- .../log_delivery_configuration/index.md | 87 ---- .../awscc/cognito/user_pool/index.md | 126 ------ .../awscc/cognito/user_pool_client/index.md | 117 ------ .../awscc/cognito/user_pool_clients/index.md | 65 --- .../awscc/cognito/user_pool_group/index.md | 77 ---- .../awscc/cognito/user_pool_groups/index.md | 65 --- .../index.md | 76 ---- .../awscc/cognito/user_pool_user/index.md | 74 ---- .../index.md | 65 --- .../awscc/cognito/user_pool_users/index.md | 64 --- .../awscc/cognito/user_pools/index.md | 65 --- .../comprehend/document_classifier/index.md | 99 ----- .../comprehend/document_classifiers/index.md | 65 --- .../awscc/comprehend/flywheel/index.md | 88 ---- .../awscc/comprehend/flywheels/index.md | 63 --- .../providers/awscc/comprehend/index.md | 41 -- .../config/aggregation_authorization/index.md | 77 ---- .../aggregation_authorizations/index.md | 64 --- .../awscc/config/config_rule/index.md | 86 ---- .../awscc/config/config_rules/index.md | 61 --- .../config/configuration_aggregator/index.md | 82 ---- .../config/configuration_aggregators/index.md | 65 --- .../awscc/config/conformance_pack/index.md | 83 ---- .../awscc/config/conformance_packs/index.md | 66 --- .../providers/awscc/config/index.md | 49 --- .../organization_conformance_pack/index.md | 88 ---- .../organization_conformance_packs/index.md | 69 ---- .../awscc/config/stored_queries/index.md | 62 --- .../awscc/config/stored_query/index.md | 81 ---- .../awscc/connect/approved_origin/index.md | 63 --- .../awscc/connect/approved_origins/index.md | 63 --- .../awscc/connect/contact_flow/index.md | 83 ---- .../connect/contact_flow_module/index.md | 83 ---- .../connect/contact_flow_modules/index.md | 61 --- .../awscc/connect/contact_flows/index.md | 61 --- .../awscc/connect/evaluation_form/index.md | 86 ---- .../awscc/connect/evaluation_forms/index.md | 62 --- .../awscc/connect/hours_of_operation/index.md | 80 ---- .../connect/hours_of_operations/index.md | 61 --- .../providers/awscc/connect/index.md | 80 ---- .../providers/awscc/connect/instance/index.md | 95 ----- .../connect/instance_storage_config/index.md | 97 ----- .../connect/instance_storage_configs/index.md | 75 ---- .../awscc/connect/instances/index.md | 75 ---- .../connect/integration_association/index.md | 85 ---- .../connect/integration_associations/index.md | 94 ----- .../connect/predefined_attribute/index.md | 69 ---- .../connect/predefined_attributes/index.md | 62 --- .../providers/awscc/connect/prompt/index.md | 77 ---- .../providers/awscc/connect/prompts/index.md | 64 --- .../providers/awscc/connect/queue/index.md | 95 ----- .../providers/awscc/connect/queues/index.md | 62 --- .../awscc/connect/quick_connect/index.md | 81 ---- .../awscc/connect/quick_connects/index.md | 61 --- .../awscc/connect/routing_profile/index.md | 92 ----- .../awscc/connect/routing_profiles/index.md | 62 --- .../providers/awscc/connect/rule/index.md | 85 ---- .../awscc/connect/security_key/index.md | 64 --- .../awscc/connect/security_keys/index.md | 62 --- .../awscc/connect/security_profile/index.md | 83 ---- .../awscc/connect/security_profiles/index.md | 61 --- .../awscc/connect/task_template/index.md | 89 ---- .../awscc/connect/task_templates/index.md | 61 --- .../traffic_distribution_group/index.md | 80 ---- .../traffic_distribution_groups/index.md | 62 --- .../providers/awscc/connect/user/index.md | 98 ----- .../connect/user_hierarchy_group/index.md | 76 ---- .../connect/user_hierarchy_groups/index.md | 61 --- .../providers/awscc/connect/users/index.md | 62 --- .../providers/awscc/connect/view/index.md | 85 ---- .../awscc/connect/view_version/index.md | 68 ---- .../awscc/connect/view_versions/index.md | 60 --- .../providers/awscc/connect/views/index.md | 61 --- .../awscc/connectcampaigns/campaign/index.md | 80 ---- .../awscc/connectcampaigns/campaigns/index.md | 65 --- .../providers/awscc/connectcampaigns/index.md | 39 -- .../controltower/enabled_baseline/index.md | 126 ------ .../controltower/enabled_baselines/index.md | 86 ---- .../controltower/enabled_control/index.md | 94 ----- .../controltower/enabled_controls/index.md | 73 ---- .../providers/awscc/controltower/index.md | 43 -- .../awscc/controltower/landing_zone/index.md | 132 ------ .../awscc/controltower/landing_zones/index.md | 90 ----- docs/awscc-docs/providers/awscc/cur/index.md | 39 -- .../awscc/cur/report_definition/index.md | 89 ---- .../awscc/cur/report_definitions/index.md | 60 --- .../calculated_attribute_definition/index.md | 86 ---- .../calculated_attribute_definitions/index.md | 63 --- .../awscc/customerprofiles/domain/index.md | 86 ---- .../awscc/customerprofiles/domains/index.md | 61 --- .../customerprofiles/event_stream/index.md | 84 ---- .../customerprofiles/event_streams/index.md | 65 --- .../providers/awscc/customerprofiles/index.md | 47 --- .../customerprofiles/integration/index.md | 99 ----- .../customerprofiles/integrations/index.md | 71 ---- .../customerprofiles/object_type/index.md | 92 ----- .../customerprofiles/object_types/index.md | 64 --- .../providers/awscc/databrew/dataset/index.md | 79 ---- .../awscc/databrew/datasets/index.md | 67 --- .../providers/awscc/databrew/index.md | 49 --- .../providers/awscc/databrew/job/index.md | 107 ----- .../providers/awscc/databrew/jobs/index.md | 66 --- .../providers/awscc/databrew/project/index.md | 78 ---- .../awscc/databrew/projects/index.md | 65 --- .../providers/awscc/databrew/recipe/index.md | 73 ---- .../providers/awscc/databrew/recipes/index.md | 65 --- .../providers/awscc/databrew/ruleset/index.md | 75 ---- .../awscc/databrew/rulesets/index.md | 65 --- .../awscc/databrew/schedule/index.md | 73 ---- .../awscc/databrew/schedules/index.md | 65 --- .../providers/awscc/datapipeline/index.md | 39 -- .../awscc/datapipeline/pipeline/index.md | 93 ----- .../awscc/datapipeline/pipelines/index.md | 67 --- .../providers/awscc/datasync/agent/index.md | 84 ---- .../providers/awscc/datasync/agents/index.md | 67 --- .../providers/awscc/datasync/index.md | 60 --- .../datasync/location_azure_blob/index.md | 88 ---- .../datasync/location_azure_blobs/index.md | 63 --- .../awscc/datasync/location_efs/index.md | 85 ---- .../awscc/datasync/location_hdfs/index.md | 98 ----- .../awscc/datasync/location_nfs/index.md | 82 ---- .../datasync/location_object_storage/index.md | 92 ----- .../location_object_storages/index.md | 63 --- .../awscc/datasync/location_s3/index.md | 81 ---- .../awscc/datasync/location_s3s/index.md | 67 --- .../awscc/datasync/location_smb/index.md | 88 ---- .../awscc/datasync/location_smbs/index.md | 63 --- .../datasync/locationf_sx_lustre/index.md | 79 ---- .../datasync/locationf_sx_lustres/index.md | 67 --- .../datasync/locationf_sx_ontap/index.md | 83 ---- .../datasync/locationf_sx_ontaps/index.md | 68 ---- .../datasync/locationf_sx_open_zfs/index.md | 81 ---- .../datasync/locationf_sx_windows/index.md | 85 ---- .../awscc/datasync/storage_system/index.md | 94 ----- .../awscc/datasync/storage_systems/index.md | 66 --- .../providers/awscc/datasync/task/index.md | 106 ----- .../providers/awscc/datasync/tasks/index.md | 78 ---- .../awscc/datazone/data_source/index.md | 110 ----- .../awscc/datazone/data_sources/index.md | 65 --- .../providers/awscc/datazone/domain/index.md | 96 ----- .../providers/awscc/datazone/domains/index.md | 66 --- .../awscc/datazone/environment/index.md | 104 ----- .../index.md | 87 ---- .../index.md | 65 --- .../datazone/environment_profile/index.md | 95 ----- .../datazone/environment_profiles/index.md | 63 --- .../awscc/datazone/environments/index.md | 64 --- .../providers/awscc/datazone/index.md | 51 --- .../providers/awscc/datazone/project/index.md | 83 ---- .../awscc/datazone/projects/index.md | 63 --- .../datazone/subscription_target/index.md | 99 ----- .../datazone/subscription_targets/index.md | 66 --- .../providers/awscc/detective/graph/index.md | 76 ---- .../providers/awscc/detective/graphs/index.md | 65 --- .../providers/awscc/detective/index.md | 43 -- .../detective/member_invitation/index.md | 68 ---- .../detective/member_invitations/index.md | 64 --- .../detective/organization_admin/index.md | 65 --- .../detective/organization_admins/index.md | 67 --- .../providers/awscc/devopsguru/index.md | 43 -- .../index.md | 70 ---- .../index.md | 63 --- .../devopsguru/notification_channel/index.md | 63 --- .../devopsguru/notification_channels/index.md | 64 --- .../devopsguru/resource_collection/index.md | 69 ---- .../devopsguru/resource_collections/index.md | 61 --- .../providers/awscc/directoryservice/index.md | 39 -- .../awscc/directoryservice/simple_ad/index.md | 94 ----- .../directoryservice/simple_ads/index.md | 71 ---- .../awscc/dms/data_provider/index.md | 87 ---- .../awscc/dms/data_providers/index.md | 66 --- docs/awscc-docs/providers/awscc/dms/index.md | 45 --- .../awscc/dms/instance_profile/index.md | 93 ----- .../awscc/dms/instance_profiles/index.md | 66 --- .../awscc/dms/migration_project/index.md | 96 ----- .../awscc/dms/migration_projects/index.md | 67 --- .../awscc/dms/replication_config/index.md | 97 ----- .../awscc/dms/replication_configs/index.md | 67 --- .../awscc/docdbelastic/cluster/index.md | 118 ------ .../awscc/docdbelastic/clusters/index.md | 79 ---- .../providers/awscc/docdbelastic/index.md | 39 -- .../awscc/dynamodb/global_table/index.md | 144 ------- .../awscc/dynamodb/global_tables/index.md | 98 ----- .../providers/awscc/dynamodb/index.md | 41 -- .../providers/awscc/dynamodb/table/index.md | 131 ------ .../providers/awscc/dynamodb/tables/index.md | 95 ----- .../awscc/ec2/capacity_reservation/index.md | 103 ----- .../ec2/capacity_reservation_fleet/index.md | 101 ----- .../ec2/capacity_reservation_fleets/index.md | 71 ---- .../awscc/ec2/capacity_reservations/index.md | 63 --- .../awscc/ec2/carrier_gateway/index.md | 76 ---- .../awscc/ec2/carrier_gateways/index.md | 62 --- .../awscc/ec2/customer_gateway/index.md | 77 ---- .../awscc/ec2/customer_gateways/index.md | 61 --- .../providers/awscc/ec2/dhcp_options/index.md | 82 ---- .../providers/awscc/ec2/ec2fleet/index.md | 91 ----- .../providers/awscc/ec2/ec2fleets/index.md | 61 --- .../ec2/egress_only_internet_gateway/index.md | 64 --- .../egress_only_internet_gateways/index.md | 61 --- .../providers/awscc/ec2/eip/index.md | 85 ---- .../awscc/ec2/eip_association/index.md | 71 ---- .../awscc/ec2/eip_associations/index.md | 61 --- .../providers/awscc/ec2/eips/index.md | 66 --- .../index.md | 68 ---- .../index.md | 62 --- .../providers/awscc/ec2/flow_log/index.md | 93 ----- .../providers/awscc/ec2/flow_logs/index.md | 66 --- .../gateway_route_table_association/index.md | 71 ---- .../providers/awscc/ec2/host/index.md | 83 ---- .../providers/awscc/ec2/hosts/index.md | 61 --- docs/awscc-docs/providers/awscc/ec2/index.md | 188 --------- .../ec2/instance_connect_endpoint/index.md | 78 ---- .../ec2/instance_connect_endpoints/index.md | 64 --- .../providers/awscc/ec2/instances/index.md | 161 -------- .../awscc/ec2/internet_gateway/index.md | 70 ---- .../awscc/ec2/internet_gateways/index.md | 62 --- .../providers/awscc/ec2/ipam/index.md | 92 ----- .../awscc/ec2/ipam_allocation/index.md | 68 ---- .../awscc/ec2/ipam_allocations/index.md | 65 --- .../providers/awscc/ec2/ipam_pool/index.md | 122 ------ .../awscc/ec2/ipam_pool_cidr/index.md | 69 ---- .../awscc/ec2/ipam_pool_cidrs/index.md | 63 --- .../providers/awscc/ec2/ipam_pools/index.md | 64 --- .../ec2/ipam_resource_discoveries/index.md | 62 --- .../ec2/ipam_resource_discovery/index.md | 86 ---- .../index.md | 89 ---- .../index.md | 62 --- .../providers/awscc/ec2/ipam_scope/index.md | 86 ---- .../providers/awscc/ec2/ipam_scopes/index.md | 62 --- .../providers/awscc/ec2/ipams/index.md | 63 --- .../providers/awscc/ec2/key_pair/index.md | 74 ---- .../providers/awscc/ec2/key_pairs/index.md | 63 --- .../awscc/ec2/launch_template/index.md | 79 ---- .../awscc/ec2/launch_templates/index.md | 61 --- .../awscc/ec2/local_gateway_route/index.md | 77 ---- .../ec2/local_gateway_route_table/index.md | 83 ---- .../index.md | 83 ---- .../index.md | 62 --- .../ec2/local_gateway_route_tables/index.md | 62 --- .../index.md | 79 ---- .../index.md | 62 --- .../awscc/ec2/local_gateway_routes/index.md | 64 --- .../providers/awscc/ec2/nat_gateway/index.md | 90 ----- .../providers/awscc/ec2/nat_gateways/index.md | 62 --- .../providers/awscc/ec2/network_acl/index.md | 74 ---- .../providers/awscc/ec2/network_acls/index.md | 62 --- .../network_insights_access_scope/index.md | 82 ---- .../index.md | 68 ---- .../index.md | 86 ---- .../network_insights_access_scopes/index.md | 62 --- .../ec2/network_insights_analyses/index.md | 70 ---- .../ec2/network_insights_analysis/index.md | 96 ----- .../awscc/ec2/network_insights_path/index.md | 94 ----- .../awscc/ec2/network_insights_paths/index.md | 61 --- .../awscc/ec2/network_interface/index.md | 113 ------ .../ec2/network_interface_attachment/index.md | 79 ---- .../network_interface_attachments/index.md | 62 --- .../awscc/ec2/network_interfaces/index.md | 63 --- .../index.md | 67 --- .../index.md | 67 --- .../awscc/ec2/placement_group/index.md | 69 ---- .../awscc/ec2/placement_groups/index.md | 62 --- .../providers/awscc/ec2/prefix_list/index.md | 87 ---- .../providers/awscc/ec2/prefix_lists/index.md | 63 --- .../providers/awscc/ec2/route/index.md | 98 ----- .../providers/awscc/ec2/route_table/index.md | 72 ---- .../providers/awscc/ec2/route_tables/index.md | 62 --- .../providers/awscc/ec2/routes/index.md | 64 --- .../awscc/ec2/security_group_egress/index.md | 84 ---- .../ec2/security_group_egresses/index.md | 62 --- .../awscc/ec2/security_group_ingress/index.md | 91 ----- .../ec2/security_group_ingresses/index.md | 61 --- .../ec2/snapshot_block_public_access/index.md | 69 ---- .../snapshot_block_public_accesses/index.md | 61 --- .../providers/awscc/ec2/snapshots/index.md | 83 ---- .../providers/awscc/ec2/spot_fleet/index.md | 69 ---- .../providers/awscc/ec2/spot_fleets/index.md | 64 --- .../providers/awscc/ec2/subnet/index.md | 108 ----- .../awscc/ec2/subnet_cidr_block/index.md | 69 ---- .../awscc/ec2/subnet_cidr_blocks/index.md | 61 --- .../subnet_network_acl_association/index.md | 65 --- .../subnet_network_acl_associations/index.md | 61 --- .../subnet_route_table_association/index.md | 66 --- .../subnet_route_table_associations/index.md | 63 --- .../providers/awscc/ec2/subnets/index.md | 64 --- .../awscc/ec2/transit_gateway/index.md | 112 ------ .../ec2/transit_gateway_attachment/index.md | 98 ----- .../ec2/transit_gateway_attachments/index.md | 75 ---- .../ec2/transit_gateway_connect/index.md | 81 ---- .../ec2/transit_gateway_connects/index.md | 62 --- .../transit_gateway_multicast_domain/index.md | 81 ---- .../index.md | 71 ---- .../index.md | 65 --- .../index.md | 62 --- .../index.md | 81 ---- .../index.md | 65 --- .../index.md | 81 ---- .../index.md | 65 --- .../index.md | 82 ---- .../index.md | 61 --- .../ec2/transit_gateway_route_table/index.md | 67 --- .../ec2/transit_gateway_route_tables/index.md | 62 --- .../transit_gateway_vpc_attachment/index.md | 102 ----- .../transit_gateway_vpc_attachments/index.md | 75 ---- .../awscc/ec2/transit_gateways/index.md | 74 ---- .../ec2/verified_access_endpoint/index.md | 198 --------- .../ec2/verified_access_endpoints/index.md | 122 ------ .../awscc/ec2/verified_access_group/index.md | 111 ----- .../awscc/ec2/verified_access_groups/index.md | 75 ---- .../ec2/verified_access_instance/index.md | 120 ------ .../ec2/verified_access_instances/index.md | 87 ---- .../verified_access_trust_provider/index.md | 108 ----- .../verified_access_trust_providers/index.md | 73 ---- .../providers/awscc/ec2/volume/index.md | 101 ----- .../awscc/ec2/volume_attachment/index.md | 65 --- .../awscc/ec2/volume_attachments/index.md | 63 --- .../providers/awscc/ec2/volumes/index.md | 68 ---- .../providers/awscc/ec2/vpc/index.md | 94 ----- .../providers/awscc/ec2/vpc_endpoint/index.md | 89 ---- .../index.md | 74 ---- .../index.md | 60 --- .../awscc/ec2/vpc_endpoint_service/index.md | 85 ---- .../vpc_endpoint_service_permissions/index.md | 76 ---- .../awscc/ec2/vpc_endpoint_services/index.md | 67 --- .../awscc/ec2/vpc_endpoints/index.md | 61 --- .../awscc/ec2/vpc_gateway_attachment/index.md | 80 ---- .../ec2/vpc_gateway_attachments/index.md | 66 --- .../awscc/ec2/vpc_peering_connection/index.md | 80 ---- .../ec2/vpc_peering_connections/index.md | 64 --- .../ec2/vpcdhcp_options_association/index.md | 67 --- .../ec2/vpcdhcp_options_associations/index.md | 62 --- .../providers/awscc/ec2/vpcs/index.md | 63 --- .../awscc/ec2/vpn_connection/index.md | 83 ---- .../awscc/ec2/vpn_connection_route/index.md | 63 --- .../awscc/ec2/vpn_connection_routes/index.md | 63 --- .../awscc/ec2/vpn_connections/index.md | 62 --- .../providers/awscc/ec2/vpn_gateway/index.md | 72 ---- .../providers/awscc/ec2/vpn_gateways/index.md | 61 --- docs/awscc-docs/providers/awscc/ecr/index.md | 47 --- .../awscc/ecr/public_repositories/index.md | 63 --- .../awscc/ecr/public_repository/index.md | 80 ---- .../ecr/pull_through_cache_rule/index.md | 76 ---- .../ecr/pull_through_cache_rules/index.md | 64 --- .../awscc/ecr/registry_policies/index.md | 61 --- .../awscc/ecr/registry_policy/index.md | 68 ---- .../ecr/replication_configuration/index.md | 71 ---- .../ecr/replication_configurations/index.md | 62 --- .../providers/awscc/ecr/repositories/index.md | 66 --- .../providers/awscc/ecr/repository/index.md | 99 ----- .../index.md | 71 ---- docs/awscc-docs/providers/awscc/ecs/index.md | 44 -- .../awscc/ecs/primary_task_set/index.md | 60 --- .../providers/awscc/ecs/service/index.md | 118 ------ .../providers/awscc/ecs/services/index.md | 67 --- .../awscc/ecs/task_definition/index.md | 107 ----- .../awscc/ecs/task_definitions/index.md | 65 --- .../providers/awscc/ecs/task_set/index.md | 91 ----- .../providers/awscc/efs/access_point/index.md | 81 ---- .../awscc/efs/access_points/index.md | 62 --- .../providers/awscc/efs/file_system/index.md | 119 ------ .../providers/awscc/efs/file_systems/index.md | 75 ---- docs/awscc-docs/providers/awscc/efs/index.md | 43 -- .../providers/awscc/efs/mount_target/index.md | 77 ---- .../awscc/efs/mount_targets/index.md | 62 --- .../awscc/eks/access_entries/index.md | 66 --- .../providers/awscc/eks/access_entry/index.md | 87 ---- .../providers/awscc/eks/addon/index.md | 88 ---- .../providers/awscc/eks/addons/index.md | 65 --- .../providers/awscc/eks/cluster/index.md | 104 ----- .../providers/awscc/eks/clusters/index.md | 76 ---- .../awscc/eks/fargate_profile/index.md | 81 ---- .../awscc/eks/fargate_profiles/index.md | 67 --- .../eks/identity_provider_config/index.md | 78 ---- .../eks/identity_provider_configs/index.md | 67 --- docs/awscc-docs/providers/awscc/eks/index.md | 51 --- .../providers/awscc/eks/nodegroup/index.md | 112 ------ .../providers/awscc/eks/nodegroups/index.md | 76 ---- .../eks/pod_identity_association/index.md | 83 ---- .../eks/pod_identity_associations/index.md | 64 --- .../global_replication_group/index.md | 93 ----- .../global_replication_groups/index.md | 61 --- .../providers/awscc/elasticache/index.md | 47 --- .../elasticache/serverless_cache/index.md | 110 ----- .../elasticache/serverless_caches/index.md | 68 ---- .../awscc/elasticache/subnet_group/index.md | 77 ---- .../awscc/elasticache/subnet_groups/index.md | 63 --- .../providers/awscc/elasticache/user/index.md | 89 ---- .../awscc/elasticache/user_group/index.md | 83 ---- .../awscc/elasticache/user_groups/index.md | 63 --- .../awscc/elasticache/users/index.md | 63 --- .../elasticbeanstalk/application/index.md | 70 ---- .../application_version/index.md | 71 ---- .../application_versions/index.md | 65 --- .../elasticbeanstalk/applications/index.md | 60 --- .../configuration_template/index.md | 80 ---- .../configuration_templates/index.md | 62 --- .../elasticbeanstalk/environment/index.md | 97 ----- .../elasticbeanstalk/environments/index.md | 62 --- .../providers/awscc/elasticbeanstalk/index.md | 45 --- .../awscc/elasticloadbalancingv2/index.md | 49 --- .../elasticloadbalancingv2/listener/index.md | 84 ---- .../listener_rule/index.md | 78 ---- .../listener_rules/index.md | 62 --- .../elasticloadbalancingv2/listeners/index.md | 62 --- .../load_balancer/index.md | 101 ----- .../load_balancers/index.md | 63 --- .../target_group/index.md | 120 ------ .../target_groups/index.md | 65 --- .../trust_store/index.md | 85 ---- .../trust_store_revocation/index.md | 67 --- .../trust_store_revocations/index.md | 65 --- .../trust_stores/index.md | 66 --- docs/awscc-docs/providers/awscc/emr/index.md | 45 --- .../awscc/emr/security_configuration/index.md | 62 --- .../emr/security_configurations/index.md | 61 --- .../providers/awscc/emr/studio/index.md | 109 ----- .../awscc/emr/studio_session_mapping/index.md | 95 ----- .../emr/studio_session_mappings/index.md | 72 ---- .../providers/awscc/emr/studios/index.md | 65 --- .../awscc/emr/wal_workspace/index.md | 69 ---- .../awscc/emr/wal_workspaces/index.md | 62 --- .../providers/awscc/emrcontainers/index.md | 39 -- .../emrcontainers/virtual_cluster/index.md | 76 ---- .../emrcontainers/virtual_clusters/index.md | 62 --- .../awscc/emrserverless/application/index.md | 119 ------ .../awscc/emrserverless/applications/index.md | 83 ---- .../providers/awscc/emrserverless/index.md | 39 -- .../id_mapping_workflow/index.md | 93 ----- .../id_mapping_workflows/index.md | 65 --- .../providers/awscc/entityresolution/index.md | 43 -- .../matching_workflow/index.md | 93 ----- .../matching_workflows/index.md | 65 --- .../entityresolution/schema_mapping/index.md | 85 ---- .../entityresolution/schema_mappings/index.md | 62 --- .../awscc/events/api_destination/index.md | 79 ---- .../awscc/events/api_destinations/index.md | 61 --- .../providers/awscc/events/archive/index.md | 77 ---- .../providers/awscc/events/archives/index.md | 61 --- .../awscc/events/connection/index.md | 81 ---- .../awscc/events/connections/index.md | 65 --- .../providers/awscc/events/endpoint/index.md | 89 ---- .../providers/awscc/events/endpoints/index.md | 63 --- .../providers/awscc/events/event_bus/index.md | 78 ---- .../awscc/events/event_buses/index.md | 65 --- .../providers/awscc/events/index.md | 49 --- .../providers/awscc/events/rule/index.md | 91 ----- .../providers/awscc/events/rules/index.md | 63 --- .../awscc/eventschemas/discoverer/index.md | 87 ---- .../awscc/eventschemas/discoverers/index.md | 67 --- .../eventschemas_registry/index.md | 76 ---- .../providers/awscc/eventschemas/index.md | 44 -- .../awscc/eventschemas/registries/index.md | 62 --- .../eventschemas/registry_policy/index.md | 73 ---- .../awscc/eventschemas/schema/index.md | 89 ---- .../awscc/eventschemas/schemata/index.md | 63 --- .../awscc/evidently/experiment/index.md | 97 ----- .../awscc/evidently/feature/index.md | 88 ---- .../providers/awscc/evidently/index.md | 43 -- .../providers/awscc/evidently/launch/index.md | 92 ----- .../awscc/evidently/project/index.md | 114 ------ .../awscc/evidently/segment/index.md | 71 ---- .../awscc/evidently/segments/index.md | 63 --- .../awscc/finspace/environment/index.md | 94 ----- .../awscc/finspace/environments/index.md | 63 --- .../providers/awscc/finspace/index.md | 39 -- .../awscc/fis/experiment_template/index.md | 85 ---- .../awscc/fis/experiment_templates/index.md | 63 --- docs/awscc-docs/providers/awscc/fis/index.md | 41 -- .../fis/target_account_configuration/index.md | 71 ---- .../target_account_configurations/index.md | 62 --- docs/awscc-docs/providers/awscc/fms/index.md | 43 -- .../awscc/fms/notification_channel/index.md | 68 ---- .../awscc/fms/notification_channels/index.md | 61 --- .../providers/awscc/fms/policies/index.md | 73 ---- .../providers/awscc/fms/policy/index.md | 111 ----- .../providers/awscc/fms/resource_set/index.md | 84 ---- .../awscc/fms/resource_sets/index.md | 63 --- .../providers/awscc/forecast/dataset/index.md | 74 ---- .../awscc/forecast/dataset_group/index.md | 73 ---- .../awscc/forecast/dataset_groups/index.md | 60 --- .../awscc/forecast/datasets/index.md | 60 --- .../providers/awscc/forecast/index.md | 41 -- .../awscc/frauddetector/detector/index.md | 144 ------- .../awscc/frauddetector/detectors/index.md | 91 ----- .../awscc/frauddetector/event_type/index.md | 112 ------ .../awscc/frauddetector/event_types/index.md | 76 ---- .../frauddetector/frauddetector_list/index.md | 87 ---- .../providers/awscc/frauddetector/index.md | 49 --- .../awscc/frauddetector/label/index.md | 81 ---- .../awscc/frauddetector/labels/index.md | 64 --- .../awscc/frauddetector/lists/index.md | 67 --- .../awscc/frauddetector/outcome/index.md | 81 ---- .../awscc/frauddetector/outcomes/index.md | 64 --- .../awscc/frauddetector/variable/index.md | 89 ---- .../awscc/frauddetector/variables/index.md | 64 --- .../fsx/data_repository_association/index.md | 90 ----- .../fsx/data_repository_associations/index.md | 67 --- docs/awscc-docs/providers/awscc/fsx/index.md | 39 -- .../providers/awscc/gamelift/alias/index.md | 71 ---- .../providers/awscc/gamelift/aliases/index.md | 60 --- .../providers/awscc/gamelift/build/index.md | 76 ---- .../providers/awscc/gamelift/builds/index.md | 61 --- .../providers/awscc/gamelift/fleet/index.md | 141 ------- .../providers/awscc/gamelift/fleets/index.md | 66 --- .../awscc/gamelift/game_server_group/index.md | 116 ------ .../gamelift/game_server_groups/index.md | 84 ---- .../gamelift/game_session_queue/index.md | 88 ---- .../gamelift/game_session_queues/index.md | 62 --- .../providers/awscc/gamelift/index.md | 55 --- .../awscc/gamelift/location/index.md | 73 ---- .../awscc/gamelift/locations/index.md | 63 --- .../matchmaking_configuration/index.md | 105 ----- .../matchmaking_configurations/index.md | 63 --- .../gamelift/matchmaking_rule_set/index.md | 78 ---- .../gamelift/matchmaking_rule_sets/index.md | 64 --- .../providers/awscc/gamelift/script/index.md | 86 ---- .../providers/awscc/gamelift/scripts/index.md | 65 --- .../globalaccelerator/accelerator/index.md | 88 ---- .../globalaccelerator/accelerators/index.md | 62 --- .../globalaccelerator/endpoint_group/index.md | 90 ----- .../endpoint_groups/index.md | 65 --- .../awscc/globalaccelerator/index.md | 43 -- .../awscc/globalaccelerator/listener/index.md | 77 ---- .../globalaccelerator/listeners/index.md | 62 --- docs/awscc-docs/providers/awscc/glue/index.md | 40 -- .../awscc/glue/schema_version/index.md | 65 --- .../glue/schema_version_metadata/index.md | 64 --- .../awscc/glue/schema_versions/index.md | 62 --- .../providers/awscc/grafana/index.md | 39 -- .../awscc/grafana/workspace/index.md | 133 ------ .../awscc/grafana/workspaces/index.md | 78 ---- .../greengrassv2/component_version/index.md | 79 ---- .../greengrassv2/component_versions/index.md | 65 --- .../awscc/greengrassv2/deployment/index.md | 90 ----- .../awscc/greengrassv2/deployments/index.md | 75 ---- .../providers/awscc/greengrassv2/index.md | 41 -- .../awscc/groundstation/config/index.md | 80 ---- .../awscc/groundstation/configs/index.md | 62 --- .../dataflow_endpoint_group/index.md | 72 ---- .../dataflow_endpoint_groups/index.md | 66 --- .../providers/awscc/groundstation/index.md | 43 -- .../groundstation/mission_profile/index.md | 98 ----- .../groundstation/mission_profiles/index.md | 67 --- .../awscc/guardduty/detector/index.md | 81 ---- .../awscc/guardduty/detectors/index.md | 64 --- .../providers/awscc/guardduty/filter/index.md | 82 ---- .../awscc/guardduty/filters/index.md | 64 --- .../providers/awscc/guardduty/index.md | 49 --- .../providers/awscc/guardduty/ip_set/index.md | 85 ---- .../awscc/guardduty/ip_sets/index.md | 65 --- .../providers/awscc/guardduty/master/index.md | 64 --- .../awscc/guardduty/masters/index.md | 64 --- .../providers/awscc/guardduty/member/index.md | 82 ---- .../awscc/guardduty/members/index.md | 63 --- .../awscc/guardduty/threat_intel_set/index.md | 84 ---- .../guardduty/threat_intel_sets/index.md | 65 --- .../awscc/healthimaging/datastore/index.md | 81 ---- .../awscc/healthimaging/datastores/index.md | 70 ---- .../providers/awscc/healthimaging/index.md | 39 -- .../awscc/healthlake/fhir_datastore/index.md | 100 ----- .../awscc/healthlake/fhir_datastores/index.md | 76 ---- .../providers/awscc/healthlake/index.md | 39 -- .../providers/awscc/iam/group/index.md | 88 ---- .../awscc/iam/group_policies/index.md | 55 --- .../providers/awscc/iam/group_policy/index.md | 71 ---- .../providers/awscc/iam/groups/index.md | 64 --- docs/awscc-docs/providers/awscc/iam/index.md | 63 --- .../awscc/iam/instance_profile/index.md | 76 ---- .../awscc/iam/instance_profiles/index.md | 63 --- .../awscc/iam/managed_policies/index.md | 63 --- .../awscc/iam/managed_policy/index.md | 111 ----- .../awscc/iam/oidc_provider/index.md | 79 ---- .../awscc/iam/oidc_providers/index.md | 63 --- .../providers/awscc/iam/policies/index.md | 73 ---- .../providers/awscc/iam/role/index.md | 105 ----- .../awscc/iam/role_policies/index.md | 55 --- .../providers/awscc/iam/role_policy/index.md | 71 ---- .../providers/awscc/iam/roles/index.md | 66 --- .../awscc/iam/saml_provider/index.md | 75 ---- .../awscc/iam/saml_providers/index.md | 63 --- .../awscc/iam/server_certificate/index.md | 80 ---- .../awscc/iam/server_certificates/index.md | 63 --- .../awscc/iam/service_linked_role/index.md | 74 ---- .../providers/awscc/iam/user/index.md | 114 ------ .../awscc/iam/user_policies/index.md | 53 --- .../providers/awscc/iam/user_policy/index.md | 71 ---- .../providers/awscc/iam/users/index.md | 66 --- .../awscc/iam/virtualmfa_device/index.md | 75 ---- .../awscc/iam/virtualmfa_devices/index.md | 62 --- .../awscc/identitystore/group/index.md | 73 ---- .../identitystore/group_membership/index.md | 67 --- .../identitystore/group_memberships/index.md | 63 --- .../awscc/identitystore/groups/index.md | 63 --- .../providers/awscc/identitystore/index.md | 41 -- .../awscc/imagebuilder/component/index.md | 86 ---- .../awscc/imagebuilder/components/index.md | 70 ---- .../imagebuilder/container_recipe/index.md | 92 ----- .../imagebuilder/container_recipes/index.md | 75 ---- .../distribution_configuration/index.md | 79 ---- .../distribution_configurations/index.md | 67 --- .../awscc/imagebuilder/image/index.md | 89 ---- .../imagebuilder/image_pipeline/index.md | 98 ----- .../imagebuilder/image_pipelines/index.md | 71 ---- .../awscc/imagebuilder/image_recipe/index.md | 80 ---- .../awscc/imagebuilder/image_recipes/index.md | 67 --- .../awscc/imagebuilder/images/index.md | 71 ---- .../providers/awscc/imagebuilder/index.md | 55 --- .../infrastructure_configuration/index.md | 96 ----- .../infrastructure_configurations/index.md | 67 --- .../imagebuilder/lifecycle_policies/index.md | 63 --- .../imagebuilder/lifecycle_policy/index.md | 85 ---- .../awscc/imagebuilder/workflow/index.md | 80 ---- .../awscc/imagebuilder/workflows/index.md | 69 ---- .../inspector/assessment_target/index.md | 70 ---- .../inspector/assessment_targets/index.md | 62 --- .../inspector/assessment_template/index.md | 70 ---- .../inspector/assessment_templates/index.md | 62 --- .../providers/awscc/inspector/index.md | 42 -- .../awscc/inspector/resource_group/index.md | 62 --- .../cis_scan_configuration/index.md | 82 ---- .../cis_scan_configurations/index.md | 63 --- .../awscc/inspectorv2/filter/index.md | 75 ---- .../awscc/inspectorv2/filters/index.md | 61 --- .../providers/awscc/inspectorv2/index.md | 41 -- .../providers/awscc/internetmonitor/index.md | 39 -- .../awscc/internetmonitor/monitor/index.md | 111 ----- .../awscc/internetmonitor/monitors/index.md | 71 ---- .../iot/account_audit_configuration/index.md | 74 ---- .../iot/account_audit_configurations/index.md | 62 --- .../providers/awscc/iot/authorizer/index.md | 88 ---- .../providers/awscc/iot/authorizers/index.md | 63 --- .../awscc/iot/billing_group/index.md | 79 ---- .../awscc/iot/billing_groups/index.md | 64 --- .../awscc/iot/ca_certificate/index.md | 92 ----- .../awscc/iot/ca_certificates/index.md | 65 --- .../providers/awscc/iot/certificate/index.md | 80 ---- .../awscc/iot/certificate_provider/index.md | 79 ---- .../awscc/iot/certificate_providers/index.md | 63 --- .../providers/awscc/iot/certificates/index.md | 63 --- .../awscc/iot/custom_metric/index.md | 78 ---- .../awscc/iot/custom_metrics/index.md | 61 --- .../providers/awscc/iot/dimension/index.md | 78 ---- .../providers/awscc/iot/dimensions/index.md | 61 --- .../awscc/iot/domain_configuration/index.md | 96 ----- .../awscc/iot/domain_configurations/index.md | 65 --- .../providers/awscc/iot/fleet_metric/index.md | 97 ----- .../awscc/iot/fleet_metrics/index.md | 62 --- docs/awscc-docs/providers/awscc/iot/index.md | 89 ---- .../providers/awscc/iot/job_template/index.md | 86 ---- .../awscc/iot/job_templates/index.md | 63 --- .../providers/awscc/iot/logging/index.md | 72 ---- .../providers/awscc/iot/loggings/index.md | 62 --- .../awscc/iot/mitigation_action/index.md | 81 ---- .../awscc/iot/mitigation_actions/index.md | 63 --- .../providers/awscc/iot/policies/index.md | 63 --- .../providers/awscc/iot/policy/index.md | 84 ---- .../awscc/iot/provisioning_template/index.md | 92 ----- .../awscc/iot/provisioning_templates/index.md | 65 --- .../iot/resource_specific_logging/index.md | 73 ---- .../iot/resource_specific_loggings/index.md | 61 --- .../providers/awscc/iot/role_alias/index.md | 83 ---- .../providers/awscc/iot/role_aliases/index.md | 65 --- .../awscc/iot/scheduled_audit/index.md | 82 ---- .../awscc/iot/scheduled_audits/index.md | 62 --- .../awscc/iot/security_profile/index.md | 91 ----- .../awscc/iot/security_profiles/index.md | 64 --- .../awscc/iot/software_package/index.md | 85 ---- .../iot/software_package_version/index.md | 88 ---- .../iot/software_package_versions/index.md | 65 --- .../awscc/iot/software_packages/index.md | 63 --- .../providers/awscc/iot/thing/index.md | 73 ---- .../providers/awscc/iot/thing_group/index.md | 85 ---- .../providers/awscc/iot/thing_groups/index.md | 65 --- .../providers/awscc/iot/thing_type/index.md | 83 ---- .../providers/awscc/iot/thing_types/index.md | 65 --- .../providers/awscc/iot/things/index.md | 61 --- .../providers/awscc/iot/topic_rule/index.md | 78 ---- .../awscc/iot/topic_rule_destination/index.md | 76 ---- .../iot/topic_rule_destinations/index.md | 63 --- .../providers/awscc/iot/topic_rules/index.md | 64 --- .../awscc/iotanalytics/dataset/index.md | 84 ---- .../awscc/iotanalytics/datasets/index.md | 60 --- .../providers/awscc/iotanalytics/index.md | 41 -- .../awscc/iotanalytics/pipeline/index.md | 74 ---- .../awscc/iotanalytics/pipelines/index.md | 60 --- .../awscc/iotcoredeviceadvisor/index.md | 39 -- .../suite_definition/index.md | 88 ---- .../suite_definitions/index.md | 71 ---- .../awscc/iotevents/alarm_model/index.md | 89 ---- .../awscc/iotevents/alarm_models/index.md | 65 --- .../awscc/iotevents/detector_model/index.md | 85 ---- .../awscc/iotevents/detector_models/index.md | 65 --- .../providers/awscc/iotevents/index.md | 43 -- .../providers/awscc/iotevents/input/index.md | 77 ---- .../providers/awscc/iotevents/inputs/index.md | 63 --- .../awscc/iotfleethub/application/index.md | 92 ----- .../awscc/iotfleethub/applications/index.md | 64 --- .../providers/awscc/iotfleethub/index.md | 39 -- .../awscc/iotfleetwise/campaign/index.md | 111 ----- .../awscc/iotfleetwise/campaigns/index.md | 67 --- .../iotfleetwise/decoder_manifest/index.md | 93 ----- .../iotfleetwise/decoder_manifests/index.md | 66 --- .../awscc/iotfleetwise/fleet/index.md | 83 ---- .../awscc/iotfleetwise/fleets/index.md | 64 --- .../providers/awscc/iotfleetwise/index.md | 49 --- .../iotfleetwise/model_manifest/index.md | 89 ---- .../iotfleetwise/model_manifests/index.md | 65 --- .../iotfleetwise/signal_catalog/index.md | 87 ---- .../iotfleetwise/signal_catalogs/index.md | 64 --- .../awscc/iotfleetwise/vehicle/index.md | 87 ---- .../awscc/iotfleetwise/vehicles/index.md | 66 --- .../iotsitewise/access_policies/index.md | 60 --- .../awscc/iotsitewise/access_policy/index.md | 75 ---- .../awscc/iotsitewise/asset/index.md | 96 ----- .../awscc/iotsitewise/asset_model/index.md | 85 ---- .../awscc/iotsitewise/asset_models/index.md | 65 --- .../awscc/iotsitewise/assets/index.md | 68 ---- .../awscc/iotsitewise/dashboard/index.md | 85 ---- .../awscc/iotsitewise/dashboards/index.md | 65 --- .../awscc/iotsitewise/gateway/index.md | 83 ---- .../awscc/iotsitewise/gateways/index.md | 69 ---- .../providers/awscc/iotsitewise/index.md | 51 --- .../awscc/iotsitewise/portal/index.md | 97 ----- .../awscc/iotsitewise/portals/index.md | 66 --- .../awscc/iotsitewise/project/index.md | 87 ---- .../awscc/iotsitewise/projects/index.md | 65 --- .../iottwinmaker/component_type/index.md | 104 ----- .../iottwinmaker/component_types/index.md | 69 ---- .../awscc/iottwinmaker/entities/index.md | 71 ---- .../awscc/iottwinmaker/entity/index.md | 106 ----- .../providers/awscc/iottwinmaker/index.md | 47 --- .../awscc/iottwinmaker/scene/index.md | 94 ----- .../awscc/iottwinmaker/scenes/index.md | 68 ---- .../awscc/iottwinmaker/sync_job/index.md | 78 ---- .../awscc/iottwinmaker/sync_jobs/index.md | 69 ---- .../awscc/iottwinmaker/workspace/index.md | 85 ---- .../awscc/iottwinmaker/workspaces/index.md | 66 --- .../awscc/iotwireless/destination/index.md | 81 ---- .../awscc/iotwireless/destinations/index.md | 64 --- .../awscc/iotwireless/device_profile/index.md | 69 ---- .../iotwireless/device_profiles/index.md | 63 --- .../awscc/iotwireless/fuota_task/index.md | 97 ----- .../awscc/iotwireless/fuota_tasks/index.md | 65 --- .../providers/awscc/iotwireless/index.md | 59 --- .../iotwireless/multicast_group/index.md | 86 ---- .../iotwireless/multicast_groups/index.md | 63 --- .../network_analyzer_configuration/index.md | 80 ---- .../network_analyzer_configurations/index.md | 63 --- .../iotwireless/partner_account/index.md | 84 ---- .../iotwireless/partner_accounts/index.md | 63 --- .../iotwireless/service_profile/index.md | 69 ---- .../iotwireless/service_profiles/index.md | 63 --- .../iotwireless/task_definition/index.md | 75 ---- .../iotwireless/task_definitions/index.md | 65 --- .../iotwireless/wireless_device/index.md | 92 ----- .../wireless_device_import_task/index.md | 91 ----- .../wireless_device_import_tasks/index.md | 65 --- .../iotwireless/wireless_devices/index.md | 63 --- .../iotwireless/wireless_gateway/index.md | 86 ---- .../iotwireless/wireless_gateways/index.md | 63 --- .../providers/awscc/ivs/channel/index.md | 91 ----- .../providers/awscc/ivs/channels/index.md | 62 --- docs/awscc-docs/providers/awscc/ivs/index.md | 47 --- .../awscc/ivs/playback_key_pair/index.md | 77 ---- .../awscc/ivs/playback_key_pairs/index.md | 62 --- .../ivs/recording_configuration/index.md | 91 ----- .../ivs/recording_configurations/index.md | 70 ---- .../providers/awscc/ivs/stage/index.md | 77 ---- .../providers/awscc/ivs/stages/index.md | 64 --- .../providers/awscc/ivs/stream_key/index.md | 76 ---- .../providers/awscc/ivs/stream_keys/index.md | 63 --- .../providers/awscc/ivschat/index.md | 41 -- .../ivschat/logging_configuration/index.md | 97 ----- .../ivschat/logging_configurations/index.md | 71 ---- .../providers/awscc/ivschat/room/index.md | 84 ---- .../providers/awscc/ivschat/rooms/index.md | 62 --- .../awscc/kafkaconnect/connector/index.md | 104 ----- .../awscc/kafkaconnect/connectors/index.md | 76 ---- .../providers/awscc/kafkaconnect/index.md | 39 -- .../awscc/kendra/data_source/index.md | 94 ----- .../awscc/kendra/data_sources/index.md | 66 --- .../providers/awscc/kendra/faq/index.md | 85 ---- .../providers/awscc/kendra/faqs/index.md | 66 --- .../providers/awscc/kendra/index.md | 43 -- .../providers/awscc/kendra/index/index.md | 94 ----- .../providers/awscc/kendra/indices/index.md | 65 --- .../kendraranking/execution_plan/index.md | 81 ---- .../kendraranking/execution_plans/index.md | 64 --- .../providers/awscc/kendraranking/index.md | 39 -- .../providers/awscc/kinesis/index.md | 39 -- .../awscc/kinesis/kinesis_stream/index.md | 91 ----- .../providers/awscc/kinesis/streams/index.md | 66 --- .../kinesisanalyticsv2/application/index.md | 90 ----- .../kinesisanalyticsv2/applications/index.md | 64 --- .../awscc/kinesisanalyticsv2/index.md | 39 -- .../kinesisfirehose/delivery_stream/index.md | 108 ----- .../kinesisfirehose/delivery_streams/index.md | 65 --- .../providers/awscc/kinesisfirehose/index.md | 39 -- .../providers/awscc/kinesisvideo/index.md | 39 -- .../kinesisvideo/kinesisvideo_stream/index.md | 80 ---- .../kinesisvideo/signaling_channel/index.md | 75 ---- .../providers/awscc/kms/alias/index.md | 67 --- .../providers/awscc/kms/aliases/index.md | 60 --- docs/awscc-docs/providers/awscc/kms/index.md | 43 -- .../providers/awscc/kms/key/index.md | 102 ----- .../providers/awscc/kms/keys/index.md | 65 --- .../providers/awscc/kms/replica_key/index.md | 88 ---- .../providers/awscc/kms/replica_keys/index.md | 65 --- .../lakeformation/data_cells_filter/index.md | 72 ---- .../lakeformation/data_cells_filters/index.md | 67 --- .../providers/awscc/lakeformation/index.md | 43 -- .../principal_permissions/index.md | 77 ---- .../awscc/lakeformation/tag/index.md | 69 ---- .../lakeformation/tag_association/index.md | 70 ---- .../awscc/lakeformation/tags/index.md | 60 --- .../awscc/lambda/code_signing_config/index.md | 73 ---- .../lambda/code_signing_configs/index.md | 60 --- .../awscc/lambda/event_invoke_config/index.md | 73 ---- .../lambda/event_invoke_configs/index.md | 62 --- .../lambda/event_source_mapping/index.md | 113 ------ .../lambda/event_source_mappings/index.md | 61 --- .../providers/awscc/lambda/function/index.md | 149 ------- .../providers/awscc/lambda/functions/index.md | 84 ---- .../providers/awscc/lambda/index.md | 55 --- .../awscc/lambda/layer_version/index.md | 73 ---- .../lambda/layer_version_permission/index.md | 69 ---- .../lambda/layer_version_permissions/index.md | 60 --- .../awscc/lambda/layer_versions/index.md | 62 --- .../awscc/lambda/permission/index.md | 76 ---- .../awscc/lambda/permissions/index.md | 62 --- .../providers/awscc/lambda/url/index.md | 77 ---- .../providers/awscc/lambda/urls/index.md | 60 --- .../providers/awscc/lambda/version/index.md | 75 ---- .../providers/awscc/lambda/versions/index.md | 65 --- .../providers/awscc/lex/bot/index.md | 129 ------ .../providers/awscc/lex/bot_alias/index.md | 89 ---- .../providers/awscc/lex/bot_aliases/index.md | 63 --- .../providers/awscc/lex/bot_version/index.md | 67 --- .../providers/awscc/lex/bot_versions/index.md | 66 --- .../providers/awscc/lex/bots/index.md | 89 ---- docs/awscc-docs/providers/awscc/lex/index.md | 45 --- .../awscc/lex/resource_policies/index.md | 61 --- .../awscc/lex/resource_policy/index.md | 73 ---- .../awscc/licensemanager/grant/index.md | 79 ---- .../awscc/licensemanager/grants/index.md | 60 --- .../providers/awscc/licensemanager/index.md | 41 -- .../awscc/licensemanager/license/index.md | 89 ---- .../awscc/licensemanager/licenses/index.md | 60 --- .../providers/awscc/lightsail/alarm/index.md | 91 ----- .../providers/awscc/lightsail/alarms/index.md | 61 --- .../providers/awscc/lightsail/bucket/index.md | 90 ----- .../awscc/lightsail/buckets/index.md | 67 --- .../awscc/lightsail/certificate/index.md | 78 ---- .../awscc/lightsail/certificates/index.md | 63 --- .../awscc/lightsail/container/index.md | 90 ----- .../awscc/lightsail/containers/index.md | 65 --- .../awscc/lightsail/database/index.md | 103 ----- .../awscc/lightsail/databases/index.md | 67 --- .../awscc/lightsail/distribution/index.md | 98 ----- .../awscc/lightsail/distributions/index.md | 69 ---- .../providers/awscc/lightsail/index.md | 57 --- .../awscc/lightsail/instance/index.md | 118 ------ .../awscc/lightsail/instances/index.md | 73 ---- .../awscc/lightsail/load_balancer/index.md | 93 ----- .../load_balancer_tls_certificate/index.md | 85 ---- .../load_balancer_tls_certificates/index.md | 67 --- .../awscc/lightsail/load_balancers/index.md | 68 ---- .../awscc/lightsail/static_ip/index.md | 80 ---- .../awscc/lightsail/static_ips/index.md | 65 --- .../providers/awscc/location/api_key/index.md | 102 ----- .../awscc/location/api_keys/index.md | 73 ---- .../location/geofence_collection/index.md | 91 ----- .../location/geofence_collections/index.md | 65 --- .../providers/awscc/location/index.md | 51 --- .../providers/awscc/location/map/index.md | 86 ---- .../providers/awscc/location/maps/index.md | 63 --- .../awscc/location/place_index/index.md | 88 ---- .../awscc/location/place_indices/index.md | 63 --- .../awscc/location/route_calculator/index.md | 86 ---- .../awscc/location/route_calculators/index.md | 63 --- .../providers/awscc/location/tracker/index.md | 97 ----- .../awscc/location/tracker_consumer/index.md | 63 --- .../awscc/location/tracker_consumers/index.md | 63 --- .../awscc/location/trackers/index.md | 65 --- .../awscc/logs/account_policies/index.md | 72 ---- .../awscc/logs/account_policy/index.md | 89 ---- .../providers/awscc/logs/deliveries/index.md | 67 --- .../providers/awscc/logs/delivery/index.md | 81 ---- .../awscc/logs/delivery_destination/index.md | 85 ---- .../awscc/logs/delivery_destinations/index.md | 67 --- .../awscc/logs/delivery_source/index.md | 82 ---- .../awscc/logs/delivery_sources/index.md | 67 --- .../providers/awscc/logs/destination/index.md | 76 ---- .../awscc/logs/destinations/index.md | 63 --- docs/awscc-docs/providers/awscc/logs/index.md | 59 --- .../awscc/logs/log_anomaly_detector/index.md | 85 ---- .../awscc/logs/log_anomaly_detectors/index.md | 60 --- .../providers/awscc/logs/log_stream/index.md | 62 --- .../providers/awscc/logs/log_streams/index.md | 62 --- .../awscc/logs/metric_filter/index.md | 72 ---- .../awscc/logs/metric_filters/index.md | 63 --- .../awscc/logs/query_definition/index.md | 71 ---- .../awscc/logs/query_definitions/index.md | 60 --- .../awscc/logs/resource_policies/index.md | 61 --- .../awscc/logs/resource_policy/index.md | 69 ---- .../awscc/logs/subscription_filter/index.md | 77 ---- .../awscc/logs/subscription_filters/index.md | 64 --- .../providers/awscc/lookoutequipment/index.md | 39 -- .../inference_scheduler/index.md | 88 ---- .../inference_schedulers/index.md | 62 --- .../awscc/lookoutmetrics/alert/index.md | 70 ---- .../awscc/lookoutmetrics/alerts/index.md | 61 --- .../lookoutmetrics/anomaly_detector/index.md | 79 ---- .../lookoutmetrics/anomaly_detectors/index.md | 63 --- .../providers/awscc/lookoutmetrics/index.md | 41 -- .../providers/awscc/lookoutvision/index.md | 39 -- .../awscc/lookoutvision/project/index.md | 62 --- .../awscc/lookoutvision/projects/index.md | 60 --- .../providers/awscc/m2/application/index.md | 92 ----- .../providers/awscc/m2/applications/index.md | 68 ---- .../providers/awscc/m2/environment/index.md | 100 ----- .../providers/awscc/m2/environments/index.md | 78 ---- docs/awscc-docs/providers/awscc/m2/index.md | 41 -- .../providers/awscc/macie/allow_list/index.md | 80 ---- .../awscc/macie/allow_lists/index.md | 62 --- .../macie/custom_data_identifier/index.md | 82 ---- .../macie/custom_data_identifiers/index.md | 62 --- .../awscc/macie/findings_filter/index.md | 82 ---- .../awscc/macie/findings_filters/index.md | 62 --- .../awscc-docs/providers/awscc/macie/index.md | 45 --- .../providers/awscc/macie/session/index.md | 72 ---- .../providers/awscc/macie/sessions/index.md | 61 --- .../awscc/managedblockchain/accessor/index.md | 82 ---- .../managedblockchain/accessors/index.md | 62 --- .../awscc/managedblockchain/index.md | 39 -- .../awscc/mediaconnect/bridge/index.md | 83 ---- .../awscc/mediaconnect/bridge_output/index.md | 70 ---- .../awscc/mediaconnect/bridge_source/index.md | 72 ---- .../awscc/mediaconnect/bridges/index.md | 61 --- .../awscc/mediaconnect/flow/index.md | 78 ---- .../mediaconnect/flow_entitlement/index.md | 81 ---- .../mediaconnect/flow_entitlements/index.md | 61 --- .../awscc/mediaconnect/flow_output/index.md | 95 ----- .../awscc/mediaconnect/flow_outputs/index.md | 61 --- .../awscc/mediaconnect/flow_source/index.md | 107 ----- .../awscc/mediaconnect/flow_sources/index.md | 63 --- .../mediaconnect/flow_vpc_interface/index.md | 78 ---- .../mediaconnect/flow_vpc_interfaces/index.md | 64 --- .../awscc/mediaconnect/flows/index.md | 61 --- .../awscc/mediaconnect/gateway/index.md | 70 ---- .../awscc/mediaconnect/gateways/index.md | 62 --- .../providers/awscc/mediaconnect/index.md | 53 --- .../providers/awscc/medialive/index.md | 41 -- .../awscc/medialive/multiplex/index.md | 87 ---- .../awscc/medialive/multiplexes/index.md | 62 --- .../awscc/medialive/multiplexprogram/index.md | 79 ---- .../medialive/multiplexprograms/index.md | 63 --- .../awscc/mediapackage/asset/index.md | 77 ---- .../awscc/mediapackage/assets/index.md | 64 --- .../awscc/mediapackage/channel/index.md | 79 ---- .../awscc/mediapackage/channels/index.md | 65 --- .../providers/awscc/mediapackage/index.md | 47 --- .../mediapackage/origin_endpoint/index.md | 96 ----- .../mediapackage/origin_endpoints/index.md | 65 --- .../packaging_configuration/index.md | 75 ---- .../packaging_configurations/index.md | 64 --- .../mediapackage/packaging_group/index.md | 81 ---- .../mediapackage/packaging_groups/index.md | 65 --- .../awscc/mediapackagev2/channel/index.md | 83 ---- .../mediapackagev2/channel_group/index.md | 81 ---- .../mediapackagev2/channel_groups/index.md | 61 --- .../mediapackagev2/channel_policy/index.md | 71 ---- .../awscc/mediapackagev2/channels/index.md | 61 --- .../providers/awscc/mediapackagev2/index.md | 45 --- .../mediapackagev2/origin_endpoint/index.md | 94 ----- .../origin_endpoint_policy/index.md | 73 ---- .../mediapackagev2/origin_endpoints/index.md | 62 --- .../awscc/mediatailor/channel/index.md | 87 ---- .../awscc/mediatailor/channel_policy/index.md | 69 ---- .../awscc/mediatailor/channels/index.md | 64 --- .../providers/awscc/mediatailor/index.md | 48 --- .../awscc/mediatailor/live_source/index.md | 77 ---- .../awscc/mediatailor/live_sources/index.md | 64 --- .../playback_configuration/index.md | 103 ----- .../playback_configurations/index.md | 64 --- .../mediatailor/source_location/index.md | 84 ---- .../mediatailor/source_locations/index.md | 65 --- .../awscc/mediatailor/vod_source/index.md | 77 ---- .../awscc/mediatailor/vod_sources/index.md | 64 --- .../providers/awscc/memorydb/acl/index.md | 80 ---- .../providers/awscc/memorydb/acls/index.md | 64 --- .../providers/awscc/memorydb/cluster/index.md | 125 ------ .../awscc/memorydb/clusters/index.md | 62 --- .../providers/awscc/memorydb/index.md | 47 --- .../awscc/memorydb/parameter_group/index.md | 82 ---- .../awscc/memorydb/parameter_groups/index.md | 63 --- .../awscc/memorydb/subnet_group/index.md | 79 ---- .../awscc/memorydb/subnet_groups/index.md | 63 --- .../providers/awscc/memorydb/user/index.md | 81 ---- .../providers/awscc/memorydb/users/index.md | 64 --- .../awscc/msk/batch_scram_secret/index.md | 78 ---- .../awscc/msk/batch_scram_secrets/index.md | 67 --- .../providers/awscc/msk/cluster/index.md | 123 ------ .../awscc/msk/cluster_policies/index.md | 61 --- .../awscc/msk/cluster_policy/index.md | 71 ---- .../providers/awscc/msk/clusters/index.md | 82 ---- .../awscc/msk/configuration/index.md | 77 ---- .../awscc/msk/configurations/index.md | 61 --- docs/awscc-docs/providers/awscc/msk/index.md | 51 --- .../providers/awscc/msk/replicator/index.md | 87 ---- .../providers/awscc/msk/replicators/index.md | 72 ---- .../awscc/msk/serverless_cluster/index.md | 70 ---- .../awscc/msk/serverless_clusters/index.md | 69 ---- .../awscc/msk/vpc_connection/index.md | 90 ----- .../awscc/msk/vpc_connections/index.md | 79 ---- .../providers/awscc/mwaa/environment/index.md | 121 ------ .../awscc/mwaa/environments/index.md | 60 --- docs/awscc-docs/providers/awscc/mwaa/index.md | 39 -- .../awscc/neptune/db_cluster/index.md | 144 ------- .../awscc/neptune/db_clusters/index.md | 72 ---- .../providers/awscc/neptune/index.md | 39 -- .../awscc/neptunegraph/graph/index.md | 99 ----- .../awscc/neptunegraph/graphs/index.md | 72 ---- .../providers/awscc/neptunegraph/index.md | 41 -- .../private_graph_endpoint/index.md | 86 ---- .../private_graph_endpoints/index.md | 73 ---- .../awscc/networkfirewall/firewall/index.md | 105 ----- .../firewall_policies/index.md | 64 --- .../networkfirewall/firewall_policy/index.md | 83 ---- .../awscc/networkfirewall/firewalls/index.md | 71 ---- .../providers/awscc/networkfirewall/index.md | 47 --- .../logging_configuration/index.md | 88 ---- .../logging_configurations/index.md | 73 ---- .../awscc/networkfirewall/rule_group/index.md | 87 ---- .../networkfirewall/rule_groups/index.md | 65 --- .../tls_inspection_configuration/index.md | 81 ---- .../tls_inspection_configurations/index.md | 62 --- .../connect_attachment/index.md | 101 ----- .../connect_attachments/index.md | 63 --- .../networkmanager/connect_peer/index.md | 95 ----- .../networkmanager/connect_peers/index.md | 63 --- .../networkmanager/core_network/index.md | 98 ----- .../networkmanager/core_networks/index.md | 64 --- .../customer_gateway_association/index.md | 66 --- .../customer_gateway_associations/index.md | 63 --- .../awscc/networkmanager/device/index.md | 96 ----- .../awscc/networkmanager/devices/index.md | 64 --- .../networkmanager/global_network/index.md | 80 ---- .../networkmanager/global_networks/index.md | 63 --- .../providers/awscc/networkmanager/index.md | 65 --- .../awscc/networkmanager/link/index.md | 90 ----- .../networkmanager/link_association/index.md | 64 --- .../networkmanager/link_associations/index.md | 65 --- .../awscc/networkmanager/links/index.md | 64 --- .../awscc/networkmanager/site/index.md | 84 ---- .../site_to_site_vpn_attachment/index.md | 99 ----- .../site_to_site_vpn_attachments/index.md | 63 --- .../awscc/networkmanager/sites/index.md | 64 --- .../transit_gateway_peering/index.md | 94 ----- .../transit_gateway_peerings/index.md | 66 --- .../transit_gateway_registration/index.md | 63 --- .../transit_gateway_registrations/index.md | 63 --- .../index.md | 101 ----- .../index.md | 64 --- .../networkmanager/vpc_attachment/index.md | 105 ----- .../networkmanager/vpc_attachments/index.md | 64 --- .../providers/awscc/nimblestudio/index.md | 45 --- .../nimblestudio/launch_profile/index.md | 88 ---- .../nimblestudio/launch_profiles/index.md | 68 ---- .../nimblestudio/streaming_image/index.md | 97 ----- .../nimblestudio/streaming_images/index.md | 75 ---- .../awscc/nimblestudio/studio/index.md | 103 ----- .../nimblestudio/studio_component/index.md | 98 ----- .../nimblestudio/studio_components/index.md | 69 ---- .../awscc/nimblestudio/studios/index.md | 69 ---- docs/awscc-docs/providers/awscc/oam/index.md | 41 -- .../providers/awscc/oam/link/index.md | 83 ---- .../providers/awscc/oam/links/index.md | 65 --- .../providers/awscc/oam/sink/index.md | 78 ---- .../providers/awscc/oam/sinks/index.md | 63 --- .../awscc/omics/annotation_store/index.md | 96 ----- .../awscc/omics/annotation_stores/index.md | 67 --- .../awscc-docs/providers/awscc/omics/index.md | 49 --- .../awscc/omics/reference_store/index.md | 73 ---- .../awscc/omics/reference_stores/index.md | 61 --- .../providers/awscc/omics/run_group/index.md | 86 ---- .../providers/awscc/omics/run_groups/index.md | 61 --- .../awscc/omics/sequence_store/index.md | 75 ---- .../awscc/omics/sequence_stores/index.md | 61 --- .../awscc/omics/variant_store/index.md | 92 ----- .../awscc/omics/variant_stores/index.md | 67 --- .../providers/awscc/omics/workflow/index.md | 96 ----- .../providers/awscc/omics/workflows/index.md | 72 ---- .../access_policies/index.md | 63 --- .../access_policy/index.md | 73 ---- .../opensearchserverless/collection/index.md | 83 ---- .../opensearchserverless/collections/index.md | 62 --- .../awscc/opensearchserverless/index.md | 49 --- .../lifecycle_policies/index.md | 62 --- .../lifecycle_policy/index.md | 72 ---- .../security_config/index.md | 74 ---- .../security_configs/index.md | 60 --- .../security_policies/index.md | 65 --- .../security_policy/index.md | 76 ---- .../vpc_endpoint/index.md | 107 ----- .../vpc_endpoints/index.md | 78 ---- .../awscc/opensearchservice/domain/index.md | 121 ------ .../awscc/opensearchservice/index.md | 39 -- .../providers/awscc/opsworkscm/index.md | 39 -- .../awscc/opsworkscm/server/index.md | 113 ------ .../awscc/opsworkscm/servers/index.md | 63 --- .../awscc/organizations/account/index.md | 91 ----- .../awscc/organizations/accounts/index.md | 66 --- .../providers/awscc/organizations/index.md | 47 --- .../awscc/organizations/organization/index.md | 74 ---- .../organizational_unit/index.md | 80 ---- .../organizational_units/index.md | 64 --- .../organizations/organizations/index.md | 63 --- .../awscc/organizations/policies/index.md | 65 --- .../awscc/organizations/policy/index.md | 91 ----- .../organizations/resource_policies/index.md | 63 --- .../organizations/resource_policy/index.md | 76 ---- docs/awscc-docs/providers/awscc/osis/index.md | 39 -- .../providers/awscc/osis/pipeline/index.md | 101 ----- .../providers/awscc/osis/pipelines/index.md | 67 --- .../panorama/application_instance/index.md | 115 ------ .../panorama/application_instances/index.md | 72 ---- .../providers/awscc/panorama/index.md | 42 -- .../providers/awscc/panorama/package/index.md | 95 ----- .../awscc/panorama/package_version/index.md | 102 ----- .../awscc/panorama/packages/index.md | 70 ---- .../awscc/pcaconnectorad/connector/index.md | 79 ---- .../awscc/pcaconnectorad/connectors/index.md | 69 ---- .../directory_registration/index.md | 76 ---- .../directory_registrations/index.md | 63 --- .../providers/awscc/pcaconnectorad/index.md | 47 --- .../service_principal_name/index.md | 64 --- .../service_principal_names/index.md | 64 --- .../awscc/pcaconnectorad/template/index.md | 80 ---- .../index.md | 62 --- .../index.md | 72 ---- .../awscc/pcaconnectorad/templates/index.md | 60 --- .../awscc/personalize/dataset/index.md | 79 ---- .../awscc/personalize/dataset_group/index.md | 69 ---- .../awscc/personalize/dataset_groups/index.md | 62 --- .../awscc/personalize/datasets/index.md | 64 --- .../providers/awscc/personalize/index.md | 45 --- .../awscc/personalize/schema/index.md | 67 --- .../awscc/personalize/schemata/index.md | 61 --- .../awscc/personalize/solution/index.md | 75 ---- .../awscc/personalize/solutions/index.md | 61 --- .../awscc/pinpoint/in_app_template/index.md | 80 ---- .../awscc/pinpoint/in_app_templates/index.md | 63 --- .../providers/awscc/pinpoint/index.md | 39 -- .../awscc-docs/providers/awscc/pipes/index.md | 39 -- .../providers/awscc/pipes/pipe/index.md | 119 ------ .../providers/awscc/pipes/pipes/index.md | 73 ---- .../environment_account_connection/index.md | 96 ----- .../environment_account_connections/index.md | 64 --- .../proton/environment_template/index.md | 87 ---- .../proton/environment_templates/index.md | 63 --- .../providers/awscc/proton/index.md | 43 -- .../awscc/proton/service_template/index.md | 88 ---- .../awscc/proton/service_templates/index.md | 63 --- docs/awscc-docs/providers/awscc/qldb/index.md | 39 -- .../providers/awscc/qldb/qldb_stream/index.md | 85 ---- .../providers/awscc/qldb/streams/index.md | 64 --- .../awscc/quicksight/analyses/index.md | 70 ---- .../awscc/quicksight/analysis/index.md | 109 ----- .../awscc/quicksight/dashboard/index.md | 115 ------ .../awscc/quicksight/dashboards/index.md | 70 ---- .../awscc/quicksight/data_set/index.md | 129 ------ .../awscc/quicksight/data_sets/index.md | 73 ---- .../awscc/quicksight/data_source/index.md | 106 ----- .../awscc/quicksight/data_sources/index.md | 67 --- .../providers/awscc/quicksight/index.md | 55 --- .../quicksight/refresh_schedule/index.md | 73 ---- .../quicksight/refresh_schedules/index.md | 65 --- .../awscc/quicksight/template/index.md | 99 ----- .../awscc/quicksight/templates/index.md | 68 ---- .../providers/awscc/quicksight/theme/index.md | 98 ----- .../awscc/quicksight/themes/index.md | 67 --- .../providers/awscc/quicksight/topic/index.md | 79 ---- .../awscc/quicksight/topics/index.md | 64 --- .../awscc/quicksight/vpc_connection/index.md | 102 ----- .../awscc/quicksight/vpc_connections/index.md | 66 --- docs/awscc-docs/providers/awscc/ram/index.md | 39 -- .../providers/awscc/ram/permission/index.md | 88 ---- .../providers/awscc/ram/permissions/index.md | 62 --- .../rds/customdb_engine_version/index.md | 87 ---- .../rds/customdb_engine_versions/index.md | 76 ---- .../providers/awscc/rds/db_cluster/index.md | 200 --------- .../rds/db_cluster_parameter_group/index.md | 84 ---- .../rds/db_cluster_parameter_groups/index.md | 69 ---- .../providers/awscc/rds/db_clusters/index.md | 73 ---- .../providers/awscc/rds/db_instance/index.md | 258 ------------ .../providers/awscc/rds/db_instances/index.md | 89 ---- .../awscc/rds/db_parameter_group/index.md | 83 ---- .../awscc/rds/db_parameter_groups/index.md | 68 ---- .../providers/awscc/rds/db_proxies/index.md | 62 --- .../providers/awscc/rds/db_proxy/index.md | 93 ----- .../awscc/rds/db_proxy_endpoint/index.md | 87 ---- .../awscc/rds/db_proxy_endpoints/index.md | 61 --- .../awscc/rds/db_proxy_target_group/index.md | 79 ---- .../awscc/rds/db_proxy_target_groups/index.md | 63 --- .../awscc/rds/db_subnet_group/index.md | 78 ---- .../awscc/rds/db_subnet_groups/index.md | 65 --- .../awscc/rds/event_subscription/index.md | 85 ---- .../awscc/rds/event_subscriptions/index.md | 65 --- .../awscc/rds/global_cluster/index.md | 79 ---- .../awscc/rds/global_clusters/index.md | 62 --- docs/awscc-docs/providers/awscc/rds/index.md | 63 --- .../providers/awscc/rds/integration/index.md | 82 ---- .../providers/awscc/rds/integrations/index.md | 65 --- .../providers/awscc/rds/option_group/index.md | 83 ---- .../awscc/rds/option_groups/index.md | 66 --- .../providers/awscc/redshift/cluster/index.md | 206 ---------- .../redshift/cluster_parameter_group/index.md | 87 ---- .../cluster_parameter_groups/index.md | 78 ---- .../redshift/cluster_subnet_group/index.md | 108 ----- .../redshift/cluster_subnet_groups/index.md | 84 ---- .../awscc/redshift/clusters/index.md | 92 ----- .../awscc/redshift/endpoint_access/index.md | 109 ----- .../awscc/redshift/endpoint_accesses/index.md | 75 ---- .../redshift/endpoint_authorization/index.md | 97 ----- .../redshift/endpoint_authorizations/index.md | 63 --- .../redshift/event_subscription/index.md | 99 ----- .../redshift/event_subscriptions/index.md | 64 --- .../providers/awscc/redshift/index.md | 51 --- .../awscc/redshift/scheduled_action/index.md | 92 ----- .../awscc/redshift/scheduled_actions/index.md | 67 --- .../awscc/redshiftserverless/index.md | 41 -- .../redshiftserverless/namespace/index.md | 134 ------ .../redshiftserverless/namespaces/index.md | 84 ---- .../redshiftserverless/workgroup/index.md | 113 ------ .../redshiftserverless/workgroups/index.md | 76 ---- .../awscc/refactorspaces/application/index.md | 102 ----- .../refactorspaces/applications/index.md | 88 ---- .../awscc/refactorspaces/environment/index.md | 82 ---- .../refactorspaces/environments/index.md | 87 ---- .../providers/awscc/refactorspaces/index.md | 45 --- .../awscc/refactorspaces/route/index.md | 130 ------ .../awscc/refactorspaces/routes/index.md | 86 ---- .../awscc/refactorspaces/service/index.md | 93 ----- .../awscc/refactorspaces/services/index.md | 77 ---- .../awscc/rekognition/collection/index.md | 73 ---- .../awscc/rekognition/collections/index.md | 63 --- .../providers/awscc/rekognition/index.md | 43 -- .../awscc/rekognition/project/index.md | 63 --- .../awscc/rekognition/projects/index.md | 60 --- .../rekognition/stream_processor/index.md | 99 ----- .../rekognition/stream_processors/index.md | 64 --- .../awscc/resiliencehub/app/index.md | 109 ----- .../awscc/resiliencehub/apps/index.md | 79 ---- .../providers/awscc/resiliencehub/index.md | 41 -- .../resiliency_policies/index.md | 62 --- .../resiliencehub/resiliency_policy/index.md | 83 ---- .../default_view_association/index.md | 69 ---- .../awscc/resourceexplorer2/index.md | 42 -- .../awscc/resourceexplorer2/index/index.md | 77 ---- .../awscc/resourceexplorer2/indices/index.md | 65 --- .../awscc/resourceexplorer2/view/index.md | 80 ---- .../awscc/resourceexplorer2/views/index.md | 61 --- .../awscc/resourcegroups/group/index.md | 92 ----- .../awscc/resourcegroups/groups/index.md | 65 --- .../providers/awscc/resourcegroups/index.md | 39 -- .../providers/awscc/robomaker/fleet/index.md | 70 ---- .../providers/awscc/robomaker/fleets/index.md | 60 --- .../providers/awscc/robomaker/index.md | 47 --- .../providers/awscc/robomaker/robot/index.md | 78 ---- .../robomaker/robot_application/index.md | 84 ---- .../robot_application_version/index.md | 67 --- .../robomaker/robot_applications/index.md | 67 --- .../providers/awscc/robomaker/robots/index.md | 61 --- .../robomaker/simulation_application/index.md | 88 ---- .../simulation_application_version/index.md | 67 --- .../simulation_applications/index.md | 67 --- .../awscc/rolesanywhere/crl/index.md | 81 ---- .../awscc/rolesanywhere/crls/index.md | 63 --- .../providers/awscc/rolesanywhere/index.md | 43 -- .../awscc/rolesanywhere/profile/index.md | 92 ----- .../awscc/rolesanywhere/profiles/index.md | 66 --- .../awscc/rolesanywhere/trust_anchor/index.md | 87 ---- .../rolesanywhere/trust_anchors/index.md | 64 --- .../awscc/route53/cidr_collection/index.md | 73 ---- .../awscc/route53/cidr_collections/index.md | 62 --- .../providers/awscc/route53/dnssec/index.md | 65 --- .../providers/awscc/route53/dnssecs/index.md | 66 --- .../awscc/route53/health_check/index.md | 73 ---- .../awscc/route53/health_checks/index.md | 64 --- .../awscc/route53/hosted_zone/index.md | 90 ----- .../awscc/route53/hosted_zones/index.md | 69 ---- .../providers/awscc/route53/index.md | 47 --- .../awscc/route53/key_signing_key/index.md | 82 ---- .../awscc/route53/key_signing_keys/index.md | 67 --- .../route53recoverycontrol/cluster/index.md | 70 ---- .../route53recoverycontrol/clusters/index.md | 63 --- .../control_panel/index.md | 83 ---- .../control_panels/index.md | 64 --- .../awscc/route53recoverycontrol/index.md | 45 --- .../routing_control/index.md | 76 ---- .../routing_controls/index.md | 63 --- .../safety_rule/index.md | 85 ---- .../safety_rules/index.md | 65 --- .../route53recoveryreadiness/cell/index.md | 79 ---- .../route53recoveryreadiness/cells/index.md | 63 --- .../awscc/route53recoveryreadiness/index.md | 45 --- .../readiness_check/index.md | 78 ---- .../readiness_checks/index.md | 65 --- .../recovery_group/index.md | 78 ---- .../recovery_groups/index.md | 64 --- .../resource_set/index.md | 81 ---- .../resource_sets/index.md | 65 --- .../firewall_domain_list/index.md | 104 ----- .../firewall_domain_lists/index.md | 70 ---- .../firewall_rule_group/index.md | 104 ----- .../firewall_rule_group_association/index.md | 106 ----- .../firewall_rule_group_associations/index.md | 70 ---- .../firewall_rule_groups/index.md | 70 ---- .../providers/awscc/route53resolver/index.md | 57 --- .../route53resolver/outpost_resolver/index.md | 95 ----- .../outpost_resolvers/index.md | 64 --- .../route53resolver/resolver_config/index.md | 71 ---- .../route53resolver/resolver_configs/index.md | 63 --- .../resolver_query_logging_config/index.md | 82 ---- .../index.md | 77 ---- .../index.md | 65 --- .../resolver_query_logging_configs/index.md | 73 ---- .../route53resolver/resolver_rule/index.md | 85 ---- .../resolver_rule_association/index.md | 67 --- .../resolver_rule_associations/index.md | 62 --- .../route53resolver/resolver_rules/index.md | 63 --- .../resolverdnssec_config/index.md | 70 ---- .../resolverdnssec_configs/index.md | 64 --- .../providers/awscc/rum/app_monitor/index.md | 120 ------ .../providers/awscc/rum/app_monitors/index.md | 90 ----- docs/awscc-docs/providers/awscc/rum/index.md | 39 -- .../providers/awscc/s3/access_grant/index.md | 83 ---- .../providers/awscc/s3/access_grants/index.md | 61 --- .../awscc/s3/access_grants_instance/index.md | 71 ---- .../awscc/s3/access_grants_instances/index.md | 61 --- .../awscc/s3/access_grants_location/index.md | 75 ---- .../awscc/s3/access_grants_locations/index.md | 62 --- .../providers/awscc/s3/access_point/index.md | 87 ---- .../providers/awscc/s3/access_points/index.md | 62 --- .../providers/awscc/s3/bucket/index.md | 160 -------- .../awscc/s3/bucket_policies/index.md | 62 --- .../providers/awscc/s3/bucket_policy/index.md | 69 ---- .../providers/awscc/s3/buckets/index.md | 84 ---- docs/awscc-docs/providers/awscc/s3/index.md | 56 --- .../s3/multi_region_access_point/index.md | 70 ---- .../index.md | 56 --- .../multi_region_access_point_policy/index.md | 72 ---- .../s3/multi_region_access_points/index.md | 62 --- .../providers/awscc/s3/storage_lens/index.md | 77 ---- .../awscc/s3/storage_lens_group/index.md | 76 ---- .../awscc/s3/storage_lens_groups/index.md | 63 --- .../awscc/s3express/bucket_policies/index.md | 62 --- .../awscc/s3express/bucket_policy/index.md | 69 ---- .../awscc/s3express/directory_bucket/index.md | 67 --- .../s3express/directory_buckets/index.md | 61 --- .../providers/awscc/s3express/index.md | 41 -- .../s3objectlambda/access_point/index.md | 82 ---- .../access_point_policy/index.md | 69 ---- .../s3objectlambda/access_points/index.md | 64 --- .../providers/awscc/s3objectlambda/index.md | 40 -- .../awscc/s3outposts/access_point/index.md | 78 ---- .../awscc/s3outposts/access_points/index.md | 63 --- .../awscc/s3outposts/bucket/index.md | 77 ---- .../awscc/s3outposts/bucket_policy/index.md | 69 ---- .../awscc/s3outposts/buckets/index.md | 62 --- .../awscc/s3outposts/endpoint/index.md | 82 ---- .../awscc/s3outposts/endpoints/index.md | 60 --- .../providers/awscc/s3outposts/index.md | 44 -- .../providers/awscc/sagemaker/app/index.md | 74 ---- .../awscc/sagemaker/app_image_config/index.md | 75 ---- .../sagemaker/app_image_configs/index.md | 61 --- .../providers/awscc/sagemaker/apps/index.md | 67 --- .../data_quality_job_definition/index.md | 84 ---- .../data_quality_job_definitions/index.md | 64 --- .../providers/awscc/sagemaker/device/index.md | 69 ---- .../awscc/sagemaker/device_fleet/index.md | 74 ---- .../awscc/sagemaker/feature_group/index.md | 93 ----- .../awscc/sagemaker/feature_groups/index.md | 70 ---- .../providers/awscc/sagemaker/image/index.md | 82 ---- .../awscc/sagemaker/image_version/index.md | 96 ----- .../awscc/sagemaker/image_versions/index.md | 61 --- .../providers/awscc/sagemaker/images/index.md | 64 --- .../providers/awscc/sagemaker/index.md | 77 ---- .../sagemaker/inference_component/index.md | 95 ----- .../sagemaker/inference_components/index.md | 65 --- .../sagemaker/inference_experiment/index.md | 109 ----- .../sagemaker/inference_experiments/index.md | 64 --- .../model_bias_job_definition/index.md | 84 ---- .../model_bias_job_definitions/index.md | 64 --- .../awscc/sagemaker/model_card/index.md | 106 ----- .../awscc/sagemaker/model_cards/index.md | 67 --- .../index.md | 84 ---- .../index.md | 64 --- .../awscc/sagemaker/model_package/index.md | 123 ------ .../sagemaker/model_package_group/index.md | 89 ---- .../sagemaker/model_package_groups/index.md | 65 --- .../awscc/sagemaker/model_packages/index.md | 73 ---- .../model_quality_job_definition/index.md | 84 ---- .../model_quality_job_definitions/index.md | 64 --- .../sagemaker/monitoring_schedule/index.md | 85 ---- .../sagemaker/monitoring_schedules/index.md | 62 --- .../awscc/sagemaker/pipeline/index.md | 84 ---- .../awscc/sagemaker/pipelines/index.md | 65 --- .../awscc/sagemaker/project/index.md | 88 ---- .../awscc/sagemaker/projects/index.md | 68 ---- .../providers/awscc/sagemaker/space/index.md | 83 ---- .../providers/awscc/sagemaker/spaces/index.md | 63 --- .../awscc/sagemaker/user_profile/index.md | 82 ---- .../awscc/sagemaker/user_profiles/index.md | 66 --- .../providers/awscc/scheduler/index.md | 41 -- .../awscc/scheduler/schedule/index.md | 90 ----- .../awscc/scheduler/schedule_group/index.md | 81 ---- .../awscc/scheduler/schedule_groups/index.md | 63 --- .../awscc/scheduler/schedules/index.md | 62 --- .../providers/awscc/secretsmanager/index.md | 39 -- .../awscc/secretsmanager/secret/index.md | 88 ---- .../awscc/secretsmanager/secrets/index.md | 63 --- .../securityhub/automation_rule/index.md | 93 ----- .../securityhub/automation_rules/index.md | 63 --- .../providers/awscc/securityhub/hub/index.md | 80 ---- .../providers/awscc/securityhub/hubs/index.md | 64 --- .../providers/awscc/securityhub/index.md | 43 -- .../awscc/securityhub/standard/index.md | 72 ---- .../awscc/securityhub/standards/index.md | 62 --- .../index.md | 95 ----- .../providers/awscc/servicecatalog/index.md | 42 -- .../servicecatalog/service_action/index.md | 77 ---- .../service_action_association/index.md | 65 --- .../service_action_associations/index.md | 65 --- .../servicecatalog/service_actions/index.md | 62 --- .../application/index.md | 84 ---- .../applications/index.md | 62 --- .../attribute_group/index.md | 79 ---- .../attribute_group_association/index.md | 66 --- .../attribute_group_associations/index.md | 62 --- .../attribute_groups/index.md | 61 --- .../awscc/servicecatalogappregistry/index.md | 45 --- .../resource_association/index.md | 68 ---- .../resource_associations/index.md | 65 --- .../awscc/ses/configuration_set/index.md | 83 ---- .../index.md | 71 ---- .../awscc/ses/configuration_sets/index.md | 60 --- .../providers/awscc/ses/contact_list/index.md | 73 ---- .../awscc/ses/contact_lists/index.md | 60 --- .../awscc/ses/dedicated_ip_pool/index.md | 69 ---- .../awscc/ses/dedicated_ip_pools/index.md | 62 --- .../awscc/ses/email_identities/index.md | 64 --- .../awscc/ses/email_identity/index.md | 92 ----- docs/awscc-docs/providers/awscc/ses/index.md | 49 --- .../providers/awscc/ses/template/index.md | 72 ---- .../providers/awscc/ses/templates/index.md | 64 --- .../awscc/ses/vdm_attributes/index.md | 71 ---- .../awscc/shield/drt_access/index.md | 87 ---- .../awscc/shield/drt_accesses/index.md | 62 --- .../providers/awscc/shield/index.md | 45 --- .../shield/proactive_engagement/index.md | 77 ---- .../shield/proactive_engagements/index.md | 65 --- .../awscc/shield/protection/index.md | 92 ----- .../awscc/shield/protection_group/index.md | 82 ---- .../awscc/shield/protection_groups/index.md | 61 --- .../awscc/shield/protections/index.md | 73 ---- .../providers/awscc/signer/index.md | 41 -- .../awscc/signer/profile_permission/index.md | 69 ---- .../awscc/signer/profile_permissions/index.md | 64 --- .../awscc/signer/signing_profile/index.md | 80 ---- .../awscc/signer/signing_profiles/index.md | 61 --- .../providers/awscc/simspaceweaver/index.md | 39 -- .../awscc/simspaceweaver/simulation/index.md | 80 ---- .../awscc/simspaceweaver/simulations/index.md | 63 --- docs/awscc-docs/providers/awscc/sns/index.md | 40 -- .../providers/awscc/sns/topic/index.md | 104 ----- .../awscc/sns/topic_inline_policy/index.md | 69 ---- .../providers/awscc/sns/topics/index.md | 66 --- docs/awscc-docs/providers/awscc/sqs/index.md | 40 -- .../providers/awscc/sqs/queue/index.md | 105 ----- .../awscc/sqs/queue_inline_policy/index.md | 71 ---- .../providers/awscc/sqs/queues/index.md | 64 --- .../providers/awscc/ssm/association/index.md | 104 ----- .../providers/awscc/ssm/associations/index.md | 65 --- .../providers/awscc/ssm/document/index.md | 92 ----- .../providers/awscc/ssm/documents/index.md | 65 --- docs/awscc-docs/providers/awscc/ssm/index.md | 49 --- .../providers/awscc/ssm/parameter/index.md | 84 ---- .../providers/awscc/ssm/parameters/index.md | 62 --- .../awscc/ssm/patch_baseline/index.md | 103 ----- .../awscc/ssm/patch_baselines/index.md | 69 ---- .../awscc/ssm/resource_data_sync/index.md | 83 ---- .../awscc/ssm/resource_data_syncs/index.md | 61 --- .../awscc/ssm/resource_policies/index.md | 62 --- .../awscc/ssm/resource_policy/index.md | 71 ---- .../awscc/ssmcontacts/contact/index.md | 77 ---- .../ssmcontacts/contact_channel/index.md | 77 ---- .../ssmcontacts/contact_channels/index.md | 61 --- .../awscc/ssmcontacts/contacts/index.md | 62 --- .../providers/awscc/ssmcontacts/index.md | 44 -- .../providers/awscc/ssmcontacts/plan/index.md | 75 ---- .../awscc/ssmcontacts/rotation/index.md | 87 ---- .../awscc/ssmcontacts/rotations/index.md | 66 --- .../providers/awscc/ssmincidents/index.md | 41 -- .../ssmincidents/replication_set/index.md | 79 ---- .../ssmincidents/replication_sets/index.md | 66 --- .../awscc/ssmincidents/response_plan/index.md | 91 ----- .../ssmincidents/response_plans/index.md | 67 --- .../providers/awscc/sso/assignment/index.md | 76 ---- .../providers/awscc/sso/assignments/index.md | 79 ---- docs/awscc-docs/providers/awscc/sso/index.md | 43 -- .../index.md | 71 ---- .../index.md | 62 --- .../awscc/sso/permission_set/index.md | 108 ----- .../awscc/sso/permission_sets/index.md | 73 ---- .../awscc/stepfunctions/activity/index.md | 72 ---- .../providers/awscc/stepfunctions/index.md | 44 -- .../stepfunctions/state_machine/index.md | 95 ----- .../state_machine_alias/index.md | 76 ---- .../state_machine_aliases/index.md | 61 --- .../state_machine_version/index.md | 67 --- .../state_machine_versions/index.md | 62 --- .../stepfunctions/state_machines/index.md | 64 --- .../awscc/supportapp/account_alias/index.md | 69 ---- .../awscc/supportapp/account_aliases/index.md | 61 --- .../providers/awscc/supportapp/index.md | 43 -- .../slack_channel_configuration/index.md | 81 ---- .../slack_channel_configurations/index.md | 63 --- .../slack_workspace_configuration/index.md | 69 ---- .../slack_workspace_configurations/index.md | 61 --- .../awscc/synthetics/canaries/index.md | 81 ---- .../awscc/synthetics/canary/index.md | 121 ------ .../providers/awscc/synthetics/group/index.md | 79 ---- .../awscc/synthetics/groups/index.md | 63 --- .../providers/awscc/synthetics/index.md | 41 -- .../systemsmanagersap/application/index.md | 84 ---- .../systemsmanagersap/applications/index.md | 63 --- .../awscc/systemsmanagersap/index.md | 39 -- .../awscc/timestream/database/index.md | 78 ---- .../awscc/timestream/databases/index.md | 66 --- .../providers/awscc/timestream/index.md | 43 -- .../timestream/scheduled_queries/index.md | 62 --- .../awscc/timestream/scheduled_query/index.md | 107 ----- .../providers/awscc/timestream/table/index.md | 92 ----- .../awscc/timestream/tables/index.md | 71 ---- .../awscc/transfer/agreement/index.md | 86 ---- .../awscc/transfer/agreements/index.md | 64 --- .../awscc/transfer/certificate/index.md | 95 ----- .../awscc/transfer/certificates/index.md | 61 --- .../awscc/transfer/connector/index.md | 82 ---- .../awscc/transfer/connectors/index.md | 62 --- .../providers/awscc/transfer/index.md | 47 --- .../providers/awscc/transfer/profile/index.md | 77 ---- .../awscc/transfer/profiles/index.md | 61 --- .../awscc/transfer/workflow/index.md | 76 ---- .../awscc/transfer/workflows/index.md | 61 --- .../identity_source/index.md | 91 ----- .../identity_sources/index.md | 74 ---- .../awscc/verifiedpermissions/index.md | 45 --- .../verifiedpermissions/policies/index.md | 68 ---- .../awscc/verifiedpermissions/policy/index.md | 80 ---- .../verifiedpermissions/policy_store/index.md | 85 ---- .../policy_stores/index.md | 69 ---- .../policy_template/index.md | 80 ---- .../policy_templates/index.md | 69 ---- .../providers/awscc/voiceid/domain/index.md | 84 ---- .../providers/awscc/voiceid/domains/index.md | 67 --- .../providers/awscc/voiceid/index.md | 39 -- .../access_log_subscription/index.md | 109 ----- .../access_log_subscriptions/index.md | 79 ---- .../awscc/vpclattice/auth_policy/index.md | 71 ---- .../providers/awscc/vpclattice/index.md | 55 --- .../awscc/vpclattice/listener/index.md | 88 ---- .../awscc/vpclattice/listeners/index.md | 63 --- .../awscc/vpclattice/resource_policy/index.md | 69 ---- .../providers/awscc/vpclattice/rule/index.md | 85 ---- .../providers/awscc/vpclattice/rules/index.md | 63 --- .../awscc/vpclattice/service/index.md | 91 ----- .../awscc/vpclattice/service_network/index.md | 81 ---- .../index.md | 96 ----- .../index.md | 63 --- .../service_network_vpc_association/index.md | 94 ----- .../service_network_vpc_associations/index.md | 66 --- .../vpclattice/service_networks/index.md | 64 --- .../awscc/vpclattice/services/index.md | 66 --- .../awscc/vpclattice/target_group/index.md | 104 ----- .../awscc/vpclattice/target_groups/index.md | 74 ---- .../awscc-docs/providers/awscc/wafv2/index.md | 48 --- .../providers/awscc/wafv2/ip_set/index.md | 83 ---- .../providers/awscc/wafv2/ip_sets/index.md | 66 --- .../wafv2/logging_configuration/index.md | 85 ---- .../wafv2/logging_configurations/index.md | 70 ---- .../awscc/wafv2/regex_pattern_set/index.md | 81 ---- .../awscc/wafv2/regex_pattern_sets/index.md | 66 --- .../providers/awscc/wafv2/rule_group/index.md | 93 ----- .../awscc/wafv2/rule_groups/index.md | 66 --- .../providers/awscc/wafv2/web_acl/index.md | 99 ----- .../providers/awscc/wafv2/web_acls/index.md | 66 --- .../awscc/wafv2/webacl_association/index.md | 115 ------ .../providers/awscc/wisdom/assistant/index.md | 77 ---- .../wisdom/assistant_association/index.md | 77 ---- .../wisdom/assistant_associations/index.md | 63 --- .../awscc/wisdom/assistants/index.md | 63 --- .../providers/awscc/wisdom/index.md | 43 -- .../awscc/wisdom/knowledge_base/index.md | 84 ---- .../awscc/wisdom/knowledge_bases/index.md | 71 ---- .../workspaces/connection_alias/index.md | 68 ---- .../providers/awscc/workspaces/index.md | 39 -- .../workspacesthinclient/environment/index.md | 121 ------ .../environments/index.md | 74 ---- .../awscc/workspacesthinclient/index.md | 39 -- .../workspacesweb/browser_settings/index.md | 95 ----- .../workspacesweb/identity_provider/index.md | 81 ---- .../workspacesweb/identity_providers/index.md | 63 --- .../providers/awscc/workspacesweb/index.md | 48 --- .../workspacesweb/ip_access_settings/index.md | 102 ----- .../workspacesweb/network_settings/index.md | 82 ---- .../awscc/workspacesweb/portal/index.md | 147 ------- .../awscc/workspacesweb/portals/index.md | 84 ---- .../awscc/workspacesweb/trust_store/index.md | 82 ---- .../awscc/workspacesweb/trust_stores/index.md | 66 --- .../user_access_logging_settings/index.md | 79 ---- .../workspacesweb/user_settings/index.md | 107 ----- .../providers/awscc/xray/group/index.md | 77 ---- .../providers/awscc/xray/groups/index.md | 62 --- docs/awscc-docs/providers/awscc/xray/index.md | 43 -- .../awscc/xray/resource_policies/index.md | 61 --- .../awscc/xray/resource_policy/index.md | 70 ---- .../awscc/xray/sampling_rule/index.md | 79 ---- .../awscc/xray/sampling_rules/index.md | 62 --- docs/awscc-docs/stackql-provider-registry.mdx | 20 - package.json | 2 - scripts/docgen.sh | 6 +- scripts/docgen/generate_docs.py | 9 +- scripts/docgen/provider_data.py | 8 +- sidebars.js | 1 - src/configs/providers.ts | 3 +- 4761 files changed, 203701 insertions(+), 157649 deletions(-) create mode 100644 docs/aws-docs/providers/aws/accessanalyzer/analyzer/index.md create mode 100644 docs/aws-docs/providers/aws/accessanalyzer/analyzers/index.md create mode 100644 docs/aws-docs/providers/aws/accessanalyzer/index.md create mode 100644 docs/aws-docs/providers/aws/acmpca/certificate/index.md create mode 100644 docs/aws-docs/providers/aws/acmpca/certificate_authorities/index.md create mode 100644 docs/aws-docs/providers/aws/acmpca/certificate_authority/index.md create mode 100644 docs/aws-docs/providers/aws/acmpca/certificate_authority_activation/index.md create mode 100644 docs/aws-docs/providers/aws/acmpca/certificate_authority_activations/index.md create mode 100644 docs/aws-docs/providers/aws/acmpca/certificates/index.md create mode 100644 docs/aws-docs/providers/aws/acmpca/index.md create mode 100644 docs/aws-docs/providers/aws/acmpca/permission/index.md create mode 100644 docs/aws-docs/providers/aws/acmpca/permissions/index.md create mode 100644 docs/aws-docs/providers/aws/amplify/app/index.md create mode 100644 docs/aws-docs/providers/aws/amplify/apps/index.md create mode 100644 docs/aws-docs/providers/aws/amplify/branch/index.md create mode 100644 docs/aws-docs/providers/aws/amplify/branches/index.md create mode 100644 docs/aws-docs/providers/aws/amplify/domain/index.md create mode 100644 docs/aws-docs/providers/aws/amplify/domains/index.md create mode 100644 docs/aws-docs/providers/aws/amplify/index.md create mode 100644 docs/aws-docs/providers/aws/amplifyuibuilder/component/index.md create mode 100644 docs/aws-docs/providers/aws/amplifyuibuilder/components/index.md create mode 100644 docs/aws-docs/providers/aws/amplifyuibuilder/form/index.md create mode 100644 docs/aws-docs/providers/aws/amplifyuibuilder/forms/index.md create mode 100644 docs/aws-docs/providers/aws/amplifyuibuilder/index.md create mode 100644 docs/aws-docs/providers/aws/amplifyuibuilder/theme/index.md create mode 100644 docs/aws-docs/providers/aws/amplifyuibuilder/themes/index.md create mode 100644 docs/aws-docs/providers/aws/apigateway/account/index.md create mode 100644 docs/aws-docs/providers/aws/apigateway/accounts/index.md create mode 100644 docs/aws-docs/providers/aws/apigateway/api_key/index.md create mode 100644 docs/aws-docs/providers/aws/apigateway/api_keys/index.md create mode 100644 docs/aws-docs/providers/aws/apigateway/authorizer/index.md create mode 100644 docs/aws-docs/providers/aws/apigateway/authorizers/index.md create mode 100644 docs/aws-docs/providers/aws/apigateway/base_path_mapping/index.md create mode 100644 docs/aws-docs/providers/aws/apigateway/base_path_mappings/index.md create mode 100644 docs/aws-docs/providers/aws/apigateway/client_certificate/index.md create mode 100644 docs/aws-docs/providers/aws/apigateway/client_certificates/index.md create mode 100644 docs/aws-docs/providers/aws/apigateway/deployment/index.md create mode 100644 docs/aws-docs/providers/aws/apigateway/deployments/index.md create mode 100644 docs/aws-docs/providers/aws/apigateway/documentation_part/index.md create mode 100644 docs/aws-docs/providers/aws/apigateway/documentation_parts/index.md create mode 100644 docs/aws-docs/providers/aws/apigateway/documentation_version/index.md create mode 100644 docs/aws-docs/providers/aws/apigateway/documentation_versions/index.md create mode 100644 docs/aws-docs/providers/aws/apigateway/domain_name/index.md create mode 100644 docs/aws-docs/providers/aws/apigateway/domain_names/index.md create mode 100644 docs/aws-docs/providers/aws/apigateway/index.md create mode 100644 docs/aws-docs/providers/aws/apigateway/method/index.md create mode 100644 docs/aws-docs/providers/aws/apigateway/methods/index.md create mode 100644 docs/aws-docs/providers/aws/apigateway/model/index.md create mode 100644 docs/aws-docs/providers/aws/apigateway/models/index.md create mode 100644 docs/aws-docs/providers/aws/apigateway/request_validator/index.md create mode 100644 docs/aws-docs/providers/aws/apigateway/request_validators/index.md create mode 100644 docs/aws-docs/providers/aws/apigateway/resource/index.md create mode 100644 docs/aws-docs/providers/aws/apigateway/resources/index.md create mode 100644 docs/aws-docs/providers/aws/apigateway/rest_api/index.md create mode 100644 docs/aws-docs/providers/aws/apigateway/rest_apis/index.md create mode 100644 docs/aws-docs/providers/aws/apigateway/stage/index.md create mode 100644 docs/aws-docs/providers/aws/apigateway/stages/index.md create mode 100644 docs/aws-docs/providers/aws/apigateway/usage_plan/index.md create mode 100644 docs/aws-docs/providers/aws/apigateway/usage_plan_key/index.md create mode 100644 docs/aws-docs/providers/aws/apigateway/usage_plan_keys/index.md create mode 100644 docs/aws-docs/providers/aws/apigateway/usage_plans/index.md create mode 100644 docs/aws-docs/providers/aws/apigateway/vpc_link/index.md create mode 100644 docs/aws-docs/providers/aws/apigateway/vpc_links/index.md create mode 100644 docs/aws-docs/providers/aws/apigatewayv2/api/index.md create mode 100644 docs/aws-docs/providers/aws/apigatewayv2/api_mapping/index.md create mode 100644 docs/aws-docs/providers/aws/apigatewayv2/api_mappings/index.md create mode 100644 docs/aws-docs/providers/aws/apigatewayv2/apis/index.md create mode 100644 docs/aws-docs/providers/aws/apigatewayv2/authorizer/index.md create mode 100644 docs/aws-docs/providers/aws/apigatewayv2/authorizers/index.md create mode 100644 docs/aws-docs/providers/aws/apigatewayv2/deployment/index.md create mode 100644 docs/aws-docs/providers/aws/apigatewayv2/deployments/index.md create mode 100644 docs/aws-docs/providers/aws/apigatewayv2/domain_name/index.md create mode 100644 docs/aws-docs/providers/aws/apigatewayv2/domain_names/index.md create mode 100644 docs/aws-docs/providers/aws/apigatewayv2/index.md create mode 100644 docs/aws-docs/providers/aws/apigatewayv2/integration_response/index.md create mode 100644 docs/aws-docs/providers/aws/apigatewayv2/integration_responses/index.md create mode 100644 docs/aws-docs/providers/aws/apigatewayv2/model/index.md create mode 100644 docs/aws-docs/providers/aws/apigatewayv2/models/index.md create mode 100644 docs/aws-docs/providers/aws/apigatewayv2/route/index.md create mode 100644 docs/aws-docs/providers/aws/apigatewayv2/route_response/index.md create mode 100644 docs/aws-docs/providers/aws/apigatewayv2/route_responses/index.md create mode 100644 docs/aws-docs/providers/aws/apigatewayv2/routes/index.md create mode 100644 docs/aws-docs/providers/aws/apigatewayv2/vpc_link/index.md create mode 100644 docs/aws-docs/providers/aws/apigatewayv2/vpc_links/index.md create mode 100644 docs/aws-docs/providers/aws/appconfig/application/index.md create mode 100644 docs/aws-docs/providers/aws/appconfig/applications/index.md create mode 100644 docs/aws-docs/providers/aws/appconfig/configuration_profile/index.md create mode 100644 docs/aws-docs/providers/aws/appconfig/configuration_profiles/index.md create mode 100644 docs/aws-docs/providers/aws/appconfig/environment/index.md create mode 100644 docs/aws-docs/providers/aws/appconfig/environments/index.md create mode 100644 docs/aws-docs/providers/aws/appconfig/extension/index.md create mode 100644 docs/aws-docs/providers/aws/appconfig/extension_association/index.md create mode 100644 docs/aws-docs/providers/aws/appconfig/extension_associations/index.md create mode 100644 docs/aws-docs/providers/aws/appconfig/extensions/index.md create mode 100644 docs/aws-docs/providers/aws/appconfig/hosted_configuration_version/index.md create mode 100644 docs/aws-docs/providers/aws/appconfig/hosted_configuration_versions/index.md create mode 100644 docs/aws-docs/providers/aws/appconfig/index.md create mode 100644 docs/aws-docs/providers/aws/appflow/connector/index.md create mode 100644 docs/aws-docs/providers/aws/appflow/connector_profile/index.md create mode 100644 docs/aws-docs/providers/aws/appflow/connector_profiles/index.md create mode 100644 docs/aws-docs/providers/aws/appflow/connectors/index.md create mode 100644 docs/aws-docs/providers/aws/appflow/flow/index.md create mode 100644 docs/aws-docs/providers/aws/appflow/flows/index.md create mode 100644 docs/aws-docs/providers/aws/appflow/index.md create mode 100644 docs/aws-docs/providers/aws/appintegrations/application/index.md create mode 100644 docs/aws-docs/providers/aws/appintegrations/applications/index.md create mode 100644 docs/aws-docs/providers/aws/appintegrations/data_integration/index.md create mode 100644 docs/aws-docs/providers/aws/appintegrations/data_integrations/index.md create mode 100644 docs/aws-docs/providers/aws/appintegrations/event_integration/index.md create mode 100644 docs/aws-docs/providers/aws/appintegrations/event_integrations/index.md create mode 100644 docs/aws-docs/providers/aws/appintegrations/index.md create mode 100644 docs/aws-docs/providers/aws/applicationautoscaling/index.md create mode 100644 docs/aws-docs/providers/aws/applicationautoscaling/scalable_target/index.md create mode 100644 docs/aws-docs/providers/aws/applicationautoscaling/scalable_targets/index.md create mode 100644 docs/aws-docs/providers/aws/applicationautoscaling/scaling_policies/index.md create mode 100644 docs/aws-docs/providers/aws/applicationautoscaling/scaling_policy/index.md create mode 100644 docs/aws-docs/providers/aws/applicationinsights/application/index.md create mode 100644 docs/aws-docs/providers/aws/applicationinsights/applications/index.md create mode 100644 docs/aws-docs/providers/aws/applicationinsights/index.md create mode 100644 docs/aws-docs/providers/aws/apprunner/auto_scaling_configuration/index.md create mode 100644 docs/aws-docs/providers/aws/apprunner/auto_scaling_configurations/index.md create mode 100644 docs/aws-docs/providers/aws/apprunner/index.md create mode 100644 docs/aws-docs/providers/aws/apprunner/observability_configuration/index.md create mode 100644 docs/aws-docs/providers/aws/apprunner/observability_configurations/index.md create mode 100644 docs/aws-docs/providers/aws/apprunner/service/index.md create mode 100644 docs/aws-docs/providers/aws/apprunner/services/index.md create mode 100644 docs/aws-docs/providers/aws/apprunner/vpc_connector/index.md create mode 100644 docs/aws-docs/providers/aws/apprunner/vpc_connectors/index.md create mode 100644 docs/aws-docs/providers/aws/apprunner/vpc_ingress_connection/index.md create mode 100644 docs/aws-docs/providers/aws/apprunner/vpc_ingress_connections/index.md create mode 100644 docs/aws-docs/providers/aws/appstream/app_block/index.md create mode 100644 docs/aws-docs/providers/aws/appstream/app_block_builder/index.md create mode 100644 docs/aws-docs/providers/aws/appstream/app_block_builders/index.md create mode 100644 docs/aws-docs/providers/aws/appstream/app_blocks/index.md create mode 100644 docs/aws-docs/providers/aws/appstream/application/index.md create mode 100644 docs/aws-docs/providers/aws/appstream/application_entitlement_association/index.md create mode 100644 docs/aws-docs/providers/aws/appstream/application_entitlement_associations/index.md create mode 100644 docs/aws-docs/providers/aws/appstream/application_fleet_association/index.md create mode 100644 docs/aws-docs/providers/aws/appstream/application_fleet_associations/index.md create mode 100644 docs/aws-docs/providers/aws/appstream/applications/index.md create mode 100644 docs/aws-docs/providers/aws/appstream/directory_config/index.md create mode 100644 docs/aws-docs/providers/aws/appstream/directory_configs/index.md create mode 100644 docs/aws-docs/providers/aws/appstream/entitlement/index.md create mode 100644 docs/aws-docs/providers/aws/appstream/entitlements/index.md create mode 100644 docs/aws-docs/providers/aws/appstream/image_builder/index.md create mode 100644 docs/aws-docs/providers/aws/appstream/image_builders/index.md create mode 100644 docs/aws-docs/providers/aws/appstream/index.md create mode 100644 docs/aws-docs/providers/aws/appsync/domain_name/index.md create mode 100644 docs/aws-docs/providers/aws/appsync/domain_name_api_association/index.md create mode 100644 docs/aws-docs/providers/aws/appsync/domain_name_api_associations/index.md create mode 100644 docs/aws-docs/providers/aws/appsync/domain_names/index.md create mode 100644 docs/aws-docs/providers/aws/appsync/function_configuration/index.md create mode 100644 docs/aws-docs/providers/aws/appsync/function_configurations/index.md create mode 100644 docs/aws-docs/providers/aws/appsync/index.md create mode 100644 docs/aws-docs/providers/aws/appsync/resolver/index.md create mode 100644 docs/aws-docs/providers/aws/appsync/resolvers/index.md create mode 100644 docs/aws-docs/providers/aws/appsync/source_api_association/index.md create mode 100644 docs/aws-docs/providers/aws/appsync/source_api_associations/index.md create mode 100644 docs/aws-docs/providers/aws/aps/index.md create mode 100644 docs/aws-docs/providers/aws/aps/rule_groups_namespace/index.md create mode 100644 docs/aws-docs/providers/aws/aps/rule_groups_namespaces/index.md create mode 100644 docs/aws-docs/providers/aws/aps/scraper/index.md create mode 100644 docs/aws-docs/providers/aws/aps/scrapers/index.md create mode 100644 docs/aws-docs/providers/aws/aps/workspace/index.md create mode 100644 docs/aws-docs/providers/aws/aps/workspaces/index.md create mode 100644 docs/aws-docs/providers/aws/arczonalshift/index.md create mode 100644 docs/aws-docs/providers/aws/arczonalshift/zonal_autoshift_configuration/index.md create mode 100644 docs/aws-docs/providers/aws/arczonalshift/zonal_autoshift_configurations/index.md create mode 100644 docs/aws-docs/providers/aws/athena/capacity_reservation/index.md create mode 100644 docs/aws-docs/providers/aws/athena/capacity_reservations/index.md create mode 100644 docs/aws-docs/providers/aws/athena/data_catalog/index.md create mode 100644 docs/aws-docs/providers/aws/athena/data_catalogs/index.md create mode 100644 docs/aws-docs/providers/aws/athena/index.md create mode 100644 docs/aws-docs/providers/aws/athena/named_queries/index.md create mode 100644 docs/aws-docs/providers/aws/athena/named_query/index.md create mode 100644 docs/aws-docs/providers/aws/athena/prepared_statement/index.md create mode 100644 docs/aws-docs/providers/aws/athena/prepared_statements/index.md create mode 100644 docs/aws-docs/providers/aws/athena/work_group/index.md create mode 100644 docs/aws-docs/providers/aws/athena/work_groups/index.md create mode 100644 docs/aws-docs/providers/aws/auditmanager/assessment/index.md create mode 100644 docs/aws-docs/providers/aws/auditmanager/assessments/index.md create mode 100644 docs/aws-docs/providers/aws/auditmanager/index.md create mode 100644 docs/aws-docs/providers/aws/autoscaling/auto_scaling_group/index.md create mode 100644 docs/aws-docs/providers/aws/autoscaling/auto_scaling_groups/index.md create mode 100644 docs/aws-docs/providers/aws/autoscaling/index.md create mode 100644 docs/aws-docs/providers/aws/autoscaling/launch_configuration/index.md create mode 100644 docs/aws-docs/providers/aws/autoscaling/launch_configurations/index.md create mode 100644 docs/aws-docs/providers/aws/autoscaling/lifecycle_hook/index.md create mode 100644 docs/aws-docs/providers/aws/autoscaling/lifecycle_hooks/index.md create mode 100644 docs/aws-docs/providers/aws/autoscaling/scaling_policies/index.md create mode 100644 docs/aws-docs/providers/aws/autoscaling/scaling_policy/index.md create mode 100644 docs/aws-docs/providers/aws/autoscaling/scheduled_action/index.md create mode 100644 docs/aws-docs/providers/aws/autoscaling/scheduled_actions/index.md create mode 100644 docs/aws-docs/providers/aws/autoscaling/warm_pool/index.md create mode 100644 docs/aws-docs/providers/aws/autoscaling/warm_pools/index.md create mode 100644 docs/aws-docs/providers/aws/b2bi/capabilities/index.md create mode 100644 docs/aws-docs/providers/aws/b2bi/capability/index.md create mode 100644 docs/aws-docs/providers/aws/b2bi/index.md create mode 100644 docs/aws-docs/providers/aws/b2bi/partnership/index.md create mode 100644 docs/aws-docs/providers/aws/b2bi/partnerships/index.md create mode 100644 docs/aws-docs/providers/aws/b2bi/profile/index.md create mode 100644 docs/aws-docs/providers/aws/b2bi/profiles/index.md create mode 100644 docs/aws-docs/providers/aws/b2bi/transformer/index.md create mode 100644 docs/aws-docs/providers/aws/b2bi/transformers/index.md create mode 100644 docs/aws-docs/providers/aws/backup/backup_plan/index.md create mode 100644 docs/aws-docs/providers/aws/backup/backup_plans/index.md create mode 100644 docs/aws-docs/providers/aws/backup/backup_selection/index.md create mode 100644 docs/aws-docs/providers/aws/backup/backup_selections/index.md create mode 100644 docs/aws-docs/providers/aws/backup/backup_vault/index.md create mode 100644 docs/aws-docs/providers/aws/backup/backup_vaults/index.md create mode 100644 docs/aws-docs/providers/aws/backup/framework/index.md create mode 100644 docs/aws-docs/providers/aws/backup/frameworks/index.md create mode 100644 docs/aws-docs/providers/aws/backup/index.md create mode 100644 docs/aws-docs/providers/aws/backup/report_plan/index.md create mode 100644 docs/aws-docs/providers/aws/backup/report_plans/index.md create mode 100644 docs/aws-docs/providers/aws/backup/restore_testing_plan/index.md create mode 100644 docs/aws-docs/providers/aws/backup/restore_testing_plans/index.md create mode 100644 docs/aws-docs/providers/aws/backup/restore_testing_selection/index.md create mode 100644 docs/aws-docs/providers/aws/backup/restore_testing_selections/index.md create mode 100644 docs/aws-docs/providers/aws/backupgateway/hypervisor/index.md create mode 100644 docs/aws-docs/providers/aws/backupgateway/hypervisors/index.md create mode 100644 docs/aws-docs/providers/aws/backupgateway/index.md create mode 100644 docs/aws-docs/providers/aws/batch/compute_environment/index.md create mode 100644 docs/aws-docs/providers/aws/batch/compute_environments/index.md create mode 100644 docs/aws-docs/providers/aws/batch/index.md create mode 100644 docs/aws-docs/providers/aws/batch/job_queue/index.md create mode 100644 docs/aws-docs/providers/aws/batch/job_queues/index.md create mode 100644 docs/aws-docs/providers/aws/batch/scheduling_policies/index.md create mode 100644 docs/aws-docs/providers/aws/batch/scheduling_policy/index.md create mode 100644 docs/aws-docs/providers/aws/bcmdataexports/export/index.md create mode 100644 docs/aws-docs/providers/aws/bcmdataexports/exports/index.md create mode 100644 docs/aws-docs/providers/aws/bcmdataexports/index.md create mode 100644 docs/aws-docs/providers/aws/bedrock/agent/index.md create mode 100644 docs/aws-docs/providers/aws/bedrock/agent_alias/index.md create mode 100644 docs/aws-docs/providers/aws/bedrock/agent_aliases/index.md create mode 100644 docs/aws-docs/providers/aws/bedrock/agents/index.md create mode 100644 docs/aws-docs/providers/aws/bedrock/data_source/index.md create mode 100644 docs/aws-docs/providers/aws/bedrock/data_sources/index.md create mode 100644 docs/aws-docs/providers/aws/bedrock/index.md create mode 100644 docs/aws-docs/providers/aws/bedrock/knowledge_base/index.md create mode 100644 docs/aws-docs/providers/aws/bedrock/knowledge_bases/index.md create mode 100644 docs/aws-docs/providers/aws/billingconductor/billing_group/index.md create mode 100644 docs/aws-docs/providers/aws/billingconductor/billing_groups/index.md create mode 100644 docs/aws-docs/providers/aws/billingconductor/custom_line_item/index.md create mode 100644 docs/aws-docs/providers/aws/billingconductor/custom_line_items/index.md create mode 100644 docs/aws-docs/providers/aws/billingconductor/index.md create mode 100644 docs/aws-docs/providers/aws/billingconductor/pricing_plan/index.md create mode 100644 docs/aws-docs/providers/aws/billingconductor/pricing_plans/index.md create mode 100644 docs/aws-docs/providers/aws/billingconductor/pricing_rule/index.md create mode 100644 docs/aws-docs/providers/aws/billingconductor/pricing_rules/index.md create mode 100644 docs/aws-docs/providers/aws/budgets/budgets_action/index.md create mode 100644 docs/aws-docs/providers/aws/budgets/budgets_actions/index.md create mode 100644 docs/aws-docs/providers/aws/budgets/index.md create mode 100644 docs/aws-docs/providers/aws/cassandra/index.md create mode 100644 docs/aws-docs/providers/aws/cassandra/keyspace/index.md create mode 100644 docs/aws-docs/providers/aws/cassandra/keyspaces/index.md create mode 100644 docs/aws-docs/providers/aws/cassandra/table/index.md create mode 100644 docs/aws-docs/providers/aws/cassandra/tables/index.md create mode 100644 docs/aws-docs/providers/aws/ce/anomaly_monitor/index.md create mode 100644 docs/aws-docs/providers/aws/ce/anomaly_monitors/index.md create mode 100644 docs/aws-docs/providers/aws/ce/anomaly_subscription/index.md create mode 100644 docs/aws-docs/providers/aws/ce/anomaly_subscriptions/index.md create mode 100644 docs/aws-docs/providers/aws/ce/cost_categories/index.md create mode 100644 docs/aws-docs/providers/aws/ce/cost_category/index.md create mode 100644 docs/aws-docs/providers/aws/ce/index.md create mode 100644 docs/aws-docs/providers/aws/certificatemanager/account/index.md create mode 100644 docs/aws-docs/providers/aws/certificatemanager/accounts/index.md create mode 100644 docs/aws-docs/providers/aws/certificatemanager/index.md create mode 100644 docs/aws-docs/providers/aws/chatbot/index.md create mode 100644 docs/aws-docs/providers/aws/chatbot/microsoft_teams_channel_configuration/index.md create mode 100644 docs/aws-docs/providers/aws/chatbot/microsoft_teams_channel_configurations/index.md create mode 100644 docs/aws-docs/providers/aws/chatbot/slack_channel_configuration/index.md create mode 100644 docs/aws-docs/providers/aws/chatbot/slack_channel_configurations/index.md create mode 100644 docs/aws-docs/providers/aws/cleanrooms/analysis_template/index.md create mode 100644 docs/aws-docs/providers/aws/cleanrooms/analysis_templates/index.md create mode 100644 docs/aws-docs/providers/aws/cleanrooms/collaboration/index.md create mode 100644 docs/aws-docs/providers/aws/cleanrooms/collaborations/index.md create mode 100644 docs/aws-docs/providers/aws/cleanrooms/configured_table/index.md create mode 100644 docs/aws-docs/providers/aws/cleanrooms/configured_table_association/index.md create mode 100644 docs/aws-docs/providers/aws/cleanrooms/configured_table_associations/index.md create mode 100644 docs/aws-docs/providers/aws/cleanrooms/configured_tables/index.md create mode 100644 docs/aws-docs/providers/aws/cleanrooms/index.md create mode 100644 docs/aws-docs/providers/aws/cleanrooms/membership/index.md create mode 100644 docs/aws-docs/providers/aws/cleanrooms/memberships/index.md create mode 100644 docs/aws-docs/providers/aws/cleanrooms/privacy_budget_template/index.md create mode 100644 docs/aws-docs/providers/aws/cleanrooms/privacy_budget_templates/index.md create mode 100644 docs/aws-docs/providers/aws/cleanroomsml/index.md create mode 100644 docs/aws-docs/providers/aws/cleanroomsml/training_dataset/index.md create mode 100644 docs/aws-docs/providers/aws/cleanroomsml/training_datasets/index.md create mode 100644 docs/aws-docs/providers/aws/cloudformation/hook_default_version/index.md create mode 100644 docs/aws-docs/providers/aws/cloudformation/hook_default_versions/index.md create mode 100644 docs/aws-docs/providers/aws/cloudformation/hook_type_config/index.md create mode 100644 docs/aws-docs/providers/aws/cloudformation/hook_type_configs/index.md create mode 100644 docs/aws-docs/providers/aws/cloudformation/hook_version/index.md create mode 100644 docs/aws-docs/providers/aws/cloudformation/hook_versions/index.md create mode 100644 docs/aws-docs/providers/aws/cloudformation/index.md create mode 100644 docs/aws-docs/providers/aws/cloudformation/module_default_version/index.md create mode 100644 docs/aws-docs/providers/aws/cloudformation/module_default_versions/index.md create mode 100644 docs/aws-docs/providers/aws/cloudformation/module_version/index.md create mode 100644 docs/aws-docs/providers/aws/cloudformation/module_versions/index.md create mode 100644 docs/aws-docs/providers/aws/cloudformation/public_type_version/index.md create mode 100644 docs/aws-docs/providers/aws/cloudformation/public_type_versions/index.md create mode 100644 docs/aws-docs/providers/aws/cloudformation/publisher/index.md create mode 100644 docs/aws-docs/providers/aws/cloudformation/publishers/index.md create mode 100644 docs/aws-docs/providers/aws/cloudformation/resource_default_version/index.md create mode 100644 docs/aws-docs/providers/aws/cloudformation/resource_default_versions/index.md create mode 100644 docs/aws-docs/providers/aws/cloudformation/resource_version/index.md create mode 100644 docs/aws-docs/providers/aws/cloudformation/resource_versions/index.md create mode 100644 docs/aws-docs/providers/aws/cloudformation/stack/index.md create mode 100644 docs/aws-docs/providers/aws/cloudformation/stack_set/index.md create mode 100644 docs/aws-docs/providers/aws/cloudformation/stack_sets/index.md create mode 100644 docs/aws-docs/providers/aws/cloudformation/stacks/index.md create mode 100644 docs/aws-docs/providers/aws/cloudformation/type_activation/index.md create mode 100644 docs/aws-docs/providers/aws/cloudformation/type_activations/index.md create mode 100644 docs/aws-docs/providers/aws/cloudfront/cache_policies/index.md create mode 100644 docs/aws-docs/providers/aws/cloudfront/cache_policy/index.md create mode 100644 docs/aws-docs/providers/aws/cloudfront/cloud_front_origin_access_identities/index.md create mode 100644 docs/aws-docs/providers/aws/cloudfront/cloud_front_origin_access_identity/index.md create mode 100644 docs/aws-docs/providers/aws/cloudfront/continuous_deployment_policies/index.md create mode 100644 docs/aws-docs/providers/aws/cloudfront/continuous_deployment_policy/index.md create mode 100644 docs/aws-docs/providers/aws/cloudfront/distribution/index.md create mode 100644 docs/aws-docs/providers/aws/cloudfront/distributions/index.md create mode 100644 docs/aws-docs/providers/aws/cloudfront/function/index.md create mode 100644 docs/aws-docs/providers/aws/cloudfront/functions/index.md create mode 100644 docs/aws-docs/providers/aws/cloudfront/index.md create mode 100644 docs/aws-docs/providers/aws/cloudfront/key_group/index.md create mode 100644 docs/aws-docs/providers/aws/cloudfront/key_groups/index.md create mode 100644 docs/aws-docs/providers/aws/cloudfront/key_value_store/index.md create mode 100644 docs/aws-docs/providers/aws/cloudfront/key_value_stores/index.md create mode 100644 docs/aws-docs/providers/aws/cloudfront/monitoring_subscription/index.md create mode 100644 docs/aws-docs/providers/aws/cloudfront/monitoring_subscriptions/index.md create mode 100644 docs/aws-docs/providers/aws/cloudfront/origin_access_control/index.md create mode 100644 docs/aws-docs/providers/aws/cloudfront/origin_access_controls/index.md create mode 100644 docs/aws-docs/providers/aws/cloudfront/origin_request_policies/index.md create mode 100644 docs/aws-docs/providers/aws/cloudfront/origin_request_policy/index.md create mode 100644 docs/aws-docs/providers/aws/cloudfront/public_key/index.md create mode 100644 docs/aws-docs/providers/aws/cloudfront/public_keys/index.md create mode 100644 docs/aws-docs/providers/aws/cloudfront/realtime_log_config/index.md create mode 100644 docs/aws-docs/providers/aws/cloudfront/realtime_log_configs/index.md create mode 100644 docs/aws-docs/providers/aws/cloudfront/response_headers_policies/index.md create mode 100644 docs/aws-docs/providers/aws/cloudfront/response_headers_policy/index.md create mode 100644 docs/aws-docs/providers/aws/cloudhsm/backups/index.md create mode 100644 docs/aws-docs/providers/aws/cloudhsm/clusters/index.md create mode 100644 docs/aws-docs/providers/aws/cloudhsm/hsm/index.md create mode 100644 docs/aws-docs/providers/aws/cloudhsm/index.md create mode 100644 docs/aws-docs/providers/aws/cloudhsm/tags/index.md create mode 100644 docs/aws-docs/providers/aws/cloudtrail/channel/index.md create mode 100644 docs/aws-docs/providers/aws/cloudtrail/channels/index.md create mode 100644 docs/aws-docs/providers/aws/cloudtrail/event_data_store/index.md create mode 100644 docs/aws-docs/providers/aws/cloudtrail/event_data_stores/index.md create mode 100644 docs/aws-docs/providers/aws/cloudtrail/index.md create mode 100644 docs/aws-docs/providers/aws/cloudtrail/resource_policies/index.md create mode 100644 docs/aws-docs/providers/aws/cloudtrail/resource_policy/index.md create mode 100644 docs/aws-docs/providers/aws/cloudtrail/trail/index.md create mode 100644 docs/aws-docs/providers/aws/cloudtrail/trails/index.md create mode 100644 docs/aws-docs/providers/aws/cloudwatch/alarm/index.md create mode 100644 docs/aws-docs/providers/aws/cloudwatch/alarms/index.md create mode 100644 docs/aws-docs/providers/aws/cloudwatch/composite_alarm/index.md create mode 100644 docs/aws-docs/providers/aws/cloudwatch/composite_alarms/index.md create mode 100644 docs/aws-docs/providers/aws/cloudwatch/index.md create mode 100644 docs/aws-docs/providers/aws/cloudwatch/metric_stream/index.md create mode 100644 docs/aws-docs/providers/aws/cloudwatch/metric_streams/index.md create mode 100644 docs/aws-docs/providers/aws/cloudwatch_api/index.md create mode 100644 docs/aws-docs/providers/aws/cloudwatch_api/log_events/index.md create mode 100644 docs/aws-docs/providers/aws/codeartifact/domain/index.md create mode 100644 docs/aws-docs/providers/aws/codeartifact/domains/index.md create mode 100644 docs/aws-docs/providers/aws/codeartifact/index.md create mode 100644 docs/aws-docs/providers/aws/codeartifact/package_group/index.md create mode 100644 docs/aws-docs/providers/aws/codeartifact/package_groups/index.md create mode 100644 docs/aws-docs/providers/aws/codeartifact/repositories/index.md create mode 100644 docs/aws-docs/providers/aws/codeartifact/repository/index.md create mode 100644 docs/aws-docs/providers/aws/codebuild/fleet/index.md create mode 100644 docs/aws-docs/providers/aws/codebuild/fleets/index.md create mode 100644 docs/aws-docs/providers/aws/codebuild/index.md create mode 100644 docs/aws-docs/providers/aws/codeconnections/connection/index.md create mode 100644 docs/aws-docs/providers/aws/codeconnections/connections/index.md create mode 100644 docs/aws-docs/providers/aws/codeconnections/index.md create mode 100644 docs/aws-docs/providers/aws/codedeploy/application/index.md create mode 100644 docs/aws-docs/providers/aws/codedeploy/applications/index.md create mode 100644 docs/aws-docs/providers/aws/codedeploy/deployment_config/index.md create mode 100644 docs/aws-docs/providers/aws/codedeploy/deployment_configs/index.md create mode 100644 docs/aws-docs/providers/aws/codedeploy/index.md create mode 100644 docs/aws-docs/providers/aws/codeguruprofiler/index.md create mode 100644 docs/aws-docs/providers/aws/codeguruprofiler/profiling_group/index.md create mode 100644 docs/aws-docs/providers/aws/codeguruprofiler/profiling_groups/index.md create mode 100644 docs/aws-docs/providers/aws/codegurureviewer/index.md create mode 100644 docs/aws-docs/providers/aws/codegurureviewer/repository_association/index.md create mode 100644 docs/aws-docs/providers/aws/codegurureviewer/repository_associations/index.md create mode 100644 docs/aws-docs/providers/aws/codepipeline/custom_action_type/index.md create mode 100644 docs/aws-docs/providers/aws/codepipeline/custom_action_types/index.md create mode 100644 docs/aws-docs/providers/aws/codepipeline/index.md create mode 100644 docs/aws-docs/providers/aws/codestarconnections/connection/index.md create mode 100644 docs/aws-docs/providers/aws/codestarconnections/connections/index.md create mode 100644 docs/aws-docs/providers/aws/codestarconnections/index.md create mode 100644 docs/aws-docs/providers/aws/codestarconnections/repository_link/index.md create mode 100644 docs/aws-docs/providers/aws/codestarconnections/repository_links/index.md create mode 100644 docs/aws-docs/providers/aws/codestarconnections/sync_configuration/index.md create mode 100644 docs/aws-docs/providers/aws/codestarconnections/sync_configurations/index.md create mode 100644 docs/aws-docs/providers/aws/codestarnotifications/index.md create mode 100644 docs/aws-docs/providers/aws/codestarnotifications/notification_rule/index.md create mode 100644 docs/aws-docs/providers/aws/codestarnotifications/notification_rules/index.md create mode 100644 docs/aws-docs/providers/aws/cognito/identity_pool/index.md create mode 100644 docs/aws-docs/providers/aws/cognito/identity_pool_principal_tag/index.md create mode 100644 docs/aws-docs/providers/aws/cognito/identity_pool_principal_tags/index.md create mode 100644 docs/aws-docs/providers/aws/cognito/identity_pool_role_attachment/index.md create mode 100644 docs/aws-docs/providers/aws/cognito/identity_pool_role_attachments/index.md create mode 100644 docs/aws-docs/providers/aws/cognito/identity_pools/index.md create mode 100644 docs/aws-docs/providers/aws/cognito/index.md create mode 100644 docs/aws-docs/providers/aws/cognito/log_delivery_configuration/index.md create mode 100644 docs/aws-docs/providers/aws/cognito/log_delivery_configurations/index.md create mode 100644 docs/aws-docs/providers/aws/cognito/user_pool/index.md create mode 100644 docs/aws-docs/providers/aws/cognito/user_pool_client/index.md create mode 100644 docs/aws-docs/providers/aws/cognito/user_pool_clients/index.md create mode 100644 docs/aws-docs/providers/aws/cognito/user_pool_group/index.md create mode 100644 docs/aws-docs/providers/aws/cognito/user_pool_groups/index.md create mode 100644 docs/aws-docs/providers/aws/cognito/user_pool_risk_configuration_attachment/index.md create mode 100644 docs/aws-docs/providers/aws/cognito/user_pool_risk_configuration_attachments/index.md create mode 100644 docs/aws-docs/providers/aws/cognito/user_pool_user/index.md create mode 100644 docs/aws-docs/providers/aws/cognito/user_pool_user_to_group_attachment/index.md create mode 100644 docs/aws-docs/providers/aws/cognito/user_pool_user_to_group_attachments/index.md create mode 100644 docs/aws-docs/providers/aws/cognito/user_pool_users/index.md create mode 100644 docs/aws-docs/providers/aws/cognito/user_pools/index.md create mode 100644 docs/aws-docs/providers/aws/comprehend/document_classifier/index.md create mode 100644 docs/aws-docs/providers/aws/comprehend/document_classifiers/index.md create mode 100644 docs/aws-docs/providers/aws/comprehend/flywheel/index.md create mode 100644 docs/aws-docs/providers/aws/comprehend/flywheels/index.md create mode 100644 docs/aws-docs/providers/aws/comprehend/index.md create mode 100644 docs/aws-docs/providers/aws/config/aggregation_authorization/index.md create mode 100644 docs/aws-docs/providers/aws/config/aggregation_authorizations/index.md create mode 100644 docs/aws-docs/providers/aws/config/config_rule/index.md create mode 100644 docs/aws-docs/providers/aws/config/config_rules/index.md create mode 100644 docs/aws-docs/providers/aws/config/configuration_aggregator/index.md create mode 100644 docs/aws-docs/providers/aws/config/configuration_aggregators/index.md create mode 100644 docs/aws-docs/providers/aws/config/conformance_pack/index.md create mode 100644 docs/aws-docs/providers/aws/config/conformance_packs/index.md create mode 100644 docs/aws-docs/providers/aws/config/index.md create mode 100644 docs/aws-docs/providers/aws/config/organization_conformance_pack/index.md create mode 100644 docs/aws-docs/providers/aws/config/organization_conformance_packs/index.md create mode 100644 docs/aws-docs/providers/aws/config/stored_queries/index.md create mode 100644 docs/aws-docs/providers/aws/config/stored_query/index.md create mode 100644 docs/aws-docs/providers/aws/connect/approved_origin/index.md create mode 100644 docs/aws-docs/providers/aws/connect/approved_origins/index.md create mode 100644 docs/aws-docs/providers/aws/connect/contact_flow/index.md create mode 100644 docs/aws-docs/providers/aws/connect/contact_flow_module/index.md create mode 100644 docs/aws-docs/providers/aws/connect/contact_flow_modules/index.md create mode 100644 docs/aws-docs/providers/aws/connect/contact_flows/index.md create mode 100644 docs/aws-docs/providers/aws/connect/evaluation_form/index.md create mode 100644 docs/aws-docs/providers/aws/connect/evaluation_forms/index.md create mode 100644 docs/aws-docs/providers/aws/connect/hours_of_operation/index.md create mode 100644 docs/aws-docs/providers/aws/connect/hours_of_operations/index.md create mode 100644 docs/aws-docs/providers/aws/connect/index.md create mode 100644 docs/aws-docs/providers/aws/connect/instance/index.md create mode 100644 docs/aws-docs/providers/aws/connect/instance_storage_config/index.md create mode 100644 docs/aws-docs/providers/aws/connect/instance_storage_configs/index.md create mode 100644 docs/aws-docs/providers/aws/connect/instances/index.md create mode 100644 docs/aws-docs/providers/aws/connect/integration_association/index.md create mode 100644 docs/aws-docs/providers/aws/connect/integration_associations/index.md create mode 100644 docs/aws-docs/providers/aws/connect/predefined_attribute/index.md create mode 100644 docs/aws-docs/providers/aws/connect/predefined_attributes/index.md create mode 100644 docs/aws-docs/providers/aws/connect/prompt/index.md create mode 100644 docs/aws-docs/providers/aws/connect/prompts/index.md create mode 100644 docs/aws-docs/providers/aws/connect/queue/index.md create mode 100644 docs/aws-docs/providers/aws/connect/queues/index.md create mode 100644 docs/aws-docs/providers/aws/connect/quick_connect/index.md create mode 100644 docs/aws-docs/providers/aws/connect/quick_connects/index.md create mode 100644 docs/aws-docs/providers/aws/connect/routing_profile/index.md create mode 100644 docs/aws-docs/providers/aws/connect/routing_profiles/index.md create mode 100644 docs/aws-docs/providers/aws/connect/rule/index.md create mode 100644 docs/aws-docs/providers/aws/connect/rules/index.md create mode 100644 docs/aws-docs/providers/aws/connect/security_key/index.md create mode 100644 docs/aws-docs/providers/aws/connect/security_keys/index.md create mode 100644 docs/aws-docs/providers/aws/connect/security_profile/index.md create mode 100644 docs/aws-docs/providers/aws/connect/security_profiles/index.md create mode 100644 docs/aws-docs/providers/aws/connect/task_template/index.md create mode 100644 docs/aws-docs/providers/aws/connect/task_templates/index.md create mode 100644 docs/aws-docs/providers/aws/connect/traffic_distribution_group/index.md create mode 100644 docs/aws-docs/providers/aws/connect/traffic_distribution_groups/index.md create mode 100644 docs/aws-docs/providers/aws/connect/user/index.md create mode 100644 docs/aws-docs/providers/aws/connect/user_hierarchy_group/index.md create mode 100644 docs/aws-docs/providers/aws/connect/user_hierarchy_groups/index.md create mode 100644 docs/aws-docs/providers/aws/connect/users/index.md create mode 100644 docs/aws-docs/providers/aws/connect/view/index.md create mode 100644 docs/aws-docs/providers/aws/connect/view_version/index.md create mode 100644 docs/aws-docs/providers/aws/connect/view_versions/index.md create mode 100644 docs/aws-docs/providers/aws/connect/views/index.md create mode 100644 docs/aws-docs/providers/aws/connectcampaigns/campaign/index.md create mode 100644 docs/aws-docs/providers/aws/connectcampaigns/campaigns/index.md create mode 100644 docs/aws-docs/providers/aws/connectcampaigns/index.md create mode 100644 docs/aws-docs/providers/aws/controltower/enabled_baseline/index.md create mode 100644 docs/aws-docs/providers/aws/controltower/enabled_baselines/index.md create mode 100644 docs/aws-docs/providers/aws/controltower/enabled_control/index.md create mode 100644 docs/aws-docs/providers/aws/controltower/enabled_controls/index.md create mode 100644 docs/aws-docs/providers/aws/controltower/index.md create mode 100644 docs/aws-docs/providers/aws/controltower/landing_zone/index.md create mode 100644 docs/aws-docs/providers/aws/controltower/landing_zones/index.md create mode 100644 docs/aws-docs/providers/aws/cur/index.md create mode 100644 docs/aws-docs/providers/aws/cur/report_definition/index.md create mode 100644 docs/aws-docs/providers/aws/cur/report_definitions/index.md create mode 100644 docs/aws-docs/providers/aws/customerprofiles/calculated_attribute_definition/index.md create mode 100644 docs/aws-docs/providers/aws/customerprofiles/calculated_attribute_definitions/index.md create mode 100644 docs/aws-docs/providers/aws/customerprofiles/domain/index.md create mode 100644 docs/aws-docs/providers/aws/customerprofiles/domains/index.md create mode 100644 docs/aws-docs/providers/aws/customerprofiles/event_stream/index.md create mode 100644 docs/aws-docs/providers/aws/customerprofiles/event_streams/index.md create mode 100644 docs/aws-docs/providers/aws/customerprofiles/index.md create mode 100644 docs/aws-docs/providers/aws/customerprofiles/integration/index.md create mode 100644 docs/aws-docs/providers/aws/customerprofiles/integrations/index.md create mode 100644 docs/aws-docs/providers/aws/customerprofiles/object_type/index.md create mode 100644 docs/aws-docs/providers/aws/customerprofiles/object_types/index.md create mode 100644 docs/aws-docs/providers/aws/databrew/dataset/index.md create mode 100644 docs/aws-docs/providers/aws/databrew/datasets/index.md create mode 100644 docs/aws-docs/providers/aws/databrew/index.md create mode 100644 docs/aws-docs/providers/aws/databrew/job/index.md create mode 100644 docs/aws-docs/providers/aws/databrew/jobs/index.md create mode 100644 docs/aws-docs/providers/aws/databrew/project/index.md create mode 100644 docs/aws-docs/providers/aws/databrew/projects/index.md create mode 100644 docs/aws-docs/providers/aws/databrew/recipe/index.md create mode 100644 docs/aws-docs/providers/aws/databrew/recipes/index.md create mode 100644 docs/aws-docs/providers/aws/databrew/ruleset/index.md create mode 100644 docs/aws-docs/providers/aws/databrew/rulesets/index.md create mode 100644 docs/aws-docs/providers/aws/databrew/schedule/index.md create mode 100644 docs/aws-docs/providers/aws/databrew/schedules/index.md create mode 100644 docs/aws-docs/providers/aws/datapipeline/index.md create mode 100644 docs/aws-docs/providers/aws/datapipeline/pipeline/index.md create mode 100644 docs/aws-docs/providers/aws/datapipeline/pipelines/index.md create mode 100644 docs/aws-docs/providers/aws/datasync/agent/index.md create mode 100644 docs/aws-docs/providers/aws/datasync/agents/index.md create mode 100644 docs/aws-docs/providers/aws/datasync/index.md create mode 100644 docs/aws-docs/providers/aws/datasync/location_azure_blob/index.md create mode 100644 docs/aws-docs/providers/aws/datasync/location_azure_blobs/index.md create mode 100644 docs/aws-docs/providers/aws/datasync/location_efs/index.md create mode 100644 docs/aws-docs/providers/aws/datasync/location_hdfs/index.md create mode 100644 docs/aws-docs/providers/aws/datasync/location_nfs/index.md create mode 100644 docs/aws-docs/providers/aws/datasync/location_object_storage/index.md create mode 100644 docs/aws-docs/providers/aws/datasync/location_object_storages/index.md create mode 100644 docs/aws-docs/providers/aws/datasync/location_s3/index.md create mode 100644 docs/aws-docs/providers/aws/datasync/location_s3s/index.md create mode 100644 docs/aws-docs/providers/aws/datasync/location_smb/index.md create mode 100644 docs/aws-docs/providers/aws/datasync/location_smbs/index.md create mode 100644 docs/aws-docs/providers/aws/datasync/locationf_sx_lustre/index.md create mode 100644 docs/aws-docs/providers/aws/datasync/locationf_sx_lustres/index.md create mode 100644 docs/aws-docs/providers/aws/datasync/locationf_sx_ontap/index.md create mode 100644 docs/aws-docs/providers/aws/datasync/locationf_sx_ontaps/index.md create mode 100644 docs/aws-docs/providers/aws/datasync/locationf_sx_open_zfs/index.md create mode 100644 docs/aws-docs/providers/aws/datasync/locationf_sx_windows/index.md create mode 100644 docs/aws-docs/providers/aws/datasync/storage_system/index.md create mode 100644 docs/aws-docs/providers/aws/datasync/storage_systems/index.md create mode 100644 docs/aws-docs/providers/aws/datasync/task/index.md create mode 100644 docs/aws-docs/providers/aws/datasync/tasks/index.md create mode 100644 docs/aws-docs/providers/aws/datazone/data_source/index.md create mode 100644 docs/aws-docs/providers/aws/datazone/data_sources/index.md create mode 100644 docs/aws-docs/providers/aws/datazone/domain/index.md create mode 100644 docs/aws-docs/providers/aws/datazone/domains/index.md create mode 100644 docs/aws-docs/providers/aws/datazone/environment/index.md create mode 100644 docs/aws-docs/providers/aws/datazone/environment_blueprint_configuration/index.md create mode 100644 docs/aws-docs/providers/aws/datazone/environment_blueprint_configurations/index.md create mode 100644 docs/aws-docs/providers/aws/datazone/environment_profile/index.md create mode 100644 docs/aws-docs/providers/aws/datazone/environment_profiles/index.md create mode 100644 docs/aws-docs/providers/aws/datazone/environments/index.md create mode 100644 docs/aws-docs/providers/aws/datazone/index.md create mode 100644 docs/aws-docs/providers/aws/datazone/project/index.md create mode 100644 docs/aws-docs/providers/aws/datazone/projects/index.md create mode 100644 docs/aws-docs/providers/aws/datazone/subscription_target/index.md create mode 100644 docs/aws-docs/providers/aws/datazone/subscription_targets/index.md create mode 100644 docs/aws-docs/providers/aws/deadline/farm/index.md create mode 100644 docs/aws-docs/providers/aws/deadline/farms/index.md create mode 100644 docs/aws-docs/providers/aws/deadline/fleet/index.md create mode 100644 docs/aws-docs/providers/aws/deadline/fleets/index.md create mode 100644 docs/aws-docs/providers/aws/deadline/index.md create mode 100644 docs/aws-docs/providers/aws/deadline/license_endpoint/index.md create mode 100644 docs/aws-docs/providers/aws/deadline/license_endpoints/index.md create mode 100644 docs/aws-docs/providers/aws/deadline/metered_product/index.md create mode 100644 docs/aws-docs/providers/aws/deadline/metered_products/index.md create mode 100644 docs/aws-docs/providers/aws/deadline/queue/index.md create mode 100644 docs/aws-docs/providers/aws/deadline/queue_environment/index.md create mode 100644 docs/aws-docs/providers/aws/deadline/queue_environments/index.md create mode 100644 docs/aws-docs/providers/aws/deadline/queue_fleet_association/index.md create mode 100644 docs/aws-docs/providers/aws/deadline/queue_fleet_associations/index.md create mode 100644 docs/aws-docs/providers/aws/deadline/queues/index.md create mode 100644 docs/aws-docs/providers/aws/deadline/storage_profile/index.md create mode 100644 docs/aws-docs/providers/aws/deadline/storage_profiles/index.md create mode 100644 docs/aws-docs/providers/aws/detective/graph/index.md create mode 100644 docs/aws-docs/providers/aws/detective/graphs/index.md create mode 100644 docs/aws-docs/providers/aws/detective/index.md create mode 100644 docs/aws-docs/providers/aws/detective/member_invitation/index.md create mode 100644 docs/aws-docs/providers/aws/detective/member_invitations/index.md create mode 100644 docs/aws-docs/providers/aws/detective/organization_admin/index.md create mode 100644 docs/aws-docs/providers/aws/detective/organization_admins/index.md create mode 100644 docs/aws-docs/providers/aws/devopsguru/index.md create mode 100644 docs/aws-docs/providers/aws/devopsguru/log_anomaly_detection_integration/index.md create mode 100644 docs/aws-docs/providers/aws/devopsguru/log_anomaly_detection_integrations/index.md create mode 100644 docs/aws-docs/providers/aws/devopsguru/notification_channel/index.md create mode 100644 docs/aws-docs/providers/aws/devopsguru/notification_channels/index.md create mode 100644 docs/aws-docs/providers/aws/devopsguru/resource_collection/index.md create mode 100644 docs/aws-docs/providers/aws/devopsguru/resource_collections/index.md create mode 100644 docs/aws-docs/providers/aws/directoryservice/index.md create mode 100644 docs/aws-docs/providers/aws/directoryservice/simple_ad/index.md create mode 100644 docs/aws-docs/providers/aws/directoryservice/simple_ads/index.md create mode 100644 docs/aws-docs/providers/aws/dms/data_provider/index.md create mode 100644 docs/aws-docs/providers/aws/dms/data_providers/index.md create mode 100644 docs/aws-docs/providers/aws/dms/index.md create mode 100644 docs/aws-docs/providers/aws/dms/instance_profile/index.md create mode 100644 docs/aws-docs/providers/aws/dms/instance_profiles/index.md create mode 100644 docs/aws-docs/providers/aws/dms/migration_project/index.md create mode 100644 docs/aws-docs/providers/aws/dms/migration_projects/index.md create mode 100644 docs/aws-docs/providers/aws/dms/replication_config/index.md create mode 100644 docs/aws-docs/providers/aws/dms/replication_configs/index.md create mode 100644 docs/aws-docs/providers/aws/docdbelastic/cluster/index.md create mode 100644 docs/aws-docs/providers/aws/docdbelastic/clusters/index.md create mode 100644 docs/aws-docs/providers/aws/docdbelastic/index.md create mode 100644 docs/aws-docs/providers/aws/dynamodb/global_table/index.md create mode 100644 docs/aws-docs/providers/aws/dynamodb/global_tables/index.md create mode 100644 docs/aws-docs/providers/aws/dynamodb/index.md create mode 100644 docs/aws-docs/providers/aws/dynamodb/table/index.md create mode 100644 docs/aws-docs/providers/aws/dynamodb/tables/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/account_attributes/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/address/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/address_attribute/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/address_to_classic/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/address_to_vpc/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/addresses/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/addresses_attribute/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/aggregate_id_format/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/associated_enclave_certificate_iam_roles/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/associated_ipv6_pool_cidrs/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/availability_zone_group/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/availability_zones/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/bundle_tasks/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/byoip_cidr_to_ipam/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/byoip_cidrs/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/capacity_reservation/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/capacity_reservation_fleet/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/capacity_reservation_usage/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/carrier_gateway/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/classic_link_instances/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/classic_link_vpc/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/client_vpn_authorization_rules/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/client_vpn_client_certificate_revocation_list/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/client_vpn_client_configuration/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/client_vpn_connections/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/client_vpn_endpoints/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/client_vpn_ingress/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/client_vpn_routes/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/client_vpn_target_networks/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/coip_pool_usage/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/coip_pools/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/console_output/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/console_screenshot/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/conversion_tasks/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/customer_gateway/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/default_credit_specification/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/default_subnet/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/default_vpc/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/diagnostic_interrupt/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/ebs_default_kms_key_id/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/ebs_encryption_by_default/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/ec2fleet/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/ec2fleets/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/egress_only_internet_gateway/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/eip/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/eip_association/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/eip_associations/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/eips/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/elastic_gpus/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/enclave_certificate_iam_role/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/enclave_certificate_iam_role_association/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/enclave_certificate_iam_role_associations/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/export_image_tasks/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/export_tasks/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/fast_launch/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/fast_launch_images/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/fast_snapshot_restores/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/fleet_history/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/fleet_instances/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/fleets/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/flow_log/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/flow_logs_integration_template/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/fpga_image_attribute/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/fpga_images/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/gateway_route_table_association/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/gateway_route_table_associations/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/groups_for_capacity_reservation/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/host/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/host_reservation_offerings/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/host_reservation_purchase_preview/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/host_reservations/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/iam_instance_profile/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/iam_instance_profile_associations/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/id_format/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/identity_id_format/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/image_attribute/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/image_deprecation/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/image_from_recycle_bin/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/images/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/images_in_recycle_bin/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/import_image_tasks/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/import_snapshot_tasks/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/import_task/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/instance/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/instance_attribute/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/instance_capacity_reservation_attributes/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/instance_connect_endpoint/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/instance_connect_endpoints/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/instance_credit_specifications/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/instance_event_notification_attributes/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/instance_event_start_time/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/instance_event_windows/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/instance_export_task/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/instance_maintenance_options/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/instance_metadata_options/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/instance_placement/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/instance_status/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/instance_type_offerings/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/instance_types/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/instance_types_from_instance_requirements/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/instance_uefi_data/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/internet_gateway/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/ipam/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/ipam_address_history/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/ipam_allocation/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/ipam_allocations/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/ipam_organization_admin_account/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/ipam_pool/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/ipam_pool_allocations/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/ipam_pool_cidr/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/ipam_resource_cidrs/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/ipam_resource_discoveries/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/ipam_resource_discovery/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/ipam_resource_discovery_association/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/ipam_resource_discovery_associations/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/ipam_scope/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/ipv6_addresses/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/ipv6_pools/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/key_pair/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/launch_template/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/launch_template_data/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/launch_template_versions/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/local_gateway_route/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/local_gateway_route_table/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/local_gateway_route_table_virtual_interface_group_association/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/local_gateway_route_table_vpc_associations/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/local_gateway_route_tablevpc_association/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/local_gateway_route_tablevpc_associations/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/local_gateway_virtual_interface_groups/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/local_gateway_virtual_interfaces/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/local_gateways/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/managed_prefix_list_associations/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/managed_prefix_list_entries/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/managed_prefix_list_version/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/managed_prefix_lists/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/moving_addresses/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/nat_gateway/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/network_acl/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/network_acl_association/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/network_acl_entry/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/network_insights_access_scope/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/network_insights_access_scope_analysis_findings/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/network_insights_access_scope_content/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/network_insights_path/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/network_interface/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/network_interface_attachment/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/network_interface_attachments/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/network_interface_attribute/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/network_interface_permissions/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/network_performance_metric_subscription/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/network_performance_metric_subscriptions/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/password_data/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/placement_group/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/prefix_list/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/principal_id_format/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/private_dns_name_options/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/private_ip_addresses/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/product_instance/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/public_ipv4_pool_cidr/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/public_ipv4_pools/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/queued_reserved_instances/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/regions/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/replace_root_volume_tasks/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/reserved_instances/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/reserved_instances_exchange_quote/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/reserved_instances_listings/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/reserved_instances_modifications/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/reserved_instances_offerings/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/restore_image_task/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/route_table/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/route_table_association/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/routes/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/scheduled_instance_availability/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/scheduled_instances/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/security_group/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/security_group_egresses/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/security_group_ingresses/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/security_group_references/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/security_group_rule_descriptions_egress/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/security_group_rule_descriptions_ingress/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/security_group_rules/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/security_groups_to_client_vpn_target_network/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/serial_console_access/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/serial_console_access_status/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/snapshot_attribute/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/snapshot_block_public_access/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/snapshot_block_public_accesses/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/snapshot_from_recycle_bin/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/snapshot_tier/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/snapshot_tier_status/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/snapshots_in_recycle_bin/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/spot_datafeed_subscription/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/spot_fleet_instances/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/spot_fleet_request_history/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/spot_fleet_requests/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/spot_fleets/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/spot_instance_requests/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/spot_instances/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/spot_placement_scores/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/spot_price_history/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/stale_security_groups/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/store_image_tasks/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/subnet/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/subnet_attribute/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/subnet_cidr_blocks/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/subnet_cidr_reservations/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/subnet_network_acl_association/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/subnet_network_acl_associations/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/subnet_route_table_association/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/subnet_route_table_associations/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/tags/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/traffic_mirror_filter_network_services/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/traffic_mirror_filter_rule/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/traffic_mirror_filters/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/traffic_mirror_sessions/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/traffic_mirror_targets/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/transit_gateway/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/transit_gateway_attachment/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/transit_gateway_attachment_propagations/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/transit_gateway_connect/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/transit_gateway_connect_peers/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_domain/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_domain_association/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_group_member/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_group_source/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_groups/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/transit_gateway_peering_attachment/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/transit_gateway_prefix_list_references/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/transit_gateway_route_table/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/transit_gateway_route_table_association/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/transit_gateway_route_table_propagations/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/transit_gateway_routes/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/transit_gateway_vpc_attachment/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/trunk_interface/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/trunk_interface_associations/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/verified_access_endpoint/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/verified_access_endpoints/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/verified_access_group/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/verified_access_groups/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/verified_access_instance/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/verified_access_instances/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/verified_access_trust_provider/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/verified_access_trust_providers/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/vgw_route_propagation/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/volume/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/volume_attachment/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/volume_attachments/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/volume_attribute/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/volume_i_o/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/volume_status/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/volumes_modifications/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/vpc/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/vpc_attribute/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/vpc_cidr_blocks/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/vpc_classic_link/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/vpc_classic_link_dns_support/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/vpc_endpoint/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/vpc_endpoint_connection_notification/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/vpc_endpoint_connections/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/vpc_endpoint_service/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/vpc_endpoint_service_configurations/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/vpc_endpoint_service_payer_responsibility/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/vpc_endpoint_service_private_dns_verification/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/vpc_gateway_attachment/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/vpc_gateway_attachments/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/vpc_peering_connection/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/vpc_peering_connection_options/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/vpc_tenancy/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/vpcdhcp_options_association/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/vpcdhcp_options_associations/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/vpn_connection/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/vpn_connection_device_sample_configuration/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/vpn_connection_device_types/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/vpn_connection_options/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/vpn_connection_routes/index.md create mode 100644 docs/aws-docs/providers/aws/ec2/vpn_gateway/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/vpn_tunnel_certificate/index.md delete mode 100644 docs/aws-docs/providers/aws/ec2/vpn_tunnel_options/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/account_attributes/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/address/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/address_attribute/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/address_to_classic/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/address_to_vpc/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/addresses/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/addresses_attribute/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/aggregate_id_format/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/associated_enclave_certificate_iam_roles/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/associated_ipv6_pool_cidrs/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/availability_zone_group/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/availability_zones/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/bundle_tasks/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/byoip_cidr_to_ipam/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/byoip_cidrs/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/capacity_reservation_fleets/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/capacity_reservation_usage/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/capacity_reservations/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/carrier_gateways/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/classic_link_instances/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/classic_link_vpc/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/client_vpn_authorization_rules/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/client_vpn_client_certificate_revocation_list/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/client_vpn_client_configuration/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/client_vpn_connections/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/client_vpn_endpoints/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/client_vpn_ingress/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/client_vpn_routes/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/client_vpn_target_networks/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/coip_pool_usage/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/coip_pools/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/console_output/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/console_screenshot/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/conversion_tasks/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/customer_gateways/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/default_credit_specification/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/default_subnet/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/default_vpc/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/dhcp_options/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/diagnostic_interrupt/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/ebs_default_kms_key_id/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/ebs_encryption_by_default/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/egress_only_internet_gateways/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/elastic_gpus/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/enclave_certificate_iam_role/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/export_image_tasks/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/export_tasks/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/fast_launch/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/fast_launch_images/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/fast_snapshot_restores/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/fleet_history/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/fleet_instances/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/fleets/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/flow_logs/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/flow_logs_integration_template/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/fpga_image_attribute/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/fpga_images/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/groups_for_capacity_reservation/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/host_reservation_offerings/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/host_reservation_purchase_preview/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/host_reservations/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/hosts/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/iam_instance_profile/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/iam_instance_profile_associations/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/id_format/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/identity_id_format/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/image_attribute/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/image_deprecation/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/image_from_recycle_bin/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/images/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/images_in_recycle_bin/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/import_image_tasks/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/import_snapshot_tasks/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/import_task/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/instance_attribute/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/instance_capacity_reservation_attributes/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/instance_credit_specifications/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/instance_event_notification_attributes/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/instance_event_start_time/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/instance_event_windows/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/instance_export_task/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/instance_maintenance_options/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/instance_metadata_options/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/instance_placement/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/instance_status/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/instance_type_offerings/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/instance_types/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/instance_types_from_instance_requirements/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/instance_uefi_data/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/instances/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/internet_gateways/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/ipam_address_history/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/ipam_organization_admin_account/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/ipam_pool_allocations/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/ipam_pool_cidrs/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/ipam_pools/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/ipam_resource_cidrs/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/ipam_scopes/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/ipams/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/ipv6_addresses/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/ipv6_pools/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/key_pairs/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/launch_template_data/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/launch_template_versions/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/launch_templates/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/local_gateway_route_table_virtual_interface_group_associations/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/local_gateway_route_table_vpc_associations/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/local_gateway_route_tables/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/local_gateway_routes/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/local_gateway_virtual_interface_groups/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/local_gateway_virtual_interfaces/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/local_gateways/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/managed_prefix_list_associations/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/managed_prefix_list_entries/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/managed_prefix_list_version/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/managed_prefix_lists/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/moving_addresses/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/nat_gateways/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/network_acl_association/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/network_acl_entry/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/network_acls/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/network_insights_access_scope_analyses/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/network_insights_access_scope_analysis/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/network_insights_access_scope_analysis_findings/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/network_insights_access_scope_content/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/network_insights_access_scopes/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/network_insights_analyses/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/network_insights_analysis/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/network_insights_paths/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/network_interface_attribute/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/network_interface_permissions/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/network_interfaces/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/password_data/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/placement_groups/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/prefix_lists/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/principal_id_format/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/private_dns_name_options/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/private_ip_addresses/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/product_instance/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/public_ipv4_pool_cidr/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/public_ipv4_pools/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/queued_reserved_instances/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/regions/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/replace_root_volume_tasks/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/reserved_instances/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/reserved_instances_exchange_quote/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/reserved_instances_listings/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/reserved_instances_modifications/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/reserved_instances_offerings/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/restore_image_task/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/route/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/route_table_association/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/route_tables/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/scheduled_instance_availability/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/scheduled_instances/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/security_group_egress/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/security_group_ingress/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/security_group_references/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/security_group_rule_descriptions_egress/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/security_group_rule_descriptions_ingress/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/security_group_rules/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/security_groups/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/security_groups_to_client_vpn_target_network/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/serial_console_access/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/serial_console_access_status/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/snapshot_attribute/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/snapshot_from_recycle_bin/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/snapshot_tier/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/snapshot_tier_status/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/snapshots/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/snapshots_in_recycle_bin/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/spot_datafeed_subscription/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/spot_fleet/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/spot_fleet_instances/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/spot_fleet_request_history/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/spot_fleet_requests/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/spot_instance_requests/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/spot_instances/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/spot_placement_scores/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/spot_price_history/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/stale_security_groups/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/store_image_tasks/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/subnet_attribute/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/subnet_cidr_block/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/subnet_cidr_reservations/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/subnets/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/tags/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/traffic_mirror_filter_network_services/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/traffic_mirror_filter_rule/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/traffic_mirror_filters/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/traffic_mirror_sessions/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/traffic_mirror_targets/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/transit_gateway_attachment_propagations/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/transit_gateway_attachments/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/transit_gateway_connect_peers/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/transit_gateway_connects/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/transit_gateway_multicast_domain_associations/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/transit_gateway_multicast_domains/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/transit_gateway_multicast_group_members/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/transit_gateway_multicast_group_sources/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/transit_gateway_multicast_groups/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/transit_gateway_peering_attachments/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/transit_gateway_prefix_list_references/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/transit_gateway_route_table_associations/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/transit_gateway_route_table_propagations/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/transit_gateway_route_tables/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/transit_gateway_routes/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/transit_gateway_vpc_attachments/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/transit_gateways/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/trunk_interface/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/trunk_interface_associations/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/vgw_route_propagation/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/volume_attribute/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/volume_i_o/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/volume_status/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/volumes/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/volumes_modifications/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/vpc_attribute/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/vpc_cidr_block/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/vpc_classic_link/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/vpc_classic_link_dns_support/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/vpc_endpoint_connection_notifications/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/vpc_endpoint_connections/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/vpc_endpoint_service_configurations/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/vpc_endpoint_service_payer_responsibility/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/vpc_endpoint_service_permissions/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/vpc_endpoint_service_private_dns_verification/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/vpc_endpoint_services/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/vpc_endpoints/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/vpc_peering_connection_options/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/vpc_peering_connections/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/vpc_tenancy/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/vpcs/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/vpn_connection_device_sample_configuration/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/vpn_connection_device_types/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/vpn_connection_options/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/vpn_connection_route/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/vpn_connections/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/vpn_gateways/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/vpn_tunnel_certificate/index.md create mode 100644 docs/aws-docs/providers/aws/ec2_api/vpn_tunnel_options/index.md create mode 100644 docs/aws-docs/providers/aws/ecr/index.md create mode 100644 docs/aws-docs/providers/aws/ecr/public_repositories/index.md create mode 100644 docs/aws-docs/providers/aws/ecr/public_repository/index.md create mode 100644 docs/aws-docs/providers/aws/ecr/pull_through_cache_rule/index.md create mode 100644 docs/aws-docs/providers/aws/ecr/pull_through_cache_rules/index.md create mode 100644 docs/aws-docs/providers/aws/ecr/registry_policies/index.md create mode 100644 docs/aws-docs/providers/aws/ecr/registry_policy/index.md create mode 100644 docs/aws-docs/providers/aws/ecr/replication_configuration/index.md create mode 100644 docs/aws-docs/providers/aws/ecr/replication_configurations/index.md create mode 100644 docs/aws-docs/providers/aws/ecr/repositories/index.md create mode 100644 docs/aws-docs/providers/aws/ecr/repository/index.md create mode 100644 docs/aws-docs/providers/aws/ecr/repository_creation_template/index.md create mode 100644 docs/aws-docs/providers/aws/ecr/repository_creation_templates/index.md create mode 100644 docs/aws-docs/providers/aws/ecs/cluster_capacity_provider_associations/index.md create mode 100644 docs/aws-docs/providers/aws/ecs/index.md create mode 100644 docs/aws-docs/providers/aws/ecs/primary_task_set/index.md create mode 100644 docs/aws-docs/providers/aws/ecs/primary_task_sets/index.md create mode 100644 docs/aws-docs/providers/aws/ecs/service/index.md create mode 100644 docs/aws-docs/providers/aws/ecs/services/index.md create mode 100644 docs/aws-docs/providers/aws/ecs/task_definition/index.md create mode 100644 docs/aws-docs/providers/aws/ecs/task_definitions/index.md create mode 100644 docs/aws-docs/providers/aws/ecs/task_set/index.md create mode 100644 docs/aws-docs/providers/aws/ecs/task_sets/index.md create mode 100644 docs/aws-docs/providers/aws/efs/access_point/index.md create mode 100644 docs/aws-docs/providers/aws/efs/access_points/index.md create mode 100644 docs/aws-docs/providers/aws/efs/file_system/index.md create mode 100644 docs/aws-docs/providers/aws/efs/file_systems/index.md create mode 100644 docs/aws-docs/providers/aws/efs/index.md create mode 100644 docs/aws-docs/providers/aws/efs/mount_target/index.md create mode 100644 docs/aws-docs/providers/aws/efs/mount_targets/index.md create mode 100644 docs/aws-docs/providers/aws/eks/access_entries/index.md create mode 100644 docs/aws-docs/providers/aws/eks/access_entry/index.md create mode 100644 docs/aws-docs/providers/aws/eks/addon/index.md create mode 100644 docs/aws-docs/providers/aws/eks/addons/index.md create mode 100644 docs/aws-docs/providers/aws/eks/cluster/index.md create mode 100644 docs/aws-docs/providers/aws/eks/clusters/index.md create mode 100644 docs/aws-docs/providers/aws/eks/fargate_profile/index.md create mode 100644 docs/aws-docs/providers/aws/eks/fargate_profiles/index.md create mode 100644 docs/aws-docs/providers/aws/eks/identity_provider_config/index.md create mode 100644 docs/aws-docs/providers/aws/eks/identity_provider_configs/index.md create mode 100644 docs/aws-docs/providers/aws/eks/index.md create mode 100644 docs/aws-docs/providers/aws/eks/nodegroup/index.md create mode 100644 docs/aws-docs/providers/aws/eks/nodegroups/index.md create mode 100644 docs/aws-docs/providers/aws/eks/pod_identity_association/index.md create mode 100644 docs/aws-docs/providers/aws/eks/pod_identity_associations/index.md create mode 100644 docs/aws-docs/providers/aws/elasticache/global_replication_group/index.md create mode 100644 docs/aws-docs/providers/aws/elasticache/global_replication_groups/index.md create mode 100644 docs/aws-docs/providers/aws/elasticache/index.md create mode 100644 docs/aws-docs/providers/aws/elasticache/serverless_cache/index.md create mode 100644 docs/aws-docs/providers/aws/elasticache/serverless_caches/index.md create mode 100644 docs/aws-docs/providers/aws/elasticache/subnet_group/index.md create mode 100644 docs/aws-docs/providers/aws/elasticache/subnet_groups/index.md create mode 100644 docs/aws-docs/providers/aws/elasticache/user/index.md create mode 100644 docs/aws-docs/providers/aws/elasticache/user_group/index.md create mode 100644 docs/aws-docs/providers/aws/elasticache/user_groups/index.md create mode 100644 docs/aws-docs/providers/aws/elasticache/users/index.md create mode 100644 docs/aws-docs/providers/aws/elasticbeanstalk/application/index.md create mode 100644 docs/aws-docs/providers/aws/elasticbeanstalk/application_version/index.md create mode 100644 docs/aws-docs/providers/aws/elasticbeanstalk/application_versions/index.md create mode 100644 docs/aws-docs/providers/aws/elasticbeanstalk/applications/index.md create mode 100644 docs/aws-docs/providers/aws/elasticbeanstalk/configuration_template/index.md create mode 100644 docs/aws-docs/providers/aws/elasticbeanstalk/configuration_templates/index.md create mode 100644 docs/aws-docs/providers/aws/elasticbeanstalk/environment/index.md create mode 100644 docs/aws-docs/providers/aws/elasticbeanstalk/environments/index.md create mode 100644 docs/aws-docs/providers/aws/elasticbeanstalk/index.md create mode 100644 docs/aws-docs/providers/aws/elasticloadbalancingv2/index.md create mode 100644 docs/aws-docs/providers/aws/elasticloadbalancingv2/listener/index.md create mode 100644 docs/aws-docs/providers/aws/elasticloadbalancingv2/listener_rule/index.md create mode 100644 docs/aws-docs/providers/aws/elasticloadbalancingv2/listener_rules/index.md create mode 100644 docs/aws-docs/providers/aws/elasticloadbalancingv2/listeners/index.md create mode 100644 docs/aws-docs/providers/aws/elasticloadbalancingv2/load_balancer/index.md create mode 100644 docs/aws-docs/providers/aws/elasticloadbalancingv2/load_balancers/index.md create mode 100644 docs/aws-docs/providers/aws/elasticloadbalancingv2/target_group/index.md create mode 100644 docs/aws-docs/providers/aws/elasticloadbalancingv2/target_groups/index.md create mode 100644 docs/aws-docs/providers/aws/elasticloadbalancingv2/trust_store/index.md create mode 100644 docs/aws-docs/providers/aws/elasticloadbalancingv2/trust_store_revocation/index.md create mode 100644 docs/aws-docs/providers/aws/elasticloadbalancingv2/trust_store_revocations/index.md create mode 100644 docs/aws-docs/providers/aws/elasticloadbalancingv2/trust_stores/index.md create mode 100644 docs/aws-docs/providers/aws/emr/index.md create mode 100644 docs/aws-docs/providers/aws/emr/security_configuration/index.md create mode 100644 docs/aws-docs/providers/aws/emr/security_configurations/index.md create mode 100644 docs/aws-docs/providers/aws/emr/studio/index.md create mode 100644 docs/aws-docs/providers/aws/emr/studio_session_mapping/index.md create mode 100644 docs/aws-docs/providers/aws/emr/studio_session_mappings/index.md create mode 100644 docs/aws-docs/providers/aws/emr/studios/index.md create mode 100644 docs/aws-docs/providers/aws/emr/wal_workspace/index.md create mode 100644 docs/aws-docs/providers/aws/emr/wal_workspaces/index.md create mode 100644 docs/aws-docs/providers/aws/emrcontainers/index.md create mode 100644 docs/aws-docs/providers/aws/emrcontainers/virtual_cluster/index.md create mode 100644 docs/aws-docs/providers/aws/emrcontainers/virtual_clusters/index.md create mode 100644 docs/aws-docs/providers/aws/emrserverless/application/index.md create mode 100644 docs/aws-docs/providers/aws/emrserverless/applications/index.md create mode 100644 docs/aws-docs/providers/aws/emrserverless/index.md create mode 100644 docs/aws-docs/providers/aws/entityresolution/id_mapping_workflow/index.md create mode 100644 docs/aws-docs/providers/aws/entityresolution/id_mapping_workflows/index.md create mode 100644 docs/aws-docs/providers/aws/entityresolution/id_namespace/index.md create mode 100644 docs/aws-docs/providers/aws/entityresolution/id_namespaces/index.md create mode 100644 docs/aws-docs/providers/aws/entityresolution/index.md create mode 100644 docs/aws-docs/providers/aws/entityresolution/matching_workflow/index.md create mode 100644 docs/aws-docs/providers/aws/entityresolution/matching_workflows/index.md create mode 100644 docs/aws-docs/providers/aws/entityresolution/policy_statement/index.md create mode 100644 docs/aws-docs/providers/aws/entityresolution/policy_statements/index.md create mode 100644 docs/aws-docs/providers/aws/entityresolution/schema_mapping/index.md create mode 100644 docs/aws-docs/providers/aws/entityresolution/schema_mappings/index.md create mode 100644 docs/aws-docs/providers/aws/events/api_destination/index.md create mode 100644 docs/aws-docs/providers/aws/events/api_destinations/index.md create mode 100644 docs/aws-docs/providers/aws/events/archive/index.md create mode 100644 docs/aws-docs/providers/aws/events/archives/index.md create mode 100644 docs/aws-docs/providers/aws/events/connection/index.md create mode 100644 docs/aws-docs/providers/aws/events/connections/index.md create mode 100644 docs/aws-docs/providers/aws/events/endpoint/index.md create mode 100644 docs/aws-docs/providers/aws/events/endpoints/index.md create mode 100644 docs/aws-docs/providers/aws/events/event_bus/index.md create mode 100644 docs/aws-docs/providers/aws/events/event_buses/index.md create mode 100644 docs/aws-docs/providers/aws/events/index.md create mode 100644 docs/aws-docs/providers/aws/events/rule/index.md create mode 100644 docs/aws-docs/providers/aws/events/rules/index.md create mode 100644 docs/aws-docs/providers/aws/eventschemas/discoverer/index.md create mode 100644 docs/aws-docs/providers/aws/eventschemas/discoverers/index.md create mode 100644 docs/aws-docs/providers/aws/eventschemas/eventschemas_registry/index.md create mode 100644 docs/aws-docs/providers/aws/eventschemas/index.md create mode 100644 docs/aws-docs/providers/aws/eventschemas/registries/index.md create mode 100644 docs/aws-docs/providers/aws/eventschemas/registry_policies/index.md create mode 100644 docs/aws-docs/providers/aws/eventschemas/registry_policy/index.md create mode 100644 docs/aws-docs/providers/aws/eventschemas/schema/index.md create mode 100644 docs/aws-docs/providers/aws/eventschemas/schemata/index.md create mode 100644 docs/aws-docs/providers/aws/evidently/experiment/index.md create mode 100644 docs/aws-docs/providers/aws/evidently/experiments/index.md create mode 100644 docs/aws-docs/providers/aws/evidently/feature/index.md create mode 100644 docs/aws-docs/providers/aws/evidently/features/index.md create mode 100644 docs/aws-docs/providers/aws/evidently/index.md create mode 100644 docs/aws-docs/providers/aws/evidently/launch/index.md create mode 100644 docs/aws-docs/providers/aws/evidently/launches/index.md create mode 100644 docs/aws-docs/providers/aws/evidently/project/index.md create mode 100644 docs/aws-docs/providers/aws/evidently/projects/index.md create mode 100644 docs/aws-docs/providers/aws/evidently/segment/index.md create mode 100644 docs/aws-docs/providers/aws/evidently/segments/index.md create mode 100644 docs/aws-docs/providers/aws/finspace/environment/index.md create mode 100644 docs/aws-docs/providers/aws/finspace/environments/index.md create mode 100644 docs/aws-docs/providers/aws/finspace/index.md create mode 100644 docs/aws-docs/providers/aws/fis/experiment_template/index.md create mode 100644 docs/aws-docs/providers/aws/fis/experiment_templates/index.md create mode 100644 docs/aws-docs/providers/aws/fis/index.md create mode 100644 docs/aws-docs/providers/aws/fis/target_account_configuration/index.md create mode 100644 docs/aws-docs/providers/aws/fis/target_account_configurations/index.md create mode 100644 docs/aws-docs/providers/aws/fms/index.md create mode 100644 docs/aws-docs/providers/aws/fms/notification_channel/index.md create mode 100644 docs/aws-docs/providers/aws/fms/notification_channels/index.md create mode 100644 docs/aws-docs/providers/aws/fms/policies/index.md create mode 100644 docs/aws-docs/providers/aws/fms/policy/index.md create mode 100644 docs/aws-docs/providers/aws/fms/resource_set/index.md create mode 100644 docs/aws-docs/providers/aws/fms/resource_sets/index.md create mode 100644 docs/aws-docs/providers/aws/forecast/dataset/index.md create mode 100644 docs/aws-docs/providers/aws/forecast/dataset_group/index.md create mode 100644 docs/aws-docs/providers/aws/forecast/dataset_groups/index.md create mode 100644 docs/aws-docs/providers/aws/forecast/datasets/index.md create mode 100644 docs/aws-docs/providers/aws/forecast/index.md create mode 100644 docs/aws-docs/providers/aws/frauddetector/detector/index.md create mode 100644 docs/aws-docs/providers/aws/frauddetector/detectors/index.md create mode 100644 docs/aws-docs/providers/aws/frauddetector/event_type/index.md create mode 100644 docs/aws-docs/providers/aws/frauddetector/event_types/index.md create mode 100644 docs/aws-docs/providers/aws/frauddetector/frauddetector_list/index.md create mode 100644 docs/aws-docs/providers/aws/frauddetector/index.md create mode 100644 docs/aws-docs/providers/aws/frauddetector/label/index.md create mode 100644 docs/aws-docs/providers/aws/frauddetector/labels/index.md create mode 100644 docs/aws-docs/providers/aws/frauddetector/lists/index.md create mode 100644 docs/aws-docs/providers/aws/frauddetector/outcome/index.md create mode 100644 docs/aws-docs/providers/aws/frauddetector/outcomes/index.md create mode 100644 docs/aws-docs/providers/aws/frauddetector/variable/index.md create mode 100644 docs/aws-docs/providers/aws/frauddetector/variables/index.md create mode 100644 docs/aws-docs/providers/aws/fsx/data_repository_association/index.md create mode 100644 docs/aws-docs/providers/aws/fsx/data_repository_associations/index.md create mode 100644 docs/aws-docs/providers/aws/fsx/index.md create mode 100644 docs/aws-docs/providers/aws/gamelift/alias/index.md create mode 100644 docs/aws-docs/providers/aws/gamelift/aliases/index.md create mode 100644 docs/aws-docs/providers/aws/gamelift/build/index.md create mode 100644 docs/aws-docs/providers/aws/gamelift/builds/index.md create mode 100644 docs/aws-docs/providers/aws/gamelift/fleet/index.md create mode 100644 docs/aws-docs/providers/aws/gamelift/fleets/index.md create mode 100644 docs/aws-docs/providers/aws/gamelift/game_server_group/index.md create mode 100644 docs/aws-docs/providers/aws/gamelift/game_server_groups/index.md create mode 100644 docs/aws-docs/providers/aws/gamelift/game_session_queue/index.md create mode 100644 docs/aws-docs/providers/aws/gamelift/game_session_queues/index.md create mode 100644 docs/aws-docs/providers/aws/gamelift/index.md create mode 100644 docs/aws-docs/providers/aws/gamelift/location/index.md create mode 100644 docs/aws-docs/providers/aws/gamelift/locations/index.md create mode 100644 docs/aws-docs/providers/aws/gamelift/matchmaking_configuration/index.md create mode 100644 docs/aws-docs/providers/aws/gamelift/matchmaking_configurations/index.md create mode 100644 docs/aws-docs/providers/aws/gamelift/matchmaking_rule_set/index.md create mode 100644 docs/aws-docs/providers/aws/gamelift/matchmaking_rule_sets/index.md create mode 100644 docs/aws-docs/providers/aws/gamelift/script/index.md create mode 100644 docs/aws-docs/providers/aws/gamelift/scripts/index.md create mode 100644 docs/aws-docs/providers/aws/globalaccelerator/accelerator/index.md create mode 100644 docs/aws-docs/providers/aws/globalaccelerator/accelerators/index.md create mode 100644 docs/aws-docs/providers/aws/globalaccelerator/cross_account_attachment/index.md create mode 100644 docs/aws-docs/providers/aws/globalaccelerator/cross_account_attachments/index.md create mode 100644 docs/aws-docs/providers/aws/globalaccelerator/endpoint_group/index.md create mode 100644 docs/aws-docs/providers/aws/globalaccelerator/endpoint_groups/index.md create mode 100644 docs/aws-docs/providers/aws/globalaccelerator/index.md create mode 100644 docs/aws-docs/providers/aws/globalaccelerator/listener/index.md create mode 100644 docs/aws-docs/providers/aws/globalaccelerator/listeners/index.md create mode 100644 docs/aws-docs/providers/aws/glue/index.md create mode 100644 docs/aws-docs/providers/aws/glue/schema_version/index.md create mode 100644 docs/aws-docs/providers/aws/glue/schema_version_metadata/index.md create mode 100644 docs/aws-docs/providers/aws/glue/schema_versions/index.md create mode 100644 docs/aws-docs/providers/aws/grafana/index.md create mode 100644 docs/aws-docs/providers/aws/grafana/workspace/index.md create mode 100644 docs/aws-docs/providers/aws/grafana/workspaces/index.md create mode 100644 docs/aws-docs/providers/aws/greengrassv2/component_version/index.md create mode 100644 docs/aws-docs/providers/aws/greengrassv2/component_versions/index.md create mode 100644 docs/aws-docs/providers/aws/greengrassv2/deployment/index.md create mode 100644 docs/aws-docs/providers/aws/greengrassv2/deployments/index.md create mode 100644 docs/aws-docs/providers/aws/greengrassv2/index.md create mode 100644 docs/aws-docs/providers/aws/groundstation/config/index.md create mode 100644 docs/aws-docs/providers/aws/groundstation/configs/index.md create mode 100644 docs/aws-docs/providers/aws/groundstation/dataflow_endpoint_group/index.md create mode 100644 docs/aws-docs/providers/aws/groundstation/dataflow_endpoint_groups/index.md create mode 100644 docs/aws-docs/providers/aws/groundstation/index.md create mode 100644 docs/aws-docs/providers/aws/groundstation/mission_profile/index.md create mode 100644 docs/aws-docs/providers/aws/groundstation/mission_profiles/index.md create mode 100644 docs/aws-docs/providers/aws/guardduty/detector/index.md create mode 100644 docs/aws-docs/providers/aws/guardduty/detectors/index.md create mode 100644 docs/aws-docs/providers/aws/guardduty/filter/index.md create mode 100644 docs/aws-docs/providers/aws/guardduty/filters/index.md create mode 100644 docs/aws-docs/providers/aws/guardduty/index.md create mode 100644 docs/aws-docs/providers/aws/guardduty/ip_set/index.md create mode 100644 docs/aws-docs/providers/aws/guardduty/ip_sets/index.md create mode 100644 docs/aws-docs/providers/aws/guardduty/master/index.md create mode 100644 docs/aws-docs/providers/aws/guardduty/masters/index.md create mode 100644 docs/aws-docs/providers/aws/guardduty/member/index.md create mode 100644 docs/aws-docs/providers/aws/guardduty/members/index.md create mode 100644 docs/aws-docs/providers/aws/guardduty/threat_intel_set/index.md create mode 100644 docs/aws-docs/providers/aws/guardduty/threat_intel_sets/index.md create mode 100644 docs/aws-docs/providers/aws/healthimaging/datastore/index.md create mode 100644 docs/aws-docs/providers/aws/healthimaging/datastores/index.md create mode 100644 docs/aws-docs/providers/aws/healthimaging/index.md create mode 100644 docs/aws-docs/providers/aws/healthlake/fhir_datastore/index.md create mode 100644 docs/aws-docs/providers/aws/healthlake/fhir_datastores/index.md create mode 100644 docs/aws-docs/providers/aws/healthlake/index.md delete mode 100644 docs/aws-docs/providers/aws/iam/access_key_last_useds/index.md delete mode 100644 docs/aws-docs/providers/aws/iam/access_keys/index.md delete mode 100644 docs/aws-docs/providers/aws/iam/account_alias/index.md delete mode 100644 docs/aws-docs/providers/aws/iam/account_aliases/index.md delete mode 100644 docs/aws-docs/providers/aws/iam/account_authorization_details/index.md delete mode 100644 docs/aws-docs/providers/aws/iam/account_password_policies/index.md delete mode 100644 docs/aws-docs/providers/aws/iam/account_summaries/index.md delete mode 100644 docs/aws-docs/providers/aws/iam/assume_role_policies/index.md delete mode 100644 docs/aws-docs/providers/aws/iam/attached_group_policies/index.md delete mode 100644 docs/aws-docs/providers/aws/iam/attached_role_policies/index.md delete mode 100644 docs/aws-docs/providers/aws/iam/attached_user_policies/index.md delete mode 100644 docs/aws-docs/providers/aws/iam/client_id_from_open_id_connect_providers/index.md delete mode 100644 docs/aws-docs/providers/aws/iam/context_keys_for_custom_policies/index.md delete mode 100644 docs/aws-docs/providers/aws/iam/context_keys_for_principal_policies/index.md delete mode 100644 docs/aws-docs/providers/aws/iam/credential_reports/index.md delete mode 100644 docs/aws-docs/providers/aws/iam/custom_policies/index.md delete mode 100644 docs/aws-docs/providers/aws/iam/default_policy_versions/index.md delete mode 100644 docs/aws-docs/providers/aws/iam/entities_for_policies/index.md create mode 100644 docs/aws-docs/providers/aws/iam/group/index.md create mode 100644 docs/aws-docs/providers/aws/iam/group_policy/index.md delete mode 100644 docs/aws-docs/providers/aws/iam/groups_for_users/index.md create mode 100644 docs/aws-docs/providers/aws/iam/instance_profile/index.md delete mode 100644 docs/aws-docs/providers/aws/iam/instance_profile_tags/index.md delete mode 100644 docs/aws-docs/providers/aws/iam/instance_profiles_for_roles/index.md delete mode 100644 docs/aws-docs/providers/aws/iam/login_profiles/index.md create mode 100644 docs/aws-docs/providers/aws/iam/managed_policies/index.md create mode 100644 docs/aws-docs/providers/aws/iam/managed_policy/index.md delete mode 100644 docs/aws-docs/providers/aws/iam/mfa_device_tags/index.md delete mode 100644 docs/aws-docs/providers/aws/iam/mfa_devices/index.md create mode 100644 docs/aws-docs/providers/aws/iam/oidc_provider/index.md create mode 100644 docs/aws-docs/providers/aws/iam/oidc_providers/index.md delete mode 100644 docs/aws-docs/providers/aws/iam/open_id_connect_provider_tags/index.md delete mode 100644 docs/aws-docs/providers/aws/iam/open_id_connect_provider_thumbprints/index.md delete mode 100644 docs/aws-docs/providers/aws/iam/open_id_connect_providers/index.md delete mode 100644 docs/aws-docs/providers/aws/iam/organizations_access_reports/index.md delete mode 100644 docs/aws-docs/providers/aws/iam/passwords/index.md delete mode 100644 docs/aws-docs/providers/aws/iam/policy_tags/index.md delete mode 100644 docs/aws-docs/providers/aws/iam/policy_versions/index.md delete mode 100644 docs/aws-docs/providers/aws/iam/principal_policies/index.md create mode 100644 docs/aws-docs/providers/aws/iam/role/index.md delete mode 100644 docs/aws-docs/providers/aws/iam/role_descriptions/index.md delete mode 100644 docs/aws-docs/providers/aws/iam/role_from_instance_profiles/index.md delete mode 100644 docs/aws-docs/providers/aws/iam/role_permissions_boundaries/index.md create mode 100644 docs/aws-docs/providers/aws/iam/role_policy/index.md delete mode 100644 docs/aws-docs/providers/aws/iam/role_tags/index.md delete mode 100644 docs/aws-docs/providers/aws/iam/role_to_instance_profiles/index.md create mode 100644 docs/aws-docs/providers/aws/iam/saml_provider/index.md delete mode 100644 docs/aws-docs/providers/aws/iam/saml_provider_tags/index.md delete mode 100644 docs/aws-docs/providers/aws/iam/security_token_service_preferences/index.md create mode 100644 docs/aws-docs/providers/aws/iam/server_certificate/index.md delete mode 100644 docs/aws-docs/providers/aws/iam/server_certificate_tags/index.md delete mode 100644 docs/aws-docs/providers/aws/iam/service_last_accessed_details/index.md delete mode 100644 docs/aws-docs/providers/aws/iam/service_last_accessed_details_with_entities/index.md create mode 100644 docs/aws-docs/providers/aws/iam/service_linked_role/index.md delete mode 100644 docs/aws-docs/providers/aws/iam/service_linked_role_deletion_status/index.md delete mode 100644 docs/aws-docs/providers/aws/iam/service_specific_credentials/index.md delete mode 100644 docs/aws-docs/providers/aws/iam/signing_certificates/index.md delete mode 100644 docs/aws-docs/providers/aws/iam/ssh_public_keys/index.md create mode 100644 docs/aws-docs/providers/aws/iam/user/index.md delete mode 100644 docs/aws-docs/providers/aws/iam/user_from_groups/index.md delete mode 100644 docs/aws-docs/providers/aws/iam/user_permissions_boundaries/index.md create mode 100644 docs/aws-docs/providers/aws/iam/user_policy/index.md delete mode 100644 docs/aws-docs/providers/aws/iam/user_tags/index.md delete mode 100644 docs/aws-docs/providers/aws/iam/user_to_groups/index.md delete mode 100644 docs/aws-docs/providers/aws/iam/virtual_mfa_devices/index.md create mode 100644 docs/aws-docs/providers/aws/iam/virtualmfa_device/index.md create mode 100644 docs/aws-docs/providers/aws/iam/virtualmfa_devices/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/access_key_last_useds/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/access_keys/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/account_alias/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/account_aliases/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/account_authorization_details/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/account_password_policies/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/account_summaries/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/assume_role_policies/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/attached_group_policies/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/attached_role_policies/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/attached_user_policies/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/client_id_from_open_id_connect_providers/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/context_keys_for_custom_policies/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/context_keys_for_principal_policies/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/credential_reports/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/custom_policies/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/default_policy_versions/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/entities_for_policies/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/group_policies/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/groups/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/groups_for_users/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/instance_profile_tags/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/instance_profiles/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/instance_profiles_for_roles/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/login_profiles/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/mfa_device_tags/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/mfa_devices/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/open_id_connect_provider_tags/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/open_id_connect_provider_thumbprints/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/open_id_connect_providers/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/organizations_access_reports/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/passwords/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/policies/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/policy_tags/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/policy_versions/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/principal_policies/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/role_descriptions/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/role_from_instance_profiles/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/role_permissions_boundaries/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/role_policies/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/role_tags/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/role_to_instance_profiles/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/roles/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/saml_provider_tags/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/saml_providers/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/security_token_service_preferences/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/server_certificate_tags/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/server_certificates/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/service_last_accessed_details/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/service_last_accessed_details_with_entities/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/service_linked_role_deletion_status/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/service_linked_roles/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/service_specific_credentials/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/signing_certificates/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/ssh_public_keys/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/user_from_groups/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/user_permissions_boundaries/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/user_policies/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/user_tags/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/user_to_groups/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/users/index.md create mode 100644 docs/aws-docs/providers/aws/iam_api/virtual_mfa_devices/index.md create mode 100644 docs/aws-docs/providers/aws/identitystore/group/index.md create mode 100644 docs/aws-docs/providers/aws/identitystore/group_membership/index.md create mode 100644 docs/aws-docs/providers/aws/identitystore/group_memberships/index.md create mode 100644 docs/aws-docs/providers/aws/identitystore/groups/index.md create mode 100644 docs/aws-docs/providers/aws/identitystore/index.md create mode 100644 docs/aws-docs/providers/aws/imagebuilder/component/index.md create mode 100644 docs/aws-docs/providers/aws/imagebuilder/components/index.md create mode 100644 docs/aws-docs/providers/aws/imagebuilder/container_recipe/index.md create mode 100644 docs/aws-docs/providers/aws/imagebuilder/container_recipes/index.md create mode 100644 docs/aws-docs/providers/aws/imagebuilder/distribution_configuration/index.md create mode 100644 docs/aws-docs/providers/aws/imagebuilder/distribution_configurations/index.md create mode 100644 docs/aws-docs/providers/aws/imagebuilder/image/index.md create mode 100644 docs/aws-docs/providers/aws/imagebuilder/image_pipeline/index.md create mode 100644 docs/aws-docs/providers/aws/imagebuilder/image_pipelines/index.md create mode 100644 docs/aws-docs/providers/aws/imagebuilder/image_recipe/index.md create mode 100644 docs/aws-docs/providers/aws/imagebuilder/image_recipes/index.md create mode 100644 docs/aws-docs/providers/aws/imagebuilder/images/index.md create mode 100644 docs/aws-docs/providers/aws/imagebuilder/index.md create mode 100644 docs/aws-docs/providers/aws/imagebuilder/infrastructure_configuration/index.md create mode 100644 docs/aws-docs/providers/aws/imagebuilder/infrastructure_configurations/index.md create mode 100644 docs/aws-docs/providers/aws/imagebuilder/lifecycle_policies/index.md create mode 100644 docs/aws-docs/providers/aws/imagebuilder/lifecycle_policy/index.md create mode 100644 docs/aws-docs/providers/aws/imagebuilder/workflow/index.md create mode 100644 docs/aws-docs/providers/aws/imagebuilder/workflows/index.md create mode 100644 docs/aws-docs/providers/aws/inspector/assessment_target/index.md create mode 100644 docs/aws-docs/providers/aws/inspector/assessment_targets/index.md create mode 100644 docs/aws-docs/providers/aws/inspector/assessment_template/index.md create mode 100644 docs/aws-docs/providers/aws/inspector/assessment_templates/index.md create mode 100644 docs/aws-docs/providers/aws/inspector/index.md create mode 100644 docs/aws-docs/providers/aws/inspector/resource_group/index.md create mode 100644 docs/aws-docs/providers/aws/inspector/resource_groups/index.md create mode 100644 docs/aws-docs/providers/aws/inspectorv2/cis_scan_configuration/index.md create mode 100644 docs/aws-docs/providers/aws/inspectorv2/cis_scan_configurations/index.md create mode 100644 docs/aws-docs/providers/aws/inspectorv2/filter/index.md create mode 100644 docs/aws-docs/providers/aws/inspectorv2/filters/index.md create mode 100644 docs/aws-docs/providers/aws/inspectorv2/index.md create mode 100644 docs/aws-docs/providers/aws/internetmonitor/index.md create mode 100644 docs/aws-docs/providers/aws/internetmonitor/monitor/index.md create mode 100644 docs/aws-docs/providers/aws/internetmonitor/monitors/index.md create mode 100644 docs/aws-docs/providers/aws/iot/account_audit_configuration/index.md create mode 100644 docs/aws-docs/providers/aws/iot/account_audit_configurations/index.md create mode 100644 docs/aws-docs/providers/aws/iot/authorizer/index.md create mode 100644 docs/aws-docs/providers/aws/iot/authorizers/index.md create mode 100644 docs/aws-docs/providers/aws/iot/billing_group/index.md create mode 100644 docs/aws-docs/providers/aws/iot/billing_groups/index.md create mode 100644 docs/aws-docs/providers/aws/iot/ca_certificate/index.md create mode 100644 docs/aws-docs/providers/aws/iot/ca_certificates/index.md create mode 100644 docs/aws-docs/providers/aws/iot/certificate/index.md create mode 100644 docs/aws-docs/providers/aws/iot/certificate_provider/index.md create mode 100644 docs/aws-docs/providers/aws/iot/certificate_providers/index.md create mode 100644 docs/aws-docs/providers/aws/iot/certificates/index.md create mode 100644 docs/aws-docs/providers/aws/iot/custom_metric/index.md create mode 100644 docs/aws-docs/providers/aws/iot/custom_metrics/index.md create mode 100644 docs/aws-docs/providers/aws/iot/dimension/index.md create mode 100644 docs/aws-docs/providers/aws/iot/dimensions/index.md create mode 100644 docs/aws-docs/providers/aws/iot/domain_configuration/index.md create mode 100644 docs/aws-docs/providers/aws/iot/domain_configurations/index.md create mode 100644 docs/aws-docs/providers/aws/iot/fleet_metric/index.md create mode 100644 docs/aws-docs/providers/aws/iot/fleet_metrics/index.md create mode 100644 docs/aws-docs/providers/aws/iot/index.md create mode 100644 docs/aws-docs/providers/aws/iot/job_template/index.md create mode 100644 docs/aws-docs/providers/aws/iot/job_templates/index.md create mode 100644 docs/aws-docs/providers/aws/iot/logging/index.md create mode 100644 docs/aws-docs/providers/aws/iot/loggings/index.md create mode 100644 docs/aws-docs/providers/aws/iot/mitigation_action/index.md create mode 100644 docs/aws-docs/providers/aws/iot/mitigation_actions/index.md create mode 100644 docs/aws-docs/providers/aws/iot/policies/index.md create mode 100644 docs/aws-docs/providers/aws/iot/policy/index.md create mode 100644 docs/aws-docs/providers/aws/iot/provisioning_template/index.md create mode 100644 docs/aws-docs/providers/aws/iot/provisioning_templates/index.md create mode 100644 docs/aws-docs/providers/aws/iot/resource_specific_logging/index.md create mode 100644 docs/aws-docs/providers/aws/iot/resource_specific_loggings/index.md create mode 100644 docs/aws-docs/providers/aws/iot/role_alias/index.md create mode 100644 docs/aws-docs/providers/aws/iot/role_aliases/index.md create mode 100644 docs/aws-docs/providers/aws/iot/scheduled_audit/index.md create mode 100644 docs/aws-docs/providers/aws/iot/scheduled_audits/index.md create mode 100644 docs/aws-docs/providers/aws/iot/security_profile/index.md create mode 100644 docs/aws-docs/providers/aws/iot/security_profiles/index.md create mode 100644 docs/aws-docs/providers/aws/iot/software_package/index.md create mode 100644 docs/aws-docs/providers/aws/iot/software_package_version/index.md create mode 100644 docs/aws-docs/providers/aws/iot/software_package_versions/index.md create mode 100644 docs/aws-docs/providers/aws/iot/software_packages/index.md create mode 100644 docs/aws-docs/providers/aws/iot/thing/index.md create mode 100644 docs/aws-docs/providers/aws/iot/thing_group/index.md create mode 100644 docs/aws-docs/providers/aws/iot/thing_groups/index.md create mode 100644 docs/aws-docs/providers/aws/iot/thing_type/index.md create mode 100644 docs/aws-docs/providers/aws/iot/thing_types/index.md create mode 100644 docs/aws-docs/providers/aws/iot/things/index.md create mode 100644 docs/aws-docs/providers/aws/iot/topic_rule/index.md create mode 100644 docs/aws-docs/providers/aws/iot/topic_rule_destination/index.md create mode 100644 docs/aws-docs/providers/aws/iot/topic_rule_destinations/index.md create mode 100644 docs/aws-docs/providers/aws/iot/topic_rules/index.md create mode 100644 docs/aws-docs/providers/aws/iotanalytics/dataset/index.md create mode 100644 docs/aws-docs/providers/aws/iotanalytics/datasets/index.md create mode 100644 docs/aws-docs/providers/aws/iotanalytics/index.md create mode 100644 docs/aws-docs/providers/aws/iotanalytics/pipeline/index.md create mode 100644 docs/aws-docs/providers/aws/iotanalytics/pipelines/index.md create mode 100644 docs/aws-docs/providers/aws/iotcoredeviceadvisor/index.md create mode 100644 docs/aws-docs/providers/aws/iotcoredeviceadvisor/suite_definition/index.md create mode 100644 docs/aws-docs/providers/aws/iotcoredeviceadvisor/suite_definitions/index.md create mode 100644 docs/aws-docs/providers/aws/iotevents/alarm_model/index.md create mode 100644 docs/aws-docs/providers/aws/iotevents/alarm_models/index.md create mode 100644 docs/aws-docs/providers/aws/iotevents/detector_model/index.md create mode 100644 docs/aws-docs/providers/aws/iotevents/detector_models/index.md create mode 100644 docs/aws-docs/providers/aws/iotevents/index.md create mode 100644 docs/aws-docs/providers/aws/iotevents/input/index.md create mode 100644 docs/aws-docs/providers/aws/iotevents/inputs/index.md create mode 100644 docs/aws-docs/providers/aws/iotfleethub/application/index.md create mode 100644 docs/aws-docs/providers/aws/iotfleethub/applications/index.md create mode 100644 docs/aws-docs/providers/aws/iotfleethub/index.md create mode 100644 docs/aws-docs/providers/aws/iotfleetwise/campaign/index.md create mode 100644 docs/aws-docs/providers/aws/iotfleetwise/campaigns/index.md create mode 100644 docs/aws-docs/providers/aws/iotfleetwise/decoder_manifest/index.md create mode 100644 docs/aws-docs/providers/aws/iotfleetwise/decoder_manifests/index.md create mode 100644 docs/aws-docs/providers/aws/iotfleetwise/fleet/index.md create mode 100644 docs/aws-docs/providers/aws/iotfleetwise/fleets/index.md create mode 100644 docs/aws-docs/providers/aws/iotfleetwise/index.md create mode 100644 docs/aws-docs/providers/aws/iotfleetwise/model_manifest/index.md create mode 100644 docs/aws-docs/providers/aws/iotfleetwise/model_manifests/index.md create mode 100644 docs/aws-docs/providers/aws/iotfleetwise/signal_catalog/index.md create mode 100644 docs/aws-docs/providers/aws/iotfleetwise/signal_catalogs/index.md create mode 100644 docs/aws-docs/providers/aws/iotfleetwise/vehicle/index.md create mode 100644 docs/aws-docs/providers/aws/iotfleetwise/vehicles/index.md create mode 100644 docs/aws-docs/providers/aws/iotsitewise/access_policies/index.md create mode 100644 docs/aws-docs/providers/aws/iotsitewise/access_policy/index.md create mode 100644 docs/aws-docs/providers/aws/iotsitewise/asset/index.md create mode 100644 docs/aws-docs/providers/aws/iotsitewise/asset_model/index.md create mode 100644 docs/aws-docs/providers/aws/iotsitewise/asset_models/index.md create mode 100644 docs/aws-docs/providers/aws/iotsitewise/assets/index.md create mode 100644 docs/aws-docs/providers/aws/iotsitewise/dashboard/index.md create mode 100644 docs/aws-docs/providers/aws/iotsitewise/dashboards/index.md create mode 100644 docs/aws-docs/providers/aws/iotsitewise/gateway/index.md create mode 100644 docs/aws-docs/providers/aws/iotsitewise/gateways/index.md create mode 100644 docs/aws-docs/providers/aws/iotsitewise/index.md create mode 100644 docs/aws-docs/providers/aws/iotsitewise/portal/index.md create mode 100644 docs/aws-docs/providers/aws/iotsitewise/portals/index.md create mode 100644 docs/aws-docs/providers/aws/iotsitewise/project/index.md create mode 100644 docs/aws-docs/providers/aws/iotsitewise/projects/index.md create mode 100644 docs/aws-docs/providers/aws/iottwinmaker/component_type/index.md create mode 100644 docs/aws-docs/providers/aws/iottwinmaker/component_types/index.md create mode 100644 docs/aws-docs/providers/aws/iottwinmaker/entities/index.md create mode 100644 docs/aws-docs/providers/aws/iottwinmaker/entity/index.md create mode 100644 docs/aws-docs/providers/aws/iottwinmaker/index.md create mode 100644 docs/aws-docs/providers/aws/iottwinmaker/scene/index.md create mode 100644 docs/aws-docs/providers/aws/iottwinmaker/scenes/index.md create mode 100644 docs/aws-docs/providers/aws/iottwinmaker/sync_job/index.md create mode 100644 docs/aws-docs/providers/aws/iottwinmaker/sync_jobs/index.md create mode 100644 docs/aws-docs/providers/aws/iottwinmaker/workspace/index.md create mode 100644 docs/aws-docs/providers/aws/iottwinmaker/workspaces/index.md create mode 100644 docs/aws-docs/providers/aws/iotwireless/destination/index.md create mode 100644 docs/aws-docs/providers/aws/iotwireless/destinations/index.md create mode 100644 docs/aws-docs/providers/aws/iotwireless/device_profile/index.md create mode 100644 docs/aws-docs/providers/aws/iotwireless/device_profiles/index.md create mode 100644 docs/aws-docs/providers/aws/iotwireless/fuota_task/index.md create mode 100644 docs/aws-docs/providers/aws/iotwireless/fuota_tasks/index.md create mode 100644 docs/aws-docs/providers/aws/iotwireless/index.md create mode 100644 docs/aws-docs/providers/aws/iotwireless/multicast_group/index.md create mode 100644 docs/aws-docs/providers/aws/iotwireless/multicast_groups/index.md create mode 100644 docs/aws-docs/providers/aws/iotwireless/network_analyzer_configuration/index.md create mode 100644 docs/aws-docs/providers/aws/iotwireless/network_analyzer_configurations/index.md create mode 100644 docs/aws-docs/providers/aws/iotwireless/partner_account/index.md create mode 100644 docs/aws-docs/providers/aws/iotwireless/partner_accounts/index.md create mode 100644 docs/aws-docs/providers/aws/iotwireless/service_profile/index.md create mode 100644 docs/aws-docs/providers/aws/iotwireless/service_profiles/index.md create mode 100644 docs/aws-docs/providers/aws/iotwireless/task_definition/index.md create mode 100644 docs/aws-docs/providers/aws/iotwireless/task_definitions/index.md create mode 100644 docs/aws-docs/providers/aws/iotwireless/wireless_device/index.md create mode 100644 docs/aws-docs/providers/aws/iotwireless/wireless_device_import_task/index.md create mode 100644 docs/aws-docs/providers/aws/iotwireless/wireless_device_import_tasks/index.md create mode 100644 docs/aws-docs/providers/aws/iotwireless/wireless_devices/index.md create mode 100644 docs/aws-docs/providers/aws/iotwireless/wireless_gateway/index.md create mode 100644 docs/aws-docs/providers/aws/iotwireless/wireless_gateways/index.md create mode 100644 docs/aws-docs/providers/aws/ivs/channel/index.md create mode 100644 docs/aws-docs/providers/aws/ivs/channels/index.md create mode 100644 docs/aws-docs/providers/aws/ivs/encoder_configuration/index.md create mode 100644 docs/aws-docs/providers/aws/ivs/encoder_configurations/index.md create mode 100644 docs/aws-docs/providers/aws/ivs/index.md create mode 100644 docs/aws-docs/providers/aws/ivs/playback_key_pair/index.md create mode 100644 docs/aws-docs/providers/aws/ivs/playback_key_pairs/index.md create mode 100644 docs/aws-docs/providers/aws/ivs/playback_restriction_policies/index.md create mode 100644 docs/aws-docs/providers/aws/ivs/playback_restriction_policy/index.md create mode 100644 docs/aws-docs/providers/aws/ivs/recording_configuration/index.md create mode 100644 docs/aws-docs/providers/aws/ivs/recording_configurations/index.md create mode 100644 docs/aws-docs/providers/aws/ivs/stage/index.md create mode 100644 docs/aws-docs/providers/aws/ivs/stages/index.md create mode 100644 docs/aws-docs/providers/aws/ivs/storage_configuration/index.md create mode 100644 docs/aws-docs/providers/aws/ivs/storage_configurations/index.md create mode 100644 docs/aws-docs/providers/aws/ivs/stream_key/index.md create mode 100644 docs/aws-docs/providers/aws/ivs/stream_keys/index.md create mode 100644 docs/aws-docs/providers/aws/ivschat/index.md create mode 100644 docs/aws-docs/providers/aws/ivschat/logging_configuration/index.md create mode 100644 docs/aws-docs/providers/aws/ivschat/logging_configurations/index.md create mode 100644 docs/aws-docs/providers/aws/ivschat/room/index.md create mode 100644 docs/aws-docs/providers/aws/ivschat/rooms/index.md create mode 100644 docs/aws-docs/providers/aws/kafkaconnect/connector/index.md create mode 100644 docs/aws-docs/providers/aws/kafkaconnect/connectors/index.md create mode 100644 docs/aws-docs/providers/aws/kafkaconnect/custom_plugin/index.md create mode 100644 docs/aws-docs/providers/aws/kafkaconnect/custom_plugins/index.md create mode 100644 docs/aws-docs/providers/aws/kafkaconnect/index.md create mode 100644 docs/aws-docs/providers/aws/kafkaconnect/worker_configuration/index.md create mode 100644 docs/aws-docs/providers/aws/kafkaconnect/worker_configurations/index.md create mode 100644 docs/aws-docs/providers/aws/kendra/data_source/index.md create mode 100644 docs/aws-docs/providers/aws/kendra/data_sources/index.md create mode 100644 docs/aws-docs/providers/aws/kendra/faq/index.md create mode 100644 docs/aws-docs/providers/aws/kendra/faqs/index.md create mode 100644 docs/aws-docs/providers/aws/kendra/index.md create mode 100644 docs/aws-docs/providers/aws/kendra/index/index.md create mode 100644 docs/aws-docs/providers/aws/kendra/indices/index.md create mode 100644 docs/aws-docs/providers/aws/kendraranking/execution_plan/index.md create mode 100644 docs/aws-docs/providers/aws/kendraranking/execution_plans/index.md create mode 100644 docs/aws-docs/providers/aws/kendraranking/index.md create mode 100644 docs/aws-docs/providers/aws/kinesis/index.md create mode 100644 docs/aws-docs/providers/aws/kinesis/kinesis_stream/index.md create mode 100644 docs/aws-docs/providers/aws/kinesis/streams/index.md create mode 100644 docs/aws-docs/providers/aws/kinesisanalyticsv2/application/index.md create mode 100644 docs/aws-docs/providers/aws/kinesisanalyticsv2/applications/index.md create mode 100644 docs/aws-docs/providers/aws/kinesisanalyticsv2/index.md create mode 100644 docs/aws-docs/providers/aws/kinesisfirehose/delivery_stream/index.md create mode 100644 docs/aws-docs/providers/aws/kinesisfirehose/delivery_streams/index.md create mode 100644 docs/aws-docs/providers/aws/kinesisfirehose/index.md create mode 100644 docs/aws-docs/providers/aws/kinesisvideo/index.md create mode 100644 docs/aws-docs/providers/aws/kinesisvideo/kinesisvideo_stream/index.md create mode 100644 docs/aws-docs/providers/aws/kinesisvideo/signaling_channel/index.md create mode 100644 docs/aws-docs/providers/aws/kinesisvideo/signaling_channels/index.md create mode 100644 docs/aws-docs/providers/aws/kinesisvideo/streams/index.md create mode 100644 docs/aws-docs/providers/aws/kms/alias/index.md create mode 100644 docs/aws-docs/providers/aws/kms/aliases/index.md create mode 100644 docs/aws-docs/providers/aws/kms/index.md create mode 100644 docs/aws-docs/providers/aws/kms/key/index.md create mode 100644 docs/aws-docs/providers/aws/kms/keys/index.md create mode 100644 docs/aws-docs/providers/aws/kms/replica_key/index.md create mode 100644 docs/aws-docs/providers/aws/kms/replica_keys/index.md create mode 100644 docs/aws-docs/providers/aws/lakeformation/data_cells_filter/index.md create mode 100644 docs/aws-docs/providers/aws/lakeformation/data_cells_filters/index.md create mode 100644 docs/aws-docs/providers/aws/lakeformation/index.md create mode 100644 docs/aws-docs/providers/aws/lakeformation/principal_permissions/index.md create mode 100644 docs/aws-docs/providers/aws/lakeformation/tag/index.md create mode 100644 docs/aws-docs/providers/aws/lakeformation/tag_association/index.md create mode 100644 docs/aws-docs/providers/aws/lakeformation/tag_associations/index.md create mode 100644 docs/aws-docs/providers/aws/lakeformation/tags/index.md create mode 100644 docs/aws-docs/providers/aws/lambda/code_signing_config/index.md create mode 100644 docs/aws-docs/providers/aws/lambda/code_signing_configs/index.md create mode 100644 docs/aws-docs/providers/aws/lambda/event_invoke_config/index.md create mode 100644 docs/aws-docs/providers/aws/lambda/event_invoke_configs/index.md create mode 100644 docs/aws-docs/providers/aws/lambda/event_source_mapping/index.md create mode 100644 docs/aws-docs/providers/aws/lambda/event_source_mappings/index.md create mode 100644 docs/aws-docs/providers/aws/lambda/function/index.md create mode 100644 docs/aws-docs/providers/aws/lambda/functions/index.md create mode 100644 docs/aws-docs/providers/aws/lambda/index.md create mode 100644 docs/aws-docs/providers/aws/lambda/layer_version/index.md create mode 100644 docs/aws-docs/providers/aws/lambda/layer_version_permission/index.md create mode 100644 docs/aws-docs/providers/aws/lambda/layer_version_permissions/index.md create mode 100644 docs/aws-docs/providers/aws/lambda/layer_versions/index.md create mode 100644 docs/aws-docs/providers/aws/lambda/permission/index.md create mode 100644 docs/aws-docs/providers/aws/lambda/permissions/index.md create mode 100644 docs/aws-docs/providers/aws/lambda/url/index.md create mode 100644 docs/aws-docs/providers/aws/lambda/urls/index.md create mode 100644 docs/aws-docs/providers/aws/lambda/version/index.md create mode 100644 docs/aws-docs/providers/aws/lambda/versions/index.md create mode 100644 docs/aws-docs/providers/aws/lex/bot/index.md create mode 100644 docs/aws-docs/providers/aws/lex/bot_alias/index.md create mode 100644 docs/aws-docs/providers/aws/lex/bot_aliases/index.md create mode 100644 docs/aws-docs/providers/aws/lex/bot_version/index.md create mode 100644 docs/aws-docs/providers/aws/lex/bot_versions/index.md create mode 100644 docs/aws-docs/providers/aws/lex/bots/index.md create mode 100644 docs/aws-docs/providers/aws/lex/index.md create mode 100644 docs/aws-docs/providers/aws/lex/resource_policies/index.md create mode 100644 docs/aws-docs/providers/aws/lex/resource_policy/index.md create mode 100644 docs/aws-docs/providers/aws/licensemanager/grant/index.md create mode 100644 docs/aws-docs/providers/aws/licensemanager/grants/index.md create mode 100644 docs/aws-docs/providers/aws/licensemanager/index.md create mode 100644 docs/aws-docs/providers/aws/licensemanager/license/index.md create mode 100644 docs/aws-docs/providers/aws/licensemanager/licenses/index.md create mode 100644 docs/aws-docs/providers/aws/lightsail/alarm/index.md create mode 100644 docs/aws-docs/providers/aws/lightsail/alarms/index.md create mode 100644 docs/aws-docs/providers/aws/lightsail/bucket/index.md create mode 100644 docs/aws-docs/providers/aws/lightsail/buckets/index.md create mode 100644 docs/aws-docs/providers/aws/lightsail/certificate/index.md create mode 100644 docs/aws-docs/providers/aws/lightsail/certificates/index.md create mode 100644 docs/aws-docs/providers/aws/lightsail/container/index.md create mode 100644 docs/aws-docs/providers/aws/lightsail/containers/index.md create mode 100644 docs/aws-docs/providers/aws/lightsail/database/index.md create mode 100644 docs/aws-docs/providers/aws/lightsail/databases/index.md create mode 100644 docs/aws-docs/providers/aws/lightsail/distribution/index.md create mode 100644 docs/aws-docs/providers/aws/lightsail/distributions/index.md create mode 100644 docs/aws-docs/providers/aws/lightsail/index.md create mode 100644 docs/aws-docs/providers/aws/lightsail/instance/index.md create mode 100644 docs/aws-docs/providers/aws/lightsail/instances/index.md create mode 100644 docs/aws-docs/providers/aws/lightsail/load_balancer/index.md create mode 100644 docs/aws-docs/providers/aws/lightsail/load_balancer_tls_certificate/index.md create mode 100644 docs/aws-docs/providers/aws/lightsail/load_balancer_tls_certificates/index.md create mode 100644 docs/aws-docs/providers/aws/lightsail/load_balancers/index.md create mode 100644 docs/aws-docs/providers/aws/lightsail/static_ip/index.md create mode 100644 docs/aws-docs/providers/aws/lightsail/static_ips/index.md create mode 100644 docs/aws-docs/providers/aws/location/api_key/index.md create mode 100644 docs/aws-docs/providers/aws/location/api_keys/index.md create mode 100644 docs/aws-docs/providers/aws/location/geofence_collection/index.md create mode 100644 docs/aws-docs/providers/aws/location/geofence_collections/index.md create mode 100644 docs/aws-docs/providers/aws/location/index.md create mode 100644 docs/aws-docs/providers/aws/location/map/index.md create mode 100644 docs/aws-docs/providers/aws/location/maps/index.md create mode 100644 docs/aws-docs/providers/aws/location/place_index/index.md create mode 100644 docs/aws-docs/providers/aws/location/place_indices/index.md create mode 100644 docs/aws-docs/providers/aws/location/route_calculator/index.md create mode 100644 docs/aws-docs/providers/aws/location/route_calculators/index.md create mode 100644 docs/aws-docs/providers/aws/location/tracker/index.md create mode 100644 docs/aws-docs/providers/aws/location/tracker_consumer/index.md create mode 100644 docs/aws-docs/providers/aws/location/tracker_consumers/index.md create mode 100644 docs/aws-docs/providers/aws/location/trackers/index.md create mode 100644 docs/aws-docs/providers/aws/logs/account_policies/index.md create mode 100644 docs/aws-docs/providers/aws/logs/account_policy/index.md create mode 100644 docs/aws-docs/providers/aws/logs/deliveries/index.md create mode 100644 docs/aws-docs/providers/aws/logs/delivery/index.md create mode 100644 docs/aws-docs/providers/aws/logs/delivery_destination/index.md create mode 100644 docs/aws-docs/providers/aws/logs/delivery_destinations/index.md create mode 100644 docs/aws-docs/providers/aws/logs/delivery_source/index.md create mode 100644 docs/aws-docs/providers/aws/logs/delivery_sources/index.md create mode 100644 docs/aws-docs/providers/aws/logs/destination/index.md create mode 100644 docs/aws-docs/providers/aws/logs/destinations/index.md create mode 100644 docs/aws-docs/providers/aws/logs/index.md create mode 100644 docs/aws-docs/providers/aws/logs/log_anomaly_detector/index.md create mode 100644 docs/aws-docs/providers/aws/logs/log_anomaly_detectors/index.md create mode 100644 docs/aws-docs/providers/aws/logs/log_stream/index.md create mode 100644 docs/aws-docs/providers/aws/logs/log_streams/index.md create mode 100644 docs/aws-docs/providers/aws/logs/metric_filter/index.md create mode 100644 docs/aws-docs/providers/aws/logs/metric_filters/index.md create mode 100644 docs/aws-docs/providers/aws/logs/query_definition/index.md create mode 100644 docs/aws-docs/providers/aws/logs/query_definitions/index.md create mode 100644 docs/aws-docs/providers/aws/logs/resource_policies/index.md create mode 100644 docs/aws-docs/providers/aws/logs/resource_policy/index.md create mode 100644 docs/aws-docs/providers/aws/logs/subscription_filter/index.md create mode 100644 docs/aws-docs/providers/aws/logs/subscription_filters/index.md create mode 100644 docs/aws-docs/providers/aws/lookoutequipment/index.md create mode 100644 docs/aws-docs/providers/aws/lookoutequipment/inference_scheduler/index.md create mode 100644 docs/aws-docs/providers/aws/lookoutequipment/inference_schedulers/index.md create mode 100644 docs/aws-docs/providers/aws/lookoutmetrics/alert/index.md create mode 100644 docs/aws-docs/providers/aws/lookoutmetrics/alerts/index.md create mode 100644 docs/aws-docs/providers/aws/lookoutmetrics/anomaly_detector/index.md create mode 100644 docs/aws-docs/providers/aws/lookoutmetrics/anomaly_detectors/index.md create mode 100644 docs/aws-docs/providers/aws/lookoutmetrics/index.md create mode 100644 docs/aws-docs/providers/aws/lookoutvision/index.md create mode 100644 docs/aws-docs/providers/aws/lookoutvision/project/index.md create mode 100644 docs/aws-docs/providers/aws/lookoutvision/projects/index.md create mode 100644 docs/aws-docs/providers/aws/m2/application/index.md create mode 100644 docs/aws-docs/providers/aws/m2/applications/index.md create mode 100644 docs/aws-docs/providers/aws/m2/environment/index.md create mode 100644 docs/aws-docs/providers/aws/m2/environments/index.md create mode 100644 docs/aws-docs/providers/aws/m2/index.md create mode 100644 docs/aws-docs/providers/aws/macie/allow_list/index.md create mode 100644 docs/aws-docs/providers/aws/macie/allow_lists/index.md create mode 100644 docs/aws-docs/providers/aws/macie/custom_data_identifier/index.md create mode 100644 docs/aws-docs/providers/aws/macie/custom_data_identifiers/index.md create mode 100644 docs/aws-docs/providers/aws/macie/findings_filter/index.md create mode 100644 docs/aws-docs/providers/aws/macie/findings_filters/index.md create mode 100644 docs/aws-docs/providers/aws/macie/index.md create mode 100644 docs/aws-docs/providers/aws/macie/session/index.md create mode 100644 docs/aws-docs/providers/aws/macie/sessions/index.md create mode 100644 docs/aws-docs/providers/aws/managedblockchain/accessor/index.md create mode 100644 docs/aws-docs/providers/aws/managedblockchain/accessors/index.md create mode 100644 docs/aws-docs/providers/aws/managedblockchain/index.md create mode 100644 docs/aws-docs/providers/aws/mediaconnect/bridge/index.md create mode 100644 docs/aws-docs/providers/aws/mediaconnect/bridge_output/index.md create mode 100644 docs/aws-docs/providers/aws/mediaconnect/bridge_outputs/index.md create mode 100644 docs/aws-docs/providers/aws/mediaconnect/bridge_source/index.md create mode 100644 docs/aws-docs/providers/aws/mediaconnect/bridge_sources/index.md create mode 100644 docs/aws-docs/providers/aws/mediaconnect/bridges/index.md create mode 100644 docs/aws-docs/providers/aws/mediaconnect/flow/index.md create mode 100644 docs/aws-docs/providers/aws/mediaconnect/flow_entitlement/index.md create mode 100644 docs/aws-docs/providers/aws/mediaconnect/flow_entitlements/index.md create mode 100644 docs/aws-docs/providers/aws/mediaconnect/flow_output/index.md create mode 100644 docs/aws-docs/providers/aws/mediaconnect/flow_outputs/index.md create mode 100644 docs/aws-docs/providers/aws/mediaconnect/flow_source/index.md create mode 100644 docs/aws-docs/providers/aws/mediaconnect/flow_sources/index.md create mode 100644 docs/aws-docs/providers/aws/mediaconnect/flow_vpc_interface/index.md create mode 100644 docs/aws-docs/providers/aws/mediaconnect/flow_vpc_interfaces/index.md create mode 100644 docs/aws-docs/providers/aws/mediaconnect/flows/index.md create mode 100644 docs/aws-docs/providers/aws/mediaconnect/gateway/index.md create mode 100644 docs/aws-docs/providers/aws/mediaconnect/gateways/index.md create mode 100644 docs/aws-docs/providers/aws/mediaconnect/index.md create mode 100644 docs/aws-docs/providers/aws/medialive/index.md create mode 100644 docs/aws-docs/providers/aws/medialive/multiplex/index.md create mode 100644 docs/aws-docs/providers/aws/medialive/multiplexes/index.md create mode 100644 docs/aws-docs/providers/aws/medialive/multiplexprogram/index.md create mode 100644 docs/aws-docs/providers/aws/medialive/multiplexprograms/index.md create mode 100644 docs/aws-docs/providers/aws/mediapackage/asset/index.md create mode 100644 docs/aws-docs/providers/aws/mediapackage/assets/index.md create mode 100644 docs/aws-docs/providers/aws/mediapackage/channel/index.md create mode 100644 docs/aws-docs/providers/aws/mediapackage/channels/index.md create mode 100644 docs/aws-docs/providers/aws/mediapackage/index.md create mode 100644 docs/aws-docs/providers/aws/mediapackage/origin_endpoint/index.md create mode 100644 docs/aws-docs/providers/aws/mediapackage/origin_endpoints/index.md create mode 100644 docs/aws-docs/providers/aws/mediapackage/packaging_configuration/index.md create mode 100644 docs/aws-docs/providers/aws/mediapackage/packaging_configurations/index.md create mode 100644 docs/aws-docs/providers/aws/mediapackage/packaging_group/index.md create mode 100644 docs/aws-docs/providers/aws/mediapackage/packaging_groups/index.md create mode 100644 docs/aws-docs/providers/aws/mediapackagev2/channel/index.md create mode 100644 docs/aws-docs/providers/aws/mediapackagev2/channel_group/index.md create mode 100644 docs/aws-docs/providers/aws/mediapackagev2/channel_groups/index.md create mode 100644 docs/aws-docs/providers/aws/mediapackagev2/channel_policies/index.md create mode 100644 docs/aws-docs/providers/aws/mediapackagev2/channel_policy/index.md create mode 100644 docs/aws-docs/providers/aws/mediapackagev2/channels/index.md create mode 100644 docs/aws-docs/providers/aws/mediapackagev2/index.md create mode 100644 docs/aws-docs/providers/aws/mediapackagev2/origin_endpoint/index.md create mode 100644 docs/aws-docs/providers/aws/mediapackagev2/origin_endpoint_policies/index.md create mode 100644 docs/aws-docs/providers/aws/mediapackagev2/origin_endpoint_policy/index.md create mode 100644 docs/aws-docs/providers/aws/mediapackagev2/origin_endpoints/index.md create mode 100644 docs/aws-docs/providers/aws/mediatailor/channel/index.md create mode 100644 docs/aws-docs/providers/aws/mediatailor/channel_policies/index.md create mode 100644 docs/aws-docs/providers/aws/mediatailor/channel_policy/index.md create mode 100644 docs/aws-docs/providers/aws/mediatailor/channels/index.md create mode 100644 docs/aws-docs/providers/aws/mediatailor/index.md create mode 100644 docs/aws-docs/providers/aws/mediatailor/live_source/index.md create mode 100644 docs/aws-docs/providers/aws/mediatailor/live_sources/index.md create mode 100644 docs/aws-docs/providers/aws/mediatailor/playback_configuration/index.md create mode 100644 docs/aws-docs/providers/aws/mediatailor/playback_configurations/index.md create mode 100644 docs/aws-docs/providers/aws/mediatailor/source_location/index.md create mode 100644 docs/aws-docs/providers/aws/mediatailor/source_locations/index.md create mode 100644 docs/aws-docs/providers/aws/mediatailor/vod_source/index.md create mode 100644 docs/aws-docs/providers/aws/mediatailor/vod_sources/index.md create mode 100644 docs/aws-docs/providers/aws/memorydb/acl/index.md create mode 100644 docs/aws-docs/providers/aws/memorydb/acls/index.md create mode 100644 docs/aws-docs/providers/aws/memorydb/cluster/index.md create mode 100644 docs/aws-docs/providers/aws/memorydb/clusters/index.md create mode 100644 docs/aws-docs/providers/aws/memorydb/index.md create mode 100644 docs/aws-docs/providers/aws/memorydb/parameter_group/index.md create mode 100644 docs/aws-docs/providers/aws/memorydb/parameter_groups/index.md create mode 100644 docs/aws-docs/providers/aws/memorydb/subnet_group/index.md create mode 100644 docs/aws-docs/providers/aws/memorydb/subnet_groups/index.md create mode 100644 docs/aws-docs/providers/aws/memorydb/user/index.md create mode 100644 docs/aws-docs/providers/aws/memorydb/users/index.md create mode 100644 docs/aws-docs/providers/aws/msk/batch_scram_secret/index.md create mode 100644 docs/aws-docs/providers/aws/msk/batch_scram_secrets/index.md create mode 100644 docs/aws-docs/providers/aws/msk/cluster/index.md create mode 100644 docs/aws-docs/providers/aws/msk/cluster_policies/index.md create mode 100644 docs/aws-docs/providers/aws/msk/cluster_policy/index.md create mode 100644 docs/aws-docs/providers/aws/msk/clusters/index.md create mode 100644 docs/aws-docs/providers/aws/msk/configuration/index.md create mode 100644 docs/aws-docs/providers/aws/msk/configurations/index.md create mode 100644 docs/aws-docs/providers/aws/msk/index.md create mode 100644 docs/aws-docs/providers/aws/msk/replicator/index.md create mode 100644 docs/aws-docs/providers/aws/msk/replicators/index.md create mode 100644 docs/aws-docs/providers/aws/msk/serverless_cluster/index.md create mode 100644 docs/aws-docs/providers/aws/msk/serverless_clusters/index.md create mode 100644 docs/aws-docs/providers/aws/msk/vpc_connection/index.md create mode 100644 docs/aws-docs/providers/aws/msk/vpc_connections/index.md create mode 100644 docs/aws-docs/providers/aws/mwaa/environment/index.md create mode 100644 docs/aws-docs/providers/aws/mwaa/environments/index.md create mode 100644 docs/aws-docs/providers/aws/mwaa/index.md create mode 100644 docs/aws-docs/providers/aws/neptune/db_cluster/index.md create mode 100644 docs/aws-docs/providers/aws/neptune/db_clusters/index.md create mode 100644 docs/aws-docs/providers/aws/neptune/index.md create mode 100644 docs/aws-docs/providers/aws/neptunegraph/graph/index.md create mode 100644 docs/aws-docs/providers/aws/neptunegraph/graphs/index.md create mode 100644 docs/aws-docs/providers/aws/neptunegraph/index.md create mode 100644 docs/aws-docs/providers/aws/neptunegraph/private_graph_endpoint/index.md create mode 100644 docs/aws-docs/providers/aws/neptunegraph/private_graph_endpoints/index.md create mode 100644 docs/aws-docs/providers/aws/networkfirewall/firewall/index.md create mode 100644 docs/aws-docs/providers/aws/networkfirewall/firewall_policies/index.md create mode 100644 docs/aws-docs/providers/aws/networkfirewall/firewall_policy/index.md create mode 100644 docs/aws-docs/providers/aws/networkfirewall/firewalls/index.md create mode 100644 docs/aws-docs/providers/aws/networkfirewall/index.md create mode 100644 docs/aws-docs/providers/aws/networkfirewall/logging_configuration/index.md create mode 100644 docs/aws-docs/providers/aws/networkfirewall/logging_configurations/index.md create mode 100644 docs/aws-docs/providers/aws/networkfirewall/rule_group/index.md create mode 100644 docs/aws-docs/providers/aws/networkfirewall/rule_groups/index.md create mode 100644 docs/aws-docs/providers/aws/networkfirewall/tls_inspection_configuration/index.md create mode 100644 docs/aws-docs/providers/aws/networkfirewall/tls_inspection_configurations/index.md create mode 100644 docs/aws-docs/providers/aws/networkmanager/connect_attachment/index.md create mode 100644 docs/aws-docs/providers/aws/networkmanager/connect_attachments/index.md create mode 100644 docs/aws-docs/providers/aws/networkmanager/connect_peer/index.md create mode 100644 docs/aws-docs/providers/aws/networkmanager/connect_peers/index.md create mode 100644 docs/aws-docs/providers/aws/networkmanager/core_network/index.md create mode 100644 docs/aws-docs/providers/aws/networkmanager/core_networks/index.md create mode 100644 docs/aws-docs/providers/aws/networkmanager/customer_gateway_association/index.md create mode 100644 docs/aws-docs/providers/aws/networkmanager/customer_gateway_associations/index.md create mode 100644 docs/aws-docs/providers/aws/networkmanager/device/index.md create mode 100644 docs/aws-docs/providers/aws/networkmanager/devices/index.md create mode 100644 docs/aws-docs/providers/aws/networkmanager/global_network/index.md create mode 100644 docs/aws-docs/providers/aws/networkmanager/global_networks/index.md create mode 100644 docs/aws-docs/providers/aws/networkmanager/index.md create mode 100644 docs/aws-docs/providers/aws/networkmanager/link/index.md create mode 100644 docs/aws-docs/providers/aws/networkmanager/link_association/index.md create mode 100644 docs/aws-docs/providers/aws/networkmanager/link_associations/index.md create mode 100644 docs/aws-docs/providers/aws/networkmanager/links/index.md create mode 100644 docs/aws-docs/providers/aws/networkmanager/site/index.md create mode 100644 docs/aws-docs/providers/aws/networkmanager/site_to_site_vpn_attachment/index.md create mode 100644 docs/aws-docs/providers/aws/networkmanager/site_to_site_vpn_attachments/index.md create mode 100644 docs/aws-docs/providers/aws/networkmanager/sites/index.md create mode 100644 docs/aws-docs/providers/aws/networkmanager/transit_gateway_peering/index.md create mode 100644 docs/aws-docs/providers/aws/networkmanager/transit_gateway_peerings/index.md create mode 100644 docs/aws-docs/providers/aws/networkmanager/transit_gateway_registration/index.md create mode 100644 docs/aws-docs/providers/aws/networkmanager/transit_gateway_registrations/index.md create mode 100644 docs/aws-docs/providers/aws/networkmanager/transit_gateway_route_table_attachment/index.md create mode 100644 docs/aws-docs/providers/aws/networkmanager/transit_gateway_route_table_attachments/index.md create mode 100644 docs/aws-docs/providers/aws/networkmanager/vpc_attachment/index.md create mode 100644 docs/aws-docs/providers/aws/networkmanager/vpc_attachments/index.md create mode 100644 docs/aws-docs/providers/aws/nimblestudio/index.md create mode 100644 docs/aws-docs/providers/aws/nimblestudio/launch_profile/index.md create mode 100644 docs/aws-docs/providers/aws/nimblestudio/launch_profiles/index.md create mode 100644 docs/aws-docs/providers/aws/nimblestudio/streaming_image/index.md create mode 100644 docs/aws-docs/providers/aws/nimblestudio/streaming_images/index.md create mode 100644 docs/aws-docs/providers/aws/nimblestudio/studio/index.md create mode 100644 docs/aws-docs/providers/aws/nimblestudio/studio_component/index.md create mode 100644 docs/aws-docs/providers/aws/nimblestudio/studio_components/index.md create mode 100644 docs/aws-docs/providers/aws/nimblestudio/studios/index.md create mode 100644 docs/aws-docs/providers/aws/oam/index.md create mode 100644 docs/aws-docs/providers/aws/oam/link/index.md create mode 100644 docs/aws-docs/providers/aws/oam/links/index.md create mode 100644 docs/aws-docs/providers/aws/oam/sink/index.md create mode 100644 docs/aws-docs/providers/aws/oam/sinks/index.md create mode 100644 docs/aws-docs/providers/aws/omics/annotation_store/index.md create mode 100644 docs/aws-docs/providers/aws/omics/annotation_stores/index.md create mode 100644 docs/aws-docs/providers/aws/omics/index.md create mode 100644 docs/aws-docs/providers/aws/omics/reference_store/index.md create mode 100644 docs/aws-docs/providers/aws/omics/reference_stores/index.md create mode 100644 docs/aws-docs/providers/aws/omics/run_group/index.md create mode 100644 docs/aws-docs/providers/aws/omics/run_groups/index.md create mode 100644 docs/aws-docs/providers/aws/omics/sequence_store/index.md create mode 100644 docs/aws-docs/providers/aws/omics/sequence_stores/index.md create mode 100644 docs/aws-docs/providers/aws/omics/variant_store/index.md create mode 100644 docs/aws-docs/providers/aws/omics/variant_stores/index.md create mode 100644 docs/aws-docs/providers/aws/omics/workflow/index.md create mode 100644 docs/aws-docs/providers/aws/omics/workflows/index.md create mode 100644 docs/aws-docs/providers/aws/opensearchserverless/access_policies/index.md create mode 100644 docs/aws-docs/providers/aws/opensearchserverless/access_policy/index.md create mode 100644 docs/aws-docs/providers/aws/opensearchserverless/collection/index.md create mode 100644 docs/aws-docs/providers/aws/opensearchserverless/collections/index.md create mode 100644 docs/aws-docs/providers/aws/opensearchserverless/index.md create mode 100644 docs/aws-docs/providers/aws/opensearchserverless/lifecycle_policies/index.md create mode 100644 docs/aws-docs/providers/aws/opensearchserverless/lifecycle_policy/index.md create mode 100644 docs/aws-docs/providers/aws/opensearchserverless/security_config/index.md create mode 100644 docs/aws-docs/providers/aws/opensearchserverless/security_configs/index.md create mode 100644 docs/aws-docs/providers/aws/opensearchserverless/security_policies/index.md create mode 100644 docs/aws-docs/providers/aws/opensearchserverless/security_policy/index.md create mode 100644 docs/aws-docs/providers/aws/opensearchserverless/vpc_endpoint/index.md create mode 100644 docs/aws-docs/providers/aws/opensearchserverless/vpc_endpoints/index.md create mode 100644 docs/aws-docs/providers/aws/opensearchservice/domain/index.md create mode 100644 docs/aws-docs/providers/aws/opensearchservice/domains/index.md create mode 100644 docs/aws-docs/providers/aws/opensearchservice/index.md create mode 100644 docs/aws-docs/providers/aws/opsworkscm/index.md create mode 100644 docs/aws-docs/providers/aws/opsworkscm/server/index.md create mode 100644 docs/aws-docs/providers/aws/opsworkscm/servers/index.md create mode 100644 docs/aws-docs/providers/aws/organizations/account/index.md create mode 100644 docs/aws-docs/providers/aws/organizations/accounts/index.md create mode 100644 docs/aws-docs/providers/aws/organizations/index.md create mode 100644 docs/aws-docs/providers/aws/organizations/organization/index.md create mode 100644 docs/aws-docs/providers/aws/organizations/organizational_unit/index.md create mode 100644 docs/aws-docs/providers/aws/organizations/organizational_units/index.md create mode 100644 docs/aws-docs/providers/aws/organizations/organizations/index.md create mode 100644 docs/aws-docs/providers/aws/organizations/policies/index.md create mode 100644 docs/aws-docs/providers/aws/organizations/policy/index.md create mode 100644 docs/aws-docs/providers/aws/organizations/resource_policies/index.md create mode 100644 docs/aws-docs/providers/aws/organizations/resource_policy/index.md create mode 100644 docs/aws-docs/providers/aws/osis/index.md create mode 100644 docs/aws-docs/providers/aws/osis/pipeline/index.md create mode 100644 docs/aws-docs/providers/aws/osis/pipelines/index.md create mode 100644 docs/aws-docs/providers/aws/panorama/application_instance/index.md create mode 100644 docs/aws-docs/providers/aws/panorama/application_instances/index.md create mode 100644 docs/aws-docs/providers/aws/panorama/index.md create mode 100644 docs/aws-docs/providers/aws/panorama/package/index.md create mode 100644 docs/aws-docs/providers/aws/panorama/package_version/index.md create mode 100644 docs/aws-docs/providers/aws/panorama/package_versions/index.md create mode 100644 docs/aws-docs/providers/aws/panorama/packages/index.md create mode 100644 docs/aws-docs/providers/aws/pcaconnectorad/connector/index.md create mode 100644 docs/aws-docs/providers/aws/pcaconnectorad/connectors/index.md create mode 100644 docs/aws-docs/providers/aws/pcaconnectorad/directory_registration/index.md create mode 100644 docs/aws-docs/providers/aws/pcaconnectorad/directory_registrations/index.md create mode 100644 docs/aws-docs/providers/aws/pcaconnectorad/index.md create mode 100644 docs/aws-docs/providers/aws/pcaconnectorad/service_principal_name/index.md create mode 100644 docs/aws-docs/providers/aws/pcaconnectorad/service_principal_names/index.md create mode 100644 docs/aws-docs/providers/aws/pcaconnectorad/template/index.md create mode 100644 docs/aws-docs/providers/aws/pcaconnectorad/template_group_access_control_entries/index.md create mode 100644 docs/aws-docs/providers/aws/pcaconnectorad/template_group_access_control_entry/index.md create mode 100644 docs/aws-docs/providers/aws/pcaconnectorad/templates/index.md create mode 100644 docs/aws-docs/providers/aws/personalize/dataset/index.md create mode 100644 docs/aws-docs/providers/aws/personalize/dataset_group/index.md create mode 100644 docs/aws-docs/providers/aws/personalize/dataset_groups/index.md create mode 100644 docs/aws-docs/providers/aws/personalize/datasets/index.md create mode 100644 docs/aws-docs/providers/aws/personalize/index.md create mode 100644 docs/aws-docs/providers/aws/personalize/schema/index.md create mode 100644 docs/aws-docs/providers/aws/personalize/schemata/index.md create mode 100644 docs/aws-docs/providers/aws/personalize/solution/index.md create mode 100644 docs/aws-docs/providers/aws/personalize/solutions/index.md create mode 100644 docs/aws-docs/providers/aws/pinpoint/in_app_template/index.md create mode 100644 docs/aws-docs/providers/aws/pinpoint/in_app_templates/index.md create mode 100644 docs/aws-docs/providers/aws/pinpoint/index.md create mode 100644 docs/aws-docs/providers/aws/pipes/index.md create mode 100644 docs/aws-docs/providers/aws/pipes/pipe/index.md create mode 100644 docs/aws-docs/providers/aws/pipes/pipes/index.md create mode 100644 docs/aws-docs/providers/aws/proton/environment_account_connection/index.md create mode 100644 docs/aws-docs/providers/aws/proton/environment_account_connections/index.md create mode 100644 docs/aws-docs/providers/aws/proton/environment_template/index.md create mode 100644 docs/aws-docs/providers/aws/proton/environment_templates/index.md create mode 100644 docs/aws-docs/providers/aws/proton/index.md create mode 100644 docs/aws-docs/providers/aws/proton/service_template/index.md create mode 100644 docs/aws-docs/providers/aws/proton/service_templates/index.md create mode 100644 docs/aws-docs/providers/aws/qldb/index.md create mode 100644 docs/aws-docs/providers/aws/qldb/qldb_stream/index.md create mode 100644 docs/aws-docs/providers/aws/qldb/streams/index.md create mode 100644 docs/aws-docs/providers/aws/quicksight/analyses/index.md create mode 100644 docs/aws-docs/providers/aws/quicksight/analysis/index.md create mode 100644 docs/aws-docs/providers/aws/quicksight/dashboard/index.md create mode 100644 docs/aws-docs/providers/aws/quicksight/dashboards/index.md create mode 100644 docs/aws-docs/providers/aws/quicksight/data_set/index.md create mode 100644 docs/aws-docs/providers/aws/quicksight/data_sets/index.md create mode 100644 docs/aws-docs/providers/aws/quicksight/data_source/index.md create mode 100644 docs/aws-docs/providers/aws/quicksight/data_sources/index.md create mode 100644 docs/aws-docs/providers/aws/quicksight/index.md create mode 100644 docs/aws-docs/providers/aws/quicksight/refresh_schedule/index.md create mode 100644 docs/aws-docs/providers/aws/quicksight/refresh_schedules/index.md create mode 100644 docs/aws-docs/providers/aws/quicksight/template/index.md create mode 100644 docs/aws-docs/providers/aws/quicksight/templates/index.md create mode 100644 docs/aws-docs/providers/aws/quicksight/theme/index.md create mode 100644 docs/aws-docs/providers/aws/quicksight/themes/index.md create mode 100644 docs/aws-docs/providers/aws/quicksight/topic/index.md create mode 100644 docs/aws-docs/providers/aws/quicksight/topics/index.md create mode 100644 docs/aws-docs/providers/aws/quicksight/vpc_connection/index.md create mode 100644 docs/aws-docs/providers/aws/quicksight/vpc_connections/index.md create mode 100644 docs/aws-docs/providers/aws/ram/index.md create mode 100644 docs/aws-docs/providers/aws/ram/permission/index.md create mode 100644 docs/aws-docs/providers/aws/ram/permissions/index.md create mode 100644 docs/aws-docs/providers/aws/rds/customdb_engine_version/index.md create mode 100644 docs/aws-docs/providers/aws/rds/customdb_engine_versions/index.md create mode 100644 docs/aws-docs/providers/aws/rds/db_cluster/index.md create mode 100644 docs/aws-docs/providers/aws/rds/db_cluster_parameter_group/index.md create mode 100644 docs/aws-docs/providers/aws/rds/db_cluster_parameter_groups/index.md create mode 100644 docs/aws-docs/providers/aws/rds/db_clusters/index.md create mode 100644 docs/aws-docs/providers/aws/rds/db_instance/index.md create mode 100644 docs/aws-docs/providers/aws/rds/db_instances/index.md create mode 100644 docs/aws-docs/providers/aws/rds/db_parameter_group/index.md create mode 100644 docs/aws-docs/providers/aws/rds/db_parameter_groups/index.md create mode 100644 docs/aws-docs/providers/aws/rds/db_proxies/index.md create mode 100644 docs/aws-docs/providers/aws/rds/db_proxy/index.md create mode 100644 docs/aws-docs/providers/aws/rds/db_proxy_endpoint/index.md create mode 100644 docs/aws-docs/providers/aws/rds/db_proxy_endpoints/index.md create mode 100644 docs/aws-docs/providers/aws/rds/db_proxy_target_group/index.md create mode 100644 docs/aws-docs/providers/aws/rds/db_proxy_target_groups/index.md create mode 100644 docs/aws-docs/providers/aws/rds/db_subnet_group/index.md create mode 100644 docs/aws-docs/providers/aws/rds/db_subnet_groups/index.md create mode 100644 docs/aws-docs/providers/aws/rds/event_subscription/index.md create mode 100644 docs/aws-docs/providers/aws/rds/event_subscriptions/index.md create mode 100644 docs/aws-docs/providers/aws/rds/global_cluster/index.md create mode 100644 docs/aws-docs/providers/aws/rds/global_clusters/index.md create mode 100644 docs/aws-docs/providers/aws/rds/index.md create mode 100644 docs/aws-docs/providers/aws/rds/integration/index.md create mode 100644 docs/aws-docs/providers/aws/rds/integrations/index.md create mode 100644 docs/aws-docs/providers/aws/rds/option_group/index.md create mode 100644 docs/aws-docs/providers/aws/rds/option_groups/index.md create mode 100644 docs/aws-docs/providers/aws/redshift/cluster/index.md create mode 100644 docs/aws-docs/providers/aws/redshift/cluster_parameter_group/index.md create mode 100644 docs/aws-docs/providers/aws/redshift/cluster_parameter_groups/index.md create mode 100644 docs/aws-docs/providers/aws/redshift/cluster_subnet_group/index.md create mode 100644 docs/aws-docs/providers/aws/redshift/cluster_subnet_groups/index.md create mode 100644 docs/aws-docs/providers/aws/redshift/clusters/index.md create mode 100644 docs/aws-docs/providers/aws/redshift/endpoint_access/index.md create mode 100644 docs/aws-docs/providers/aws/redshift/endpoint_accesses/index.md create mode 100644 docs/aws-docs/providers/aws/redshift/endpoint_authorization/index.md create mode 100644 docs/aws-docs/providers/aws/redshift/endpoint_authorizations/index.md create mode 100644 docs/aws-docs/providers/aws/redshift/event_subscription/index.md create mode 100644 docs/aws-docs/providers/aws/redshift/event_subscriptions/index.md create mode 100644 docs/aws-docs/providers/aws/redshift/index.md create mode 100644 docs/aws-docs/providers/aws/redshift/scheduled_action/index.md create mode 100644 docs/aws-docs/providers/aws/redshift/scheduled_actions/index.md create mode 100644 docs/aws-docs/providers/aws/redshiftserverless/index.md create mode 100644 docs/aws-docs/providers/aws/redshiftserverless/namespace/index.md create mode 100644 docs/aws-docs/providers/aws/redshiftserverless/namespaces/index.md create mode 100644 docs/aws-docs/providers/aws/redshiftserverless/workgroup/index.md create mode 100644 docs/aws-docs/providers/aws/redshiftserverless/workgroups/index.md create mode 100644 docs/aws-docs/providers/aws/refactorspaces/application/index.md create mode 100644 docs/aws-docs/providers/aws/refactorspaces/applications/index.md create mode 100644 docs/aws-docs/providers/aws/refactorspaces/environment/index.md create mode 100644 docs/aws-docs/providers/aws/refactorspaces/environments/index.md create mode 100644 docs/aws-docs/providers/aws/refactorspaces/index.md create mode 100644 docs/aws-docs/providers/aws/refactorspaces/route/index.md create mode 100644 docs/aws-docs/providers/aws/refactorspaces/routes/index.md create mode 100644 docs/aws-docs/providers/aws/refactorspaces/service/index.md create mode 100644 docs/aws-docs/providers/aws/refactorspaces/services/index.md create mode 100644 docs/aws-docs/providers/aws/rekognition/collection/index.md create mode 100644 docs/aws-docs/providers/aws/rekognition/collections/index.md create mode 100644 docs/aws-docs/providers/aws/rekognition/index.md create mode 100644 docs/aws-docs/providers/aws/rekognition/project/index.md create mode 100644 docs/aws-docs/providers/aws/rekognition/projects/index.md create mode 100644 docs/aws-docs/providers/aws/rekognition/stream_processor/index.md create mode 100644 docs/aws-docs/providers/aws/rekognition/stream_processors/index.md create mode 100644 docs/aws-docs/providers/aws/resiliencehub/app/index.md create mode 100644 docs/aws-docs/providers/aws/resiliencehub/apps/index.md create mode 100644 docs/aws-docs/providers/aws/resiliencehub/index.md create mode 100644 docs/aws-docs/providers/aws/resiliencehub/resiliency_policies/index.md create mode 100644 docs/aws-docs/providers/aws/resiliencehub/resiliency_policy/index.md create mode 100644 docs/aws-docs/providers/aws/resourceexplorer2/default_view_association/index.md create mode 100644 docs/aws-docs/providers/aws/resourceexplorer2/default_view_associations/index.md create mode 100644 docs/aws-docs/providers/aws/resourceexplorer2/index.md create mode 100644 docs/aws-docs/providers/aws/resourceexplorer2/index/index.md create mode 100644 docs/aws-docs/providers/aws/resourceexplorer2/indices/index.md create mode 100644 docs/aws-docs/providers/aws/resourceexplorer2/view/index.md create mode 100644 docs/aws-docs/providers/aws/resourceexplorer2/views/index.md create mode 100644 docs/aws-docs/providers/aws/resourcegroups/group/index.md create mode 100644 docs/aws-docs/providers/aws/resourcegroups/groups/index.md create mode 100644 docs/aws-docs/providers/aws/resourcegroups/index.md create mode 100644 docs/aws-docs/providers/aws/robomaker/fleet/index.md create mode 100644 docs/aws-docs/providers/aws/robomaker/fleets/index.md create mode 100644 docs/aws-docs/providers/aws/robomaker/index.md create mode 100644 docs/aws-docs/providers/aws/robomaker/robot/index.md create mode 100644 docs/aws-docs/providers/aws/robomaker/robot_application/index.md create mode 100644 docs/aws-docs/providers/aws/robomaker/robot_application_version/index.md create mode 100644 docs/aws-docs/providers/aws/robomaker/robot_application_versions/index.md create mode 100644 docs/aws-docs/providers/aws/robomaker/robot_applications/index.md create mode 100644 docs/aws-docs/providers/aws/robomaker/robots/index.md create mode 100644 docs/aws-docs/providers/aws/robomaker/simulation_application/index.md create mode 100644 docs/aws-docs/providers/aws/robomaker/simulation_application_version/index.md create mode 100644 docs/aws-docs/providers/aws/robomaker/simulation_application_versions/index.md create mode 100644 docs/aws-docs/providers/aws/robomaker/simulation_applications/index.md create mode 100644 docs/aws-docs/providers/aws/rolesanywhere/crl/index.md create mode 100644 docs/aws-docs/providers/aws/rolesanywhere/crls/index.md create mode 100644 docs/aws-docs/providers/aws/rolesanywhere/index.md create mode 100644 docs/aws-docs/providers/aws/rolesanywhere/profile/index.md create mode 100644 docs/aws-docs/providers/aws/rolesanywhere/profiles/index.md create mode 100644 docs/aws-docs/providers/aws/rolesanywhere/trust_anchor/index.md create mode 100644 docs/aws-docs/providers/aws/rolesanywhere/trust_anchors/index.md create mode 100644 docs/aws-docs/providers/aws/route53/cidr_collection/index.md create mode 100644 docs/aws-docs/providers/aws/route53/cidr_collections/index.md create mode 100644 docs/aws-docs/providers/aws/route53/dnssec/index.md create mode 100644 docs/aws-docs/providers/aws/route53/dnssecs/index.md create mode 100644 docs/aws-docs/providers/aws/route53/health_check/index.md create mode 100644 docs/aws-docs/providers/aws/route53/health_checks/index.md create mode 100644 docs/aws-docs/providers/aws/route53/hosted_zone/index.md create mode 100644 docs/aws-docs/providers/aws/route53/hosted_zones/index.md create mode 100644 docs/aws-docs/providers/aws/route53/index.md create mode 100644 docs/aws-docs/providers/aws/route53/key_signing_key/index.md create mode 100644 docs/aws-docs/providers/aws/route53/key_signing_keys/index.md create mode 100644 docs/aws-docs/providers/aws/route53recoverycontrol/cluster/index.md create mode 100644 docs/aws-docs/providers/aws/route53recoverycontrol/clusters/index.md create mode 100644 docs/aws-docs/providers/aws/route53recoverycontrol/control_panel/index.md create mode 100644 docs/aws-docs/providers/aws/route53recoverycontrol/control_panels/index.md create mode 100644 docs/aws-docs/providers/aws/route53recoverycontrol/index.md create mode 100644 docs/aws-docs/providers/aws/route53recoverycontrol/routing_control/index.md create mode 100644 docs/aws-docs/providers/aws/route53recoverycontrol/routing_controls/index.md create mode 100644 docs/aws-docs/providers/aws/route53recoverycontrol/safety_rule/index.md create mode 100644 docs/aws-docs/providers/aws/route53recoverycontrol/safety_rules/index.md create mode 100644 docs/aws-docs/providers/aws/route53recoveryreadiness/cell/index.md create mode 100644 docs/aws-docs/providers/aws/route53recoveryreadiness/cells/index.md create mode 100644 docs/aws-docs/providers/aws/route53recoveryreadiness/index.md create mode 100644 docs/aws-docs/providers/aws/route53recoveryreadiness/readiness_check/index.md create mode 100644 docs/aws-docs/providers/aws/route53recoveryreadiness/readiness_checks/index.md create mode 100644 docs/aws-docs/providers/aws/route53recoveryreadiness/recovery_group/index.md create mode 100644 docs/aws-docs/providers/aws/route53recoveryreadiness/recovery_groups/index.md create mode 100644 docs/aws-docs/providers/aws/route53recoveryreadiness/resource_set/index.md create mode 100644 docs/aws-docs/providers/aws/route53recoveryreadiness/resource_sets/index.md create mode 100644 docs/aws-docs/providers/aws/route53resolver/firewall_domain_list/index.md create mode 100644 docs/aws-docs/providers/aws/route53resolver/firewall_domain_lists/index.md create mode 100644 docs/aws-docs/providers/aws/route53resolver/firewall_rule_group/index.md create mode 100644 docs/aws-docs/providers/aws/route53resolver/firewall_rule_group_association/index.md create mode 100644 docs/aws-docs/providers/aws/route53resolver/firewall_rule_group_associations/index.md create mode 100644 docs/aws-docs/providers/aws/route53resolver/firewall_rule_groups/index.md create mode 100644 docs/aws-docs/providers/aws/route53resolver/index.md create mode 100644 docs/aws-docs/providers/aws/route53resolver/outpost_resolver/index.md create mode 100644 docs/aws-docs/providers/aws/route53resolver/outpost_resolvers/index.md create mode 100644 docs/aws-docs/providers/aws/route53resolver/resolver_config/index.md create mode 100644 docs/aws-docs/providers/aws/route53resolver/resolver_configs/index.md create mode 100644 docs/aws-docs/providers/aws/route53resolver/resolver_query_logging_config/index.md create mode 100644 docs/aws-docs/providers/aws/route53resolver/resolver_query_logging_config_association/index.md create mode 100644 docs/aws-docs/providers/aws/route53resolver/resolver_query_logging_config_associations/index.md create mode 100644 docs/aws-docs/providers/aws/route53resolver/resolver_query_logging_configs/index.md create mode 100644 docs/aws-docs/providers/aws/route53resolver/resolver_rule/index.md create mode 100644 docs/aws-docs/providers/aws/route53resolver/resolver_rule_association/index.md create mode 100644 docs/aws-docs/providers/aws/route53resolver/resolver_rule_associations/index.md create mode 100644 docs/aws-docs/providers/aws/route53resolver/resolver_rules/index.md create mode 100644 docs/aws-docs/providers/aws/route53resolver/resolverdnssec_config/index.md create mode 100644 docs/aws-docs/providers/aws/route53resolver/resolverdnssec_configs/index.md create mode 100644 docs/aws-docs/providers/aws/rum/app_monitor/index.md create mode 100644 docs/aws-docs/providers/aws/rum/app_monitors/index.md create mode 100644 docs/aws-docs/providers/aws/rum/index.md create mode 100644 docs/aws-docs/providers/aws/s3/access_grant/index.md create mode 100644 docs/aws-docs/providers/aws/s3/access_grants/index.md create mode 100644 docs/aws-docs/providers/aws/s3/access_grants_instance/index.md create mode 100644 docs/aws-docs/providers/aws/s3/access_grants_instances/index.md create mode 100644 docs/aws-docs/providers/aws/s3/access_grants_location/index.md create mode 100644 docs/aws-docs/providers/aws/s3/access_grants_locations/index.md create mode 100644 docs/aws-docs/providers/aws/s3/access_point/index.md create mode 100644 docs/aws-docs/providers/aws/s3/access_points/index.md create mode 100644 docs/aws-docs/providers/aws/s3/bucket/index.md delete mode 100644 docs/aws-docs/providers/aws/s3/bucket_accelerate_configurations/index.md delete mode 100644 docs/aws-docs/providers/aws/s3/bucket_acls/index.md delete mode 100644 docs/aws-docs/providers/aws/s3/bucket_analytics_configurations/index.md delete mode 100644 docs/aws-docs/providers/aws/s3/bucket_cors/index.md delete mode 100644 docs/aws-docs/providers/aws/s3/bucket_encryptions/index.md delete mode 100644 docs/aws-docs/providers/aws/s3/bucket_intelligent_tiering_configurations/index.md delete mode 100644 docs/aws-docs/providers/aws/s3/bucket_inventory_configurations/index.md delete mode 100644 docs/aws-docs/providers/aws/s3/bucket_lifecycle_configurations/index.md delete mode 100644 docs/aws-docs/providers/aws/s3/bucket_lifecycles/index.md delete mode 100644 docs/aws-docs/providers/aws/s3/bucket_locations/index.md delete mode 100644 docs/aws-docs/providers/aws/s3/bucket_loggings/index.md delete mode 100644 docs/aws-docs/providers/aws/s3/bucket_metrics_configurations/index.md delete mode 100644 docs/aws-docs/providers/aws/s3/bucket_notification_configurations/index.md delete mode 100644 docs/aws-docs/providers/aws/s3/bucket_notifications/index.md delete mode 100644 docs/aws-docs/providers/aws/s3/bucket_ownership_controls/index.md create mode 100644 docs/aws-docs/providers/aws/s3/bucket_policy/index.md delete mode 100644 docs/aws-docs/providers/aws/s3/bucket_policy_status/index.md delete mode 100644 docs/aws-docs/providers/aws/s3/bucket_replications/index.md delete mode 100644 docs/aws-docs/providers/aws/s3/bucket_request_payments/index.md delete mode 100644 docs/aws-docs/providers/aws/s3/bucket_taggings/index.md delete mode 100644 docs/aws-docs/providers/aws/s3/bucket_versionings/index.md delete mode 100644 docs/aws-docs/providers/aws/s3/bucket_websites/index.md delete mode 100644 docs/aws-docs/providers/aws/s3/get_object_responses/index.md create mode 100644 docs/aws-docs/providers/aws/s3/multi_region_access_point/index.md create mode 100644 docs/aws-docs/providers/aws/s3/multi_region_access_point_policies/index.md create mode 100644 docs/aws-docs/providers/aws/s3/multi_region_access_point_policy/index.md create mode 100644 docs/aws-docs/providers/aws/s3/multi_region_access_points/index.md delete mode 100644 docs/aws-docs/providers/aws/s3/multipart_uploads/index.md delete mode 100644 docs/aws-docs/providers/aws/s3/object_acls/index.md delete mode 100644 docs/aws-docs/providers/aws/s3/object_attributes/index.md delete mode 100644 docs/aws-docs/providers/aws/s3/object_contents/index.md delete mode 100644 docs/aws-docs/providers/aws/s3/object_legal_holds/index.md delete mode 100644 docs/aws-docs/providers/aws/s3/object_lock_configurations/index.md delete mode 100644 docs/aws-docs/providers/aws/s3/object_retentions/index.md delete mode 100644 docs/aws-docs/providers/aws/s3/object_taggings/index.md delete mode 100644 docs/aws-docs/providers/aws/s3/object_torrents/index.md delete mode 100644 docs/aws-docs/providers/aws/s3/object_versions/index.md delete mode 100644 docs/aws-docs/providers/aws/s3/objects/index.md delete mode 100644 docs/aws-docs/providers/aws/s3/objects_v2s/index.md delete mode 100644 docs/aws-docs/providers/aws/s3/part_copies/index.md delete mode 100644 docs/aws-docs/providers/aws/s3/parts/index.md delete mode 100644 docs/aws-docs/providers/aws/s3/public_access_blocks/index.md create mode 100644 docs/aws-docs/providers/aws/s3/storage_lens/index.md create mode 100644 docs/aws-docs/providers/aws/s3/storage_lens_group/index.md create mode 100644 docs/aws-docs/providers/aws/s3/storage_lens_groups/index.md create mode 100644 docs/aws-docs/providers/aws/s3_api/bucket_accelerate_configurations/index.md create mode 100644 docs/aws-docs/providers/aws/s3_api/bucket_acls/index.md create mode 100644 docs/aws-docs/providers/aws/s3_api/bucket_analytics_configurations/index.md create mode 100644 docs/aws-docs/providers/aws/s3_api/bucket_cors/index.md create mode 100644 docs/aws-docs/providers/aws/s3_api/bucket_encryptions/index.md create mode 100644 docs/aws-docs/providers/aws/s3_api/bucket_intelligent_tiering_configurations/index.md create mode 100644 docs/aws-docs/providers/aws/s3_api/bucket_inventory_configurations/index.md create mode 100644 docs/aws-docs/providers/aws/s3_api/bucket_lifecycle_configurations/index.md create mode 100644 docs/aws-docs/providers/aws/s3_api/bucket_lifecycles/index.md create mode 100644 docs/aws-docs/providers/aws/s3_api/bucket_locations/index.md create mode 100644 docs/aws-docs/providers/aws/s3_api/bucket_loggings/index.md create mode 100644 docs/aws-docs/providers/aws/s3_api/bucket_metrics_configurations/index.md create mode 100644 docs/aws-docs/providers/aws/s3_api/bucket_notification_configurations/index.md create mode 100644 docs/aws-docs/providers/aws/s3_api/bucket_notifications/index.md create mode 100644 docs/aws-docs/providers/aws/s3_api/bucket_ownership_controls/index.md create mode 100644 docs/aws-docs/providers/aws/s3_api/bucket_policies/index.md create mode 100644 docs/aws-docs/providers/aws/s3_api/bucket_policy_status/index.md create mode 100644 docs/aws-docs/providers/aws/s3_api/bucket_replications/index.md create mode 100644 docs/aws-docs/providers/aws/s3_api/bucket_request_payments/index.md create mode 100644 docs/aws-docs/providers/aws/s3_api/bucket_taggings/index.md create mode 100644 docs/aws-docs/providers/aws/s3_api/bucket_versionings/index.md create mode 100644 docs/aws-docs/providers/aws/s3_api/bucket_websites/index.md create mode 100644 docs/aws-docs/providers/aws/s3_api/buckets/index.md create mode 100644 docs/aws-docs/providers/aws/s3_api/get_object_responses/index.md create mode 100644 docs/aws-docs/providers/aws/s3_api/index.md create mode 100644 docs/aws-docs/providers/aws/s3_api/multipart_uploads/index.md create mode 100644 docs/aws-docs/providers/aws/s3_api/object_acls/index.md create mode 100644 docs/aws-docs/providers/aws/s3_api/object_attributes/index.md create mode 100644 docs/aws-docs/providers/aws/s3_api/object_contents/index.md create mode 100644 docs/aws-docs/providers/aws/s3_api/object_legal_holds/index.md create mode 100644 docs/aws-docs/providers/aws/s3_api/object_lock_configurations/index.md create mode 100644 docs/aws-docs/providers/aws/s3_api/object_retentions/index.md create mode 100644 docs/aws-docs/providers/aws/s3_api/object_taggings/index.md create mode 100644 docs/aws-docs/providers/aws/s3_api/object_torrents/index.md create mode 100644 docs/aws-docs/providers/aws/s3_api/object_versions/index.md create mode 100644 docs/aws-docs/providers/aws/s3_api/objects/index.md create mode 100644 docs/aws-docs/providers/aws/s3_api/objects_v2s/index.md create mode 100644 docs/aws-docs/providers/aws/s3_api/part_copies/index.md create mode 100644 docs/aws-docs/providers/aws/s3_api/parts/index.md create mode 100644 docs/aws-docs/providers/aws/s3_api/public_access_blocks/index.md create mode 100644 docs/aws-docs/providers/aws/s3express/bucket_policies/index.md create mode 100644 docs/aws-docs/providers/aws/s3express/bucket_policy/index.md create mode 100644 docs/aws-docs/providers/aws/s3express/directory_bucket/index.md create mode 100644 docs/aws-docs/providers/aws/s3express/directory_buckets/index.md create mode 100644 docs/aws-docs/providers/aws/s3express/index.md create mode 100644 docs/aws-docs/providers/aws/s3objectlambda/access_point/index.md create mode 100644 docs/aws-docs/providers/aws/s3objectlambda/access_point_policies/index.md create mode 100644 docs/aws-docs/providers/aws/s3objectlambda/access_point_policy/index.md create mode 100644 docs/aws-docs/providers/aws/s3objectlambda/access_points/index.md create mode 100644 docs/aws-docs/providers/aws/s3objectlambda/index.md create mode 100644 docs/aws-docs/providers/aws/s3outposts/access_point/index.md create mode 100644 docs/aws-docs/providers/aws/s3outposts/access_points/index.md create mode 100644 docs/aws-docs/providers/aws/s3outposts/bucket/index.md create mode 100644 docs/aws-docs/providers/aws/s3outposts/bucket_policies/index.md create mode 100644 docs/aws-docs/providers/aws/s3outposts/bucket_policy/index.md create mode 100644 docs/aws-docs/providers/aws/s3outposts/buckets/index.md create mode 100644 docs/aws-docs/providers/aws/s3outposts/endpoint/index.md create mode 100644 docs/aws-docs/providers/aws/s3outposts/endpoints/index.md create mode 100644 docs/aws-docs/providers/aws/s3outposts/index.md create mode 100644 docs/aws-docs/providers/aws/sagemaker/app/index.md create mode 100644 docs/aws-docs/providers/aws/sagemaker/app_image_config/index.md create mode 100644 docs/aws-docs/providers/aws/sagemaker/app_image_configs/index.md create mode 100644 docs/aws-docs/providers/aws/sagemaker/apps/index.md create mode 100644 docs/aws-docs/providers/aws/sagemaker/data_quality_job_definition/index.md create mode 100644 docs/aws-docs/providers/aws/sagemaker/data_quality_job_definitions/index.md create mode 100644 docs/aws-docs/providers/aws/sagemaker/device/index.md create mode 100644 docs/aws-docs/providers/aws/sagemaker/device_fleet/index.md create mode 100644 docs/aws-docs/providers/aws/sagemaker/device_fleets/index.md create mode 100644 docs/aws-docs/providers/aws/sagemaker/devices/index.md create mode 100644 docs/aws-docs/providers/aws/sagemaker/feature_group/index.md create mode 100644 docs/aws-docs/providers/aws/sagemaker/feature_groups/index.md create mode 100644 docs/aws-docs/providers/aws/sagemaker/image/index.md create mode 100644 docs/aws-docs/providers/aws/sagemaker/image_version/index.md create mode 100644 docs/aws-docs/providers/aws/sagemaker/image_versions/index.md create mode 100644 docs/aws-docs/providers/aws/sagemaker/images/index.md create mode 100644 docs/aws-docs/providers/aws/sagemaker/index.md create mode 100644 docs/aws-docs/providers/aws/sagemaker/inference_component/index.md create mode 100644 docs/aws-docs/providers/aws/sagemaker/inference_components/index.md create mode 100644 docs/aws-docs/providers/aws/sagemaker/inference_experiment/index.md create mode 100644 docs/aws-docs/providers/aws/sagemaker/inference_experiments/index.md create mode 100644 docs/aws-docs/providers/aws/sagemaker/model_bias_job_definition/index.md create mode 100644 docs/aws-docs/providers/aws/sagemaker/model_bias_job_definitions/index.md create mode 100644 docs/aws-docs/providers/aws/sagemaker/model_card/index.md create mode 100644 docs/aws-docs/providers/aws/sagemaker/model_cards/index.md create mode 100644 docs/aws-docs/providers/aws/sagemaker/model_explainability_job_definition/index.md create mode 100644 docs/aws-docs/providers/aws/sagemaker/model_explainability_job_definitions/index.md create mode 100644 docs/aws-docs/providers/aws/sagemaker/model_package/index.md create mode 100644 docs/aws-docs/providers/aws/sagemaker/model_package_group/index.md create mode 100644 docs/aws-docs/providers/aws/sagemaker/model_package_groups/index.md create mode 100644 docs/aws-docs/providers/aws/sagemaker/model_packages/index.md create mode 100644 docs/aws-docs/providers/aws/sagemaker/model_quality_job_definition/index.md create mode 100644 docs/aws-docs/providers/aws/sagemaker/model_quality_job_definitions/index.md create mode 100644 docs/aws-docs/providers/aws/sagemaker/monitoring_schedule/index.md create mode 100644 docs/aws-docs/providers/aws/sagemaker/monitoring_schedules/index.md create mode 100644 docs/aws-docs/providers/aws/sagemaker/pipeline/index.md create mode 100644 docs/aws-docs/providers/aws/sagemaker/pipelines/index.md create mode 100644 docs/aws-docs/providers/aws/sagemaker/project/index.md create mode 100644 docs/aws-docs/providers/aws/sagemaker/projects/index.md create mode 100644 docs/aws-docs/providers/aws/sagemaker/space/index.md create mode 100644 docs/aws-docs/providers/aws/sagemaker/spaces/index.md create mode 100644 docs/aws-docs/providers/aws/sagemaker/user_profile/index.md create mode 100644 docs/aws-docs/providers/aws/sagemaker/user_profiles/index.md create mode 100644 docs/aws-docs/providers/aws/scheduler/index.md create mode 100644 docs/aws-docs/providers/aws/scheduler/schedule/index.md create mode 100644 docs/aws-docs/providers/aws/scheduler/schedule_group/index.md create mode 100644 docs/aws-docs/providers/aws/scheduler/schedule_groups/index.md create mode 100644 docs/aws-docs/providers/aws/scheduler/schedules/index.md create mode 100644 docs/aws-docs/providers/aws/secretsmanager/index.md create mode 100644 docs/aws-docs/providers/aws/secretsmanager/secret/index.md create mode 100644 docs/aws-docs/providers/aws/secretsmanager/secrets/index.md create mode 100644 docs/aws-docs/providers/aws/securityhub/automation_rule/index.md create mode 100644 docs/aws-docs/providers/aws/securityhub/automation_rules/index.md create mode 100644 docs/aws-docs/providers/aws/securityhub/delegated_admin/index.md create mode 100644 docs/aws-docs/providers/aws/securityhub/delegated_admins/index.md create mode 100644 docs/aws-docs/providers/aws/securityhub/hub/index.md create mode 100644 docs/aws-docs/providers/aws/securityhub/hubs/index.md create mode 100644 docs/aws-docs/providers/aws/securityhub/index.md create mode 100644 docs/aws-docs/providers/aws/securityhub/insight/index.md create mode 100644 docs/aws-docs/providers/aws/securityhub/insights/index.md create mode 100644 docs/aws-docs/providers/aws/securityhub/product_subscription/index.md create mode 100644 docs/aws-docs/providers/aws/securityhub/product_subscriptions/index.md create mode 100644 docs/aws-docs/providers/aws/securityhub/standard/index.md create mode 100644 docs/aws-docs/providers/aws/securityhub/standards/index.md create mode 100644 docs/aws-docs/providers/aws/securitylake/data_lake/index.md create mode 100644 docs/aws-docs/providers/aws/securitylake/data_lakes/index.md create mode 100644 docs/aws-docs/providers/aws/securitylake/index.md create mode 100644 docs/aws-docs/providers/aws/securitylake/subscriber/index.md create mode 100644 docs/aws-docs/providers/aws/securitylake/subscribers/index.md create mode 100644 docs/aws-docs/providers/aws/servicecatalog/cloud_formation_provisioned_product/index.md create mode 100644 docs/aws-docs/providers/aws/servicecatalog/cloud_formation_provisioned_products/index.md create mode 100644 docs/aws-docs/providers/aws/servicecatalog/index.md create mode 100644 docs/aws-docs/providers/aws/servicecatalog/service_action/index.md create mode 100644 docs/aws-docs/providers/aws/servicecatalog/service_action_association/index.md create mode 100644 docs/aws-docs/providers/aws/servicecatalog/service_action_associations/index.md create mode 100644 docs/aws-docs/providers/aws/servicecatalog/service_actions/index.md create mode 100644 docs/aws-docs/providers/aws/servicecatalogappregistry/application/index.md create mode 100644 docs/aws-docs/providers/aws/servicecatalogappregistry/applications/index.md create mode 100644 docs/aws-docs/providers/aws/servicecatalogappregistry/attribute_group/index.md create mode 100644 docs/aws-docs/providers/aws/servicecatalogappregistry/attribute_group_association/index.md create mode 100644 docs/aws-docs/providers/aws/servicecatalogappregistry/attribute_group_associations/index.md create mode 100644 docs/aws-docs/providers/aws/servicecatalogappregistry/attribute_groups/index.md create mode 100644 docs/aws-docs/providers/aws/servicecatalogappregistry/index.md create mode 100644 docs/aws-docs/providers/aws/servicecatalogappregistry/resource_association/index.md create mode 100644 docs/aws-docs/providers/aws/servicecatalogappregistry/resource_associations/index.md create mode 100644 docs/aws-docs/providers/aws/ses/configuration_set/index.md create mode 100644 docs/aws-docs/providers/aws/ses/configuration_set_event_destination/index.md create mode 100644 docs/aws-docs/providers/aws/ses/configuration_set_event_destinations/index.md create mode 100644 docs/aws-docs/providers/aws/ses/configuration_sets/index.md create mode 100644 docs/aws-docs/providers/aws/ses/contact_list/index.md create mode 100644 docs/aws-docs/providers/aws/ses/contact_lists/index.md create mode 100644 docs/aws-docs/providers/aws/ses/dedicated_ip_pool/index.md create mode 100644 docs/aws-docs/providers/aws/ses/dedicated_ip_pools/index.md create mode 100644 docs/aws-docs/providers/aws/ses/email_identities/index.md create mode 100644 docs/aws-docs/providers/aws/ses/email_identity/index.md create mode 100644 docs/aws-docs/providers/aws/ses/index.md create mode 100644 docs/aws-docs/providers/aws/ses/template/index.md create mode 100644 docs/aws-docs/providers/aws/ses/templates/index.md create mode 100644 docs/aws-docs/providers/aws/ses/vdm_attributes/index.md create mode 100644 docs/aws-docs/providers/aws/shield/drt_access/index.md create mode 100644 docs/aws-docs/providers/aws/shield/drt_accesses/index.md create mode 100644 docs/aws-docs/providers/aws/shield/index.md create mode 100644 docs/aws-docs/providers/aws/shield/proactive_engagement/index.md create mode 100644 docs/aws-docs/providers/aws/shield/proactive_engagements/index.md create mode 100644 docs/aws-docs/providers/aws/shield/protection/index.md create mode 100644 docs/aws-docs/providers/aws/shield/protection_group/index.md create mode 100644 docs/aws-docs/providers/aws/shield/protection_groups/index.md create mode 100644 docs/aws-docs/providers/aws/shield/protections/index.md create mode 100644 docs/aws-docs/providers/aws/signer/index.md create mode 100644 docs/aws-docs/providers/aws/signer/profile_permission/index.md create mode 100644 docs/aws-docs/providers/aws/signer/profile_permissions/index.md create mode 100644 docs/aws-docs/providers/aws/signer/signing_profile/index.md create mode 100644 docs/aws-docs/providers/aws/signer/signing_profiles/index.md create mode 100644 docs/aws-docs/providers/aws/simspaceweaver/index.md create mode 100644 docs/aws-docs/providers/aws/simspaceweaver/simulation/index.md create mode 100644 docs/aws-docs/providers/aws/simspaceweaver/simulations/index.md create mode 100644 docs/aws-docs/providers/aws/sns/index.md create mode 100644 docs/aws-docs/providers/aws/sns/topic/index.md create mode 100644 docs/aws-docs/providers/aws/sns/topic_inline_policies/index.md create mode 100644 docs/aws-docs/providers/aws/sns/topic_inline_policy/index.md create mode 100644 docs/aws-docs/providers/aws/sns/topics/index.md create mode 100644 docs/aws-docs/providers/aws/sqs/index.md create mode 100644 docs/aws-docs/providers/aws/sqs/queue/index.md create mode 100644 docs/aws-docs/providers/aws/sqs/queue_inline_policies/index.md create mode 100644 docs/aws-docs/providers/aws/sqs/queue_inline_policy/index.md create mode 100644 docs/aws-docs/providers/aws/sqs/queues/index.md create mode 100644 docs/aws-docs/providers/aws/ssm/association/index.md create mode 100644 docs/aws-docs/providers/aws/ssm/associations/index.md create mode 100644 docs/aws-docs/providers/aws/ssm/document/index.md create mode 100644 docs/aws-docs/providers/aws/ssm/documents/index.md create mode 100644 docs/aws-docs/providers/aws/ssm/index.md create mode 100644 docs/aws-docs/providers/aws/ssm/parameter/index.md create mode 100644 docs/aws-docs/providers/aws/ssm/parameters/index.md create mode 100644 docs/aws-docs/providers/aws/ssm/patch_baseline/index.md create mode 100644 docs/aws-docs/providers/aws/ssm/patch_baselines/index.md create mode 100644 docs/aws-docs/providers/aws/ssm/resource_data_sync/index.md create mode 100644 docs/aws-docs/providers/aws/ssm/resource_data_syncs/index.md create mode 100644 docs/aws-docs/providers/aws/ssm/resource_policies/index.md create mode 100644 docs/aws-docs/providers/aws/ssm/resource_policy/index.md create mode 100644 docs/aws-docs/providers/aws/ssmcontacts/contact/index.md create mode 100644 docs/aws-docs/providers/aws/ssmcontacts/contact_channel/index.md create mode 100644 docs/aws-docs/providers/aws/ssmcontacts/contact_channels/index.md create mode 100644 docs/aws-docs/providers/aws/ssmcontacts/contacts/index.md create mode 100644 docs/aws-docs/providers/aws/ssmcontacts/index.md create mode 100644 docs/aws-docs/providers/aws/ssmcontacts/plan/index.md create mode 100644 docs/aws-docs/providers/aws/ssmcontacts/plans/index.md create mode 100644 docs/aws-docs/providers/aws/ssmcontacts/rotation/index.md create mode 100644 docs/aws-docs/providers/aws/ssmcontacts/rotations/index.md create mode 100644 docs/aws-docs/providers/aws/ssmincidents/index.md create mode 100644 docs/aws-docs/providers/aws/ssmincidents/replication_set/index.md create mode 100644 docs/aws-docs/providers/aws/ssmincidents/replication_sets/index.md create mode 100644 docs/aws-docs/providers/aws/ssmincidents/response_plan/index.md create mode 100644 docs/aws-docs/providers/aws/ssmincidents/response_plans/index.md create mode 100644 docs/aws-docs/providers/aws/sso/assignment/index.md create mode 100644 docs/aws-docs/providers/aws/sso/assignments/index.md create mode 100644 docs/aws-docs/providers/aws/sso/index.md create mode 100644 docs/aws-docs/providers/aws/sso/instance_access_control_attribute_configuration/index.md create mode 100644 docs/aws-docs/providers/aws/sso/instance_access_control_attribute_configurations/index.md create mode 100644 docs/aws-docs/providers/aws/sso/permission_set/index.md create mode 100644 docs/aws-docs/providers/aws/sso/permission_sets/index.md create mode 100644 docs/aws-docs/providers/aws/stepfunctions/activities/index.md create mode 100644 docs/aws-docs/providers/aws/stepfunctions/activity/index.md create mode 100644 docs/aws-docs/providers/aws/stepfunctions/index.md create mode 100644 docs/aws-docs/providers/aws/stepfunctions/state_machine/index.md create mode 100644 docs/aws-docs/providers/aws/stepfunctions/state_machine_alias/index.md create mode 100644 docs/aws-docs/providers/aws/stepfunctions/state_machine_aliases/index.md create mode 100644 docs/aws-docs/providers/aws/stepfunctions/state_machine_version/index.md create mode 100644 docs/aws-docs/providers/aws/stepfunctions/state_machine_versions/index.md create mode 100644 docs/aws-docs/providers/aws/stepfunctions/state_machines/index.md create mode 100644 docs/aws-docs/providers/aws/supportapp/account_alias/index.md create mode 100644 docs/aws-docs/providers/aws/supportapp/account_aliases/index.md create mode 100644 docs/aws-docs/providers/aws/supportapp/index.md create mode 100644 docs/aws-docs/providers/aws/supportapp/slack_channel_configuration/index.md create mode 100644 docs/aws-docs/providers/aws/supportapp/slack_channel_configurations/index.md create mode 100644 docs/aws-docs/providers/aws/supportapp/slack_workspace_configuration/index.md create mode 100644 docs/aws-docs/providers/aws/supportapp/slack_workspace_configurations/index.md create mode 100644 docs/aws-docs/providers/aws/synthetics/canaries/index.md create mode 100644 docs/aws-docs/providers/aws/synthetics/canary/index.md create mode 100644 docs/aws-docs/providers/aws/synthetics/group/index.md create mode 100644 docs/aws-docs/providers/aws/synthetics/groups/index.md create mode 100644 docs/aws-docs/providers/aws/synthetics/index.md create mode 100644 docs/aws-docs/providers/aws/systemsmanagersap/application/index.md create mode 100644 docs/aws-docs/providers/aws/systemsmanagersap/applications/index.md create mode 100644 docs/aws-docs/providers/aws/systemsmanagersap/index.md create mode 100644 docs/aws-docs/providers/aws/timestream/database/index.md create mode 100644 docs/aws-docs/providers/aws/timestream/databases/index.md create mode 100644 docs/aws-docs/providers/aws/timestream/index.md create mode 100644 docs/aws-docs/providers/aws/timestream/influxdb_instance/index.md create mode 100644 docs/aws-docs/providers/aws/timestream/influxdb_instances/index.md create mode 100644 docs/aws-docs/providers/aws/timestream/scheduled_queries/index.md create mode 100644 docs/aws-docs/providers/aws/timestream/scheduled_query/index.md create mode 100644 docs/aws-docs/providers/aws/timestream/table/index.md create mode 100644 docs/aws-docs/providers/aws/timestream/tables/index.md create mode 100644 docs/aws-docs/providers/aws/transfer/agreement/index.md create mode 100644 docs/aws-docs/providers/aws/transfer/agreements/index.md create mode 100644 docs/aws-docs/providers/aws/transfer/certificate/index.md create mode 100644 docs/aws-docs/providers/aws/transfer/certificates/index.md create mode 100644 docs/aws-docs/providers/aws/transfer/connector/index.md create mode 100644 docs/aws-docs/providers/aws/transfer/connectors/index.md create mode 100644 docs/aws-docs/providers/aws/transfer/index.md create mode 100644 docs/aws-docs/providers/aws/transfer/profile/index.md create mode 100644 docs/aws-docs/providers/aws/transfer/profiles/index.md create mode 100644 docs/aws-docs/providers/aws/transfer/workflow/index.md create mode 100644 docs/aws-docs/providers/aws/transfer/workflows/index.md create mode 100644 docs/aws-docs/providers/aws/transfer_api/connectors/index.md create mode 100644 docs/aws-docs/providers/aws/transfer_api/index.md create mode 100644 docs/aws-docs/providers/aws/transfer_api/servers/index.md create mode 100644 docs/aws-docs/providers/aws/transfer_api/users/index.md create mode 100644 docs/aws-docs/providers/aws/verifiedpermissions/identity_source/index.md create mode 100644 docs/aws-docs/providers/aws/verifiedpermissions/identity_sources/index.md create mode 100644 docs/aws-docs/providers/aws/verifiedpermissions/index.md create mode 100644 docs/aws-docs/providers/aws/verifiedpermissions/policies/index.md create mode 100644 docs/aws-docs/providers/aws/verifiedpermissions/policy/index.md create mode 100644 docs/aws-docs/providers/aws/verifiedpermissions/policy_store/index.md create mode 100644 docs/aws-docs/providers/aws/verifiedpermissions/policy_stores/index.md create mode 100644 docs/aws-docs/providers/aws/verifiedpermissions/policy_template/index.md create mode 100644 docs/aws-docs/providers/aws/verifiedpermissions/policy_templates/index.md create mode 100644 docs/aws-docs/providers/aws/voiceid/domain/index.md create mode 100644 docs/aws-docs/providers/aws/voiceid/domains/index.md create mode 100644 docs/aws-docs/providers/aws/voiceid/index.md create mode 100644 docs/aws-docs/providers/aws/vpclattice/access_log_subscription/index.md create mode 100644 docs/aws-docs/providers/aws/vpclattice/access_log_subscriptions/index.md create mode 100644 docs/aws-docs/providers/aws/vpclattice/auth_policies/index.md create mode 100644 docs/aws-docs/providers/aws/vpclattice/auth_policy/index.md create mode 100644 docs/aws-docs/providers/aws/vpclattice/index.md create mode 100644 docs/aws-docs/providers/aws/vpclattice/listener/index.md create mode 100644 docs/aws-docs/providers/aws/vpclattice/listeners/index.md create mode 100644 docs/aws-docs/providers/aws/vpclattice/resource_policies/index.md create mode 100644 docs/aws-docs/providers/aws/vpclattice/resource_policy/index.md create mode 100644 docs/aws-docs/providers/aws/vpclattice/rule/index.md create mode 100644 docs/aws-docs/providers/aws/vpclattice/rules/index.md create mode 100644 docs/aws-docs/providers/aws/vpclattice/service/index.md create mode 100644 docs/aws-docs/providers/aws/vpclattice/service_network/index.md create mode 100644 docs/aws-docs/providers/aws/vpclattice/service_network_service_association/index.md create mode 100644 docs/aws-docs/providers/aws/vpclattice/service_network_service_associations/index.md create mode 100644 docs/aws-docs/providers/aws/vpclattice/service_network_vpc_association/index.md create mode 100644 docs/aws-docs/providers/aws/vpclattice/service_network_vpc_associations/index.md create mode 100644 docs/aws-docs/providers/aws/vpclattice/service_networks/index.md create mode 100644 docs/aws-docs/providers/aws/vpclattice/services/index.md create mode 100644 docs/aws-docs/providers/aws/vpclattice/target_group/index.md create mode 100644 docs/aws-docs/providers/aws/vpclattice/target_groups/index.md create mode 100644 docs/aws-docs/providers/aws/wafv2/index.md create mode 100644 docs/aws-docs/providers/aws/wafv2/ip_set/index.md create mode 100644 docs/aws-docs/providers/aws/wafv2/ip_sets/index.md create mode 100644 docs/aws-docs/providers/aws/wafv2/logging_configuration/index.md create mode 100644 docs/aws-docs/providers/aws/wafv2/logging_configurations/index.md create mode 100644 docs/aws-docs/providers/aws/wafv2/regex_pattern_set/index.md create mode 100644 docs/aws-docs/providers/aws/wafv2/regex_pattern_sets/index.md create mode 100644 docs/aws-docs/providers/aws/wafv2/rule_group/index.md create mode 100644 docs/aws-docs/providers/aws/wafv2/rule_groups/index.md create mode 100644 docs/aws-docs/providers/aws/wafv2/web_acl/index.md create mode 100644 docs/aws-docs/providers/aws/wafv2/web_acls/index.md create mode 100644 docs/aws-docs/providers/aws/wafv2/webacl_association/index.md create mode 100644 docs/aws-docs/providers/aws/wafv2/webacl_associations/index.md create mode 100644 docs/aws-docs/providers/aws/wisdom/assistant/index.md create mode 100644 docs/aws-docs/providers/aws/wisdom/assistant_association/index.md create mode 100644 docs/aws-docs/providers/aws/wisdom/assistant_associations/index.md create mode 100644 docs/aws-docs/providers/aws/wisdom/assistants/index.md create mode 100644 docs/aws-docs/providers/aws/wisdom/index.md create mode 100644 docs/aws-docs/providers/aws/wisdom/knowledge_base/index.md create mode 100644 docs/aws-docs/providers/aws/wisdom/knowledge_bases/index.md create mode 100644 docs/aws-docs/providers/aws/workspaces/connection_alias/index.md create mode 100644 docs/aws-docs/providers/aws/workspaces/connection_aliases/index.md create mode 100644 docs/aws-docs/providers/aws/workspaces/index.md create mode 100644 docs/aws-docs/providers/aws/workspacesthinclient/environment/index.md create mode 100644 docs/aws-docs/providers/aws/workspacesthinclient/environments/index.md create mode 100644 docs/aws-docs/providers/aws/workspacesthinclient/index.md create mode 100644 docs/aws-docs/providers/aws/workspacesweb/browser_settings/index.md create mode 100644 docs/aws-docs/providers/aws/workspacesweb/identity_provider/index.md create mode 100644 docs/aws-docs/providers/aws/workspacesweb/identity_providers/index.md create mode 100644 docs/aws-docs/providers/aws/workspacesweb/index.md create mode 100644 docs/aws-docs/providers/aws/workspacesweb/ip_access_settings/index.md create mode 100644 docs/aws-docs/providers/aws/workspacesweb/network_settings/index.md create mode 100644 docs/aws-docs/providers/aws/workspacesweb/portal/index.md create mode 100644 docs/aws-docs/providers/aws/workspacesweb/portals/index.md create mode 100644 docs/aws-docs/providers/aws/workspacesweb/trust_store/index.md create mode 100644 docs/aws-docs/providers/aws/workspacesweb/trust_stores/index.md create mode 100644 docs/aws-docs/providers/aws/workspacesweb/user_access_logging_settings/index.md create mode 100644 docs/aws-docs/providers/aws/workspacesweb/user_settings/index.md create mode 100644 docs/aws-docs/providers/aws/xray/group/index.md create mode 100644 docs/aws-docs/providers/aws/xray/groups/index.md create mode 100644 docs/aws-docs/providers/aws/xray/index.md create mode 100644 docs/aws-docs/providers/aws/xray/resource_policies/index.md create mode 100644 docs/aws-docs/providers/aws/xray/resource_policy/index.md create mode 100644 docs/aws-docs/providers/aws/xray/sampling_rule/index.md create mode 100644 docs/aws-docs/providers/aws/xray/sampling_rules/index.md delete mode 100644 docs/awscc-docs/index.md delete mode 100644 docs/awscc-docs/providers/awscc/accessanalyzer/analyzer/index.md delete mode 100644 docs/awscc-docs/providers/awscc/accessanalyzer/analyzers/index.md delete mode 100644 docs/awscc-docs/providers/awscc/accessanalyzer/index.md delete mode 100644 docs/awscc-docs/providers/awscc/acmpca/certificate/index.md delete mode 100644 docs/awscc-docs/providers/awscc/acmpca/certificate_authorities/index.md delete mode 100644 docs/awscc-docs/providers/awscc/acmpca/certificate_authority/index.md delete mode 100644 docs/awscc-docs/providers/awscc/acmpca/certificate_authority_activation/index.md delete mode 100644 docs/awscc-docs/providers/awscc/acmpca/index.md delete mode 100644 docs/awscc-docs/providers/awscc/acmpca/permission/index.md delete mode 100644 docs/awscc-docs/providers/awscc/amplify/app/index.md delete mode 100644 docs/awscc-docs/providers/awscc/amplify/apps/index.md delete mode 100644 docs/awscc-docs/providers/awscc/amplify/branch/index.md delete mode 100644 docs/awscc-docs/providers/awscc/amplify/branches/index.md delete mode 100644 docs/awscc-docs/providers/awscc/amplify/domain/index.md delete mode 100644 docs/awscc-docs/providers/awscc/amplify/domains/index.md delete mode 100644 docs/awscc-docs/providers/awscc/amplify/index.md delete mode 100644 docs/awscc-docs/providers/awscc/amplifyuibuilder/component/index.md delete mode 100644 docs/awscc-docs/providers/awscc/amplifyuibuilder/components/index.md delete mode 100644 docs/awscc-docs/providers/awscc/amplifyuibuilder/form/index.md delete mode 100644 docs/awscc-docs/providers/awscc/amplifyuibuilder/forms/index.md delete mode 100644 docs/awscc-docs/providers/awscc/amplifyuibuilder/index.md delete mode 100644 docs/awscc-docs/providers/awscc/amplifyuibuilder/theme/index.md delete mode 100644 docs/awscc-docs/providers/awscc/amplifyuibuilder/themes/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigateway/account/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigateway/api_key/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigateway/api_keys/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigateway/authorizer/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigateway/authorizers/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigateway/base_path_mapping/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigateway/base_path_mappings/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigateway/client_certificate/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigateway/client_certificates/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigateway/deployment/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigateway/deployments/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigateway/documentation_part/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigateway/documentation_parts/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigateway/documentation_version/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigateway/documentation_versions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigateway/domain_name/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigateway/domain_names/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigateway/gateway_responses/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigateway/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigateway/method/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigateway/model/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigateway/models/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigateway/request_validator/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigateway/request_validators/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigateway/resource/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigateway/resources/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigateway/rest_api/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigateway/rest_apis/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigateway/stage/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigateway/stages/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigateway/usage_plan/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigateway/usage_plan_key/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigateway/usage_plan_keys/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigateway/usage_plans/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigateway/vpc_link/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigateway/vpc_links/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigatewayv2/api/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigatewayv2/api_mapping/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigatewayv2/api_mappings/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigatewayv2/apis/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigatewayv2/authorizer/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigatewayv2/authorizers/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigatewayv2/deployment/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigatewayv2/deployments/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigatewayv2/domain_name/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigatewayv2/domain_names/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigatewayv2/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigatewayv2/integration_response/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigatewayv2/integration_responses/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigatewayv2/model/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigatewayv2/models/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigatewayv2/route/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigatewayv2/route_response/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigatewayv2/route_responses/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigatewayv2/routes/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigatewayv2/vpc_link/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apigatewayv2/vpc_links/index.md delete mode 100644 docs/awscc-docs/providers/awscc/appconfig/application/index.md delete mode 100644 docs/awscc-docs/providers/awscc/appconfig/applications/index.md delete mode 100644 docs/awscc-docs/providers/awscc/appconfig/configuration_profile/index.md delete mode 100644 docs/awscc-docs/providers/awscc/appconfig/configuration_profiles/index.md delete mode 100644 docs/awscc-docs/providers/awscc/appconfig/environment/index.md delete mode 100644 docs/awscc-docs/providers/awscc/appconfig/environments/index.md delete mode 100644 docs/awscc-docs/providers/awscc/appconfig/extension/index.md delete mode 100644 docs/awscc-docs/providers/awscc/appconfig/extension_association/index.md delete mode 100644 docs/awscc-docs/providers/awscc/appconfig/extension_associations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/appconfig/extensions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/appconfig/hosted_configuration_version/index.md delete mode 100644 docs/awscc-docs/providers/awscc/appconfig/hosted_configuration_versions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/appconfig/index.md delete mode 100644 docs/awscc-docs/providers/awscc/appflow/connector/index.md delete mode 100644 docs/awscc-docs/providers/awscc/appflow/connector_profile/index.md delete mode 100644 docs/awscc-docs/providers/awscc/appflow/connector_profiles/index.md delete mode 100644 docs/awscc-docs/providers/awscc/appflow/connectors/index.md delete mode 100644 docs/awscc-docs/providers/awscc/appflow/flow/index.md delete mode 100644 docs/awscc-docs/providers/awscc/appflow/flows/index.md delete mode 100644 docs/awscc-docs/providers/awscc/appflow/index.md delete mode 100644 docs/awscc-docs/providers/awscc/appintegrations/data_integration/index.md delete mode 100644 docs/awscc-docs/providers/awscc/appintegrations/data_integrations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/appintegrations/event_integration/index.md delete mode 100644 docs/awscc-docs/providers/awscc/appintegrations/event_integrations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/appintegrations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/applicationautoscaling/index.md delete mode 100644 docs/awscc-docs/providers/awscc/applicationautoscaling/scalable_target/index.md delete mode 100644 docs/awscc-docs/providers/awscc/applicationautoscaling/scalable_targets/index.md delete mode 100644 docs/awscc-docs/providers/awscc/applicationautoscaling/scaling_policies/index.md delete mode 100644 docs/awscc-docs/providers/awscc/applicationautoscaling/scaling_policy/index.md delete mode 100644 docs/awscc-docs/providers/awscc/applicationinsights/application/index.md delete mode 100644 docs/awscc-docs/providers/awscc/applicationinsights/applications/index.md delete mode 100644 docs/awscc-docs/providers/awscc/applicationinsights/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apprunner/auto_scaling_configuration/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apprunner/auto_scaling_configurations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apprunner/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apprunner/observability_configuration/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apprunner/observability_configurations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apprunner/service/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apprunner/services/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apprunner/vpc_connector/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apprunner/vpc_connectors/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apprunner/vpc_ingress_connection/index.md delete mode 100644 docs/awscc-docs/providers/awscc/apprunner/vpc_ingress_connections/index.md delete mode 100644 docs/awscc-docs/providers/awscc/appstream/app_block/index.md delete mode 100644 docs/awscc-docs/providers/awscc/appstream/app_block_builder/index.md delete mode 100644 docs/awscc-docs/providers/awscc/appstream/app_block_builders/index.md delete mode 100644 docs/awscc-docs/providers/awscc/appstream/application/index.md delete mode 100644 docs/awscc-docs/providers/awscc/appstream/application_entitlement_association/index.md delete mode 100644 docs/awscc-docs/providers/awscc/appstream/application_fleet_association/index.md delete mode 100644 docs/awscc-docs/providers/awscc/appstream/directory_config/index.md delete mode 100644 docs/awscc-docs/providers/awscc/appstream/directory_configs/index.md delete mode 100644 docs/awscc-docs/providers/awscc/appstream/entitlement/index.md delete mode 100644 docs/awscc-docs/providers/awscc/appstream/image_builder/index.md delete mode 100644 docs/awscc-docs/providers/awscc/appstream/image_builders/index.md delete mode 100644 docs/awscc-docs/providers/awscc/appstream/index.md delete mode 100644 docs/awscc-docs/providers/awscc/appsync/domain_name/index.md delete mode 100644 docs/awscc-docs/providers/awscc/appsync/domain_name_api_association/index.md delete mode 100644 docs/awscc-docs/providers/awscc/appsync/domain_names/index.md delete mode 100644 docs/awscc-docs/providers/awscc/appsync/function_configuration/index.md delete mode 100644 docs/awscc-docs/providers/awscc/appsync/function_configurations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/appsync/index.md delete mode 100644 docs/awscc-docs/providers/awscc/appsync/resolver/index.md delete mode 100644 docs/awscc-docs/providers/awscc/appsync/resolvers/index.md delete mode 100644 docs/awscc-docs/providers/awscc/appsync/source_api_association/index.md delete mode 100644 docs/awscc-docs/providers/awscc/appsync/source_api_associations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/aps/index.md delete mode 100644 docs/awscc-docs/providers/awscc/aps/rule_groups_namespace/index.md delete mode 100644 docs/awscc-docs/providers/awscc/aps/rule_groups_namespaces/index.md delete mode 100644 docs/awscc-docs/providers/awscc/aps/workspace/index.md delete mode 100644 docs/awscc-docs/providers/awscc/aps/workspaces/index.md delete mode 100644 docs/awscc-docs/providers/awscc/arczonalshift/index.md delete mode 100644 docs/awscc-docs/providers/awscc/arczonalshift/zonal_autoshift_configuration/index.md delete mode 100644 docs/awscc-docs/providers/awscc/arczonalshift/zonal_autoshift_configurations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/athena/capacity_reservation/index.md delete mode 100644 docs/awscc-docs/providers/awscc/athena/capacity_reservations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/athena/data_catalog/index.md delete mode 100644 docs/awscc-docs/providers/awscc/athena/data_catalogs/index.md delete mode 100644 docs/awscc-docs/providers/awscc/athena/index.md delete mode 100644 docs/awscc-docs/providers/awscc/athena/named_queries/index.md delete mode 100644 docs/awscc-docs/providers/awscc/athena/named_query/index.md delete mode 100644 docs/awscc-docs/providers/awscc/athena/prepared_statement/index.md delete mode 100644 docs/awscc-docs/providers/awscc/athena/prepared_statements/index.md delete mode 100644 docs/awscc-docs/providers/awscc/athena/work_group/index.md delete mode 100644 docs/awscc-docs/providers/awscc/athena/work_groups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/auditmanager/assessment/index.md delete mode 100644 docs/awscc-docs/providers/awscc/auditmanager/assessments/index.md delete mode 100644 docs/awscc-docs/providers/awscc/auditmanager/index.md delete mode 100644 docs/awscc-docs/providers/awscc/autoscaling/auto_scaling_group/index.md delete mode 100644 docs/awscc-docs/providers/awscc/autoscaling/auto_scaling_groups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/autoscaling/index.md delete mode 100644 docs/awscc-docs/providers/awscc/autoscaling/launch_configuration/index.md delete mode 100644 docs/awscc-docs/providers/awscc/autoscaling/launch_configurations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/autoscaling/lifecycle_hook/index.md delete mode 100644 docs/awscc-docs/providers/awscc/autoscaling/lifecycle_hooks/index.md delete mode 100644 docs/awscc-docs/providers/awscc/autoscaling/scaling_policies/index.md delete mode 100644 docs/awscc-docs/providers/awscc/autoscaling/scaling_policy/index.md delete mode 100644 docs/awscc-docs/providers/awscc/autoscaling/scheduled_action/index.md delete mode 100644 docs/awscc-docs/providers/awscc/autoscaling/scheduled_actions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/autoscaling/warm_pool/index.md delete mode 100644 docs/awscc-docs/providers/awscc/b2bi/capabilities/index.md delete mode 100644 docs/awscc-docs/providers/awscc/b2bi/capability/index.md delete mode 100644 docs/awscc-docs/providers/awscc/b2bi/index.md delete mode 100644 docs/awscc-docs/providers/awscc/b2bi/partnership/index.md delete mode 100644 docs/awscc-docs/providers/awscc/b2bi/partnerships/index.md delete mode 100644 docs/awscc-docs/providers/awscc/b2bi/profile/index.md delete mode 100644 docs/awscc-docs/providers/awscc/b2bi/profiles/index.md delete mode 100644 docs/awscc-docs/providers/awscc/b2bi/transformer/index.md delete mode 100644 docs/awscc-docs/providers/awscc/b2bi/transformers/index.md delete mode 100644 docs/awscc-docs/providers/awscc/backup/backup_plan/index.md delete mode 100644 docs/awscc-docs/providers/awscc/backup/backup_plans/index.md delete mode 100644 docs/awscc-docs/providers/awscc/backup/backup_selection/index.md delete mode 100644 docs/awscc-docs/providers/awscc/backup/backup_selections/index.md delete mode 100644 docs/awscc-docs/providers/awscc/backup/backup_vault/index.md delete mode 100644 docs/awscc-docs/providers/awscc/backup/backup_vaults/index.md delete mode 100644 docs/awscc-docs/providers/awscc/backup/framework/index.md delete mode 100644 docs/awscc-docs/providers/awscc/backup/frameworks/index.md delete mode 100644 docs/awscc-docs/providers/awscc/backup/index.md delete mode 100644 docs/awscc-docs/providers/awscc/backup/report_plan/index.md delete mode 100644 docs/awscc-docs/providers/awscc/backup/report_plans/index.md delete mode 100644 docs/awscc-docs/providers/awscc/backup/restore_testing_plan/index.md delete mode 100644 docs/awscc-docs/providers/awscc/backup/restore_testing_plans/index.md delete mode 100644 docs/awscc-docs/providers/awscc/backup/restore_testing_selection/index.md delete mode 100644 docs/awscc-docs/providers/awscc/backup/restore_testing_selections/index.md delete mode 100644 docs/awscc-docs/providers/awscc/backupgateway/hypervisor/index.md delete mode 100644 docs/awscc-docs/providers/awscc/backupgateway/hypervisors/index.md delete mode 100644 docs/awscc-docs/providers/awscc/backupgateway/index.md delete mode 100644 docs/awscc-docs/providers/awscc/batch/compute_environment/index.md delete mode 100644 docs/awscc-docs/providers/awscc/batch/compute_environments/index.md delete mode 100644 docs/awscc-docs/providers/awscc/batch/index.md delete mode 100644 docs/awscc-docs/providers/awscc/batch/job_queue/index.md delete mode 100644 docs/awscc-docs/providers/awscc/batch/job_queues/index.md delete mode 100644 docs/awscc-docs/providers/awscc/batch/scheduling_policies/index.md delete mode 100644 docs/awscc-docs/providers/awscc/batch/scheduling_policy/index.md delete mode 100644 docs/awscc-docs/providers/awscc/billingconductor/billing_group/index.md delete mode 100644 docs/awscc-docs/providers/awscc/billingconductor/billing_groups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/billingconductor/custom_line_item/index.md delete mode 100644 docs/awscc-docs/providers/awscc/billingconductor/custom_line_items/index.md delete mode 100644 docs/awscc-docs/providers/awscc/billingconductor/index.md delete mode 100644 docs/awscc-docs/providers/awscc/billingconductor/pricing_plan/index.md delete mode 100644 docs/awscc-docs/providers/awscc/billingconductor/pricing_plans/index.md delete mode 100644 docs/awscc-docs/providers/awscc/billingconductor/pricing_rule/index.md delete mode 100644 docs/awscc-docs/providers/awscc/billingconductor/pricing_rules/index.md delete mode 100644 docs/awscc-docs/providers/awscc/budgets/budgets_action/index.md delete mode 100644 docs/awscc-docs/providers/awscc/budgets/budgets_actions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/budgets/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cassandra/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cassandra/keyspace/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cassandra/keyspaces/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cassandra/table/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cassandra/tables/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ce/anomaly_monitor/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ce/anomaly_monitors/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ce/anomaly_subscription/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ce/anomaly_subscriptions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ce/cost_categories/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ce/cost_category/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ce/index.md delete mode 100644 docs/awscc-docs/providers/awscc/certificatemanager/account/index.md delete mode 100644 docs/awscc-docs/providers/awscc/certificatemanager/index.md delete mode 100644 docs/awscc-docs/providers/awscc/chatbot/index.md delete mode 100644 docs/awscc-docs/providers/awscc/chatbot/microsoft_teams_channel_configuration/index.md delete mode 100644 docs/awscc-docs/providers/awscc/chatbot/microsoft_teams_channel_configurations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/chatbot/slack_channel_configuration/index.md delete mode 100644 docs/awscc-docs/providers/awscc/chatbot/slack_channel_configurations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cleanrooms/analysis_template/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cleanrooms/analysis_templates/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cleanrooms/collaboration/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cleanrooms/collaborations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cleanrooms/configured_table/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cleanrooms/configured_table_association/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cleanrooms/configured_table_associations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cleanrooms/configured_tables/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cleanrooms/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cleanrooms/membership/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cleanrooms/memberships/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloud_control/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloud_control/resource/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloud_control/resource_request/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloud_control/resource_requests/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloud_control/resources/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudformation/hook_default_version/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudformation/hook_default_versions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudformation/hook_type_config/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudformation/hook_type_configs/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudformation/hook_version/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudformation/hook_versions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudformation/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudformation/module_default_version/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudformation/module_default_versions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudformation/module_version/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudformation/public_type_version/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudformation/public_type_versions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudformation/publisher/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudformation/publishers/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudformation/resource_default_version/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudformation/resource_default_versions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudformation/resource_version/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudformation/resource_versions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudformation/stack/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudformation/stack_set/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudformation/stack_sets/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudformation/stacks/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudformation/type_activation/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudformation/type_activations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudfront/cache_policies/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudfront/cache_policy/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudfront/cloud_front_origin_access_identities/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudfront/cloud_front_origin_access_identity/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudfront/continuous_deployment_policies/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudfront/continuous_deployment_policy/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudfront/distribution/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudfront/distributions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudfront/function/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudfront/functions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudfront/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudfront/key_group/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudfront/key_groups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudfront/key_value_store/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudfront/key_value_stores/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudfront/monitoring_subscription/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudfront/origin_access_control/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudfront/origin_access_controls/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudfront/origin_request_policies/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudfront/origin_request_policy/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudfront/public_key/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudfront/public_keys/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudfront/realtime_log_config/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudfront/realtime_log_configs/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudfront/response_headers_policies/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudfront/response_headers_policy/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudtrail/channel/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudtrail/channels/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudtrail/event_data_store/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudtrail/event_data_stores/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudtrail/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudtrail/resource_policy/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudtrail/trail/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudtrail/trails/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudwatch/alarm/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudwatch/alarms/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudwatch/composite_alarm/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudwatch/composite_alarms/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudwatch/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudwatch/metric_stream/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cloudwatch/metric_streams/index.md delete mode 100644 docs/awscc-docs/providers/awscc/codeartifact/domain/index.md delete mode 100644 docs/awscc-docs/providers/awscc/codeartifact/domains/index.md delete mode 100644 docs/awscc-docs/providers/awscc/codeartifact/index.md delete mode 100644 docs/awscc-docs/providers/awscc/codeartifact/repositories/index.md delete mode 100644 docs/awscc-docs/providers/awscc/codeartifact/repository/index.md delete mode 100644 docs/awscc-docs/providers/awscc/codebuild/fleet/index.md delete mode 100644 docs/awscc-docs/providers/awscc/codebuild/fleets/index.md delete mode 100644 docs/awscc-docs/providers/awscc/codebuild/index.md delete mode 100644 docs/awscc-docs/providers/awscc/codedeploy/application/index.md delete mode 100644 docs/awscc-docs/providers/awscc/codedeploy/applications/index.md delete mode 100644 docs/awscc-docs/providers/awscc/codedeploy/deployment_config/index.md delete mode 100644 docs/awscc-docs/providers/awscc/codedeploy/deployment_configs/index.md delete mode 100644 docs/awscc-docs/providers/awscc/codedeploy/index.md delete mode 100644 docs/awscc-docs/providers/awscc/codeguruprofiler/index.md delete mode 100644 docs/awscc-docs/providers/awscc/codeguruprofiler/profiling_group/index.md delete mode 100644 docs/awscc-docs/providers/awscc/codeguruprofiler/profiling_groups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/codegurureviewer/index.md delete mode 100644 docs/awscc-docs/providers/awscc/codegurureviewer/repository_association/index.md delete mode 100644 docs/awscc-docs/providers/awscc/codegurureviewer/repository_associations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/codepipeline/custom_action_type/index.md delete mode 100644 docs/awscc-docs/providers/awscc/codepipeline/custom_action_types/index.md delete mode 100644 docs/awscc-docs/providers/awscc/codepipeline/index.md delete mode 100644 docs/awscc-docs/providers/awscc/codestarconnections/connection/index.md delete mode 100644 docs/awscc-docs/providers/awscc/codestarconnections/connections/index.md delete mode 100644 docs/awscc-docs/providers/awscc/codestarconnections/index.md delete mode 100644 docs/awscc-docs/providers/awscc/codestarconnections/repository_link/index.md delete mode 100644 docs/awscc-docs/providers/awscc/codestarconnections/repository_links/index.md delete mode 100644 docs/awscc-docs/providers/awscc/codestarconnections/sync_configuration/index.md delete mode 100644 docs/awscc-docs/providers/awscc/codestarconnections/sync_configurations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/codestarnotifications/index.md delete mode 100644 docs/awscc-docs/providers/awscc/codestarnotifications/notification_rule/index.md delete mode 100644 docs/awscc-docs/providers/awscc/codestarnotifications/notification_rules/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cognito/identity_pool/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cognito/identity_pool_principal_tag/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cognito/identity_pool_principal_tags/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cognito/identity_pool_role_attachment/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cognito/identity_pool_role_attachments/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cognito/identity_pools/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cognito/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cognito/log_delivery_configuration/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cognito/user_pool/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cognito/user_pool_client/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cognito/user_pool_clients/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cognito/user_pool_group/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cognito/user_pool_groups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cognito/user_pool_risk_configuration_attachment/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cognito/user_pool_user/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cognito/user_pool_user_to_group_attachment/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cognito/user_pool_users/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cognito/user_pools/index.md delete mode 100644 docs/awscc-docs/providers/awscc/comprehend/document_classifier/index.md delete mode 100644 docs/awscc-docs/providers/awscc/comprehend/document_classifiers/index.md delete mode 100644 docs/awscc-docs/providers/awscc/comprehend/flywheel/index.md delete mode 100644 docs/awscc-docs/providers/awscc/comprehend/flywheels/index.md delete mode 100644 docs/awscc-docs/providers/awscc/comprehend/index.md delete mode 100644 docs/awscc-docs/providers/awscc/config/aggregation_authorization/index.md delete mode 100644 docs/awscc-docs/providers/awscc/config/aggregation_authorizations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/config/config_rule/index.md delete mode 100644 docs/awscc-docs/providers/awscc/config/config_rules/index.md delete mode 100644 docs/awscc-docs/providers/awscc/config/configuration_aggregator/index.md delete mode 100644 docs/awscc-docs/providers/awscc/config/configuration_aggregators/index.md delete mode 100644 docs/awscc-docs/providers/awscc/config/conformance_pack/index.md delete mode 100644 docs/awscc-docs/providers/awscc/config/conformance_packs/index.md delete mode 100644 docs/awscc-docs/providers/awscc/config/index.md delete mode 100644 docs/awscc-docs/providers/awscc/config/organization_conformance_pack/index.md delete mode 100644 docs/awscc-docs/providers/awscc/config/organization_conformance_packs/index.md delete mode 100644 docs/awscc-docs/providers/awscc/config/stored_queries/index.md delete mode 100644 docs/awscc-docs/providers/awscc/config/stored_query/index.md delete mode 100644 docs/awscc-docs/providers/awscc/connect/approved_origin/index.md delete mode 100644 docs/awscc-docs/providers/awscc/connect/approved_origins/index.md delete mode 100644 docs/awscc-docs/providers/awscc/connect/contact_flow/index.md delete mode 100644 docs/awscc-docs/providers/awscc/connect/contact_flow_module/index.md delete mode 100644 docs/awscc-docs/providers/awscc/connect/contact_flow_modules/index.md delete mode 100644 docs/awscc-docs/providers/awscc/connect/contact_flows/index.md delete mode 100644 docs/awscc-docs/providers/awscc/connect/evaluation_form/index.md delete mode 100644 docs/awscc-docs/providers/awscc/connect/evaluation_forms/index.md delete mode 100644 docs/awscc-docs/providers/awscc/connect/hours_of_operation/index.md delete mode 100644 docs/awscc-docs/providers/awscc/connect/hours_of_operations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/connect/index.md delete mode 100644 docs/awscc-docs/providers/awscc/connect/instance/index.md delete mode 100644 docs/awscc-docs/providers/awscc/connect/instance_storage_config/index.md delete mode 100644 docs/awscc-docs/providers/awscc/connect/instance_storage_configs/index.md delete mode 100644 docs/awscc-docs/providers/awscc/connect/instances/index.md delete mode 100644 docs/awscc-docs/providers/awscc/connect/integration_association/index.md delete mode 100644 docs/awscc-docs/providers/awscc/connect/integration_associations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/connect/predefined_attribute/index.md delete mode 100644 docs/awscc-docs/providers/awscc/connect/predefined_attributes/index.md delete mode 100644 docs/awscc-docs/providers/awscc/connect/prompt/index.md delete mode 100644 docs/awscc-docs/providers/awscc/connect/prompts/index.md delete mode 100644 docs/awscc-docs/providers/awscc/connect/queue/index.md delete mode 100644 docs/awscc-docs/providers/awscc/connect/queues/index.md delete mode 100644 docs/awscc-docs/providers/awscc/connect/quick_connect/index.md delete mode 100644 docs/awscc-docs/providers/awscc/connect/quick_connects/index.md delete mode 100644 docs/awscc-docs/providers/awscc/connect/routing_profile/index.md delete mode 100644 docs/awscc-docs/providers/awscc/connect/routing_profiles/index.md delete mode 100644 docs/awscc-docs/providers/awscc/connect/rule/index.md delete mode 100644 docs/awscc-docs/providers/awscc/connect/security_key/index.md delete mode 100644 docs/awscc-docs/providers/awscc/connect/security_keys/index.md delete mode 100644 docs/awscc-docs/providers/awscc/connect/security_profile/index.md delete mode 100644 docs/awscc-docs/providers/awscc/connect/security_profiles/index.md delete mode 100644 docs/awscc-docs/providers/awscc/connect/task_template/index.md delete mode 100644 docs/awscc-docs/providers/awscc/connect/task_templates/index.md delete mode 100644 docs/awscc-docs/providers/awscc/connect/traffic_distribution_group/index.md delete mode 100644 docs/awscc-docs/providers/awscc/connect/traffic_distribution_groups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/connect/user/index.md delete mode 100644 docs/awscc-docs/providers/awscc/connect/user_hierarchy_group/index.md delete mode 100644 docs/awscc-docs/providers/awscc/connect/user_hierarchy_groups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/connect/users/index.md delete mode 100644 docs/awscc-docs/providers/awscc/connect/view/index.md delete mode 100644 docs/awscc-docs/providers/awscc/connect/view_version/index.md delete mode 100644 docs/awscc-docs/providers/awscc/connect/view_versions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/connect/views/index.md delete mode 100644 docs/awscc-docs/providers/awscc/connectcampaigns/campaign/index.md delete mode 100644 docs/awscc-docs/providers/awscc/connectcampaigns/campaigns/index.md delete mode 100644 docs/awscc-docs/providers/awscc/connectcampaigns/index.md delete mode 100644 docs/awscc-docs/providers/awscc/controltower/enabled_baseline/index.md delete mode 100644 docs/awscc-docs/providers/awscc/controltower/enabled_baselines/index.md delete mode 100644 docs/awscc-docs/providers/awscc/controltower/enabled_control/index.md delete mode 100644 docs/awscc-docs/providers/awscc/controltower/enabled_controls/index.md delete mode 100644 docs/awscc-docs/providers/awscc/controltower/index.md delete mode 100644 docs/awscc-docs/providers/awscc/controltower/landing_zone/index.md delete mode 100644 docs/awscc-docs/providers/awscc/controltower/landing_zones/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cur/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cur/report_definition/index.md delete mode 100644 docs/awscc-docs/providers/awscc/cur/report_definitions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/customerprofiles/calculated_attribute_definition/index.md delete mode 100644 docs/awscc-docs/providers/awscc/customerprofiles/calculated_attribute_definitions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/customerprofiles/domain/index.md delete mode 100644 docs/awscc-docs/providers/awscc/customerprofiles/domains/index.md delete mode 100644 docs/awscc-docs/providers/awscc/customerprofiles/event_stream/index.md delete mode 100644 docs/awscc-docs/providers/awscc/customerprofiles/event_streams/index.md delete mode 100644 docs/awscc-docs/providers/awscc/customerprofiles/index.md delete mode 100644 docs/awscc-docs/providers/awscc/customerprofiles/integration/index.md delete mode 100644 docs/awscc-docs/providers/awscc/customerprofiles/integrations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/customerprofiles/object_type/index.md delete mode 100644 docs/awscc-docs/providers/awscc/customerprofiles/object_types/index.md delete mode 100644 docs/awscc-docs/providers/awscc/databrew/dataset/index.md delete mode 100644 docs/awscc-docs/providers/awscc/databrew/datasets/index.md delete mode 100644 docs/awscc-docs/providers/awscc/databrew/index.md delete mode 100644 docs/awscc-docs/providers/awscc/databrew/job/index.md delete mode 100644 docs/awscc-docs/providers/awscc/databrew/jobs/index.md delete mode 100644 docs/awscc-docs/providers/awscc/databrew/project/index.md delete mode 100644 docs/awscc-docs/providers/awscc/databrew/projects/index.md delete mode 100644 docs/awscc-docs/providers/awscc/databrew/recipe/index.md delete mode 100644 docs/awscc-docs/providers/awscc/databrew/recipes/index.md delete mode 100644 docs/awscc-docs/providers/awscc/databrew/ruleset/index.md delete mode 100644 docs/awscc-docs/providers/awscc/databrew/rulesets/index.md delete mode 100644 docs/awscc-docs/providers/awscc/databrew/schedule/index.md delete mode 100644 docs/awscc-docs/providers/awscc/databrew/schedules/index.md delete mode 100644 docs/awscc-docs/providers/awscc/datapipeline/index.md delete mode 100644 docs/awscc-docs/providers/awscc/datapipeline/pipeline/index.md delete mode 100644 docs/awscc-docs/providers/awscc/datapipeline/pipelines/index.md delete mode 100644 docs/awscc-docs/providers/awscc/datasync/agent/index.md delete mode 100644 docs/awscc-docs/providers/awscc/datasync/agents/index.md delete mode 100644 docs/awscc-docs/providers/awscc/datasync/index.md delete mode 100644 docs/awscc-docs/providers/awscc/datasync/location_azure_blob/index.md delete mode 100644 docs/awscc-docs/providers/awscc/datasync/location_azure_blobs/index.md delete mode 100644 docs/awscc-docs/providers/awscc/datasync/location_efs/index.md delete mode 100644 docs/awscc-docs/providers/awscc/datasync/location_hdfs/index.md delete mode 100644 docs/awscc-docs/providers/awscc/datasync/location_nfs/index.md delete mode 100644 docs/awscc-docs/providers/awscc/datasync/location_object_storage/index.md delete mode 100644 docs/awscc-docs/providers/awscc/datasync/location_object_storages/index.md delete mode 100644 docs/awscc-docs/providers/awscc/datasync/location_s3/index.md delete mode 100644 docs/awscc-docs/providers/awscc/datasync/location_s3s/index.md delete mode 100644 docs/awscc-docs/providers/awscc/datasync/location_smb/index.md delete mode 100644 docs/awscc-docs/providers/awscc/datasync/location_smbs/index.md delete mode 100644 docs/awscc-docs/providers/awscc/datasync/locationf_sx_lustre/index.md delete mode 100644 docs/awscc-docs/providers/awscc/datasync/locationf_sx_lustres/index.md delete mode 100644 docs/awscc-docs/providers/awscc/datasync/locationf_sx_ontap/index.md delete mode 100644 docs/awscc-docs/providers/awscc/datasync/locationf_sx_ontaps/index.md delete mode 100644 docs/awscc-docs/providers/awscc/datasync/locationf_sx_open_zfs/index.md delete mode 100644 docs/awscc-docs/providers/awscc/datasync/locationf_sx_windows/index.md delete mode 100644 docs/awscc-docs/providers/awscc/datasync/storage_system/index.md delete mode 100644 docs/awscc-docs/providers/awscc/datasync/storage_systems/index.md delete mode 100644 docs/awscc-docs/providers/awscc/datasync/task/index.md delete mode 100644 docs/awscc-docs/providers/awscc/datasync/tasks/index.md delete mode 100644 docs/awscc-docs/providers/awscc/datazone/data_source/index.md delete mode 100644 docs/awscc-docs/providers/awscc/datazone/data_sources/index.md delete mode 100644 docs/awscc-docs/providers/awscc/datazone/domain/index.md delete mode 100644 docs/awscc-docs/providers/awscc/datazone/domains/index.md delete mode 100644 docs/awscc-docs/providers/awscc/datazone/environment/index.md delete mode 100644 docs/awscc-docs/providers/awscc/datazone/environment_blueprint_configuration/index.md delete mode 100644 docs/awscc-docs/providers/awscc/datazone/environment_blueprint_configurations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/datazone/environment_profile/index.md delete mode 100644 docs/awscc-docs/providers/awscc/datazone/environment_profiles/index.md delete mode 100644 docs/awscc-docs/providers/awscc/datazone/environments/index.md delete mode 100644 docs/awscc-docs/providers/awscc/datazone/index.md delete mode 100644 docs/awscc-docs/providers/awscc/datazone/project/index.md delete mode 100644 docs/awscc-docs/providers/awscc/datazone/projects/index.md delete mode 100644 docs/awscc-docs/providers/awscc/datazone/subscription_target/index.md delete mode 100644 docs/awscc-docs/providers/awscc/datazone/subscription_targets/index.md delete mode 100644 docs/awscc-docs/providers/awscc/detective/graph/index.md delete mode 100644 docs/awscc-docs/providers/awscc/detective/graphs/index.md delete mode 100644 docs/awscc-docs/providers/awscc/detective/index.md delete mode 100644 docs/awscc-docs/providers/awscc/detective/member_invitation/index.md delete mode 100644 docs/awscc-docs/providers/awscc/detective/member_invitations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/detective/organization_admin/index.md delete mode 100644 docs/awscc-docs/providers/awscc/detective/organization_admins/index.md delete mode 100644 docs/awscc-docs/providers/awscc/devopsguru/index.md delete mode 100644 docs/awscc-docs/providers/awscc/devopsguru/log_anomaly_detection_integration/index.md delete mode 100644 docs/awscc-docs/providers/awscc/devopsguru/log_anomaly_detection_integrations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/devopsguru/notification_channel/index.md delete mode 100644 docs/awscc-docs/providers/awscc/devopsguru/notification_channels/index.md delete mode 100644 docs/awscc-docs/providers/awscc/devopsguru/resource_collection/index.md delete mode 100644 docs/awscc-docs/providers/awscc/devopsguru/resource_collections/index.md delete mode 100644 docs/awscc-docs/providers/awscc/directoryservice/index.md delete mode 100644 docs/awscc-docs/providers/awscc/directoryservice/simple_ad/index.md delete mode 100644 docs/awscc-docs/providers/awscc/directoryservice/simple_ads/index.md delete mode 100644 docs/awscc-docs/providers/awscc/dms/data_provider/index.md delete mode 100644 docs/awscc-docs/providers/awscc/dms/data_providers/index.md delete mode 100644 docs/awscc-docs/providers/awscc/dms/index.md delete mode 100644 docs/awscc-docs/providers/awscc/dms/instance_profile/index.md delete mode 100644 docs/awscc-docs/providers/awscc/dms/instance_profiles/index.md delete mode 100644 docs/awscc-docs/providers/awscc/dms/migration_project/index.md delete mode 100644 docs/awscc-docs/providers/awscc/dms/migration_projects/index.md delete mode 100644 docs/awscc-docs/providers/awscc/dms/replication_config/index.md delete mode 100644 docs/awscc-docs/providers/awscc/dms/replication_configs/index.md delete mode 100644 docs/awscc-docs/providers/awscc/docdbelastic/cluster/index.md delete mode 100644 docs/awscc-docs/providers/awscc/docdbelastic/clusters/index.md delete mode 100644 docs/awscc-docs/providers/awscc/docdbelastic/index.md delete mode 100644 docs/awscc-docs/providers/awscc/dynamodb/global_table/index.md delete mode 100644 docs/awscc-docs/providers/awscc/dynamodb/global_tables/index.md delete mode 100644 docs/awscc-docs/providers/awscc/dynamodb/index.md delete mode 100644 docs/awscc-docs/providers/awscc/dynamodb/table/index.md delete mode 100644 docs/awscc-docs/providers/awscc/dynamodb/tables/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/capacity_reservation/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/capacity_reservation_fleet/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/capacity_reservation_fleets/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/capacity_reservations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/carrier_gateway/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/carrier_gateways/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/customer_gateway/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/customer_gateways/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/dhcp_options/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/ec2fleet/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/ec2fleets/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/egress_only_internet_gateway/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/egress_only_internet_gateways/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/eip/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/eip_association/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/eip_associations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/eips/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/enclave_certificate_iam_role_association/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/enclave_certificate_iam_role_associations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/flow_log/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/flow_logs/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/gateway_route_table_association/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/host/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/hosts/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/instance_connect_endpoint/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/instance_connect_endpoints/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/instances/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/internet_gateway/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/internet_gateways/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/ipam/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/ipam_allocation/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/ipam_allocations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/ipam_pool/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/ipam_pool_cidr/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/ipam_pool_cidrs/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/ipam_pools/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/ipam_resource_discoveries/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/ipam_resource_discovery/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/ipam_resource_discovery_association/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/ipam_resource_discovery_associations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/ipam_scope/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/ipam_scopes/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/ipams/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/key_pair/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/key_pairs/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/launch_template/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/launch_templates/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/local_gateway_route/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/local_gateway_route_table/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/local_gateway_route_table_virtual_interface_group_association/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/local_gateway_route_table_virtual_interface_group_associations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/local_gateway_route_tables/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/local_gateway_route_tablevpc_association/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/local_gateway_route_tablevpc_associations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/local_gateway_routes/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/nat_gateway/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/nat_gateways/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/network_acl/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/network_acls/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/network_insights_access_scope/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/network_insights_access_scope_analyses/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/network_insights_access_scope_analysis/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/network_insights_access_scopes/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/network_insights_analyses/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/network_insights_analysis/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/network_insights_path/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/network_insights_paths/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/network_interface/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/network_interface_attachment/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/network_interface_attachments/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/network_interfaces/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/network_performance_metric_subscription/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/network_performance_metric_subscriptions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/placement_group/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/placement_groups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/prefix_list/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/prefix_lists/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/route/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/route_table/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/route_tables/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/routes/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/security_group_egress/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/security_group_egresses/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/security_group_ingress/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/security_group_ingresses/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/snapshot_block_public_access/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/snapshot_block_public_accesses/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/snapshots/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/spot_fleet/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/spot_fleets/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/subnet/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/subnet_cidr_block/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/subnet_cidr_blocks/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/subnet_network_acl_association/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/subnet_network_acl_associations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/subnet_route_table_association/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/subnet_route_table_associations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/subnets/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/transit_gateway/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/transit_gateway_attachment/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/transit_gateway_attachments/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/transit_gateway_connect/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/transit_gateway_connects/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/transit_gateway_multicast_domain/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/transit_gateway_multicast_domain_association/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/transit_gateway_multicast_domain_associations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/transit_gateway_multicast_domains/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/transit_gateway_multicast_group_member/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/transit_gateway_multicast_group_members/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/transit_gateway_multicast_group_source/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/transit_gateway_multicast_group_sources/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/transit_gateway_peering_attachment/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/transit_gateway_peering_attachments/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/transit_gateway_route_table/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/transit_gateway_route_tables/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/transit_gateway_vpc_attachment/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/transit_gateway_vpc_attachments/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/transit_gateways/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/verified_access_endpoint/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/verified_access_endpoints/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/verified_access_group/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/verified_access_groups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/verified_access_instance/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/verified_access_instances/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/verified_access_trust_provider/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/verified_access_trust_providers/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/volume/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/volume_attachment/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/volume_attachments/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/volumes/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/vpc/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/vpc_endpoint/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/vpc_endpoint_connection_notification/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/vpc_endpoint_connection_notifications/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/vpc_endpoint_service/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/vpc_endpoint_service_permissions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/vpc_endpoint_services/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/vpc_endpoints/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/vpc_gateway_attachment/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/vpc_gateway_attachments/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/vpc_peering_connection/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/vpc_peering_connections/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/vpcdhcp_options_association/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/vpcdhcp_options_associations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/vpcs/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/vpn_connection/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/vpn_connection_route/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/vpn_connection_routes/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/vpn_connections/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/vpn_gateway/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ec2/vpn_gateways/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ecr/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ecr/public_repositories/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ecr/public_repository/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ecr/pull_through_cache_rule/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ecr/pull_through_cache_rules/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ecr/registry_policies/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ecr/registry_policy/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ecr/replication_configuration/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ecr/replication_configurations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ecr/repositories/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ecr/repository/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ecs/cluster_capacity_provider_associations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ecs/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ecs/primary_task_set/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ecs/service/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ecs/services/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ecs/task_definition/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ecs/task_definitions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ecs/task_set/index.md delete mode 100644 docs/awscc-docs/providers/awscc/efs/access_point/index.md delete mode 100644 docs/awscc-docs/providers/awscc/efs/access_points/index.md delete mode 100644 docs/awscc-docs/providers/awscc/efs/file_system/index.md delete mode 100644 docs/awscc-docs/providers/awscc/efs/file_systems/index.md delete mode 100644 docs/awscc-docs/providers/awscc/efs/index.md delete mode 100644 docs/awscc-docs/providers/awscc/efs/mount_target/index.md delete mode 100644 docs/awscc-docs/providers/awscc/efs/mount_targets/index.md delete mode 100644 docs/awscc-docs/providers/awscc/eks/access_entries/index.md delete mode 100644 docs/awscc-docs/providers/awscc/eks/access_entry/index.md delete mode 100644 docs/awscc-docs/providers/awscc/eks/addon/index.md delete mode 100644 docs/awscc-docs/providers/awscc/eks/addons/index.md delete mode 100644 docs/awscc-docs/providers/awscc/eks/cluster/index.md delete mode 100644 docs/awscc-docs/providers/awscc/eks/clusters/index.md delete mode 100644 docs/awscc-docs/providers/awscc/eks/fargate_profile/index.md delete mode 100644 docs/awscc-docs/providers/awscc/eks/fargate_profiles/index.md delete mode 100644 docs/awscc-docs/providers/awscc/eks/identity_provider_config/index.md delete mode 100644 docs/awscc-docs/providers/awscc/eks/identity_provider_configs/index.md delete mode 100644 docs/awscc-docs/providers/awscc/eks/index.md delete mode 100644 docs/awscc-docs/providers/awscc/eks/nodegroup/index.md delete mode 100644 docs/awscc-docs/providers/awscc/eks/nodegroups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/eks/pod_identity_association/index.md delete mode 100644 docs/awscc-docs/providers/awscc/eks/pod_identity_associations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/elasticache/global_replication_group/index.md delete mode 100644 docs/awscc-docs/providers/awscc/elasticache/global_replication_groups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/elasticache/index.md delete mode 100644 docs/awscc-docs/providers/awscc/elasticache/serverless_cache/index.md delete mode 100644 docs/awscc-docs/providers/awscc/elasticache/serverless_caches/index.md delete mode 100644 docs/awscc-docs/providers/awscc/elasticache/subnet_group/index.md delete mode 100644 docs/awscc-docs/providers/awscc/elasticache/subnet_groups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/elasticache/user/index.md delete mode 100644 docs/awscc-docs/providers/awscc/elasticache/user_group/index.md delete mode 100644 docs/awscc-docs/providers/awscc/elasticache/user_groups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/elasticache/users/index.md delete mode 100644 docs/awscc-docs/providers/awscc/elasticbeanstalk/application/index.md delete mode 100644 docs/awscc-docs/providers/awscc/elasticbeanstalk/application_version/index.md delete mode 100644 docs/awscc-docs/providers/awscc/elasticbeanstalk/application_versions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/elasticbeanstalk/applications/index.md delete mode 100644 docs/awscc-docs/providers/awscc/elasticbeanstalk/configuration_template/index.md delete mode 100644 docs/awscc-docs/providers/awscc/elasticbeanstalk/configuration_templates/index.md delete mode 100644 docs/awscc-docs/providers/awscc/elasticbeanstalk/environment/index.md delete mode 100644 docs/awscc-docs/providers/awscc/elasticbeanstalk/environments/index.md delete mode 100644 docs/awscc-docs/providers/awscc/elasticbeanstalk/index.md delete mode 100644 docs/awscc-docs/providers/awscc/elasticloadbalancingv2/index.md delete mode 100644 docs/awscc-docs/providers/awscc/elasticloadbalancingv2/listener/index.md delete mode 100644 docs/awscc-docs/providers/awscc/elasticloadbalancingv2/listener_rule/index.md delete mode 100644 docs/awscc-docs/providers/awscc/elasticloadbalancingv2/listener_rules/index.md delete mode 100644 docs/awscc-docs/providers/awscc/elasticloadbalancingv2/listeners/index.md delete mode 100644 docs/awscc-docs/providers/awscc/elasticloadbalancingv2/load_balancer/index.md delete mode 100644 docs/awscc-docs/providers/awscc/elasticloadbalancingv2/load_balancers/index.md delete mode 100644 docs/awscc-docs/providers/awscc/elasticloadbalancingv2/target_group/index.md delete mode 100644 docs/awscc-docs/providers/awscc/elasticloadbalancingv2/target_groups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/elasticloadbalancingv2/trust_store/index.md delete mode 100644 docs/awscc-docs/providers/awscc/elasticloadbalancingv2/trust_store_revocation/index.md delete mode 100644 docs/awscc-docs/providers/awscc/elasticloadbalancingv2/trust_store_revocations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/elasticloadbalancingv2/trust_stores/index.md delete mode 100644 docs/awscc-docs/providers/awscc/emr/index.md delete mode 100644 docs/awscc-docs/providers/awscc/emr/security_configuration/index.md delete mode 100644 docs/awscc-docs/providers/awscc/emr/security_configurations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/emr/studio/index.md delete mode 100644 docs/awscc-docs/providers/awscc/emr/studio_session_mapping/index.md delete mode 100644 docs/awscc-docs/providers/awscc/emr/studio_session_mappings/index.md delete mode 100644 docs/awscc-docs/providers/awscc/emr/studios/index.md delete mode 100644 docs/awscc-docs/providers/awscc/emr/wal_workspace/index.md delete mode 100644 docs/awscc-docs/providers/awscc/emr/wal_workspaces/index.md delete mode 100644 docs/awscc-docs/providers/awscc/emrcontainers/index.md delete mode 100644 docs/awscc-docs/providers/awscc/emrcontainers/virtual_cluster/index.md delete mode 100644 docs/awscc-docs/providers/awscc/emrcontainers/virtual_clusters/index.md delete mode 100644 docs/awscc-docs/providers/awscc/emrserverless/application/index.md delete mode 100644 docs/awscc-docs/providers/awscc/emrserverless/applications/index.md delete mode 100644 docs/awscc-docs/providers/awscc/emrserverless/index.md delete mode 100644 docs/awscc-docs/providers/awscc/entityresolution/id_mapping_workflow/index.md delete mode 100644 docs/awscc-docs/providers/awscc/entityresolution/id_mapping_workflows/index.md delete mode 100644 docs/awscc-docs/providers/awscc/entityresolution/index.md delete mode 100644 docs/awscc-docs/providers/awscc/entityresolution/matching_workflow/index.md delete mode 100644 docs/awscc-docs/providers/awscc/entityresolution/matching_workflows/index.md delete mode 100644 docs/awscc-docs/providers/awscc/entityresolution/schema_mapping/index.md delete mode 100644 docs/awscc-docs/providers/awscc/entityresolution/schema_mappings/index.md delete mode 100644 docs/awscc-docs/providers/awscc/events/api_destination/index.md delete mode 100644 docs/awscc-docs/providers/awscc/events/api_destinations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/events/archive/index.md delete mode 100644 docs/awscc-docs/providers/awscc/events/archives/index.md delete mode 100644 docs/awscc-docs/providers/awscc/events/connection/index.md delete mode 100644 docs/awscc-docs/providers/awscc/events/connections/index.md delete mode 100644 docs/awscc-docs/providers/awscc/events/endpoint/index.md delete mode 100644 docs/awscc-docs/providers/awscc/events/endpoints/index.md delete mode 100644 docs/awscc-docs/providers/awscc/events/event_bus/index.md delete mode 100644 docs/awscc-docs/providers/awscc/events/event_buses/index.md delete mode 100644 docs/awscc-docs/providers/awscc/events/index.md delete mode 100644 docs/awscc-docs/providers/awscc/events/rule/index.md delete mode 100644 docs/awscc-docs/providers/awscc/events/rules/index.md delete mode 100644 docs/awscc-docs/providers/awscc/eventschemas/discoverer/index.md delete mode 100644 docs/awscc-docs/providers/awscc/eventschemas/discoverers/index.md delete mode 100644 docs/awscc-docs/providers/awscc/eventschemas/eventschemas_registry/index.md delete mode 100644 docs/awscc-docs/providers/awscc/eventschemas/index.md delete mode 100644 docs/awscc-docs/providers/awscc/eventschemas/registries/index.md delete mode 100644 docs/awscc-docs/providers/awscc/eventschemas/registry_policy/index.md delete mode 100644 docs/awscc-docs/providers/awscc/eventschemas/schema/index.md delete mode 100644 docs/awscc-docs/providers/awscc/eventschemas/schemata/index.md delete mode 100644 docs/awscc-docs/providers/awscc/evidently/experiment/index.md delete mode 100644 docs/awscc-docs/providers/awscc/evidently/feature/index.md delete mode 100644 docs/awscc-docs/providers/awscc/evidently/index.md delete mode 100644 docs/awscc-docs/providers/awscc/evidently/launch/index.md delete mode 100644 docs/awscc-docs/providers/awscc/evidently/project/index.md delete mode 100644 docs/awscc-docs/providers/awscc/evidently/segment/index.md delete mode 100644 docs/awscc-docs/providers/awscc/evidently/segments/index.md delete mode 100644 docs/awscc-docs/providers/awscc/finspace/environment/index.md delete mode 100644 docs/awscc-docs/providers/awscc/finspace/environments/index.md delete mode 100644 docs/awscc-docs/providers/awscc/finspace/index.md delete mode 100644 docs/awscc-docs/providers/awscc/fis/experiment_template/index.md delete mode 100644 docs/awscc-docs/providers/awscc/fis/experiment_templates/index.md delete mode 100644 docs/awscc-docs/providers/awscc/fis/index.md delete mode 100644 docs/awscc-docs/providers/awscc/fis/target_account_configuration/index.md delete mode 100644 docs/awscc-docs/providers/awscc/fis/target_account_configurations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/fms/index.md delete mode 100644 docs/awscc-docs/providers/awscc/fms/notification_channel/index.md delete mode 100644 docs/awscc-docs/providers/awscc/fms/notification_channels/index.md delete mode 100644 docs/awscc-docs/providers/awscc/fms/policies/index.md delete mode 100644 docs/awscc-docs/providers/awscc/fms/policy/index.md delete mode 100644 docs/awscc-docs/providers/awscc/fms/resource_set/index.md delete mode 100644 docs/awscc-docs/providers/awscc/fms/resource_sets/index.md delete mode 100644 docs/awscc-docs/providers/awscc/forecast/dataset/index.md delete mode 100644 docs/awscc-docs/providers/awscc/forecast/dataset_group/index.md delete mode 100644 docs/awscc-docs/providers/awscc/forecast/dataset_groups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/forecast/datasets/index.md delete mode 100644 docs/awscc-docs/providers/awscc/forecast/index.md delete mode 100644 docs/awscc-docs/providers/awscc/frauddetector/detector/index.md delete mode 100644 docs/awscc-docs/providers/awscc/frauddetector/detectors/index.md delete mode 100644 docs/awscc-docs/providers/awscc/frauddetector/event_type/index.md delete mode 100644 docs/awscc-docs/providers/awscc/frauddetector/event_types/index.md delete mode 100644 docs/awscc-docs/providers/awscc/frauddetector/frauddetector_list/index.md delete mode 100644 docs/awscc-docs/providers/awscc/frauddetector/index.md delete mode 100644 docs/awscc-docs/providers/awscc/frauddetector/label/index.md delete mode 100644 docs/awscc-docs/providers/awscc/frauddetector/labels/index.md delete mode 100644 docs/awscc-docs/providers/awscc/frauddetector/lists/index.md delete mode 100644 docs/awscc-docs/providers/awscc/frauddetector/outcome/index.md delete mode 100644 docs/awscc-docs/providers/awscc/frauddetector/outcomes/index.md delete mode 100644 docs/awscc-docs/providers/awscc/frauddetector/variable/index.md delete mode 100644 docs/awscc-docs/providers/awscc/frauddetector/variables/index.md delete mode 100644 docs/awscc-docs/providers/awscc/fsx/data_repository_association/index.md delete mode 100644 docs/awscc-docs/providers/awscc/fsx/data_repository_associations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/fsx/index.md delete mode 100644 docs/awscc-docs/providers/awscc/gamelift/alias/index.md delete mode 100644 docs/awscc-docs/providers/awscc/gamelift/aliases/index.md delete mode 100644 docs/awscc-docs/providers/awscc/gamelift/build/index.md delete mode 100644 docs/awscc-docs/providers/awscc/gamelift/builds/index.md delete mode 100644 docs/awscc-docs/providers/awscc/gamelift/fleet/index.md delete mode 100644 docs/awscc-docs/providers/awscc/gamelift/fleets/index.md delete mode 100644 docs/awscc-docs/providers/awscc/gamelift/game_server_group/index.md delete mode 100644 docs/awscc-docs/providers/awscc/gamelift/game_server_groups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/gamelift/game_session_queue/index.md delete mode 100644 docs/awscc-docs/providers/awscc/gamelift/game_session_queues/index.md delete mode 100644 docs/awscc-docs/providers/awscc/gamelift/index.md delete mode 100644 docs/awscc-docs/providers/awscc/gamelift/location/index.md delete mode 100644 docs/awscc-docs/providers/awscc/gamelift/locations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/gamelift/matchmaking_configuration/index.md delete mode 100644 docs/awscc-docs/providers/awscc/gamelift/matchmaking_configurations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/gamelift/matchmaking_rule_set/index.md delete mode 100644 docs/awscc-docs/providers/awscc/gamelift/matchmaking_rule_sets/index.md delete mode 100644 docs/awscc-docs/providers/awscc/gamelift/script/index.md delete mode 100644 docs/awscc-docs/providers/awscc/gamelift/scripts/index.md delete mode 100644 docs/awscc-docs/providers/awscc/globalaccelerator/accelerator/index.md delete mode 100644 docs/awscc-docs/providers/awscc/globalaccelerator/accelerators/index.md delete mode 100644 docs/awscc-docs/providers/awscc/globalaccelerator/endpoint_group/index.md delete mode 100644 docs/awscc-docs/providers/awscc/globalaccelerator/endpoint_groups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/globalaccelerator/index.md delete mode 100644 docs/awscc-docs/providers/awscc/globalaccelerator/listener/index.md delete mode 100644 docs/awscc-docs/providers/awscc/globalaccelerator/listeners/index.md delete mode 100644 docs/awscc-docs/providers/awscc/glue/index.md delete mode 100644 docs/awscc-docs/providers/awscc/glue/schema_version/index.md delete mode 100644 docs/awscc-docs/providers/awscc/glue/schema_version_metadata/index.md delete mode 100644 docs/awscc-docs/providers/awscc/glue/schema_versions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/grafana/index.md delete mode 100644 docs/awscc-docs/providers/awscc/grafana/workspace/index.md delete mode 100644 docs/awscc-docs/providers/awscc/grafana/workspaces/index.md delete mode 100644 docs/awscc-docs/providers/awscc/greengrassv2/component_version/index.md delete mode 100644 docs/awscc-docs/providers/awscc/greengrassv2/component_versions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/greengrassv2/deployment/index.md delete mode 100644 docs/awscc-docs/providers/awscc/greengrassv2/deployments/index.md delete mode 100644 docs/awscc-docs/providers/awscc/greengrassv2/index.md delete mode 100644 docs/awscc-docs/providers/awscc/groundstation/config/index.md delete mode 100644 docs/awscc-docs/providers/awscc/groundstation/configs/index.md delete mode 100644 docs/awscc-docs/providers/awscc/groundstation/dataflow_endpoint_group/index.md delete mode 100644 docs/awscc-docs/providers/awscc/groundstation/dataflow_endpoint_groups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/groundstation/index.md delete mode 100644 docs/awscc-docs/providers/awscc/groundstation/mission_profile/index.md delete mode 100644 docs/awscc-docs/providers/awscc/groundstation/mission_profiles/index.md delete mode 100644 docs/awscc-docs/providers/awscc/guardduty/detector/index.md delete mode 100644 docs/awscc-docs/providers/awscc/guardduty/detectors/index.md delete mode 100644 docs/awscc-docs/providers/awscc/guardduty/filter/index.md delete mode 100644 docs/awscc-docs/providers/awscc/guardduty/filters/index.md delete mode 100644 docs/awscc-docs/providers/awscc/guardduty/index.md delete mode 100644 docs/awscc-docs/providers/awscc/guardduty/ip_set/index.md delete mode 100644 docs/awscc-docs/providers/awscc/guardduty/ip_sets/index.md delete mode 100644 docs/awscc-docs/providers/awscc/guardduty/master/index.md delete mode 100644 docs/awscc-docs/providers/awscc/guardduty/masters/index.md delete mode 100644 docs/awscc-docs/providers/awscc/guardduty/member/index.md delete mode 100644 docs/awscc-docs/providers/awscc/guardduty/members/index.md delete mode 100644 docs/awscc-docs/providers/awscc/guardduty/threat_intel_set/index.md delete mode 100644 docs/awscc-docs/providers/awscc/guardduty/threat_intel_sets/index.md delete mode 100644 docs/awscc-docs/providers/awscc/healthimaging/datastore/index.md delete mode 100644 docs/awscc-docs/providers/awscc/healthimaging/datastores/index.md delete mode 100644 docs/awscc-docs/providers/awscc/healthimaging/index.md delete mode 100644 docs/awscc-docs/providers/awscc/healthlake/fhir_datastore/index.md delete mode 100644 docs/awscc-docs/providers/awscc/healthlake/fhir_datastores/index.md delete mode 100644 docs/awscc-docs/providers/awscc/healthlake/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iam/group/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iam/group_policies/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iam/group_policy/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iam/groups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iam/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iam/instance_profile/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iam/instance_profiles/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iam/managed_policies/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iam/managed_policy/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iam/oidc_provider/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iam/oidc_providers/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iam/policies/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iam/role/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iam/role_policies/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iam/role_policy/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iam/roles/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iam/saml_provider/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iam/saml_providers/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iam/server_certificate/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iam/server_certificates/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iam/service_linked_role/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iam/user/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iam/user_policies/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iam/user_policy/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iam/users/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iam/virtualmfa_device/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iam/virtualmfa_devices/index.md delete mode 100644 docs/awscc-docs/providers/awscc/identitystore/group/index.md delete mode 100644 docs/awscc-docs/providers/awscc/identitystore/group_membership/index.md delete mode 100644 docs/awscc-docs/providers/awscc/identitystore/group_memberships/index.md delete mode 100644 docs/awscc-docs/providers/awscc/identitystore/groups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/identitystore/index.md delete mode 100644 docs/awscc-docs/providers/awscc/imagebuilder/component/index.md delete mode 100644 docs/awscc-docs/providers/awscc/imagebuilder/components/index.md delete mode 100644 docs/awscc-docs/providers/awscc/imagebuilder/container_recipe/index.md delete mode 100644 docs/awscc-docs/providers/awscc/imagebuilder/container_recipes/index.md delete mode 100644 docs/awscc-docs/providers/awscc/imagebuilder/distribution_configuration/index.md delete mode 100644 docs/awscc-docs/providers/awscc/imagebuilder/distribution_configurations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/imagebuilder/image/index.md delete mode 100644 docs/awscc-docs/providers/awscc/imagebuilder/image_pipeline/index.md delete mode 100644 docs/awscc-docs/providers/awscc/imagebuilder/image_pipelines/index.md delete mode 100644 docs/awscc-docs/providers/awscc/imagebuilder/image_recipe/index.md delete mode 100644 docs/awscc-docs/providers/awscc/imagebuilder/image_recipes/index.md delete mode 100644 docs/awscc-docs/providers/awscc/imagebuilder/images/index.md delete mode 100644 docs/awscc-docs/providers/awscc/imagebuilder/index.md delete mode 100644 docs/awscc-docs/providers/awscc/imagebuilder/infrastructure_configuration/index.md delete mode 100644 docs/awscc-docs/providers/awscc/imagebuilder/infrastructure_configurations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/imagebuilder/lifecycle_policies/index.md delete mode 100644 docs/awscc-docs/providers/awscc/imagebuilder/lifecycle_policy/index.md delete mode 100644 docs/awscc-docs/providers/awscc/imagebuilder/workflow/index.md delete mode 100644 docs/awscc-docs/providers/awscc/imagebuilder/workflows/index.md delete mode 100644 docs/awscc-docs/providers/awscc/inspector/assessment_target/index.md delete mode 100644 docs/awscc-docs/providers/awscc/inspector/assessment_targets/index.md delete mode 100644 docs/awscc-docs/providers/awscc/inspector/assessment_template/index.md delete mode 100644 docs/awscc-docs/providers/awscc/inspector/assessment_templates/index.md delete mode 100644 docs/awscc-docs/providers/awscc/inspector/index.md delete mode 100644 docs/awscc-docs/providers/awscc/inspector/resource_group/index.md delete mode 100644 docs/awscc-docs/providers/awscc/inspectorv2/cis_scan_configuration/index.md delete mode 100644 docs/awscc-docs/providers/awscc/inspectorv2/cis_scan_configurations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/inspectorv2/filter/index.md delete mode 100644 docs/awscc-docs/providers/awscc/inspectorv2/filters/index.md delete mode 100644 docs/awscc-docs/providers/awscc/inspectorv2/index.md delete mode 100644 docs/awscc-docs/providers/awscc/internetmonitor/index.md delete mode 100644 docs/awscc-docs/providers/awscc/internetmonitor/monitor/index.md delete mode 100644 docs/awscc-docs/providers/awscc/internetmonitor/monitors/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/account_audit_configuration/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/account_audit_configurations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/authorizer/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/authorizers/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/billing_group/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/billing_groups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/ca_certificate/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/ca_certificates/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/certificate/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/certificate_provider/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/certificate_providers/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/certificates/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/custom_metric/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/custom_metrics/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/dimension/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/dimensions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/domain_configuration/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/domain_configurations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/fleet_metric/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/fleet_metrics/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/job_template/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/job_templates/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/logging/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/loggings/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/mitigation_action/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/mitigation_actions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/policies/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/policy/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/provisioning_template/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/provisioning_templates/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/resource_specific_logging/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/resource_specific_loggings/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/role_alias/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/role_aliases/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/scheduled_audit/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/scheduled_audits/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/security_profile/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/security_profiles/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/software_package/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/software_package_version/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/software_package_versions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/software_packages/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/thing/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/thing_group/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/thing_groups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/thing_type/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/thing_types/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/things/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/topic_rule/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/topic_rule_destination/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/topic_rule_destinations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iot/topic_rules/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotanalytics/dataset/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotanalytics/datasets/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotanalytics/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotanalytics/pipeline/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotanalytics/pipelines/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotcoredeviceadvisor/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotcoredeviceadvisor/suite_definition/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotcoredeviceadvisor/suite_definitions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotevents/alarm_model/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotevents/alarm_models/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotevents/detector_model/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotevents/detector_models/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotevents/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotevents/input/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotevents/inputs/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotfleethub/application/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotfleethub/applications/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotfleethub/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotfleetwise/campaign/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotfleetwise/campaigns/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotfleetwise/decoder_manifest/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotfleetwise/decoder_manifests/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotfleetwise/fleet/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotfleetwise/fleets/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotfleetwise/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotfleetwise/model_manifest/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotfleetwise/model_manifests/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotfleetwise/signal_catalog/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotfleetwise/signal_catalogs/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotfleetwise/vehicle/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotfleetwise/vehicles/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotsitewise/access_policies/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotsitewise/access_policy/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotsitewise/asset/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotsitewise/asset_model/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotsitewise/asset_models/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotsitewise/assets/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotsitewise/dashboard/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotsitewise/dashboards/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotsitewise/gateway/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotsitewise/gateways/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotsitewise/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotsitewise/portal/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotsitewise/portals/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotsitewise/project/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotsitewise/projects/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iottwinmaker/component_type/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iottwinmaker/component_types/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iottwinmaker/entities/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iottwinmaker/entity/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iottwinmaker/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iottwinmaker/scene/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iottwinmaker/scenes/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iottwinmaker/sync_job/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iottwinmaker/sync_jobs/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iottwinmaker/workspace/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iottwinmaker/workspaces/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotwireless/destination/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotwireless/destinations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotwireless/device_profile/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotwireless/device_profiles/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotwireless/fuota_task/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotwireless/fuota_tasks/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotwireless/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotwireless/multicast_group/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotwireless/multicast_groups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotwireless/network_analyzer_configuration/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotwireless/network_analyzer_configurations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotwireless/partner_account/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotwireless/partner_accounts/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotwireless/service_profile/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotwireless/service_profiles/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotwireless/task_definition/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotwireless/task_definitions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotwireless/wireless_device/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotwireless/wireless_device_import_task/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotwireless/wireless_device_import_tasks/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotwireless/wireless_devices/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotwireless/wireless_gateway/index.md delete mode 100644 docs/awscc-docs/providers/awscc/iotwireless/wireless_gateways/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ivs/channel/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ivs/channels/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ivs/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ivs/playback_key_pair/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ivs/playback_key_pairs/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ivs/recording_configuration/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ivs/recording_configurations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ivs/stage/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ivs/stages/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ivs/stream_key/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ivs/stream_keys/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ivschat/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ivschat/logging_configuration/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ivschat/logging_configurations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ivschat/room/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ivschat/rooms/index.md delete mode 100644 docs/awscc-docs/providers/awscc/kafkaconnect/connector/index.md delete mode 100644 docs/awscc-docs/providers/awscc/kafkaconnect/connectors/index.md delete mode 100644 docs/awscc-docs/providers/awscc/kafkaconnect/index.md delete mode 100644 docs/awscc-docs/providers/awscc/kendra/data_source/index.md delete mode 100644 docs/awscc-docs/providers/awscc/kendra/data_sources/index.md delete mode 100644 docs/awscc-docs/providers/awscc/kendra/faq/index.md delete mode 100644 docs/awscc-docs/providers/awscc/kendra/faqs/index.md delete mode 100644 docs/awscc-docs/providers/awscc/kendra/index.md delete mode 100644 docs/awscc-docs/providers/awscc/kendra/index/index.md delete mode 100644 docs/awscc-docs/providers/awscc/kendra/indices/index.md delete mode 100644 docs/awscc-docs/providers/awscc/kendraranking/execution_plan/index.md delete mode 100644 docs/awscc-docs/providers/awscc/kendraranking/execution_plans/index.md delete mode 100644 docs/awscc-docs/providers/awscc/kendraranking/index.md delete mode 100644 docs/awscc-docs/providers/awscc/kinesis/index.md delete mode 100644 docs/awscc-docs/providers/awscc/kinesis/kinesis_stream/index.md delete mode 100644 docs/awscc-docs/providers/awscc/kinesis/streams/index.md delete mode 100644 docs/awscc-docs/providers/awscc/kinesisanalyticsv2/application/index.md delete mode 100644 docs/awscc-docs/providers/awscc/kinesisanalyticsv2/applications/index.md delete mode 100644 docs/awscc-docs/providers/awscc/kinesisanalyticsv2/index.md delete mode 100644 docs/awscc-docs/providers/awscc/kinesisfirehose/delivery_stream/index.md delete mode 100644 docs/awscc-docs/providers/awscc/kinesisfirehose/delivery_streams/index.md delete mode 100644 docs/awscc-docs/providers/awscc/kinesisfirehose/index.md delete mode 100644 docs/awscc-docs/providers/awscc/kinesisvideo/index.md delete mode 100644 docs/awscc-docs/providers/awscc/kinesisvideo/kinesisvideo_stream/index.md delete mode 100644 docs/awscc-docs/providers/awscc/kinesisvideo/signaling_channel/index.md delete mode 100644 docs/awscc-docs/providers/awscc/kms/alias/index.md delete mode 100644 docs/awscc-docs/providers/awscc/kms/aliases/index.md delete mode 100644 docs/awscc-docs/providers/awscc/kms/index.md delete mode 100644 docs/awscc-docs/providers/awscc/kms/key/index.md delete mode 100644 docs/awscc-docs/providers/awscc/kms/keys/index.md delete mode 100644 docs/awscc-docs/providers/awscc/kms/replica_key/index.md delete mode 100644 docs/awscc-docs/providers/awscc/kms/replica_keys/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lakeformation/data_cells_filter/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lakeformation/data_cells_filters/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lakeformation/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lakeformation/principal_permissions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lakeformation/tag/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lakeformation/tag_association/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lakeformation/tags/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lambda/code_signing_config/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lambda/code_signing_configs/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lambda/event_invoke_config/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lambda/event_invoke_configs/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lambda/event_source_mapping/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lambda/event_source_mappings/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lambda/function/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lambda/functions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lambda/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lambda/layer_version/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lambda/layer_version_permission/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lambda/layer_version_permissions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lambda/layer_versions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lambda/permission/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lambda/permissions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lambda/url/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lambda/urls/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lambda/version/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lambda/versions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lex/bot/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lex/bot_alias/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lex/bot_aliases/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lex/bot_version/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lex/bot_versions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lex/bots/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lex/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lex/resource_policies/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lex/resource_policy/index.md delete mode 100644 docs/awscc-docs/providers/awscc/licensemanager/grant/index.md delete mode 100644 docs/awscc-docs/providers/awscc/licensemanager/grants/index.md delete mode 100644 docs/awscc-docs/providers/awscc/licensemanager/index.md delete mode 100644 docs/awscc-docs/providers/awscc/licensemanager/license/index.md delete mode 100644 docs/awscc-docs/providers/awscc/licensemanager/licenses/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lightsail/alarm/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lightsail/alarms/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lightsail/bucket/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lightsail/buckets/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lightsail/certificate/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lightsail/certificates/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lightsail/container/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lightsail/containers/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lightsail/database/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lightsail/databases/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lightsail/distribution/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lightsail/distributions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lightsail/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lightsail/instance/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lightsail/instances/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lightsail/load_balancer/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lightsail/load_balancer_tls_certificate/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lightsail/load_balancer_tls_certificates/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lightsail/load_balancers/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lightsail/static_ip/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lightsail/static_ips/index.md delete mode 100644 docs/awscc-docs/providers/awscc/location/api_key/index.md delete mode 100644 docs/awscc-docs/providers/awscc/location/api_keys/index.md delete mode 100644 docs/awscc-docs/providers/awscc/location/geofence_collection/index.md delete mode 100644 docs/awscc-docs/providers/awscc/location/geofence_collections/index.md delete mode 100644 docs/awscc-docs/providers/awscc/location/index.md delete mode 100644 docs/awscc-docs/providers/awscc/location/map/index.md delete mode 100644 docs/awscc-docs/providers/awscc/location/maps/index.md delete mode 100644 docs/awscc-docs/providers/awscc/location/place_index/index.md delete mode 100644 docs/awscc-docs/providers/awscc/location/place_indices/index.md delete mode 100644 docs/awscc-docs/providers/awscc/location/route_calculator/index.md delete mode 100644 docs/awscc-docs/providers/awscc/location/route_calculators/index.md delete mode 100644 docs/awscc-docs/providers/awscc/location/tracker/index.md delete mode 100644 docs/awscc-docs/providers/awscc/location/tracker_consumer/index.md delete mode 100644 docs/awscc-docs/providers/awscc/location/tracker_consumers/index.md delete mode 100644 docs/awscc-docs/providers/awscc/location/trackers/index.md delete mode 100644 docs/awscc-docs/providers/awscc/logs/account_policies/index.md delete mode 100644 docs/awscc-docs/providers/awscc/logs/account_policy/index.md delete mode 100644 docs/awscc-docs/providers/awscc/logs/deliveries/index.md delete mode 100644 docs/awscc-docs/providers/awscc/logs/delivery/index.md delete mode 100644 docs/awscc-docs/providers/awscc/logs/delivery_destination/index.md delete mode 100644 docs/awscc-docs/providers/awscc/logs/delivery_destinations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/logs/delivery_source/index.md delete mode 100644 docs/awscc-docs/providers/awscc/logs/delivery_sources/index.md delete mode 100644 docs/awscc-docs/providers/awscc/logs/destination/index.md delete mode 100644 docs/awscc-docs/providers/awscc/logs/destinations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/logs/index.md delete mode 100644 docs/awscc-docs/providers/awscc/logs/log_anomaly_detector/index.md delete mode 100644 docs/awscc-docs/providers/awscc/logs/log_anomaly_detectors/index.md delete mode 100644 docs/awscc-docs/providers/awscc/logs/log_stream/index.md delete mode 100644 docs/awscc-docs/providers/awscc/logs/log_streams/index.md delete mode 100644 docs/awscc-docs/providers/awscc/logs/metric_filter/index.md delete mode 100644 docs/awscc-docs/providers/awscc/logs/metric_filters/index.md delete mode 100644 docs/awscc-docs/providers/awscc/logs/query_definition/index.md delete mode 100644 docs/awscc-docs/providers/awscc/logs/query_definitions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/logs/resource_policies/index.md delete mode 100644 docs/awscc-docs/providers/awscc/logs/resource_policy/index.md delete mode 100644 docs/awscc-docs/providers/awscc/logs/subscription_filter/index.md delete mode 100644 docs/awscc-docs/providers/awscc/logs/subscription_filters/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lookoutequipment/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lookoutequipment/inference_scheduler/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lookoutequipment/inference_schedulers/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lookoutmetrics/alert/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lookoutmetrics/alerts/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lookoutmetrics/anomaly_detector/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lookoutmetrics/anomaly_detectors/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lookoutmetrics/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lookoutvision/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lookoutvision/project/index.md delete mode 100644 docs/awscc-docs/providers/awscc/lookoutvision/projects/index.md delete mode 100644 docs/awscc-docs/providers/awscc/m2/application/index.md delete mode 100644 docs/awscc-docs/providers/awscc/m2/applications/index.md delete mode 100644 docs/awscc-docs/providers/awscc/m2/environment/index.md delete mode 100644 docs/awscc-docs/providers/awscc/m2/environments/index.md delete mode 100644 docs/awscc-docs/providers/awscc/m2/index.md delete mode 100644 docs/awscc-docs/providers/awscc/macie/allow_list/index.md delete mode 100644 docs/awscc-docs/providers/awscc/macie/allow_lists/index.md delete mode 100644 docs/awscc-docs/providers/awscc/macie/custom_data_identifier/index.md delete mode 100644 docs/awscc-docs/providers/awscc/macie/custom_data_identifiers/index.md delete mode 100644 docs/awscc-docs/providers/awscc/macie/findings_filter/index.md delete mode 100644 docs/awscc-docs/providers/awscc/macie/findings_filters/index.md delete mode 100644 docs/awscc-docs/providers/awscc/macie/index.md delete mode 100644 docs/awscc-docs/providers/awscc/macie/session/index.md delete mode 100644 docs/awscc-docs/providers/awscc/macie/sessions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/managedblockchain/accessor/index.md delete mode 100644 docs/awscc-docs/providers/awscc/managedblockchain/accessors/index.md delete mode 100644 docs/awscc-docs/providers/awscc/managedblockchain/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mediaconnect/bridge/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mediaconnect/bridge_output/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mediaconnect/bridge_source/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mediaconnect/bridges/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mediaconnect/flow/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mediaconnect/flow_entitlement/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mediaconnect/flow_entitlements/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mediaconnect/flow_output/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mediaconnect/flow_outputs/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mediaconnect/flow_source/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mediaconnect/flow_sources/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mediaconnect/flow_vpc_interface/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mediaconnect/flow_vpc_interfaces/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mediaconnect/flows/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mediaconnect/gateway/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mediaconnect/gateways/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mediaconnect/index.md delete mode 100644 docs/awscc-docs/providers/awscc/medialive/index.md delete mode 100644 docs/awscc-docs/providers/awscc/medialive/multiplex/index.md delete mode 100644 docs/awscc-docs/providers/awscc/medialive/multiplexes/index.md delete mode 100644 docs/awscc-docs/providers/awscc/medialive/multiplexprogram/index.md delete mode 100644 docs/awscc-docs/providers/awscc/medialive/multiplexprograms/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mediapackage/asset/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mediapackage/assets/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mediapackage/channel/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mediapackage/channels/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mediapackage/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mediapackage/origin_endpoint/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mediapackage/origin_endpoints/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mediapackage/packaging_configuration/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mediapackage/packaging_configurations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mediapackage/packaging_group/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mediapackage/packaging_groups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mediapackagev2/channel/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mediapackagev2/channel_group/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mediapackagev2/channel_groups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mediapackagev2/channel_policy/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mediapackagev2/channels/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mediapackagev2/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mediapackagev2/origin_endpoint/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mediapackagev2/origin_endpoint_policy/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mediapackagev2/origin_endpoints/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mediatailor/channel/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mediatailor/channel_policy/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mediatailor/channels/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mediatailor/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mediatailor/live_source/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mediatailor/live_sources/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mediatailor/playback_configuration/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mediatailor/playback_configurations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mediatailor/source_location/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mediatailor/source_locations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mediatailor/vod_source/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mediatailor/vod_sources/index.md delete mode 100644 docs/awscc-docs/providers/awscc/memorydb/acl/index.md delete mode 100644 docs/awscc-docs/providers/awscc/memorydb/acls/index.md delete mode 100644 docs/awscc-docs/providers/awscc/memorydb/cluster/index.md delete mode 100644 docs/awscc-docs/providers/awscc/memorydb/clusters/index.md delete mode 100644 docs/awscc-docs/providers/awscc/memorydb/index.md delete mode 100644 docs/awscc-docs/providers/awscc/memorydb/parameter_group/index.md delete mode 100644 docs/awscc-docs/providers/awscc/memorydb/parameter_groups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/memorydb/subnet_group/index.md delete mode 100644 docs/awscc-docs/providers/awscc/memorydb/subnet_groups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/memorydb/user/index.md delete mode 100644 docs/awscc-docs/providers/awscc/memorydb/users/index.md delete mode 100644 docs/awscc-docs/providers/awscc/msk/batch_scram_secret/index.md delete mode 100644 docs/awscc-docs/providers/awscc/msk/batch_scram_secrets/index.md delete mode 100644 docs/awscc-docs/providers/awscc/msk/cluster/index.md delete mode 100644 docs/awscc-docs/providers/awscc/msk/cluster_policies/index.md delete mode 100644 docs/awscc-docs/providers/awscc/msk/cluster_policy/index.md delete mode 100644 docs/awscc-docs/providers/awscc/msk/clusters/index.md delete mode 100644 docs/awscc-docs/providers/awscc/msk/configuration/index.md delete mode 100644 docs/awscc-docs/providers/awscc/msk/configurations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/msk/index.md delete mode 100644 docs/awscc-docs/providers/awscc/msk/replicator/index.md delete mode 100644 docs/awscc-docs/providers/awscc/msk/replicators/index.md delete mode 100644 docs/awscc-docs/providers/awscc/msk/serverless_cluster/index.md delete mode 100644 docs/awscc-docs/providers/awscc/msk/serverless_clusters/index.md delete mode 100644 docs/awscc-docs/providers/awscc/msk/vpc_connection/index.md delete mode 100644 docs/awscc-docs/providers/awscc/msk/vpc_connections/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mwaa/environment/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mwaa/environments/index.md delete mode 100644 docs/awscc-docs/providers/awscc/mwaa/index.md delete mode 100644 docs/awscc-docs/providers/awscc/neptune/db_cluster/index.md delete mode 100644 docs/awscc-docs/providers/awscc/neptune/db_clusters/index.md delete mode 100644 docs/awscc-docs/providers/awscc/neptune/index.md delete mode 100644 docs/awscc-docs/providers/awscc/neptunegraph/graph/index.md delete mode 100644 docs/awscc-docs/providers/awscc/neptunegraph/graphs/index.md delete mode 100644 docs/awscc-docs/providers/awscc/neptunegraph/index.md delete mode 100644 docs/awscc-docs/providers/awscc/neptunegraph/private_graph_endpoint/index.md delete mode 100644 docs/awscc-docs/providers/awscc/neptunegraph/private_graph_endpoints/index.md delete mode 100644 docs/awscc-docs/providers/awscc/networkfirewall/firewall/index.md delete mode 100644 docs/awscc-docs/providers/awscc/networkfirewall/firewall_policies/index.md delete mode 100644 docs/awscc-docs/providers/awscc/networkfirewall/firewall_policy/index.md delete mode 100644 docs/awscc-docs/providers/awscc/networkfirewall/firewalls/index.md delete mode 100644 docs/awscc-docs/providers/awscc/networkfirewall/index.md delete mode 100644 docs/awscc-docs/providers/awscc/networkfirewall/logging_configuration/index.md delete mode 100644 docs/awscc-docs/providers/awscc/networkfirewall/logging_configurations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/networkfirewall/rule_group/index.md delete mode 100644 docs/awscc-docs/providers/awscc/networkfirewall/rule_groups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/networkfirewall/tls_inspection_configuration/index.md delete mode 100644 docs/awscc-docs/providers/awscc/networkfirewall/tls_inspection_configurations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/networkmanager/connect_attachment/index.md delete mode 100644 docs/awscc-docs/providers/awscc/networkmanager/connect_attachments/index.md delete mode 100644 docs/awscc-docs/providers/awscc/networkmanager/connect_peer/index.md delete mode 100644 docs/awscc-docs/providers/awscc/networkmanager/connect_peers/index.md delete mode 100644 docs/awscc-docs/providers/awscc/networkmanager/core_network/index.md delete mode 100644 docs/awscc-docs/providers/awscc/networkmanager/core_networks/index.md delete mode 100644 docs/awscc-docs/providers/awscc/networkmanager/customer_gateway_association/index.md delete mode 100644 docs/awscc-docs/providers/awscc/networkmanager/customer_gateway_associations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/networkmanager/device/index.md delete mode 100644 docs/awscc-docs/providers/awscc/networkmanager/devices/index.md delete mode 100644 docs/awscc-docs/providers/awscc/networkmanager/global_network/index.md delete mode 100644 docs/awscc-docs/providers/awscc/networkmanager/global_networks/index.md delete mode 100644 docs/awscc-docs/providers/awscc/networkmanager/index.md delete mode 100644 docs/awscc-docs/providers/awscc/networkmanager/link/index.md delete mode 100644 docs/awscc-docs/providers/awscc/networkmanager/link_association/index.md delete mode 100644 docs/awscc-docs/providers/awscc/networkmanager/link_associations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/networkmanager/links/index.md delete mode 100644 docs/awscc-docs/providers/awscc/networkmanager/site/index.md delete mode 100644 docs/awscc-docs/providers/awscc/networkmanager/site_to_site_vpn_attachment/index.md delete mode 100644 docs/awscc-docs/providers/awscc/networkmanager/site_to_site_vpn_attachments/index.md delete mode 100644 docs/awscc-docs/providers/awscc/networkmanager/sites/index.md delete mode 100644 docs/awscc-docs/providers/awscc/networkmanager/transit_gateway_peering/index.md delete mode 100644 docs/awscc-docs/providers/awscc/networkmanager/transit_gateway_peerings/index.md delete mode 100644 docs/awscc-docs/providers/awscc/networkmanager/transit_gateway_registration/index.md delete mode 100644 docs/awscc-docs/providers/awscc/networkmanager/transit_gateway_registrations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/networkmanager/transit_gateway_route_table_attachment/index.md delete mode 100644 docs/awscc-docs/providers/awscc/networkmanager/transit_gateway_route_table_attachments/index.md delete mode 100644 docs/awscc-docs/providers/awscc/networkmanager/vpc_attachment/index.md delete mode 100644 docs/awscc-docs/providers/awscc/networkmanager/vpc_attachments/index.md delete mode 100644 docs/awscc-docs/providers/awscc/nimblestudio/index.md delete mode 100644 docs/awscc-docs/providers/awscc/nimblestudio/launch_profile/index.md delete mode 100644 docs/awscc-docs/providers/awscc/nimblestudio/launch_profiles/index.md delete mode 100644 docs/awscc-docs/providers/awscc/nimblestudio/streaming_image/index.md delete mode 100644 docs/awscc-docs/providers/awscc/nimblestudio/streaming_images/index.md delete mode 100644 docs/awscc-docs/providers/awscc/nimblestudio/studio/index.md delete mode 100644 docs/awscc-docs/providers/awscc/nimblestudio/studio_component/index.md delete mode 100644 docs/awscc-docs/providers/awscc/nimblestudio/studio_components/index.md delete mode 100644 docs/awscc-docs/providers/awscc/nimblestudio/studios/index.md delete mode 100644 docs/awscc-docs/providers/awscc/oam/index.md delete mode 100644 docs/awscc-docs/providers/awscc/oam/link/index.md delete mode 100644 docs/awscc-docs/providers/awscc/oam/links/index.md delete mode 100644 docs/awscc-docs/providers/awscc/oam/sink/index.md delete mode 100644 docs/awscc-docs/providers/awscc/oam/sinks/index.md delete mode 100644 docs/awscc-docs/providers/awscc/omics/annotation_store/index.md delete mode 100644 docs/awscc-docs/providers/awscc/omics/annotation_stores/index.md delete mode 100644 docs/awscc-docs/providers/awscc/omics/index.md delete mode 100644 docs/awscc-docs/providers/awscc/omics/reference_store/index.md delete mode 100644 docs/awscc-docs/providers/awscc/omics/reference_stores/index.md delete mode 100644 docs/awscc-docs/providers/awscc/omics/run_group/index.md delete mode 100644 docs/awscc-docs/providers/awscc/omics/run_groups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/omics/sequence_store/index.md delete mode 100644 docs/awscc-docs/providers/awscc/omics/sequence_stores/index.md delete mode 100644 docs/awscc-docs/providers/awscc/omics/variant_store/index.md delete mode 100644 docs/awscc-docs/providers/awscc/omics/variant_stores/index.md delete mode 100644 docs/awscc-docs/providers/awscc/omics/workflow/index.md delete mode 100644 docs/awscc-docs/providers/awscc/omics/workflows/index.md delete mode 100644 docs/awscc-docs/providers/awscc/opensearchserverless/access_policies/index.md delete mode 100644 docs/awscc-docs/providers/awscc/opensearchserverless/access_policy/index.md delete mode 100644 docs/awscc-docs/providers/awscc/opensearchserverless/collection/index.md delete mode 100644 docs/awscc-docs/providers/awscc/opensearchserverless/collections/index.md delete mode 100644 docs/awscc-docs/providers/awscc/opensearchserverless/index.md delete mode 100644 docs/awscc-docs/providers/awscc/opensearchserverless/lifecycle_policies/index.md delete mode 100644 docs/awscc-docs/providers/awscc/opensearchserverless/lifecycle_policy/index.md delete mode 100644 docs/awscc-docs/providers/awscc/opensearchserverless/security_config/index.md delete mode 100644 docs/awscc-docs/providers/awscc/opensearchserverless/security_configs/index.md delete mode 100644 docs/awscc-docs/providers/awscc/opensearchserverless/security_policies/index.md delete mode 100644 docs/awscc-docs/providers/awscc/opensearchserverless/security_policy/index.md delete mode 100644 docs/awscc-docs/providers/awscc/opensearchserverless/vpc_endpoint/index.md delete mode 100644 docs/awscc-docs/providers/awscc/opensearchserverless/vpc_endpoints/index.md delete mode 100644 docs/awscc-docs/providers/awscc/opensearchservice/domain/index.md delete mode 100644 docs/awscc-docs/providers/awscc/opensearchservice/index.md delete mode 100644 docs/awscc-docs/providers/awscc/opsworkscm/index.md delete mode 100644 docs/awscc-docs/providers/awscc/opsworkscm/server/index.md delete mode 100644 docs/awscc-docs/providers/awscc/opsworkscm/servers/index.md delete mode 100644 docs/awscc-docs/providers/awscc/organizations/account/index.md delete mode 100644 docs/awscc-docs/providers/awscc/organizations/accounts/index.md delete mode 100644 docs/awscc-docs/providers/awscc/organizations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/organizations/organization/index.md delete mode 100644 docs/awscc-docs/providers/awscc/organizations/organizational_unit/index.md delete mode 100644 docs/awscc-docs/providers/awscc/organizations/organizational_units/index.md delete mode 100644 docs/awscc-docs/providers/awscc/organizations/organizations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/organizations/policies/index.md delete mode 100644 docs/awscc-docs/providers/awscc/organizations/policy/index.md delete mode 100644 docs/awscc-docs/providers/awscc/organizations/resource_policies/index.md delete mode 100644 docs/awscc-docs/providers/awscc/organizations/resource_policy/index.md delete mode 100644 docs/awscc-docs/providers/awscc/osis/index.md delete mode 100644 docs/awscc-docs/providers/awscc/osis/pipeline/index.md delete mode 100644 docs/awscc-docs/providers/awscc/osis/pipelines/index.md delete mode 100644 docs/awscc-docs/providers/awscc/panorama/application_instance/index.md delete mode 100644 docs/awscc-docs/providers/awscc/panorama/application_instances/index.md delete mode 100644 docs/awscc-docs/providers/awscc/panorama/index.md delete mode 100644 docs/awscc-docs/providers/awscc/panorama/package/index.md delete mode 100644 docs/awscc-docs/providers/awscc/panorama/package_version/index.md delete mode 100644 docs/awscc-docs/providers/awscc/panorama/packages/index.md delete mode 100644 docs/awscc-docs/providers/awscc/pcaconnectorad/connector/index.md delete mode 100644 docs/awscc-docs/providers/awscc/pcaconnectorad/connectors/index.md delete mode 100644 docs/awscc-docs/providers/awscc/pcaconnectorad/directory_registration/index.md delete mode 100644 docs/awscc-docs/providers/awscc/pcaconnectorad/directory_registrations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/pcaconnectorad/index.md delete mode 100644 docs/awscc-docs/providers/awscc/pcaconnectorad/service_principal_name/index.md delete mode 100644 docs/awscc-docs/providers/awscc/pcaconnectorad/service_principal_names/index.md delete mode 100644 docs/awscc-docs/providers/awscc/pcaconnectorad/template/index.md delete mode 100644 docs/awscc-docs/providers/awscc/pcaconnectorad/template_group_access_control_entries/index.md delete mode 100644 docs/awscc-docs/providers/awscc/pcaconnectorad/template_group_access_control_entry/index.md delete mode 100644 docs/awscc-docs/providers/awscc/pcaconnectorad/templates/index.md delete mode 100644 docs/awscc-docs/providers/awscc/personalize/dataset/index.md delete mode 100644 docs/awscc-docs/providers/awscc/personalize/dataset_group/index.md delete mode 100644 docs/awscc-docs/providers/awscc/personalize/dataset_groups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/personalize/datasets/index.md delete mode 100644 docs/awscc-docs/providers/awscc/personalize/index.md delete mode 100644 docs/awscc-docs/providers/awscc/personalize/schema/index.md delete mode 100644 docs/awscc-docs/providers/awscc/personalize/schemata/index.md delete mode 100644 docs/awscc-docs/providers/awscc/personalize/solution/index.md delete mode 100644 docs/awscc-docs/providers/awscc/personalize/solutions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/pinpoint/in_app_template/index.md delete mode 100644 docs/awscc-docs/providers/awscc/pinpoint/in_app_templates/index.md delete mode 100644 docs/awscc-docs/providers/awscc/pinpoint/index.md delete mode 100644 docs/awscc-docs/providers/awscc/pipes/index.md delete mode 100644 docs/awscc-docs/providers/awscc/pipes/pipe/index.md delete mode 100644 docs/awscc-docs/providers/awscc/pipes/pipes/index.md delete mode 100644 docs/awscc-docs/providers/awscc/proton/environment_account_connection/index.md delete mode 100644 docs/awscc-docs/providers/awscc/proton/environment_account_connections/index.md delete mode 100644 docs/awscc-docs/providers/awscc/proton/environment_template/index.md delete mode 100644 docs/awscc-docs/providers/awscc/proton/environment_templates/index.md delete mode 100644 docs/awscc-docs/providers/awscc/proton/index.md delete mode 100644 docs/awscc-docs/providers/awscc/proton/service_template/index.md delete mode 100644 docs/awscc-docs/providers/awscc/proton/service_templates/index.md delete mode 100644 docs/awscc-docs/providers/awscc/qldb/index.md delete mode 100644 docs/awscc-docs/providers/awscc/qldb/qldb_stream/index.md delete mode 100644 docs/awscc-docs/providers/awscc/qldb/streams/index.md delete mode 100644 docs/awscc-docs/providers/awscc/quicksight/analyses/index.md delete mode 100644 docs/awscc-docs/providers/awscc/quicksight/analysis/index.md delete mode 100644 docs/awscc-docs/providers/awscc/quicksight/dashboard/index.md delete mode 100644 docs/awscc-docs/providers/awscc/quicksight/dashboards/index.md delete mode 100644 docs/awscc-docs/providers/awscc/quicksight/data_set/index.md delete mode 100644 docs/awscc-docs/providers/awscc/quicksight/data_sets/index.md delete mode 100644 docs/awscc-docs/providers/awscc/quicksight/data_source/index.md delete mode 100644 docs/awscc-docs/providers/awscc/quicksight/data_sources/index.md delete mode 100644 docs/awscc-docs/providers/awscc/quicksight/index.md delete mode 100644 docs/awscc-docs/providers/awscc/quicksight/refresh_schedule/index.md delete mode 100644 docs/awscc-docs/providers/awscc/quicksight/refresh_schedules/index.md delete mode 100644 docs/awscc-docs/providers/awscc/quicksight/template/index.md delete mode 100644 docs/awscc-docs/providers/awscc/quicksight/templates/index.md delete mode 100644 docs/awscc-docs/providers/awscc/quicksight/theme/index.md delete mode 100644 docs/awscc-docs/providers/awscc/quicksight/themes/index.md delete mode 100644 docs/awscc-docs/providers/awscc/quicksight/topic/index.md delete mode 100644 docs/awscc-docs/providers/awscc/quicksight/topics/index.md delete mode 100644 docs/awscc-docs/providers/awscc/quicksight/vpc_connection/index.md delete mode 100644 docs/awscc-docs/providers/awscc/quicksight/vpc_connections/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ram/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ram/permission/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ram/permissions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/rds/customdb_engine_version/index.md delete mode 100644 docs/awscc-docs/providers/awscc/rds/customdb_engine_versions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/rds/db_cluster/index.md delete mode 100644 docs/awscc-docs/providers/awscc/rds/db_cluster_parameter_group/index.md delete mode 100644 docs/awscc-docs/providers/awscc/rds/db_cluster_parameter_groups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/rds/db_clusters/index.md delete mode 100644 docs/awscc-docs/providers/awscc/rds/db_instance/index.md delete mode 100644 docs/awscc-docs/providers/awscc/rds/db_instances/index.md delete mode 100644 docs/awscc-docs/providers/awscc/rds/db_parameter_group/index.md delete mode 100644 docs/awscc-docs/providers/awscc/rds/db_parameter_groups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/rds/db_proxies/index.md delete mode 100644 docs/awscc-docs/providers/awscc/rds/db_proxy/index.md delete mode 100644 docs/awscc-docs/providers/awscc/rds/db_proxy_endpoint/index.md delete mode 100644 docs/awscc-docs/providers/awscc/rds/db_proxy_endpoints/index.md delete mode 100644 docs/awscc-docs/providers/awscc/rds/db_proxy_target_group/index.md delete mode 100644 docs/awscc-docs/providers/awscc/rds/db_proxy_target_groups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/rds/db_subnet_group/index.md delete mode 100644 docs/awscc-docs/providers/awscc/rds/db_subnet_groups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/rds/event_subscription/index.md delete mode 100644 docs/awscc-docs/providers/awscc/rds/event_subscriptions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/rds/global_cluster/index.md delete mode 100644 docs/awscc-docs/providers/awscc/rds/global_clusters/index.md delete mode 100644 docs/awscc-docs/providers/awscc/rds/index.md delete mode 100644 docs/awscc-docs/providers/awscc/rds/integration/index.md delete mode 100644 docs/awscc-docs/providers/awscc/rds/integrations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/rds/option_group/index.md delete mode 100644 docs/awscc-docs/providers/awscc/rds/option_groups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/redshift/cluster/index.md delete mode 100644 docs/awscc-docs/providers/awscc/redshift/cluster_parameter_group/index.md delete mode 100644 docs/awscc-docs/providers/awscc/redshift/cluster_parameter_groups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/redshift/cluster_subnet_group/index.md delete mode 100644 docs/awscc-docs/providers/awscc/redshift/cluster_subnet_groups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/redshift/clusters/index.md delete mode 100644 docs/awscc-docs/providers/awscc/redshift/endpoint_access/index.md delete mode 100644 docs/awscc-docs/providers/awscc/redshift/endpoint_accesses/index.md delete mode 100644 docs/awscc-docs/providers/awscc/redshift/endpoint_authorization/index.md delete mode 100644 docs/awscc-docs/providers/awscc/redshift/endpoint_authorizations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/redshift/event_subscription/index.md delete mode 100644 docs/awscc-docs/providers/awscc/redshift/event_subscriptions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/redshift/index.md delete mode 100644 docs/awscc-docs/providers/awscc/redshift/scheduled_action/index.md delete mode 100644 docs/awscc-docs/providers/awscc/redshift/scheduled_actions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/redshiftserverless/index.md delete mode 100644 docs/awscc-docs/providers/awscc/redshiftserverless/namespace/index.md delete mode 100644 docs/awscc-docs/providers/awscc/redshiftserverless/namespaces/index.md delete mode 100644 docs/awscc-docs/providers/awscc/redshiftserverless/workgroup/index.md delete mode 100644 docs/awscc-docs/providers/awscc/redshiftserverless/workgroups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/refactorspaces/application/index.md delete mode 100644 docs/awscc-docs/providers/awscc/refactorspaces/applications/index.md delete mode 100644 docs/awscc-docs/providers/awscc/refactorspaces/environment/index.md delete mode 100644 docs/awscc-docs/providers/awscc/refactorspaces/environments/index.md delete mode 100644 docs/awscc-docs/providers/awscc/refactorspaces/index.md delete mode 100644 docs/awscc-docs/providers/awscc/refactorspaces/route/index.md delete mode 100644 docs/awscc-docs/providers/awscc/refactorspaces/routes/index.md delete mode 100644 docs/awscc-docs/providers/awscc/refactorspaces/service/index.md delete mode 100644 docs/awscc-docs/providers/awscc/refactorspaces/services/index.md delete mode 100644 docs/awscc-docs/providers/awscc/rekognition/collection/index.md delete mode 100644 docs/awscc-docs/providers/awscc/rekognition/collections/index.md delete mode 100644 docs/awscc-docs/providers/awscc/rekognition/index.md delete mode 100644 docs/awscc-docs/providers/awscc/rekognition/project/index.md delete mode 100644 docs/awscc-docs/providers/awscc/rekognition/projects/index.md delete mode 100644 docs/awscc-docs/providers/awscc/rekognition/stream_processor/index.md delete mode 100644 docs/awscc-docs/providers/awscc/rekognition/stream_processors/index.md delete mode 100644 docs/awscc-docs/providers/awscc/resiliencehub/app/index.md delete mode 100644 docs/awscc-docs/providers/awscc/resiliencehub/apps/index.md delete mode 100644 docs/awscc-docs/providers/awscc/resiliencehub/index.md delete mode 100644 docs/awscc-docs/providers/awscc/resiliencehub/resiliency_policies/index.md delete mode 100644 docs/awscc-docs/providers/awscc/resiliencehub/resiliency_policy/index.md delete mode 100644 docs/awscc-docs/providers/awscc/resourceexplorer2/default_view_association/index.md delete mode 100644 docs/awscc-docs/providers/awscc/resourceexplorer2/index.md delete mode 100644 docs/awscc-docs/providers/awscc/resourceexplorer2/index/index.md delete mode 100644 docs/awscc-docs/providers/awscc/resourceexplorer2/indices/index.md delete mode 100644 docs/awscc-docs/providers/awscc/resourceexplorer2/view/index.md delete mode 100644 docs/awscc-docs/providers/awscc/resourceexplorer2/views/index.md delete mode 100644 docs/awscc-docs/providers/awscc/resourcegroups/group/index.md delete mode 100644 docs/awscc-docs/providers/awscc/resourcegroups/groups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/resourcegroups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/robomaker/fleet/index.md delete mode 100644 docs/awscc-docs/providers/awscc/robomaker/fleets/index.md delete mode 100644 docs/awscc-docs/providers/awscc/robomaker/index.md delete mode 100644 docs/awscc-docs/providers/awscc/robomaker/robot/index.md delete mode 100644 docs/awscc-docs/providers/awscc/robomaker/robot_application/index.md delete mode 100644 docs/awscc-docs/providers/awscc/robomaker/robot_application_version/index.md delete mode 100644 docs/awscc-docs/providers/awscc/robomaker/robot_applications/index.md delete mode 100644 docs/awscc-docs/providers/awscc/robomaker/robots/index.md delete mode 100644 docs/awscc-docs/providers/awscc/robomaker/simulation_application/index.md delete mode 100644 docs/awscc-docs/providers/awscc/robomaker/simulation_application_version/index.md delete mode 100644 docs/awscc-docs/providers/awscc/robomaker/simulation_applications/index.md delete mode 100644 docs/awscc-docs/providers/awscc/rolesanywhere/crl/index.md delete mode 100644 docs/awscc-docs/providers/awscc/rolesanywhere/crls/index.md delete mode 100644 docs/awscc-docs/providers/awscc/rolesanywhere/index.md delete mode 100644 docs/awscc-docs/providers/awscc/rolesanywhere/profile/index.md delete mode 100644 docs/awscc-docs/providers/awscc/rolesanywhere/profiles/index.md delete mode 100644 docs/awscc-docs/providers/awscc/rolesanywhere/trust_anchor/index.md delete mode 100644 docs/awscc-docs/providers/awscc/rolesanywhere/trust_anchors/index.md delete mode 100644 docs/awscc-docs/providers/awscc/route53/cidr_collection/index.md delete mode 100644 docs/awscc-docs/providers/awscc/route53/cidr_collections/index.md delete mode 100644 docs/awscc-docs/providers/awscc/route53/dnssec/index.md delete mode 100644 docs/awscc-docs/providers/awscc/route53/dnssecs/index.md delete mode 100644 docs/awscc-docs/providers/awscc/route53/health_check/index.md delete mode 100644 docs/awscc-docs/providers/awscc/route53/health_checks/index.md delete mode 100644 docs/awscc-docs/providers/awscc/route53/hosted_zone/index.md delete mode 100644 docs/awscc-docs/providers/awscc/route53/hosted_zones/index.md delete mode 100644 docs/awscc-docs/providers/awscc/route53/index.md delete mode 100644 docs/awscc-docs/providers/awscc/route53/key_signing_key/index.md delete mode 100644 docs/awscc-docs/providers/awscc/route53/key_signing_keys/index.md delete mode 100644 docs/awscc-docs/providers/awscc/route53recoverycontrol/cluster/index.md delete mode 100644 docs/awscc-docs/providers/awscc/route53recoverycontrol/clusters/index.md delete mode 100644 docs/awscc-docs/providers/awscc/route53recoverycontrol/control_panel/index.md delete mode 100644 docs/awscc-docs/providers/awscc/route53recoverycontrol/control_panels/index.md delete mode 100644 docs/awscc-docs/providers/awscc/route53recoverycontrol/index.md delete mode 100644 docs/awscc-docs/providers/awscc/route53recoverycontrol/routing_control/index.md delete mode 100644 docs/awscc-docs/providers/awscc/route53recoverycontrol/routing_controls/index.md delete mode 100644 docs/awscc-docs/providers/awscc/route53recoverycontrol/safety_rule/index.md delete mode 100644 docs/awscc-docs/providers/awscc/route53recoverycontrol/safety_rules/index.md delete mode 100644 docs/awscc-docs/providers/awscc/route53recoveryreadiness/cell/index.md delete mode 100644 docs/awscc-docs/providers/awscc/route53recoveryreadiness/cells/index.md delete mode 100644 docs/awscc-docs/providers/awscc/route53recoveryreadiness/index.md delete mode 100644 docs/awscc-docs/providers/awscc/route53recoveryreadiness/readiness_check/index.md delete mode 100644 docs/awscc-docs/providers/awscc/route53recoveryreadiness/readiness_checks/index.md delete mode 100644 docs/awscc-docs/providers/awscc/route53recoveryreadiness/recovery_group/index.md delete mode 100644 docs/awscc-docs/providers/awscc/route53recoveryreadiness/recovery_groups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/route53recoveryreadiness/resource_set/index.md delete mode 100644 docs/awscc-docs/providers/awscc/route53recoveryreadiness/resource_sets/index.md delete mode 100644 docs/awscc-docs/providers/awscc/route53resolver/firewall_domain_list/index.md delete mode 100644 docs/awscc-docs/providers/awscc/route53resolver/firewall_domain_lists/index.md delete mode 100644 docs/awscc-docs/providers/awscc/route53resolver/firewall_rule_group/index.md delete mode 100644 docs/awscc-docs/providers/awscc/route53resolver/firewall_rule_group_association/index.md delete mode 100644 docs/awscc-docs/providers/awscc/route53resolver/firewall_rule_group_associations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/route53resolver/firewall_rule_groups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/route53resolver/index.md delete mode 100644 docs/awscc-docs/providers/awscc/route53resolver/outpost_resolver/index.md delete mode 100644 docs/awscc-docs/providers/awscc/route53resolver/outpost_resolvers/index.md delete mode 100644 docs/awscc-docs/providers/awscc/route53resolver/resolver_config/index.md delete mode 100644 docs/awscc-docs/providers/awscc/route53resolver/resolver_configs/index.md delete mode 100644 docs/awscc-docs/providers/awscc/route53resolver/resolver_query_logging_config/index.md delete mode 100644 docs/awscc-docs/providers/awscc/route53resolver/resolver_query_logging_config_association/index.md delete mode 100644 docs/awscc-docs/providers/awscc/route53resolver/resolver_query_logging_config_associations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/route53resolver/resolver_query_logging_configs/index.md delete mode 100644 docs/awscc-docs/providers/awscc/route53resolver/resolver_rule/index.md delete mode 100644 docs/awscc-docs/providers/awscc/route53resolver/resolver_rule_association/index.md delete mode 100644 docs/awscc-docs/providers/awscc/route53resolver/resolver_rule_associations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/route53resolver/resolver_rules/index.md delete mode 100644 docs/awscc-docs/providers/awscc/route53resolver/resolverdnssec_config/index.md delete mode 100644 docs/awscc-docs/providers/awscc/route53resolver/resolverdnssec_configs/index.md delete mode 100644 docs/awscc-docs/providers/awscc/rum/app_monitor/index.md delete mode 100644 docs/awscc-docs/providers/awscc/rum/app_monitors/index.md delete mode 100644 docs/awscc-docs/providers/awscc/rum/index.md delete mode 100644 docs/awscc-docs/providers/awscc/s3/access_grant/index.md delete mode 100644 docs/awscc-docs/providers/awscc/s3/access_grants/index.md delete mode 100644 docs/awscc-docs/providers/awscc/s3/access_grants_instance/index.md delete mode 100644 docs/awscc-docs/providers/awscc/s3/access_grants_instances/index.md delete mode 100644 docs/awscc-docs/providers/awscc/s3/access_grants_location/index.md delete mode 100644 docs/awscc-docs/providers/awscc/s3/access_grants_locations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/s3/access_point/index.md delete mode 100644 docs/awscc-docs/providers/awscc/s3/access_points/index.md delete mode 100644 docs/awscc-docs/providers/awscc/s3/bucket/index.md delete mode 100644 docs/awscc-docs/providers/awscc/s3/bucket_policies/index.md delete mode 100644 docs/awscc-docs/providers/awscc/s3/bucket_policy/index.md delete mode 100644 docs/awscc-docs/providers/awscc/s3/buckets/index.md delete mode 100644 docs/awscc-docs/providers/awscc/s3/index.md delete mode 100644 docs/awscc-docs/providers/awscc/s3/multi_region_access_point/index.md delete mode 100644 docs/awscc-docs/providers/awscc/s3/multi_region_access_point_policies/index.md delete mode 100644 docs/awscc-docs/providers/awscc/s3/multi_region_access_point_policy/index.md delete mode 100644 docs/awscc-docs/providers/awscc/s3/multi_region_access_points/index.md delete mode 100644 docs/awscc-docs/providers/awscc/s3/storage_lens/index.md delete mode 100644 docs/awscc-docs/providers/awscc/s3/storage_lens_group/index.md delete mode 100644 docs/awscc-docs/providers/awscc/s3/storage_lens_groups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/s3express/bucket_policies/index.md delete mode 100644 docs/awscc-docs/providers/awscc/s3express/bucket_policy/index.md delete mode 100644 docs/awscc-docs/providers/awscc/s3express/directory_bucket/index.md delete mode 100644 docs/awscc-docs/providers/awscc/s3express/directory_buckets/index.md delete mode 100644 docs/awscc-docs/providers/awscc/s3express/index.md delete mode 100644 docs/awscc-docs/providers/awscc/s3objectlambda/access_point/index.md delete mode 100644 docs/awscc-docs/providers/awscc/s3objectlambda/access_point_policy/index.md delete mode 100644 docs/awscc-docs/providers/awscc/s3objectlambda/access_points/index.md delete mode 100644 docs/awscc-docs/providers/awscc/s3objectlambda/index.md delete mode 100644 docs/awscc-docs/providers/awscc/s3outposts/access_point/index.md delete mode 100644 docs/awscc-docs/providers/awscc/s3outposts/access_points/index.md delete mode 100644 docs/awscc-docs/providers/awscc/s3outposts/bucket/index.md delete mode 100644 docs/awscc-docs/providers/awscc/s3outposts/bucket_policy/index.md delete mode 100644 docs/awscc-docs/providers/awscc/s3outposts/buckets/index.md delete mode 100644 docs/awscc-docs/providers/awscc/s3outposts/endpoint/index.md delete mode 100644 docs/awscc-docs/providers/awscc/s3outposts/endpoints/index.md delete mode 100644 docs/awscc-docs/providers/awscc/s3outposts/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sagemaker/app/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sagemaker/app_image_config/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sagemaker/app_image_configs/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sagemaker/apps/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sagemaker/data_quality_job_definition/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sagemaker/data_quality_job_definitions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sagemaker/device/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sagemaker/device_fleet/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sagemaker/feature_group/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sagemaker/feature_groups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sagemaker/image/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sagemaker/image_version/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sagemaker/image_versions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sagemaker/images/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sagemaker/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sagemaker/inference_component/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sagemaker/inference_components/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sagemaker/inference_experiment/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sagemaker/inference_experiments/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sagemaker/model_bias_job_definition/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sagemaker/model_bias_job_definitions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sagemaker/model_card/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sagemaker/model_cards/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sagemaker/model_explainability_job_definition/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sagemaker/model_explainability_job_definitions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sagemaker/model_package/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sagemaker/model_package_group/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sagemaker/model_package_groups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sagemaker/model_packages/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sagemaker/model_quality_job_definition/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sagemaker/model_quality_job_definitions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sagemaker/monitoring_schedule/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sagemaker/monitoring_schedules/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sagemaker/pipeline/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sagemaker/pipelines/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sagemaker/project/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sagemaker/projects/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sagemaker/space/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sagemaker/spaces/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sagemaker/user_profile/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sagemaker/user_profiles/index.md delete mode 100644 docs/awscc-docs/providers/awscc/scheduler/index.md delete mode 100644 docs/awscc-docs/providers/awscc/scheduler/schedule/index.md delete mode 100644 docs/awscc-docs/providers/awscc/scheduler/schedule_group/index.md delete mode 100644 docs/awscc-docs/providers/awscc/scheduler/schedule_groups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/scheduler/schedules/index.md delete mode 100644 docs/awscc-docs/providers/awscc/secretsmanager/index.md delete mode 100644 docs/awscc-docs/providers/awscc/secretsmanager/secret/index.md delete mode 100644 docs/awscc-docs/providers/awscc/secretsmanager/secrets/index.md delete mode 100644 docs/awscc-docs/providers/awscc/securityhub/automation_rule/index.md delete mode 100644 docs/awscc-docs/providers/awscc/securityhub/automation_rules/index.md delete mode 100644 docs/awscc-docs/providers/awscc/securityhub/hub/index.md delete mode 100644 docs/awscc-docs/providers/awscc/securityhub/hubs/index.md delete mode 100644 docs/awscc-docs/providers/awscc/securityhub/index.md delete mode 100644 docs/awscc-docs/providers/awscc/securityhub/standard/index.md delete mode 100644 docs/awscc-docs/providers/awscc/securityhub/standards/index.md delete mode 100644 docs/awscc-docs/providers/awscc/servicecatalog/cloud_formation_provisioned_product/index.md delete mode 100644 docs/awscc-docs/providers/awscc/servicecatalog/index.md delete mode 100644 docs/awscc-docs/providers/awscc/servicecatalog/service_action/index.md delete mode 100644 docs/awscc-docs/providers/awscc/servicecatalog/service_action_association/index.md delete mode 100644 docs/awscc-docs/providers/awscc/servicecatalog/service_action_associations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/servicecatalog/service_actions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/servicecatalogappregistry/application/index.md delete mode 100644 docs/awscc-docs/providers/awscc/servicecatalogappregistry/applications/index.md delete mode 100644 docs/awscc-docs/providers/awscc/servicecatalogappregistry/attribute_group/index.md delete mode 100644 docs/awscc-docs/providers/awscc/servicecatalogappregistry/attribute_group_association/index.md delete mode 100644 docs/awscc-docs/providers/awscc/servicecatalogappregistry/attribute_group_associations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/servicecatalogappregistry/attribute_groups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/servicecatalogappregistry/index.md delete mode 100644 docs/awscc-docs/providers/awscc/servicecatalogappregistry/resource_association/index.md delete mode 100644 docs/awscc-docs/providers/awscc/servicecatalogappregistry/resource_associations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ses/configuration_set/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ses/configuration_set_event_destination/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ses/configuration_sets/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ses/contact_list/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ses/contact_lists/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ses/dedicated_ip_pool/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ses/dedicated_ip_pools/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ses/email_identities/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ses/email_identity/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ses/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ses/template/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ses/templates/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ses/vdm_attributes/index.md delete mode 100644 docs/awscc-docs/providers/awscc/shield/drt_access/index.md delete mode 100644 docs/awscc-docs/providers/awscc/shield/drt_accesses/index.md delete mode 100644 docs/awscc-docs/providers/awscc/shield/index.md delete mode 100644 docs/awscc-docs/providers/awscc/shield/proactive_engagement/index.md delete mode 100644 docs/awscc-docs/providers/awscc/shield/proactive_engagements/index.md delete mode 100644 docs/awscc-docs/providers/awscc/shield/protection/index.md delete mode 100644 docs/awscc-docs/providers/awscc/shield/protection_group/index.md delete mode 100644 docs/awscc-docs/providers/awscc/shield/protection_groups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/shield/protections/index.md delete mode 100644 docs/awscc-docs/providers/awscc/signer/index.md delete mode 100644 docs/awscc-docs/providers/awscc/signer/profile_permission/index.md delete mode 100644 docs/awscc-docs/providers/awscc/signer/profile_permissions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/signer/signing_profile/index.md delete mode 100644 docs/awscc-docs/providers/awscc/signer/signing_profiles/index.md delete mode 100644 docs/awscc-docs/providers/awscc/simspaceweaver/index.md delete mode 100644 docs/awscc-docs/providers/awscc/simspaceweaver/simulation/index.md delete mode 100644 docs/awscc-docs/providers/awscc/simspaceweaver/simulations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sns/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sns/topic/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sns/topic_inline_policy/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sns/topics/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sqs/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sqs/queue/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sqs/queue_inline_policy/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sqs/queues/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ssm/association/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ssm/associations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ssm/document/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ssm/documents/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ssm/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ssm/parameter/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ssm/parameters/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ssm/patch_baseline/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ssm/patch_baselines/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ssm/resource_data_sync/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ssm/resource_data_syncs/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ssm/resource_policies/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ssm/resource_policy/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ssmcontacts/contact/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ssmcontacts/contact_channel/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ssmcontacts/contact_channels/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ssmcontacts/contacts/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ssmcontacts/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ssmcontacts/plan/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ssmcontacts/rotation/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ssmcontacts/rotations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ssmincidents/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ssmincidents/replication_set/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ssmincidents/replication_sets/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ssmincidents/response_plan/index.md delete mode 100644 docs/awscc-docs/providers/awscc/ssmincidents/response_plans/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sso/assignment/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sso/assignments/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sso/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sso/instance_access_control_attribute_configuration/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sso/instance_access_control_attribute_configurations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sso/permission_set/index.md delete mode 100644 docs/awscc-docs/providers/awscc/sso/permission_sets/index.md delete mode 100644 docs/awscc-docs/providers/awscc/stepfunctions/activity/index.md delete mode 100644 docs/awscc-docs/providers/awscc/stepfunctions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/stepfunctions/state_machine/index.md delete mode 100644 docs/awscc-docs/providers/awscc/stepfunctions/state_machine_alias/index.md delete mode 100644 docs/awscc-docs/providers/awscc/stepfunctions/state_machine_aliases/index.md delete mode 100644 docs/awscc-docs/providers/awscc/stepfunctions/state_machine_version/index.md delete mode 100644 docs/awscc-docs/providers/awscc/stepfunctions/state_machine_versions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/stepfunctions/state_machines/index.md delete mode 100644 docs/awscc-docs/providers/awscc/supportapp/account_alias/index.md delete mode 100644 docs/awscc-docs/providers/awscc/supportapp/account_aliases/index.md delete mode 100644 docs/awscc-docs/providers/awscc/supportapp/index.md delete mode 100644 docs/awscc-docs/providers/awscc/supportapp/slack_channel_configuration/index.md delete mode 100644 docs/awscc-docs/providers/awscc/supportapp/slack_channel_configurations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/supportapp/slack_workspace_configuration/index.md delete mode 100644 docs/awscc-docs/providers/awscc/supportapp/slack_workspace_configurations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/synthetics/canaries/index.md delete mode 100644 docs/awscc-docs/providers/awscc/synthetics/canary/index.md delete mode 100644 docs/awscc-docs/providers/awscc/synthetics/group/index.md delete mode 100644 docs/awscc-docs/providers/awscc/synthetics/groups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/synthetics/index.md delete mode 100644 docs/awscc-docs/providers/awscc/systemsmanagersap/application/index.md delete mode 100644 docs/awscc-docs/providers/awscc/systemsmanagersap/applications/index.md delete mode 100644 docs/awscc-docs/providers/awscc/systemsmanagersap/index.md delete mode 100644 docs/awscc-docs/providers/awscc/timestream/database/index.md delete mode 100644 docs/awscc-docs/providers/awscc/timestream/databases/index.md delete mode 100644 docs/awscc-docs/providers/awscc/timestream/index.md delete mode 100644 docs/awscc-docs/providers/awscc/timestream/scheduled_queries/index.md delete mode 100644 docs/awscc-docs/providers/awscc/timestream/scheduled_query/index.md delete mode 100644 docs/awscc-docs/providers/awscc/timestream/table/index.md delete mode 100644 docs/awscc-docs/providers/awscc/timestream/tables/index.md delete mode 100644 docs/awscc-docs/providers/awscc/transfer/agreement/index.md delete mode 100644 docs/awscc-docs/providers/awscc/transfer/agreements/index.md delete mode 100644 docs/awscc-docs/providers/awscc/transfer/certificate/index.md delete mode 100644 docs/awscc-docs/providers/awscc/transfer/certificates/index.md delete mode 100644 docs/awscc-docs/providers/awscc/transfer/connector/index.md delete mode 100644 docs/awscc-docs/providers/awscc/transfer/connectors/index.md delete mode 100644 docs/awscc-docs/providers/awscc/transfer/index.md delete mode 100644 docs/awscc-docs/providers/awscc/transfer/profile/index.md delete mode 100644 docs/awscc-docs/providers/awscc/transfer/profiles/index.md delete mode 100644 docs/awscc-docs/providers/awscc/transfer/workflow/index.md delete mode 100644 docs/awscc-docs/providers/awscc/transfer/workflows/index.md delete mode 100644 docs/awscc-docs/providers/awscc/verifiedpermissions/identity_source/index.md delete mode 100644 docs/awscc-docs/providers/awscc/verifiedpermissions/identity_sources/index.md delete mode 100644 docs/awscc-docs/providers/awscc/verifiedpermissions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/verifiedpermissions/policies/index.md delete mode 100644 docs/awscc-docs/providers/awscc/verifiedpermissions/policy/index.md delete mode 100644 docs/awscc-docs/providers/awscc/verifiedpermissions/policy_store/index.md delete mode 100644 docs/awscc-docs/providers/awscc/verifiedpermissions/policy_stores/index.md delete mode 100644 docs/awscc-docs/providers/awscc/verifiedpermissions/policy_template/index.md delete mode 100644 docs/awscc-docs/providers/awscc/verifiedpermissions/policy_templates/index.md delete mode 100644 docs/awscc-docs/providers/awscc/voiceid/domain/index.md delete mode 100644 docs/awscc-docs/providers/awscc/voiceid/domains/index.md delete mode 100644 docs/awscc-docs/providers/awscc/voiceid/index.md delete mode 100644 docs/awscc-docs/providers/awscc/vpclattice/access_log_subscription/index.md delete mode 100644 docs/awscc-docs/providers/awscc/vpclattice/access_log_subscriptions/index.md delete mode 100644 docs/awscc-docs/providers/awscc/vpclattice/auth_policy/index.md delete mode 100644 docs/awscc-docs/providers/awscc/vpclattice/index.md delete mode 100644 docs/awscc-docs/providers/awscc/vpclattice/listener/index.md delete mode 100644 docs/awscc-docs/providers/awscc/vpclattice/listeners/index.md delete mode 100644 docs/awscc-docs/providers/awscc/vpclattice/resource_policy/index.md delete mode 100644 docs/awscc-docs/providers/awscc/vpclattice/rule/index.md delete mode 100644 docs/awscc-docs/providers/awscc/vpclattice/rules/index.md delete mode 100644 docs/awscc-docs/providers/awscc/vpclattice/service/index.md delete mode 100644 docs/awscc-docs/providers/awscc/vpclattice/service_network/index.md delete mode 100644 docs/awscc-docs/providers/awscc/vpclattice/service_network_service_association/index.md delete mode 100644 docs/awscc-docs/providers/awscc/vpclattice/service_network_service_associations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/vpclattice/service_network_vpc_association/index.md delete mode 100644 docs/awscc-docs/providers/awscc/vpclattice/service_network_vpc_associations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/vpclattice/service_networks/index.md delete mode 100644 docs/awscc-docs/providers/awscc/vpclattice/services/index.md delete mode 100644 docs/awscc-docs/providers/awscc/vpclattice/target_group/index.md delete mode 100644 docs/awscc-docs/providers/awscc/vpclattice/target_groups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/wafv2/index.md delete mode 100644 docs/awscc-docs/providers/awscc/wafv2/ip_set/index.md delete mode 100644 docs/awscc-docs/providers/awscc/wafv2/ip_sets/index.md delete mode 100644 docs/awscc-docs/providers/awscc/wafv2/logging_configuration/index.md delete mode 100644 docs/awscc-docs/providers/awscc/wafv2/logging_configurations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/wafv2/regex_pattern_set/index.md delete mode 100644 docs/awscc-docs/providers/awscc/wafv2/regex_pattern_sets/index.md delete mode 100644 docs/awscc-docs/providers/awscc/wafv2/rule_group/index.md delete mode 100644 docs/awscc-docs/providers/awscc/wafv2/rule_groups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/wafv2/web_acl/index.md delete mode 100644 docs/awscc-docs/providers/awscc/wafv2/web_acls/index.md delete mode 100644 docs/awscc-docs/providers/awscc/wafv2/webacl_association/index.md delete mode 100644 docs/awscc-docs/providers/awscc/wisdom/assistant/index.md delete mode 100644 docs/awscc-docs/providers/awscc/wisdom/assistant_association/index.md delete mode 100644 docs/awscc-docs/providers/awscc/wisdom/assistant_associations/index.md delete mode 100644 docs/awscc-docs/providers/awscc/wisdom/assistants/index.md delete mode 100644 docs/awscc-docs/providers/awscc/wisdom/index.md delete mode 100644 docs/awscc-docs/providers/awscc/wisdom/knowledge_base/index.md delete mode 100644 docs/awscc-docs/providers/awscc/wisdom/knowledge_bases/index.md delete mode 100644 docs/awscc-docs/providers/awscc/workspaces/connection_alias/index.md delete mode 100644 docs/awscc-docs/providers/awscc/workspaces/index.md delete mode 100644 docs/awscc-docs/providers/awscc/workspacesthinclient/environment/index.md delete mode 100644 docs/awscc-docs/providers/awscc/workspacesthinclient/environments/index.md delete mode 100644 docs/awscc-docs/providers/awscc/workspacesthinclient/index.md delete mode 100644 docs/awscc-docs/providers/awscc/workspacesweb/browser_settings/index.md delete mode 100644 docs/awscc-docs/providers/awscc/workspacesweb/identity_provider/index.md delete mode 100644 docs/awscc-docs/providers/awscc/workspacesweb/identity_providers/index.md delete mode 100644 docs/awscc-docs/providers/awscc/workspacesweb/index.md delete mode 100644 docs/awscc-docs/providers/awscc/workspacesweb/ip_access_settings/index.md delete mode 100644 docs/awscc-docs/providers/awscc/workspacesweb/network_settings/index.md delete mode 100644 docs/awscc-docs/providers/awscc/workspacesweb/portal/index.md delete mode 100644 docs/awscc-docs/providers/awscc/workspacesweb/portals/index.md delete mode 100644 docs/awscc-docs/providers/awscc/workspacesweb/trust_store/index.md delete mode 100644 docs/awscc-docs/providers/awscc/workspacesweb/trust_stores/index.md delete mode 100644 docs/awscc-docs/providers/awscc/workspacesweb/user_access_logging_settings/index.md delete mode 100644 docs/awscc-docs/providers/awscc/workspacesweb/user_settings/index.md delete mode 100644 docs/awscc-docs/providers/awscc/xray/group/index.md delete mode 100644 docs/awscc-docs/providers/awscc/xray/groups/index.md delete mode 100644 docs/awscc-docs/providers/awscc/xray/index.md delete mode 100644 docs/awscc-docs/providers/awscc/xray/resource_policies/index.md delete mode 100644 docs/awscc-docs/providers/awscc/xray/resource_policy/index.md delete mode 100644 docs/awscc-docs/providers/awscc/xray/sampling_rule/index.md delete mode 100644 docs/awscc-docs/providers/awscc/xray/sampling_rules/index.md delete mode 100644 docs/awscc-docs/stackql-provider-registry.mdx diff --git a/.github/workflows/build-docs.yaml b/.github/workflows/build-docs.yaml index 8404b54ddb..8a3b600b12 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 awscc azure azure-extras azure-isv azure-stack digitalocean firebase github google googleadmin k8s linode netlify okta sumologic vercel godaddy pagerduty homebrew datadog ) + array=( aws 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 c42c72230b..b59adab2d9 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,6 @@ 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 e70bd38c16..0c3e5e6bbe 100644 --- a/ci-scripts/get-providers-to-deploy.js +++ b/ci-scripts/get-providers-to-deploy.js @@ -8,7 +8,6 @@ const isMatchRegex = (path) => regex.test(path); const rootName = 'root' const allProviders = [ 'aws', - 'awscc', 'azure', 'azure_extras', 'azure_isv', diff --git a/docs/aws-docs/index.md b/docs/aws-docs/index.md index 58e16fcb9c..0d4497123d 100644 --- a/docs/aws-docs/index.md +++ b/docs/aws-docs/index.md @@ -1,106 +1,318 @@ ---- -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 +--- +title: aws +hide_title: false +hide_table_of_contents: false +keywords: + - aws + - aws cloud control + - cloud control api + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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. ---- -EC2, IAM and S3 core AWS Services. -:::tip - -All AWS Services (incl Lambda, DynamoDB, RDS, etc) are supported by the [__`awscc`__](https://awscc.stackql.io/providers/awscc/) (AWS Cloud Control API) provider in StackQL. - -::: - - -:::info Provider Summary (v24.03.00220) +:::info Provider Summary (v24.05.00228)
-total services: 4
-total methods: 780
+total services: 220
+total methods: 6,535
-total resources: 346
-total selectable resources: 250
+total resources: 1,915
+total selectable resources: 1,807
::: -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)) -- `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)) - -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`) - +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)) +- `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)) + +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
+bcmdataexports
+bedrock
+billingconductor
+budgets
+cassandra
+ce
+certificatemanager
+chatbot
+cleanrooms
+cleanroomsml
cloud_control
+cloudformation
+cloudfront
+cloudhsm
+cloudtrail
+cloudwatch
+cloudwatch_api
+codeartifact
+codebuild
+codeconnections
+codedeploy
+codeguruprofiler
+codegurureviewer
+codepipeline
+codestarconnections
+codestarnotifications
+cognito
+comprehend
+config
+connect
+connectcampaigns
+controltower
+cur
+customerprofiles
+databrew
+datapipeline
+datasync
+datazone
+deadline
+detective
+devopsguru
+directoryservice
+dms
+docdbelastic
+dynamodb
ec2
+ec2_api
+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
+iam_api
+identitystore
+imagebuilder
+inspector
+inspectorv2
+internetmonitor
+iot
+iotanalytics
+iotcoredeviceadvisor
+iotevents
-iam
+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
+s3_api
+s3express
+s3objectlambda
+s3outposts
+sagemaker
+scheduler
+secretsmanager
+securityhub
+securitylake
+servicecatalog
+servicecatalogappregistry
+ses
+shield
+signer
+simspaceweaver
+sns
+sqs
+ssm
+ssmcontacts
+ssmincidents
+sso
+stepfunctions
+supportapp
+synthetics
+systemsmanagersap
+timestream
+transfer
+transfer_api
+verifiedpermissions
+voiceid
+vpclattice
+wafv2
+wisdom
+workspaces
+workspacesthinclient
+workspacesweb
+xray
diff --git a/docs/aws-docs/providers/aws/accessanalyzer/analyzer/index.md b/docs/aws-docs/providers/aws/accessanalyzer/analyzer/index.md new file mode 100644 index 0000000000..e27cbe179e --- /dev/null +++ b/docs/aws-docs/providers/aws/accessanalyzer/analyzer/index.md @@ -0,0 +1,104 @@ +--- +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
DescriptionThe AWS::AccessAnalyzer::Analyzer type specifies an analyzer of the user's account
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +analyzer_name, +archive_rules, +arn, +tags, +type, +analyzer_configuration +FROM aws.accessanalyzer.analyzer +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the analyzer resource, the following permissions are required: + +### Read +```json +access-analyzer:ListAnalyzers, +access-analyzer:GetAnalyzer, +access-analyzer:ListArchiveRules +``` + +### Update +```json +access-analyzer:CreateArchiveRule, +access-analyzer:DeleteArchiveRule, +access-analyzer:ListAnalyzers, +access-analyzer:TagResource, +access-analyzer:UntagResource, +access-analyzer:UpdateArchiveRule +``` + +### Delete +```json +access-analyzer:DeleteAnalyzer +``` + diff --git a/docs/aws-docs/providers/aws/accessanalyzer/analyzers/index.md b/docs/aws-docs/providers/aws/accessanalyzer/analyzers/index.md new file mode 100644 index 0000000000..f7a7b89046 --- /dev/null +++ b/docs/aws-docs/providers/aws/accessanalyzer/analyzers/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionThe AWS::AccessAnalyzer::Analyzer type specifies an analyzer of the user's account
Idaws.accessanalyzer.analyzers
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringAmazon Resource Name (ARN) of the analyzer
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.accessanalyzer.analyzers +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the analyzers resource, the following permissions are required: + +### Create +```json +access-analyzer:CreateAnalyzer, +access-analyzer:TagResource, +iam:CreateServiceLinkedRole, +organizations:ListAWSServiceAccessForOrganization, +organizations:ListDelegatedAdministrators +``` + +### List +```json +access-analyzer:ListAnalyzers +``` + diff --git a/docs/aws-docs/providers/aws/accessanalyzer/index.md b/docs/aws-docs/providers/aws/accessanalyzer/index.md new file mode 100644 index 0000000000..2cf8ed5bac --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/acmpca/certificate/index.md b/docs/aws-docs/providers/aws/acmpca/certificate/index.md new file mode 100644 index 0000000000..043491b7bd --- /dev/null +++ b/docs/aws-docs/providers/aws/acmpca/certificate/index.md @@ -0,0 +1,98 @@ +--- +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
DescriptionThe ``AWS::ACMPCA::Certificate`` resource is used to issue a certificate using your private certificate authority. For more information, see the [IssueCertificate](https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html) action.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +api_passthrough, +certificate_authority_arn, +certificate_signing_request, +signing_algorithm, +template_arn, +validity, +validity_not_before, +certificate, +arn +FROM aws.acmpca.certificate +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the certificate resource, the following permissions are required: + +### Read +```json +acm-pca:GetCertificate +``` + +### Delete +```json +acm-pca:GetCertificate +``` + diff --git a/docs/aws-docs/providers/aws/acmpca/certificate_authorities/index.md b/docs/aws-docs/providers/aws/acmpca/certificate_authorities/index.md new file mode 100644 index 0000000000..e206f59493 --- /dev/null +++ b/docs/aws-docs/providers/aws/acmpca/certificate_authorities/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionPrivate certificate authority.
Idaws.acmpca.certificate_authorities
+ +## Fields + + + + + +
NameDatatypeDescription
arnundefinedThe Amazon Resource Name (ARN) of the certificate authority.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.acmpca.certificate_authorities +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the certificate_authorities resource, the following permissions are required: + +### Create +```json +acm-pca:CreateCertificateAuthority, +acm-pca:DescribeCertificateAuthority, +acm-pca:GetCertificateAuthorityCsr +``` + +### List +```json +acm-pca:DescribeCertificateAuthority, +acm-pca:GetCertificateAuthorityCsr, +acm-pca:ListCertificateAuthorities, +acm-pca:ListTags +``` + diff --git a/docs/aws-docs/providers/aws/acmpca/certificate_authority/index.md b/docs/aws-docs/providers/aws/acmpca/certificate_authority/index.md new file mode 100644 index 0000000000..ccade6947a --- /dev/null +++ b/docs/aws-docs/providers/aws/acmpca/certificate_authority/index.md @@ -0,0 +1,113 @@ +--- +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
DescriptionPrivate certificate authority.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.acmpca.certificate_authority +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the certificate_authority resource, the following permissions are required: + +### Read +```json +acm-pca:DescribeCertificateAuthority, +acm-pca:GetCertificateAuthorityCsr, +acm-pca:ListTags +``` + +### Update +```json +acm-pca:ListTags, +acm-pca:TagCertificateAuthority, +acm-pca:UntagCertificateAuthority, +acm-pca:UpdateCertificateAuthority +``` + +### Delete +```json +acm-pca:DeleteCertificateAuthority, +acm-pca:DescribeCertificateAuthority +``` + diff --git a/docs/aws-docs/providers/aws/acmpca/certificate_authority_activation/index.md b/docs/aws-docs/providers/aws/acmpca/certificate_authority_activation/index.md new file mode 100644 index 0000000000..88be63e8fc --- /dev/null +++ b/docs/aws-docs/providers/aws/acmpca/certificate_authority_activation/index.md @@ -0,0 +1,97 @@ +--- +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
DescriptionUsed to install the certificate authority certificate and update the certificate authority status.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +certificate_authority_arn, +certificate, +certificate_chain, +status, +complete_certificate_chain +FROM aws.acmpca.certificate_authority_activation +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the certificate_authority_activation resource, the following permissions are required: + +### Read +```json +acm-pca:GetCertificateAuthorityCertificate, +acm-pca:DescribeCertificateAuthority +``` + +### Delete +```json +acm-pca:UpdateCertificateAuthority +``` + +### Update +```json +acm-pca:ImportCertificateAuthorityCertificate, +acm-pca:UpdateCertificateAuthority +``` + diff --git a/docs/aws-docs/providers/aws/acmpca/certificate_authority_activations/index.md b/docs/aws-docs/providers/aws/acmpca/certificate_authority_activations/index.md new file mode 100644 index 0000000000..92eb0bfa27 --- /dev/null +++ b/docs/aws-docs/providers/aws/acmpca/certificate_authority_activations/index.md @@ -0,0 +1,68 @@ +--- +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
DescriptionUsed to install the certificate authority certificate and update the certificate authority status.
Idaws.acmpca.certificate_authority_activations
+ +## Fields + + + + + +
NameDatatypeDescription
certificate_authority_arnstringArn of the Certificate Authority.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +certificate_authority_arn +FROM aws.acmpca.certificate_authority_activations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the certificate_authority_activations resource, the following permissions are required: + +### Create +```json +acm-pca:ImportCertificateAuthorityCertificate, +acm-pca:UpdateCertificateAuthority +``` + diff --git a/docs/aws-docs/providers/aws/acmpca/certificates/index.md b/docs/aws-docs/providers/aws/acmpca/certificates/index.md new file mode 100644 index 0000000000..2080788d60 --- /dev/null +++ b/docs/aws-docs/providers/aws/acmpca/certificates/index.md @@ -0,0 +1,70 @@ +--- +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
DescriptionThe ``AWS::ACMPCA::Certificate`` resource is used to issue a certificate using your private certificate authority. For more information, see the [IssueCertificate](https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html) action.
Idaws.acmpca.certificates
+ +## Fields + + + + + + +
NameDatatypeDescription
arnundefined
certificate_authority_arnundefinedThe Amazon Resource Name (ARN) for the private CA issues the certificate.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +certificate_authority_arn +FROM aws.acmpca.certificates +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the certificates resource, the following permissions are required: + +### Create +```json +acm-pca:IssueCertificate, +acm-pca:GetCertificate +``` + diff --git a/docs/aws-docs/providers/aws/acmpca/index.md b/docs/aws-docs/providers/aws/acmpca/index.md new file mode 100644 index 0000000000..1e24200b3d --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/acmpca/permission/index.md b/docs/aws-docs/providers/aws/acmpca/permission/index.md new file mode 100644 index 0000000000..d8ac6301e2 --- /dev/null +++ b/docs/aws-docs/providers/aws/acmpca/permission/index.md @@ -0,0 +1,83 @@ +--- +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 set on private certificate authority
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +actions, +certificate_authority_arn, +principal, +source_account +FROM aws.acmpca.permission +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the permission resource, the following permissions are required: + +### Read +```json +acm-pca:ListPermissions +``` + +### Delete +```json +acm-pca:DeletePermission +``` + diff --git a/docs/aws-docs/providers/aws/acmpca/permissions/index.md b/docs/aws-docs/providers/aws/acmpca/permissions/index.md new file mode 100644 index 0000000000..120f6a3359 --- /dev/null +++ b/docs/aws-docs/providers/aws/acmpca/permissions/index.md @@ -0,0 +1,70 @@ +--- +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
DescriptionPermission set on private certificate authority
Idaws.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 + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +certificate_authority_arn, +principal +FROM aws.acmpca.permissions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the permissions resource, the following permissions are required: + +### Create +```json +acm-pca:CreatePermission, +acm-pca:ListPermissions +``` + diff --git a/docs/aws-docs/providers/aws/amplify/app/index.md b/docs/aws-docs/providers/aws/amplify/app/index.md new file mode 100644 index 0000000000..2ef437038f --- /dev/null +++ b/docs/aws-docs/providers/aws/amplify/app/index.md @@ -0,0 +1,144 @@ +--- +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
DescriptionThe AWS::Amplify::App resource creates Apps in the Amplify Console. An App is a collection of branches.
Idaws.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
iam_service_rolestring
namestring
oauth_tokenstring
platformstring
repositorystring
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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, +iam_service_role, +name, +oauth_token, +platform, +repository, +tags +FROM aws.amplify.app +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the app resource, the following permissions are required: + +### Delete +```json +amplify:GetApp, +amplify:DeleteApp, +codecommit:GetRepository, +codecommit:GetRepositoryTriggers, +codecommit:PutRepositoryTriggers, +sns:Unsubscribe, +iam:PassRole +``` + +### Read +```json +amplify:GetApp, +amplify:ListTagsForResource, +codecommit:GetRepository, +codecommit:GetRepositoryTriggers, +iam:PassRole +``` + +### Update +```json +amplify:GetApp, +amplify:UpdateApp, +amplify:ListTagsForResource, +amplify:TagResource, +amplify:UntagResource, +codecommit:GetRepository, +codecommit:PutRepositoryTriggers, +codecommit:GetRepositoryTriggers, +sns:CreateTopic, +sns:Subscribe, +sns:Unsubscribe, +iam:PassRole +``` + diff --git a/docs/aws-docs/providers/aws/amplify/apps/index.md b/docs/aws-docs/providers/aws/amplify/apps/index.md new file mode 100644 index 0000000000..98d1622de0 --- /dev/null +++ b/docs/aws-docs/providers/aws/amplify/apps/index.md @@ -0,0 +1,88 @@ +--- +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
DescriptionThe AWS::Amplify::App resource creates Apps in the Amplify Console. An App is a collection of branches.
Idaws.amplify.apps
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.amplify.apps +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the apps resource, the following permissions are required: + +### Create +```json +amplify:GetApp, +amplify:CreateApp, +amplify:TagResource, +codecommit:GetRepository, +codecommit:PutRepositoryTriggers, +codecommit:GetRepositoryTriggers, +sns:CreateTopic, +sns:Subscribe, +iam:PassRole +``` + +### List +```json +amplify:GetApp, +amplify:ListApps, +amplify:ListTagsForResource, +iam:PassRole +``` + diff --git a/docs/aws-docs/providers/aws/amplify/branch/index.md b/docs/aws-docs/providers/aws/amplify/branch/index.md new file mode 100644 index 0000000000..832e35dd23 --- /dev/null +++ b/docs/aws-docs/providers/aws/amplify/branch/index.md @@ -0,0 +1,141 @@ +--- +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
DescriptionThe AWS::Amplify::Branch resource creates a new branch within an app.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.amplify.branch +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the branch resource, the following permissions are required: + +### Delete +```json +amplify:GetBranch, +amplify:DeleteBranch, +codecommit:GetRepository, +codecommit:GetRepositoryTriggers, +sns:Unsubscribe, +iam:PassRole +``` + +### Read +```json +amplify:GetBranch, +amplify:ListTagsForResource, +codecommit:GetRepository, +codecommit:GetRepositoryTriggers, +s3:GetObject, +s3:GetObjectAcl, +iam:PassRole +``` + +### Update +```json +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 +``` + diff --git a/docs/aws-docs/providers/aws/amplify/branches/index.md b/docs/aws-docs/providers/aws/amplify/branches/index.md new file mode 100644 index 0000000000..dee9da28aa --- /dev/null +++ b/docs/aws-docs/providers/aws/amplify/branches/index.md @@ -0,0 +1,92 @@ +--- +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
DescriptionThe AWS::Amplify::Branch resource creates a new branch within an app.
Idaws.amplify.branches
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.amplify.branches +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the branches resource, the following permissions are required: + +### Create +```json +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 +```json +amplify:GetBranch, +amplify:ListBranches, +amplify:ListTagsForResource, +iam:PassRole +``` + diff --git a/docs/aws-docs/providers/aws/amplify/domain/index.md b/docs/aws-docs/providers/aws/amplify/domain/index.md new file mode 100644 index 0000000000..dd56f6c3ed --- /dev/null +++ b/docs/aws-docs/providers/aws/amplify/domain/index.md @@ -0,0 +1,122 @@ +--- +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
DescriptionThe AWS::Amplify::Domain resource allows you to connect a custom domain to your app.
Idaws.amplify.domain
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
app_idstring
arnstring
auto_sub_domain_creation_patternsarray
auto_sub_domain_iam_rolestring
certificate_recordstring
certificateobject
certificate_settingsobject
domain_namestring
domain_statusstring
update_statusstring
enable_auto_sub_domainboolean
status_reasonstring
sub_domain_settingsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +app_id, +arn, +auto_sub_domain_creation_patterns, +auto_sub_domain_iam_role, +certificate_record, +certificate, +certificate_settings, +domain_name, +domain_status, +update_status, +enable_auto_sub_domain, +status_reason, +sub_domain_settings +FROM aws.amplify.domain +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the domain resource, the following permissions are required: + +### Delete +```json +amplify:DeleteDomainAssociation, +iam:PassRole, +amplify:DeleteDomainAssociation +``` + +### Read +```json +amplify:GetDomainAssociation, +route53:ListHostedZones, +iam:PassRole, +amplify:ListTagsForResource +``` + +### Update +```json +amplify:UpdateDomainAssociation, +route53:ListHostedZones, +route53:ChangeResourceRecordSets, +iam:PassRole, +amplify:ListTagsForResource, +amplify:TagResource, +amplify:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/amplify/domains/index.md b/docs/aws-docs/providers/aws/amplify/domains/index.md new file mode 100644 index 0000000000..78425bca74 --- /dev/null +++ b/docs/aws-docs/providers/aws/amplify/domains/index.md @@ -0,0 +1,83 @@ +--- +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
DescriptionThe AWS::Amplify::Domain resource allows you to connect a custom domain to your app.
Idaws.amplify.domains
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.amplify.domains +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the domains resource, the following permissions are required: + +### Create +```json +amplify:CreateDomainAssociation, +route53:ListHostedZones, +route53:ChangeResourceRecordSets, +iam:PassRole, +amplify:TagResource +``` + +### List +```json +amplify:ListDomainAssociations, +iam:PassRole, +amplify:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/amplify/index.md b/docs/aws-docs/providers/aws/amplify/index.md new file mode 100644 index 0000000000..6643c489b9 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/amplifyuibuilder/component/index.md b/docs/aws-docs/providers/aws/amplifyuibuilder/component/index.md new file mode 100644 index 0000000000..d1b40feff0 --- /dev/null +++ b/docs/aws-docs/providers/aws/amplifyuibuilder/component/index.md @@ -0,0 +1,127 @@ +--- +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
DescriptionDefinition of AWS::AmplifyUIBuilder::Component Resource Type
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.amplifyuibuilder.component +WHERE data__Identifier = '||'; +``` + +## Permissions + +To operate on the component resource, the following permissions are required: + +### Read +```json +amplify:GetApp, +amplifyuibuilder:GetComponent +``` + +### Update +```json +amplify:GetApp, +amplifyuibuilder:GetComponent, +amplifyuibuilder:TagResource, +amplifyuibuilder:UntagResource, +amplifyuibuilder:UpdateComponent +``` + +### Delete +```json +amplify:GetApp, +amplifyuibuilder:DeleteComponent, +amplifyuibuilder:GetComponent, +amplifyuibuilder:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/amplifyuibuilder/components/index.md b/docs/aws-docs/providers/aws/amplifyuibuilder/components/index.md new file mode 100644 index 0000000000..aa8d4ecf71 --- /dev/null +++ b/docs/aws-docs/providers/aws/amplifyuibuilder/components/index.md @@ -0,0 +1,85 @@ +--- +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
DescriptionDefinition of AWS::AmplifyUIBuilder::Component Resource Type
Idaws.amplifyuibuilder.components
+ +## Fields + + + + + + + +
NameDatatypeDescription
app_idstring
environment_namestring
idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +app_id, +environment_name, +id +FROM aws.amplifyuibuilder.components +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the components resource, the following permissions are required: + +### Create +```json +amplify:GetApp, +amplifyuibuilder:CreateComponent, +amplifyuibuilder:GetComponent, +amplifyuibuilder:TagResource +``` + +### List +```json +amplify:GetApp, +amplifyuibuilder:ListComponents +``` + diff --git a/docs/aws-docs/providers/aws/amplifyuibuilder/form/index.md b/docs/aws-docs/providers/aws/amplifyuibuilder/form/index.md new file mode 100644 index 0000000000..ee41216799 --- /dev/null +++ b/docs/aws-docs/providers/aws/amplifyuibuilder/form/index.md @@ -0,0 +1,120 @@ +--- +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
DescriptionDefinition of AWS::AmplifyUIBuilder::Form Resource Type
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.amplifyuibuilder.form +WHERE data__Identifier = '||'; +``` + +## Permissions + +To operate on the form resource, the following permissions are required: + +### Read +```json +amplify:GetApp, +amplifyuibuilder:GetForm, +amplifyuibuilder:TagResource +``` + +### Update +```json +amplify:GetApp, +amplifyuibuilder:GetForm, +amplifyuibuilder:TagResource, +amplifyuibuilder:UntagResource, +amplifyuibuilder:UpdateForm +``` + +### Delete +```json +amplify:GetApp, +amplifyuibuilder:DeleteForm, +amplifyuibuilder:TagResource, +amplifyuibuilder:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/amplifyuibuilder/forms/index.md b/docs/aws-docs/providers/aws/amplifyuibuilder/forms/index.md new file mode 100644 index 0000000000..5a083d6983 --- /dev/null +++ b/docs/aws-docs/providers/aws/amplifyuibuilder/forms/index.md @@ -0,0 +1,86 @@ +--- +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
DescriptionDefinition of AWS::AmplifyUIBuilder::Form Resource Type
Idaws.amplifyuibuilder.forms
+ +## Fields + + + + + + + +
NameDatatypeDescription
app_idstring
environment_namestring
idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +app_id, +environment_name, +id +FROM aws.amplifyuibuilder.forms +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the forms resource, the following permissions are required: + +### Create +```json +amplify:GetApp, +amplifyuibuilder:CreateForm, +amplifyuibuilder:GetForm, +amplifyuibuilder:TagResource, +amplifyuibuilder:UntagResource +``` + +### List +```json +amplify:GetApp, +amplifyuibuilder:ListForms +``` + diff --git a/docs/aws-docs/providers/aws/amplifyuibuilder/index.md b/docs/aws-docs/providers/aws/amplifyuibuilder/index.md new file mode 100644 index 0000000000..acef9657e5 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/amplifyuibuilder/theme/index.md b/docs/aws-docs/providers/aws/amplifyuibuilder/theme/index.md new file mode 100644 index 0000000000..416df40f12 --- /dev/null +++ b/docs/aws-docs/providers/aws/amplifyuibuilder/theme/index.md @@ -0,0 +1,110 @@ +--- +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
DescriptionDefinition of AWS::AmplifyUIBuilder::Theme Resource Type
Idaws.amplifyuibuilder.theme
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
app_idstring
created_atstring
environment_namestring
idstring
modified_atstring
namestring
overridesarray
tagsobject
valuesarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +app_id, +created_at, +environment_name, +id, +modified_at, +name, +overrides, +tags, +values +FROM aws.amplifyuibuilder.theme +WHERE data__Identifier = '||'; +``` + +## Permissions + +To operate on the theme resource, the following permissions are required: + +### Read +```json +amplify:GetApp, +amplifyuibuilder:GetTheme +``` + +### Update +```json +amplify:GetApp, +amplifyuibuilder:GetTheme, +amplifyuibuilder:TagResource, +amplifyuibuilder:UntagResource, +amplifyuibuilder:UpdateTheme +``` + +### Delete +```json +amplify:GetApp, +amplifyuibuilder:DeleteTheme, +amplifyuibuilder:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/amplifyuibuilder/themes/index.md b/docs/aws-docs/providers/aws/amplifyuibuilder/themes/index.md new file mode 100644 index 0000000000..2012c59539 --- /dev/null +++ b/docs/aws-docs/providers/aws/amplifyuibuilder/themes/index.md @@ -0,0 +1,85 @@ +--- +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
DescriptionDefinition of AWS::AmplifyUIBuilder::Theme Resource Type
Idaws.amplifyuibuilder.themes
+ +## Fields + + + + + + + +
NameDatatypeDescription
app_idstring
environment_namestring
idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +app_id, +environment_name, +id +FROM aws.amplifyuibuilder.themes +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the themes resource, the following permissions are required: + +### Create +```json +amplify:GetApp, +amplifyuibuilder:CreateTheme, +amplifyuibuilder:GetTheme, +amplifyuibuilder:TagResource +``` + +### List +```json +amplify:GetApp, +amplifyuibuilder:ListThemes +``` + diff --git a/docs/aws-docs/providers/aws/apigateway/account/index.md b/docs/aws-docs/providers/aws/apigateway/account/index.md new file mode 100644 index 0000000000..1cbf9e11e9 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/account/index.md @@ -0,0 +1,86 @@ +--- +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
DescriptionThe ``AWS::ApiGateway::Account`` resource specifies the IAM role that Amazon API Gateway uses to write API logs to Amazon CloudWatch Logs. To avoid overwriting other roles, you should only have one ``AWS::ApiGateway::Account`` resource per region per account.
Idaws.apigateway.account
+ +## Fields + + + + + + +
NameDatatypeDescription
idstring
cloud_watch_role_arnstringThe ARN of an Amazon CloudWatch role for the current Account.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +cloud_watch_role_arn +FROM aws.apigateway.account +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the account resource, the following permissions are required: + +### Read +```json +apigateway:GET +``` + +### Update +```json +apigateway:PATCH, +iam:GetRole, +iam:PassRole +``` + diff --git a/docs/aws-docs/providers/aws/apigateway/accounts/index.md b/docs/aws-docs/providers/aws/apigateway/accounts/index.md new file mode 100644 index 0000000000..e0c214d902 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/accounts/index.md @@ -0,0 +1,69 @@ +--- +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
DescriptionThe ``AWS::ApiGateway::Account`` resource specifies the IAM role that Amazon API Gateway uses to write API logs to Amazon CloudWatch Logs. To avoid overwriting other roles, you should only have one ``AWS::ApiGateway::Account`` resource per region per account.
Idaws.apigateway.accounts
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.apigateway.accounts +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the accounts resource, the following permissions are required: + +### Create +```json +apigateway:PATCH, +iam:GetRole, +iam:PassRole +``` + diff --git a/docs/aws-docs/providers/aws/apigateway/api_key/index.md b/docs/aws-docs/providers/aws/apigateway/api_key/index.md new file mode 100644 index 0000000000..d12db75475 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/api_key/index.md @@ -0,0 +1,107 @@ +--- +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
DescriptionThe ``AWS::ApiGateway::ApiKey`` resource creates a unique key that you can distribute to clients who are executing API Gateway ``Method`` resources that require an API key. To specify which API key clients must use, map the API key with the ``RestApi`` and ``Stage`` resources that include the methods that require a key.
Idaws.apigateway.api_key
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
api_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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +api_key_id, +customer_id, +description, +enabled, +generate_distinct_id, +name, +stage_keys, +tags, +value +FROM aws.apigateway.api_key +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the api_key resource, the following permissions are required: + +### Read +```json +apigateway:GET +``` + +### Update +```json +apigateway:GET, +apigateway:PATCH, +apigateway:PUT, +apigateway:DELETE +``` + +### Delete +```json +apigateway:DELETE, +apigateway:GET +``` + diff --git a/docs/aws-docs/providers/aws/apigateway/api_keys/index.md b/docs/aws-docs/providers/aws/apigateway/api_keys/index.md new file mode 100644 index 0000000000..01a038075b --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/api_keys/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionThe ``AWS::ApiGateway::ApiKey`` resource creates a unique key that you can distribute to clients who are executing API Gateway ``Method`` resources that require an API key. To specify which API key clients must use, map the API key with the ``RestApi`` and ``Stage`` resources that include the methods that require a key.
Idaws.apigateway.api_keys
+ +## Fields + + + + + +
NameDatatypeDescription
api_key_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +api_key_id +FROM aws.apigateway.api_keys +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the api_keys resource, the following permissions are required: + +### Create +```json +apigateway:POST, +apigateway:GET, +apigateway:PUT +``` + +### List +```json +apigateway:GET +``` + diff --git a/docs/aws-docs/providers/aws/apigateway/authorizer/index.md b/docs/aws-docs/providers/aws/apigateway/authorizer/index.md new file mode 100644 index 0000000000..180deb5ed2 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/authorizer/index.md @@ -0,0 +1,109 @@ +--- +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
DescriptionThe ``AWS::ApiGateway::Authorizer`` resource creates an authorization layer that API Gateway activates for methods that have authorization enabled. API Gateway activates the authorizer when a client calls those methods.
Idaws.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 this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
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_arnsarrayA 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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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_arns, +type +FROM aws.apigateway.authorizer +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the authorizer resource, the following permissions are required: + +### Read +```json +apigateway:GET +``` + +### Update +```json +apigateway:GET, +apigateway:PATCH, +iam:PassRole +``` + +### Delete +```json +apigateway:DELETE +``` + diff --git a/docs/aws-docs/providers/aws/apigateway/authorizers/index.md b/docs/aws-docs/providers/aws/apigateway/authorizers/index.md new file mode 100644 index 0000000000..a24afba32c --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/authorizers/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionThe ``AWS::ApiGateway::Authorizer`` resource creates an authorization layer that API Gateway activates for methods that have authorization enabled. API Gateway activates the authorizer when a client calls those methods.
Idaws.apigateway.authorizers
+ +## Fields + + + + + + +
NameDatatypeDescription
rest_api_idstringThe string identifier of the associated RestApi.
authorizer_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +rest_api_id, +authorizer_id +FROM aws.apigateway.authorizers +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the authorizers resource, the following permissions are required: + +### Create +```json +apigateway:POST, +iam:PassRole +``` + +### List +```json +apigateway:GET +``` + diff --git a/docs/aws-docs/providers/aws/apigateway/base_path_mapping/index.md b/docs/aws-docs/providers/aws/apigateway/base_path_mapping/index.md new file mode 100644 index 0000000000..7dc51601f8 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/base_path_mapping/index.md @@ -0,0 +1,95 @@ +--- +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
DescriptionThe ``AWS::ApiGateway::BasePathMapping`` resource creates a base path that clients who call your API must use in the invocation URL.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +base_path, +domain_name, +rest_api_id, +stage +FROM aws.apigateway.base_path_mapping +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the base_path_mapping resource, the following permissions are required: + +### Read +```json +apigateway:GET +``` + +### Update +```json +apigateway:GET, +apigateway:DELETE, +apigateway:PATCH +``` + +### Delete +```json +apigateway:DELETE +``` + diff --git a/docs/aws-docs/providers/aws/apigateway/base_path_mappings/index.md b/docs/aws-docs/providers/aws/apigateway/base_path_mappings/index.md new file mode 100644 index 0000000000..20d4cd80f4 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/base_path_mappings/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionThe ``AWS::ApiGateway::BasePathMapping`` resource creates a base path that clients who call your API must use in the invocation URL.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +domain_name, +base_path +FROM aws.apigateway.base_path_mappings +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the base_path_mappings resource, the following permissions are required: + +### Create +```json +apigateway:POST, +apigateway:GET +``` + +### List +```json +apigateway:GET +``` + diff --git a/docs/aws-docs/providers/aws/apigateway/client_certificate/index.md b/docs/aws-docs/providers/aws/apigateway/client_certificate/index.md new file mode 100644 index 0000000000..30c0b1aa55 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/client_certificate/index.md @@ -0,0 +1,94 @@ +--- +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
DescriptionThe ``AWS::ApiGateway::ClientCertificate`` resource creates a client certificate that API Gateway uses to configure client-side SSL authentication for sending requests to the integration endpoint.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +client_certificate_id, +description, +tags +FROM aws.apigateway.client_certificate +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the client_certificate resource, the following permissions are required: + +### Read +```json +apigateway:GET +``` + +### Update +```json +apigateway:GET, +apigateway:PATCH, +apigateway:PUT, +apigateway:DELETE +``` + +### Delete +```json +apigateway:DELETE +``` + diff --git a/docs/aws-docs/providers/aws/apigateway/client_certificates/index.md b/docs/aws-docs/providers/aws/apigateway/client_certificates/index.md new file mode 100644 index 0000000000..2af23d4401 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/client_certificates/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionThe ``AWS::ApiGateway::ClientCertificate`` resource creates a client certificate that API Gateway uses to configure client-side SSL authentication for sending requests to the integration endpoint.
Idaws.apigateway.client_certificates
+ +## Fields + + + + + +
NameDatatypeDescription
client_certificate_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +client_certificate_id +FROM aws.apigateway.client_certificates +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the client_certificates resource, the following permissions are required: + +### Create +```json +apigateway:POST, +apigateway:GET, +apigateway:PUT +``` + +### List +```json +apigateway:GET +``` + diff --git a/docs/aws-docs/providers/aws/apigateway/deployment/index.md b/docs/aws-docs/providers/aws/apigateway/deployment/index.md new file mode 100644 index 0000000000..3ff2e43440 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/deployment/index.md @@ -0,0 +1,101 @@ +--- +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
DescriptionThe ``AWS::ApiGateway::Deployment`` resource deploys an API Gateway ``RestApi`` resource to a stage so that clients can call the API over the internet. The stage acts as an environment.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +deployment_id, +deployment_canary_settings, +description, +rest_api_id, +stage_description, +stage_name +FROM aws.apigateway.deployment +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the deployment resource, the following permissions are required: + +### Read +```json +apigateway:GET +``` + +### Update +```json +apigateway:PATCH, +apigateway:GET, +apigateway:PUT, +apigateway:DELETE +``` + +### Delete +```json +apigateway:GET, +apigateway:DELETE +``` + diff --git a/docs/aws-docs/providers/aws/apigateway/deployments/index.md b/docs/aws-docs/providers/aws/apigateway/deployments/index.md new file mode 100644 index 0000000000..a68b43da38 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/deployments/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionThe ``AWS::ApiGateway::Deployment`` resource deploys an API Gateway ``RestApi`` resource to a stage so that clients can call the API over the internet. The stage acts as an environment.
Idaws.apigateway.deployments
+ +## Fields + + + + + + +
NameDatatypeDescription
deployment_idstring
rest_api_idstringThe string identifier of the associated RestApi.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +deployment_id, +rest_api_id +FROM aws.apigateway.deployments +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the deployments resource, the following permissions are required: + +### Create +```json +apigateway:POST, +apigateway:PATCH, +apigateway:PUT, +apigateway:GET +``` + +### List +```json +apigateway:GET +``` + diff --git a/docs/aws-docs/providers/aws/apigateway/documentation_part/index.md b/docs/aws-docs/providers/aws/apigateway/documentation_part/index.md new file mode 100644 index 0000000000..7af95860cf --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/documentation_part/index.md @@ -0,0 +1,94 @@ +--- +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
DescriptionThe ``AWS::ApiGateway::DocumentationPart`` resource creates a documentation part for an API. For more information, see [Representation of API Documentation in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api-content-representation.html) in the *API Gateway Developer Guide*.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +documentation_part_id, +location, +properties, +rest_api_id +FROM aws.apigateway.documentation_part +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the documentation_part resource, the following permissions are required: + +### Read +```json +apigateway:GET +``` + +### Update +```json +apigateway:GET, +apigateway:PATCH +``` + +### Delete +```json +apigateway:DELETE +``` + diff --git a/docs/aws-docs/providers/aws/apigateway/documentation_parts/index.md b/docs/aws-docs/providers/aws/apigateway/documentation_parts/index.md new file mode 100644 index 0000000000..1bc9ad5ff4 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/documentation_parts/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionThe ``AWS::ApiGateway::DocumentationPart`` resource creates a documentation part for an API. For more information, see [Representation of API Documentation in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api-content-representation.html) in the *API Gateway Developer Guide*.
Idaws.apigateway.documentation_parts
+ +## Fields + + + + + + +
NameDatatypeDescription
documentation_part_idstring
rest_api_idstringThe string identifier of the associated RestApi.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +documentation_part_id, +rest_api_id +FROM aws.apigateway.documentation_parts +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the documentation_parts resource, the following permissions are required: + +### Create +```json +apigateway:GET, +apigateway:POST +``` + +### List +```json +apigateway:GET +``` + diff --git a/docs/aws-docs/providers/aws/apigateway/documentation_version/index.md b/docs/aws-docs/providers/aws/apigateway/documentation_version/index.md new file mode 100644 index 0000000000..7f130a080e --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/documentation_version/index.md @@ -0,0 +1,92 @@ +--- +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
DescriptionThe ``AWS::ApiGateway::DocumentationVersion`` resource creates a snapshot of the documentation for an API. For more information, see [Representation of API Documentation in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api-content-representation.html) in the *API Gateway Developer Guide*.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +description, +documentation_version, +rest_api_id +FROM aws.apigateway.documentation_version +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the documentation_version resource, the following permissions are required: + +### Read +```json +apigateway:GET +``` + +### Update +```json +apigateway:GET, +apigateway:PATCH +``` + +### Delete +```json +apigateway:DELETE +``` + diff --git a/docs/aws-docs/providers/aws/apigateway/documentation_versions/index.md b/docs/aws-docs/providers/aws/apigateway/documentation_versions/index.md new file mode 100644 index 0000000000..5f4468d425 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/documentation_versions/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionThe ``AWS::ApiGateway::DocumentationVersion`` resource creates a snapshot of the documentation for an API. For more information, see [Representation of API Documentation in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api-content-representation.html) in the *API Gateway Developer Guide*.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +documentation_version, +rest_api_id +FROM aws.apigateway.documentation_versions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the documentation_versions resource, the following permissions are required: + +### Create +```json +apigateway:GET, +apigateway:POST +``` + +### List +```json +apigateway:GET +``` + diff --git a/docs/aws-docs/providers/aws/apigateway/domain_name/index.md b/docs/aws-docs/providers/aws/apigateway/domain_name/index.md new file mode 100644 index 0000000000..f82cc31d11 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/domain_name/index.md @@ -0,0 +1,109 @@ +--- +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
DescriptionResource Type definition for AWS::ApiGateway::DomainName.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.apigateway.domain_name +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the domain_name resource, the following permissions are required: + +### Read +```json +apigateway:* +``` + +### Update +```json +apigateway:* +``` + +### Delete +```json +apigateway:* +``` + diff --git a/docs/aws-docs/providers/aws/apigateway/domain_names/index.md b/docs/aws-docs/providers/aws/apigateway/domain_names/index.md new file mode 100644 index 0000000000..de3e1828fd --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/domain_names/index.md @@ -0,0 +1,77 @@ +--- +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
DescriptionResource Type definition for AWS::ApiGateway::DomainName.
Idaws.apigateway.domain_names
+ +## Fields + + + + + +
NameDatatypeDescription
domain_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +domain_name +FROM aws.apigateway.domain_names +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the domain_names resource, the following permissions are required: + +### Create +```json +apigateway:* +``` + +### List +```json +apigateway:* +``` + diff --git a/docs/aws-docs/providers/aws/apigateway/index.md b/docs/aws-docs/providers/aws/apigateway/index.md new file mode 100644 index 0000000000..d4b44c79d7 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/index.md @@ -0,0 +1,73 @@ +--- +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: 36
+total selectable resources: 36
+total methods: 36
+
+
+ +::: + +## 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 +
+
+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/aws-docs/providers/aws/apigateway/method/index.md b/docs/aws-docs/providers/aws/apigateway/method/index.md new file mode 100644 index 0000000000..483a1f35b6 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/method/index.md @@ -0,0 +1,114 @@ +--- +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
DescriptionThe ``AWS::ApiGateway::Method`` resource creates API Gateway methods that define the parameters and body that clients must send in their requests.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.apigateway.method +WHERE data__Identifier = '||'; +``` + +## Permissions + +To operate on the method resource, the following permissions are required: + +### Read +```json +apigateway:GET +``` + +### Update +```json +apigateway:GET, +apigateway:DELETE, +apigateway:PUT, +iam:PassRole +``` + +### Delete +```json +apigateway:DELETE +``` + diff --git a/docs/aws-docs/providers/aws/apigateway/methods/index.md b/docs/aws-docs/providers/aws/apigateway/methods/index.md new file mode 100644 index 0000000000..ca14dcffb1 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/methods/index.md @@ -0,0 +1,73 @@ +--- +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
DescriptionThe ``AWS::ApiGateway::Method`` resource creates API Gateway methods that define the parameters and body that clients must send in their requests.
Idaws.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 + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +rest_api_id, +resource_id, +http_method +FROM aws.apigateway.methods +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the methods resource, the following permissions are required: + +### Create +```json +apigateway:PUT, +apigateway:GET, +iam:PassRole +``` + diff --git a/docs/aws-docs/providers/aws/apigateway/model/index.md b/docs/aws-docs/providers/aws/apigateway/model/index.md new file mode 100644 index 0000000000..3cec2e70b6 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/model/index.md @@ -0,0 +1,97 @@ +--- +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
DescriptionThe ``AWS::ApiGateway::Model`` resource defines the structure of a request or response payload for an API method.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +content_type, +description, +name, +rest_api_id, +schema +FROM aws.apigateway.model +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the model resource, the following permissions are required: + +### Read +```json +apigateway:GET +``` + +### Update +```json +apigateway:PATCH, +apigateway:GET +``` + +### Delete +```json +apigateway:GET, +apigateway:DELETE +``` + diff --git a/docs/aws-docs/providers/aws/apigateway/models/index.md b/docs/aws-docs/providers/aws/apigateway/models/index.md new file mode 100644 index 0000000000..ee6efb22ce --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/models/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionThe ``AWS::ApiGateway::Model`` resource defines the structure of a request or response payload for an API method.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +rest_api_id, +name +FROM aws.apigateway.models +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the models resource, the following permissions are required: + +### Create +```json +apigateway:POST, +apigateway:GET +``` + +### List +```json +apigateway:GET +``` + diff --git a/docs/aws-docs/providers/aws/apigateway/request_validator/index.md b/docs/aws-docs/providers/aws/apigateway/request_validator/index.md new file mode 100644 index 0000000000..8b36982703 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/request_validator/index.md @@ -0,0 +1,96 @@ +--- +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
DescriptionThe ``AWS::ApiGateway::RequestValidator`` resource sets up basic validation rules for incoming requests to your API. For more information, see [Enable Basic Request Validation for an API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html) in the *API Gateway Developer Guide*.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +request_validator_id, +name, +rest_api_id, +validate_request_body, +validate_request_parameters +FROM aws.apigateway.request_validator +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the request_validator resource, the following permissions are required: + +### Update +```json +apigateway:PATCH, +apigateway:GET +``` + +### Delete +```json +apigateway:DELETE +``` + +### Read +```json +apigateway:GET +``` + diff --git a/docs/aws-docs/providers/aws/apigateway/request_validators/index.md b/docs/aws-docs/providers/aws/apigateway/request_validators/index.md new file mode 100644 index 0000000000..b6bdc473f8 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/request_validators/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionThe ``AWS::ApiGateway::RequestValidator`` resource sets up basic validation rules for incoming requests to your API. For more information, see [Enable Basic Request Validation for an API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html) in the *API Gateway Developer Guide*.
Idaws.apigateway.request_validators
+ +## Fields + + + + + + +
NameDatatypeDescription
rest_api_idstringThe string identifier of the associated RestApi.
request_validator_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +rest_api_id, +request_validator_id +FROM aws.apigateway.request_validators +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the request_validators resource, the following permissions are required: + +### Create +```json +apigateway:POST, +apigateway:GET +``` + +### List +```json +apigateway:GET +``` + diff --git a/docs/aws-docs/providers/aws/apigateway/resource/index.md b/docs/aws-docs/providers/aws/apigateway/resource/index.md new file mode 100644 index 0000000000..c8f4fde471 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/resource/index.md @@ -0,0 +1,94 @@ +--- +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
DescriptionThe ``AWS::ApiGateway::Resource`` resource creates a resource in an API.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +resource_id, +rest_api_id, +parent_id, +path_part +FROM aws.apigateway.resource +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the resource resource, the following permissions are required: + +### Read +```json +apigateway:GET +``` + +### Update +```json +apigateway:GET, +apigateway:PATCH +``` + +### Delete +```json +apigateway:DELETE +``` + diff --git a/docs/aws-docs/providers/aws/apigateway/resources/index.md b/docs/aws-docs/providers/aws/apigateway/resources/index.md new file mode 100644 index 0000000000..251933c469 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/resources/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionThe ``AWS::ApiGateway::Resource`` resource creates a resource in an API.
Idaws.apigateway.resources
+ +## Fields + + + + + + +
NameDatatypeDescription
rest_api_idstringThe string identifier of the associated RestApi.
resource_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +rest_api_id, +resource_id +FROM aws.apigateway.resources +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the resources resource, the following permissions are required: + +### Create +```json +apigateway:POST +``` + +### List +```json +apigateway:GET +``` + diff --git a/docs/aws-docs/providers/aws/apigateway/rest_api/index.md b/docs/aws-docs/providers/aws/apigateway/rest_api/index.md new file mode 100644 index 0000000000..aa140f1f4a --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/rest_api/index.md @@ -0,0 +1,125 @@ +--- +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
DescriptionThe ``AWS::ApiGateway::RestApi`` resource creates a REST API. For more information, see [restapi:create](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateRestApi.html) in the *Amazon API Gateway REST API Reference*.<br/> On January 1, 2016, the Swagger Specification was donated to the [OpenAPI initiative](https://docs.aws.amazon.com/https://www.openapis.org/), becoming the foundation of the OpenAPI Specification.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.apigateway.rest_api +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the rest_api resource, the following permissions are required: + +### Read +```json +apigateway:GET +``` + +### Update +```json +apigateway:GET, +apigateway:DELETE, +apigateway:PATCH, +apigateway:PUT, +apigateway:UpdateRestApiPolicy, +s3:GetObject, +iam:PassRole +``` + +### Delete +```json +apigateway:DELETE +``` + diff --git a/docs/aws-docs/providers/aws/apigateway/rest_apis/index.md b/docs/aws-docs/providers/aws/apigateway/rest_apis/index.md new file mode 100644 index 0000000000..81853944bd --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/rest_apis/index.md @@ -0,0 +1,83 @@ +--- +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
DescriptionThe ``AWS::ApiGateway::RestApi`` resource creates a REST API. For more information, see [restapi:create](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateRestApi.html) in the *Amazon API Gateway REST API Reference*.<br/> On January 1, 2016, the Swagger Specification was donated to the [OpenAPI initiative](https://docs.aws.amazon.com/https://www.openapis.org/), becoming the foundation of the OpenAPI Specification.
Idaws.apigateway.rest_apis
+ +## Fields + + + + + +
NameDatatypeDescription
rest_api_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +rest_api_id +FROM aws.apigateway.rest_apis +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the rest_apis resource, the following permissions are required: + +### Create +```json +apigateway:GET, +apigateway:POST, +apigateway:PUT, +apigateway:PATCH, +apigateway:UpdateRestApiPolicy, +s3:GetObject, +iam:PassRole +``` + +### List +```json +apigateway:GET +``` + diff --git a/docs/aws-docs/providers/aws/apigateway/stage/index.md b/docs/aws-docs/providers/aws/apigateway/stage/index.md new file mode 100644 index 0000000000..b8854ceb00 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/stage/index.md @@ -0,0 +1,116 @@ +--- +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
DescriptionThe ``AWS::ApiGateway::Stage`` resource creates a stage for a deployment.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.apigateway.stage +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the stage resource, the following permissions are required: + +### Read +```json +apigateway:GET +``` + +### Update +```json +apigateway:GET, +apigateway:PATCH, +apigateway:PUT, +apigateway:DELETE +``` + +### Delete +```json +apigateway:DELETE +``` + diff --git a/docs/aws-docs/providers/aws/apigateway/stages/index.md b/docs/aws-docs/providers/aws/apigateway/stages/index.md new file mode 100644 index 0000000000..a33690e302 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/stages/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionThe ``AWS::ApiGateway::Stage`` resource creates a stage for a deployment.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +rest_api_id, +stage_name +FROM aws.apigateway.stages +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the stages resource, the following permissions are required: + +### Create +```json +apigateway:POST, +apigateway:PATCH, +apigateway:GET, +apigateway:PUT +``` + +### List +```json +apigateway:GET +``` + diff --git a/docs/aws-docs/providers/aws/apigateway/usage_plan/index.md b/docs/aws-docs/providers/aws/apigateway/usage_plan/index.md new file mode 100644 index 0000000000..bb572ea9e8 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/usage_plan/index.md @@ -0,0 +1,104 @@ +--- +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
DescriptionThe ``AWS::ApiGateway::UsagePlan`` resource creates a usage plan for deployed APIs. A usage plan sets a target for the throttling and quota limits on individual client API keys. For more information, see [Creating and Using API Usage Plans in Amazon API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html) in the *API Gateway Developer Guide*.<br/> In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using [](https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html) to monitor costs and [](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) to manage API requests.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +api_stages, +description, +quota, +tags, +throttle, +usage_plan_name +FROM aws.apigateway.usage_plan +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the usage_plan resource, the following permissions are required: + +### Read +```json +apigateway:GET +``` + +### Update +```json +apigateway:GET, +apigateway:DELETE, +apigateway:PATCH, +apigateway:PUT +``` + +### Delete +```json +apigateway:DELETE, +apigateway:GET, +apigateway:PATCH +``` + diff --git a/docs/aws-docs/providers/aws/apigateway/usage_plan_key/index.md b/docs/aws-docs/providers/aws/apigateway/usage_plan_key/index.md new file mode 100644 index 0000000000..20ed2ded58 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/usage_plan_key/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionThe ``AWS::ApiGateway::UsagePlanKey`` resource associates an API key with a usage plan. This association determines which users the usage plan is applied to.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +key_id, +key_type, +usage_plan_id, +id +FROM aws.apigateway.usage_plan_key +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the usage_plan_key resource, the following permissions are required: + +### Read +```json +apigateway:GET +``` + +### Delete +```json +apigateway:DELETE, +apigateway:GET +``` + diff --git a/docs/aws-docs/providers/aws/apigateway/usage_plan_keys/index.md b/docs/aws-docs/providers/aws/apigateway/usage_plan_keys/index.md new file mode 100644 index 0000000000..f114e88f43 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/usage_plan_keys/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionThe ``AWS::ApiGateway::UsagePlanKey`` resource associates an API key with a usage plan. This association determines which users the usage plan is applied to.
Idaws.apigateway.usage_plan_keys
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.apigateway.usage_plan_keys +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the usage_plan_keys resource, the following permissions are required: + +### Create +```json +apigateway:POST, +apigateway:GET +``` + +### List +```json +apigateway:GET +``` + diff --git a/docs/aws-docs/providers/aws/apigateway/usage_plans/index.md b/docs/aws-docs/providers/aws/apigateway/usage_plans/index.md new file mode 100644 index 0000000000..152f931533 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/usage_plans/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionThe ``AWS::ApiGateway::UsagePlan`` resource creates a usage plan for deployed APIs. A usage plan sets a target for the throttling and quota limits on individual client API keys. For more information, see [Creating and Using API Usage Plans in Amazon API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html) in the *API Gateway Developer Guide*.<br/> In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using [](https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html) to monitor costs and [](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) to manage API requests.
Idaws.apigateway.usage_plans
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.apigateway.usage_plans +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the usage_plans resource, the following permissions are required: + +### Create +```json +apigateway:POST, +apigateway:GET, +apigateway:PUT +``` + +### List +```json +apigateway:GET +``` + diff --git a/docs/aws-docs/providers/aws/apigateway/vpc_link/index.md b/docs/aws-docs/providers/aws/apigateway/vpc_link/index.md new file mode 100644 index 0000000000..d1e782a672 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/vpc_link/index.md @@ -0,0 +1,111 @@ +--- +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
DescriptionSchema for AWS ApiGateway VpcLink
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +description, +tags, +target_arns, +vpc_link_id +FROM aws.apigateway.vpc_link +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the vpc_link resource, the following permissions are required: + +### Update +```json +apigateway:PATCH, +apigateway:GET, +apigateway:PUT, +ec2:CreateVpcEndpointServiceConfiguration, +ec2:DeleteVpcEndpointServiceConfigurations, +ec2:DescribeVpcEndpointServiceConfigurations, +ec2:ModifyVpcEndpointServicePermissions +``` + +### Read +```json +apigateway:GET, +ec2:CreateVpcEndpointServiceConfiguration, +ec2:DeleteVpcEndpointServiceConfigurations, +ec2:DescribeVpcEndpointServiceConfigurations, +ec2:ModifyVpcEndpointServicePermissions +``` + +### Delete +```json +apigateway:GET, +apigateway:DELETE, +apigateway:PUT, +ec2:CreateVpcEndpointServiceConfiguration, +ec2:DeleteVpcEndpointServiceConfigurations, +ec2:DescribeVpcEndpointServiceConfigurations, +ec2:ModifyVpcEndpointServicePermissions +``` + diff --git a/docs/aws-docs/providers/aws/apigateway/vpc_links/index.md b/docs/aws-docs/providers/aws/apigateway/vpc_links/index.md new file mode 100644 index 0000000000..973685c153 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigateway/vpc_links/index.md @@ -0,0 +1,87 @@ +--- +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
DescriptionSchema for AWS ApiGateway VpcLink
Idaws.apigateway.vpc_links
+ +## Fields + + + + + +
NameDatatypeDescription
vpc_link_idstringThe ID of the instance that backs VPC link.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +vpc_link_id +FROM aws.apigateway.vpc_links +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the vpc_links resource, the following permissions are required: + +### Create +```json +apigateway:POST, +apigateway:PUT, +apigateway:GET, +ec2:CreateVpcEndpointServiceConfiguration, +ec2:DeleteVpcEndpointServiceConfigurations, +ec2:DescribeVpcEndpointServiceConfigurations, +ec2:ModifyVpcEndpointServicePermissions +``` + +### List +```json +apigateway:GET, +ec2:CreateVpcEndpointServiceConfiguration, +ec2:DeleteVpcEndpointServiceConfigurations, +ec2:DescribeVpcEndpointServiceConfigurations, +ec2:ModifyVpcEndpointServicePermissions +``` + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/api/index.md b/docs/aws-docs/providers/aws/apigatewayv2/api/index.md new file mode 100644 index 0000000000..26b8aabf56 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigatewayv2/api/index.md @@ -0,0 +1,130 @@ +--- +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
DescriptionThe ``AWS::ApiGatewayV2::Api`` resource creates an API. WebSocket APIs and HTTP APIs are supported. For more information about WebSocket APIs, see [About WebSocket APIs in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-overview.html) in the *API Gateway Developer Guide*. For more information about HTTP APIs, see [HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api.html) in the *API Gateway Developer Guide.*
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.apigatewayv2.api +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the api resource, the following permissions are required: + +### Update +```json +apigateway:PATCH, +apigateway:GET, +apigateway:PUT, +apigateway:POST, +s3:getObject +``` + +### Read +```json +apigateway:GET, +s3:getObject +``` + +### Delete +```json +apigateway:GET, +apigateway:DELETE, +s3:getObject +``` + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/api_mapping/index.md b/docs/aws-docs/providers/aws/apigatewayv2/api_mapping/index.md new file mode 100644 index 0000000000..8970d72fc6 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigatewayv2/api_mapping/index.md @@ -0,0 +1,97 @@ +--- +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
DescriptionThe ``AWS::ApiGatewayV2::ApiMapping`` resource contains an API mapping. An API mapping relates a path of your custom domain name to a stage of your API. A custom domain name can have multiple API mappings, but the paths can't overlap. A custom domain can map only to APIs of the same protocol type. For more information, see [CreateApiMapping](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/domainnames-domainname-apimappings.html#CreateApiMapping) in the *Amazon API Gateway V2 API Reference*.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +api_mapping_id, +domain_name, +stage, +api_mapping_key, +api_id +FROM aws.apigatewayv2.api_mapping +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the api_mapping resource, the following permissions are required: + +### Update +```json +apigateway:PATCH, +apigateway:GET, +apigateway:PUT +``` + +### Read +```json +apigateway:GET +``` + +### Delete +```json +apigateway:DELETE +``` + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/api_mappings/index.md b/docs/aws-docs/providers/aws/apigatewayv2/api_mappings/index.md new file mode 100644 index 0000000000..c038016460 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigatewayv2/api_mappings/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionThe ``AWS::ApiGatewayV2::ApiMapping`` resource contains an API mapping. An API mapping relates a path of your custom domain name to a stage of your API. A custom domain name can have multiple API mappings, but the paths can't overlap. A custom domain can map only to APIs of the same protocol type. For more information, see [CreateApiMapping](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/domainnames-domainname-apimappings.html#CreateApiMapping) in the *Amazon API Gateway V2 API Reference*.
Idaws.apigatewayv2.api_mappings
+ +## Fields + + + + + + +
NameDatatypeDescription
api_mapping_idstring
domain_namestringThe domain name.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +api_mapping_id, +domain_name +FROM aws.apigatewayv2.api_mappings +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the api_mappings resource, the following permissions are required: + +### Create +```json +apigateway:POST +``` + +### List +```json +apigateway:GET +``` + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/apis/index.md b/docs/aws-docs/providers/aws/apigatewayv2/apis/index.md new file mode 100644 index 0000000000..fe3c166bed --- /dev/null +++ b/docs/aws-docs/providers/aws/apigatewayv2/apis/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionThe ``AWS::ApiGatewayV2::Api`` resource creates an API. WebSocket APIs and HTTP APIs are supported. For more information about WebSocket APIs, see [About WebSocket APIs in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-overview.html) in the *API Gateway Developer Guide*. For more information about HTTP APIs, see [HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api.html) in the *API Gateway Developer Guide.*
Idaws.apigatewayv2.apis
+ +## Fields + + + + + +
NameDatatypeDescription
api_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +api_id +FROM aws.apigatewayv2.apis +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the apis resource, the following permissions are required: + +### Create +```json +apigateway:POST, +apigateway:PUT, +s3:getObject +``` + +### List +```json +apigateway:GET, +s3:getObject +``` + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/authorizer/index.md b/docs/aws-docs/providers/aws/apigatewayv2/authorizer/index.md new file mode 100644 index 0000000000..54497b8811 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigatewayv2/authorizer/index.md @@ -0,0 +1,113 @@ +--- +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
DescriptionThe ``AWS::ApiGatewayV2::Authorizer`` resource creates an authorizer for a WebSocket API or an HTTP API. To learn more, see [Controlling and managing access to a WebSocket API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-control-access.html) and [Controlling and managing access to an HTTP API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-access-control.html) in the *API Gateway Developer Guide*.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.apigatewayv2.authorizer +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the authorizer resource, the following permissions are required: + +### Update +```json +apigateway:PATCH, +apigateway:GET, +apigateway:PUT, +iam:PassRole +``` + +### Read +```json +apigateway:GET +``` + +### Delete +```json +apigateway:GET, +apigateway:DELETE +``` + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/authorizers/index.md b/docs/aws-docs/providers/aws/apigatewayv2/authorizers/index.md new file mode 100644 index 0000000000..172c7f5c4f --- /dev/null +++ b/docs/aws-docs/providers/aws/apigatewayv2/authorizers/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionThe ``AWS::ApiGatewayV2::Authorizer`` resource creates an authorizer for a WebSocket API or an HTTP API. To learn more, see [Controlling and managing access to a WebSocket API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-control-access.html) and [Controlling and managing access to an HTTP API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-access-control.html) in the *API Gateway Developer Guide*.
Idaws.apigatewayv2.authorizers
+ +## Fields + + + + + + +
NameDatatypeDescription
authorizer_idstring
api_idstringThe API identifier.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +authorizer_id, +api_id +FROM aws.apigatewayv2.authorizers +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the authorizers resource, the following permissions are required: + +### Create +```json +apigateway:POST, +iam:PassRole +``` + +### List +```json +apigateway:GET +``` + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/deployment/index.md b/docs/aws-docs/providers/aws/apigatewayv2/deployment/index.md new file mode 100644 index 0000000000..9371cb85bf --- /dev/null +++ b/docs/aws-docs/providers/aws/apigatewayv2/deployment/index.md @@ -0,0 +1,96 @@ +--- +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
DescriptionThe ``AWS::ApiGatewayV2::Deployment`` resource creates a deployment for an API.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +deployment_id, +description, +stage_name, +api_id +FROM aws.apigatewayv2.deployment +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the deployment resource, the following permissions are required: + +### Update +```json +apigateway:PATCH, +apigateway:GET, +apigateway:PUT +``` + +### Read +```json +apigateway:GET +``` + +### Delete +```json +apigateway:GET, +apigateway:DELETE +``` + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/deployments/index.md b/docs/aws-docs/providers/aws/apigatewayv2/deployments/index.md new file mode 100644 index 0000000000..22975cf120 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigatewayv2/deployments/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionThe ``AWS::ApiGatewayV2::Deployment`` resource creates a deployment for an API.
Idaws.apigatewayv2.deployments
+ +## Fields + + + + + + +
NameDatatypeDescription
api_idstringThe API identifier.
deployment_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +api_id, +deployment_id +FROM aws.apigatewayv2.deployments +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the deployments resource, the following permissions are required: + +### Create +```json +apigateway:POST +``` + +### List +```json +apigateway:GET +``` + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/domain_name/index.md b/docs/aws-docs/providers/aws/apigatewayv2/domain_name/index.md new file mode 100644 index 0000000000..ca05c744e2 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigatewayv2/domain_name/index.md @@ -0,0 +1,100 @@ +--- +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
DescriptionThe ``AWS::ApiGatewayV2::DomainName`` resource specifies a custom domain name for your API in Amazon API Gateway (API Gateway). <br/> You can use a custom domain name to provide a URL that's more intuitive and easier to recall. For more information about using custom domain names, see [Set up Custom Domain Name for an API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html) in the *API Gateway Developer Guide*.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +mutual_tls_authentication, +regional_hosted_zone_id, +regional_domain_name, +domain_name, +domain_name_configurations, +tags +FROM aws.apigatewayv2.domain_name +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the domain_name resource, the following permissions are required: + +### Update +```json +apigateway:PATCH, +apigateway:GET, +apigateway:PUT +``` + +### Read +```json +apigateway:GET +``` + +### Delete +```json +apigateway:GET, +apigateway:DELETE +``` + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/domain_names/index.md b/docs/aws-docs/providers/aws/apigatewayv2/domain_names/index.md new file mode 100644 index 0000000000..6d90ab7c94 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigatewayv2/domain_names/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionThe ``AWS::ApiGatewayV2::DomainName`` resource specifies a custom domain name for your API in Amazon API Gateway (API Gateway). <br/> You can use a custom domain name to provide a URL that's more intuitive and easier to recall. For more information about using custom domain names, see [Set up Custom Domain Name for an API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html) in the *API Gateway Developer Guide*.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +domain_name +FROM aws.apigatewayv2.domain_names +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the domain_names resource, the following permissions are required: + +### Create +```json +apigateway:POST, +apigateway:GET, +apigateway:PUT +``` + +### List +```json +apigateway:GET +``` + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/index.md b/docs/aws-docs/providers/aws/apigatewayv2/index.md new file mode 100644 index 0000000000..8dc6a7be24 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/apigatewayv2/integration_response/index.md b/docs/aws-docs/providers/aws/apigatewayv2/integration_response/index.md new file mode 100644 index 0000000000..c53ee4d8b0 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigatewayv2/integration_response/index.md @@ -0,0 +1,104 @@ +--- +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
DescriptionThe ``AWS::ApiGatewayV2::IntegrationResponse`` resource updates an integration response for an WebSocket API. For more information, see [Set up WebSocket API Integration Responses in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integration-responses.html) in the *API Gateway Developer Guide*.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.apigatewayv2.integration_response +WHERE data__Identifier = '||'; +``` + +## Permissions + +To operate on the integration_response resource, the following permissions are required: + +### Read +```json +apigateway:GET +``` + +### Update +```json +apigateway:PATCH, +apigateway:PUT, +apigateway:GET +``` + +### Delete +```json +apigateway:GET, +apigateway:DELETE +``` + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/integration_responses/index.md b/docs/aws-docs/providers/aws/apigatewayv2/integration_responses/index.md new file mode 100644 index 0000000000..09333edeac --- /dev/null +++ b/docs/aws-docs/providers/aws/apigatewayv2/integration_responses/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionThe ``AWS::ApiGatewayV2::IntegrationResponse`` resource updates an integration response for an WebSocket API. For more information, see [Set up WebSocket API Integration Responses in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integration-responses.html) in the *API Gateway Developer Guide*.
Idaws.apigatewayv2.integration_responses
+ +## Fields + + + + + + + +
NameDatatypeDescription
api_idstringThe API identifier.
integration_idstringThe integration ID.
integration_response_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +api_id, +integration_id, +integration_response_id +FROM aws.apigatewayv2.integration_responses +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the integration_responses resource, the following permissions are required: + +### Create +```json +apigateway:POST +``` + +### List +```json +apigateway:GET +``` + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/model/index.md b/docs/aws-docs/providers/aws/apigatewayv2/model/index.md new file mode 100644 index 0000000000..d8fb9975aa --- /dev/null +++ b/docs/aws-docs/providers/aws/apigatewayv2/model/index.md @@ -0,0 +1,100 @@ +--- +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
DescriptionThe ``AWS::ApiGatewayV2::Model`` resource updates data model for a WebSocket API. For more information, see [Model Selection Expressions](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-model-selection-expressions) in the *API Gateway Developer Guide*.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +model_id, +description, +content_type, +schema, +api_id, +name +FROM aws.apigatewayv2.model +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the model resource, the following permissions are required: + +### Update +```json +apigateway:PATCH, +apigateway:GET, +apigateway:PUT +``` + +### Read +```json +apigateway:GET +``` + +### Delete +```json +apigateway:GET, +apigateway:DELETE +``` + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/models/index.md b/docs/aws-docs/providers/aws/apigatewayv2/models/index.md new file mode 100644 index 0000000000..c9808632d3 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigatewayv2/models/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionThe ``AWS::ApiGatewayV2::Model`` resource updates data model for a WebSocket API. For more information, see [Model Selection Expressions](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-model-selection-expressions) in the *API Gateway Developer Guide*.
Idaws.apigatewayv2.models
+ +## Fields + + + + + + +
NameDatatypeDescription
api_idstringThe API identifier.
model_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +api_id, +model_id +FROM aws.apigatewayv2.models +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the models resource, the following permissions are required: + +### Create +```json +apigateway:POST +``` + +### List +```json +apigateway:GET +``` + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/route/index.md b/docs/aws-docs/providers/aws/apigatewayv2/route/index.md new file mode 100644 index 0000000000..0615846184 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigatewayv2/route/index.md @@ -0,0 +1,114 @@ +--- +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
DescriptionThe ``AWS::ApiGatewayV2::Route`` resource creates a route for an API.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.apigatewayv2.route +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the route resource, the following permissions are required: + +### Update +```json +apigateway:PATCH, +apigateway:GET, +apigateway:PUT +``` + +### Read +```json +apigateway:GET +``` + +### Delete +```json +apigateway:GET, +apigateway:DELETE +``` + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/route_response/index.md b/docs/aws-docs/providers/aws/apigatewayv2/route_response/index.md new file mode 100644 index 0000000000..fca6858cab --- /dev/null +++ b/docs/aws-docs/providers/aws/apigatewayv2/route_response/index.md @@ -0,0 +1,102 @@ +--- +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
DescriptionThe ``AWS::ApiGatewayV2::RouteResponse`` resource creates a route response for a WebSocket API. For more information, see [Set up Route Responses for a WebSocket API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-route-response.html) in the *API Gateway Developer Guide*.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +route_response_key, +response_parameters, +route_id, +model_selection_expression, +api_id, +response_models, +route_response_id +FROM aws.apigatewayv2.route_response +WHERE data__Identifier = '||'; +``` + +## Permissions + +To operate on the route_response resource, the following permissions are required: + +### Update +```json +apigateway:PATCH, +apigateway:GET, +apigateway:PUT +``` + +### Read +```json +apigateway:GET +``` + +### Delete +```json +apigateway:GET, +apigateway:DELETE +``` + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/route_responses/index.md b/docs/aws-docs/providers/aws/apigatewayv2/route_responses/index.md new file mode 100644 index 0000000000..8378e88764 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigatewayv2/route_responses/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionThe ``AWS::ApiGatewayV2::RouteResponse`` resource creates a route response for a WebSocket API. For more information, see [Set up Route Responses for a WebSocket API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-route-response.html) in the *API Gateway Developer Guide*.
Idaws.apigatewayv2.route_responses
+ +## Fields + + + + + + + +
NameDatatypeDescription
api_idstringThe API identifier.
route_idstringThe route ID.
route_response_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +api_id, +route_id, +route_response_id +FROM aws.apigatewayv2.route_responses +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the route_responses resource, the following permissions are required: + +### Create +```json +apigateway:POST +``` + +### List +```json +apigateway:GET +``` + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/routes/index.md b/docs/aws-docs/providers/aws/apigatewayv2/routes/index.md new file mode 100644 index 0000000000..4342c5ead6 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigatewayv2/routes/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionThe ``AWS::ApiGatewayV2::Route`` resource creates a route for an API.
Idaws.apigatewayv2.routes
+ +## Fields + + + + + + +
NameDatatypeDescription
api_idstringThe API identifier.
route_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +api_id, +route_id +FROM aws.apigatewayv2.routes +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the routes resource, the following permissions are required: + +### Create +```json +apigateway:POST +``` + +### List +```json +apigateway:GET +``` + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/vpc_link/index.md b/docs/aws-docs/providers/aws/apigatewayv2/vpc_link/index.md new file mode 100644 index 0000000000..893fcfacea --- /dev/null +++ b/docs/aws-docs/providers/aws/apigatewayv2/vpc_link/index.md @@ -0,0 +1,108 @@ +--- +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
DescriptionThe ``AWS::ApiGatewayV2::VpcLink`` resource creates a VPC link. Supported only for HTTP APIs. The VPC link status must transition from ``PENDING`` to ``AVAILABLE`` to successfully create a VPC link, which can take up to 10 minutes. To learn more, see [Working with VPC Links for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-vpc-links.html) in the *API Gateway Developer Guide*.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +vpc_link_id, +subnet_ids, +security_group_ids, +tags, +name +FROM aws.apigatewayv2.vpc_link +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the vpc_link resource, the following permissions are required: + +### Update +```json +apigateway:PATCH, +apigateway:GET, +apigateway:TagResource, +apigateway:unTagResource, +iam:CreateServiceLinkedRole, +iam:DeleteServiceLinkedRole, +iam:GetServiceLinkedRoleDeletionStatus +``` + +### Read +```json +apigateway:GET, +iam:CreateServiceLinkedRole, +iam:DeleteServiceLinkedRole, +iam:GetServiceLinkedRoleDeletionStatus +``` + +### Delete +```json +apigateway:GET, +apigateway:DELETE, +iam:CreateServiceLinkedRole, +iam:DeleteServiceLinkedRole, +iam:GetServiceLinkedRoleDeletionStatus +``` + diff --git a/docs/aws-docs/providers/aws/apigatewayv2/vpc_links/index.md b/docs/aws-docs/providers/aws/apigatewayv2/vpc_links/index.md new file mode 100644 index 0000000000..109971e404 --- /dev/null +++ b/docs/aws-docs/providers/aws/apigatewayv2/vpc_links/index.md @@ -0,0 +1,85 @@ +--- +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
DescriptionThe ``AWS::ApiGatewayV2::VpcLink`` resource creates a VPC link. Supported only for HTTP APIs. The VPC link status must transition from ``PENDING`` to ``AVAILABLE`` to successfully create a VPC link, which can take up to 10 minutes. To learn more, see [Working with VPC Links for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-vpc-links.html) in the *API Gateway Developer Guide*.
Idaws.apigatewayv2.vpc_links
+ +## Fields + + + + + +
NameDatatypeDescription
vpc_link_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +vpc_link_id +FROM aws.apigatewayv2.vpc_links +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the vpc_links resource, the following permissions are required: + +### Create +```json +apigateway:POST, +apigateway:GET, +apigateway:TagResource, +iam:CreateServiceLinkedRole, +iam:DeleteServiceLinkedRole, +iam:GetServiceLinkedRoleDeletionStatus +``` + +### List +```json +apigateway:GET, +iam:CreateServiceLinkedRole, +iam:DeleteServiceLinkedRole, +iam:GetServiceLinkedRoleDeletionStatus +``` + diff --git a/docs/aws-docs/providers/aws/appconfig/application/index.md b/docs/aws-docs/providers/aws/appconfig/application/index.md new file mode 100644 index 0000000000..9a60cdc013 --- /dev/null +++ b/docs/aws-docs/providers/aws/appconfig/application/index.md @@ -0,0 +1,97 @@ +--- +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
DescriptionResource Type definition for AWS::AppConfig::Application
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +description, +application_id, +tags, +name +FROM aws.appconfig.application +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the application resource, the following permissions are required: + +### Read +```json +appconfig:GetApplication, +appconfig:ListTagsForResource +``` + +### Update +```json +appconfig:UpdateApplication, +appconfig:TagResource, +appconfig:UntagResource +``` + +### Delete +```json +appconfig:GetApplication, +appconfig:DeleteApplication +``` + diff --git a/docs/aws-docs/providers/aws/appconfig/applications/index.md b/docs/aws-docs/providers/aws/appconfig/applications/index.md new file mode 100644 index 0000000000..24dd9b289b --- /dev/null +++ b/docs/aws-docs/providers/aws/appconfig/applications/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionResource Type definition for AWS::AppConfig::Application
Idaws.appconfig.applications
+ +## Fields + + + + + +
NameDatatypeDescription
application_idstringThe application Id
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +application_id +FROM aws.appconfig.applications +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the applications resource, the following permissions are required: + +### Create +```json +appconfig:CreateApplication, +appconfig:GetApplication, +appconfig:ListTagsForResource, +appconfig:TagResource +``` + +### List +```json +appconfig:ListApplications +``` + diff --git a/docs/aws-docs/providers/aws/appconfig/configuration_profile/index.md b/docs/aws-docs/providers/aws/appconfig/configuration_profile/index.md new file mode 100644 index 0000000000..7ef99ff304 --- /dev/null +++ b/docs/aws-docs/providers/aws/appconfig/configuration_profile/index.md @@ -0,0 +1,111 @@ +--- +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
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Idaws.appconfig.configuration_profile
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
configuration_profile_idstringThe configuration profile ID
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
kms_key_identifierstringThe AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.
descriptionstringA description of the configuration profile.
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.
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.
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.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +configuration_profile_id, +location_uri, +type, +kms_key_identifier, +description, +kms_key_arn, +validators, +retrieval_role_arn, +application_id, +tags, +name +FROM aws.appconfig.configuration_profile +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the configuration_profile resource, the following permissions are required: + +### Read +```json +appconfig:GetConfigurationProfile, +appconfig:ListTagsForResource +``` + +### Update +```json +appconfig:UpdateConfigurationProfile, +appconfig:TagResource, +appconfig:UntagResource, +iam:PassRole +``` + +### Delete +```json +appconfig:DeleteConfigurationProfile +``` + diff --git a/docs/aws-docs/providers/aws/appconfig/configuration_profiles/index.md b/docs/aws-docs/providers/aws/appconfig/configuration_profiles/index.md new file mode 100644 index 0000000000..69a4c9fb4e --- /dev/null +++ b/docs/aws-docs/providers/aws/appconfig/configuration_profiles/index.md @@ -0,0 +1,83 @@ +--- +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
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Idaws.appconfig.configuration_profiles
+ +## Fields + + + + + + +
NameDatatypeDescription
application_idstringThe application ID.
configuration_profile_idstringThe configuration profile ID
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +application_id, +configuration_profile_id +FROM aws.appconfig.configuration_profiles +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the configuration_profiles resource, the following permissions are required: + +### Create +```json +appconfig:CreateConfigurationProfile, +appconfig:GetConfigurationProfile, +appconfig:TagResource, +appconfig:ListTagsForResource, +iam:PassRole +``` + +### List +```json +appconfig:ListConfigurationProfiles +``` + diff --git a/docs/aws-docs/providers/aws/appconfig/environment/index.md b/docs/aws-docs/providers/aws/appconfig/environment/index.md new file mode 100644 index 0000000000..e87ea1622b --- /dev/null +++ b/docs/aws-docs/providers/aws/appconfig/environment/index.md @@ -0,0 +1,102 @@ +--- +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
DescriptionResource Type definition for AWS::AppConfig::Environment
Idaws.appconfig.environment
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
environment_idstringThe environment ID.
descriptionstringA description of the environment.
monitorsarrayAmazon CloudWatch alarms to monitor during the deployment process.
application_idstringThe application ID.
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.
namestringA name for the environment.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +environment_id, +description, +monitors, +application_id, +tags, +name +FROM aws.appconfig.environment +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the environment resource, the following permissions are required: + +### Read +```json +appconfig:GetEnvironment, +appconfig:ListTagsForResource +``` + +### Update +```json +appconfig:UpdateEnvironment, +appconfig:TagResource, +appconfig:UntagResource, +iam:PassRole +``` + +### Delete +```json +appconfig:GetEnvironment, +appconfig:DeleteEnvironment +``` + diff --git a/docs/aws-docs/providers/aws/appconfig/environments/index.md b/docs/aws-docs/providers/aws/appconfig/environments/index.md new file mode 100644 index 0000000000..b4c1c094f4 --- /dev/null +++ b/docs/aws-docs/providers/aws/appconfig/environments/index.md @@ -0,0 +1,83 @@ +--- +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
DescriptionResource Type definition for AWS::AppConfig::Environment
Idaws.appconfig.environments
+ +## Fields + + + + + + +
NameDatatypeDescription
application_idstringThe application ID.
environment_idstringThe environment ID.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +application_id, +environment_id +FROM aws.appconfig.environments +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the environments resource, the following permissions are required: + +### Create +```json +appconfig:CreateEnvironment, +appconfig:GetEnvironment, +appconfig:ListTagsForResource, +appconfig:TagResource, +iam:PassRole +``` + +### List +```json +appconfig:ListEnvironments +``` + diff --git a/docs/aws-docs/providers/aws/appconfig/extension/index.md b/docs/aws-docs/providers/aws/appconfig/extension/index.md new file mode 100644 index 0000000000..16e8baf11c --- /dev/null +++ b/docs/aws-docs/providers/aws/appconfig/extension/index.md @@ -0,0 +1,106 @@ +--- +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
DescriptionResource Type definition for AWS::AppConfig::Extension
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +arn, +version_number, +name, +description, +actions, +parameters, +latest_version_number, +tags +FROM aws.appconfig.extension +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the extension resource, the following permissions are required: + +### Read +```json +appconfig:GetExtension +``` + +### Update +```json +appconfig:UpdateExtension, +appconfig:TagResource, +appconfig:UntagResource +``` + +### Delete +```json +appconfig:DeleteExtension, +appconfig:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/appconfig/extension_association/index.md b/docs/aws-docs/providers/aws/appconfig/extension_association/index.md new file mode 100644 index 0000000000..c62fc97e19 --- /dev/null +++ b/docs/aws-docs/providers/aws/appconfig/extension_association/index.md @@ -0,0 +1,106 @@ +--- +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
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +arn, +extension_arn, +resource_arn, +extension_identifier, +resource_identifier, +extension_version_number, +parameters, +tags +FROM aws.appconfig.extension_association +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the extension_association resource, the following permissions are required: + +### Read +```json +appconfig:GetExtensionAssociation +``` + +### Update +```json +appconfig:UpdateExtensionAssociation, +appconfig:TagResource, +appconfig:UntagResource +``` + +### Delete +```json +appconfig:DeleteExtensionAssociation, +appconfig:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/appconfig/extension_associations/index.md b/docs/aws-docs/providers/aws/appconfig/extension_associations/index.md new file mode 100644 index 0000000000..bb1716cefb --- /dev/null +++ b/docs/aws-docs/providers/aws/appconfig/extension_associations/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Idaws.appconfig.extension_associations
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.appconfig.extension_associations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the extension_associations resource, the following permissions are required: + +### Create +```json +appconfig:CreateExtensionAssociation, +appconfig:TagResource +``` + +### List +```json +appconfig:ListExtensionAssociations +``` + diff --git a/docs/aws-docs/providers/aws/appconfig/extensions/index.md b/docs/aws-docs/providers/aws/appconfig/extensions/index.md new file mode 100644 index 0000000000..a9e43d971a --- /dev/null +++ b/docs/aws-docs/providers/aws/appconfig/extensions/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource Type definition for AWS::AppConfig::Extension
Idaws.appconfig.extensions
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.appconfig.extensions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the extensions resource, the following permissions are required: + +### Create +```json +appconfig:CreateExtension, +appconfig:TagResource, +iam:PassRole +``` + +### List +```json +appconfig:ListExtensions +``` + diff --git a/docs/aws-docs/providers/aws/appconfig/hosted_configuration_version/index.md b/docs/aws-docs/providers/aws/appconfig/hosted_configuration_version/index.md new file mode 100644 index 0000000000..e2944fffea --- /dev/null +++ b/docs/aws-docs/providers/aws/appconfig/hosted_configuration_version/index.md @@ -0,0 +1,91 @@ +--- +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
DescriptionResource Type definition for AWS::AppConfig::HostedConfigurationVersion
Idaws.appconfig.hosted_configuration_version
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
configuration_profile_idstringThe configuration profile ID.
descriptionstringA description of the hosted configuration version.
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.
contentstringThe content of the configuration or the configuration data.
version_labelstringA user-defined label for an AWS AppConfig hosted configuration version.
application_idstringThe application ID.
version_numberstringCurrent version number of hosted configuration version.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +configuration_profile_id, +description, +content_type, +latest_version_number, +content, +version_label, +application_id, +version_number +FROM aws.appconfig.hosted_configuration_version +WHERE data__Identifier = '||'; +``` + +## Permissions + +To operate on the hosted_configuration_version resource, the following permissions are required: + +### Read +```json +appconfig:GetHostedConfigurationVersion +``` + +### Delete +```json +appconfig:DeleteHostedConfigurationVersion +``` + diff --git a/docs/aws-docs/providers/aws/appconfig/hosted_configuration_versions/index.md b/docs/aws-docs/providers/aws/appconfig/hosted_configuration_versions/index.md new file mode 100644 index 0000000000..8838ac2756 --- /dev/null +++ b/docs/aws-docs/providers/aws/appconfig/hosted_configuration_versions/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionResource Type definition for AWS::AppConfig::HostedConfigurationVersion
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +application_id, +configuration_profile_id, +version_number +FROM aws.appconfig.hosted_configuration_versions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the hosted_configuration_versions resource, the following permissions are required: + +### Create +```json +appconfig:CreateHostedConfigurationVersion +``` + +### List +```json +appconfig:ListHostedConfigurationVersions +``` + diff --git a/docs/aws-docs/providers/aws/appconfig/index.md b/docs/aws-docs/providers/aws/appconfig/index.md new file mode 100644 index 0000000000..5036ea432f --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/appflow/connector/index.md b/docs/aws-docs/providers/aws/appflow/connector/index.md new file mode 100644 index 0000000000..e97300ac51 --- /dev/null +++ b/docs/aws-docs/providers/aws/appflow/connector/index.md @@ -0,0 +1,96 @@ +--- +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
DescriptionResource schema for AWS::AppFlow::Connector
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +connector_label, +connector_arn, +connector_provisioning_type, +connector_provisioning_config, +description +FROM aws.appflow.connector +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the connector resource, the following permissions are required: + +### Read +```json +appflow:DescribeConnector +``` + +### Delete +```json +appflow:UnRegisterConnector +``` + +### Update +```json +appflow:UpdateConnectorRegistration, +lambda:InvokeFunction +``` + diff --git a/docs/aws-docs/providers/aws/appflow/connector_profile/index.md b/docs/aws-docs/providers/aws/appflow/connector_profile/index.md new file mode 100644 index 0000000000..b2e3d2f67b --- /dev/null +++ b/docs/aws-docs/providers/aws/appflow/connector_profile/index.md @@ -0,0 +1,110 @@ +--- +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
DescriptionResource Type definition for AWS::AppFlow::ConnectorProfile
Idaws.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.
kms_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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +connector_profile_arn, +connector_label, +connector_profile_name, +kms_arn, +connector_type, +connection_mode, +connector_profile_config, +credentials_arn +FROM aws.appflow.connector_profile +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the connector_profile resource, the following permissions are required: + +### Delete +```json +appflow:DeleteConnectorProfile +``` + +### Read +```json +appflow:DescribeConnectorProfiles +``` + +### Update +```json +appflow:UpdateConnectorProfile, +kms:ListKeys, +kms:DescribeKey, +kms:ListAliases, +kms:CreateGrant, +kms:ListGrants, +iam:PassRole, +secretsmanager:CreateSecret, +secretsmanager:GetSecretValue, +secretsmanager:PutResourcePolicy +``` + diff --git a/docs/aws-docs/providers/aws/appflow/connector_profiles/index.md b/docs/aws-docs/providers/aws/appflow/connector_profiles/index.md new file mode 100644 index 0000000000..acb44ceda0 --- /dev/null +++ b/docs/aws-docs/providers/aws/appflow/connector_profiles/index.md @@ -0,0 +1,86 @@ +--- +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
DescriptionResource Type definition for AWS::AppFlow::ConnectorProfile
Idaws.appflow.connector_profiles
+ +## Fields + + + + + +
NameDatatypeDescription
connector_profile_namestringThe maximum number of items to retrieve in a single batch.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +connector_profile_name +FROM aws.appflow.connector_profiles +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the connector_profiles resource, the following permissions are required: + +### Create +```json +appflow:CreateConnectorProfile, +kms:ListKeys, +kms:DescribeKey, +kms:ListAliases, +kms:CreateGrant, +kms:ListGrants, +iam:PassRole, +secretsmanager:CreateSecret, +secretsmanager:GetSecretValue, +secretsmanager:PutResourcePolicy +``` + +### List +```json +appflow:DescribeConnectorProfiles +``` + diff --git a/docs/aws-docs/providers/aws/appflow/connectors/index.md b/docs/aws-docs/providers/aws/appflow/connectors/index.md new file mode 100644 index 0000000000..7c1c218954 --- /dev/null +++ b/docs/aws-docs/providers/aws/appflow/connectors/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionResource schema for AWS::AppFlow::Connector
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +connector_label +FROM aws.appflow.connectors +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the connectors resource, the following permissions are required: + +### Create +```json +appflow:RegisterConnector, +lambda:InvokeFunction +``` + +### List +```json +appflow:ListConnectors +``` + diff --git a/docs/aws-docs/providers/aws/appflow/flow/index.md b/docs/aws-docs/providers/aws/appflow/flow/index.md new file mode 100644 index 0000000000..b60a2342ae --- /dev/null +++ b/docs/aws-docs/providers/aws/appflow/flow/index.md @@ -0,0 +1,121 @@ +--- +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
DescriptionResource schema for AWS::AppFlow::Flow.
Idaws.appflow.flow
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
flow_arnstringARN identifier of the flow.
flow_namestringName of the flow.
descriptionstringDescription of the flow.
kms_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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +flow_arn, +flow_name, +description, +kms_arn, +trigger_config, +flow_status, +source_flow_config, +destination_flow_config_list, +tasks, +tags, +metadata_catalog_config +FROM aws.appflow.flow +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the flow resource, the following permissions are required: + +### Read +```json +appflow:DescribeFlow, +appflow:ListTagsForResource +``` + +### Update +```json +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 +```json +appflow:DeleteFlow +``` + diff --git a/docs/aws-docs/providers/aws/appflow/flows/index.md b/docs/aws-docs/providers/aws/appflow/flows/index.md new file mode 100644 index 0000000000..3eeb081005 --- /dev/null +++ b/docs/aws-docs/providers/aws/appflow/flows/index.md @@ -0,0 +1,92 @@ +--- +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
DescriptionResource schema for AWS::AppFlow::Flow.
Idaws.appflow.flows
+ +## Fields + + + + + +
NameDatatypeDescription
flow_namestringName of the flow.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +flow_name +FROM aws.appflow.flows +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the flows resource, the following permissions are required: + +### Create +```json +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 +```json +appflow:ListFlows +``` + diff --git a/docs/aws-docs/providers/aws/appflow/index.md b/docs/aws-docs/providers/aws/appflow/index.md new file mode 100644 index 0000000000..90813a7491 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/appintegrations/application/index.md b/docs/aws-docs/providers/aws/appintegrations/application/index.md new file mode 100644 index 0000000000..a785e083ac --- /dev/null +++ b/docs/aws-docs/providers/aws/appintegrations/application/index.md @@ -0,0 +1,104 @@ +--- +title: application +hide_title: false +hide_table_of_contents: false +keywords: + - application + - 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 application resource + +## Overview + + + + + +
Nameapplication
TypeResource
DescriptionResource Type definition for AWS:AppIntegrations::Application
Idaws.appintegrations.application
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
namestringThe name of the application.
idstringThe id of the application.
namespacestringThe namespace of the application.
descriptionstringThe application description.
application_arnstringThe Amazon Resource Name (ARN) of the application.
application_source_configobjectApplication source config
permissionsarrayThe configuration of events or requests that the application has access to.
tagsarrayThe tags (keys and values) associated with the application.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +id, +namespace, +description, +application_arn, +application_source_config, +permissions, +tags +FROM aws.appintegrations.application +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the application resource, the following permissions are required: + +### Read +```json +app-integrations:GetApplication +``` + +### Update +```json +app-integrations:GetApplication, +app-integrations:UpdateApplication, +app-integrations:TagResource, +app-integrations:UntagResource +``` + +### Delete +```json +app-integrations:DeleteApplication +``` + diff --git a/docs/aws-docs/providers/aws/appintegrations/applications/index.md b/docs/aws-docs/providers/aws/appintegrations/applications/index.md new file mode 100644 index 0000000000..4398dafc8e --- /dev/null +++ b/docs/aws-docs/providers/aws/appintegrations/applications/index.md @@ -0,0 +1,79 @@ +--- +title: applications +hide_title: false +hide_table_of_contents: false +keywords: + - applications + - 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 applications in a region + +## Overview + + + + + +
Nameapplications
TypeResource
DescriptionResource Type definition for AWS:AppIntegrations::Application
Idaws.appintegrations.applications
+ +## Fields + + + + + +
NameDatatypeDescription
application_arnstringThe Amazon Resource Name (ARN) of the application.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +application_arn +FROM aws.appintegrations.applications +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the applications resource, the following permissions are required: + +### Create +```json +app-integrations:CreateApplication, +app-integrations:TagResource +``` + +### List +```json +app-integrations:ListApplications, +app-integrations:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/appintegrations/data_integration/index.md b/docs/aws-docs/providers/aws/appintegrations/data_integration/index.md new file mode 100644 index 0000000000..2766f3eeaf --- /dev/null +++ b/docs/aws-docs/providers/aws/appintegrations/data_integration/index.md @@ -0,0 +1,132 @@ +--- +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
DescriptionResource Type definition for AWS::AppIntegrations::DataIntegration
Idaws.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_uristringThe 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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +description, +id, +data_integration_arn, +name, +kms_key, +schedule_config, +source_uri, +tags, +file_configuration, +object_configuration +FROM aws.appintegrations.data_integration +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the data_integration resource, the following permissions are required: + +### Read +```json +app-integrations:GetDataIntegration, +app-integrations:ListTagsForResource +``` + +### Update +```json +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 +```json +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 +``` + diff --git a/docs/aws-docs/providers/aws/appintegrations/data_integrations/index.md b/docs/aws-docs/providers/aws/appintegrations/data_integrations/index.md new file mode 100644 index 0000000000..8f020eebad --- /dev/null +++ b/docs/aws-docs/providers/aws/appintegrations/data_integrations/index.md @@ -0,0 +1,93 @@ +--- +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
DescriptionResource Type definition for AWS::AppIntegrations::DataIntegration
Idaws.appintegrations.data_integrations
+ +## Fields + + + + + +
NameDatatypeDescription
idstringThe unique identifer of the data integration.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.appintegrations.data_integrations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the data_integrations resource, the following permissions are required: + +### Create +```json +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 +```json +app-integrations:ListDataIntegrations +``` + diff --git a/docs/aws-docs/providers/aws/appintegrations/event_integration/index.md b/docs/aws-docs/providers/aws/appintegrations/event_integration/index.md new file mode 100644 index 0000000000..f44b5b796a --- /dev/null +++ b/docs/aws-docs/providers/aws/appintegrations/event_integration/index.md @@ -0,0 +1,101 @@ +--- +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
DescriptionResource Type definition for AWS::AppIntegrations::EventIntegration
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +description, +event_integration_arn, +name, +event_bridge_bus, +event_filter, +tags +FROM aws.appintegrations.event_integration +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the event_integration resource, the following permissions are required: + +### Read +```json +app-integrations:GetEventIntegration, +app-integrations:ListTagsForResource +``` + +### Update +```json +app-integrations:GetEventIntegration, +app-integrations:UpdateEventIntegration, +app-integrations:TagResource, +app-integrations:UntagResource +``` + +### Delete +```json +app-integrations:DeleteEventIntegration +``` + diff --git a/docs/aws-docs/providers/aws/appintegrations/event_integrations/index.md b/docs/aws-docs/providers/aws/appintegrations/event_integrations/index.md new file mode 100644 index 0000000000..fd5aecd7cd --- /dev/null +++ b/docs/aws-docs/providers/aws/appintegrations/event_integrations/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionResource Type definition for AWS::AppIntegrations::EventIntegration
Idaws.appintegrations.event_integrations
+ +## Fields + + + + + +
NameDatatypeDescription
namestringThe name of the event integration.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.appintegrations.event_integrations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the event_integrations resource, the following permissions are required: + +### Create +```json +app-integrations:CreateEventIntegration, +app-integrations:TagResource +``` + +### List +```json +app-integrations:ListEventIntegrations +``` + diff --git a/docs/aws-docs/providers/aws/appintegrations/index.md b/docs/aws-docs/providers/aws/appintegrations/index.md new file mode 100644 index 0000000000..8a0fc77b47 --- /dev/null +++ b/docs/aws-docs/providers/aws/appintegrations/index.md @@ -0,0 +1,43 @@ +--- +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: 6
+total selectable resources: 6
+total methods: 6
+
+
+ +::: + +## Resources +
+
+application
+applications
+data_integration +
+
+data_integrations
+event_integration
+event_integrations +
+
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/applicationautoscaling/index.md b/docs/aws-docs/providers/aws/applicationautoscaling/index.md new file mode 100644 index 0000000000..83b32e4eaf --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/applicationautoscaling/scalable_target/index.md b/docs/aws-docs/providers/aws/applicationautoscaling/scalable_target/index.md new file mode 100644 index 0000000000..64abb7cb1f --- /dev/null +++ b/docs/aws-docs/providers/aws/applicationautoscaling/scalable_target/index.md @@ -0,0 +1,114 @@ +--- +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
DescriptionResource Type definition for AWS::ApplicationAutoScaling::ScalableTarget
Idaws.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_arnstringSpecify 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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +max_capacity, +min_capacity, +resource_id, +role_arn, +scalable_dimension, +scheduled_actions, +service_namespace, +suspended_state +FROM aws.applicationautoscaling.scalable_target +WHERE data__Identifier = '||'; +``` + +## Permissions + +To operate on the scalable_target resource, the following permissions are required: + +### Read +```json +application-autoscaling:DescribeScalableTargets, +application-autoscaling:DescribeScheduledActions +``` + +### Update +```json +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 +```json +application-autoscaling:DeregisterScalableTarget +``` + diff --git a/docs/aws-docs/providers/aws/applicationautoscaling/scalable_targets/index.md b/docs/aws-docs/providers/aws/applicationautoscaling/scalable_targets/index.md new file mode 100644 index 0000000000..ec06d9ff39 --- /dev/null +++ b/docs/aws-docs/providers/aws/applicationautoscaling/scalable_targets/index.md @@ -0,0 +1,92 @@ +--- +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
DescriptionResource Type definition for AWS::ApplicationAutoScaling::ScalableTarget
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +resource_id, +scalable_dimension, +service_namespace +FROM aws.applicationautoscaling.scalable_targets +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the scalable_targets resource, the following permissions are required: + +### Create +```json +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 +```json +application-autoscaling:DescribeScalableTargets +``` + diff --git a/docs/aws-docs/providers/aws/applicationautoscaling/scaling_policies/index.md b/docs/aws-docs/providers/aws/applicationautoscaling/scaling_policies/index.md new file mode 100644 index 0000000000..c66d452ff6 --- /dev/null +++ b/docs/aws-docs/providers/aws/applicationautoscaling/scaling_policies/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionResource Type definition for AWS::ApplicationAutoScaling::ScalingPolicy
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +scalable_dimension +FROM aws.applicationautoscaling.scaling_policies +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the scaling_policies resource, the following permissions are required: + +### Create +```json +application-autoscaling:DescribeScalingPolicies, +application-autoscaling:PutScalingPolicy +``` + +### List +```json +application-autoscaling:DescribeScalingPolicies +``` + diff --git a/docs/aws-docs/providers/aws/applicationautoscaling/scaling_policy/index.md b/docs/aws-docs/providers/aws/applicationautoscaling/scaling_policy/index.md new file mode 100644 index 0000000000..228e2ae6b8 --- /dev/null +++ b/docs/aws-docs/providers/aws/applicationautoscaling/scaling_policy/index.md @@ -0,0 +1,105 @@ +--- +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
DescriptionResource Type definition for AWS::ApplicationAutoScaling::ScalingPolicy
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.applicationautoscaling.scaling_policy +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the scaling_policy resource, the following permissions are required: + +### Read +```json +application-autoscaling:DescribeScalingPolicies +``` + +### Update +```json +application-autoscaling:DescribeScalingPolicies, +application-autoscaling:PutScalingPolicy +``` + +### Delete +```json +application-autoscaling:DescribeScalingPolicies, +application-autoscaling:DeleteScalingPolicy +``` + diff --git a/docs/aws-docs/providers/aws/applicationinsights/application/index.md b/docs/aws-docs/providers/aws/applicationinsights/application/index.md new file mode 100644 index 0000000000..559650b82c --- /dev/null +++ b/docs/aws-docs/providers/aws/applicationinsights/application/index.md @@ -0,0 +1,109 @@ +--- +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
DescriptionResource schema for AWS::ApplicationInsights::Application
Idaws.applicationinsights.application
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
resource_group_namestringThe name of the resource group.
application_arnstringThe ARN of the ApplicationInsights application.
cwe_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_sns_topic_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
attach_missing_permissionbooleanIf set to true, the managed policies for SSM and CW will be attached to the instance roles if they are missing
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +resource_group_name, +application_arn, +cwe_monitor_enabled, +ops_center_enabled, +ops_item_sns_topic_arn, +tags, +custom_components, +log_pattern_sets, +auto_configuration_enabled, +component_monitoring_settings, +grouping_type, +attach_missing_permission +FROM aws.applicationinsights.application +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the application resource, the following permissions are required: + +### Read +```json +* +``` + +### Update +```json +* +``` + +### Delete +```json +* +``` + diff --git a/docs/aws-docs/providers/aws/applicationinsights/applications/index.md b/docs/aws-docs/providers/aws/applicationinsights/applications/index.md new file mode 100644 index 0000000000..4c87ef26fa --- /dev/null +++ b/docs/aws-docs/providers/aws/applicationinsights/applications/index.md @@ -0,0 +1,77 @@ +--- +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
DescriptionResource schema for AWS::ApplicationInsights::Application
Idaws.applicationinsights.applications
+ +## Fields + + + + + +
NameDatatypeDescription
application_arnstringThe ARN of the ApplicationInsights application.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +application_arn +FROM aws.applicationinsights.applications +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the applications resource, the following permissions are required: + +### Create +```json +* +``` + +### List +```json +* +``` + diff --git a/docs/aws-docs/providers/aws/applicationinsights/index.md b/docs/aws-docs/providers/aws/applicationinsights/index.md new file mode 100644 index 0000000000..34662fe014 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/apprunner/auto_scaling_configuration/index.md b/docs/aws-docs/providers/aws/apprunner/auto_scaling_configuration/index.md new file mode 100644 index 0000000000..c46cd9d6e7 --- /dev/null +++ b/docs/aws-docs/providers/aws/apprunner/auto_scaling_configuration/index.md @@ -0,0 +1,91 @@ +--- +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
DescriptionDescribes an AWS App Runner automatic configuration resource that enables automatic scaling of instances used to process web requests. You can share an auto scaling configuration across multiple services.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.apprunner.auto_scaling_configuration +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the auto_scaling_configuration resource, the following permissions are required: + +### Read +```json +apprunner:DescribeAutoScalingConfiguration +``` + +### Delete +```json +apprunner:DeleteAutoScalingConfiguration +``` + diff --git a/docs/aws-docs/providers/aws/apprunner/auto_scaling_configurations/index.md b/docs/aws-docs/providers/aws/apprunner/auto_scaling_configurations/index.md new file mode 100644 index 0000000000..fc53a1e3e2 --- /dev/null +++ b/docs/aws-docs/providers/aws/apprunner/auto_scaling_configurations/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionDescribes an AWS App Runner automatic configuration resource that enables automatic scaling of instances used to process web requests. You can share an auto scaling configuration across multiple services.
Idaws.apprunner.auto_scaling_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
auto_scaling_configuration_arnstringThe Amazon Resource Name (ARN) of this auto scaling configuration.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +auto_scaling_configuration_arn +FROM aws.apprunner.auto_scaling_configurations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the auto_scaling_configurations resource, the following permissions are required: + +### Create +```json +apprunner:CreateAutoScalingConfiguration, +apprunner:DescribeAutoScalingConfiguration, +apprunner:TagResource +``` + +### List +```json +apprunner:ListAutoScalingConfiguration +``` + diff --git a/docs/aws-docs/providers/aws/apprunner/index.md b/docs/aws-docs/providers/aws/apprunner/index.md new file mode 100644 index 0000000000..0540fe66c4 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/apprunner/observability_configuration/index.md b/docs/aws-docs/providers/aws/apprunner/observability_configuration/index.md new file mode 100644 index 0000000000..715685b7b7 --- /dev/null +++ b/docs/aws-docs/providers/aws/apprunner/observability_configuration/index.md @@ -0,0 +1,87 @@ +--- +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
DescriptionThe AWS::AppRunner::ObservabilityConfiguration resource is an AWS App Runner resource type that specifies an App Runner observability configuration
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +observability_configuration_arn, +observability_configuration_name, +observability_configuration_revision, +latest, +trace_configuration, +tags +FROM aws.apprunner.observability_configuration +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the observability_configuration resource, the following permissions are required: + +### Read +```json +apprunner:DescribeObservabilityConfiguration +``` + +### Delete +```json +apprunner:DeleteObservabilityConfiguration +``` + diff --git a/docs/aws-docs/providers/aws/apprunner/observability_configurations/index.md b/docs/aws-docs/providers/aws/apprunner/observability_configurations/index.md new file mode 100644 index 0000000000..655018e470 --- /dev/null +++ b/docs/aws-docs/providers/aws/apprunner/observability_configurations/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionThe AWS::AppRunner::ObservabilityConfiguration resource is an AWS App Runner resource type that specifies an App Runner observability configuration
Idaws.apprunner.observability_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
observability_configuration_arnstringThe Amazon Resource Name (ARN) of this ObservabilityConfiguration
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +observability_configuration_arn +FROM aws.apprunner.observability_configurations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the observability_configurations resource, the following permissions are required: + +### Create +```json +apprunner:CreateObservabilityConfiguration, +apprunner:DescribeObservabilityConfiguration, +apprunner:TagResource +``` + +### List +```json +apprunner:ListObservabilityConfigurations +``` + diff --git a/docs/aws-docs/providers/aws/apprunner/service/index.md b/docs/aws-docs/providers/aws/apprunner/service/index.md new file mode 100644 index 0000000000..edb8b07418 --- /dev/null +++ b/docs/aws-docs/providers/aws/apprunner/service/index.md @@ -0,0 +1,112 @@ +--- +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
DescriptionThe AWS::AppRunner::Service resource specifies an AppRunner Service.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.apprunner.service +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the service resource, the following permissions are required: + +### Read +```json +apprunner:DescribeService +``` + +### Update +```json +apprunner:UpdateService, +iam:PassRole +``` + +### Delete +```json +apprunner:DeleteService +``` + diff --git a/docs/aws-docs/providers/aws/apprunner/services/index.md b/docs/aws-docs/providers/aws/apprunner/services/index.md new file mode 100644 index 0000000000..3974f57569 --- /dev/null +++ b/docs/aws-docs/providers/aws/apprunner/services/index.md @@ -0,0 +1,88 @@ +--- +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
DescriptionThe AWS::AppRunner::Service resource specifies an AppRunner Service.
Idaws.apprunner.services
+ +## Fields + + + + + +
NameDatatypeDescription
service_arnstringThe Amazon Resource Name (ARN) of the AppRunner Service.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +service_arn +FROM aws.apprunner.services +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the services resource, the following permissions are required: + +### Create +```json +apprunner:CreateService, +apprunner:TagResource, +iam:PassRole, +iam:CreateServiceLinkedRole, +logs:CreateLogGroup, +logs:PutRetentionPolicy, +logs:CreateLogStream, +logs:PutLogEvents, +logs:DescribeLogStreams, +events:PutRule, +events:PutTargets +``` + +### List +```json +apprunner:ListServices, +iam:PassRole +``` + diff --git a/docs/aws-docs/providers/aws/apprunner/vpc_connector/index.md b/docs/aws-docs/providers/aws/apprunner/vpc_connector/index.md new file mode 100644 index 0000000000..6d8b987c1f --- /dev/null +++ b/docs/aws-docs/providers/aws/apprunner/vpc_connector/index.md @@ -0,0 +1,87 @@ +--- +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
DescriptionThe AWS::AppRunner::VpcConnector resource specifies an App Runner VpcConnector.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +vpc_connector_name, +vpc_connector_arn, +vpc_connector_revision, +subnets, +security_groups, +tags +FROM aws.apprunner.vpc_connector +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the vpc_connector resource, the following permissions are required: + +### Read +```json +apprunner:DescribeVpcConnector +``` + +### Delete +```json +apprunner:DeleteVpcConnector +``` + diff --git a/docs/aws-docs/providers/aws/apprunner/vpc_connectors/index.md b/docs/aws-docs/providers/aws/apprunner/vpc_connectors/index.md new file mode 100644 index 0000000000..f3c3d57a90 --- /dev/null +++ b/docs/aws-docs/providers/aws/apprunner/vpc_connectors/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionThe AWS::AppRunner::VpcConnector resource specifies an App Runner VpcConnector.
Idaws.apprunner.vpc_connectors
+ +## Fields + + + + + +
NameDatatypeDescription
vpc_connector_arnstringThe Amazon Resource Name (ARN) of this VPC connector.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +vpc_connector_arn +FROM aws.apprunner.vpc_connectors +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the vpc_connectors resource, the following permissions are required: + +### Create +```json +iam:CreateServiceLinkedRole, +apprunner:CreateVpcConnector, +apprunner:DescribeVpcConnector, +apprunner:TagResource, +ec2:DescribeSubnets, +ec2:DescribeSecurityGroups +``` + +### List +```json +apprunner:ListVpcConnectors +``` + diff --git a/docs/aws-docs/providers/aws/apprunner/vpc_ingress_connection/index.md b/docs/aws-docs/providers/aws/apprunner/vpc_ingress_connection/index.md new file mode 100644 index 0000000000..2c35d054fc --- /dev/null +++ b/docs/aws-docs/providers/aws/apprunner/vpc_ingress_connection/index.md @@ -0,0 +1,99 @@ +--- +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
DescriptionThe AWS::AppRunner::VpcIngressConnection resource is an App Runner resource that specifies an App Runner VpcIngressConnection.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +vpc_ingress_connection_arn, +vpc_ingress_connection_name, +service_arn, +status, +domain_name, +ingress_vpc_configuration, +tags +FROM aws.apprunner.vpc_ingress_connection +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the vpc_ingress_connection resource, the following permissions are required: + +### Read +```json +apprunner:DescribeVpcIngressConnection +``` + +### Update +```json +apprunner:UpdateVpcIngressConnection +``` + +### Delete +```json +apprunner:DeleteVpcIngressConnection +``` + diff --git a/docs/aws-docs/providers/aws/apprunner/vpc_ingress_connections/index.md b/docs/aws-docs/providers/aws/apprunner/vpc_ingress_connections/index.md new file mode 100644 index 0000000000..2f1f8119f5 --- /dev/null +++ b/docs/aws-docs/providers/aws/apprunner/vpc_ingress_connections/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionThe AWS::AppRunner::VpcIngressConnection resource is an App Runner resource that specifies an App Runner VpcIngressConnection.
Idaws.apprunner.vpc_ingress_connections
+ +## Fields + + + + + +
NameDatatypeDescription
vpc_ingress_connection_arnstringThe Amazon Resource Name (ARN) of the VpcIngressConnection.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +vpc_ingress_connection_arn +FROM aws.apprunner.vpc_ingress_connections +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the vpc_ingress_connections resource, the following permissions are required: + +### Create +```json +apprunner:CreateVpcIngressConnection, +apprunner:DescribeVpcIngressConnection, +ec2:DescribeVpcs, +ec2:DescribeVpcEndpoints, +ec2:DescribeSubnets, +apprunner:TagResource +``` + +### List +```json +apprunner:ListVpcIngressConnections +``` + diff --git a/docs/aws-docs/providers/aws/appstream/app_block/index.md b/docs/aws-docs/providers/aws/appstream/app_block/index.md new file mode 100644 index 0000000000..b391713594 --- /dev/null +++ b/docs/aws-docs/providers/aws/appstream/app_block/index.md @@ -0,0 +1,95 @@ +--- +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
DescriptionResource Type definition for AWS::AppStream::AppBlock
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.appstream.app_block +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the app_block resource, the following permissions are required: + +### Read +```json +appstream:DescribeAppBlocks +``` + +### Delete +```json +appstream:DeleteAppBlock +``` + diff --git a/docs/aws-docs/providers/aws/appstream/app_block_builder/index.md b/docs/aws-docs/providers/aws/appstream/app_block_builder/index.md new file mode 100644 index 0000000000..59105171c0 --- /dev/null +++ b/docs/aws-docs/providers/aws/appstream/app_block_builder/index.md @@ -0,0 +1,124 @@ +--- +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
DescriptionResource Type definition for AWS::AppStream::AppBlockBuilder.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.appstream.app_block_builder +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the app_block_builder resource, the following permissions are required: + +### Read +```json +appstream:DescribeAppBlockBuilders +``` + +### Update +```json +appstream:UpdateAppBlockBuilder, +appstream:DescribeAppBlockBuilders, +appstream:StartAppBlockBuilder, +appstream:StopAppBlockBuilder, +appstream:AssociateAppBlockBuilderAppBlock, +appstream:DisassociateAppBlockBuilderAppBlock, +appstream:DescribeAppBlockBuilderAppBlockAssociations, +appstream:ListTagsForResource, +appstream:TagResource, +appstream:UntagResource, +iam:PassRole +``` + +### Delete +```json +appstream:DescribeAppBlockBuilders, +appstream:DeleteAppBlockBuilder, +appstream:DisassociateAppBlockBuilderAppBlock, +appstream:DescribeAppBlockBuilderAppBlockAssociations +``` + diff --git a/docs/aws-docs/providers/aws/appstream/app_block_builders/index.md b/docs/aws-docs/providers/aws/appstream/app_block_builders/index.md new file mode 100644 index 0000000000..aeb7626d7a --- /dev/null +++ b/docs/aws-docs/providers/aws/appstream/app_block_builders/index.md @@ -0,0 +1,83 @@ +--- +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
DescriptionResource Type definition for AWS::AppStream::AppBlockBuilder.
Idaws.appstream.app_block_builders
+ +## Fields + + + + + +
NameDatatypeDescription
namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.appstream.app_block_builders +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the app_block_builders resource, the following permissions are required: + +### Create +```json +appstream:CreateAppBlockBuilder, +appstream:DescribeAppBlockBuilders, +appstream:StartAppBlockBuilder, +appstream:AssociateAppBlockBuilderAppBlock, +appstream:DescribeAppBlockBuilderAppBlockAssociations, +appstream:TagResource, +iam:PassRole +``` + +### List +```json +appstream:DescribeAppBlockBuilders +``` + diff --git a/docs/aws-docs/providers/aws/appstream/app_blocks/index.md b/docs/aws-docs/providers/aws/appstream/app_blocks/index.md new file mode 100644 index 0000000000..8929ac971c --- /dev/null +++ b/docs/aws-docs/providers/aws/appstream/app_blocks/index.md @@ -0,0 +1,71 @@ +--- +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
DescriptionResource Type definition for AWS::AppStream::AppBlock
Idaws.appstream.app_blocks
+ +## Fields + + + + + +
NameDatatypeDescription
arnundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.appstream.app_blocks +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the app_blocks resource, the following permissions are required: + +### Create +```json +appstream:CreateAppBlock, +appstream:TagResource, +s3:GetObject, +s3:ListBucket, +s3:GetBucketOwnershipControls +``` + diff --git a/docs/aws-docs/providers/aws/appstream/application/index.md b/docs/aws-docs/providers/aws/appstream/application/index.md new file mode 100644 index 0000000000..93b7ca2cc6 --- /dev/null +++ b/docs/aws-docs/providers/aws/appstream/application/index.md @@ -0,0 +1,114 @@ +--- +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
DescriptionResource Type definition for AWS::AppStream::Application
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.appstream.application +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the application resource, the following permissions are required: + +### Read +```json +appstream:DescribeApplications +``` + +### Update +```json +appstream:UpdateApplication, +s3:GetObject +``` + +### Delete +```json +appstream:DeleteApplication +``` + diff --git a/docs/aws-docs/providers/aws/appstream/application_entitlement_association/index.md b/docs/aws-docs/providers/aws/appstream/application_entitlement_association/index.md new file mode 100644 index 0000000000..4c977da6f4 --- /dev/null +++ b/docs/aws-docs/providers/aws/appstream/application_entitlement_association/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionResource Type definition for AWS::AppStream::ApplicationEntitlementAssociation
Idaws.appstream.application_entitlement_association
+ +## Fields + + + + + + + +
NameDatatypeDescription
stack_namestring
entitlement_namestring
application_identifierstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +stack_name, +entitlement_name, +application_identifier +FROM aws.appstream.application_entitlement_association +WHERE data__Identifier = '||'; +``` + +## Permissions + +To operate on the application_entitlement_association resource, the following permissions are required: + +### Read +```json +appstream:ListEntitledApplications +``` + +### Delete +```json +appstream:DisassociateApplicationFromEntitlement, +appstream:ListEntitledApplications +``` + diff --git a/docs/aws-docs/providers/aws/appstream/application_entitlement_associations/index.md b/docs/aws-docs/providers/aws/appstream/application_entitlement_associations/index.md new file mode 100644 index 0000000000..0a9e21f9f7 --- /dev/null +++ b/docs/aws-docs/providers/aws/appstream/application_entitlement_associations/index.md @@ -0,0 +1,72 @@ +--- +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
DescriptionResource Type definition for AWS::AppStream::ApplicationEntitlementAssociation
Idaws.appstream.application_entitlement_associations
+ +## Fields + + + + + + + +
NameDatatypeDescription
stack_namestring
entitlement_namestring
application_identifierstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +stack_name, +entitlement_name, +application_identifier +FROM aws.appstream.application_entitlement_associations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the application_entitlement_associations resource, the following permissions are required: + +### Create +```json +appstream:AssociateApplicationToEntitlement, +appstream:ListEntitledApplications +``` + diff --git a/docs/aws-docs/providers/aws/appstream/application_fleet_association/index.md b/docs/aws-docs/providers/aws/appstream/application_fleet_association/index.md new file mode 100644 index 0000000000..69db2127cd --- /dev/null +++ b/docs/aws-docs/providers/aws/appstream/application_fleet_association/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionResource Type definition for AWS::AppStream::ApplicationFleetAssociation
Idaws.appstream.application_fleet_association
+ +## Fields + + + + + + +
NameDatatypeDescription
fleet_namestring
application_arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +fleet_name, +application_arn +FROM aws.appstream.application_fleet_association +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the application_fleet_association resource, the following permissions are required: + +### Read +```json +appstream:DescribeApplicationFleetAssociations +``` + +### Delete +```json +appstream:DisassociateApplicationFleet, +appstream:DescribeApplicationFleetAssociations +``` + diff --git a/docs/aws-docs/providers/aws/appstream/application_fleet_associations/index.md b/docs/aws-docs/providers/aws/appstream/application_fleet_associations/index.md new file mode 100644 index 0000000000..dd8b387cac --- /dev/null +++ b/docs/aws-docs/providers/aws/appstream/application_fleet_associations/index.md @@ -0,0 +1,70 @@ +--- +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
DescriptionResource Type definition for AWS::AppStream::ApplicationFleetAssociation
Idaws.appstream.application_fleet_associations
+ +## Fields + + + + + + +
NameDatatypeDescription
fleet_namestring
application_arnundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +fleet_name, +application_arn +FROM aws.appstream.application_fleet_associations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the application_fleet_associations resource, the following permissions are required: + +### Create +```json +appstream:AssociateApplicationFleet, +appstream:DescribeApplicationFleetAssociations +``` + diff --git a/docs/aws-docs/providers/aws/appstream/applications/index.md b/docs/aws-docs/providers/aws/appstream/applications/index.md new file mode 100644 index 0000000000..bcbbeb2283 --- /dev/null +++ b/docs/aws-docs/providers/aws/appstream/applications/index.md @@ -0,0 +1,69 @@ +--- +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
DescriptionResource Type definition for AWS::AppStream::Application
Idaws.appstream.applications
+ +## Fields + + + + + +
NameDatatypeDescription
arnundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.appstream.applications +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the applications resource, the following permissions are required: + +### Create +```json +s3:GetObject, +appstream:CreateApplication, +appstream:TagResource +``` + diff --git a/docs/aws-docs/providers/aws/appstream/directory_config/index.md b/docs/aws-docs/providers/aws/appstream/directory_config/index.md new file mode 100644 index 0000000000..5833a507bc --- /dev/null +++ b/docs/aws-docs/providers/aws/appstream/directory_config/index.md @@ -0,0 +1,111 @@ +--- +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
DescriptionResource Type definition for AWS::AppStream::DirectoryConfig
Idaws.appstream.directory_config
+ +## Fields + + + + + + + + +
NameDatatypeDescription
organizational_unit_distinguished_namesarray
service_account_credentialsobject
directory_namestring
certificate_based_auth_propertiesobject
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +organizational_unit_distinguished_names, +service_account_credentials, +directory_name, +certificate_based_auth_properties +FROM aws.appstream.directory_config +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the directory_config resource, the following permissions are required: + +### Update +```json +appstream:CreateDirectoryConfig, +appstream:DeleteDirectoryConfig, +appstream:DescribeDirectoryConfigs, +appstream:UpdateDirectoryConfig, +iam:CreateServiceLinkedRole, +iam:DeleteServiceLinkedRole, +iam:GetServiceLinkedRoleDeletionStatus +``` + +### Read +```json +appstream:CreateDirectoryConfig, +appstream:DeleteDirectoryConfig, +appstream:DescribeDirectoryConfigs, +appstream:UpdateDirectoryConfig, +iam:CreateServiceLinkedRole, +iam:DeleteServiceLinkedRole, +iam:GetServiceLinkedRoleDeletionStatus +``` + +### Delete +```json +appstream:CreateDirectoryConfig, +appstream:DeleteDirectoryConfig, +appstream:DescribeDirectoryConfigs, +appstream:UpdateDirectoryConfig, +iam:CreateServiceLinkedRole, +iam:DeleteServiceLinkedRole, +iam:GetServiceLinkedRoleDeletionStatus +``` + diff --git a/docs/aws-docs/providers/aws/appstream/directory_configs/index.md b/docs/aws-docs/providers/aws/appstream/directory_configs/index.md new file mode 100644 index 0000000000..dc45ea6442 --- /dev/null +++ b/docs/aws-docs/providers/aws/appstream/directory_configs/index.md @@ -0,0 +1,89 @@ +--- +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
DescriptionResource Type definition for AWS::AppStream::DirectoryConfig
Idaws.appstream.directory_configs
+ +## Fields + + + + + +
NameDatatypeDescription
directory_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +directory_name +FROM aws.appstream.directory_configs +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the directory_configs resource, the following permissions are required: + +### Create +```json +appstream:CreateDirectoryConfig, +appstream:DeleteDirectoryConfig, +appstream:DescribeDirectoryConfigs, +appstream:UpdateDirectoryConfig, +iam:CreateServiceLinkedRole, +iam:DeleteServiceLinkedRole, +iam:GetServiceLinkedRoleDeletionStatus +``` + +### List +```json +appstream:CreateDirectoryConfig, +appstream:DeleteDirectoryConfig, +appstream:DescribeDirectoryConfigs, +appstream:UpdateDirectoryConfig, +iam:CreateServiceLinkedRole, +iam:DeleteServiceLinkedRole, +iam:GetServiceLinkedRoleDeletionStatus +``` + diff --git a/docs/aws-docs/providers/aws/appstream/entitlement/index.md b/docs/aws-docs/providers/aws/appstream/entitlement/index.md new file mode 100644 index 0000000000..075196e9d0 --- /dev/null +++ b/docs/aws-docs/providers/aws/appstream/entitlement/index.md @@ -0,0 +1,99 @@ +--- +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
DescriptionResource Type definition for AWS::AppStream::Entitlement
Idaws.appstream.entitlement
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
namestring
stack_namestring
descriptionstring
app_visibilitystring
attributesarray
created_timestring
last_modified_timestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +stack_name, +description, +app_visibility, +attributes, +created_time, +last_modified_time +FROM aws.appstream.entitlement +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the entitlement resource, the following permissions are required: + +### Read +```json +appstream:DescribeEntitlements +``` + +### Update +```json +appstream:UpdateEntitlement +``` + +### Delete +```json +appstream:DeleteEntitlement +``` + diff --git a/docs/aws-docs/providers/aws/appstream/entitlements/index.md b/docs/aws-docs/providers/aws/appstream/entitlements/index.md new file mode 100644 index 0000000000..e74111535c --- /dev/null +++ b/docs/aws-docs/providers/aws/appstream/entitlements/index.md @@ -0,0 +1,69 @@ +--- +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
DescriptionResource Type definition for AWS::AppStream::Entitlement
Idaws.appstream.entitlements
+ +## Fields + + + + + + +
NameDatatypeDescription
stack_namestring
namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +stack_name, +name +FROM aws.appstream.entitlements +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the entitlements resource, the following permissions are required: + +### Create +```json +appstream:CreateEntitlement +``` + diff --git a/docs/aws-docs/providers/aws/appstream/image_builder/index.md b/docs/aws-docs/providers/aws/appstream/image_builder/index.md new file mode 100644 index 0000000000..be1782bfa0 --- /dev/null +++ b/docs/aws-docs/providers/aws/appstream/image_builder/index.md @@ -0,0 +1,121 @@ +--- +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
DescriptionResource Type definition for AWS::AppStream::ImageBuilder
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.appstream.image_builder +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the image_builder resource, the following permissions are required: + +### Read +```json +appstream:CreateImageBuilder, +appstream:CreateImageBuilderStreamingURL, +appstream:CreateStreamingURL, +appstream:DeleteImageBuilder, +appstream:DescribeImageBuilders, +appstream:StartImageBuilder, +appstream:StopImageBuilder, +iam:CreateServiceLinkedRole, +iam:DeleteServiceLinkedRole, +iam:GetServiceLinkedRoleDeletionStatus +``` + +### Delete +```json +appstream:CreateImageBuilder, +appstream:CreateImageBuilderStreamingURL, +appstream:CreateStreamingURL, +appstream:DeleteImageBuilder, +appstream:DescribeImageBuilders, +appstream:StartImageBuilder, +appstream:StopImageBuilder, +iam:CreateServiceLinkedRole, +iam:DeleteServiceLinkedRole, +iam:GetServiceLinkedRoleDeletionStatus +``` + diff --git a/docs/aws-docs/providers/aws/appstream/image_builders/index.md b/docs/aws-docs/providers/aws/appstream/image_builders/index.md new file mode 100644 index 0000000000..d3d23c75ff --- /dev/null +++ b/docs/aws-docs/providers/aws/appstream/image_builders/index.md @@ -0,0 +1,95 @@ +--- +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
DescriptionResource Type definition for AWS::AppStream::ImageBuilder
Idaws.appstream.image_builders
+ +## Fields + + + + + +
NameDatatypeDescription
namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.appstream.image_builders +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the image_builders resource, the following permissions are required: + +### Create +```json +appstream:CreateImageBuilder, +appstream:CreateImageBuilderStreamingURL, +appstream:CreateStreamingURL, +appstream:DeleteImageBuilder, +appstream:DescribeImageBuilders, +appstream:StartImageBuilder, +appstream:StopImageBuilder, +iam:CreateServiceLinkedRole, +iam:DeleteServiceLinkedRole, +iam:GetServiceLinkedRoleDeletionStatus +``` + +### List +```json +appstream:CreateImageBuilder, +appstream:CreateImageBuilderStreamingURL, +appstream:CreateStreamingURL, +appstream:DeleteImageBuilder, +appstream:DescribeImageBuilders, +appstream:StartImageBuilder, +appstream:StopImageBuilder, +iam:CreateServiceLinkedRole, +iam:DeleteServiceLinkedRole, +iam:GetServiceLinkedRoleDeletionStatus +``` + diff --git a/docs/aws-docs/providers/aws/appstream/index.md b/docs/aws-docs/providers/aws/appstream/index.md new file mode 100644 index 0000000000..c2d11d7f83 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/appsync/domain_name/index.md b/docs/aws-docs/providers/aws/appsync/domain_name/index.md new file mode 100644 index 0000000000..6ebe9ea337 --- /dev/null +++ b/docs/aws-docs/providers/aws/appsync/domain_name/index.md @@ -0,0 +1,96 @@ +--- +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
DescriptionResource Type definition for AWS::AppSync::DomainName
Idaws.appsync.domain_name
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
domain_namestring
descriptionstring
certificate_arnstring
app_sync_domain_namestring
hosted_zone_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +domain_name, +description, +certificate_arn, +app_sync_domain_name, +hosted_zone_id +FROM aws.appsync.domain_name +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the domain_name resource, the following permissions are required: + +### Delete +```json +appsync:GetDomainName, +appsync:DeleteDomainName +``` + +### Update +```json +appsync:UpdateDomainName +``` + +### Read +```json +appsync:GetDomainName +``` + diff --git a/docs/aws-docs/providers/aws/appsync/domain_name_api_association/index.md b/docs/aws-docs/providers/aws/appsync/domain_name_api_association/index.md new file mode 100644 index 0000000000..baf480f50c --- /dev/null +++ b/docs/aws-docs/providers/aws/appsync/domain_name_api_association/index.md @@ -0,0 +1,93 @@ +--- +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
DescriptionResource Type definition for AWS::AppSync::DomainNameApiAssociation
Idaws.appsync.domain_name_api_association
+ +## Fields + + + + + + + +
NameDatatypeDescription
domain_namestring
api_idstring
api_association_identifierstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +domain_name, +api_id, +api_association_identifier +FROM aws.appsync.domain_name_api_association +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the domain_name_api_association resource, the following permissions are required: + +### Delete +```json +appsync:DisassociateApi, +appsync:GetApiAssociation +``` + +### Update +```json +appsync:AssociateApi, +appsync:GetApiAssociation +``` + +### Read +```json +appsync:GetApiAssociation +``` + diff --git a/docs/aws-docs/providers/aws/appsync/domain_name_api_associations/index.md b/docs/aws-docs/providers/aws/appsync/domain_name_api_associations/index.md new file mode 100644 index 0000000000..07561148c5 --- /dev/null +++ b/docs/aws-docs/providers/aws/appsync/domain_name_api_associations/index.md @@ -0,0 +1,68 @@ +--- +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
DescriptionResource Type definition for AWS::AppSync::DomainNameApiAssociation
Idaws.appsync.domain_name_api_associations
+ +## Fields + + + + + +
NameDatatypeDescription
api_association_identifierstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +api_association_identifier +FROM aws.appsync.domain_name_api_associations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the domain_name_api_associations resource, the following permissions are required: + +### Create +```json +appsync:AssociateApi, +appsync:GetApiAssociation +``` + diff --git a/docs/aws-docs/providers/aws/appsync/domain_names/index.md b/docs/aws-docs/providers/aws/appsync/domain_names/index.md new file mode 100644 index 0000000000..641008c0e2 --- /dev/null +++ b/docs/aws-docs/providers/aws/appsync/domain_names/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionResource Type definition for AWS::AppSync::DomainName
Idaws.appsync.domain_names
+ +## Fields + + + + + +
NameDatatypeDescription
domain_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +domain_name +FROM aws.appsync.domain_names +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the domain_names resource, the following permissions are required: + +### Create +```json +appsync:CreateDomainName, +appsync:GetDomainName, +acm:DescribeCertificate, +cloudfront:UpdateDistribution +``` + +### List +```json +appsync:ListDomainNames +``` + diff --git a/docs/aws-docs/providers/aws/appsync/function_configuration/index.md b/docs/aws-docs/providers/aws/appsync/function_configuration/index.md new file mode 100644 index 0000000000..29d23cb764 --- /dev/null +++ b/docs/aws-docs/providers/aws/appsync/function_configuration/index.md @@ -0,0 +1,118 @@ +--- +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
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.appsync.function_configuration +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the function_configuration resource, the following permissions are required: + +### Read +```json +appsync:GetFunction +``` + +### Update +```json +s3:GetObject, +appsync:UpdateFunction +``` + +### Delete +```json +appsync:DeleteFunction +``` + diff --git a/docs/aws-docs/providers/aws/appsync/function_configurations/index.md b/docs/aws-docs/providers/aws/appsync/function_configurations/index.md new file mode 100644 index 0000000000..1a0c76127b --- /dev/null +++ b/docs/aws-docs/providers/aws/appsync/function_configurations/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Idaws.appsync.function_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
function_arnstringThe ARN for the function generated by the service
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +function_arn +FROM aws.appsync.function_configurations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the function_configurations resource, the following permissions are required: + +### Create +```json +s3:GetObject, +appsync:CreateFunction +``` + +### List +```json +appsync:ListFunctions +``` + diff --git a/docs/aws-docs/providers/aws/appsync/index.md b/docs/aws-docs/providers/aws/appsync/index.md new file mode 100644 index 0000000000..575fe6311c --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/appsync/resolver/index.md b/docs/aws-docs/providers/aws/appsync/resolver/index.md new file mode 100644 index 0000000000..de618b2d78 --- /dev/null +++ b/docs/aws-docs/providers/aws/appsync/resolver/index.md @@ -0,0 +1,122 @@ +--- +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
DescriptionThe ``AWS::AppSync::Resolver`` resource defines the logical GraphQL resolver that you attach to fields in a schema. Request and response templates for resolvers are written in Apache Velocity Template Language (VTL) format. For more information about resolvers, see [Resolver Mapping Template Reference](https://docs.aws.amazon.com/appsync/latest/devguide/resolver-mapping-template-reference.html).<br/> When you submit an update, CFNLong updates resources based on differences between what you submit and the stack's current template. To cause this resource to be updated you must change a property value for this resource in the CFNshort template. Changing the S3 file content without changing a property value will not result in an update operation.<br/> See [Update Behaviors of Stack Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html) in the *User Guide*.
Idaws.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_configstringEnables or disables enhanced resolver metrics for specified resolvers. Note that ``MetricsConfig`` won't be used unless the ``resolverLevelMetricsBehavior`` value is set to ``PER_RESOLVER_METRICS``. If the ``resolverLevelMetricsBehavior`` is set to ``FULL_REQUEST_RESOLVER_METRICS`` instead, ``MetricsConfig`` will be ignored. However, you can still set its value.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.appsync.resolver +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the resolver resource, the following permissions are required: + +### Read +```json +appsync:GetResolver +``` + +### Update +```json +s3:GetObject, +appsync:UpdateResolver +``` + +### Delete +```json +appsync:DeleteResolver +``` + diff --git a/docs/aws-docs/providers/aws/appsync/resolvers/index.md b/docs/aws-docs/providers/aws/appsync/resolvers/index.md new file mode 100644 index 0000000000..cce09916cf --- /dev/null +++ b/docs/aws-docs/providers/aws/appsync/resolvers/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionThe ``AWS::AppSync::Resolver`` resource defines the logical GraphQL resolver that you attach to fields in a schema. Request and response templates for resolvers are written in Apache Velocity Template Language (VTL) format. For more information about resolvers, see [Resolver Mapping Template Reference](https://docs.aws.amazon.com/appsync/latest/devguide/resolver-mapping-template-reference.html).<br/> When you submit an update, CFNLong updates resources based on differences between what you submit and the stack's current template. To cause this resource to be updated you must change a property value for this resource in the CFNshort template. Changing the S3 file content without changing a property value will not result in an update operation.<br/> See [Update Behaviors of Stack Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html) in the *User Guide*.
Idaws.appsync.resolvers
+ +## Fields + + + + + +
NameDatatypeDescription
resolver_arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +resolver_arn +FROM aws.appsync.resolvers +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the resolvers resource, the following permissions are required: + +### Create +```json +s3:GetObject, +appsync:CreateResolver, +appsync:GetResolver +``` + +### List +```json +appsync:ListResolvers +``` + diff --git a/docs/aws-docs/providers/aws/appsync/source_api_association/index.md b/docs/aws-docs/providers/aws/appsync/source_api_association/index.md new file mode 100644 index 0000000000..6c81b2a07a --- /dev/null +++ b/docs/aws-docs/providers/aws/appsync/source_api_association/index.md @@ -0,0 +1,117 @@ +--- +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
DescriptionResource Type definition for AWS::AppSync::SourceApiAssociation
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.appsync.source_api_association +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the source_api_association resource, the following permissions are required: + +### Read +```json +appsync:GetSourceApiAssociation, +appsync:ListSourceApiAssociations +``` + +### Update +```json +appsync:GetSourceApiAssociation, +appsync:UpdateSourceApiAssociation, +appsync:GetSourceApiAssociation +``` + +### Delete +```json +appsync:GetSourceApiAssociation, +appsync:DisassociateSourceGraphqlApi, +appsync:DisassociateMergedGraphqlApi, +appsync:ListSourceApiAssociations +``` + diff --git a/docs/aws-docs/providers/aws/appsync/source_api_associations/index.md b/docs/aws-docs/providers/aws/appsync/source_api_associations/index.md new file mode 100644 index 0000000000..ae40eca128 --- /dev/null +++ b/docs/aws-docs/providers/aws/appsync/source_api_associations/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource Type definition for AWS::AppSync::SourceApiAssociation
Idaws.appsync.source_api_associations
+ +## Fields + + + + + +
NameDatatypeDescription
association_arnstringARN of the SourceApiAssociation.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +association_arn +FROM aws.appsync.source_api_associations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the source_api_associations resource, the following permissions are required: + +### Create +```json +appsync:AssociateSourceGraphqlApi, +appsync:AssociateMergedGraphqlApi, +appsync:GetSourceApiAssociation +``` + +### List +```json +appsync:ListSourceApiAssociations +``` + diff --git a/docs/aws-docs/providers/aws/aps/index.md b/docs/aws-docs/providers/aws/aps/index.md new file mode 100644 index 0000000000..4fd2175a4d --- /dev/null +++ b/docs/aws-docs/providers/aws/aps/index.md @@ -0,0 +1,43 @@ +--- +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: 6
+total selectable resources: 6
+total methods: 6
+
+
+ +::: + +## Resources +
+
+rule_groups_namespace
+rule_groups_namespaces
+scraper +
+
+scrapers
+workspace
+workspaces +
+
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/aps/rule_groups_namespace/index.md b/docs/aws-docs/providers/aws/aps/rule_groups_namespace/index.md new file mode 100644 index 0000000000..ceb2159983 --- /dev/null +++ b/docs/aws-docs/providers/aws/aps/rule_groups_namespace/index.md @@ -0,0 +1,101 @@ +--- +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
DescriptionRuleGroupsNamespace schema for cloudformation.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +workspace, +name, +data, +arn, +tags +FROM aws.aps.rule_groups_namespace +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the rule_groups_namespace resource, the following permissions are required: + +### Read +```json +aps:DescribeRuleGroupsNamespace, +aps:ListTagsForResource +``` + +### Update +```json +aps:PutRuleGroupsNamespace, +aps:DescribeRuleGroupsNamespace, +aps:TagResource, +aps:UntagResource, +aps:ListTagsForResource +``` + +### Delete +```json +aps:DeleteRuleGroupsNamespace, +aps:DescribeRuleGroupsNamespace +``` + diff --git a/docs/aws-docs/providers/aws/aps/rule_groups_namespaces/index.md b/docs/aws-docs/providers/aws/aps/rule_groups_namespaces/index.md new file mode 100644 index 0000000000..ba5e2c8949 --- /dev/null +++ b/docs/aws-docs/providers/aws/aps/rule_groups_namespaces/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionRuleGroupsNamespace schema for cloudformation.
Idaws.aps.rule_groups_namespaces
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe RuleGroupsNamespace ARN.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.aps.rule_groups_namespaces +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the rule_groups_namespaces resource, the following permissions are required: + +### Create +```json +aps:CreateRuleGroupsNamespace, +aps:DescribeRuleGroupsNamespace, +aps:TagResource +``` + +### List +```json +aps:ListRuleGroupsNamespaces, +aps:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/aps/scraper/index.md b/docs/aws-docs/providers/aws/aps/scraper/index.md new file mode 100644 index 0000000000..7bc605a14d --- /dev/null +++ b/docs/aws-docs/providers/aws/aps/scraper/index.md @@ -0,0 +1,112 @@ +--- +title: scraper +hide_title: false +hide_table_of_contents: false +keywords: + - scraper + - 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 scraper resource + +## Overview + + + + + +
Namescraper
TypeResource
DescriptionResource Type definition for AWS::APS::Scraper
Idaws.aps.scraper
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
scraper_idstringRequired to identify a specific scraper.
aliasstringScraper alias.
arnstringScraper ARN.
role_arnstringIAM role ARN for the scraper.
scrape_configurationobject
sourceobject
destinationobject
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +scraper_id, +alias, +arn, +role_arn, +scrape_configuration, +source, +destination, +tags +FROM aws.aps.scraper +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the scraper resource, the following permissions are required: + +### Read +```json +aps:DescribeScraper, +aps:ListTagsForResource +``` + +### Update +```json +aps:DescribeScraper, +aps:TagResource, +aps:UntagResource, +aps:ListTagsForResource +``` + +### Delete +```json +aps:DeleteScraper, +aps:DescribeScraper, +aps:DescribeWorkspace, +eks:AssociateAccessPolicy, +eks:DescribeCluster, +ec2:DescribeSubnets, +ec2:DescribeSecurityGroups, +iam:DeleteServiceLinkedRole +``` + diff --git a/docs/aws-docs/providers/aws/aps/scrapers/index.md b/docs/aws-docs/providers/aws/aps/scrapers/index.md new file mode 100644 index 0000000000..6122eabc11 --- /dev/null +++ b/docs/aws-docs/providers/aws/aps/scrapers/index.md @@ -0,0 +1,87 @@ +--- +title: scrapers +hide_title: false +hide_table_of_contents: false +keywords: + - scrapers + - 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 scrapers in a region + +## Overview + + + + + +
Namescrapers
TypeResource
DescriptionResource Type definition for AWS::APS::Scraper
Idaws.aps.scrapers
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringScraper ARN.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.aps.scrapers +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the scrapers resource, the following permissions are required: + +### Create +```json +aps:CreateScraper, +aps:DescribeScraper, +aps:DescribeWorkspace, +aps:TagResource, +eks:CreateAccessEntry, +eks:AssociateAccessPolicy, +eks:DescribeCluster, +ec2:DescribeSubnets, +ec2:DescribeSecurityGroups, +iam:CreateServiceLinkedRole +``` + +### List +```json +aps:ListScrapers, +aps:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/aps/workspace/index.md b/docs/aws-docs/providers/aws/aps/workspace/index.md new file mode 100644 index 0000000000..f504b0760d --- /dev/null +++ b/docs/aws-docs/providers/aws/aps/workspace/index.md @@ -0,0 +1,125 @@ +--- +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
DescriptionResource Type definition for AWS::APS::Workspace
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +workspace_id, +alias, +arn, +alert_manager_definition, +prometheus_endpoint, +logging_configuration, +kms_key_arn, +tags +FROM aws.aps.workspace +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the workspace resource, the following permissions are required: + +### Read +```json +aps:DescribeWorkspace, +aps:ListTagsForResource, +aps:DescribeAlertManagerDefinition, +aps:DescribeLoggingConfiguration +``` + +### Update +```json +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 +```json +aps:DeleteWorkspace, +aps:DescribeWorkspace, +aps:DeleteAlertManagerDefinition, +aps:DeleteLoggingConfiguration, +logs:DeleteLogDelivery +``` + diff --git a/docs/aws-docs/providers/aws/aps/workspaces/index.md b/docs/aws-docs/providers/aws/aps/workspaces/index.md new file mode 100644 index 0000000000..cfa48a8cbd --- /dev/null +++ b/docs/aws-docs/providers/aws/aps/workspaces/index.md @@ -0,0 +1,90 @@ +--- +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
DescriptionResource Type definition for AWS::APS::Workspace
Idaws.aps.workspaces
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringWorkspace arn.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.aps.workspaces +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the workspaces resource, the following permissions are required: + +### Create +```json +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 +```json +aps:ListWorkspaces, +aps:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/arczonalshift/index.md b/docs/aws-docs/providers/aws/arczonalshift/index.md new file mode 100644 index 0000000000..a8a5d7d53a --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/arczonalshift/zonal_autoshift_configuration/index.md b/docs/aws-docs/providers/aws/arczonalshift/zonal_autoshift_configuration/index.md new file mode 100644 index 0000000000..eec92fbcc8 --- /dev/null +++ b/docs/aws-docs/providers/aws/arczonalshift/zonal_autoshift_configuration/index.md @@ -0,0 +1,96 @@ +--- +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
DescriptionDefinition of AWS::ARCZonalShift::ZonalAutoshiftConfiguration Resource Type
Idaws.arczonalshift.zonal_autoshift_configuration
+ +## Fields + + + + + + + +
NameDatatypeDescription
zonal_autoshift_statusstring
practice_run_configurationobject
resource_identifierstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +zonal_autoshift_status, +practice_run_configuration, +resource_identifier +FROM aws.arczonalshift.zonal_autoshift_configuration +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the zonal_autoshift_configuration resource, the following permissions are required: + +### Read +```json +arc-zonal-shift:GetManagedResource +``` + +### Update +```json +arc-zonal-shift:GetManagedResource, +arc-zonal-shift:UpdatePracticeRunConfiguration, +arc-zonal-shift:UpdateZonalAutoshiftConfiguration, +cloudwatch:DescribeAlarms +``` + +### Delete +```json +arc-zonal-shift:DeletePracticeRunConfiguration, +arc-zonal-shift:GetManagedResource, +arc-zonal-shift:UpdateZonalAutoshiftConfiguration +``` + diff --git a/docs/aws-docs/providers/aws/arczonalshift/zonal_autoshift_configurations/index.md b/docs/aws-docs/providers/aws/arczonalshift/zonal_autoshift_configurations/index.md new file mode 100644 index 0000000000..5db279679b --- /dev/null +++ b/docs/aws-docs/providers/aws/arczonalshift/zonal_autoshift_configurations/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionDefinition of AWS::ARCZonalShift::ZonalAutoshiftConfiguration Resource Type
Idaws.arczonalshift.zonal_autoshift_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
resource_identifierstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +resource_identifier +FROM aws.arczonalshift.zonal_autoshift_configurations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the zonal_autoshift_configurations resource, the following permissions are required: + +### Create +```json +arc-zonal-shift:CreatePracticeRunConfiguration, +arc-zonal-shift:GetManagedResource, +arc-zonal-shift:UpdateZonalAutoshiftConfiguration, +cloudwatch:DescribeAlarms, +iam:CreateServiceLinkedRole +``` + +### List +```json +arc-zonal-shift:ListManagedResources +``` + diff --git a/docs/aws-docs/providers/aws/athena/capacity_reservation/index.md b/docs/aws-docs/providers/aws/athena/capacity_reservation/index.md new file mode 100644 index 0000000000..1a4a09313d --- /dev/null +++ b/docs/aws-docs/providers/aws/athena/capacity_reservation/index.md @@ -0,0 +1,111 @@ +--- +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
DescriptionResource schema for AWS::Athena::CapacityReservation
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +name, +status, +target_dpus, +allocated_dpus, +capacity_assignment_configuration, +creation_time, +last_successful_allocation_time, +tags +FROM aws.athena.capacity_reservation +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the capacity_reservation resource, the following permissions are required: + +### Read +```json +athena:GetCapacityReservation, +athena:GetCapacityAssignmentConfiguration, +athena:ListTagsForResource +``` + +### Update +```json +athena:UpdateCapacityReservation, +athena:PutCapacityAssignmentConfiguration, +athena:GetCapacityReservation, +athena:TagResource, +athena:UntagResource +``` + +### Delete +```json +athena:CancelCapacityReservation, +athena:GetCapacityReservation, +athena:DeleteCapacityReservation +``` + diff --git a/docs/aws-docs/providers/aws/athena/capacity_reservations/index.md b/docs/aws-docs/providers/aws/athena/capacity_reservations/index.md new file mode 100644 index 0000000000..c1efe63820 --- /dev/null +++ b/docs/aws-docs/providers/aws/athena/capacity_reservations/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionResource schema for AWS::Athena::CapacityReservation
Idaws.athena.capacity_reservations
+ +## Fields + + + + + +
NameDatatypeDescription
arnundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.athena.capacity_reservations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the capacity_reservations resource, the following permissions are required: + +### Create +```json +athena:CreateCapacityReservation, +athena:PutCapacityAssignmentConfiguration, +athena:GetCapacityReservation, +athena:TagResource +``` + +### List +```json +athena:ListCapacityReservations, +athena:GetCapacityReservation +``` + diff --git a/docs/aws-docs/providers/aws/athena/data_catalog/index.md b/docs/aws-docs/providers/aws/athena/data_catalog/index.md new file mode 100644 index 0000000000..5c83e19782 --- /dev/null +++ b/docs/aws-docs/providers/aws/athena/data_catalog/index.md @@ -0,0 +1,100 @@ +--- +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
DescriptionResource schema for AWS::Athena::DataCatalog
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +description, +parameters, +tags, +type +FROM aws.athena.data_catalog +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the data_catalog resource, the following permissions are required: + +### Read +```json +athena:GetDataCatalog, +athena:ListTagsForResource +``` + +### Update +```json +athena:UpdateDataCatalog, +athena:TagResource, +athena:GetDataCatalog, +athena:UntagResource, +athena:ListTagsForResource +``` + +### Delete +```json +athena:DeleteDataCatalog +``` + diff --git a/docs/aws-docs/providers/aws/athena/data_catalogs/index.md b/docs/aws-docs/providers/aws/athena/data_catalogs/index.md new file mode 100644 index 0000000000..890ce51c2e --- /dev/null +++ b/docs/aws-docs/providers/aws/athena/data_catalogs/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionResource schema for AWS::Athena::DataCatalog
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.athena.data_catalogs +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the data_catalogs resource, the following permissions are required: + +### Create +```json +athena:CreateDataCatalog, +athena:TagResource +``` + +### List +```json +athena:ListDataCatalog +``` + diff --git a/docs/aws-docs/providers/aws/athena/index.md b/docs/aws-docs/providers/aws/athena/index.md new file mode 100644 index 0000000000..27d7fb19ea --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/athena/named_queries/index.md b/docs/aws-docs/providers/aws/athena/named_queries/index.md new file mode 100644 index 0000000000..7dbe5dca36 --- /dev/null +++ b/docs/aws-docs/providers/aws/athena/named_queries/index.md @@ -0,0 +1,77 @@ +--- +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
DescriptionResource schema for AWS::Athena::NamedQuery
Idaws.athena.named_queries
+ +## Fields + + + + + +
NameDatatypeDescription
named_query_idstringThe unique ID of the query.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +named_query_id +FROM aws.athena.named_queries +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the named_queries resource, the following permissions are required: + +### Create +```json +athena:CreateNamedQuery +``` + +### List +```json +athena:ListNamedQueries +``` + diff --git a/docs/aws-docs/providers/aws/athena/named_query/index.md b/docs/aws-docs/providers/aws/athena/named_query/index.md new file mode 100644 index 0000000000..1a3b974149 --- /dev/null +++ b/docs/aws-docs/providers/aws/athena/named_query/index.md @@ -0,0 +1,87 @@ +--- +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
DescriptionResource schema for AWS::Athena::NamedQuery
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +database, +description, +query_string, +work_group, +named_query_id +FROM aws.athena.named_query +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the named_query resource, the following permissions are required: + +### Read +```json +athena:GetNamedQuery +``` + +### Delete +```json +athena:DeleteNamedQuery +``` + diff --git a/docs/aws-docs/providers/aws/athena/prepared_statement/index.md b/docs/aws-docs/providers/aws/athena/prepared_statement/index.md new file mode 100644 index 0000000000..835f3de892 --- /dev/null +++ b/docs/aws-docs/providers/aws/athena/prepared_statement/index.md @@ -0,0 +1,94 @@ +--- +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
DescriptionResource schema for AWS::Athena::PreparedStatement
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +statement_name, +work_group, +description, +query_statement +FROM aws.athena.prepared_statement +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the prepared_statement resource, the following permissions are required: + +### Read +```json +athena:GetPreparedStatement +``` + +### Update +```json +athena:UpdatePreparedStatement +``` + +### Delete +```json +athena:DeletePreparedStatement, +athena:GetPreparedStatement +``` + diff --git a/docs/aws-docs/providers/aws/athena/prepared_statements/index.md b/docs/aws-docs/providers/aws/athena/prepared_statements/index.md new file mode 100644 index 0000000000..3cb3583cf5 --- /dev/null +++ b/docs/aws-docs/providers/aws/athena/prepared_statements/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionResource schema for AWS::Athena::PreparedStatement
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +statement_name, +work_group +FROM aws.athena.prepared_statements +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the prepared_statements resource, the following permissions are required: + +### Create +```json +athena:CreatePreparedStatement, +athena:GetPreparedStatement +``` + +### List +```json +athena:ListPreparedStatements +``` + diff --git a/docs/aws-docs/providers/aws/athena/work_group/index.md b/docs/aws-docs/providers/aws/athena/work_group/index.md new file mode 100644 index 0000000000..239c8a9890 --- /dev/null +++ b/docs/aws-docs/providers/aws/athena/work_group/index.md @@ -0,0 +1,116 @@ +--- +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
DescriptionResource schema for AWS::Athena::WorkGroup
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +description, +tags, +work_group_configuration, +work_group_configuration_updates, +creation_time, +state, +recursive_delete_option +FROM aws.athena.work_group +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the work_group resource, the following permissions are required: + +### Read +```json +athena:GetWorkGroup, +athena:ListTagsForResource +``` + +### Delete +```json +athena:DeleteWorkGroup, +athena:GetWorkGroup, +athena:UntagResource +``` + +### Update +```json +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 +``` + diff --git a/docs/aws-docs/providers/aws/athena/work_groups/index.md b/docs/aws-docs/providers/aws/athena/work_groups/index.md new file mode 100644 index 0000000000..032378f261 --- /dev/null +++ b/docs/aws-docs/providers/aws/athena/work_groups/index.md @@ -0,0 +1,88 @@ +--- +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
DescriptionResource schema for AWS::Athena::WorkGroup
Idaws.athena.work_groups
+ +## Fields + + + + + +
NameDatatypeDescription
namestringThe workGroup name.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.athena.work_groups +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the work_groups resource, the following permissions are required: + +### Create +```json +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 +```json +athena:ListWorkGroups +``` + diff --git a/docs/aws-docs/providers/aws/auditmanager/assessment/index.md b/docs/aws-docs/providers/aws/auditmanager/assessment/index.md new file mode 100644 index 0000000000..33c0982773 --- /dev/null +++ b/docs/aws-docs/providers/aws/auditmanager/assessment/index.md @@ -0,0 +1,114 @@ +--- +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
DescriptionAn entity that defines the scope of audit evidence collected by AWS Audit Manager.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +framework_id, +assessment_id, +aws_account, +arn, +tags, +delegations, +roles, +scope, +assessment_reports_destination, +status, +creation_time, +name, +description +FROM aws.auditmanager.assessment +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the assessment resource, the following permissions are required: + +### Read +```json +auditmanager:GetAssessment +``` + +### Update +```json +auditmanager:UpdateAssessment, +auditmanager:UpdateAssessmentStatus, +auditmanager:BatchCreateDelegationByAssessment, +auditmanager:BatchDeleteDelegationByAssessment +``` + +### Delete +```json +auditmanager:DeleteAssessment +``` + diff --git a/docs/aws-docs/providers/aws/auditmanager/assessments/index.md b/docs/aws-docs/providers/aws/auditmanager/assessments/index.md new file mode 100644 index 0000000000..980c7069e2 --- /dev/null +++ b/docs/aws-docs/providers/aws/auditmanager/assessments/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionAn entity that defines the scope of audit evidence collected by AWS Audit Manager.
Idaws.auditmanager.assessments
+ +## Fields + + + + + +
NameDatatypeDescription
assessment_idundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +assessment_id +FROM aws.auditmanager.assessments +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the assessments resource, the following permissions are required: + +### Create +```json +auditmanager:CreateAssessment, +auditmanager:TagResource, +auditmanager:ListTagsForResource, +auditmanager:BatchCreateDelegationByAssessment, +iam:PassRole +``` + +### List +```json +auditmanager:ListAssessments +``` + diff --git a/docs/aws-docs/providers/aws/auditmanager/index.md b/docs/aws-docs/providers/aws/auditmanager/index.md new file mode 100644 index 0000000000..2576743718 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/autoscaling/auto_scaling_group/index.md b/docs/aws-docs/providers/aws/autoscaling/auto_scaling_group/index.md new file mode 100644 index 0000000000..4df32c98c7 --- /dev/null +++ b/docs/aws-docs/providers/aws/autoscaling/auto_scaling_group/index.md @@ -0,0 +1,177 @@ +--- +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
DescriptionThe ``AWS::AutoScaling::AutoScalingGroup`` resource defines an Amazon EC2 Auto Scaling group, which is a collection of Amazon EC2 instances that are treated as a logical grouping for the purposes of automatic scaling and management. <br/> For more information about Amazon EC2 Auto Scaling, see the [Amazon EC2 Auto Scaling User Guide](https://docs.aws.amazon.com/autoscaling/ec2/userguide/what-is-amazon-ec2-auto-scaling.html). <br/> Amazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a [launch template](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) or a launch configuration. We strongly recommend that you do not use launch configurations. They do not provide full functionality for Amazon EC2 Auto Scaling or Amazon EC2. For more information, see [Launch configurations](https://docs.aws.amazon.com/autoscaling/ec2/userguide/launch-configurations.html) and [Migrate CloudFormation stacks from launch configurations to launch templates](https://docs.aws.amazon.com/autoscaling/ec2/userguide/migrate-launch-configurations-with-cloudformation.html) in the *Amazon EC2 Auto Scaling User Guide*.
Idaws.autoscaling.auto_scaling_group
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
lifecycle_hook_specification_listarrayOne or more lifecycle hooks to add to the Auto Scaling group before instances are launched.
load_balancer_namesarrayA list of Classic Load Balancers associated with this Auto Scaling group. For Application Load Balancers, Network Load Balancers, and Gateway Load Balancers, specify the ``TargetGroupARNs`` property instead.
launch_configuration_namestringThe name of the launch configuration to use to launch instances.<br/> Required only if you don't specify ``LaunchTemplate``, ``MixedInstancesPolicy``, or ``InstanceId``.
service_linked_role_arnstringThe Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS service on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role named ``AWSServiceRoleForAutoScaling``, which it creates if it does not exist. For more information, see [Service-linked roles](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-service-linked-role.html) in the *Amazon EC2 Auto Scaling User Guide*.
target_group_arnsarrayThe Amazon Resource Names (ARN) of the Elastic Load Balancing target groups to associate with the Auto Scaling group. Instances are registered as targets with the target groups. The target groups receive incoming traffic and route requests to one or more registered targets. For more information, see [Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html) in the *Amazon EC2 Auto Scaling User Guide*.
cooldownstring*Only needed if you use simple scaling policies.* <br/> The amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. For more information, see [Scaling cooldowns for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html) in the *Amazon EC2 Auto Scaling User Guide*.<br/> Default: ``300`` seconds
notification_configurationsarrayConfigures an Auto Scaling group to send notifications when specified events take place.
desired_capacitystringThe desired capacity is the initial capacity of the Auto Scaling group at the time of its creation and the capacity it attempts to maintain. It can scale beyond this capacity if you configure automatic scaling.<br/> The number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group. If you do not specify a desired capacity when creating the stack, the default is the minimum size of the group.<br/> CloudFormation marks the Auto Scaling group as successful (by setting its status to CREATE_COMPLETE) when the desired capacity is reached. However, if a maximum Spot price is set in the launch template or launch configuration that you specified, then desired capacity is not used as a criteria for success. Whether your request is fulfilled depends on Spot Instance capacity and your maximum price.
health_check_grace_periodintegerThe amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service and marking it unhealthy due to a failed health check. This is useful if your instances do not immediately pass their health checks after they enter the ``InService`` state. For more information, see [Set the health check grace period for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/health-check-grace-period.html) in the *Amazon EC2 Auto Scaling User Guide*.<br/> Default: ``0`` seconds
default_instance_warmupintegerThe amount of time, in seconds, until a new instance is considered to have finished initializing and resource consumption to become stable after it enters the ``InService`` state. <br/> During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the warm-up period before aggregating the metrics for new instances with existing instances in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage data. For more information, see [Set the default instance warmup for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-default-instance-warmup.html) in the *Amazon EC2 Auto Scaling User Guide*.<br/> To manage various warm-up settings at the group level, we recommend that you set the default instance warmup, *even if it is set to 0 seconds*. To remove a value that you previously set, include the property but specify ``-1`` for the value. However, we strongly recommend keeping the default instance warmup enabled by specifying a value of ``0`` or other nominal value.<br/> Default: None
new_instances_protected_from_scale_inbooleanIndicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. For more information about preventing instances from terminating on scale in, see [Using instance scale-in protection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html) in the *Amazon EC2 Auto Scaling User Guide*.
launch_templateobjectInformation used to specify the launch template and version to use to launch instances. You can alternatively associate a launch template to the Auto Scaling group by specifying a ``MixedInstancesPolicy``. For more information about creating launch templates, see [Create a launch template for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) in the *Amazon EC2 Auto Scaling User Guide*.<br/> If you omit this property, you must specify ``MixedInstancesPolicy``, ``LaunchConfigurationName``, or ``InstanceId``.
mixed_instances_policyobjectAn embedded object that specifies a mixed instances policy.<br/> The policy includes properties that not only define the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances (optional), and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacities, but also the properties that specify the instance configuration information—the launch template and instance types. The policy can also include a weight for each instance type and different launch templates for individual instance types.<br/> For more information, see [Auto Scaling groups with multiple instance types and purchase options](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) in the *Amazon EC2 Auto Scaling User Guide*.
vpc_zone_identifierarrayA list of subnet IDs for a virtual private cloud (VPC) where instances in the Auto Scaling group can be created.<br/> If this resource specifies public subnets and is also in a VPC that is defined in the same stack template, you must use the [DependsOn attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) to declare a dependency on the [VPC-gateway attachment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc-gateway-attachment.html).<br/> When you update ``VPCZoneIdentifier``, this retains the same Auto Scaling group and replaces old instances with new ones, according to the specified subnets. You can optionally specify how CloudFormation handles these updates by using an [UpdatePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html).<br/> Required to launch instances into a nondefault VPC. If you specify ``VPCZoneIdentifier`` with ``AvailabilityZones``, the subnets that you specify for this property must reside in those Availability Zones.
tagsarrayOne or more tags. You can tag your Auto Scaling group and propagate the tags to the Amazon EC2 instances it launches. Tags are not propagated to Amazon EBS volumes. To add tags to Amazon EBS volumes, specify the tags in a launch template but use caution. If the launch template specifies an instance tag with a key that is also specified for the Auto Scaling group, Amazon EC2 Auto Scaling overrides the value of that instance tag with the value specified by the Auto Scaling group. For more information, see [Tag Auto Scaling groups and instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-tagging.html) in the *Amazon EC2 Auto Scaling User Guide*.
contextstringReserved.
capacity_rebalancebooleanIndicates whether Capacity Rebalancing is enabled. Otherwise, Capacity Rebalancing is disabled. When you turn on Capacity Rebalancing, Amazon EC2 Auto Scaling attempts to launch a Spot Instance whenever Amazon EC2 notifies that a Spot Instance is at an elevated risk of interruption. After launching a new instance, it then terminates an old instance. For more information, see [Use Capacity Rebalancing to handle Amazon EC2 Spot Interruptions](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-capacity-rebalancing.html) in the in the *Amazon EC2 Auto Scaling User Guide*.
instance_idstringThe ID of the instance used to base the launch configuration on. For more information, see [Create an Auto Scaling group using an EC2 instance](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-from-instance.html) in the *Amazon EC2 Auto Scaling User Guide*.<br/> If you specify ``LaunchTemplate``, ``MixedInstancesPolicy``, or ``LaunchConfigurationName``, don't specify ``InstanceId``.
availability_zonesarrayA list of Availability Zones where instances in the Auto Scaling group can be created. Used for launching into the default VPC subnet in each Availability Zone when not using the ``VPCZoneIdentifier`` property, or for attaching a network interface when an existing network interface ID is specified in a launch template.
notification_configurationobject
metrics_collectionarrayEnables the monitoring of group metrics of an Auto Scaling group. By default, these metrics are disabled.
instance_maintenance_policyobjectAn instance maintenance policy. For more information, see [Set instance maintenance policy](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-maintenance-policy.html) in the *Amazon EC2 Auto Scaling User Guide*.
max_sizestringThe maximum size of the group.<br/> With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to go above ``MaxSize`` to meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will never go above ``MaxSize`` by more than your largest instance weight (weights that define how many units each instance contributes to the desired capacity of the group).
min_sizestringThe minimum size of the group.
termination_policiesarrayA policy or a list of policies that are used to select the instance to terminate. These policies are executed in the order that you list them. For more information, see [Work with Amazon EC2 Auto Scaling termination policies](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html) in the *Amazon EC2 Auto Scaling User Guide*.<br/> Valid values: ``Default`` | ``AllocationStrategy`` | ``ClosestToNextInstanceHour`` | ``NewestInstance`` | ``OldestInstance`` | ``OldestLaunchConfiguration`` | ``OldestLaunchTemplate`` | ``arn:aws:lambda:region:account-id:function:my-function:my-alias``
auto_scaling_group_namestringThe name of the Auto Scaling group. This name must be unique per Region per account.<br/> The name can contain any ASCII character 33 to 126 including most punctuation characters, digits, and upper and lowercased letters.<br/> You cannot use a colon (:) in the name.
desired_capacity_typestringThe unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports ``DesiredCapacityType`` for attribute-based instance type selection only. For more information, see [Creating an Auto Scaling group using attribute-based instance type selection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html) in the *Amazon EC2 Auto Scaling User Guide*.<br/> By default, Amazon EC2 Auto Scaling specifies ``units``, which translates into number of instances.<br/> Valid values: ``units`` | ``vcpu`` | ``memory-mib``
placement_groupstringThe name of the placement group into which to launch your instances. For more information, see [Placement groups](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) in the *Amazon EC2 User Guide for Linux Instances*.<br/> A *cluster* placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a cluster placement group.
health_check_typestringA comma-separated value string of one or more health check types.<br/> The valid values are ``EC2``, ``ELB``, and ``VPC_LATTICE``. ``EC2`` is the default health check and cannot be disabled. For more information, see [Health checks for Auto Scaling instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html) in the *Amazon EC2 Auto Scaling User Guide*.<br/> Only specify ``EC2`` if you must clear a value that was previously set.
max_instance_lifetimeintegerThe maximum amount of time, in seconds, that an instance can be in service. The default is null. If specified, the value must be either 0 or a number equal to or greater than 86,400 seconds (1 day). For more information, see [Replacing Auto Scaling instances based on maximum instance lifetime](https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html) in the *Amazon EC2 Auto Scaling User Guide*.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +lifecycle_hook_specification_list, +load_balancer_names, +launch_configuration_name, +service_linked_role_arn, +target_group_arns, +cooldown, +notification_configurations, +desired_capacity, +health_check_grace_period, +default_instance_warmup, +new_instances_protected_from_scale_in, +launch_template, +mixed_instances_policy, +vpc_zone_identifier, +tags, +context, +capacity_rebalance, +instance_id, +availability_zones, +notification_configuration, +metrics_collection, +instance_maintenance_policy, +max_size, +min_size, +termination_policies, +auto_scaling_group_name, +desired_capacity_type, +placement_group, +health_check_type, +max_instance_lifetime +FROM aws.autoscaling.auto_scaling_group +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the auto_scaling_group resource, the following permissions are required: + +### Read +```json +autoscaling:Describe*, +managed-fleets:Get* +``` + +### Update +```json +autoscaling:UpdateAutoScalingGroup, +autoscaling:CreateOrUpdateTags, +autoscaling:DeleteTags, +autoscaling:Describe*, +autoscaling:EnableMetricsCollection, +autoscaling:DisableMetricsCollection, +autoscaling:PutNotificationConfiguration, +autoscaling:DeleteNotificationConfiguration, +autoscaling:DetachLoadBalancerTargetGroups, +autoscaling:AttachLoadBalancerTargetGroups, +autoscaling:AttachLoadBalancers, +autoscaling:DetachLoadBalancers, +autoscaling:AttachTrafficSources, +autoscaling:DetachTrafficSources, +autoscaling:DeleteLifecycleHook, +autoscaling:PutLifecycleHook, +cloudwatch:PutMetricAlarm, +ec2:Describe*, +ec2:Get*, +ec2:RunInstances, +elasticloadbalancing:Describe*, +iam:CreateServiceLinkedRole, +iam:PassRole, +managed-fleets:Get*, +managed-fleets:RegisterAutoScalingGroup, +managed-fleets:DeregisterAutoScalingGroup, +managed-fleets:UpdateAutoScalingGroup, +ssm:Get* +``` + +### Delete +```json +autoscaling:DeleteAutoScalingGroup, +autoscaling:UpdateAutoScalingGroup, +autoscaling:Describe*, +managed-fleets:Get*, +managed-fleets:DeleteAutoScalingGroup +``` + diff --git a/docs/aws-docs/providers/aws/autoscaling/auto_scaling_groups/index.md b/docs/aws-docs/providers/aws/autoscaling/auto_scaling_groups/index.md new file mode 100644 index 0000000000..c1cc67aca5 --- /dev/null +++ b/docs/aws-docs/providers/aws/autoscaling/auto_scaling_groups/index.md @@ -0,0 +1,93 @@ +--- +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
DescriptionThe ``AWS::AutoScaling::AutoScalingGroup`` resource defines an Amazon EC2 Auto Scaling group, which is a collection of Amazon EC2 instances that are treated as a logical grouping for the purposes of automatic scaling and management. <br/> For more information about Amazon EC2 Auto Scaling, see the [Amazon EC2 Auto Scaling User Guide](https://docs.aws.amazon.com/autoscaling/ec2/userguide/what-is-amazon-ec2-auto-scaling.html). <br/> Amazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a [launch template](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) or a launch configuration. We strongly recommend that you do not use launch configurations. They do not provide full functionality for Amazon EC2 Auto Scaling or Amazon EC2. For more information, see [Launch configurations](https://docs.aws.amazon.com/autoscaling/ec2/userguide/launch-configurations.html) and [Migrate CloudFormation stacks from launch configurations to launch templates](https://docs.aws.amazon.com/autoscaling/ec2/userguide/migrate-launch-configurations-with-cloudformation.html) in the *Amazon EC2 Auto Scaling User Guide*.
Idaws.autoscaling.auto_scaling_groups
+ +## Fields + + + + + +
NameDatatypeDescription
auto_scaling_group_namestringThe name of the Auto Scaling group. This name must be unique per Region per account.<br/> The name can contain any ASCII character 33 to 126 including most punctuation characters, digits, and upper and lowercased letters.<br/> You cannot use a colon (:) in the name.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +auto_scaling_group_name +FROM aws.autoscaling.auto_scaling_groups +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the auto_scaling_groups resource, the following permissions are required: + +### Create +```json +autoscaling:CreateAutoScalingGroup, +autoscaling:UpdateAutoScalingGroup, +autoscaling:CreateOrUpdateTags, +autoscaling:Describe*, +autoscaling:EnableMetricsCollection, +autoscaling:PutNotificationConfiguration, +cloudwatch:PutMetricAlarm, +ec2:Describe*, +ec2:Get*, +ec2:RunInstances, +elasticloadbalancing:Describe*, +iam:CreateServiceLinkedRole, +iam:PassRole, +managed-fleets:Get*, +managed-fleets:CreateAutoScalingGroup, +managed-fleets:UpdateAutoScalingGroup, +ssm:Get* +``` + +### List +```json +autoscaling:Describe* +``` + diff --git a/docs/aws-docs/providers/aws/autoscaling/index.md b/docs/aws-docs/providers/aws/autoscaling/index.md new file mode 100644 index 0000000000..68df10b374 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/autoscaling/launch_configuration/index.md b/docs/aws-docs/providers/aws/autoscaling/launch_configuration/index.md new file mode 100644 index 0000000000..67aec7b7d5 --- /dev/null +++ b/docs/aws-docs/providers/aws/autoscaling/launch_configuration/index.md @@ -0,0 +1,114 @@ +--- +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
DescriptionThe AWS::AutoScaling::LaunchConfiguration resource specifies the launch configuration that can be used by an Auto Scaling group to configure Amazon EC2 instances.
Idaws.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_vpc_idstringThe ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to.
classic_link_vpc_security_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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +associate_public_ip_address, +block_device_mappings, +classic_link_vpc_id, +classic_link_vpc_security_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 aws.autoscaling.launch_configuration +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the launch_configuration resource, the following permissions are required: + +### Read +```json +autoscaling:DescribeLaunchConfigurations +``` + +### Delete +```json +autoscaling:DeleteLaunchConfiguration, +autoscaling:DescribeLaunchConfigurations +``` + diff --git a/docs/aws-docs/providers/aws/autoscaling/launch_configurations/index.md b/docs/aws-docs/providers/aws/autoscaling/launch_configurations/index.md new file mode 100644 index 0000000000..aea78ea2d1 --- /dev/null +++ b/docs/aws-docs/providers/aws/autoscaling/launch_configurations/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionThe AWS::AutoScaling::LaunchConfiguration resource specifies the launch configuration that can be used by an Auto Scaling group to configure Amazon EC2 instances.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +launch_configuration_name +FROM aws.autoscaling.launch_configurations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the launch_configurations resource, the following permissions are required: + +### Create +```json +autoscaling:CreateLaunchConfiguration, +autoscaling:DescribeLaunchConfigurations, +iam:PassRole +``` + +### List +```json +autoscaling:DescribeLaunchConfigurations +``` + diff --git a/docs/aws-docs/providers/aws/autoscaling/lifecycle_hook/index.md b/docs/aws-docs/providers/aws/autoscaling/lifecycle_hook/index.md new file mode 100644 index 0000000000..33eb68ccf5 --- /dev/null +++ b/docs/aws-docs/providers/aws/autoscaling/lifecycle_hook/index.md @@ -0,0 +1,104 @@ +--- +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
DescriptionResource Type definition for AWS::AutoScaling::LifecycleHook
Idaws.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_arnstringThe 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_arnstringThe 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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +auto_scaling_group_name, +default_result, +heartbeat_timeout, +lifecycle_hook_name, +lifecycle_transition, +notification_metadata, +notification_target_arn, +role_arn +FROM aws.autoscaling.lifecycle_hook +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the lifecycle_hook resource, the following permissions are required: + +### Read +```json +autoscaling:DescribeLifecycleHooks +``` + +### Update +```json +autoscaling:PutLifecycleHook, +autoscaling:DescribeLifecycleHooks, +iam:PassRole +``` + +### Delete +```json +autoscaling:DeleteLifecycleHook, +autoscaling:DescribeLifecycleHooks +``` + diff --git a/docs/aws-docs/providers/aws/autoscaling/lifecycle_hooks/index.md b/docs/aws-docs/providers/aws/autoscaling/lifecycle_hooks/index.md new file mode 100644 index 0000000000..2bd0be4027 --- /dev/null +++ b/docs/aws-docs/providers/aws/autoscaling/lifecycle_hooks/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionResource Type definition for AWS::AutoScaling::LifecycleHook
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +auto_scaling_group_name, +lifecycle_hook_name +FROM aws.autoscaling.lifecycle_hooks +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the lifecycle_hooks resource, the following permissions are required: + +### Create +```json +autoscaling:PutLifecycleHook, +autoscaling:DescribeLifecycleHooks, +iam:PassRole +``` + +### List +```json +autoscaling:DescribeLifecycleHooks +``` + diff --git a/docs/aws-docs/providers/aws/autoscaling/scaling_policies/index.md b/docs/aws-docs/providers/aws/autoscaling/scaling_policies/index.md new file mode 100644 index 0000000000..805ea47b3a --- /dev/null +++ b/docs/aws-docs/providers/aws/autoscaling/scaling_policies/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionThe AWS::AutoScaling::ScalingPolicy resource specifies an Amazon EC2 Auto Scaling scaling policy so that the Auto Scaling group can scale the number of instances available for your application.
Idaws.autoscaling.scaling_policies
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe ARN of the AutoScaling scaling policy
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.autoscaling.scaling_policies +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the scaling_policies resource, the following permissions are required: + +### Create +```json +autoscaling:DescribePolicies, +autoscaling:PutScalingPolicy, +cloudwatch:GetMetricData +``` + +### List +```json +autoscaling:DescribePolicies +``` + diff --git a/docs/aws-docs/providers/aws/autoscaling/scaling_policy/index.md b/docs/aws-docs/providers/aws/autoscaling/scaling_policy/index.md new file mode 100644 index 0000000000..7e4ccafe64 --- /dev/null +++ b/docs/aws-docs/providers/aws/autoscaling/scaling_policy/index.md @@ -0,0 +1,114 @@ +--- +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
DescriptionThe AWS::AutoScaling::ScalingPolicy resource specifies an Amazon EC2 Auto Scaling scaling policy so that the Auto Scaling group can scale the number of instances available for your application.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.autoscaling.scaling_policy +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the scaling_policy resource, the following permissions are required: + +### Read +```json +autoscaling:DescribePolicies +``` + +### Update +```json +autoscaling:DescribePolicies, +autoscaling:PutScalingPolicy, +cloudwatch:GetMetricData +``` + +### Delete +```json +autoscaling:DeletePolicy, +autoscaling:DescribePolicies +``` + diff --git a/docs/aws-docs/providers/aws/autoscaling/scheduled_action/index.md b/docs/aws-docs/providers/aws/autoscaling/scheduled_action/index.md new file mode 100644 index 0000000000..f6a48882be --- /dev/null +++ b/docs/aws-docs/providers/aws/autoscaling/scheduled_action/index.md @@ -0,0 +1,104 @@ +--- +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
DescriptionThe AWS::AutoScaling::ScheduledAction resource specifies an Amazon EC2 Auto Scaling scheduled action so that the Auto Scaling group can change the number of instances available for your application in response to predictable load changes.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.autoscaling.scheduled_action +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the scheduled_action resource, the following permissions are required: + +### Read +```json +autoscaling:DescribeScheduledActions +``` + +### Update +```json +autoscaling:PutScheduledUpdateGroupAction +``` + +### Delete +```json +autoscaling:DeleteScheduledAction, +autoscaling:DescribeScheduledActions +``` + diff --git a/docs/aws-docs/providers/aws/autoscaling/scheduled_actions/index.md b/docs/aws-docs/providers/aws/autoscaling/scheduled_actions/index.md new file mode 100644 index 0000000000..ab5a2f1053 --- /dev/null +++ b/docs/aws-docs/providers/aws/autoscaling/scheduled_actions/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionThe AWS::AutoScaling::ScheduledAction resource specifies an Amazon EC2 Auto Scaling scheduled action so that the Auto Scaling group can change the number of instances available for your application in response to predictable load changes.
Idaws.autoscaling.scheduled_actions
+ +## Fields + + + + + + +
NameDatatypeDescription
scheduled_action_namestringAuto-generated unique identifier
auto_scaling_group_namestringThe name of the Auto Scaling group.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +scheduled_action_name, +auto_scaling_group_name +FROM aws.autoscaling.scheduled_actions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the scheduled_actions resource, the following permissions are required: + +### Create +```json +autoscaling:PutScheduledUpdateGroupAction, +autoscaling:DescribeScheduledActions +``` + +### List +```json +autoscaling:DescribeScheduledActions +``` + diff --git a/docs/aws-docs/providers/aws/autoscaling/warm_pool/index.md b/docs/aws-docs/providers/aws/autoscaling/warm_pool/index.md new file mode 100644 index 0000000000..ffed3dfbaf --- /dev/null +++ b/docs/aws-docs/providers/aws/autoscaling/warm_pool/index.md @@ -0,0 +1,98 @@ +--- +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
DescriptionResource schema for AWS::AutoScaling::WarmPool.
Idaws.autoscaling.warm_pool
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
auto_scaling_group_namestring
max_group_prepared_capacityinteger
min_sizeinteger
pool_statestring
instance_reuse_policyobject
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +auto_scaling_group_name, +max_group_prepared_capacity, +min_size, +pool_state, +instance_reuse_policy +FROM aws.autoscaling.warm_pool +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the warm_pool resource, the following permissions are required: + +### Delete +```json +autoscaling:DeleteWarmPool, +autoscaling:DescribeWarmPool +``` + +### Read +```json +autoscaling:DescribeWarmPool +``` + +### Update +```json +autoscaling:PutWarmPool, +autoscaling:DescribeWarmPool, +autoscaling:DescribeAutoScalingGroups +``` + diff --git a/docs/aws-docs/providers/aws/autoscaling/warm_pools/index.md b/docs/aws-docs/providers/aws/autoscaling/warm_pools/index.md new file mode 100644 index 0000000000..3360bc5749 --- /dev/null +++ b/docs/aws-docs/providers/aws/autoscaling/warm_pools/index.md @@ -0,0 +1,69 @@ +--- +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
DescriptionResource schema for AWS::AutoScaling::WarmPool.
Idaws.autoscaling.warm_pools
+ +## Fields + + + + + +
NameDatatypeDescription
auto_scaling_group_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +auto_scaling_group_name +FROM aws.autoscaling.warm_pools +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the warm_pools resource, the following permissions are required: + +### Create +```json +autoscaling:PutWarmPool, +autoscaling:DescribeWarmPool, +autoscaling:DescribeAutoScalingGroups +``` + diff --git a/docs/aws-docs/providers/aws/b2bi/capabilities/index.md b/docs/aws-docs/providers/aws/b2bi/capabilities/index.md new file mode 100644 index 0000000000..f7c53f2ed0 --- /dev/null +++ b/docs/aws-docs/providers/aws/b2bi/capabilities/index.md @@ -0,0 +1,92 @@ +--- +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
DescriptionDefinition of AWS::B2BI::Capability Resource Type
Idaws.b2bi.capabilities
+ +## Fields + + + + + +
NameDatatypeDescription
capability_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +capability_id +FROM aws.b2bi.capabilities +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the capabilities resource, the following permissions are required: + +### Create +```json +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 +```json +b2bi:ListCapabilities +``` + diff --git a/docs/aws-docs/providers/aws/b2bi/capability/index.md b/docs/aws-docs/providers/aws/b2bi/capability/index.md new file mode 100644 index 0000000000..962b04c2a8 --- /dev/null +++ b/docs/aws-docs/providers/aws/b2bi/capability/index.md @@ -0,0 +1,106 @@ +--- +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
DescriptionDefinition of AWS::B2BI::Capability Resource Type
Idaws.b2bi.capability
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
capability_arnstring
capability_idstring
configurationundefined
created_atstring
instructions_documentsarray
modified_atstring
namestring
tagsarray
typestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +capability_arn, +capability_id, +configuration, +created_at, +instructions_documents, +modified_at, +name, +tags, +type +FROM aws.b2bi.capability +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the capability resource, the following permissions are required: + +### Read +```json +b2bi:GetCapability, +b2bi:ListTagsForResource +``` + +### Update +```json +b2bi:TagResource, +b2bi:UntagResource, +b2bi:UpdateCapability +``` + +### Delete +```json +b2bi:DeleteCapability +``` + diff --git a/docs/aws-docs/providers/aws/b2bi/index.md b/docs/aws-docs/providers/aws/b2bi/index.md new file mode 100644 index 0000000000..017a720b9b --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/b2bi/partnership/index.md b/docs/aws-docs/providers/aws/b2bi/partnership/index.md new file mode 100644 index 0000000000..5b2be0c8b1 --- /dev/null +++ b/docs/aws-docs/providers/aws/b2bi/partnership/index.md @@ -0,0 +1,110 @@ +--- +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
DescriptionDefinition of AWS::B2BI::Partnership Resource Type
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +capabilities, +created_at, +email, +modified_at, +name, +partnership_arn, +partnership_id, +phone, +profile_id, +tags, +trading_partner_id +FROM aws.b2bi.partnership +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the partnership resource, the following permissions are required: + +### Read +```json +b2bi:GetPartnership, +b2bi:ListTagsForResource +``` + +### Update +```json +b2bi:TagResource, +b2bi:UntagResource, +b2bi:UpdatePartnership +``` + +### Delete +```json +b2bi:DeletePartnership +``` + diff --git a/docs/aws-docs/providers/aws/b2bi/partnerships/index.md b/docs/aws-docs/providers/aws/b2bi/partnerships/index.md new file mode 100644 index 0000000000..41bc9bff61 --- /dev/null +++ b/docs/aws-docs/providers/aws/b2bi/partnerships/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionDefinition of AWS::B2BI::Partnership Resource Type
Idaws.b2bi.partnerships
+ +## Fields + + + + + +
NameDatatypeDescription
partnership_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +partnership_id +FROM aws.b2bi.partnerships +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the partnerships resource, the following permissions are required: + +### Create +```json +b2bi:CreatePartnership, +b2bi:TagResource, +s3:PutObject +``` + +### List +```json +b2bi:ListPartnerships +``` + diff --git a/docs/aws-docs/providers/aws/b2bi/profile/index.md b/docs/aws-docs/providers/aws/b2bi/profile/index.md new file mode 100644 index 0000000000..72901d3a33 --- /dev/null +++ b/docs/aws-docs/providers/aws/b2bi/profile/index.md @@ -0,0 +1,112 @@ +--- +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
DescriptionDefinition of AWS::B2BI::Profile Resource Type
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +business_name, +created_at, +email, +log_group_name, +logging, +modified_at, +name, +phone, +profile_arn, +profile_id, +tags +FROM aws.b2bi.profile +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the profile resource, the following permissions are required: + +### Read +```json +b2bi:GetProfile, +b2bi:ListTagsForResource +``` + +### Update +```json +b2bi:TagResource, +b2bi:UntagResource, +b2bi:UpdateProfile +``` + +### Delete +```json +b2bi:DeleteProfile, +logs:DeleteLogDelivery, +logs:ListLogDeliveries +``` + diff --git a/docs/aws-docs/providers/aws/b2bi/profiles/index.md b/docs/aws-docs/providers/aws/b2bi/profiles/index.md new file mode 100644 index 0000000000..0b0b8b620a --- /dev/null +++ b/docs/aws-docs/providers/aws/b2bi/profiles/index.md @@ -0,0 +1,87 @@ +--- +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
DescriptionDefinition of AWS::B2BI::Profile Resource Type
Idaws.b2bi.profiles
+ +## Fields + + + + + +
NameDatatypeDescription
profile_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +profile_id +FROM aws.b2bi.profiles +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the profiles resource, the following permissions are required: + +### Create +```json +b2bi:CreateProfile, +b2bi:TagResource, +logs:CreateLogDelivery, +logs:CreateLogGroup, +logs:CreateLogStream, +logs:DescribeLogGroups, +logs:DescribeLogStreams, +logs:DescribeResourcePolicies, +logs:ListLogDeliveries, +logs:PutLogEvents, +logs:PutResourcePolicy +``` + +### List +```json +b2bi:ListProfiles +``` + diff --git a/docs/aws-docs/providers/aws/b2bi/transformer/index.md b/docs/aws-docs/providers/aws/b2bi/transformer/index.md new file mode 100644 index 0000000000..33e43a9f53 --- /dev/null +++ b/docs/aws-docs/providers/aws/b2bi/transformer/index.md @@ -0,0 +1,112 @@ +--- +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
DescriptionDefinition of AWS::B2BI::Transformer Resource Type
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +created_at, +edi_type, +file_format, +mapping_template, +modified_at, +name, +sample_document, +status, +tags, +transformer_arn, +transformer_id +FROM aws.b2bi.transformer +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the transformer resource, the following permissions are required: + +### Read +```json +b2bi:GetTransformer, +b2bi:ListTagsForResource +``` + +### Update +```json +b2bi:TagResource, +b2bi:UntagResource, +b2bi:UpdateTransformer +``` + +### Delete +```json +b2bi:DeleteTransformer, +logs:DeleteLogDelivery, +logs:ListLogDeliveries +``` + diff --git a/docs/aws-docs/providers/aws/b2bi/transformers/index.md b/docs/aws-docs/providers/aws/b2bi/transformers/index.md new file mode 100644 index 0000000000..87df1fc8ea --- /dev/null +++ b/docs/aws-docs/providers/aws/b2bi/transformers/index.md @@ -0,0 +1,88 @@ +--- +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
DescriptionDefinition of AWS::B2BI::Transformer Resource Type
Idaws.b2bi.transformers
+ +## Fields + + + + + +
NameDatatypeDescription
transformer_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +transformer_id +FROM aws.b2bi.transformers +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the transformers resource, the following permissions are required: + +### Create +```json +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 +```json +b2bi:ListTransformers +``` + diff --git a/docs/aws-docs/providers/aws/backup/backup_plan/index.md b/docs/aws-docs/providers/aws/backup/backup_plan/index.md new file mode 100644 index 0000000000..e484fb47a4 --- /dev/null +++ b/docs/aws-docs/providers/aws/backup/backup_plan/index.md @@ -0,0 +1,100 @@ +--- +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
DescriptionResource Type definition for AWS::Backup::BackupPlan
Idaws.backup.backup_plan
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
backup_planobject
backup_plan_tagsobject
backup_plan_arnstring
backup_plan_idstring
version_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +backup_plan, +backup_plan_tags, +backup_plan_arn, +backup_plan_id, +version_id +FROM aws.backup.backup_plan +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the backup_plan resource, the following permissions are required: + +### Read +```json +backup:GetBackupPlan, +backup:ListTags +``` + +### Delete +```json +backup:GetBackupPlan, +backup:DeleteBackupPlan +``` + +### Update +```json +backup:UpdateBackupPlan, +backup:ListTags, +backup:TagResource, +backup:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/backup/backup_plans/index.md b/docs/aws-docs/providers/aws/backup/backup_plans/index.md new file mode 100644 index 0000000000..3fb980c19b --- /dev/null +++ b/docs/aws-docs/providers/aws/backup/backup_plans/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource Type definition for AWS::Backup::BackupPlan
Idaws.backup.backup_plans
+ +## Fields + + + + + +
NameDatatypeDescription
backup_plan_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +backup_plan_id +FROM aws.backup.backup_plans +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the backup_plans resource, the following permissions are required: + +### Create +```json +backup:GetBackupPlan, +backup:TagResource, +backup:CreateBackupPlan +``` + +### List +```json +backup:ListBackupPlans +``` + diff --git a/docs/aws-docs/providers/aws/backup/backup_selection/index.md b/docs/aws-docs/providers/aws/backup/backup_selection/index.md new file mode 100644 index 0000000000..dcb011d4d6 --- /dev/null +++ b/docs/aws-docs/providers/aws/backup/backup_selection/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionResource Type definition for AWS::Backup::BackupSelection
Idaws.backup.backup_selection
+ +## Fields + + + + + + + + +
NameDatatypeDescription
idstring
backup_plan_idstring
backup_selectionobject
selection_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +backup_plan_id, +backup_selection, +selection_id +FROM aws.backup.backup_selection +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the backup_selection resource, the following permissions are required: + +### Delete +```json +backup:GetBackupSelection, +backup:DeleteBackupSelection +``` + +### Read +```json +backup:GetBackupSelection +``` + diff --git a/docs/aws-docs/providers/aws/backup/backup_selections/index.md b/docs/aws-docs/providers/aws/backup/backup_selections/index.md new file mode 100644 index 0000000000..621469b99f --- /dev/null +++ b/docs/aws-docs/providers/aws/backup/backup_selections/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionResource Type definition for AWS::Backup::BackupSelection
Idaws.backup.backup_selections
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.backup.backup_selections +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the backup_selections resource, the following permissions are required: + +### Create +```json +backup:CreateBackupSelection, +iam:GetRole, +iam:PassRole, +iam:CreateServiceLinkedRole +``` + +### List +```json +backup:ListBackupSelections +``` + diff --git a/docs/aws-docs/providers/aws/backup/backup_vault/index.md b/docs/aws-docs/providers/aws/backup/backup_vault/index.md new file mode 100644 index 0000000000..6f0ec757e6 --- /dev/null +++ b/docs/aws-docs/providers/aws/backup/backup_vault/index.md @@ -0,0 +1,111 @@ +--- +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
DescriptionResource Type definition for AWS::Backup::BackupVault
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +access_policy, +backup_vault_name, +backup_vault_tags, +encryption_key_arn, +notifications, +lock_configuration, +backup_vault_arn +FROM aws.backup.backup_vault +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the backup_vault resource, the following permissions are required: + +### Read +```json +backup:DescribeBackupVault, +backup:GetBackupVaultNotifications, +backup:GetBackupVaultAccessPolicy, +backup:ListTags +``` + +### Update +```json +backup:DescribeBackupVault, +backup:DeleteBackupVaultAccessPolicy, +backup:DeleteBackupVaultNotifications, +backup:DeleteBackupVaultLockConfiguration, +backup:ListTags, +backup:TagResource, +backup:UntagResource, +backup:PutBackupVaultAccessPolicy, +backup:PutBackupVaultNotifications, +backup:PutBackupVaultLockConfiguration +``` + +### Delete +```json +backup:DeleteBackupVault +``` + diff --git a/docs/aws-docs/providers/aws/backup/backup_vaults/index.md b/docs/aws-docs/providers/aws/backup/backup_vaults/index.md new file mode 100644 index 0000000000..cb6f5fbe17 --- /dev/null +++ b/docs/aws-docs/providers/aws/backup/backup_vaults/index.md @@ -0,0 +1,88 @@ +--- +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
DescriptionResource Type definition for AWS::Backup::BackupVault
Idaws.backup.backup_vaults
+ +## Fields + + + + + +
NameDatatypeDescription
backup_vault_nameundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +backup_vault_name +FROM aws.backup.backup_vaults +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the backup_vaults resource, the following permissions are required: + +### Create +```json +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 +```json +backup:ListBackupVaults +``` + diff --git a/docs/aws-docs/providers/aws/backup/framework/index.md b/docs/aws-docs/providers/aws/backup/framework/index.md new file mode 100644 index 0000000000..aa85ee1634 --- /dev/null +++ b/docs/aws-docs/providers/aws/backup/framework/index.md @@ -0,0 +1,107 @@ +--- +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
DescriptionContains detailed information about a framework. Frameworks contain controls, which evaluate and report on your backup events and resources. Frameworks generate daily compliance results.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +framework_name, +framework_description, +framework_arn, +deployment_status, +creation_time, +framework_controls, +framework_status, +framework_tags +FROM aws.backup.framework +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the framework resource, the following permissions are required: + +### Read +```json +backup:DescribeFramework, +backup:ListTags +``` + +### Update +```json +backup:DescribeFramework, +backup:UpdateFramework, +backup:ListTags, +backup:TagResource, +backup:UntagResource +``` + +### Delete +```json +backup:DeleteFramework, +backup:DescribeFramework +``` + diff --git a/docs/aws-docs/providers/aws/backup/frameworks/index.md b/docs/aws-docs/providers/aws/backup/frameworks/index.md new file mode 100644 index 0000000000..d42bf82d0b --- /dev/null +++ b/docs/aws-docs/providers/aws/backup/frameworks/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionContains detailed information about a framework. Frameworks contain controls, which evaluate and report on your backup events and resources. Frameworks generate daily compliance results.
Idaws.backup.frameworks
+ +## Fields + + + + + +
NameDatatypeDescription
framework_arnstringAn Amazon Resource Name (ARN) that uniquely identifies Framework as a resource
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +framework_arn +FROM aws.backup.frameworks +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the frameworks resource, the following permissions are required: + +### Create +```json +backup:CreateFramework, +backup:DescribeFramework, +backup:ListTags, +backup:TagResource, +iam:CreateServiceLinkedRole +``` + +### List +```json +backup:ListFrameworks +``` + diff --git a/docs/aws-docs/providers/aws/backup/index.md b/docs/aws-docs/providers/aws/backup/index.md new file mode 100644 index 0000000000..20c6538316 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/backup/report_plan/index.md b/docs/aws-docs/providers/aws/backup/report_plan/index.md new file mode 100644 index 0000000000..0863295f52 --- /dev/null +++ b/docs/aws-docs/providers/aws/backup/report_plan/index.md @@ -0,0 +1,103 @@ +--- +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
DescriptionContains detailed information about a report plan in AWS Backup Audit Manager.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +report_plan_name, +report_plan_arn, +report_plan_description, +report_plan_tags, +report_delivery_channel, +report_setting +FROM aws.backup.report_plan +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the report_plan resource, the following permissions are required: + +### Read +```json +backup:DescribeReportPlan, +backup:ListTags +``` + +### Update +```json +backup:DescribeReportPlan, +backup:UpdateReportPlan, +backup:ListTags, +backup:UntagResource, +backup:TagResource +``` + +### Delete +```json +backup:DeleteReportPlan, +backup:DescribeReportPlan +``` + diff --git a/docs/aws-docs/providers/aws/backup/report_plans/index.md b/docs/aws-docs/providers/aws/backup/report_plans/index.md new file mode 100644 index 0000000000..1716f20122 --- /dev/null +++ b/docs/aws-docs/providers/aws/backup/report_plans/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionContains detailed information about a report plan in AWS Backup Audit Manager.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +report_plan_arn +FROM aws.backup.report_plans +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the report_plans resource, the following permissions are required: + +### Create +```json +backup:CreateReportPlan, +backup:DescribeReportPlan, +backup:ListTags, +backup:TagResource, +iam:CreateServiceLinkedRole +``` + +### List +```json +backup:ListReportPlans +``` + diff --git a/docs/aws-docs/providers/aws/backup/restore_testing_plan/index.md b/docs/aws-docs/providers/aws/backup/restore_testing_plan/index.md new file mode 100644 index 0000000000..34f4df2273 --- /dev/null +++ b/docs/aws-docs/providers/aws/backup/restore_testing_plan/index.md @@ -0,0 +1,105 @@ +--- +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
DescriptionDefinition of AWS::Backup::RestoreTestingPlan Resource Type
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.backup.restore_testing_plan +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the restore_testing_plan resource, the following permissions are required: + +### Read +```json +backup:GetRestoreTestingPlan, +backup:ListTags +``` + +### Update +```json +backup:UpdateRestoreTestingPlan, +backup:TagResource, +backup:UntagResource, +backup:GetRestoreTestingPlan, +backup:ListTags +``` + +### Delete +```json +backup:DeleteRestoreTestingPlan, +backup:GetRestoreTestingPlan +``` + diff --git a/docs/aws-docs/providers/aws/backup/restore_testing_plans/index.md b/docs/aws-docs/providers/aws/backup/restore_testing_plans/index.md new file mode 100644 index 0000000000..9a7cb7121f --- /dev/null +++ b/docs/aws-docs/providers/aws/backup/restore_testing_plans/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionDefinition of AWS::Backup::RestoreTestingPlan Resource Type
Idaws.backup.restore_testing_plans
+ +## Fields + + + + + +
NameDatatypeDescription
restore_testing_plan_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +restore_testing_plan_name +FROM aws.backup.restore_testing_plans +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the restore_testing_plans resource, the following permissions are required: + +### Create +```json +backup:CreateRestoreTestingPlan, +backup:TagResource, +backup:GetRestoreTestingPlan, +backup:ListTags +``` + +### List +```json +backup:ListRestoreTestingPlans +``` + diff --git a/docs/aws-docs/providers/aws/backup/restore_testing_selection/index.md b/docs/aws-docs/providers/aws/backup/restore_testing_selection/index.md new file mode 100644 index 0000000000..a90a3ab22a --- /dev/null +++ b/docs/aws-docs/providers/aws/backup/restore_testing_selection/index.md @@ -0,0 +1,104 @@ +--- +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
DescriptionResource Type definition for AWS::Backup::RestoreTestingSelection
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.backup.restore_testing_selection +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the restore_testing_selection resource, the following permissions are required: + +### Read +```json +backup:GetRestoreTestingSelection +``` + +### Update +```json +backup:UpdateRestoreTestingSelection, +backup:GetRestoreTestingSelection, +iam:PassRole +``` + +### Delete +```json +backup:DeleteRestoreTestingSelection, +backup:GetRestoreTestingSelection +``` + diff --git a/docs/aws-docs/providers/aws/backup/restore_testing_selections/index.md b/docs/aws-docs/providers/aws/backup/restore_testing_selections/index.md new file mode 100644 index 0000000000..1f646eb511 --- /dev/null +++ b/docs/aws-docs/providers/aws/backup/restore_testing_selections/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionResource Type definition for AWS::Backup::RestoreTestingSelection
Idaws.backup.restore_testing_selections
+ +## Fields + + + + + + +
NameDatatypeDescription
restore_testing_plan_namestring
restore_testing_selection_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +restore_testing_plan_name, +restore_testing_selection_name +FROM aws.backup.restore_testing_selections +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the restore_testing_selections resource, the following permissions are required: + +### Create +```json +backup:CreateRestoreTestingSelection, +backup:GetRestoreTestingSelection, +iam:PassRole +``` + +### List +```json +backup:ListRestoreTestingSelections +``` + diff --git a/docs/aws-docs/providers/aws/backupgateway/hypervisor/index.md b/docs/aws-docs/providers/aws/backupgateway/hypervisor/index.md new file mode 100644 index 0000000000..8106d0f44e --- /dev/null +++ b/docs/aws-docs/providers/aws/backupgateway/hypervisor/index.md @@ -0,0 +1,108 @@ +--- +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
DescriptionDefinition of AWS::BackupGateway::Hypervisor Resource Type
Idaws.backupgateway.hypervisor
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
hoststring
hypervisor_arnstring
kms_key_arnstring
log_group_arnstring
namestring
passwordstring
tagsarray
usernamestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +host, +hypervisor_arn, +kms_key_arn, +log_group_arn, +name, +password, +tags, +username +FROM aws.backupgateway.hypervisor +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the hypervisor resource, the following permissions are required: + +### Read +```json +backup-gateway:GetHypervisor, +backup-gateway:ListHypervisors +``` + +### Update +```json +backup-gateway:UpdateHypervisor, +backup-gateway:GetHypervisor, +backup-gateway:ListHypervisors, +backup-gateway:ImportHypervisorConfiguration, +backup-gateway:DeleteHypervisor +``` + +### Delete +```json +backup-gateway:DeleteHypervisor, +backup-gateway:GetHypervisor, +backup-gateway:ListHypervisors +``` + diff --git a/docs/aws-docs/providers/aws/backupgateway/hypervisors/index.md b/docs/aws-docs/providers/aws/backupgateway/hypervisors/index.md new file mode 100644 index 0000000000..7b139eb4c5 --- /dev/null +++ b/docs/aws-docs/providers/aws/backupgateway/hypervisors/index.md @@ -0,0 +1,83 @@ +--- +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
DescriptionDefinition of AWS::BackupGateway::Hypervisor Resource Type
Idaws.backupgateway.hypervisors
+ +## Fields + + + + + +
NameDatatypeDescription
hypervisor_arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +hypervisor_arn +FROM aws.backupgateway.hypervisors +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the hypervisors resource, the following permissions are required: + +### Create +```json +backup-gateway:ImportHypervisorConfiguration, +backup-gateway:GetHypervisor, +backup-gateway:ListHypervisors, +backup-gateway:TagResource, +kms:CreateGrant, +kms:Encrypt, +kms:Decrypt +``` + +### List +```json +backup-gateway:ListHypervisors +``` + diff --git a/docs/aws-docs/providers/aws/backupgateway/index.md b/docs/aws-docs/providers/aws/backupgateway/index.md new file mode 100644 index 0000000000..a853f8b3ae --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/batch/compute_environment/index.md b/docs/aws-docs/providers/aws/batch/compute_environment/index.md new file mode 100644 index 0000000000..25ca226709 --- /dev/null +++ b/docs/aws-docs/providers/aws/batch/compute_environment/index.md @@ -0,0 +1,116 @@ +--- +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
DescriptionResource Type definition for AWS::Batch::ComputeEnvironment
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.batch.compute_environment +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the compute_environment resource, the following permissions are required: + +### Read +```json +Batch:DescribeComputeEnvironments +``` + +### Update +```json +Batch:UpdateComputeEnvironment, +Batch:DescribeComputeEnvironments, +Batch:TagResource, +Batch:UnTagResource, +Iam:PassRole, +Eks:DescribeCluster +``` + +### Delete +```json +Batch:DeleteComputeEnvironment, +Batch:DescribeComputeEnvironments, +Batch:UpdateComputeEnvironment, +Iam:PassRole, +Eks:DescribeCluster +``` + diff --git a/docs/aws-docs/providers/aws/batch/compute_environments/index.md b/docs/aws-docs/providers/aws/batch/compute_environments/index.md new file mode 100644 index 0000000000..18453ef695 --- /dev/null +++ b/docs/aws-docs/providers/aws/batch/compute_environments/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionResource Type definition for AWS::Batch::ComputeEnvironment
Idaws.batch.compute_environments
+ +## Fields + + + + + +
NameDatatypeDescription
compute_environment_arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +compute_environment_arn +FROM aws.batch.compute_environments +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the compute_environments resource, the following permissions are required: + +### Create +```json +Batch:CreateComputeEnvironment, +Batch:TagResource, +Batch:DescribeComputeEnvironments, +iam:CreateServiceLinkedRole, +Iam:PassRole, +Eks:DescribeCluster +``` + +### List +```json +Batch:DescribeComputeEnvironments +``` + diff --git a/docs/aws-docs/providers/aws/batch/index.md b/docs/aws-docs/providers/aws/batch/index.md new file mode 100644 index 0000000000..c49b4694da --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/batch/job_queue/index.md b/docs/aws-docs/providers/aws/batch/job_queue/index.md new file mode 100644 index 0000000000..b13a945271 --- /dev/null +++ b/docs/aws-docs/providers/aws/batch/job_queue/index.md @@ -0,0 +1,106 @@ +--- +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
DescriptionResource Type definition for AWS::Batch::JobQueue
Idaws.batch.job_queue
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
job_queue_namestring
job_queue_arnstring
compute_environment_orderarray
job_state_time_limit_actionsarray
priorityinteger
statestring
scheduling_policy_arnstring
tagsobjectA key-value pair to associate with a resource.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +job_queue_name, +job_queue_arn, +compute_environment_order, +job_state_time_limit_actions, +priority, +state, +scheduling_policy_arn, +tags +FROM aws.batch.job_queue +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the job_queue resource, the following permissions are required: + +### Read +```json +Batch:DescribeJobQueues +``` + +### Update +```json +Batch:DescribeJobQueues, +Batch:UpdateJobQueue, +Batch:TagResource, +Batch:UnTagResource +``` + +### Delete +```json +Batch:UpdateJobQueue, +Batch:DescribeJobQueues, +Batch:DeleteJobQueue +``` + diff --git a/docs/aws-docs/providers/aws/batch/job_queues/index.md b/docs/aws-docs/providers/aws/batch/job_queues/index.md new file mode 100644 index 0000000000..d1e1965883 --- /dev/null +++ b/docs/aws-docs/providers/aws/batch/job_queues/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource Type definition for AWS::Batch::JobQueue
Idaws.batch.job_queues
+ +## Fields + + + + + +
NameDatatypeDescription
job_queue_arnundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +job_queue_arn +FROM aws.batch.job_queues +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the job_queues resource, the following permissions are required: + +### Create +```json +Batch:CreateJobQueue, +Batch:TagResource, +Batch:DescribeJobQueues +``` + +### List +```json +Batch:DescribeJobQueues +``` + diff --git a/docs/aws-docs/providers/aws/batch/scheduling_policies/index.md b/docs/aws-docs/providers/aws/batch/scheduling_policies/index.md new file mode 100644 index 0000000000..62a593a098 --- /dev/null +++ b/docs/aws-docs/providers/aws/batch/scheduling_policies/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource Type schema for AWS::Batch::SchedulingPolicy
Idaws.batch.scheduling_policies
+ +## Fields + + + + + +
NameDatatypeDescription
arnundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.batch.scheduling_policies +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the scheduling_policies resource, the following permissions are required: + +### Create +```json +Batch:CreateSchedulingPolicy, +Batch:TagResource +``` + +### List +```json +Batch:ListSchedulingPolicies, +Batch:DescribeSchedulingPolicies +``` + diff --git a/docs/aws-docs/providers/aws/batch/scheduling_policy/index.md b/docs/aws-docs/providers/aws/batch/scheduling_policy/index.md new file mode 100644 index 0000000000..28aae7ec0d --- /dev/null +++ b/docs/aws-docs/providers/aws/batch/scheduling_policy/index.md @@ -0,0 +1,96 @@ +--- +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
DescriptionResource Type schema for AWS::Batch::SchedulingPolicy
Idaws.batch.scheduling_policy
+ +## Fields + + + + + + + + +
NameDatatypeDescription
namestringName of Scheduling Policy.
arnstring
fairshare_policyobject
tagsobjectA key-value pair to associate with a resource.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +arn, +fairshare_policy, +tags +FROM aws.batch.scheduling_policy +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the scheduling_policy resource, the following permissions are required: + +### Read +```json +Batch:DescribeSchedulingPolicies +``` + +### Update +```json +Batch:UpdateSchedulingPolicy, +Batch:TagResource, +Batch:UnTagResource +``` + +### Delete +```json +Batch:DescribeSchedulingPolicies, +Batch:DeleteSchedulingPolicy +``` + diff --git a/docs/aws-docs/providers/aws/bcmdataexports/export/index.md b/docs/aws-docs/providers/aws/bcmdataexports/export/index.md new file mode 100644 index 0000000000..3e66a3fe54 --- /dev/null +++ b/docs/aws-docs/providers/aws/bcmdataexports/export/index.md @@ -0,0 +1,96 @@ +--- +title: export +hide_title: false +hide_table_of_contents: false +keywords: + - export + - bcmdataexports + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual export resource + +## Overview + + + + + +
Nameexport
TypeResource
DescriptionDefinition of AWS::BCMDataExports::Export Resource Type
Idaws.bcmdataexports.export
+ +## Fields + + + + + + + +
NameDatatypeDescription
exportobject
export_arnstring
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +export, +export_arn, +tags +FROM aws.bcmdataexports.export +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the export resource, the following permissions are required: + +### Read +```json +bcm-data-exports:GetExport, +bcm-data-exports:ListTagsForResource +``` + +### Update +```json +bcm-data-exports:UpdateExport, +bcm-data-exports:TagResource, +bcm-data-exports:UntagResource, +bcm-data-exports:GetExport, +bcm-data-exports:ListTagsForResource +``` + +### Delete +```json +bcm-data-exports:DeleteExport +``` + diff --git a/docs/aws-docs/providers/aws/bcmdataexports/exports/index.md b/docs/aws-docs/providers/aws/bcmdataexports/exports/index.md new file mode 100644 index 0000000000..f63cf1b3e7 --- /dev/null +++ b/docs/aws-docs/providers/aws/bcmdataexports/exports/index.md @@ -0,0 +1,81 @@ +--- +title: exports +hide_title: false +hide_table_of_contents: false +keywords: + - exports + - bcmdataexports + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Retrieves a list of exports in a region + +## Overview + + + + + +
Nameexports
TypeResource
DescriptionDefinition of AWS::BCMDataExports::Export Resource Type
Idaws.bcmdataexports.exports
+ +## Fields + + + + + +
NameDatatypeDescription
export_arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +export_arn +FROM aws.bcmdataexports.exports +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the exports resource, the following permissions are required: + +### Create +```json +bcm-data-exports:CreateExport, +bcm-data-exports:GetExport, +bcm-data-exports:ListTagsForResource, +bcm-data-exports:TagResource, +cur:PutReportDefinition +``` + +### List +```json +bcm-data-exports:ListExports +``` + diff --git a/docs/aws-docs/providers/aws/bcmdataexports/index.md b/docs/aws-docs/providers/aws/bcmdataexports/index.md new file mode 100644 index 0000000000..3fd4c7d5a4 --- /dev/null +++ b/docs/aws-docs/providers/aws/bcmdataexports/index.md @@ -0,0 +1,39 @@ +--- +title: bcmdataexports +hide_title: false +hide_table_of_contents: false +keywords: + - bcmdataexports + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- + +The bcmdataexports service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+export +
+
+exports +
+
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/bedrock/agent/index.md b/docs/aws-docs/providers/aws/bedrock/agent/index.md new file mode 100644 index 0000000000..84090c72d8 --- /dev/null +++ b/docs/aws-docs/providers/aws/bedrock/agent/index.md @@ -0,0 +1,151 @@ +--- +title: agent +hide_title: false +hide_table_of_contents: false +keywords: + - agent + - bedrock + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual agent resource + +## Overview + + + + + +
Nameagent
TypeResource
DescriptionDefinition of AWS::Bedrock::Agent Resource Type
Idaws.bedrock.agent
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
action_groupsarrayList of ActionGroups
agent_arnstringArn representation of the Agent.
agent_idstringIdentifier for a resource.
agent_namestringName for a resource.
agent_resource_role_arnstringARN of a IAM role.
agent_statusstring
agent_versionstringDraft Agent Version.
auto_preparebooleanSpecifies whether to automatically prepare after creating or updating the agent.
created_atstringTime Stamp.
customer_encryption_key_arnstringA KMS key ARN
skip_resource_in_use_check_on_deletebooleanSpecifies whether to allow deleting agent while it is in use.
descriptionstringDescription of the Resource.
failure_reasonsarrayFailure Reasons for Error.
foundation_modelstringARN or name of a Bedrock model.
idle_session_ttl_in_secondsnumberMax Session Time.
instructionstringInstruction for the agent.
knowledge_basesarrayList of Agent Knowledge Bases
prepared_atstringTime Stamp.
prompt_override_configurationobject
recommended_actionsarrayThe recommended actions users can take to resolve an error in failureReasons.
tagsobject
updated_atstringTime Stamp.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +action_groups, +agent_arn, +agent_id, +agent_name, +agent_resource_role_arn, +agent_status, +agent_version, +auto_prepare, +created_at, +customer_encryption_key_arn, +skip_resource_in_use_check_on_delete, +description, +failure_reasons, +foundation_model, +idle_session_ttl_in_seconds, +instruction, +knowledge_bases, +prepared_at, +prompt_override_configuration, +recommended_actions, +tags, +updated_at +FROM aws.bedrock.agent +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the agent resource, the following permissions are required: + +### Read +```json +bedrock:GetAgent, +bedrock:GetAgentActionGroup, +bedrock:ListAgentActionGroups, +bedrock:GetAgentKnowledgeBase, +bedrock:ListAgentKnowledgeBases, +bedrock:ListTagsForResource +``` + +### Update +```json +bedrock:GetAgent, +bedrock:UpdateAgent, +bedrock:PrepareAgent, +bedrock:GetAgentKnowledgeBase, +bedrock:UpdateAgentKnowledgeBase, +bedrock:AssociateAgentKnowledgeBase, +bedrock:DisassociateAgentKnowledgeBase, +bedrock:ListAgentKnowledgeBases, +bedrock:CreateAgentActionGroup, +bedrock:GetAgentActionGroup, +bedrock:UpdateAgentActionGroup, +bedrock:DeleteAgentActionGroup, +bedrock:ListAgentActionGroups, +bedrock:TagResource, +bedrock:UntagResource, +bedrock:ListTagsForResource, +iam:PassRole +``` + +### Delete +```json +bedrock:GetAgent, +bedrock:DeleteAgent +``` + diff --git a/docs/aws-docs/providers/aws/bedrock/agent_alias/index.md b/docs/aws-docs/providers/aws/bedrock/agent_alias/index.md new file mode 100644 index 0000000000..69d7b3ed75 --- /dev/null +++ b/docs/aws-docs/providers/aws/bedrock/agent_alias/index.md @@ -0,0 +1,114 @@ +--- +title: agent_alias +hide_title: false +hide_table_of_contents: false +keywords: + - agent_alias + - bedrock + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual agent_alias resource + +## Overview + + + + + +
Nameagent_alias
TypeResource
DescriptionDefinition of AWS::Bedrock::AgentAlias Resource Type
Idaws.bedrock.agent_alias
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
agent_alias_arnstringArn representation of the Agent Alias.
agent_alias_history_eventsarrayThe list of history events for an alias for an Agent.
agent_alias_idstringId for an Agent Alias generated at the server side.
agent_alias_namestringName for a resource.
agent_alias_statusstring
agent_idstringIdentifier for a resource.
created_atstringTime Stamp.
descriptionstringDescription of the Resource.
routing_configurationarrayRouting configuration for an Agent alias.
tagsobject
updated_atstringTime Stamp.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +agent_alias_arn, +agent_alias_history_events, +agent_alias_id, +agent_alias_name, +agent_alias_status, +agent_id, +created_at, +description, +routing_configuration, +tags, +updated_at +FROM aws.bedrock.agent_alias +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the agent_alias resource, the following permissions are required: + +### Read +```json +bedrock:GetAgentAlias, +bedrock:ListTagsForResource +``` + +### Update +```json +bedrock:PrepareAgent, +bedrock:GetAgent, +bedrock:UpdateAgentAlias, +bedrock:TagResource, +bedrock:UntagResource, +bedrock:GetAgentAlias, +bedrock:ListTagsForResource +``` + +### Delete +```json +bedrock:DeleteAgentAlias +``` + diff --git a/docs/aws-docs/providers/aws/bedrock/agent_aliases/index.md b/docs/aws-docs/providers/aws/bedrock/agent_aliases/index.md new file mode 100644 index 0000000000..8c01bc1a98 --- /dev/null +++ b/docs/aws-docs/providers/aws/bedrock/agent_aliases/index.md @@ -0,0 +1,84 @@ +--- +title: agent_aliases +hide_title: false +hide_table_of_contents: false +keywords: + - agent_aliases + - bedrock + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Retrieves a list of agent_aliases in a region + +## Overview + + + + + +
Nameagent_aliases
TypeResource
DescriptionDefinition of AWS::Bedrock::AgentAlias Resource Type
Idaws.bedrock.agent_aliases
+ +## Fields + + + + + + +
NameDatatypeDescription
agent_idstringIdentifier for a resource.
agent_alias_idstringId for an Agent Alias generated at the server side.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +agent_id, +agent_alias_id +FROM aws.bedrock.agent_aliases +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the agent_aliases resource, the following permissions are required: + +### Create +```json +bedrock:PrepareAgent, +bedrock:GetAgent, +bedrock:CreateAgentAlias, +bedrock:TagResource, +bedrock:GetAgentAlias, +bedrock:ListTagsForResource +``` + +### List +```json +bedrock:ListAgentAliases +``` + diff --git a/docs/aws-docs/providers/aws/bedrock/agents/index.md b/docs/aws-docs/providers/aws/bedrock/agents/index.md new file mode 100644 index 0000000000..497357d6f7 --- /dev/null +++ b/docs/aws-docs/providers/aws/bedrock/agents/index.md @@ -0,0 +1,88 @@ +--- +title: agents +hide_title: false +hide_table_of_contents: false +keywords: + - agents + - bedrock + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Retrieves a list of agents in a region + +## Overview + + + + + +
Nameagents
TypeResource
DescriptionDefinition of AWS::Bedrock::Agent Resource Type
Idaws.bedrock.agents
+ +## Fields + + + + + +
NameDatatypeDescription
agent_idstringIdentifier for a resource.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +agent_id +FROM aws.bedrock.agents +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the agents resource, the following permissions are required: + +### Create +```json +bedrock:CreateAgent, +bedrock:GetAgent, +bedrock:PrepareAgent, +bedrock:GetAgentKnowledgeBase, +bedrock:AssociateAgentKnowledgeBase, +bedrock:ListAgentKnowledgeBases, +bedrock:CreateAgentActionGroup, +bedrock:GetAgentActionGroup, +bedrock:ListAgentActionGroups, +bedrock:TagResource, +bedrock:ListTagsForResource, +iam:PassRole +``` + +### List +```json +bedrock:ListAgents +``` + diff --git a/docs/aws-docs/providers/aws/bedrock/data_source/index.md b/docs/aws-docs/providers/aws/bedrock/data_source/index.md new file mode 100644 index 0000000000..5982a2e7c6 --- /dev/null +++ b/docs/aws-docs/providers/aws/bedrock/data_source/index.md @@ -0,0 +1,107 @@ +--- +title: data_source +hide_title: false +hide_table_of_contents: false +keywords: + - data_source + - bedrock + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual data_source resource + +## Overview + + + + + +
Namedata_source
TypeResource
DescriptionDefinition of AWS::Bedrock::DataSource Resource Type
Idaws.bedrock.data_source
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
data_source_configurationobject
data_source_idstringIdentifier for a resource.
descriptionstringDescription of the Resource.
knowledge_base_idstringThe unique identifier of the knowledge base to which to add the data source.
data_source_statusstring
namestringThe name of the data source.
server_side_encryption_configurationobject
vector_ingestion_configurationobject
created_atstringThe time at which the data source was created.
updated_atstringThe time at which the knowledge base was last updated.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +data_source_configuration, +data_source_id, +description, +knowledge_base_id, +data_source_status, +name, +server_side_encryption_configuration, +vector_ingestion_configuration, +created_at, +updated_at +FROM aws.bedrock.data_source +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the data_source resource, the following permissions are required: + +### Read +```json +bedrock:GetDataSource +``` + +### Update +```json +bedrock:GetDataSource, +bedrock:UpdateDataSource +``` + +### Delete +```json +bedrock:GetDataSource, +bedrock:DeleteDataSource +``` + diff --git a/docs/aws-docs/providers/aws/bedrock/data_sources/index.md b/docs/aws-docs/providers/aws/bedrock/data_sources/index.md new file mode 100644 index 0000000000..7c6102b4ca --- /dev/null +++ b/docs/aws-docs/providers/aws/bedrock/data_sources/index.md @@ -0,0 +1,81 @@ +--- +title: data_sources +hide_title: false +hide_table_of_contents: false +keywords: + - data_sources + - bedrock + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Retrieves a list of data_sources in a region + +## Overview + + + + + +
Namedata_sources
TypeResource
DescriptionDefinition of AWS::Bedrock::DataSource Resource Type
Idaws.bedrock.data_sources
+ +## Fields + + + + + + +
NameDatatypeDescription
knowledge_base_idstringThe unique identifier of the knowledge base to which to add the data source.
data_source_idstringIdentifier for a resource.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +knowledge_base_id, +data_source_id +FROM aws.bedrock.data_sources +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the data_sources resource, the following permissions are required: + +### Create +```json +bedrock:CreateDataSource, +bedrock:GetDataSource, +bedrock:GetKnowledgeBase +``` + +### List +```json +bedrock:ListDataSources +``` + diff --git a/docs/aws-docs/providers/aws/bedrock/index.md b/docs/aws-docs/providers/aws/bedrock/index.md new file mode 100644 index 0000000000..dba336a382 --- /dev/null +++ b/docs/aws-docs/providers/aws/bedrock/index.md @@ -0,0 +1,45 @@ +--- +title: bedrock +hide_title: false +hide_table_of_contents: false +keywords: + - bedrock + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- + +The bedrock service documentation. + +:::info Service Summary + +
+
+total resources: 8
+total selectable resources: 8
+total methods: 8
+
+
+ +::: + +## Resources +
+
+agent
+agent_alias
+agent_aliases
+agents +
+
+data_source
+data_sources
+knowledge_base
+knowledge_bases +
+
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/bedrock/knowledge_base/index.md b/docs/aws-docs/providers/aws/bedrock/knowledge_base/index.md new file mode 100644 index 0000000000..bcc4f476c0 --- /dev/null +++ b/docs/aws-docs/providers/aws/bedrock/knowledge_base/index.md @@ -0,0 +1,118 @@ +--- +title: knowledge_base +hide_title: false +hide_table_of_contents: false +keywords: + - knowledge_base + - bedrock + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual knowledge_base resource + +## Overview + + + + + +
Nameknowledge_base
TypeResource
DescriptionDefinition of AWS::Bedrock::KnowledgeBase Resource Type
Idaws.bedrock.knowledge_base
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
descriptionstringDescription of the Resource.
knowledge_base_configurationobject
knowledge_base_idstringThe unique identifier of the knowledge base.
knowledge_base_arnstringThe ARN of the knowledge base.
namestringThe name of the knowledge base.
statusstring
role_arnstringThe ARN of the IAM role with permissions to invoke API operations on the knowledge base. The ARN must begin with AmazonBedrockExecutionRoleForKnowledgeBase_
created_atstringThe time at which the knowledge base was created.
failure_reasonsarrayA list of reasons that the API operation on the knowledge base failed.
updated_atstringThe time at which the knowledge base was last updated.
storage_configurationobject
tagsobject
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +description, +knowledge_base_configuration, +knowledge_base_id, +knowledge_base_arn, +name, +status, +role_arn, +created_at, +failure_reasons, +updated_at, +storage_configuration, +tags +FROM aws.bedrock.knowledge_base +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the knowledge_base resource, the following permissions are required: + +### Read +```json +bedrock:GetKnowledgeBase, +bedrock:ListTagsForResource +``` + +### Update +```json +bedrock:GetKnowledgeBase, +bedrock:UpdateKnowledgeBase, +bedrock:TagResource, +bedrock:UntagResource, +bedrock:ListTagsForResource, +bedrock:AssociateThirdPartyKnowledgeBase, +iam:PassRole +``` + +### Delete +```json +bedrock:GetKnowledgeBase, +bedrock:DeleteKnowledgeBase, +bedrock:ListDataSources +``` + diff --git a/docs/aws-docs/providers/aws/bedrock/knowledge_bases/index.md b/docs/aws-docs/providers/aws/bedrock/knowledge_bases/index.md new file mode 100644 index 0000000000..0be605a294 --- /dev/null +++ b/docs/aws-docs/providers/aws/bedrock/knowledge_bases/index.md @@ -0,0 +1,82 @@ +--- +title: knowledge_bases +hide_title: false +hide_table_of_contents: false +keywords: + - knowledge_bases + - bedrock + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Retrieves a list of knowledge_bases in a region + +## Overview + + + + + +
Nameknowledge_bases
TypeResource
DescriptionDefinition of AWS::Bedrock::KnowledgeBase Resource Type
Idaws.bedrock.knowledge_bases
+ +## Fields + + + + + +
NameDatatypeDescription
knowledge_base_idstringThe unique identifier of the knowledge base.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +knowledge_base_id +FROM aws.bedrock.knowledge_bases +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the knowledge_bases resource, the following permissions are required: + +### Create +```json +bedrock:CreateKnowledgeBase, +bedrock:GetKnowledgeBase, +bedrock:TagResource, +bedrock:ListTagsForResource, +bedrock:AssociateThirdPartyKnowledgeBase, +iam:PassRole +``` + +### List +```json +bedrock:ListKnowledgeBases +``` + diff --git a/docs/aws-docs/providers/aws/billingconductor/billing_group/index.md b/docs/aws-docs/providers/aws/billingconductor/billing_group/index.md new file mode 100644 index 0000000000..907324cc81 --- /dev/null +++ b/docs/aws-docs/providers/aws/billingconductor/billing_group/index.md @@ -0,0 +1,122 @@ +--- +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
DescriptionA billing group is a set of linked account which belong to the same end customer. It can be seen as a virtual consolidated billing family.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.billingconductor.billing_group +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the billing_group resource, the following permissions are required: + +### Read +```json +billingconductor:ListBillingGroups, +billingconductor:ListAccountAssociations, +organizations:ListAccounts, +billingconductor:ListTagsForResource +``` + +### Update +```json +billingconductor:UpdateBillingGroup, +billingconductor:ListAccountAssociations, +organizations:ListAccounts, +billingconductor:AssociateAccounts, +billingconductor:DisassociateAccounts, +billingconductor:ListBillingGroups, +billingconductor:TagResource, +billingconductor:UntagResource +``` + +### Delete +```json +billingconductor:DeleteBillingGroup, +billingconductor:ListBillingGroups, +billingconductor:UntagResource, +billingconductor:UpdateBillingGroup +``` + diff --git a/docs/aws-docs/providers/aws/billingconductor/billing_groups/index.md b/docs/aws-docs/providers/aws/billingconductor/billing_groups/index.md new file mode 100644 index 0000000000..bccee658d1 --- /dev/null +++ b/docs/aws-docs/providers/aws/billingconductor/billing_groups/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionA billing group is a set of linked account which belong to the same end customer. It can be seen as a virtual consolidated billing family.
Idaws.billingconductor.billing_groups
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringBilling Group ARN
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.billingconductor.billing_groups +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the billing_groups resource, the following permissions are required: + +### Create +```json +billingconductor:CreateBillingGroup, +billingconductor:AssociateAccounts, +billingconductor:ListBillingGroups, +billingconductor:TagResource, +billingconductor:ListTagsForResource +``` + +### List +```json +billingconductor:ListBillingGroups, +billingconductor:ListAccountAssociations, +organizations:ListAccounts, +billingconductor:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/billingconductor/custom_line_item/index.md b/docs/aws-docs/providers/aws/billingconductor/custom_line_item/index.md new file mode 100644 index 0000000000..fed30c59d8 --- /dev/null +++ b/docs/aws-docs/providers/aws/billingconductor/custom_line_item/index.md @@ -0,0 +1,124 @@ +--- +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
DescriptionA custom line item is an one time charge that is applied to a specific billing group's bill.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.billingconductor.custom_line_item +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the custom_line_item resource, the following permissions are required: + +### Read +```json +billingconductor:ListCustomLineItems, +billingconductor:ListCustomLineItemVersions, +billingconductor:ListResourcesAssociatedToCustomLineItem, +billingconductor:ListTagsForResource +``` + +### Update +```json +billingconductor:UpdateCustomLineItem, +billingconductor:ListCustomLineItems, +billingconductor:ListResourcesAssociatedToCustomLineItem, +billingconductor:BatchAssociateResourcesToCustomLineItem, +billingconductor:BatchDisassociateResourcesFromCustomLineItem, +billingconductor:TagResource, +billingconductor:UntagResource +``` + +### Delete +```json +billingconductor:DeleteCustomLineItem, +billingconductor:ListCustomLineItems, +billingconductor:BatchDisassociateResourcesFromCustomLineItem, +billingconductor:ListResourcesAssociatedToCustomLineItem, +billingconductor:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/billingconductor/custom_line_items/index.md b/docs/aws-docs/providers/aws/billingconductor/custom_line_items/index.md new file mode 100644 index 0000000000..35a3ea6a3c --- /dev/null +++ b/docs/aws-docs/providers/aws/billingconductor/custom_line_items/index.md @@ -0,0 +1,83 @@ +--- +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
DescriptionA custom line item is an one time charge that is applied to a specific billing group's bill.
Idaws.billingconductor.custom_line_items
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringARN
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.billingconductor.custom_line_items +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the custom_line_items resource, the following permissions are required: + +### Create +```json +billingconductor:CreateCustomLineItem, +billingconductor:BatchAssociateResourcesToCustomLineItem, +billingconductor:ListCustomLineItems, +billingconductor:TagResource, +billingconductor:ListTagsForResource +``` + +### List +```json +billingconductor:ListCustomLineItems, +billingconductor:ListResourcesAssociatedToCustomLineItem, +billingconductor:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/billingconductor/index.md b/docs/aws-docs/providers/aws/billingconductor/index.md new file mode 100644 index 0000000000..4e23cabae0 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/billingconductor/pricing_plan/index.md b/docs/aws-docs/providers/aws/billingconductor/pricing_plan/index.md new file mode 100644 index 0000000000..db034bde70 --- /dev/null +++ b/docs/aws-docs/providers/aws/billingconductor/pricing_plan/index.md @@ -0,0 +1,111 @@ +--- +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 enables you to customize your billing details consistent with the usage that accrues in each of your billing groups.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +name, +pricing_rule_arns, +size, +description, +creation_time, +last_modified_time, +tags +FROM aws.billingconductor.pricing_plan +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the pricing_plan resource, the following permissions are required: + +### Read +```json +billingconductor:ListPricingPlans, +billingconductor:ListPricingRulesAssociatedToPricingPlan, +billingconductor:ListTagsForResource +``` + +### Update +```json +billingconductor:ListPricingPlans, +billingconductor:UpdatePricingPlan, +billingconductor:ListPricingRulesAssociatedToPricingPlan, +billingconductor:AssociatePricingRules, +billingconductor:DisassociatePricingRules, +billingconductor:TagResource, +billingconductor:UntagResource +``` + +### Delete +```json +billingconductor:ListPricingPlans, +billingconductor:DeletePricingPlan, +billingconductor:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/billingconductor/pricing_plans/index.md b/docs/aws-docs/providers/aws/billingconductor/pricing_plans/index.md new file mode 100644 index 0000000000..2609525288 --- /dev/null +++ b/docs/aws-docs/providers/aws/billingconductor/pricing_plans/index.md @@ -0,0 +1,83 @@ +--- +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 Plan enables you to customize your billing details consistent with the usage that accrues in each of your billing groups.
Idaws.billingconductor.pricing_plans
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringPricing Plan ARN
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.billingconductor.pricing_plans +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the pricing_plans resource, the following permissions are required: + +### Create +```json +billingconductor:CreatePricingPlan, +billingconductor:AssociatePricingRules, +billingconductor:ListPricingPlans, +billingconductor:TagResource, +billingconductor:ListTagsForResource +``` + +### List +```json +billingconductor:ListPricingPlans, +billingconductor:ListPricingRulesAssociatedToPricingPlan, +billingconductor:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/billingconductor/pricing_rule/index.md b/docs/aws-docs/providers/aws/billingconductor/pricing_rule/index.md new file mode 100644 index 0000000000..93200cbc5d --- /dev/null +++ b/docs/aws-docs/providers/aws/billingconductor/pricing_rule/index.md @@ -0,0 +1,121 @@ +--- +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
DescriptionA markup/discount that is defined for a specific set of services that can later be associated with a pricing plan.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.billingconductor.pricing_rule +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the pricing_rule resource, the following permissions are required: + +### Read +```json +billingconductor:ListPricingRules, +billingconductor:ListTagsForResource +``` + +### Update +```json +billingconductor:UpdatePricingRule, +billingconductor:ListPricingRules, +billingconductor:TagResource, +billingconductor:UntagResource +``` + +### Delete +```json +billingconductor:DeletePricingRule, +billingconductor:ListPricingRules, +billingconductor:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/billingconductor/pricing_rules/index.md b/docs/aws-docs/providers/aws/billingconductor/pricing_rules/index.md new file mode 100644 index 0000000000..f3d3179084 --- /dev/null +++ b/docs/aws-docs/providers/aws/billingconductor/pricing_rules/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionA markup/discount that is defined for a specific set of services that can later be associated with a pricing plan.
Idaws.billingconductor.pricing_rules
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringPricing rule ARN
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.billingconductor.pricing_rules +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the pricing_rules resource, the following permissions are required: + +### Create +```json +billingconductor:CreatePricingRule, +billingconductor:ListPricingRules, +billingconductor:TagResource, +billingconductor:ListTagsForResource +``` + +### List +```json +billingconductor:ListPricingRules, +billingconductor:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/budgets/budgets_action/index.md b/docs/aws-docs/providers/aws/budgets/budgets_action/index.md new file mode 100644 index 0000000000..5e743e2e85 --- /dev/null +++ b/docs/aws-docs/providers/aws/budgets/budgets_action/index.md @@ -0,0 +1,104 @@ +--- +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
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +action_id, +budget_name, +notification_type, +action_type, +action_threshold, +execution_role_arn, +approval_model, +subscribers, +definition +FROM aws.budgets.budgets_action +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the budgets_action resource, the following permissions are required: + +### Read +```json +budgets:DescribeBudgetAction +``` + +### Update +```json +budgets:UpdateBudgetAction, +iam:PassRole +``` + +### Delete +```json +budgets:DeleteBudgetAction +``` + diff --git a/docs/aws-docs/providers/aws/budgets/budgets_actions/index.md b/docs/aws-docs/providers/aws/budgets/budgets_actions/index.md new file mode 100644 index 0000000000..e7fb853b2b --- /dev/null +++ b/docs/aws-docs/providers/aws/budgets/budgets_actions/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Idaws.budgets.budgets_actions
+ +## Fields + + + + + + +
NameDatatypeDescription
action_idstring
budget_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +action_id, +budget_name +FROM aws.budgets.budgets_actions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the budgets_actions resource, the following permissions are required: + +### Create +```json +budgets:CreateBudgetAction, +iam:PassRole +``` + +### List +```json +budgets:DescribeBudgetActionsForAccount, +budgets:DescribeBudgetActionsForBudget +``` + diff --git a/docs/aws-docs/providers/aws/budgets/index.md b/docs/aws-docs/providers/aws/budgets/index.md new file mode 100644 index 0000000000..31c3d46550 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/cassandra/index.md b/docs/aws-docs/providers/aws/cassandra/index.md new file mode 100644 index 0000000000..a510beacb0 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/cassandra/keyspace/index.md b/docs/aws-docs/providers/aws/cassandra/keyspace/index.md new file mode 100644 index 0000000000..f0b32de997 --- /dev/null +++ b/docs/aws-docs/providers/aws/cassandra/keyspace/index.md @@ -0,0 +1,102 @@ +--- +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
DescriptionResource schema for AWS::Cassandra::Keyspace
Idaws.cassandra.keyspace
+ +## Fields + + + + + + + +
NameDatatypeDescription
keyspace_namestringName for Cassandra keyspace
tagsarray
replication_specificationobject
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +keyspace_name, +tags, +replication_specification +FROM aws.cassandra.keyspace +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the keyspace resource, the following permissions are required: + +### Read +```json +cassandra:Select, +cassandra:SelectMultiRegionResource +``` + +### Update +```json +cassandra:Alter, +cassandra:AlterMultiRegionResource, +cassandra:Select, +cassandra:SelectMultiRegionResource, +cassandra:TagResource, +cassandra:TagMultiRegionResource, +cassandra:UntagResource, +cassandra:UntagMultiRegionResource +``` + +### Delete +```json +cassandra:Drop, +cassandra:DropMultiRegionResource, +cassandra:Select, +cassandra:SelectMultiRegionResource +``` + diff --git a/docs/aws-docs/providers/aws/cassandra/keyspaces/index.md b/docs/aws-docs/providers/aws/cassandra/keyspaces/index.md new file mode 100644 index 0000000000..82121b4afd --- /dev/null +++ b/docs/aws-docs/providers/aws/cassandra/keyspaces/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionResource schema for AWS::Cassandra::Keyspace
Idaws.cassandra.keyspaces
+ +## Fields + + + + + +
NameDatatypeDescription
keyspace_namestringName for Cassandra keyspace
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +keyspace_name +FROM aws.cassandra.keyspaces +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the keyspaces resource, the following permissions are required: + +### Create +```json +cassandra:Create, +cassandra:CreateMultiRegionResource, +cassandra:Select, +cassandra:SelectMultiRegionResource, +cassandra:TagResource, +cassandra:TagMultiRegionResource, +iam:CreateServiceLinkedRole +``` + +### List +```json +cassandra:Select, +cassandra:SelectMultiRegionResource +``` + diff --git a/docs/aws-docs/providers/aws/cassandra/table/index.md b/docs/aws-docs/providers/aws/cassandra/table/index.md new file mode 100644 index 0000000000..f7e1177e62 --- /dev/null +++ b/docs/aws-docs/providers/aws/cassandra/table/index.md @@ -0,0 +1,153 @@ +--- +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
DescriptionResource schema for AWS::Cassandra::Table
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.cassandra.table +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the table resource, the following permissions are required: + +### Read +```json +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 +```json +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 +```json +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 +``` + diff --git a/docs/aws-docs/providers/aws/cassandra/tables/index.md b/docs/aws-docs/providers/aws/cassandra/tables/index.md new file mode 100644 index 0000000000..d78a3a2de9 --- /dev/null +++ b/docs/aws-docs/providers/aws/cassandra/tables/index.md @@ -0,0 +1,107 @@ +--- +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
DescriptionResource schema for AWS::Cassandra::Table
Idaws.cassandra.tables
+ +## Fields + + + + + + +
NameDatatypeDescription
keyspace_namestringName for Cassandra keyspace
table_namestringName for Cassandra table
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +keyspace_name, +table_name +FROM aws.cassandra.tables +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the tables resource, the following permissions are required: + +### Create +```json +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 +```json +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 +``` + diff --git a/docs/aws-docs/providers/aws/ce/anomaly_monitor/index.md b/docs/aws-docs/providers/aws/ce/anomaly_monitor/index.md new file mode 100644 index 0000000000..7331f97362 --- /dev/null +++ b/docs/aws-docs/providers/aws/ce/anomaly_monitor/index.md @@ -0,0 +1,105 @@ +--- +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
DescriptionAWS Cost Anomaly Detection leverages advanced Machine Learning technologies to identify anomalous spend and root causes, so you can quickly take action. You can use Cost Anomaly Detection by creating monitor.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.ce.anomaly_monitor +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the anomaly_monitor resource, the following permissions are required: + +### Read +```json +ce:GetAnomalyMonitors +``` + +### Update +```json +ce:UpdateAnomalyMonitor +``` + +### Delete +```json +ce:DeleteAnomalyMonitor +``` + diff --git a/docs/aws-docs/providers/aws/ce/anomaly_monitors/index.md b/docs/aws-docs/providers/aws/ce/anomaly_monitors/index.md new file mode 100644 index 0000000000..219e83c855 --- /dev/null +++ b/docs/aws-docs/providers/aws/ce/anomaly_monitors/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionAWS Cost Anomaly Detection leverages advanced Machine Learning technologies to identify anomalous spend and root causes, so you can quickly take action. You can use Cost Anomaly Detection by creating monitor.
Idaws.ce.anomaly_monitors
+ +## Fields + + + + + +
NameDatatypeDescription
monitor_arnundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +monitor_arn +FROM aws.ce.anomaly_monitors +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the anomaly_monitors resource, the following permissions are required: + +### Create +```json +ce:CreateAnomalyMonitor, +ce:TagResource +``` + +### List +```json +ce:GetAnomalyMonitors +``` + diff --git a/docs/aws-docs/providers/aws/ce/anomaly_subscription/index.md b/docs/aws-docs/providers/aws/ce/anomaly_subscription/index.md new file mode 100644 index 0000000000..49cdd3a381 --- /dev/null +++ b/docs/aws-docs/providers/aws/ce/anomaly_subscription/index.md @@ -0,0 +1,103 @@ +--- +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
DescriptionAWS Cost Anomaly Detection leverages advanced Machine Learning technologies to identify anomalous spend and root causes, so you can quickly take action. Create subscription to be notified
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +subscription_arn, +subscription_name, +account_id, +monitor_arn_list, +subscribers, +threshold, +threshold_expression, +frequency, +resource_tags +FROM aws.ce.anomaly_subscription +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the anomaly_subscription resource, the following permissions are required: + +### Read +```json +ce:GetAnomalySubscriptions +``` + +### Update +```json +ce:UpdateAnomalySubscription +``` + +### Delete +```json +ce:DeleteAnomalySubscription +``` + diff --git a/docs/aws-docs/providers/aws/ce/anomaly_subscriptions/index.md b/docs/aws-docs/providers/aws/ce/anomaly_subscriptions/index.md new file mode 100644 index 0000000000..247857411b --- /dev/null +++ b/docs/aws-docs/providers/aws/ce/anomaly_subscriptions/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionAWS Cost Anomaly Detection leverages advanced Machine Learning technologies to identify anomalous spend and root causes, so you can quickly take action. Create subscription to be notified
Idaws.ce.anomaly_subscriptions
+ +## Fields + + + + + +
NameDatatypeDescription
subscription_arnundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +subscription_arn +FROM aws.ce.anomaly_subscriptions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the anomaly_subscriptions resource, the following permissions are required: + +### Create +```json +ce:CreateAnomalySubscription, +ce:TagResource +``` + +### List +```json +ce:GetAnomalySubscriptions +``` + diff --git a/docs/aws-docs/providers/aws/ce/cost_categories/index.md b/docs/aws-docs/providers/aws/ce/cost_categories/index.md new file mode 100644 index 0000000000..ff6d93cf52 --- /dev/null +++ b/docs/aws-docs/providers/aws/ce/cost_categories/index.md @@ -0,0 +1,77 @@ +--- +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 Category enables you to map your cost and usage into meaningful categories. You can use Cost Category to organize your costs using a rule-based engine.
Idaws.ce.cost_categories
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringCost category ARN
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.ce.cost_categories +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the cost_categories resource, the following permissions are required: + +### Create +```json +ce:CreateCostCategoryDefinition +``` + +### List +```json +ce:ListCostCategoryDefinitions +``` + diff --git a/docs/aws-docs/providers/aws/ce/cost_category/index.md b/docs/aws-docs/providers/aws/ce/cost_category/index.md new file mode 100644 index 0000000000..e4e41bf283 --- /dev/null +++ b/docs/aws-docs/providers/aws/ce/cost_category/index.md @@ -0,0 +1,99 @@ +--- +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 enables you to map your cost and usage into meaningful categories. You can use Cost Category to organize your costs using a rule-based engine.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +effective_start, +name, +rule_version, +rules, +split_charge_rules, +default_value +FROM aws.ce.cost_category +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the cost_category resource, the following permissions are required: + +### Read +```json +ce:DescribeCostCategoryDefinition +``` + +### Update +```json +ce:UpdateCostCategoryDefinition +``` + +### Delete +```json +ce:DeleteCostCategoryDefinition +``` + diff --git a/docs/aws-docs/providers/aws/ce/index.md b/docs/aws-docs/providers/aws/ce/index.md new file mode 100644 index 0000000000..7a1dcaa50f --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/certificatemanager/account/index.md b/docs/aws-docs/providers/aws/certificatemanager/account/index.md new file mode 100644 index 0000000000..a54313f5bd --- /dev/null +++ b/docs/aws-docs/providers/aws/certificatemanager/account/index.md @@ -0,0 +1,91 @@ +--- +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
DescriptionResource schema for AWS::CertificateManager::Account.
Idaws.certificatemanager.account
+ +## Fields + + + + + + +
NameDatatypeDescription
expiry_events_configurationobject
account_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +expiry_events_configuration, +account_id +FROM aws.certificatemanager.account +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the account resource, the following permissions are required: + +### Read +```json +acm:GetAccountConfiguration +``` + +### Update +```json +acm:GetAccountConfiguration, +acm:PutAccountConfiguration +``` + +### Delete +```json +acm:GetAccountConfiguration, +acm:PutAccountConfiguration +``` + diff --git a/docs/aws-docs/providers/aws/certificatemanager/accounts/index.md b/docs/aws-docs/providers/aws/certificatemanager/accounts/index.md new file mode 100644 index 0000000000..f55a6b08c8 --- /dev/null +++ b/docs/aws-docs/providers/aws/certificatemanager/accounts/index.md @@ -0,0 +1,68 @@ +--- +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
DescriptionResource schema for AWS::CertificateManager::Account.
Idaws.certificatemanager.accounts
+ +## Fields + + + + + +
NameDatatypeDescription
account_idundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +account_id +FROM aws.certificatemanager.accounts +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the accounts resource, the following permissions are required: + +### Create +```json +acm:GetAccountConfiguration, +acm:PutAccountConfiguration +``` + diff --git a/docs/aws-docs/providers/aws/certificatemanager/index.md b/docs/aws-docs/providers/aws/certificatemanager/index.md new file mode 100644 index 0000000000..96f26c2c3e --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/chatbot/index.md b/docs/aws-docs/providers/aws/chatbot/index.md new file mode 100644 index 0000000000..0109a9a643 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/chatbot/microsoft_teams_channel_configuration/index.md b/docs/aws-docs/providers/aws/chatbot/microsoft_teams_channel_configuration/index.md new file mode 100644 index 0000000000..6af745b99e --- /dev/null +++ b/docs/aws-docs/providers/aws/chatbot/microsoft_teams_channel_configuration/index.md @@ -0,0 +1,107 @@ +--- +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
DescriptionResource schema for AWS::Chatbot::MicrosoftTeamsChannelConfiguration.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.chatbot.microsoft_teams_channel_configuration +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the microsoft_teams_channel_configuration resource, the following permissions are required: + +### Read +```json +chatbot:GetMicrosoftTeamsChannelConfiguration +``` + +### Update +```json +chatbot:UpdateMicrosoftTeamsChannelConfiguration, +iam:PassRole +``` + +### Delete +```json +chatbot:GetMicrosoftTeamsChannelConfiguration, +chatbot:DeleteMicrosoftTeamsChannelConfiguration +``` + diff --git a/docs/aws-docs/providers/aws/chatbot/microsoft_teams_channel_configurations/index.md b/docs/aws-docs/providers/aws/chatbot/microsoft_teams_channel_configurations/index.md new file mode 100644 index 0000000000..f5ec2f3dd3 --- /dev/null +++ b/docs/aws-docs/providers/aws/chatbot/microsoft_teams_channel_configurations/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource schema for AWS::Chatbot::MicrosoftTeamsChannelConfiguration.
Idaws.chatbot.microsoft_teams_channel_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringAmazon Resource Name (ARN) of the configuration
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.chatbot.microsoft_teams_channel_configurations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the microsoft_teams_channel_configurations resource, the following permissions are required: + +### Create +```json +chatbot:CreateMicrosoftTeamsChannelConfiguration, +iam:PassRole, +iam:CreateServiceLinkedRole +``` + +### List +```json +chatbot:ListMicrosoftTeamsChannelConfigurations +``` + diff --git a/docs/aws-docs/providers/aws/chatbot/slack_channel_configuration/index.md b/docs/aws-docs/providers/aws/chatbot/slack_channel_configuration/index.md new file mode 100644 index 0000000000..6fa9a37d48 --- /dev/null +++ b/docs/aws-docs/providers/aws/chatbot/slack_channel_configuration/index.md @@ -0,0 +1,104 @@ +--- +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
DescriptionResource schema for AWS::Chatbot::SlackChannelConfiguration.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.chatbot.slack_channel_configuration +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the slack_channel_configuration resource, the following permissions are required: + +### Read +```json +chatbot:DescribeSlackChannelConfigurations +``` + +### Update +```json +chatbot:UpdateSlackChannelConfiguration, +iam:PassRole +``` + +### Delete +```json +chatbot:DeleteSlackChannelConfiguration +``` + diff --git a/docs/aws-docs/providers/aws/chatbot/slack_channel_configurations/index.md b/docs/aws-docs/providers/aws/chatbot/slack_channel_configurations/index.md new file mode 100644 index 0000000000..3678b684d1 --- /dev/null +++ b/docs/aws-docs/providers/aws/chatbot/slack_channel_configurations/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource schema for AWS::Chatbot::SlackChannelConfiguration.
Idaws.chatbot.slack_channel_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringAmazon Resource Name (ARN) of the configuration
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.chatbot.slack_channel_configurations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the slack_channel_configurations resource, the following permissions are required: + +### Create +```json +chatbot:CreateSlackChannelConfiguration, +iam:PassRole, +iam:CreateServiceLinkedRole +``` + +### List +```json +chatbot:DescribeSlackChannelConfigurations +``` + diff --git a/docs/aws-docs/providers/aws/cleanrooms/analysis_template/index.md b/docs/aws-docs/providers/aws/cleanrooms/analysis_template/index.md new file mode 100644 index 0000000000..a53639c286 --- /dev/null +++ b/docs/aws-docs/providers/aws/cleanrooms/analysis_template/index.md @@ -0,0 +1,120 @@ +--- +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
DescriptionRepresents a stored analysis within a collaboration
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.cleanrooms.analysis_template +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the analysis_template resource, the following permissions are required: + +### Read +```json +cleanrooms:GetAnalysisTemplate, +cleanrooms:ListTagsForResource +``` + +### Update +```json +cleanrooms:UpdateAnalysisTemplate, +cleanrooms:GetAnalysisTemplate, +cleanrooms:ListTagsForResource, +cleanrooms:TagResource, +cleanrooms:UntagResource +``` + +### Delete +```json +cleanrooms:DeleteAnalysisTemplate, +cleanrooms:GetAnalysisTemplate, +cleanrooms:ListAnalysisTemplates, +cleanrooms:ListTagsForResource, +cleanrooms:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/cleanrooms/analysis_templates/index.md b/docs/aws-docs/providers/aws/cleanrooms/analysis_templates/index.md new file mode 100644 index 0000000000..06f7df654b --- /dev/null +++ b/docs/aws-docs/providers/aws/cleanrooms/analysis_templates/index.md @@ -0,0 +1,83 @@ +--- +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
DescriptionRepresents a stored analysis within a collaboration
Idaws.cleanrooms.analysis_templates
+ +## Fields + + + + + + +
NameDatatypeDescription
analysis_template_identifierstring
membership_identifierstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +analysis_template_identifier, +membership_identifier +FROM aws.cleanrooms.analysis_templates +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the analysis_templates resource, the following permissions are required: + +### Create +```json +cleanrooms:CreateAnalysisTemplate, +cleanrooms:ListTagsForResource, +cleanrooms:TagResource, +cleanrooms:GetAnalysisTemplate, +cleanrooms:ListAnalysisTemplates +``` + +### List +```json +cleanrooms:ListAnalysisTemplates +``` + diff --git a/docs/aws-docs/providers/aws/cleanrooms/collaboration/index.md b/docs/aws-docs/providers/aws/cleanrooms/collaboration/index.md new file mode 100644 index 0000000000..934ccb184a --- /dev/null +++ b/docs/aws-docs/providers/aws/cleanrooms/collaboration/index.md @@ -0,0 +1,119 @@ +--- +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
DescriptionRepresents a collaboration between AWS accounts that allows for secure data collaboration
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.cleanrooms.collaboration +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the collaboration resource, the following permissions are required: + +### Read +```json +cleanrooms:GetCollaboration, +cleanrooms:ListMembers, +cleanrooms:ListTagsForResource +``` + +### Update +```json +cleanrooms:UpdateCollaboration, +cleanrooms:GetCollaboration, +cleanrooms:ListMembers, +cleanrooms:ListTagsForResource, +cleanrooms:TagResource, +cleanrooms:UntagResource +``` + +### Delete +```json +cleanrooms:DeleteCollaboration, +cleanrooms:GetCollaboration, +cleanrooms:ListTagsForResource, +cleanrooms:UntagResource, +cleanrooms:ListMembers, +cleanrooms:ListCollaborations +``` + diff --git a/docs/aws-docs/providers/aws/cleanrooms/collaborations/index.md b/docs/aws-docs/providers/aws/cleanrooms/collaborations/index.md new file mode 100644 index 0000000000..50187bf150 --- /dev/null +++ b/docs/aws-docs/providers/aws/cleanrooms/collaborations/index.md @@ -0,0 +1,83 @@ +--- +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
DescriptionRepresents a collaboration between AWS accounts that allows for secure data collaboration
Idaws.cleanrooms.collaborations
+ +## Fields + + + + + +
NameDatatypeDescription
collaboration_identifierstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +collaboration_identifier +FROM aws.cleanrooms.collaborations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the collaborations resource, the following permissions are required: + +### Create +```json +cleanrooms:CreateCollaboration, +cleanrooms:GetCollaboration, +cleanrooms:ListMembers, +cleanrooms:ListTagsForResource, +cleanrooms:TagResource, +cleanrooms:GetCollaboration, +cleanrooms:ListCollaborations +``` + +### List +```json +cleanrooms:ListCollaborations +``` + diff --git a/docs/aws-docs/providers/aws/cleanrooms/configured_table/index.md b/docs/aws-docs/providers/aws/cleanrooms/configured_table/index.md new file mode 100644 index 0000000000..7deaa5afe5 --- /dev/null +++ b/docs/aws-docs/providers/aws/cleanrooms/configured_table/index.md @@ -0,0 +1,135 @@ +--- +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
DescriptionRepresents a table that can be associated with collaborations
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +tags, +allowed_columns, +analysis_method, +configured_table_identifier, +description, +name, +analysis_rules, +table_reference +FROM aws.cleanrooms.configured_table +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the configured_table resource, the following permissions are required: + +### Read +```json +cleanrooms:GetConfiguredTable, +cleanrooms:GetConfiguredTableAnalysisRule, +cleanrooms:ListTagsForResource +``` + +### Update +```json +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 +```json +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 +``` + diff --git a/docs/aws-docs/providers/aws/cleanrooms/configured_table_association/index.md b/docs/aws-docs/providers/aws/cleanrooms/configured_table_association/index.md new file mode 100644 index 0000000000..02b205900f --- /dev/null +++ b/docs/aws-docs/providers/aws/cleanrooms/configured_table_association/index.md @@ -0,0 +1,111 @@ +--- +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
DescriptionRepresents a table that can be queried within a collaboration
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +tags, +configured_table_association_identifier, +configured_table_identifier, +description, +membership_identifier, +name, +role_arn +FROM aws.cleanrooms.configured_table_association +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the configured_table_association resource, the following permissions are required: + +### Read +```json +cleanrooms:GetConfiguredTableAssociation, +cleanrooms:ListTagsForResource +``` + +### Update +```json +cleanrooms:UpdateConfiguredTableAssociation, +cleanrooms:GetConfiguredTableAssociation, +iam:PassRole, +cleanrooms:ListTagsForResource, +cleanrooms:TagResource, +cleanrooms:UntagResource +``` + +### Delete +```json +cleanrooms:DeleteConfiguredTableAssociation, +cleanrooms:GetConfiguredTableAssociation, +cleanrooms:ListConfiguredTableAssociations, +cleanrooms:ListTagsForResource, +cleanrooms:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/cleanrooms/configured_table_associations/index.md b/docs/aws-docs/providers/aws/cleanrooms/configured_table_associations/index.md new file mode 100644 index 0000000000..7df57686bc --- /dev/null +++ b/docs/aws-docs/providers/aws/cleanrooms/configured_table_associations/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionRepresents a table that can be queried within a collaboration
Idaws.cleanrooms.configured_table_associations
+ +## Fields + + + + + + +
NameDatatypeDescription
configured_table_association_identifierstring
membership_identifierstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +configured_table_association_identifier, +membership_identifier +FROM aws.cleanrooms.configured_table_associations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the configured_table_associations resource, the following permissions are required: + +### Create +```json +cleanrooms:CreateConfiguredTableAssociation, +iam:PassRole, +cleanrooms:ListTagsForResource, +cleanrooms:TagResource, +cleanrooms:GetConfiguredTableAssociation, +cleanrooms:ListConfiguredTableAssociations +``` + +### List +```json +cleanrooms:ListConfiguredTableAssociations +``` + diff --git a/docs/aws-docs/providers/aws/cleanrooms/configured_tables/index.md b/docs/aws-docs/providers/aws/cleanrooms/configured_tables/index.md new file mode 100644 index 0000000000..1e24a7e6cf --- /dev/null +++ b/docs/aws-docs/providers/aws/cleanrooms/configured_tables/index.md @@ -0,0 +1,93 @@ +--- +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
DescriptionRepresents a table that can be associated with collaborations
Idaws.cleanrooms.configured_tables
+ +## Fields + + + + + +
NameDatatypeDescription
configured_table_identifierstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +configured_table_identifier +FROM aws.cleanrooms.configured_tables +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the configured_tables resource, the following permissions are required: + +### Create +```json +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 +```json +cleanrooms:ListConfiguredTables +``` + diff --git a/docs/aws-docs/providers/aws/cleanrooms/index.md b/docs/aws-docs/providers/aws/cleanrooms/index.md new file mode 100644 index 0000000000..bd1b090031 --- /dev/null +++ b/docs/aws-docs/providers/aws/cleanrooms/index.md @@ -0,0 +1,49 @@ +--- +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: 12
+total selectable resources: 12
+total methods: 12
+
+
+ +::: + +## Resources +
+
+analysis_template
+analysis_templates
+collaboration
+collaborations
+configured_table
+configured_table_association +
+
+configured_table_associations
+configured_tables
+membership
+memberships
+privacy_budget_template
+privacy_budget_templates +
+
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/cleanrooms/membership/index.md b/docs/aws-docs/providers/aws/cleanrooms/membership/index.md new file mode 100644 index 0000000000..e50ecc4878 --- /dev/null +++ b/docs/aws-docs/providers/aws/cleanrooms/membership/index.md @@ -0,0 +1,129 @@ +--- +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
DescriptionRepresents an AWS account that is a part of a collaboration
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.cleanrooms.membership +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the membership resource, the following permissions are required: + +### Read +```json +cleanrooms:GetMembership, +cleanrooms:ListTagsForResource, +logs:ListLogDeliveries, +logs:DescribeLogGroups, +logs:DescribeResourcePolicies, +logs:GetLogDelivery +``` + +### Update +```json +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 +```json +cleanrooms:DeleteMembership, +cleanrooms:GetMembership, +cleanrooms:ListMemberships, +cleanrooms:ListTagsForResource, +logs:ListLogDeliveries, +logs:DescribeLogGroups, +logs:DescribeResourcePolicies, +logs:GetLogDelivery +``` + diff --git a/docs/aws-docs/providers/aws/cleanrooms/memberships/index.md b/docs/aws-docs/providers/aws/cleanrooms/memberships/index.md new file mode 100644 index 0000000000..c3c030efbf --- /dev/null +++ b/docs/aws-docs/providers/aws/cleanrooms/memberships/index.md @@ -0,0 +1,91 @@ +--- +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
DescriptionRepresents an AWS account that is a part of a collaboration
Idaws.cleanrooms.memberships
+ +## Fields + + + + + +
NameDatatypeDescription
membership_identifierstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +membership_identifier +FROM aws.cleanrooms.memberships +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the memberships resource, the following permissions are required: + +### Create +```json +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 +```json +cleanrooms:ListMemberships +``` + diff --git a/docs/aws-docs/providers/aws/cleanrooms/privacy_budget_template/index.md b/docs/aws-docs/providers/aws/cleanrooms/privacy_budget_template/index.md new file mode 100644 index 0000000000..a5034b72dc --- /dev/null +++ b/docs/aws-docs/providers/aws/cleanrooms/privacy_budget_template/index.md @@ -0,0 +1,114 @@ +--- +title: privacy_budget_template +hide_title: false +hide_table_of_contents: false +keywords: + - privacy_budget_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 privacy_budget_template resource + +## Overview + + + + + +
Nameprivacy_budget_template
TypeResource
DescriptionRepresents a privacy budget within a collaboration
Idaws.cleanrooms.privacy_budget_template
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
collaboration_arnstring
collaboration_identifierstring
privacy_budget_template_identifierstring
tagsarrayAn arbitrary set of tags (key-value pairs) for this cleanrooms privacy budget template.
auto_refreshstring
privacy_budget_typestring
parametersobject
membership_arnstring
membership_identifierstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +collaboration_arn, +collaboration_identifier, +privacy_budget_template_identifier, +tags, +auto_refresh, +privacy_budget_type, +parameters, +membership_arn, +membership_identifier +FROM aws.cleanrooms.privacy_budget_template +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the privacy_budget_template resource, the following permissions are required: + +### Read +```json +cleanrooms:GetPrivacyBudgetTemplate, +cleanrooms:ListTagsForResource +``` + +### Update +```json +cleanrooms:UpdatePrivacyBudgetTemplate, +cleanrooms:GetPrivacyBudgetTemplate, +cleanrooms:ListTagsForResource, +cleanrooms:TagResource, +cleanrooms:UntagResource +``` + +### Delete +```json +cleanrooms:DeletePrivacyBudgetTemplate, +cleanrooms:GetPrivacyBudgetTemplate, +cleanrooms:ListPrivacyBudgetTemplates, +cleanrooms:ListTagsForResource, +cleanrooms:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/cleanrooms/privacy_budget_templates/index.md b/docs/aws-docs/providers/aws/cleanrooms/privacy_budget_templates/index.md new file mode 100644 index 0000000000..d38977b329 --- /dev/null +++ b/docs/aws-docs/providers/aws/cleanrooms/privacy_budget_templates/index.md @@ -0,0 +1,83 @@ +--- +title: privacy_budget_templates +hide_title: false +hide_table_of_contents: false +keywords: + - privacy_budget_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 privacy_budget_templates in a region + +## Overview + + + + + +
Nameprivacy_budget_templates
TypeResource
DescriptionRepresents a privacy budget within a collaboration
Idaws.cleanrooms.privacy_budget_templates
+ +## Fields + + + + + + +
NameDatatypeDescription
privacy_budget_template_identifierstring
membership_identifierstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +privacy_budget_template_identifier, +membership_identifier +FROM aws.cleanrooms.privacy_budget_templates +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the privacy_budget_templates resource, the following permissions are required: + +### Create +```json +cleanrooms:CreatePrivacyBudgetTemplate, +cleanrooms:ListTagsForResource, +cleanrooms:TagResource, +cleanrooms:GetPrivacyBudgetTemplate, +cleanrooms:ListPrivacyBudgetTemplates +``` + +### List +```json +cleanrooms:ListPrivacyBudgetTemplates +``` + diff --git a/docs/aws-docs/providers/aws/cleanroomsml/index.md b/docs/aws-docs/providers/aws/cleanroomsml/index.md new file mode 100644 index 0000000000..1edb5288f4 --- /dev/null +++ b/docs/aws-docs/providers/aws/cleanroomsml/index.md @@ -0,0 +1,39 @@ +--- +title: cleanroomsml +hide_title: false +hide_table_of_contents: false +keywords: + - cleanroomsml + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- + +The cleanroomsml service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+training_dataset +
+
+training_datasets +
+
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/cleanroomsml/training_dataset/index.md b/docs/aws-docs/providers/aws/cleanroomsml/training_dataset/index.md new file mode 100644 index 0000000000..6acdce8930 --- /dev/null +++ b/docs/aws-docs/providers/aws/cleanroomsml/training_dataset/index.md @@ -0,0 +1,100 @@ +--- +title: training_dataset +hide_title: false +hide_table_of_contents: false +keywords: + - training_dataset + - cleanroomsml + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual training_dataset resource + +## Overview + + + + + +
Nametraining_dataset
TypeResource
DescriptionDefinition of AWS::CleanRoomsML::TrainingDataset Resource Type
Idaws.cleanroomsml.training_dataset
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
descriptionstring
namestring
role_arnstring
tagsarrayAn arbitrary set of tags (key-value pairs) for this cleanrooms-ml training dataset.
training_dataarray
training_dataset_arnstring
statusstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +description, +name, +role_arn, +tags, +training_data, +training_dataset_arn, +status +FROM aws.cleanroomsml.training_dataset +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the training_dataset resource, the following permissions are required: + +### Read +```json +cleanrooms-ml:GetTrainingDataset +``` + +### Delete +```json +cleanrooms-ml:DeleteTrainingDataset +``` + +### Update +```json +cleanrooms-ml:TagResource, +cleanrooms-ml:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/cleanroomsml/training_datasets/index.md b/docs/aws-docs/providers/aws/cleanroomsml/training_datasets/index.md new file mode 100644 index 0000000000..1014611e11 --- /dev/null +++ b/docs/aws-docs/providers/aws/cleanroomsml/training_datasets/index.md @@ -0,0 +1,80 @@ +--- +title: training_datasets +hide_title: false +hide_table_of_contents: false +keywords: + - training_datasets + - cleanroomsml + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Retrieves a list of training_datasets in a region + +## Overview + + + + + +
Nametraining_datasets
TypeResource
DescriptionDefinition of AWS::CleanRoomsML::TrainingDataset Resource Type
Idaws.cleanroomsml.training_datasets
+ +## Fields + + + + + +
NameDatatypeDescription
training_dataset_arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +training_dataset_arn +FROM aws.cleanroomsml.training_datasets +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the training_datasets resource, the following permissions are required: + +### Create +```json +cleanrooms-ml:CreateTrainingDataset, +cleanrooms-ml:GetTrainingDataset, +cleanrooms-ml:TagResource, +iam:PassRole +``` + +### List +```json +cleanrooms-ml:ListTrainingDatasets +``` + diff --git a/docs/aws-docs/providers/aws/cloud_control/index.md b/docs/aws-docs/providers/aws/cloud_control/index.md index 7094bb5f6f..f8b411b308 100644 --- a/docs/aws-docs/providers/aws/cloud_control/index.md +++ b/docs/aws-docs/providers/aws/cloud_control/index.md @@ -33,7 +33,7 @@ cloud_control TypeService Titlecloud_control Descriptioncloud_control -Idcloud_control:v24.03.00220 +Idcloud_control:v00.00.00000 ## Resources diff --git a/docs/aws-docs/providers/aws/cloudformation/hook_default_version/index.md b/docs/aws-docs/providers/aws/cloudformation/hook_default_version/index.md new file mode 100644 index 0000000000..42d139d797 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudformation/hook_default_version/index.md @@ -0,0 +1,88 @@ +--- +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
DescriptionSet a version as default version for a hook in CloudFormation Registry.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +type_version_arn, +type_name, +arn, +version_id +FROM aws.cloudformation.hook_default_version +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the hook_default_version resource, the following permissions are required: + +### Read +```json +cloudformation:DescribeType +``` + +### Update +```json +cloudformation:SetTypeDefaultVersion +``` + diff --git a/docs/aws-docs/providers/aws/cloudformation/hook_default_versions/index.md b/docs/aws-docs/providers/aws/cloudformation/hook_default_versions/index.md new file mode 100644 index 0000000000..4a4917210d --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudformation/hook_default_versions/index.md @@ -0,0 +1,77 @@ +--- +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
DescriptionSet a version as default version for a hook in CloudFormation Registry.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.cloudformation.hook_default_versions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the hook_default_versions resource, the following permissions are required: + +### Create +```json +cloudformation:SetTypeDefaultVersion +``` + +### List +```json +cloudformation:ListTypes +``` + diff --git a/docs/aws-docs/providers/aws/cloudformation/hook_type_config/index.md b/docs/aws-docs/providers/aws/cloudformation/hook_type_config/index.md new file mode 100644 index 0000000000..4d2f5f81a7 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudformation/hook_type_config/index.md @@ -0,0 +1,95 @@ +--- +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
DescriptionSpecifies the configuration data for a registered hook in CloudFormation Registry.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +type_arn, +type_name, +configuration_arn, +configuration, +configuration_alias +FROM aws.cloudformation.hook_type_config +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the hook_type_config resource, the following permissions are required: + +### Read +```json +cloudformation:BatchDescribeTypeConfigurations +``` + +### Update +```json +cloudformation:SetTypeConfiguration +``` + +### Delete +```json +cloudformation:SetTypeConfiguration +``` + diff --git a/docs/aws-docs/providers/aws/cloudformation/hook_type_configs/index.md b/docs/aws-docs/providers/aws/cloudformation/hook_type_configs/index.md new file mode 100644 index 0000000000..d0fad826c8 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudformation/hook_type_configs/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionSpecifies the configuration data for a registered hook in CloudFormation Registry.
Idaws.cloudformation.hook_type_configs
+ +## Fields + + + + + +
NameDatatypeDescription
configuration_arnstringThe Amazon Resource Name (ARN) for the configuration data, in this account and region.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +configuration_arn +FROM aws.cloudformation.hook_type_configs +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the hook_type_configs resource, the following permissions are required: + +### Create +```json +cloudformation:SetTypeConfiguration +``` + +### List +```json +cloudformation:ListTypes, +cloudformation:BatchDescribeTypeConfigurations +``` + diff --git a/docs/aws-docs/providers/aws/cloudformation/hook_version/index.md b/docs/aws-docs/providers/aws/cloudformation/hook_version/index.md new file mode 100644 index 0000000000..b42ebdece3 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudformation/hook_version/index.md @@ -0,0 +1,94 @@ +--- +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
DescriptionPublishes new or first hook version to AWS CloudFormation Registry.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +type_arn, +execution_role_arn, +is_default_version, +logging_config, +schema_handler_package, +type_name, +version_id, +visibility +FROM aws.cloudformation.hook_version +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the hook_version resource, the following permissions are required: + +### Read +```json +cloudformation:DescribeType +``` + +### Delete +```json +cloudformation:DeregisterType, +cloudformation:DescribeType +``` + diff --git a/docs/aws-docs/providers/aws/cloudformation/hook_versions/index.md b/docs/aws-docs/providers/aws/cloudformation/hook_versions/index.md new file mode 100644 index 0000000000..87acfff6a5 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudformation/hook_versions/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionPublishes new or first hook version to AWS CloudFormation Registry.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.cloudformation.hook_versions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the hook_versions resource, the following permissions are required: + +### Create +```json +cloudformation:DescribeType, +cloudformation:DescribeTypeRegistration, +cloudformation:RegisterType, +iam:PassRole, +s3:GetObject, +s3:ListBucket, +kms:Decrypt +``` + +### List +```json +cloudformation:ListTypes, +cloudformation:ListTypeVersions +``` + diff --git a/docs/aws-docs/providers/aws/cloudformation/index.md b/docs/aws-docs/providers/aws/cloudformation/index.md new file mode 100644 index 0000000000..f3b7603170 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/cloudformation/module_default_version/index.md b/docs/aws-docs/providers/aws/cloudformation/module_default_version/index.md new file mode 100644 index 0000000000..0e41fc4029 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudformation/module_default_version/index.md @@ -0,0 +1,76 @@ +--- +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
DescriptionA module that has been registered in the CloudFormation registry as the default version
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +module_name, +version_id +FROM aws.cloudformation.module_default_version +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the module_default_version resource, the following permissions are required: + +### Read +```json +cloudformation:DescribeType +``` + diff --git a/docs/aws-docs/providers/aws/cloudformation/module_default_versions/index.md b/docs/aws-docs/providers/aws/cloudformation/module_default_versions/index.md new file mode 100644 index 0000000000..ccf52b38e2 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudformation/module_default_versions/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionA module that has been registered in the CloudFormation registry as the default version
Idaws.cloudformation.module_default_versions
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the module version to set as the default version.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.cloudformation.module_default_versions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the module_default_versions resource, the following permissions are required: + +### Create +```json +cloudformation:DescribeType, +cloudformation:SetTypeDefaultVersion +``` + +### List +```json +cloudformation:ListTypes +``` + diff --git a/docs/aws-docs/providers/aws/cloudformation/module_version/index.md b/docs/aws-docs/providers/aws/cloudformation/module_version/index.md new file mode 100644 index 0000000000..32d3398dba --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudformation/module_version/index.md @@ -0,0 +1,96 @@ +--- +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
DescriptionA module that has been registered in the CloudFormation registry.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +description, +documentation_url, +module_name, +module_package, +is_default_version, +schema, +time_created, +version_id, +visibility +FROM aws.cloudformation.module_version +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the module_version resource, the following permissions are required: + +### Read +```json +cloudformation:DescribeType +``` + +### Delete +```json +cloudformation:DeregisterType, +cloudformation:DescribeType +``` + diff --git a/docs/aws-docs/providers/aws/cloudformation/module_versions/index.md b/docs/aws-docs/providers/aws/cloudformation/module_versions/index.md new file mode 100644 index 0000000000..85ff4f5473 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudformation/module_versions/index.md @@ -0,0 +1,72 @@ +--- +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
DescriptionA module that has been registered in the CloudFormation registry.
Idaws.cloudformation.module_versions
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the module.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.cloudformation.module_versions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the module_versions resource, the following permissions are required: + +### Create +```json +cloudformation:DescribeType, +cloudformation:DescribeTypeRegistration, +cloudformation:ListTypeVersions, +cloudformation:RegisterType, +s3:GetObject, +s3:ListBucket +``` + diff --git a/docs/aws-docs/providers/aws/cloudformation/public_type_version/index.md b/docs/aws-docs/providers/aws/cloudformation/public_type_version/index.md new file mode 100644 index 0000000000..bf2dabf459 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudformation/public_type_version/index.md @@ -0,0 +1,87 @@ +--- +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
DescriptionTest and Publish a resource that has been registered in the CloudFormation Registry.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +type_version_arn, +public_version_number, +publisher_id, +public_type_arn, +type_name, +log_delivery_bucket, +type +FROM aws.cloudformation.public_type_version +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the public_type_version resource, the following permissions are required: + +### Read +```json +cloudformation:DescribeType, +cloudformation:DescribePublisher +``` + diff --git a/docs/aws-docs/providers/aws/cloudformation/public_type_versions/index.md b/docs/aws-docs/providers/aws/cloudformation/public_type_versions/index.md new file mode 100644 index 0000000000..3c6334340a --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudformation/public_type_versions/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionTest and Publish a resource that has been registered in the CloudFormation Registry.
Idaws.cloudformation.public_type_versions
+ +## Fields + + + + + +
NameDatatypeDescription
public_type_arnstringThe Amazon Resource Number (ARN) assigned to the public extension upon publication
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +public_type_arn +FROM aws.cloudformation.public_type_versions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the public_type_versions resource, the following permissions are required: + +### Create +```json +cloudformation:TestType, +cloudformation:DescribeType, +cloudformation:PublishType, +cloudformation:DescribePublisher, +s3:GetObject, +s3:PutObject +``` + +### List +```json +cloudformation:ListTypes +``` + diff --git a/docs/aws-docs/providers/aws/cloudformation/publisher/index.md b/docs/aws-docs/providers/aws/cloudformation/publisher/index.md new file mode 100644 index 0000000000..0fbce573da --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudformation/publisher/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionRegister as a publisher in the CloudFormation Registry.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +accept_terms_and_conditions, +publisher_id, +connection_arn, +publisher_status, +publisher_profile, +identity_provider +FROM aws.cloudformation.publisher +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the publisher resource, the following permissions are required: + +### Read +```json +cloudformation:DescribePublisher +``` + diff --git a/docs/aws-docs/providers/aws/cloudformation/publishers/index.md b/docs/aws-docs/providers/aws/cloudformation/publishers/index.md new file mode 100644 index 0000000000..0b5fa3d02a --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudformation/publishers/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionRegister as a publisher in the CloudFormation Registry.
Idaws.cloudformation.publishers
+ +## Fields + + + + + +
NameDatatypeDescription
publisher_idstringThe publisher id assigned by CloudFormation for publishing in this region.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +publisher_id +FROM aws.cloudformation.publishers +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the publishers resource, the following permissions are required: + +### Create +```json +cloudformation:RegisterPublisher, +cloudformation:DescribePublisher, +codestar-connections:GetConnection, +codestar-connections:UseConnection +``` + +### List +```json +cloudformation:DescribePublisher +``` + diff --git a/docs/aws-docs/providers/aws/cloudformation/resource_default_version/index.md b/docs/aws-docs/providers/aws/cloudformation/resource_default_version/index.md new file mode 100644 index 0000000000..ba075f6ccf --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudformation/resource_default_version/index.md @@ -0,0 +1,93 @@ +--- +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
DescriptionThe default version of a resource that has been registered in the CloudFormation Registry.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +version_id, +type_name, +arn, +type_version_arn +FROM aws.cloudformation.resource_default_version +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the resource_default_version resource, the following permissions are required: + +### Read +```json +cloudformation:DescribeType +``` + +### Update +```json +cloudformation:SetTypeDefaultVersion +``` + +### Delete +```json + +``` + diff --git a/docs/aws-docs/providers/aws/cloudformation/resource_default_versions/index.md b/docs/aws-docs/providers/aws/cloudformation/resource_default_versions/index.md new file mode 100644 index 0000000000..aedae77a2a --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudformation/resource_default_versions/index.md @@ -0,0 +1,77 @@ +--- +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
DescriptionThe default version of a resource that has been registered in the CloudFormation Registry.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.cloudformation.resource_default_versions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the resource_default_versions resource, the following permissions are required: + +### Create +```json +cloudformation:SetTypeDefaultVersion +``` + +### List +```json +cloudformation:ListTypeVersions +``` + diff --git a/docs/aws-docs/providers/aws/cloudformation/resource_version/index.md b/docs/aws-docs/providers/aws/cloudformation/resource_version/index.md new file mode 100644 index 0000000000..f60008ab62 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudformation/resource_version/index.md @@ -0,0 +1,96 @@ +--- +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
DescriptionA resource that has been registered in the CloudFormation Registry.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.cloudformation.resource_version +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the resource_version resource, the following permissions are required: + +### Read +```json +cloudformation:DescribeType +``` + +### Delete +```json +cloudformation:DeregisterType, +cloudformation:DescribeType +``` + diff --git a/docs/aws-docs/providers/aws/cloudformation/resource_versions/index.md b/docs/aws-docs/providers/aws/cloudformation/resource_versions/index.md new file mode 100644 index 0000000000..ef09261b51 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudformation/resource_versions/index.md @@ -0,0 +1,85 @@ +--- +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
DescriptionA resource that has been registered in the CloudFormation Registry.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.cloudformation.resource_versions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the resource_versions resource, the following permissions are required: + +### Create +```json +cloudformation:DescribeTypeRegistration, +cloudformation:RegisterType, +iam:PassRole, +s3:GetObject, +s3:ListBucket, +kms:Decrypt, +cloudformation:ListTypeVersions, +cloudformation:DeregisterType, +cloudformation:DescribeType +``` + +### List +```json +cloudformation:ListTypes +``` + diff --git a/docs/aws-docs/providers/aws/cloudformation/stack/index.md b/docs/aws-docs/providers/aws/cloudformation/stack/index.md new file mode 100644 index 0000000000..d516e34ad7 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudformation/stack/index.md @@ -0,0 +1,138 @@ +--- +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
DescriptionThe AWS::CloudFormation::Stack resource nests a stack as a resource in a top-level template.
Idaws.cloudformation.stack
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
capabilitiesarray
role_arnstring
outputsarray
descriptionstring
disable_rollbackboolean
enable_termination_protectionboolean
notification_arnsarray
parametersobject
parent_idstring
root_idstring
change_set_idstring
stack_namestring
stack_idstring
stack_policy_bodyobject
stack_policy_urlstring
stack_statusstring
stack_status_reasonstring
tagsarray
template_bodyobject
template_urlstring
timeout_in_minutesinteger
last_update_timestring
creation_timestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +capabilities, +role_arn, +outputs, +description, +disable_rollback, +enable_termination_protection, +notification_arns, +parameters, +parent_id, +root_id, +change_set_id, +stack_name, +stack_id, +stack_policy_body, +stack_policy_url, +stack_status, +stack_status_reason, +tags, +template_body, +template_url, +timeout_in_minutes, +last_update_time, +creation_time +FROM aws.cloudformation.stack +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the stack resource, the following permissions are required: + +### Update +```json +cloudformation:DescribeStacks, +cloudformation:UpdateStack, +cloudformation:UpdateTerminationProtection, +cloudformation:SetStackPolicy, +iam:PassRole +``` + +### Delete +```json +cloudformation:DescribeStacks, +cloudformation:DeleteStack +``` + +### Read +```json +cloudformation:DescribeStacks, +cloudformation:GetStackPolicy, +cloudformation:GetTemplate +``` + diff --git a/docs/aws-docs/providers/aws/cloudformation/stack_set/index.md b/docs/aws-docs/providers/aws/cloudformation/stack_set/index.md new file mode 100644 index 0000000000..abb0151e71 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudformation/stack_set/index.md @@ -0,0 +1,134 @@ +--- +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
DescriptionStackSet as a resource provides one-click experience for provisioning a StackSet and StackInstances
Idaws.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_arnstringThe 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_urlstringLocation 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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +stack_set_name, +stack_set_id, +administration_role_arn, +auto_deployment, +capabilities, +description, +execution_role_name, +operation_preferences, +stack_instances_group, +parameters, +permission_model, +tags, +template_body, +template_url, +call_as, +managed_execution +FROM aws.cloudformation.stack_set +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the stack_set resource, the following permissions are required: + +### Read +```json +cloudformation:DescribeStackSet, +cloudformation:ListStackInstances, +cloudformation:DescribeStackInstance +``` + +### Update +```json +cloudformation:GetTemplateSummary, +cloudformation:UpdateStackSet, +cloudformation:CreateStackInstances, +cloudformation:DeleteStackInstances, +cloudformation:UpdateStackInstances, +cloudformation:DescribeStackSet, +cloudformation:DescribeStackSetOperation, +cloudformation:ListStackSetOperationResults, +cloudformation:TagResource, +cloudformation:UntagResource, +iam:PassRole +``` + +### Delete +```json +cloudformation:DeleteStackSet, +cloudformation:DeleteStackInstances, +cloudformation:DescribeStackSet, +cloudformation:DescribeStackSetOperation, +cloudformation:ListStackSetOperationResults, +cloudformation:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/cloudformation/stack_sets/index.md b/docs/aws-docs/providers/aws/cloudformation/stack_sets/index.md new file mode 100644 index 0000000000..513dad9536 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudformation/stack_sets/index.md @@ -0,0 +1,86 @@ +--- +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
DescriptionStackSet as a resource provides one-click experience for provisioning a StackSet and StackInstances
Idaws.cloudformation.stack_sets
+ +## Fields + + + + + +
NameDatatypeDescription
stack_set_idstringThe ID of the stack set that you're creating.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +stack_set_id +FROM aws.cloudformation.stack_sets +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the stack_sets resource, the following permissions are required: + +### Create +```json +cloudformation:GetTemplateSummary, +cloudformation:CreateStackSet, +cloudformation:CreateStackInstances, +cloudformation:DescribeStackSetOperation, +cloudformation:ListStackSetOperationResults, +cloudformation:TagResource, +iam:PassRole +``` + +### List +```json +cloudformation:ListStackSets, +cloudformation:DescribeStackSet, +cloudformation:ListStackInstances, +cloudformation:DescribeStackInstance +``` + diff --git a/docs/aws-docs/providers/aws/cloudformation/stacks/index.md b/docs/aws-docs/providers/aws/cloudformation/stacks/index.md new file mode 100644 index 0000000000..e69a606b7e --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudformation/stacks/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionThe AWS::CloudFormation::Stack resource nests a stack as a resource in a top-level template.
Idaws.cloudformation.stacks
+ +## Fields + + + + + +
NameDatatypeDescription
stack_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +stack_id +FROM aws.cloudformation.stacks +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the stacks resource, the following permissions are required: + +### Create +```json +cloudformation:DescribeStacks, +cloudformation:CreateStack, +iam:PassRole +``` + +### List +```json +cloudformation:ListStacks +``` + diff --git a/docs/aws-docs/providers/aws/cloudformation/type_activation/index.md b/docs/aws-docs/providers/aws/cloudformation/type_activation/index.md new file mode 100644 index 0000000000..1526e3cd76 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudformation/type_activation/index.md @@ -0,0 +1,110 @@ +--- +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
DescriptionEnable a resource that has been published in the CloudFormation Registry.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.cloudformation.type_activation +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the type_activation resource, the following permissions are required: + +### Update +```json +cloudformation:ActivateType, +cloudformation:DescribeType, +iam:PassRole +``` + +### Read +```json +cloudformation:DescribeType +``` + +### Delete +```json +cloudformation:DeactivateType, +cloudformation:DescribeType +``` + diff --git a/docs/aws-docs/providers/aws/cloudformation/type_activations/index.md b/docs/aws-docs/providers/aws/cloudformation/type_activations/index.md new file mode 100644 index 0000000000..0d8a954922 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudformation/type_activations/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionEnable a resource that has been published in the CloudFormation Registry.
Idaws.cloudformation.type_activations
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the extension.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.cloudformation.type_activations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the type_activations resource, the following permissions are required: + +### Create +```json +cloudformation:ActivateType, +cloudformation:DescribeType, +iam:PassRole +``` + +### List +```json +cloudformation:ListTypes +``` + diff --git a/docs/aws-docs/providers/aws/cloudfront/cache_policies/index.md b/docs/aws-docs/providers/aws/cloudfront/cache_policies/index.md new file mode 100644 index 0000000000..496847bb48 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudfront/cache_policies/index.md @@ -0,0 +1,77 @@ +--- +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
DescriptionResource Type definition for AWS::CloudFront::CachePolicy
Idaws.cloudfront.cache_policies
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.cloudfront.cache_policies + +``` + +## Permissions + +To operate on the cache_policies resource, the following permissions are required: + +### Create +```json +cloudfront:CreateCachePolicy +``` + +### List +```json +cloudfront:ListCachePolicies +``` + diff --git a/docs/aws-docs/providers/aws/cloudfront/cache_policy/index.md b/docs/aws-docs/providers/aws/cloudfront/cache_policy/index.md new file mode 100644 index 0000000000..699353786a --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudfront/cache_policy/index.md @@ -0,0 +1,93 @@ +--- +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
DescriptionResource Type definition for AWS::CloudFront::CachePolicy
Idaws.cloudfront.cache_policy
+ +## Fields + + + + + + + +
NameDatatypeDescription
cache_policy_configobject
idstring
last_modified_timestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +cache_policy_config, +id, +last_modified_time +FROM aws.cloudfront.cache_policy +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the cache_policy resource, the following permissions are required: + +### Delete +```json +cloudfront:DeleteCachePolicy, +cloudfront:GetCachePolicy +``` + +### Read +```json +cloudfront:GetCachePolicy +``` + +### Update +```json +cloudfront:UpdateCachePolicy, +cloudfront:GetCachePolicy +``` + diff --git a/docs/aws-docs/providers/aws/cloudfront/cloud_front_origin_access_identities/index.md b/docs/aws-docs/providers/aws/cloudfront/cloud_front_origin_access_identities/index.md new file mode 100644 index 0000000000..e25d00ee86 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudfront/cloud_front_origin_access_identities/index.md @@ -0,0 +1,77 @@ +--- +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
DescriptionResource Type definition for AWS::CloudFront::CloudFrontOriginAccessIdentity
Idaws.cloudfront.cloud_front_origin_access_identities
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.cloudfront.cloud_front_origin_access_identities + +``` + +## Permissions + +To operate on the cloud_front_origin_access_identities resource, the following permissions are required: + +### Create +```json +cloudfront:CreateCloudFrontOriginAccessIdentity +``` + +### List +```json +cloudfront:ListCloudFrontOriginAccessIdentities +``` + diff --git a/docs/aws-docs/providers/aws/cloudfront/cloud_front_origin_access_identity/index.md b/docs/aws-docs/providers/aws/cloudfront/cloud_front_origin_access_identity/index.md new file mode 100644 index 0000000000..a451bf8b3e --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudfront/cloud_front_origin_access_identity/index.md @@ -0,0 +1,93 @@ +--- +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
DescriptionResource Type definition for AWS::CloudFront::CloudFrontOriginAccessIdentity
Idaws.cloudfront.cloud_front_origin_access_identity
+ +## Fields + + + + + + + +
NameDatatypeDescription
cloud_front_origin_access_identity_configobject
idstring
s3_canonical_user_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +cloud_front_origin_access_identity_config, +id, +s3_canonical_user_id +FROM aws.cloudfront.cloud_front_origin_access_identity +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the cloud_front_origin_access_identity resource, the following permissions are required: + +### Delete +```json +cloudfront:DeleteCloudFrontOriginAccessIdentity, +cloudfront:GetCloudFrontOriginAccessIdentity +``` + +### Read +```json +cloudfront:GetCloudFrontOriginAccessIdentity +``` + +### Update +```json +cloudfront:UpdateCloudFrontOriginAccessIdentity, +cloudfront:GetCloudFrontOriginAccessIdentity +``` + diff --git a/docs/aws-docs/providers/aws/cloudfront/continuous_deployment_policies/index.md b/docs/aws-docs/providers/aws/cloudfront/continuous_deployment_policies/index.md new file mode 100644 index 0000000000..8cb98788bc --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudfront/continuous_deployment_policies/index.md @@ -0,0 +1,77 @@ +--- +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
DescriptionResource Type definition for AWS::CloudFront::ContinuousDeploymentPolicy
Idaws.cloudfront.continuous_deployment_policies
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.cloudfront.continuous_deployment_policies + +``` + +## Permissions + +To operate on the continuous_deployment_policies resource, the following permissions are required: + +### Create +```json +cloudfront:CreateContinuousDeploymentPolicy +``` + +### List +```json +cloudfront:ListContinuousDeploymentPolicies +``` + diff --git a/docs/aws-docs/providers/aws/cloudfront/continuous_deployment_policy/index.md b/docs/aws-docs/providers/aws/cloudfront/continuous_deployment_policy/index.md new file mode 100644 index 0000000000..dcd10dd293 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudfront/continuous_deployment_policy/index.md @@ -0,0 +1,93 @@ +--- +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
DescriptionResource Type definition for AWS::CloudFront::ContinuousDeploymentPolicy
Idaws.cloudfront.continuous_deployment_policy
+ +## Fields + + + + + + + +
NameDatatypeDescription
continuous_deployment_policy_configobject
idstring
last_modified_timestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +continuous_deployment_policy_config, +id, +last_modified_time +FROM aws.cloudfront.continuous_deployment_policy +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the continuous_deployment_policy resource, the following permissions are required: + +### Delete +```json +cloudfront:DeleteContinuousDeploymentPolicy, +cloudfront:GetContinuousDeploymentPolicy +``` + +### Read +```json +cloudfront:GetContinuousDeploymentPolicy +``` + +### Update +```json +cloudfront:UpdateContinuousDeploymentPolicy, +cloudfront:GetContinuousDeploymentPolicy +``` + diff --git a/docs/aws-docs/providers/aws/cloudfront/distribution/index.md b/docs/aws-docs/providers/aws/cloudfront/distribution/index.md new file mode 100644 index 0000000000..295bbf1d2c --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudfront/distribution/index.md @@ -0,0 +1,102 @@ +--- +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
DescriptionA distribution tells CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +distribution_config, +domain_name, +id, +tags +FROM aws.cloudfront.distribution +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the distribution resource, the following permissions are required: + +### Delete +```json +cloudfront:DeleteDistribution, +cloudfront:GetDistribution, +cloudfront:GetDistributionConfig +``` + +### Read +```json +cloudfront:GetDistribution, +cloudfront:GetDistributionConfig +``` + +### Update +```json +cloudfront:GetDistribution, +cloudfront:GetDistributionConfig, +cloudfront:UpdateDistribution, +cloudfront:UpdateDistributionWithStagingConfig, +cloudfront:ListTagsForResource, +cloudfront:TagResource, +cloudfront:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/cloudfront/distributions/index.md b/docs/aws-docs/providers/aws/cloudfront/distributions/index.md new file mode 100644 index 0000000000..5053193813 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudfront/distributions/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionA distribution tells CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery.
Idaws.cloudfront.distributions
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.cloudfront.distributions + +``` + +## Permissions + +To operate on the distributions resource, the following permissions are required: + +### Create +```json +cloudfront:CreateDistribution, +cloudfront:CreateDistributionWithTags, +cloudfront:GetDistribution, +cloudfront:GetDistributionConfig, +cloudfront:TagResource +``` + +### List +```json +cloudfront:ListDistributions +``` + diff --git a/docs/aws-docs/providers/aws/cloudfront/function/index.md b/docs/aws-docs/providers/aws/cloudfront/function/index.md new file mode 100644 index 0000000000..bfc3389118 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudfront/function/index.md @@ -0,0 +1,103 @@ +--- +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
DescriptionResource Type definition for AWS::CloudFront::Function
Idaws.cloudfront.function
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
auto_publishboolean
function_arnstring
function_codestring
function_configobject
function_metadataobject
namestring
stagestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +auto_publish, +function_arn, +function_code, +function_config, +function_metadata, +name, +stage +FROM aws.cloudfront.function +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the function resource, the following permissions are required: + +### Delete +```json +cloudfront:DeleteFunction, +cloudfront:DescribeFunction +``` + +### Read +```json +cloudfront:DescribeFunction, +cloudfront:GetFunction +``` + +### Update +```json +cloudfront:UpdateFunction, +cloudfront:PublishFunction, +cloudfront:DescribeFunction +``` + diff --git a/docs/aws-docs/providers/aws/cloudfront/functions/index.md b/docs/aws-docs/providers/aws/cloudfront/functions/index.md new file mode 100644 index 0000000000..7a5bce39d1 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudfront/functions/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource Type definition for AWS::CloudFront::Function
Idaws.cloudfront.functions
+ +## Fields + + + + + +
NameDatatypeDescription
function_arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +function_arn +FROM aws.cloudfront.functions + +``` + +## Permissions + +To operate on the functions resource, the following permissions are required: + +### Create +```json +cloudfront:CreateFunction, +cloudfront:PublishFunction, +cloudfront:DescribeFunction +``` + +### List +```json +cloudfront:ListFunctions +``` + diff --git a/docs/aws-docs/providers/aws/cloudfront/index.md b/docs/aws-docs/providers/aws/cloudfront/index.md new file mode 100644 index 0000000000..867f659f2d --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/cloudfront/key_group/index.md b/docs/aws-docs/providers/aws/cloudfront/key_group/index.md new file mode 100644 index 0000000000..bbb72b949c --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudfront/key_group/index.md @@ -0,0 +1,93 @@ +--- +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
DescriptionResource Type definition for AWS::CloudFront::KeyGroup
Idaws.cloudfront.key_group
+ +## Fields + + + + + + + +
NameDatatypeDescription
idstring
key_group_configobject
last_modified_timestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +key_group_config, +last_modified_time +FROM aws.cloudfront.key_group +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the key_group resource, the following permissions are required: + +### Delete +```json +cloudfront:DeleteKeyGroup, +cloudfront:GetKeyGroup +``` + +### Read +```json +cloudfront:GetKeyGroup +``` + +### Update +```json +cloudfront:UpdateKeyGroup, +cloudfront:GetKeyGroup +``` + diff --git a/docs/aws-docs/providers/aws/cloudfront/key_groups/index.md b/docs/aws-docs/providers/aws/cloudfront/key_groups/index.md new file mode 100644 index 0000000000..5b866872b6 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudfront/key_groups/index.md @@ -0,0 +1,77 @@ +--- +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
DescriptionResource Type definition for AWS::CloudFront::KeyGroup
Idaws.cloudfront.key_groups
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.cloudfront.key_groups + +``` + +## Permissions + +To operate on the key_groups resource, the following permissions are required: + +### Create +```json +cloudfront:CreateKeyGroup +``` + +### List +```json +cloudfront:ListKeyGroups +``` + diff --git a/docs/aws-docs/providers/aws/cloudfront/key_value_store/index.md b/docs/aws-docs/providers/aws/cloudfront/key_value_store/index.md new file mode 100644 index 0000000000..3cfc1b2c4c --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudfront/key_value_store/index.md @@ -0,0 +1,99 @@ +--- +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
DescriptionResource Type definition for AWS::CloudFront::KeyValueStore
Idaws.cloudfront.key_value_store
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
arnstring
idstring
statusstring
namestring
commentstring
import_sourceobject
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +id, +status, +name, +comment, +import_source +FROM aws.cloudfront.key_value_store +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the key_value_store resource, the following permissions are required: + +### Delete +```json +cloudfront:DeleteKeyValueStore, +cloudfront:DescribeKeyValueStore +``` + +### Read +```json +cloudfront:DescribeKeyValueStore +``` + +### Update +```json +cloudfront:UpdateKeyValueStore, +cloudfront:DescribeKeyValueStore +``` + diff --git a/docs/aws-docs/providers/aws/cloudfront/key_value_stores/index.md b/docs/aws-docs/providers/aws/cloudfront/key_value_stores/index.md new file mode 100644 index 0000000000..4af389d920 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudfront/key_value_stores/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionResource Type definition for AWS::CloudFront::KeyValueStore
Idaws.cloudfront.key_value_stores
+ +## Fields + + + + + +
NameDatatypeDescription
namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.cloudfront.key_value_stores + +``` + +## Permissions + +To operate on the key_value_stores resource, the following permissions are required: + +### Create +```json +cloudfront:CreateKeyValueStore, +cloudfront:DescribeKeyValueStore, +s3:GetObject, +s3:HeadObject, +s3:GetBucketLocation +``` + +### List +```json +cloudfront:ListKeyValueStores +``` + diff --git a/docs/aws-docs/providers/aws/cloudfront/monitoring_subscription/index.md b/docs/aws-docs/providers/aws/cloudfront/monitoring_subscription/index.md new file mode 100644 index 0000000000..f98a518e24 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudfront/monitoring_subscription/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource Type definition for AWS::CloudFront::MonitoringSubscription
Idaws.cloudfront.monitoring_subscription
+ +## Fields + + + + + + +
NameDatatypeDescription
distribution_idstring
monitoring_subscriptionobject
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +distribution_id, +monitoring_subscription +FROM aws.cloudfront.monitoring_subscription +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the monitoring_subscription resource, the following permissions are required: + +### Delete +```json +cloudfront:DeleteMonitoringSubscription +``` + +### Read +```json +cloudfront:GetMonitoringSubscription +``` + diff --git a/docs/aws-docs/providers/aws/cloudfront/monitoring_subscriptions/index.md b/docs/aws-docs/providers/aws/cloudfront/monitoring_subscriptions/index.md new file mode 100644 index 0000000000..598660ad86 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudfront/monitoring_subscriptions/index.md @@ -0,0 +1,67 @@ +--- +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
DescriptionResource Type definition for AWS::CloudFront::MonitoringSubscription
Idaws.cloudfront.monitoring_subscriptions
+ +## Fields + + + + + +
NameDatatypeDescription
distribution_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +distribution_id +FROM aws.cloudfront.monitoring_subscriptions + +``` + +## Permissions + +To operate on the monitoring_subscriptions resource, the following permissions are required: + +### Create +```json +cloudfront:CreateMonitoringSubscription +``` + diff --git a/docs/aws-docs/providers/aws/cloudfront/origin_access_control/index.md b/docs/aws-docs/providers/aws/cloudfront/origin_access_control/index.md new file mode 100644 index 0000000000..fc2cb30bea --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudfront/origin_access_control/index.md @@ -0,0 +1,91 @@ +--- +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
DescriptionResource Type definition for AWS::CloudFront::OriginAccessControl
Idaws.cloudfront.origin_access_control
+ +## Fields + + + + + + +
NameDatatypeDescription
idstring
origin_access_control_configobject
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +origin_access_control_config +FROM aws.cloudfront.origin_access_control +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the origin_access_control resource, the following permissions are required: + +### Delete +```json +cloudfront:DeleteOriginAccessControl, +cloudfront:GetOriginAccessControl +``` + +### Read +```json +cloudfront:GetOriginAccessControl +``` + +### Update +```json +cloudfront:UpdateOriginAccessControl, +cloudfront:GetOriginAccessControl +``` + diff --git a/docs/aws-docs/providers/aws/cloudfront/origin_access_controls/index.md b/docs/aws-docs/providers/aws/cloudfront/origin_access_controls/index.md new file mode 100644 index 0000000000..e8e70ea4e3 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudfront/origin_access_controls/index.md @@ -0,0 +1,77 @@ +--- +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
DescriptionResource Type definition for AWS::CloudFront::OriginAccessControl
Idaws.cloudfront.origin_access_controls
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.cloudfront.origin_access_controls + +``` + +## Permissions + +To operate on the origin_access_controls resource, the following permissions are required: + +### Create +```json +cloudfront:CreateOriginAccessControl +``` + +### List +```json +cloudfront:ListOriginAccessControls +``` + diff --git a/docs/aws-docs/providers/aws/cloudfront/origin_request_policies/index.md b/docs/aws-docs/providers/aws/cloudfront/origin_request_policies/index.md new file mode 100644 index 0000000000..3a078bcd4f --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudfront/origin_request_policies/index.md @@ -0,0 +1,77 @@ +--- +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
DescriptionResource Type definition for AWS::CloudFront::OriginRequestPolicy
Idaws.cloudfront.origin_request_policies
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.cloudfront.origin_request_policies + +``` + +## Permissions + +To operate on the origin_request_policies resource, the following permissions are required: + +### Create +```json +cloudfront:CreateOriginRequestPolicy +``` + +### List +```json +cloudfront:ListOriginRequestPolicies +``` + diff --git a/docs/aws-docs/providers/aws/cloudfront/origin_request_policy/index.md b/docs/aws-docs/providers/aws/cloudfront/origin_request_policy/index.md new file mode 100644 index 0000000000..a39ee25598 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudfront/origin_request_policy/index.md @@ -0,0 +1,93 @@ +--- +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
DescriptionResource Type definition for AWS::CloudFront::OriginRequestPolicy
Idaws.cloudfront.origin_request_policy
+ +## Fields + + + + + + + +
NameDatatypeDescription
idstring
last_modified_timestring
origin_request_policy_configobject
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +last_modified_time, +origin_request_policy_config +FROM aws.cloudfront.origin_request_policy +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the origin_request_policy resource, the following permissions are required: + +### Delete +```json +cloudfront:DeleteOriginRequestPolicy, +cloudfront:GetOriginRequestPolicy +``` + +### Read +```json +cloudfront:GetOriginRequestPolicy +``` + +### Update +```json +cloudfront:UpdateOriginRequestPolicy, +cloudfront:GetOriginRequestPolicy +``` + diff --git a/docs/aws-docs/providers/aws/cloudfront/public_key/index.md b/docs/aws-docs/providers/aws/cloudfront/public_key/index.md new file mode 100644 index 0000000000..55617b2ae7 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudfront/public_key/index.md @@ -0,0 +1,93 @@ +--- +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
DescriptionResource Type definition for AWS::CloudFront::PublicKey
Idaws.cloudfront.public_key
+ +## Fields + + + + + + + +
NameDatatypeDescription
created_timestring
idstring
public_key_configobject
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +created_time, +id, +public_key_config +FROM aws.cloudfront.public_key +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the public_key resource, the following permissions are required: + +### Delete +```json +cloudfront:DeletePublicKey, +cloudfront:GetPublicKey +``` + +### Read +```json +cloudfront:GetPublicKey +``` + +### Update +```json +cloudfront:UpdatePublicKey, +cloudfront:GetPublicKey +``` + diff --git a/docs/aws-docs/providers/aws/cloudfront/public_keys/index.md b/docs/aws-docs/providers/aws/cloudfront/public_keys/index.md new file mode 100644 index 0000000000..413f3d75b1 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudfront/public_keys/index.md @@ -0,0 +1,77 @@ +--- +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
DescriptionResource Type definition for AWS::CloudFront::PublicKey
Idaws.cloudfront.public_keys
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.cloudfront.public_keys + +``` + +## Permissions + +To operate on the public_keys resource, the following permissions are required: + +### Create +```json +cloudfront:CreatePublicKey +``` + +### List +```json +cloudfront:ListPublicKeys +``` + diff --git a/docs/aws-docs/providers/aws/cloudfront/realtime_log_config/index.md b/docs/aws-docs/providers/aws/cloudfront/realtime_log_config/index.md new file mode 100644 index 0000000000..14bbef5b7a --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudfront/realtime_log_config/index.md @@ -0,0 +1,98 @@ +--- +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
DescriptionResource Type definition for AWS::CloudFront::RealtimeLogConfig
Idaws.cloudfront.realtime_log_config
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
arnstring
end_pointsarray
fieldsarray
namestring
sampling_ratenumber
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +end_points, +fields, +name, +sampling_rate +FROM aws.cloudfront.realtime_log_config +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the realtime_log_config resource, the following permissions are required: + +### Delete +```json +cloudfront:DeleteRealtimeLogConfig, +cloudfront:GetRealtimeLogConfig +``` + +### Read +```json +cloudfront:GetRealtimeLogConfig +``` + +### Update +```json +cloudfront:UpdateRealtimeLogConfig, +cloudfront:GetRealtimeLogConfig, +iam:PassRole +``` + diff --git a/docs/aws-docs/providers/aws/cloudfront/realtime_log_configs/index.md b/docs/aws-docs/providers/aws/cloudfront/realtime_log_configs/index.md new file mode 100644 index 0000000000..e32c4be86d --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudfront/realtime_log_configs/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionResource Type definition for AWS::CloudFront::RealtimeLogConfig
Idaws.cloudfront.realtime_log_configs
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.cloudfront.realtime_log_configs + +``` + +## Permissions + +To operate on the realtime_log_configs resource, the following permissions are required: + +### Create +```json +cloudfront:CreateRealtimeLogConfig, +iam:PassRole +``` + +### List +```json +cloudfront:ListRealtimeLogConfigs +``` + diff --git a/docs/aws-docs/providers/aws/cloudfront/response_headers_policies/index.md b/docs/aws-docs/providers/aws/cloudfront/response_headers_policies/index.md new file mode 100644 index 0000000000..c40b2780b7 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudfront/response_headers_policies/index.md @@ -0,0 +1,77 @@ +--- +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
DescriptionResource Type definition for AWS::CloudFront::ResponseHeadersPolicy
Idaws.cloudfront.response_headers_policies
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.cloudfront.response_headers_policies + +``` + +## Permissions + +To operate on the response_headers_policies resource, the following permissions are required: + +### Create +```json +cloudfront:CreateResponseHeadersPolicy +``` + +### List +```json +cloudfront:ListResponseHeadersPolicies +``` + diff --git a/docs/aws-docs/providers/aws/cloudfront/response_headers_policy/index.md b/docs/aws-docs/providers/aws/cloudfront/response_headers_policy/index.md new file mode 100644 index 0000000000..f549be3cb6 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudfront/response_headers_policy/index.md @@ -0,0 +1,93 @@ +--- +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
DescriptionResource Type definition for AWS::CloudFront::ResponseHeadersPolicy
Idaws.cloudfront.response_headers_policy
+ +## Fields + + + + + + + +
NameDatatypeDescription
idstring
last_modified_timestring
response_headers_policy_configobject
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +last_modified_time, +response_headers_policy_config +FROM aws.cloudfront.response_headers_policy +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the response_headers_policy resource, the following permissions are required: + +### Delete +```json +cloudfront:DeleteResponseHeadersPolicy, +cloudfront:GetResponseHeadersPolicy +``` + +### Read +```json +cloudfront:GetResponseHeadersPolicy +``` + +### Update +```json +cloudfront:UpdateResponseHeadersPolicy, +cloudfront:GetResponseHeadersPolicy +``` + diff --git a/docs/aws-docs/providers/aws/cloudhsm/backups/index.md b/docs/aws-docs/providers/aws/cloudhsm/backups/index.md new file mode 100644 index 0000000000..cc2e61632c --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudhsm/backups/index.md @@ -0,0 +1,48 @@ +--- +title: backups +hide_title: false +hide_table_of_contents: false +keywords: + - backups + - cloudhsm + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namebackups
TypeResource
Idaws.cloudhsm.backups
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `BackupId` | `string` | The identifier (ID) of the backup. | +| `BackupState` | `string` | The state of the backup. | +| `ClusterId` | `string` | The identifier (ID) of the cluster that was backed up. | +| `CopyTimestamp` | `string` | The date and time when the backup was copied from a source backup. | +| `CreateTimestamp` | `string` | The date and time when the backup was created. | +| `DeleteTimestamp` | `string` | The date and time when the backup will be permanently deleted. | +| `NeverExpires` | `boolean` | Specifies whether the service should exempt a backup from the retention policy for the cluster. <code>True</code> exempts a backup from the retention policy. <code>False</code> means the service applies the backup retention policy defined at the cluster. | +| `SourceBackup` | `string` | The identifier (ID) of the source backup from which the new backup was copied. | +| `SourceCluster` | `string` | The identifier (ID) of the cluster containing the source backup from which the new backup was copied. | +| `SourceRegion` | `string` | The AWS Region that contains the source backup from which the new backup was copied. | +| `TagList` | `array` | The list of tags for the backup. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `describe_backups` | `SELECT` | `region` | <p>Gets information about backups of AWS CloudHSM clusters.</p> <p>This is a paginated operation, which means that each response might contain only a subset of all the backups. When the response contains only a subset of backups, it includes a <code>NextToken</code> value. Use this value in a subsequent <code>DescribeBackups</code> request to get more backups. When you receive a response with no <code>NextToken</code> (or an empty or null value), that means there are no more backups to get.</p> | +| `delete_backup` | `DELETE` | `X-Amz-Target, data__BackupId, region` | Deletes a specified AWS CloudHSM backup. A backup can be restored up to 7 days after the DeleteBackup request is made. For more information on restoring a backup, see <a>RestoreBackup</a>. | +| `copy_backup_to_region` | `EXEC` | `X-Amz-Target, data__BackupId, data__DestinationRegion, region` | Copy an AWS CloudHSM cluster backup to a different region. | +| `modify_backup_attributes` | `EXEC` | `X-Amz-Target, data__BackupId, data__NeverExpires, region` | Modifies attributes for AWS CloudHSM backup. | +| `restore_backup` | `EXEC` | `X-Amz-Target, data__BackupId, region` | Restores a specified AWS CloudHSM backup that is in the <code>PENDING_DELETION</code> state. For mor information on deleting a backup, see <a>DeleteBackup</a>. | diff --git a/docs/aws-docs/providers/aws/cloudhsm/clusters/index.md b/docs/aws-docs/providers/aws/cloudhsm/clusters/index.md new file mode 100644 index 0000000000..560528bfb7 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudhsm/clusters/index.md @@ -0,0 +1,52 @@ +--- +title: clusters +hide_title: false +hide_table_of_contents: false +keywords: + - clusters + - cloudhsm + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameclusters
TypeResource
Idaws.cloudhsm.clusters
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `BackupPolicy` | `string` | The cluster's backup policy. | +| `BackupRetentionPolicy` | `object` | A policy that defines the number of days to retain backups. | +| `Certificates` | `object` | Contains one or more certificates or a certificate signing request (CSR). | +| `ClusterId` | `string` | The cluster's identifier (ID). | +| `CreateTimestamp` | `string` | The date and time when the cluster was created. | +| `HsmType` | `string` | The type of HSM that the cluster contains. | +| `Hsms` | `array` | Contains information about the HSMs in the cluster. | +| `PreCoPassword` | `string` | The default password for the cluster's Pre-Crypto Officer (PRECO) user. | +| `SecurityGroup` | `string` | The identifier (ID) of the cluster's security group. | +| `SourceBackupId` | `string` | The identifier (ID) of the backup used to create the cluster. This value exists only when the cluster was created from a backup. | +| `State` | `string` | The cluster's state. | +| `StateMessage` | `string` | A description of the cluster's state. | +| `SubnetMapping` | `object` | A map from availability zone to the cluster’s subnet in that availability zone. | +| `TagList` | `array` | The list of tags for the cluster. | +| `VpcId` | `string` | The identifier (ID) of the virtual private cloud (VPC) that contains the cluster. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `describe_clusters` | `SELECT` | `region` | <p>Gets information about AWS CloudHSM clusters.</p> <p>This is a paginated operation, which means that each response might contain only a subset of all the clusters. When the response contains only a subset of clusters, it includes a <code>NextToken</code> value. Use this value in a subsequent <code>DescribeClusters</code> request to get more clusters. When you receive a response with no <code>NextToken</code> (or an empty or null value), that means there are no more clusters to get.</p> | +| `create_cluster` | `INSERT` | `X-Amz-Target, data__HsmType, data__SubnetIds, region` | Creates a new AWS CloudHSM cluster. | +| `delete_cluster` | `DELETE` | `X-Amz-Target, data__ClusterId, region` | Deletes the specified AWS CloudHSM cluster. Before you can delete a cluster, you must delete all HSMs in the cluster. To see if the cluster contains any HSMs, use <a>DescribeClusters</a>. To delete an HSM, use <a>DeleteHsm</a>. | +| `initialize_cluster` | `EXEC` | `X-Amz-Target, data__ClusterId, data__SignedCert, data__TrustAnchor, region` | Claims an AWS CloudHSM cluster by submitting the cluster certificate issued by your issuing certificate authority (CA) and the CA's root certificate. Before you can claim a cluster, you must sign the cluster's certificate signing request (CSR) with your issuing CA. To get the cluster's CSR, use <a>DescribeClusters</a>. | +| `modify_cluster` | `EXEC` | `X-Amz-Target, data__BackupRetentionPolicy, data__ClusterId, region` | Modifies AWS CloudHSM cluster. | diff --git a/docs/aws-docs/providers/aws/cloudhsm/hsm/index.md b/docs/aws-docs/providers/aws/cloudhsm/hsm/index.md new file mode 100644 index 0000000000..429ff817e0 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudhsm/hsm/index.md @@ -0,0 +1,33 @@ +--- +title: hsm +hide_title: false +hide_table_of_contents: false +keywords: + - hsm + - cloudhsm + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namehsm
TypeResource
Idaws.cloudhsm.hsm
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `create_hsm` | `INSERT` | `X-Amz-Target, data__AvailabilityZone, data__ClusterId, region` | Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster. | +| `delete_hsm` | `DELETE` | `X-Amz-Target, data__ClusterId, region` | Deletes the specified HSM. To specify an HSM, you can use its identifier (ID), the IP address of the HSM's elastic network interface (ENI), or the ID of the HSM's ENI. You need to specify only one of these values. To find these values, use <a>DescribeClusters</a>. | diff --git a/docs/aws-docs/providers/aws/cloudhsm/index.md b/docs/aws-docs/providers/aws/cloudhsm/index.md new file mode 100644 index 0000000000..921ca1149d --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudhsm/index.md @@ -0,0 +1,49 @@ +--- +title: cloudhsm +hide_title: false +hide_table_of_contents: false +keywords: + - cloudhsm + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +cloudhsm + +:::info Service Summary + +
+
+total resources: 4
+total selectable resources: 3
+total methods: 15
+
+
+ +::: + +## Overview + + + + + + +
Nameaws.cloudhsm
TypeService
Titlecloudhsm
Descriptioncloudhsm
Idcloudhsm:v00.00.00000
+ +## Resources +
+
+backups
+clusters
+
+
+hsm
+tags
+
+
diff --git a/docs/aws-docs/providers/aws/cloudhsm/tags/index.md b/docs/aws-docs/providers/aws/cloudhsm/tags/index.md new file mode 100644 index 0000000000..24b1c912ff --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudhsm/tags/index.md @@ -0,0 +1,37 @@ +--- +title: tags +hide_title: false +hide_table_of_contents: false +keywords: + - tags + - cloudhsm + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nametags
TypeResource
Idaws.cloudhsm.tags
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `NextToken` | `string` | An opaque string that indicates that the response contains only a subset of tags. Use this value in a subsequent <code>ListTags</code> request to get more tags. | +| `TagList` | `array` | A list of tags. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `list_tags` | `SELECT` | `X-Amz-Target, data__ResourceId, region` | <p>Gets a list of tags for the specified AWS CloudHSM cluster.</p> <p>This is a paginated operation, which means that each response might contain only a subset of all the tags. When the response contains only a subset of tags, it includes a <code>NextToken</code> value. Use this value in a subsequent <code>ListTags</code> request to get more tags. When you receive a response with no <code>NextToken</code> (or an empty or null value), that means there are no more tags to get.</p> | +| `tag_resource` | `EXEC` | `X-Amz-Target, data__ResourceId, data__TagList, region` | Adds or overwrites one or more tags for the specified AWS CloudHSM cluster. | +| `untag_resource` | `EXEC` | `X-Amz-Target, data__ResourceId, data__TagKeyList, region` | Removes the specified tag or tags from the specified AWS CloudHSM cluster. | diff --git a/docs/aws-docs/providers/aws/cloudtrail/channel/index.md b/docs/aws-docs/providers/aws/cloudtrail/channel/index.md new file mode 100644 index 0000000000..37dc5c97fa --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudtrail/channel/index.md @@ -0,0 +1,99 @@ +--- +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
DescriptionA channel receives events from a specific source (such as an on-premises storage solution or application, or a partner event data source), and delivers the events to one or more event data stores. You use channels to ingest events into CloudTrail from sources outside AWS.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +source, +destinations, +channel_arn, +tags +FROM aws.cloudtrail.channel +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the channel resource, the following permissions are required: + +### Read +```json +CloudTrail:GetChannel, +CloudTrail:ListChannels +``` + +### Update +```json +CloudTrail:UpdateChannel, +CloudTrail:GetChannel, +CloudTrail:AddTags, +CloudTrail:RemoveTags +``` + +### Delete +```json +CloudTrail:DeleteChannel +``` + diff --git a/docs/aws-docs/providers/aws/cloudtrail/channels/index.md b/docs/aws-docs/providers/aws/cloudtrail/channels/index.md new file mode 100644 index 0000000000..04954e095a --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudtrail/channels/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionA channel receives events from a specific source (such as an on-premises storage solution or application, or a partner event data source), and delivers the events to one or more event data stores. You use channels to ingest events into CloudTrail from sources outside AWS.
Idaws.cloudtrail.channels
+ +## Fields + + + + + +
NameDatatypeDescription
channel_arnundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +channel_arn +FROM aws.cloudtrail.channels +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the channels resource, the following permissions are required: + +### Create +```json +CloudTrail:CreateChannel, +CloudTrail:AddTags +``` + +### List +```json +CloudTrail:ListChannels +``` + diff --git a/docs/aws-docs/providers/aws/cloudtrail/event_data_store/index.md b/docs/aws-docs/providers/aws/cloudtrail/event_data_store/index.md new file mode 100644 index 0000000000..63b60d7790 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudtrail/event_data_store/index.md @@ -0,0 +1,150 @@ +--- +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
DescriptionA storage lake of event data against which you can run complex SQL-based queries. An event data store can include events that you have logged on your account from the last 7 to 2557 or 3653 days (about seven or ten years) depending on the selected BillingMode.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.cloudtrail.event_data_store +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the event_data_store resource, the following permissions are required: + +### Read +```json +CloudTrail:GetEventDataStore, +CloudTrail:ListEventDataStores, +CloudTrail:GetInsightSelectors, +CloudTrail:ListTags +``` + +### Update +```json +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 +```json +CloudTrail:DeleteEventDataStore, +CloudTrail:GetEventDataStore, +CloudTrail:DisableFederation, +glue:DeleteTable, +lakeformation:DeregisterResource +``` + diff --git a/docs/aws-docs/providers/aws/cloudtrail/event_data_stores/index.md b/docs/aws-docs/providers/aws/cloudtrail/event_data_stores/index.md new file mode 100644 index 0000000000..166bf054e7 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudtrail/event_data_stores/index.md @@ -0,0 +1,95 @@ +--- +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
DescriptionA storage lake of event data against which you can run complex SQL-based queries. An event data store can include events that you have logged on your account from the last 7 to 2557 or 3653 days (about seven or ten years) depending on the selected BillingMode.
Idaws.cloudtrail.event_data_stores
+ +## Fields + + + + + +
NameDatatypeDescription
event_data_store_arnstringThe ARN of the event data store.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +event_data_store_arn +FROM aws.cloudtrail.event_data_stores +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the event_data_stores resource, the following permissions are required: + +### Create +```json +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 +```json +CloudTrail:ListEventDataStores, +CloudTrail:GetEventDataStore, +CloudTrail:GetInsightSelectors, +CloudTrail:ListTags +``` + diff --git a/docs/aws-docs/providers/aws/cloudtrail/index.md b/docs/aws-docs/providers/aws/cloudtrail/index.md new file mode 100644 index 0000000000..a3cb480781 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/cloudtrail/resource_policies/index.md b/docs/aws-docs/providers/aws/cloudtrail/resource_policies/index.md new file mode 100644 index 0000000000..d6a451019e --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudtrail/resource_policies/index.md @@ -0,0 +1,68 @@ +--- +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 Type definition for AWS::CloudTrail::ResourcePolicy
Idaws.cloudtrail.resource_policies
+ +## Fields + + + + + +
NameDatatypeDescription
resource_arnstringThe ARN of the AWS CloudTrail resource to which the policy applies.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +resource_arn +FROM aws.cloudtrail.resource_policies +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the resource_policies resource, the following permissions are required: + +### Create +```json +CloudTrail:PutResourcePolicy, +CloudTrail:GetResourcePolicy +``` + diff --git a/docs/aws-docs/providers/aws/cloudtrail/resource_policy/index.md b/docs/aws-docs/providers/aws/cloudtrail/resource_policy/index.md new file mode 100644 index 0000000000..48db644dd8 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudtrail/resource_policy/index.md @@ -0,0 +1,90 @@ +--- +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 Type definition for AWS::CloudTrail::ResourcePolicy
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +resource_arn, +resource_policy +FROM aws.cloudtrail.resource_policy +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the resource_policy resource, the following permissions are required: + +### Read +```json +CloudTrail:GetResourcePolicy +``` + +### Update +```json +CloudTrail:PutResourcePolicy, +CloudTrail:GetResourcePolicy +``` + +### Delete +```json +CloudTrail:DeleteResourcePolicy +``` + diff --git a/docs/aws-docs/providers/aws/cloudtrail/trail/index.md b/docs/aws-docs/providers/aws/cloudtrail/trail/index.md new file mode 100644 index 0000000000..f713f4960b --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudtrail/trail/index.md @@ -0,0 +1,139 @@ +--- +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
DescriptionCreates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. A maximum of five trails can exist in a region, irrespective of the region in which they were created.
Idaws.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.
kms_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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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, +kms_key_id, +s3_bucket_name, +s3_key_prefix, +sns_topic_name, +tags, +trail_name, +arn, +sns_topic_arn, +insight_selectors +FROM aws.cloudtrail.trail +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the trail resource, the following permissions are required: + +### Read +```json +CloudTrail:GetTrail, +CloudTrail:GetTrailStatus, +CloudTrail:ListTags, +CloudTrail:GetEventSelectors, +CloudTrail:GetInsightSelectors, +CloudTrail:DescribeTrails +``` + +### Update +```json +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 +```json +CloudTrail:DeleteTrail +``` + diff --git a/docs/aws-docs/providers/aws/cloudtrail/trails/index.md b/docs/aws-docs/providers/aws/cloudtrail/trails/index.md new file mode 100644 index 0000000000..2eb1840956 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudtrail/trails/index.md @@ -0,0 +1,92 @@ +--- +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
DescriptionCreates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. A maximum of five trails can exist in a region, irrespective of the region in which they were created.
Idaws.cloudtrail.trails
+ +## Fields + + + + + +
NameDatatypeDescription
trail_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +trail_name +FROM aws.cloudtrail.trails +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the trails resource, the following permissions are required: + +### Create +```json +CloudTrail:CreateTrail, +CloudTrail:StartLogging, +CloudTrail:AddTags, +CloudTrail:PutEventSelectors, +CloudTrail:PutInsightSelectors, +iam:GetRole, +iam:PassRole, +iam:CreateServiceLinkedRole, +organizations:DescribeOrganization, +organizations:ListAWSServiceAccessForOrganization +``` + +### List +```json +CloudTrail:ListTrails, +CloudTrail:GetTrail, +CloudTrail:GetTrailStatus, +CloudTrail:ListTags, +CloudTrail:GetEventSelectors, +CloudTrail:GetInsightSelectors, +CloudTrail:DescribeTrails +``` + diff --git a/docs/aws-docs/providers/aws/cloudwatch/alarm/index.md b/docs/aws-docs/providers/aws/cloudwatch/alarm/index.md new file mode 100644 index 0000000000..89caf16cb8 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudwatch/alarm/index.md @@ -0,0 +1,136 @@ +--- +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
DescriptionThe ``AWS::CloudWatch::Alarm`` type specifies an alarm and associates it with the specified metric or metric math expression.<br/> When this operation creates an alarm, the alarm state is immediately set to ``INSUFFICIENT_DATA``. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.<br/> When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.
Idaws.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. If ``ignore``, the alarm state does not change during periods with too few data points to be statistically significant. If ``evaluate`` or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.
extended_statisticstringThe percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.<br/> For an alarm based on a metric, you must specify either ``Statistic`` or ``ExtendedStatistic`` but not both.<br/> For an alarm based on a math expression, you can't specify ``ExtendedStatistic``. Instead, you use ``Metrics``.
comparison_operatorstringThe arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
treat_missing_datastringSets how this alarm is to handle missing data points. Valid values are ``breaching``, ``notBreaching``, ``ignore``, and ``missing``. For more information, see [Configuring How Alarms Treat Missing Data](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data) in the *Amazon User Guide*.<br/> If you omit this parameter, the default behavior of ``missing`` is used.
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. This is required for an alarm based on a metric. Valid values are 10, 30, 60, and any multiple of 60.<br/> For an alarm based on a math expression, you can't specify ``Period``, and instead you use the ``Metrics`` parameter.<br/> *Minimum:* 10
evaluation_periodsintegerThe number of periods over which data is compared to the specified threshold. If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an "M out of N" alarm, this value is the N, and ``DatapointsToAlarm`` is the M.<br/> For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*.
unitstringThe unit of the metric associated with the alarm. Specify this only if you are creating an alarm based on a single metric. Do not specify this if you are specifying a ``Metrics`` array.<br/> You can specify the following values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None.
namespacestringThe namespace of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you can't specify ``Namespace`` and you use ``Metrics`` instead.<br/> For a list of namespaces for metrics from AWS services, see [Services That Publish Metrics.](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html)
ok_actionsarrayThe 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). For more information about creating alarms and the actions that you can specify, see [PutMetricAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricAlarm.html) in the *API Reference*.
metric_namestringThe name of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you use ``Metrics`` instead and you can't specify ``MetricName``.
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. Each item in the array either retrieves a metric or performs a math expression.<br/> If you specify the ``Metrics`` parameter, you cannot specify ``MetricName``, ``Dimensions``, ``Period``, ``Namespace``, ``Statistic``, ``ExtendedStatistic``, or ``Unit``.
alarm_descriptionstringThe description of the alarm.
alarm_namestringThe name of the alarm. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the alarm name. <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.
statisticstringThe statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ``ExtendedStatistic``.<br/> For an alarm based on a metric, you must specify either ``Statistic`` or ``ExtendedStatistic`` but not both.<br/> For an alarm based on a math expression, you can't specify ``Statistic``. Instead, you use ``Metrics``.
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).
arnstring
datapoints_to_alarmintegerThe number of datapoints that must be breaching to trigger the alarm. This is used only if you are setting an "M out of N" alarm. In that case, this value is the M, and the value that you set for ``EvaluationPeriods`` is the N value. For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*.<br/> If you omit this parameter, CW uses the same value here that you set for ``EvaluationPeriods``, and the alarm goes to alarm state if that many consecutive periods are breaching.
thresholdnumberThe value to compare with the specified statistic.
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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, +ok_actions, +alarm_actions, +metric_name, +actions_enabled, +metrics, +alarm_description, +alarm_name, +statistic, +insufficient_data_actions, +arn, +datapoints_to_alarm, +threshold, +tags +FROM aws.cloudwatch.alarm +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the alarm resource, the following permissions are required: + +### Update +```json +cloudwatch:PutMetricAlarm, +cloudwatch:DescribeAlarms, +cloudwatch:TagResource, +cloudwatch:UntagResource +``` + +### Delete +```json +cloudwatch:DeleteAlarms, +cloudwatch:DescribeAlarms +``` + +### Read +```json +cloudwatch:DescribeAlarms, +cloudwatch:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/cloudwatch/alarms/index.md b/docs/aws-docs/providers/aws/cloudwatch/alarms/index.md new file mode 100644 index 0000000000..78cdaf9ca9 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudwatch/alarms/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionThe ``AWS::CloudWatch::Alarm`` type specifies an alarm and associates it with the specified metric or metric math expression.<br/> When this operation creates an alarm, the alarm state is immediately set to ``INSUFFICIENT_DATA``. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.<br/> When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.
Idaws.cloudwatch.alarms
+ +## Fields + + + + + +
NameDatatypeDescription
alarm_namestringThe name of the alarm. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the alarm name. <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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +alarm_name +FROM aws.cloudwatch.alarms +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the alarms resource, the following permissions are required: + +### Create +```json +cloudwatch:PutMetricAlarm, +cloudwatch:DescribeAlarms, +cloudwatch:TagResource +``` + +### List +```json +cloudwatch:DescribeAlarms +``` + diff --git a/docs/aws-docs/providers/aws/cloudwatch/composite_alarm/index.md b/docs/aws-docs/providers/aws/cloudwatch/composite_alarm/index.md new file mode 100644 index 0000000000..53f0a49797 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudwatch/composite_alarm/index.md @@ -0,0 +1,114 @@ +--- +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
DescriptionThe AWS::CloudWatch::CompositeAlarm type specifies an alarm which aggregates the states of other Alarms (Metric or Composite Alarms) as defined by the AlarmRule expression
Idaws.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.
ok_actionsarrayThe 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.
tagsarrayA list of key-value pairs to associate with the composite alarm. You can associate as many as 50 tags with an alarm.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +alarm_name, +alarm_rule, +alarm_description, +actions_enabled, +ok_actions, +alarm_actions, +insufficient_data_actions, +actions_suppressor, +actions_suppressor_wait_period, +actions_suppressor_extension_period, +tags +FROM aws.cloudwatch.composite_alarm +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the composite_alarm resource, the following permissions are required: + +### Read +```json +cloudwatch:DescribeAlarms, +cloudwatch:ListTagsForResource +``` + +### Update +```json +cloudwatch:DescribeAlarms, +cloudwatch:PutCompositeAlarm, +cloudwatch:TagResource, +cloudwatch:UntagResource +``` + +### Delete +```json +cloudwatch:DescribeAlarms, +cloudwatch:DeleteAlarms +``` + diff --git a/docs/aws-docs/providers/aws/cloudwatch/composite_alarms/index.md b/docs/aws-docs/providers/aws/cloudwatch/composite_alarms/index.md new file mode 100644 index 0000000000..f94829d4bc --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudwatch/composite_alarms/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionThe AWS::CloudWatch::CompositeAlarm type specifies an alarm which aggregates the states of other Alarms (Metric or Composite Alarms) as defined by the AlarmRule expression
Idaws.cloudwatch.composite_alarms
+ +## Fields + + + + + +
NameDatatypeDescription
alarm_namestringThe name of the Composite Alarm
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +alarm_name +FROM aws.cloudwatch.composite_alarms +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the composite_alarms resource, the following permissions are required: + +### Create +```json +cloudwatch:DescribeAlarms, +cloudwatch:PutCompositeAlarm, +cloudwatch:TagResource +``` + +### List +```json +cloudwatch:DescribeAlarms +``` + diff --git a/docs/aws-docs/providers/aws/cloudwatch/index.md b/docs/aws-docs/providers/aws/cloudwatch/index.md new file mode 100644 index 0000000000..891c9f40de --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/cloudwatch/metric_stream/index.md b/docs/aws-docs/providers/aws/cloudwatch/metric_stream/index.md new file mode 100644 index 0000000000..15f1754cbe --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudwatch/metric_stream/index.md @@ -0,0 +1,116 @@ +--- +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
DescriptionResource Type definition for Metric Stream
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.cloudwatch.metric_stream +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the metric_stream resource, the following permissions are required: + +### Update +```json +cloudwatch:PutMetricStream, +cloudwatch:GetMetricStream, +cloudwatch:TagResource, +cloudwatch:UntagResource, +iam:PassRole +``` + +### Delete +```json +cloudwatch:DeleteMetricStream, +cloudwatch:GetMetricStream +``` + +### Read +```json +cloudwatch:GetMetricStream +``` + diff --git a/docs/aws-docs/providers/aws/cloudwatch/metric_streams/index.md b/docs/aws-docs/providers/aws/cloudwatch/metric_streams/index.md new file mode 100644 index 0000000000..4bcfce32e8 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudwatch/metric_streams/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionResource Type definition for Metric Stream
Idaws.cloudwatch.metric_streams
+ +## Fields + + + + + +
NameDatatypeDescription
namestringName of the metric stream.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.cloudwatch.metric_streams +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the metric_streams resource, the following permissions are required: + +### Create +```json +cloudwatch:PutMetricStream, +cloudwatch:GetMetricStream, +cloudwatch:TagResource, +iam:PassRole +``` + +### List +```json +cloudwatch:ListMetricStreams +``` + diff --git a/docs/aws-docs/providers/aws/cloudwatch_api/index.md b/docs/aws-docs/providers/aws/cloudwatch_api/index.md new file mode 100644 index 0000000000..e38554e549 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudwatch_api/index.md @@ -0,0 +1,46 @@ +--- +title: cloudwatch_api +hide_title: false +hide_table_of_contents: false +keywords: + - cloudwatch_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +cloudwatch_api + +:::info Service Summary + +
+
+total resources: 1
+total selectable resources: 1
+total methods: 1
+
+
+ +::: + +## Overview + + + + + + +
Nameaws.cloudwatch_api
TypeService
Titlecloudwatch_api
Descriptioncloudwatch_api
Idcloudwatch_api:v00.00.00000
+ +## Resources +
+
+log_events
+
+
+
+
diff --git a/docs/aws-docs/providers/aws/cloudwatch_api/log_events/index.md b/docs/aws-docs/providers/aws/cloudwatch_api/log_events/index.md new file mode 100644 index 0000000000..ff368881d1 --- /dev/null +++ b/docs/aws-docs/providers/aws/cloudwatch_api/log_events/index.md @@ -0,0 +1,36 @@ +--- +title: log_events +hide_title: false +hide_table_of_contents: false +keywords: + - log_events + - cloudwatch_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namelog_events
TypeResource
Idaws.cloudwatch_api.log_events
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `ingestionTime` | `number` | The time the event was ingested, expressed as the number of milliseconds after <code>Jan 1, 1970 00:00:00 UTC</code>. | +| `message` | `string` | The data contained in the log event. | +| `timestamp` | `number` | The time the event occurred, expressed as the number of milliseconds after <code>Jan 1, 1970 00:00:00 UTC</code>. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `GetLogEvents` | `SELECT` | `data__logStreamName, region` | diff --git a/docs/aws-docs/providers/aws/codeartifact/domain/index.md b/docs/aws-docs/providers/aws/codeartifact/domain/index.md new file mode 100644 index 0000000000..18b0bc79b9 --- /dev/null +++ b/docs/aws-docs/providers/aws/codeartifact/domain/index.md @@ -0,0 +1,106 @@ +--- +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
DescriptionThe resource schema to create a CodeArtifact domain.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +domain_name, +name, +owner, +encryption_key, +permissions_policy_document, +tags, +arn +FROM aws.codeartifact.domain +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the domain resource, the following permissions are required: + +### Read +```json +codeartifact:DescribeDomain, +codeartifact:GetDomainPermissionsPolicy, +codeartifact:ListTagsForResource +``` + +### Update +```json +codeartifact:PutDomainPermissionsPolicy, +codeartifact:DeleteDomainPermissionsPolicy, +codeartifact:GetDomainPermissionsPolicy, +codeartifact:TagResource, +codeartifact:UntagResource +``` + +### Delete +```json +codeartifact:DeleteDomain, +codeartifact:DescribeDomain +``` + diff --git a/docs/aws-docs/providers/aws/codeartifact/domains/index.md b/docs/aws-docs/providers/aws/codeartifact/domains/index.md new file mode 100644 index 0000000000..bd0908e5ce --- /dev/null +++ b/docs/aws-docs/providers/aws/codeartifact/domains/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionThe resource schema to create a CodeArtifact domain.
Idaws.codeartifact.domains
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe ARN of the domain.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.codeartifact.domains +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the domains resource, the following permissions are required: + +### Create +```json +codeartifact:CreateDomain, +codeartifact:DescribeDomain, +codeartifact:PutDomainPermissionsPolicy, +codeartifact:GetDomainPermissionsPolicy, +codeartifact:TagResource +``` + +### List +```json +codeartifact:ListDomains +``` + diff --git a/docs/aws-docs/providers/aws/codeartifact/index.md b/docs/aws-docs/providers/aws/codeartifact/index.md new file mode 100644 index 0000000000..d1dae4f812 --- /dev/null +++ b/docs/aws-docs/providers/aws/codeartifact/index.md @@ -0,0 +1,43 @@ +--- +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: 6
+total selectable resources: 6
+total methods: 6
+
+
+ +::: + +## Resources +
+
+domain
+domains
+package_group +
+
+package_groups
+repositories
+repository +
+
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/codeartifact/package_group/index.md b/docs/aws-docs/providers/aws/codeartifact/package_group/index.md new file mode 100644 index 0000000000..a2ea7a2f00 --- /dev/null +++ b/docs/aws-docs/providers/aws/codeartifact/package_group/index.md @@ -0,0 +1,110 @@ +--- +title: package_group +hide_title: false +hide_table_of_contents: false +keywords: + - package_group + - 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 package_group resource + +## Overview + + + + + +
Namepackage_group
TypeResource
DescriptionThe resource schema to create a CodeArtifact package group.
Idaws.codeartifact.package_group
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
domain_namestringThe name of the domain that contains the package group.
domain_ownerstringThe 12-digit account ID of the AWS account that owns the domain.
patternstringThe package group pattern that is used to gather packages.
contact_infostringThe contact info of the package group.
descriptionstringThe text description of the package group.
origin_configurationobjectThe package origin configuration of the package group.
tagsarrayAn array of key-value pairs to apply to the package group.
arnstringThe ARN of the package group.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +domain_name, +domain_owner, +pattern, +contact_info, +description, +origin_configuration, +tags, +arn +FROM aws.codeartifact.package_group +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the package_group resource, the following permissions are required: + +### Read +```json +codeartifact:DescribePackageGroup, +codeartifact:ListAllowedRepositoriesForGroup, +codeartifact:ListTagsForResource +``` + +### Update +```json +codeartifact:UpdatePackageGroup, +codeartifact:UpdatePackageGroupOriginConfiguration, +codeartifact:DescribePackageGroup, +codeartifact:ListAllowedRepositoriesForGroup, +codeartifact:ListTagsForResource, +codeartifact:TagResource, +codeartifact:UntagResource +``` + +### Delete +```json +codeartifact:DeletePackageGroup, +codeartifact:DescribePackageGroup +``` + diff --git a/docs/aws-docs/providers/aws/codeartifact/package_groups/index.md b/docs/aws-docs/providers/aws/codeartifact/package_groups/index.md new file mode 100644 index 0000000000..93ae2ed939 --- /dev/null +++ b/docs/aws-docs/providers/aws/codeartifact/package_groups/index.md @@ -0,0 +1,83 @@ +--- +title: package_groups +hide_title: false +hide_table_of_contents: false +keywords: + - package_groups + - 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 package_groups in a region + +## Overview + + + + + +
Namepackage_groups
TypeResource
DescriptionThe resource schema to create a CodeArtifact package group.
Idaws.codeartifact.package_groups
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe ARN of the package group.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.codeartifact.package_groups +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the package_groups resource, the following permissions are required: + +### Create +```json +codeartifact:CreatePackageGroup, +codeartifact:DescribePackageGroup, +codeartifact:UpdatePackageGroup, +codeartifact:UpdatePackageGroupOriginConfiguration, +codeartifact:ListAllowedRepositoriesForGroup, +codeartifact:ListTagsForResource, +codeartifact:TagResource +``` + +### List +```json +codeartifact:ListPackageGroups +``` + diff --git a/docs/aws-docs/providers/aws/codeartifact/repositories/index.md b/docs/aws-docs/providers/aws/codeartifact/repositories/index.md new file mode 100644 index 0000000000..70d5bac516 --- /dev/null +++ b/docs/aws-docs/providers/aws/codeartifact/repositories/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionThe resource schema to create a CodeArtifact repository.
Idaws.codeartifact.repositories
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe ARN of the repository.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.codeartifact.repositories +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the repositories resource, the following permissions are required: + +### Create +```json +codeartifact:CreateRepository, +codeartifact:DescribeRepository, +codeartifact:PutRepositoryPermissionsPolicy, +codeartifact:AssociateExternalConnection, +codeartifact:AssociateWithDownstreamRepository, +codeartifact:TagResource +``` + +### List +```json +codeartifact:ListRepositories +``` + diff --git a/docs/aws-docs/providers/aws/codeartifact/repository/index.md b/docs/aws-docs/providers/aws/codeartifact/repository/index.md new file mode 100644 index 0000000000..dfef73429a --- /dev/null +++ b/docs/aws-docs/providers/aws/codeartifact/repository/index.md @@ -0,0 +1,116 @@ +--- +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
DescriptionThe resource schema to create a CodeArtifact repository.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +repository_name, +name, +domain_name, +domain_owner, +description, +arn, +external_connections, +upstreams, +permissions_policy_document, +tags +FROM aws.codeartifact.repository +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the repository resource, the following permissions are required: + +### Read +```json +codeartifact:DescribeRepository, +codeartifact:GetRepositoryPermissionsPolicy, +codeartifact:ListTagsForResource +``` + +### Update +```json +codeartifact:PutRepositoryPermissionsPolicy, +codeartifact:DeleteRepositoryPermissionsPolicy, +codeartifact:AssociateExternalConnection, +codeartifact:DisassociateExternalConnection, +codeartifact:UpdateRepository, +codeartifact:DescribeRepository, +codeartifact:AssociateWithDownstreamRepository, +codeartifact:TagResource, +codeartifact:UntagResource +``` + +### Delete +```json +codeartifact:DeleteRepository, +codeartifact:DescribeRepository +``` + diff --git a/docs/aws-docs/providers/aws/codebuild/fleet/index.md b/docs/aws-docs/providers/aws/codebuild/fleet/index.md new file mode 100644 index 0000000000..8af69667cd --- /dev/null +++ b/docs/aws-docs/providers/aws/codebuild/fleet/index.md @@ -0,0 +1,99 @@ +--- +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
DescriptionResource Type definition for AWS::CodeBuild::Fleet
Idaws.codebuild.fleet
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
namestring
base_capacityinteger
environment_typestring
compute_typestring
tagsarray
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +base_capacity, +environment_type, +compute_type, +tags, +arn +FROM aws.codebuild.fleet +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the fleet resource, the following permissions are required: + +### Delete +```json +codebuild:BatchGetFleets, +codebuild:DeleteFleet +``` + +### Read +```json +codebuild:BatchGetFleets +``` + +### Update +```json +codebuild:BatchGetFleets, +codebuild:UpdateFleet +``` + diff --git a/docs/aws-docs/providers/aws/codebuild/fleets/index.md b/docs/aws-docs/providers/aws/codebuild/fleets/index.md new file mode 100644 index 0000000000..fe857f85a6 --- /dev/null +++ b/docs/aws-docs/providers/aws/codebuild/fleets/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionResource Type definition for AWS::CodeBuild::Fleet
Idaws.codebuild.fleets
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.codebuild.fleets +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the fleets resource, the following permissions are required: + +### Create +```json +codebuild:BatchGetFleets, +codebuild:CreateFleet +``` + +### List +```json +codebuild:ListFleets +``` + diff --git a/docs/aws-docs/providers/aws/codebuild/index.md b/docs/aws-docs/providers/aws/codebuild/index.md new file mode 100644 index 0000000000..b26fd0e8d5 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/codeconnections/connection/index.md b/docs/aws-docs/providers/aws/codeconnections/connection/index.md new file mode 100644 index 0000000000..9fe12296f4 --- /dev/null +++ b/docs/aws-docs/providers/aws/codeconnections/connection/index.md @@ -0,0 +1,102 @@ +--- +title: connection +hide_title: false +hide_table_of_contents: false +keywords: + - connection + - codeconnections + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual connection resource + +## Overview + + + + + +
Nameconnection
TypeResource
DescriptionSchema for AWS::CodeConnections::Connection resource which can be used to connect external source providers with other AWS services (i.e. AWS CodePipeline)
Idaws.codeconnections.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +connection_arn, +connection_name, +connection_status, +owner_account_id, +provider_type, +host_arn, +tags +FROM aws.codeconnections.connection +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the connection resource, the following permissions are required: + +### Read +```json +codeconnections:GetConnection, +codeconnections:ListTagsForResource +``` + +### Update +```json +codeconnections:ListTagsForResource, +codeconnections:TagResource, +codeconnections:UntagResource +``` + +### Delete +```json +codeconnections:DeleteConnection +``` + diff --git a/docs/aws-docs/providers/aws/codeconnections/connections/index.md b/docs/aws-docs/providers/aws/codeconnections/connections/index.md new file mode 100644 index 0000000000..53cfeabaa9 --- /dev/null +++ b/docs/aws-docs/providers/aws/codeconnections/connections/index.md @@ -0,0 +1,79 @@ +--- +title: connections +hide_title: false +hide_table_of_contents: false +keywords: + - connections + - codeconnections + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Retrieves a list of connections in a region + +## Overview + + + + + +
Nameconnections
TypeResource
DescriptionSchema for AWS::CodeConnections::Connection resource which can be used to connect external source providers with other AWS services (i.e. AWS CodePipeline)
Idaws.codeconnections.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +connection_arn +FROM aws.codeconnections.connections +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the connections resource, the following permissions are required: + +### Create +```json +codeconnections:CreateConnection, +codeconnections:TagResource +``` + +### List +```json +codeconnections:ListConnections, +codeconnections:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/codeconnections/index.md b/docs/aws-docs/providers/aws/codeconnections/index.md new file mode 100644 index 0000000000..e69649ffdc --- /dev/null +++ b/docs/aws-docs/providers/aws/codeconnections/index.md @@ -0,0 +1,39 @@ +--- +title: codeconnections +hide_title: false +hide_table_of_contents: false +keywords: + - codeconnections + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- + +The codeconnections service documentation. + +:::info Service Summary + +
+
+total resources: 2
+total selectable resources: 2
+total methods: 2
+
+
+ +::: + +## Resources +
+
+connection +
+
+connections +
+
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/codedeploy/application/index.md b/docs/aws-docs/providers/aws/codedeploy/application/index.md new file mode 100644 index 0000000000..eb0e0c6a24 --- /dev/null +++ b/docs/aws-docs/providers/aws/codedeploy/application/index.md @@ -0,0 +1,94 @@ +--- +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
DescriptionThe AWS::CodeDeploy::Application resource creates an AWS CodeDeploy application
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +application_name, +compute_platform, +tags +FROM aws.codedeploy.application +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the application resource, the following permissions are required: + +### Read +```json +codedeploy:GetApplication, +codedeploy:ListTagsForResource +``` + +### Delete +```json +codedeploy:GetApplication, +codedeploy:DeleteApplication +``` + +### Update +```json +codedeploy:TagResource, +codedeploy:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/codedeploy/applications/index.md b/docs/aws-docs/providers/aws/codedeploy/applications/index.md new file mode 100644 index 0000000000..cddbfe1fce --- /dev/null +++ b/docs/aws-docs/providers/aws/codedeploy/applications/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionThe AWS::CodeDeploy::Application resource creates an AWS CodeDeploy application
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +application_name +FROM aws.codedeploy.applications +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the applications resource, the following permissions are required: + +### Create +```json +codedeploy:CreateApplication, +codedeploy:TagResource +``` + +### List +```json +codedeploy:ListApplications +``` + diff --git a/docs/aws-docs/providers/aws/codedeploy/deployment_config/index.md b/docs/aws-docs/providers/aws/codedeploy/deployment_config/index.md new file mode 100644 index 0000000000..a437bda723 --- /dev/null +++ b/docs/aws-docs/providers/aws/codedeploy/deployment_config/index.md @@ -0,0 +1,86 @@ +--- +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
DescriptionResource Type definition for AWS::CodeDeploy::DeploymentConfig
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +compute_platform, +deployment_config_name, +minimum_healthy_hosts, +zonal_config, +traffic_routing_config +FROM aws.codedeploy.deployment_config +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the deployment_config resource, the following permissions are required: + +### Read +```json +codedeploy:GetDeploymentConfig +``` + +### Delete +```json +codedeploy:GetDeploymentConfig, +codedeploy:DeleteDeploymentConfig +``` + diff --git a/docs/aws-docs/providers/aws/codedeploy/deployment_configs/index.md b/docs/aws-docs/providers/aws/codedeploy/deployment_configs/index.md new file mode 100644 index 0000000000..0c161e2dc3 --- /dev/null +++ b/docs/aws-docs/providers/aws/codedeploy/deployment_configs/index.md @@ -0,0 +1,77 @@ +--- +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
DescriptionResource Type definition for AWS::CodeDeploy::DeploymentConfig
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +deployment_config_name +FROM aws.codedeploy.deployment_configs +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the deployment_configs resource, the following permissions are required: + +### Create +```json +codedeploy:CreateDeploymentConfig +``` + +### List +```json +codedeploy:ListDeploymentConfigs +``` + diff --git a/docs/aws-docs/providers/aws/codedeploy/index.md b/docs/aws-docs/providers/aws/codedeploy/index.md new file mode 100644 index 0000000000..4e4452d563 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/codeguruprofiler/index.md b/docs/aws-docs/providers/aws/codeguruprofiler/index.md new file mode 100644 index 0000000000..84cd6f0c3f --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/codeguruprofiler/profiling_group/index.md b/docs/aws-docs/providers/aws/codeguruprofiler/profiling_group/index.md new file mode 100644 index 0000000000..0858a98ff6 --- /dev/null +++ b/docs/aws-docs/providers/aws/codeguruprofiler/profiling_group/index.md @@ -0,0 +1,107 @@ +--- +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
DescriptionThis resource schema represents the Profiling Group resource in the Amazon CodeGuru Profiler service.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +profiling_group_name, +compute_platform, +agent_permissions, +anomaly_detection_notification_configuration, +arn, +tags +FROM aws.codeguruprofiler.profiling_group +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the profiling_group resource, the following permissions are required: + +### Read +```json +codeguru-profiler:DescribeProfilingGroup, +codeguru-profiler:ListTagsForResource +``` + +### Update +```json +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 +```json +codeguru-profiler:DeleteProfilingGroup +``` + diff --git a/docs/aws-docs/providers/aws/codeguruprofiler/profiling_groups/index.md b/docs/aws-docs/providers/aws/codeguruprofiler/profiling_groups/index.md new file mode 100644 index 0000000000..f017319391 --- /dev/null +++ b/docs/aws-docs/providers/aws/codeguruprofiler/profiling_groups/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionThis resource schema represents the Profiling Group resource in the Amazon CodeGuru Profiler service.
Idaws.codeguruprofiler.profiling_groups
+ +## Fields + + + + + +
NameDatatypeDescription
profiling_group_namestringThe name of the profiling group.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +profiling_group_name +FROM aws.codeguruprofiler.profiling_groups +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the profiling_groups resource, the following permissions are required: + +### Create +```json +sns:Publish, +codeguru-profiler:AddNotificationChannels, +codeguru-profiler:CreateProfilingGroup, +codeguru-profiler:PutPermission, +codeguru-profiler:TagResource +``` + +### List +```json +codeguru-profiler:ListProfilingGroups, +codeguru-profiler:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/codegurureviewer/index.md b/docs/aws-docs/providers/aws/codegurureviewer/index.md new file mode 100644 index 0000000000..4ac929dc65 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/codegurureviewer/repository_association/index.md b/docs/aws-docs/providers/aws/codegurureviewer/repository_association/index.md new file mode 100644 index 0000000000..2485c94ff7 --- /dev/null +++ b/docs/aws-docs/providers/aws/codegurureviewer/repository_association/index.md @@ -0,0 +1,96 @@ +--- +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
DescriptionThis resource schema represents the RepositoryAssociation resource in the Amazon CodeGuru Reviewer service.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +type, +owner, +bucket_name, +connection_arn, +association_arn, +tags +FROM aws.codegurureviewer.repository_association +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the repository_association resource, the following permissions are required: + +### Read +```json +codeguru-reviewer:DescribeRepositoryAssociation, +codeguru-reviewer:ListTagsForResource +``` + +### Delete +```json +codeguru-reviewer:DescribeRepositoryAssociation, +codeguru-reviewer:DisassociateRepository, +codecommit:UntagResource, +events:DeleteRule, +events:RemoveTargets, +codestar-connections:UntagResource, +codestar-connections:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/codegurureviewer/repository_associations/index.md b/docs/aws-docs/providers/aws/codegurureviewer/repository_associations/index.md new file mode 100644 index 0000000000..832a04980e --- /dev/null +++ b/docs/aws-docs/providers/aws/codegurureviewer/repository_associations/index.md @@ -0,0 +1,92 @@ +--- +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
DescriptionThis resource schema represents the RepositoryAssociation resource in the Amazon CodeGuru Reviewer service.
Idaws.codegurureviewer.repository_associations
+ +## Fields + + + + + +
NameDatatypeDescription
association_arnstringThe Amazon Resource Name (ARN) of the repository association.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +association_arn +FROM aws.codegurureviewer.repository_associations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the repository_associations resource, the following permissions are required: + +### Create +```json +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 +```json +codeguru-reviewer:ListRepositoryAssociations +``` + diff --git a/docs/aws-docs/providers/aws/codepipeline/custom_action_type/index.md b/docs/aws-docs/providers/aws/codepipeline/custom_action_type/index.md new file mode 100644 index 0000000000..6a0c2757c5 --- /dev/null +++ b/docs/aws-docs/providers/aws/codepipeline/custom_action_type/index.md @@ -0,0 +1,107 @@ +--- +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
DescriptionThe AWS::CodePipeline::CustomActionType resource creates a custom action for activities that aren't included in the CodePipeline default actions, such as running an internally developed build process or a test suite. You can use these custom actions in the stage of a pipeline.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +category, +configuration_properties, +input_artifact_details, +output_artifact_details, +provider, +settings, +tags, +version, +id +FROM aws.codepipeline.custom_action_type +WHERE data__Identifier = '||'; +``` + +## Permissions + +To operate on the custom_action_type resource, the following permissions are required: + +### Read +```json +codepipeline:ListActionTypes, +codepipeline:ListTagsForResource +``` + +### Update +```json +codepipeline:ListActionTypes, +codepipeline:TagResource, +codepipeline:UntagResource +``` + +### Delete +```json +codepipeline:DeleteCustomActionType, +codepipeline:ListActionTypes +``` + diff --git a/docs/aws-docs/providers/aws/codepipeline/custom_action_types/index.md b/docs/aws-docs/providers/aws/codepipeline/custom_action_types/index.md new file mode 100644 index 0000000000..40703b07ea --- /dev/null +++ b/docs/aws-docs/providers/aws/codepipeline/custom_action_types/index.md @@ -0,0 +1,83 @@ +--- +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
DescriptionThe AWS::CodePipeline::CustomActionType resource creates a custom action for activities that aren't included in the CodePipeline default actions, such as running an internally developed build process or a test suite. You can use these custom actions in the stage of a pipeline.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +category, +provider, +version +FROM aws.codepipeline.custom_action_types +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the custom_action_types resource, the following permissions are required: + +### Create +```json +codepipeline:CreateCustomActionType, +codepipeline:TagResource, +codepipeline:ListActionTypes +``` + +### List +```json +codepipeline:ListActionTypes +``` + diff --git a/docs/aws-docs/providers/aws/codepipeline/index.md b/docs/aws-docs/providers/aws/codepipeline/index.md new file mode 100644 index 0000000000..f644f03b63 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/codestarconnections/connection/index.md b/docs/aws-docs/providers/aws/codestarconnections/connection/index.md new file mode 100644 index 0000000000..94eab8aecc --- /dev/null +++ b/docs/aws-docs/providers/aws/codestarconnections/connection/index.md @@ -0,0 +1,102 @@ +--- +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
DescriptionSchema for AWS::CodeStarConnections::Connection resource which can be used to connect external source providers with AWS CodePipeline
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +connection_arn, +connection_name, +connection_status, +owner_account_id, +provider_type, +host_arn, +tags +FROM aws.codestarconnections.connection +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the connection resource, the following permissions are required: + +### Read +```json +codestar-connections:GetConnection, +codestar-connections:ListTagsForResource +``` + +### Update +```json +codestar-connections:ListTagsForResource, +codestar-connections:TagResource, +codestar-connections:UntagResource +``` + +### Delete +```json +codestar-connections:DeleteConnection +``` + diff --git a/docs/aws-docs/providers/aws/codestarconnections/connections/index.md b/docs/aws-docs/providers/aws/codestarconnections/connections/index.md new file mode 100644 index 0000000000..53348759a7 --- /dev/null +++ b/docs/aws-docs/providers/aws/codestarconnections/connections/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionSchema for AWS::CodeStarConnections::Connection resource which can be used to connect external source providers with AWS CodePipeline
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +connection_arn +FROM aws.codestarconnections.connections +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the connections resource, the following permissions are required: + +### Create +```json +codestar-connections:CreateConnection, +codestar-connections:TagResource +``` + +### List +```json +codestar-connections:ListConnections, +codestar-connections:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/codestarconnections/index.md b/docs/aws-docs/providers/aws/codestarconnections/index.md new file mode 100644 index 0000000000..f5260278ed --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/codestarconnections/repository_link/index.md b/docs/aws-docs/providers/aws/codestarconnections/repository_link/index.md new file mode 100644 index 0000000000..81ec3ad3a3 --- /dev/null +++ b/docs/aws-docs/providers/aws/codestarconnections/repository_link/index.md @@ -0,0 +1,111 @@ +--- +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
DescriptionSchema for AWS::CodeStarConnections::RepositoryLink resource which is used to aggregate repository metadata relevant to synchronizing source provider content to AWS Resources.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +connection_arn, +provider_type, +owner_id, +repository_name, +encryption_key_arn, +repository_link_id, +repository_link_arn, +tags +FROM aws.codestarconnections.repository_link +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the repository_link resource, the following permissions are required: + +### Update +```json +codestar-connections:GetConnection, +codestar-connections:ListTagsForResource, +codestar-connections:PassConnection, +codestar-connections:UseConnection, +codestar-connections:TagResource, +codestar-connections:UntagResource, +codestar-connections:UpdateRepositoryLink +``` + +### Read +```json +codestar-connections:GetRepositoryLink, +codestar-connections:ListTagsForResource, +codestar-connections:GetConnection +``` + +### Delete +```json +codestar-connections:GetRepositoryLink, +codestar-connections:DeleteRepositoryLink, +codestar-connections:GetConnection +``` + diff --git a/docs/aws-docs/providers/aws/codestarconnections/repository_links/index.md b/docs/aws-docs/providers/aws/codestarconnections/repository_links/index.md new file mode 100644 index 0000000000..de3b5d5d65 --- /dev/null +++ b/docs/aws-docs/providers/aws/codestarconnections/repository_links/index.md @@ -0,0 +1,83 @@ +--- +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
DescriptionSchema for AWS::CodeStarConnections::RepositoryLink resource which is used to aggregate repository metadata relevant to synchronizing source provider content to AWS Resources.
Idaws.codestarconnections.repository_links
+ +## Fields + + + + + +
NameDatatypeDescription
repository_link_arnstringA unique Amazon Resource Name (ARN) to designate the repository link.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +repository_link_arn +FROM aws.codestarconnections.repository_links +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the repository_links resource, the following permissions are required: + +### Create +```json +codestar-connections:CreateRepositoryLink, +codestar-connections:TagResource, +codestar-connections:UseConnection, +codestar-connections:PassConnection, +codestar-connections:GetConnection, +iam:CreateServiceLinkedRole +``` + +### List +```json +codestar-connections:ListRepositoryLinks, +codestar-connections:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/codestarconnections/sync_configuration/index.md b/docs/aws-docs/providers/aws/codestarconnections/sync_configuration/index.md new file mode 100644 index 0000000000..6719a5a77a --- /dev/null +++ b/docs/aws-docs/providers/aws/codestarconnections/sync_configuration/index.md @@ -0,0 +1,110 @@ +--- +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
DescriptionSchema for AWS::CodeStarConnections::SyncConfiguration resource which is used to enables an AWS resource to be synchronized from a source-provider.
Idaws.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.
publish_deployment_statusstringWhether to enable or disable publishing of deployment status to source providers.
trigger_resource_update_onstringWhen to trigger Git sync to begin the stack update.
repository_link_idstringA UUID that uniquely identifies the RepositoryLink that the SyncConfig is associated with.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +owner_id, +resource_name, +repository_name, +provider_type, +branch, +config_file, +sync_type, +role_arn, +publish_deployment_status, +trigger_resource_update_on, +repository_link_id +FROM aws.codestarconnections.sync_configuration +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the sync_configuration resource, the following permissions are required: + +### Read +```json +codestar-connections:GetSyncConfiguration +``` + +### Update +```json +codestar-connections:UpdateSyncConfiguration, +codestar-connections:PassRepository, +iam:PassRole +``` + +### Delete +```json +codestar-connections:DeleteSyncConfiguration, +codestar-connections:GetSyncConfiguration +``` + diff --git a/docs/aws-docs/providers/aws/codestarconnections/sync_configurations/index.md b/docs/aws-docs/providers/aws/codestarconnections/sync_configurations/index.md new file mode 100644 index 0000000000..1d2795d1d8 --- /dev/null +++ b/docs/aws-docs/providers/aws/codestarconnections/sync_configurations/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionSchema for AWS::CodeStarConnections::SyncConfiguration resource which is used to enables an AWS resource to be synchronized from a source-provider.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +resource_name, +sync_type +FROM aws.codestarconnections.sync_configurations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the sync_configurations resource, the following permissions are required: + +### Create +```json +codestar-connections:CreateSyncConfiguration, +codestar-connections:PassRepository, +iam:PassRole +``` + +### List +```json +codestar-connections:ListSyncConfigurations, +codestar-connections:ListRepositoryLinks +``` + diff --git a/docs/aws-docs/providers/aws/codestarnotifications/index.md b/docs/aws-docs/providers/aws/codestarnotifications/index.md new file mode 100644 index 0000000000..60a5ce9e1e --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/codestarnotifications/notification_rule/index.md b/docs/aws-docs/providers/aws/codestarnotifications/notification_rule/index.md new file mode 100644 index 0000000000..61d819eba9 --- /dev/null +++ b/docs/aws-docs/providers/aws/codestarnotifications/notification_rule/index.md @@ -0,0 +1,110 @@ +--- +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
DescriptionResource Type definition for AWS::CodeStarNotifications::NotificationRule
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +event_type_id, +created_by, +target_address, +event_type_ids, +status, +detail_type, +resource, +targets, +tags, +name, +arn +FROM aws.codestarnotifications.notification_rule +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the notification_rule resource, the following permissions are required: + +### Read +```json +codestar-notifications:describeNotificationRule +``` + +### Delete +```json +codestar-notifications:deleteNotificationRule, +codestar-notifications:describeNotificationRule +``` + +### Update +```json +codestar-notifications:updateNotificationRule, +codestar-notifications:TagResource, +codestar-notifications:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/codestarnotifications/notification_rules/index.md b/docs/aws-docs/providers/aws/codestarnotifications/notification_rules/index.md new file mode 100644 index 0000000000..b2cbace9cb --- /dev/null +++ b/docs/aws-docs/providers/aws/codestarnotifications/notification_rules/index.md @@ -0,0 +1,77 @@ +--- +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
DescriptionResource Type definition for AWS::CodeStarNotifications::NotificationRule
Idaws.codestarnotifications.notification_rules
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.codestarnotifications.notification_rules +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the notification_rules resource, the following permissions are required: + +### Create +```json +codestar-notifications:createNotificationRule +``` + +### List +```json +codestar-notifications:listNotificationRules +``` + diff --git a/docs/aws-docs/providers/aws/cognito/identity_pool/index.md b/docs/aws-docs/providers/aws/cognito/identity_pool/index.md new file mode 100644 index 0000000000..081d941854 --- /dev/null +++ b/docs/aws-docs/providers/aws/cognito/identity_pool/index.md @@ -0,0 +1,115 @@ +--- +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
DescriptionResource Type definition for AWS::Cognito::IdentityPool
Idaws.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_arnsarray
open_id_connect_provider_arnsarray
allow_classic_flowboolean
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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_arns, +open_id_connect_provider_arns, +allow_classic_flow +FROM aws.cognito.identity_pool +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the identity_pool resource, the following permissions are required: + +### Read +```json +cognito-identity:DescribeIdentityPool +``` + +### Update +```json +cognito-identity:UpdateIdentityPool, +cognito-identity:DescribeIdentityPool, +cognito-sync:SetIdentityPoolConfiguration, +cognito-sync:SetCognitoEvents, +iam:PassRole +``` + +### Delete +```json +cognito-identity:DeleteIdentityPool +``` + diff --git a/docs/aws-docs/providers/aws/cognito/identity_pool_principal_tag/index.md b/docs/aws-docs/providers/aws/cognito/identity_pool_principal_tag/index.md new file mode 100644 index 0000000000..0106ba018b --- /dev/null +++ b/docs/aws-docs/providers/aws/cognito/identity_pool_principal_tag/index.md @@ -0,0 +1,95 @@ +--- +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
DescriptionResource Type definition for AWS::Cognito::IdentityPoolPrincipalTag
Idaws.cognito.identity_pool_principal_tag
+ +## Fields + + + + + + + + +
NameDatatypeDescription
identity_pool_idstring
identity_provider_namestring
use_defaultsboolean
principal_tagsobject
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +identity_pool_id, +identity_provider_name, +use_defaults, +principal_tags +FROM aws.cognito.identity_pool_principal_tag +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the identity_pool_principal_tag resource, the following permissions are required: + +### Read +```json +cognito-identity:GetPrincipalTagAttributeMap +``` + +### Update +```json +cognito-identity:GetPrincipalTagAttributeMap, +cognito-identity:SetPrincipalTagAttributeMap +``` + +### Delete +```json +cognito-identity:GetPrincipalTagAttributeMap, +cognito-identity:SetPrincipalTagAttributeMap +``` + diff --git a/docs/aws-docs/providers/aws/cognito/identity_pool_principal_tags/index.md b/docs/aws-docs/providers/aws/cognito/identity_pool_principal_tags/index.md new file mode 100644 index 0000000000..3a52609ea2 --- /dev/null +++ b/docs/aws-docs/providers/aws/cognito/identity_pool_principal_tags/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionResource Type definition for AWS::Cognito::IdentityPoolPrincipalTag
Idaws.cognito.identity_pool_principal_tags
+ +## Fields + + + + + + +
NameDatatypeDescription
identity_pool_idstring
identity_provider_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +identity_pool_id, +identity_provider_name +FROM aws.cognito.identity_pool_principal_tags +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the identity_pool_principal_tags resource, the following permissions are required: + +### Create +```json +cognito-identity:GetPrincipalTagAttributeMap, +cognito-identity:SetPrincipalTagAttributeMap +``` + +### List +```json +cognito-identity:GetPrincipalTagAttributeMap +``` + diff --git a/docs/aws-docs/providers/aws/cognito/identity_pool_role_attachment/index.md b/docs/aws-docs/providers/aws/cognito/identity_pool_role_attachment/index.md new file mode 100644 index 0000000000..9405946f2a --- /dev/null +++ b/docs/aws-docs/providers/aws/cognito/identity_pool_role_attachment/index.md @@ -0,0 +1,96 @@ +--- +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
DescriptionResource Type definition for AWS::Cognito::IdentityPoolRoleAttachment
Idaws.cognito.identity_pool_role_attachment
+ +## Fields + + + + + + + + +
NameDatatypeDescription
identity_pool_idstring
rolesundefined
idstring
role_mappingsundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +identity_pool_id, +roles, +id, +role_mappings +FROM aws.cognito.identity_pool_role_attachment +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the identity_pool_role_attachment resource, the following permissions are required: + +### Read +```json +cognito-identity:GetIdentityPoolRoles +``` + +### Update +```json +cognito-identity:GetIdentityPoolRoles, +cognito-identity:SetIdentityPoolRoles, +iam:PassRole +``` + +### Delete +```json +cognito-identity:GetIdentityPoolRoles, +cognito-identity:SetIdentityPoolRoles +``` + diff --git a/docs/aws-docs/providers/aws/cognito/identity_pool_role_attachments/index.md b/docs/aws-docs/providers/aws/cognito/identity_pool_role_attachments/index.md new file mode 100644 index 0000000000..97901694ae --- /dev/null +++ b/docs/aws-docs/providers/aws/cognito/identity_pool_role_attachments/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource Type definition for AWS::Cognito::IdentityPoolRoleAttachment
Idaws.cognito.identity_pool_role_attachments
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.cognito.identity_pool_role_attachments +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the identity_pool_role_attachments resource, the following permissions are required: + +### Create +```json +cognito-identity:GetIdentityPoolRoles, +cognito-identity:SetIdentityPoolRoles, +iam:PassRole +``` + +### List +```json +cognito-identity:GetIdentityPoolRoles +``` + diff --git a/docs/aws-docs/providers/aws/cognito/identity_pools/index.md b/docs/aws-docs/providers/aws/cognito/identity_pools/index.md new file mode 100644 index 0000000000..ffd60f07f1 --- /dev/null +++ b/docs/aws-docs/providers/aws/cognito/identity_pools/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionResource Type definition for AWS::Cognito::IdentityPool
Idaws.cognito.identity_pools
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.cognito.identity_pools +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the identity_pools resource, the following permissions are required: + +### Create +```json +cognito-identity:CreateIdentityPool, +cognito-sync:SetIdentityPoolConfiguration, +cognito-sync:SetCognitoEvents, +iam:PassRole +``` + +### List +```json +cognito-identity:ListIdentityPools +``` + diff --git a/docs/aws-docs/providers/aws/cognito/index.md b/docs/aws-docs/providers/aws/cognito/index.md new file mode 100644 index 0000000000..2819a5a952 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/cognito/log_delivery_configuration/index.md b/docs/aws-docs/providers/aws/cognito/log_delivery_configuration/index.md new file mode 100644 index 0000000000..f2c28504e7 --- /dev/null +++ b/docs/aws-docs/providers/aws/cognito/log_delivery_configuration/index.md @@ -0,0 +1,109 @@ +--- +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
DescriptionResource Type definition for AWS::Cognito::LogDeliveryConfiguration
Idaws.cognito.log_delivery_configuration
+ +## Fields + + + + + + + +
NameDatatypeDescription
idstring
user_pool_idstring
log_configurationsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +user_pool_id, +log_configurations +FROM aws.cognito.log_delivery_configuration +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the log_delivery_configuration resource, the following permissions are required: + +### Read +```json +cognito-idp:GetLogDeliveryConfiguration +``` + +### Update +```json +cognito-idp:GetLogDeliveryConfiguration, +cognito-idp:SetLogDeliveryConfiguration, +logs:CreateLogDelivery, +logs:GetLogDelivery, +logs:UpdateLogDelivery, +logs:DeleteLogDelivery, +logs:ListLogDeliveries, +logs:PutResourcePolicy, +logs:DescribeResourcePolicies, +logs:DescribeLogGroups +``` + +### Delete +```json +cognito-idp:GetLogDeliveryConfiguration, +cognito-idp:SetLogDeliveryConfiguration, +logs:CreateLogDelivery, +logs:GetLogDelivery, +logs:UpdateLogDelivery, +logs:DeleteLogDelivery, +logs:ListLogDeliveries, +logs:PutResourcePolicy, +logs:DescribeResourcePolicies, +logs:DescribeLogGroups +``` + diff --git a/docs/aws-docs/providers/aws/cognito/log_delivery_configurations/index.md b/docs/aws-docs/providers/aws/cognito/log_delivery_configurations/index.md new file mode 100644 index 0000000000..a5ccbd877b --- /dev/null +++ b/docs/aws-docs/providers/aws/cognito/log_delivery_configurations/index.md @@ -0,0 +1,76 @@ +--- +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
DescriptionResource Type definition for AWS::Cognito::LogDeliveryConfiguration
Idaws.cognito.log_delivery_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.cognito.log_delivery_configurations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the log_delivery_configurations resource, the following permissions are required: + +### Create +```json +cognito-idp:GetLogDeliveryConfiguration, +cognito-idp:SetLogDeliveryConfiguration, +logs:CreateLogDelivery, +logs:GetLogDelivery, +logs:UpdateLogDelivery, +logs:DeleteLogDelivery, +logs:ListLogDeliveries, +logs:PutResourcePolicy, +logs:DescribeResourcePolicies, +logs:DescribeLogGroups +``` + diff --git a/docs/aws-docs/providers/aws/cognito/user_pool/index.md b/docs/aws-docs/providers/aws/cognito/user_pool/index.md new file mode 100644 index 0000000000..e8edcbf02a --- /dev/null +++ b/docs/aws-docs/providers/aws/cognito/user_pool/index.md @@ -0,0 +1,148 @@ +--- +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
DescriptionResource Type definition for AWS::Cognito::UserPool
Idaws.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_urlstring
arnstring
user_pool_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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_url, +arn, +user_pool_id +FROM aws.cognito.user_pool +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the user_pool resource, the following permissions are required: + +### Read +```json +cognito-idp:DescribeUserPool +``` + +### Update +```json +cognito-idp:UpdateUserPool, +cognito-idp:ListTagsForResource, +cognito-idp:UntagResource, +cognito-idp:TagResource, +cognito-idp:SetUserPoolMfaConfig, +cognito-idp:AddCustomAttributes, +cognito-idp:DescribeUserPool, +iam:PassRole +``` + +### Delete +```json +cognito-idp:DeleteUserPool +``` + diff --git a/docs/aws-docs/providers/aws/cognito/user_pool_client/index.md b/docs/aws-docs/providers/aws/cognito/user_pool_client/index.md new file mode 100644 index 0000000000..7ec5175854 --- /dev/null +++ b/docs/aws-docs/providers/aws/cognito/user_pool_client/index.md @@ -0,0 +1,139 @@ +--- +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
DescriptionResource Type definition for AWS::Cognito::UserPoolClient
Idaws.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_urlsarray
default_redirect_uristring
logout_urlsarray
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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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_urls, +default_redirect_uri, +logout_urls, +supported_identity_providers, +analytics_configuration, +prevent_user_existence_errors, +enable_token_revocation, +enable_propagate_additional_user_context_data, +name, +client_secret, +client_id +FROM aws.cognito.user_pool_client +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the user_pool_client resource, the following permissions are required: + +### Read +```json +cognito-idp:DescribeUserPoolClient +``` + +### Update +```json +cognito-idp:UpdateUserPoolClient, +iam:PassRole, +iam:PutRolePolicy +``` + +### Delete +```json +cognito-idp:DeleteUserPoolClient, +iam:PutRolePolicy, +iam:DeleteRolePolicy +``` + diff --git a/docs/aws-docs/providers/aws/cognito/user_pool_clients/index.md b/docs/aws-docs/providers/aws/cognito/user_pool_clients/index.md new file mode 100644 index 0000000000..41413ab3ff --- /dev/null +++ b/docs/aws-docs/providers/aws/cognito/user_pool_clients/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionResource Type definition for AWS::Cognito::UserPoolClient
Idaws.cognito.user_pool_clients
+ +## Fields + + + + + + +
NameDatatypeDescription
user_pool_idstring
client_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +user_pool_id, +client_id +FROM aws.cognito.user_pool_clients +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the user_pool_clients resource, the following permissions are required: + +### Create +```json +cognito-idp:CreateUserPoolClient, +iam:PassRole, +iam:PutRolePolicy, +iam:CreateServiceLinkedRole +``` + +### List +```json +cognito-idp:ListUserPoolClients +``` + diff --git a/docs/aws-docs/providers/aws/cognito/user_pool_group/index.md b/docs/aws-docs/providers/aws/cognito/user_pool_group/index.md new file mode 100644 index 0000000000..678a657824 --- /dev/null +++ b/docs/aws-docs/providers/aws/cognito/user_pool_group/index.md @@ -0,0 +1,99 @@ +--- +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
DescriptionResource Type definition for AWS::Cognito::UserPoolGroup
Idaws.cognito.user_pool_group
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
descriptionstring
group_namestring
precedenceinteger
role_arnstring
user_pool_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +description, +group_name, +precedence, +role_arn, +user_pool_id +FROM aws.cognito.user_pool_group +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the user_pool_group resource, the following permissions are required: + +### Read +```json +cognito-idp:GetGroup +``` + +### Update +```json +cognito-idp:UpdateGroup, +iam:PassRole, +iam:PutRolePolicy +``` + +### Delete +```json +cognito-idp:DeleteGroup, +cognito-idp:GetGroup, +iam:PutRolePolicy +``` + diff --git a/docs/aws-docs/providers/aws/cognito/user_pool_groups/index.md b/docs/aws-docs/providers/aws/cognito/user_pool_groups/index.md new file mode 100644 index 0000000000..2cb8590014 --- /dev/null +++ b/docs/aws-docs/providers/aws/cognito/user_pool_groups/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionResource Type definition for AWS::Cognito::UserPoolGroup
Idaws.cognito.user_pool_groups
+ +## Fields + + + + + + +
NameDatatypeDescription
user_pool_idstring
group_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +user_pool_id, +group_name +FROM aws.cognito.user_pool_groups +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the user_pool_groups resource, the following permissions are required: + +### Create +```json +cognito-idp:CreateGroup, +iam:PassRole, +iam:PutRolePolicy, +cognito-idp:GetGroup +``` + +### List +```json +cognito-idp:ListGroups +``` + diff --git a/docs/aws-docs/providers/aws/cognito/user_pool_risk_configuration_attachment/index.md b/docs/aws-docs/providers/aws/cognito/user_pool_risk_configuration_attachment/index.md new file mode 100644 index 0000000000..6bb38c549c --- /dev/null +++ b/docs/aws-docs/providers/aws/cognito/user_pool_risk_configuration_attachment/index.md @@ -0,0 +1,98 @@ +--- +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
DescriptionResource Type definition for AWS::Cognito::UserPoolRiskConfigurationAttachment
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +user_pool_id, +client_id, +risk_exception_configuration, +compromised_credentials_risk_configuration, +account_takeover_risk_configuration +FROM aws.cognito.user_pool_risk_configuration_attachment +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the user_pool_risk_configuration_attachment resource, the following permissions are required: + +### Read +```json +cognito-idp:DescribeRiskConfiguration +``` + +### Update +```json +cognito-idp:SetRiskConfiguration, +cognito-idp:DescribeRiskConfiguration, +iam:PassRole +``` + +### Delete +```json +cognito-idp:SetRiskConfiguration, +cognito-idp:DescribeRiskConfiguration +``` + diff --git a/docs/aws-docs/providers/aws/cognito/user_pool_risk_configuration_attachments/index.md b/docs/aws-docs/providers/aws/cognito/user_pool_risk_configuration_attachments/index.md new file mode 100644 index 0000000000..51cd144a19 --- /dev/null +++ b/docs/aws-docs/providers/aws/cognito/user_pool_risk_configuration_attachments/index.md @@ -0,0 +1,71 @@ +--- +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
DescriptionResource Type definition for AWS::Cognito::UserPoolRiskConfigurationAttachment
Idaws.cognito.user_pool_risk_configuration_attachments
+ +## Fields + + + + + + +
NameDatatypeDescription
user_pool_idstring
client_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +user_pool_id, +client_id +FROM aws.cognito.user_pool_risk_configuration_attachments +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the user_pool_risk_configuration_attachments resource, the following permissions are required: + +### Create +```json +cognito-idp:SetRiskConfiguration, +cognito-idp:DescribeRiskConfiguration, +iam:PassRole +``` + diff --git a/docs/aws-docs/providers/aws/cognito/user_pool_user/index.md b/docs/aws-docs/providers/aws/cognito/user_pool_user/index.md new file mode 100644 index 0000000000..cc38af8baf --- /dev/null +++ b/docs/aws-docs/providers/aws/cognito/user_pool_user/index.md @@ -0,0 +1,91 @@ +--- +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
DescriptionResource Type definition for AWS::Cognito::UserPoolUser
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +desired_delivery_mediums, +force_alias_creation, +user_attributes, +message_action, +username, +user_pool_id, +validation_data, +client_metadata +FROM aws.cognito.user_pool_user +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the user_pool_user resource, the following permissions are required: + +### Read +```json +cognito-idp:AdminGetUser +``` + +### Delete +```json +cognito-idp:AdminDeleteUser +``` + diff --git a/docs/aws-docs/providers/aws/cognito/user_pool_user_to_group_attachment/index.md b/docs/aws-docs/providers/aws/cognito/user_pool_user_to_group_attachment/index.md new file mode 100644 index 0000000000..e73004a761 --- /dev/null +++ b/docs/aws-docs/providers/aws/cognito/user_pool_user_to_group_attachment/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionResource Type definition for AWS::Cognito::UserPoolUserToGroupAttachment
Idaws.cognito.user_pool_user_to_group_attachment
+ +## Fields + + + + + + + +
NameDatatypeDescription
user_pool_idstring
usernamestring
group_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +user_pool_id, +username, +group_name +FROM aws.cognito.user_pool_user_to_group_attachment +WHERE data__Identifier = '||'; +``` + +## Permissions + +To operate on the user_pool_user_to_group_attachment resource, the following permissions are required: + +### Delete +```json +cognito-idp:AdminRemoveUserFromGroup, +cognito-idp:AdminListGroupsForUser +``` + +### Read +```json +cognito-idp:AdminListGroupsForUser +``` + diff --git a/docs/aws-docs/providers/aws/cognito/user_pool_user_to_group_attachments/index.md b/docs/aws-docs/providers/aws/cognito/user_pool_user_to_group_attachments/index.md new file mode 100644 index 0000000000..43f9977bee --- /dev/null +++ b/docs/aws-docs/providers/aws/cognito/user_pool_user_to_group_attachments/index.md @@ -0,0 +1,72 @@ +--- +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
DescriptionResource Type definition for AWS::Cognito::UserPoolUserToGroupAttachment
Idaws.cognito.user_pool_user_to_group_attachments
+ +## Fields + + + + + + + +
NameDatatypeDescription
user_pool_idstring
group_namestring
usernamestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +user_pool_id, +group_name, +username +FROM aws.cognito.user_pool_user_to_group_attachments +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the user_pool_user_to_group_attachments resource, the following permissions are required: + +### Create +```json +cognito-idp:AdminAddUserToGroup, +cognito-idp:AdminListGroupsForUser +``` + diff --git a/docs/aws-docs/providers/aws/cognito/user_pool_users/index.md b/docs/aws-docs/providers/aws/cognito/user_pool_users/index.md new file mode 100644 index 0000000000..5387eb5fad --- /dev/null +++ b/docs/aws-docs/providers/aws/cognito/user_pool_users/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionResource Type definition for AWS::Cognito::UserPoolUser
Idaws.cognito.user_pool_users
+ +## Fields + + + + + + +
NameDatatypeDescription
user_pool_idstring
usernamestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +user_pool_id, +username +FROM aws.cognito.user_pool_users +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the user_pool_users resource, the following permissions are required: + +### Create +```json +cognito-idp:AdminCreateUser, +cognito-idp:AdminGetUser, +iam:PassRole +``` + +### List +```json +cognito-idp:ListUsers +``` + diff --git a/docs/aws-docs/providers/aws/cognito/user_pools/index.md b/docs/aws-docs/providers/aws/cognito/user_pools/index.md new file mode 100644 index 0000000000..cc27b05253 --- /dev/null +++ b/docs/aws-docs/providers/aws/cognito/user_pools/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionResource Type definition for AWS::Cognito::UserPool
Idaws.cognito.user_pools
+ +## Fields + + + + + +
NameDatatypeDescription
user_pool_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +user_pool_id +FROM aws.cognito.user_pools +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the user_pools resource, the following permissions are required: + +### Create +```json +cognito-idp:CreateUserPool, +iam:PassRole, +cognito-idp:SetUserPoolMfaConfig, +cognito-idp:DescribeUserPool, +kms:CreateGrant, +iam:CreateServiceLinkedRole +``` + +### List +```json +cognito-idp:ListUserPools +``` + diff --git a/docs/aws-docs/providers/aws/comprehend/document_classifier/index.md b/docs/aws-docs/providers/aws/comprehend/document_classifier/index.md new file mode 100644 index 0000000000..754d8bb522 --- /dev/null +++ b/docs/aws-docs/providers/aws/comprehend/document_classifier/index.md @@ -0,0 +1,121 @@ +--- +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 enables training document classifier models.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.comprehend.document_classifier +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the document_classifier resource, the following permissions are required: + +### Read +```json +comprehend:DescribeDocumentClassifier, +comprehend:DescribeResourcePolicy, +comprehend:ListTagsForResource +``` + +### Update +```json +iam:PassRole, +comprehend:PutResourcePolicy, +comprehend:DeleteResourcePolicy, +comprehend:DescribeResourcePolicy, +comprehend:DescribeDocumentClassifier, +comprehend:ListTagsForResource, +comprehend:TagResource, +comprehend:UntagResource +``` + +### Delete +```json +comprehend:DescribeDocumentClassifier, +comprehend:DeleteDocumentClassifier +``` + diff --git a/docs/aws-docs/providers/aws/comprehend/document_classifiers/index.md b/docs/aws-docs/providers/aws/comprehend/document_classifiers/index.md new file mode 100644 index 0000000000..03867c8782 --- /dev/null +++ b/docs/aws-docs/providers/aws/comprehend/document_classifiers/index.md @@ -0,0 +1,82 @@ +--- +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 Classifier enables training document classifier models.
Idaws.comprehend.document_classifiers
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.comprehend.document_classifiers +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the document_classifiers resource, the following permissions are required: + +### Create +```json +iam:PassRole, +comprehend:CreateDocumentClassifier, +comprehend:DescribeDocumentClassifier, +comprehend:DescribeResourcePolicy, +comprehend:ListTagsForResource, +textract:DetectDocumentText +``` + +### List +```json +comprehend:ListDocumentClassifiers +``` + diff --git a/docs/aws-docs/providers/aws/comprehend/flywheel/index.md b/docs/aws-docs/providers/aws/comprehend/flywheel/index.md new file mode 100644 index 0000000000..a00c7588d5 --- /dev/null +++ b/docs/aws-docs/providers/aws/comprehend/flywheel/index.md @@ -0,0 +1,110 @@ +--- +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
DescriptionThe AWS::Comprehend::Flywheel resource creates an Amazon Comprehend Flywheel that enables customer to train their model.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.comprehend.flywheel +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the flywheel resource, the following permissions are required: + +### Read +```json +comprehend:DescribeFlywheel, +comprehend:ListTagsForResource +``` + +### Update +```json +iam:PassRole, +comprehend:DescribeFlywheel, +comprehend:UpdateFlywheel, +comprehend:ListTagsForResource, +comprehend:TagResource, +comprehend:UntagResource +``` + +### Delete +```json +comprehend:DeleteFlywheel, +comprehend:DescribeFlywheel +``` + diff --git a/docs/aws-docs/providers/aws/comprehend/flywheels/index.md b/docs/aws-docs/providers/aws/comprehend/flywheels/index.md new file mode 100644 index 0000000000..62165471d8 --- /dev/null +++ b/docs/aws-docs/providers/aws/comprehend/flywheels/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionThe AWS::Comprehend::Flywheel resource creates an Amazon Comprehend Flywheel that enables customer to train their model.
Idaws.comprehend.flywheels
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.comprehend.flywheels +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the flywheels resource, the following permissions are required: + +### Create +```json +iam:PassRole, +comprehend:CreateFlywheel, +comprehend:DescribeFlywheel, +comprehend:ListTagsForResource +``` + +### List +```json +comprehend:ListFlywheels +``` + diff --git a/docs/aws-docs/providers/aws/comprehend/index.md b/docs/aws-docs/providers/aws/comprehend/index.md new file mode 100644 index 0000000000..04fbd30369 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/config/aggregation_authorization/index.md b/docs/aws-docs/providers/aws/config/aggregation_authorization/index.md new file mode 100644 index 0000000000..8f164c4808 --- /dev/null +++ b/docs/aws-docs/providers/aws/config/aggregation_authorization/index.md @@ -0,0 +1,99 @@ +--- +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
DescriptionResource Type definition for AWS::Config::AggregationAuthorization
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +authorized_account_id, +authorized_aws_region, +aggregation_authorization_arn, +tags +FROM aws.config.aggregation_authorization +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the aggregation_authorization resource, the following permissions are required: + +### Update +```json +config:DescribeAggregationAuthorizations, +config:TagResource, +config:UntagResource, +config:ListTagsForResource +``` + +### Read +```json +config:DescribeAggregationAuthorizations, +config:ListTagsForResource +``` + +### Delete +```json +config:DescribeAggregationAuthorizations, +config:DeleteAggregationAuthorization, +config:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/config/aggregation_authorizations/index.md b/docs/aws-docs/providers/aws/config/aggregation_authorizations/index.md new file mode 100644 index 0000000000..5d75d1f17e --- /dev/null +++ b/docs/aws-docs/providers/aws/config/aggregation_authorizations/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionResource Type definition for AWS::Config::AggregationAuthorization
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +authorized_account_id, +authorized_aws_region +FROM aws.config.aggregation_authorizations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the aggregation_authorizations resource, the following permissions are required: + +### Create +```json +config:DescribeAggregationAuthorizations, +config:PutAggregationAuthorization, +config:TagResource +``` + +### List +```json +config:DescribeAggregationAuthorizations +``` + diff --git a/docs/aws-docs/providers/aws/config/config_rule/index.md b/docs/aws-docs/providers/aws/config/config_rule/index.md new file mode 100644 index 0000000000..5618622355 --- /dev/null +++ b/docs/aws-docs/providers/aws/config/config_rule/index.md @@ -0,0 +1,108 @@ +--- +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
DescriptionYou must first create and start the CC configuration recorder in order to create CC managed rules with CFNlong. For more information, see [Managing the Configuration Recorder](https://docs.aws.amazon.com/config/latest/developerguide/stop-start-recorder.html).<br/> Adds or updates an CC rule to evaluate if your AWS resources comply with your desired configurations. For information on how many CC rules you can have per account, see [Service Limits](https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html) in the *Developer Guide*.<br/> There are two types of rules: *Managed Rules* and *Custom Rules*. You can use the ``ConfigRule`` resource to create both CC Managed Rules and CC Custom Rules.<br/> CC Managed Rules are predefined, customizable rules created by CC. For a list of managed rules, see [List of Managed Rules](https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html). If you are adding an CC managed rule, you must specify the rule's identifier for the ``SourceIdentifier`` key.<br/> CC Custom Rules are rules that you create from scratch. There are two ways to create CC custom rules: with Lambda functions ([Developer Guide](https://docs.aws.amazon.com/config/latest/developerguide/gettingstarted-concepts.html#gettingstarted-concepts-function)) and with CFNGUARDshort ([Guard GitHub Repository](https://docs.aws.amazon.com/https://github.com/aws-cloudformation/cloudformation-guard)), a policy-as-code language. CC custom rules created with LAMlong are called *Custom Lambda Rules* and CC custom rules created with CFNGUARDshort are called *Custom Policy Rules*.<br/> If you are adding a new CC Custom LAM rule, you first need to create an LAMlong function that the rule invokes to evaluate your resources. When you use the ``ConfigRule`` resource to add a Custom LAM rule to CC, you must specify the Amazon Resource Name (ARN) that LAMlong assigns to the function. You specify the ARN in the ``SourceIdentifier`` key. This key is part of the ``Source`` object, which is part of the ``ConfigRule`` object. <br/> For any new CC rule that you add, specify the ``ConfigRuleName`` in the ``ConfigRule`` object. Do not specify the ``ConfigRuleArn`` or the ``ConfigRuleId``. These values are generated by CC for new rules.<br/> If you are updating a rule that you added previously, you can specify the rule by ``ConfigRuleName``, ``ConfigRuleId``, or ``ConfigRuleArn`` in the ``ConfigRule`` data type that you use in this request.<br/> For more information about developing and using CC rules, see [Evaluating Resources with Rules](https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html) in the *Developer Guide*.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +config_rule_id, +description, +scope, +config_rule_name, +arn, +compliance, +maximum_execution_frequency, +source, +input_parameters, +evaluation_modes +FROM aws.config.config_rule +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the config_rule resource, the following permissions are required: + +### Read +```json +config:DescribeConfigRules, +config:DescribeComplianceByConfigRule +``` + +### Delete +```json +config:DeleteConfigRule, +config:DescribeConfigRules +``` + +### Update +```json +config:PutConfigRule, +config:DescribeConfigRules +``` + diff --git a/docs/aws-docs/providers/aws/config/config_rules/index.md b/docs/aws-docs/providers/aws/config/config_rules/index.md new file mode 100644 index 0000000000..0b7a296921 --- /dev/null +++ b/docs/aws-docs/providers/aws/config/config_rules/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionYou must first create and start the CC configuration recorder in order to create CC managed rules with CFNlong. For more information, see [Managing the Configuration Recorder](https://docs.aws.amazon.com/config/latest/developerguide/stop-start-recorder.html).<br/> Adds or updates an CC rule to evaluate if your AWS resources comply with your desired configurations. For information on how many CC rules you can have per account, see [Service Limits](https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html) in the *Developer Guide*.<br/> There are two types of rules: *Managed Rules* and *Custom Rules*. You can use the ``ConfigRule`` resource to create both CC Managed Rules and CC Custom Rules.<br/> CC Managed Rules are predefined, customizable rules created by CC. For a list of managed rules, see [List of Managed Rules](https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html). If you are adding an CC managed rule, you must specify the rule's identifier for the ``SourceIdentifier`` key.<br/> CC Custom Rules are rules that you create from scratch. There are two ways to create CC custom rules: with Lambda functions ([Developer Guide](https://docs.aws.amazon.com/config/latest/developerguide/gettingstarted-concepts.html#gettingstarted-concepts-function)) and with CFNGUARDshort ([Guard GitHub Repository](https://docs.aws.amazon.com/https://github.com/aws-cloudformation/cloudformation-guard)), a policy-as-code language. CC custom rules created with LAMlong are called *Custom Lambda Rules* and CC custom rules created with CFNGUARDshort are called *Custom Policy Rules*.<br/> If you are adding a new CC Custom LAM rule, you first need to create an LAMlong function that the rule invokes to evaluate your resources. When you use the ``ConfigRule`` resource to add a Custom LAM rule to CC, you must specify the Amazon Resource Name (ARN) that LAMlong assigns to the function. You specify the ARN in the ``SourceIdentifier`` key. This key is part of the ``Source`` object, which is part of the ``ConfigRule`` object. <br/> For any new CC rule that you add, specify the ``ConfigRuleName`` in the ``ConfigRule`` object. Do not specify the ``ConfigRuleArn`` or the ``ConfigRuleId``. These values are generated by CC for new rules.<br/> If you are updating a rule that you added previously, you can specify the rule by ``ConfigRuleName``, ``ConfigRuleId``, or ``ConfigRuleArn`` in the ``ConfigRule`` data type that you use in this request.<br/> For more information about developing and using CC rules, see [Evaluating Resources with Rules](https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html) in the *Developer Guide*.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +config_rule_name +FROM aws.config.config_rules +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the config_rules resource, the following permissions are required: + +### Create +```json +config:PutConfigRule, +config:DescribeConfigRules +``` + +### List +```json +config:DescribeConfigRules +``` + diff --git a/docs/aws-docs/providers/aws/config/configuration_aggregator/index.md b/docs/aws-docs/providers/aws/config/configuration_aggregator/index.md new file mode 100644 index 0000000000..223afdde70 --- /dev/null +++ b/docs/aws-docs/providers/aws/config/configuration_aggregator/index.md @@ -0,0 +1,104 @@ +--- +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
DescriptionResource Type definition for AWS::Config::ConfigurationAggregator
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +account_aggregation_sources, +configuration_aggregator_name, +configuration_aggregator_arn, +organization_aggregation_source, +tags +FROM aws.config.configuration_aggregator +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the configuration_aggregator resource, the following permissions are required: + +### Read +```json +config:DescribeConfigurationAggregators, +config:ListTagsForResource +``` + +### Update +```json +config:PutConfigurationAggregator, +config:DescribeConfigurationAggregators, +config:TagResource, +config:UntagResource, +config:ListTagsForResource, +iam:PassRole, +organizations:EnableAWSServiceAccess, +organizations:ListDelegatedAdministrators +``` + +### Delete +```json +config:DeleteConfigurationAggregator, +config:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/config/configuration_aggregators/index.md b/docs/aws-docs/providers/aws/config/configuration_aggregators/index.md new file mode 100644 index 0000000000..3dbea540d9 --- /dev/null +++ b/docs/aws-docs/providers/aws/config/configuration_aggregators/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionResource Type definition for AWS::Config::ConfigurationAggregator
Idaws.config.configuration_aggregators
+ +## Fields + + + + + +
NameDatatypeDescription
configuration_aggregator_namestringThe name of the aggregator.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +configuration_aggregator_name +FROM aws.config.configuration_aggregators +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the configuration_aggregators resource, the following permissions are required: + +### Create +```json +config:PutConfigurationAggregator, +config:DescribeConfigurationAggregators, +config:TagResource, +iam:PassRole, +organizations:EnableAWSServiceAccess, +organizations:ListDelegatedAdministrators +``` + +### List +```json +config:DescribeConfigurationAggregators +``` + diff --git a/docs/aws-docs/providers/aws/config/conformance_pack/index.md b/docs/aws-docs/providers/aws/config/conformance_pack/index.md new file mode 100644 index 0000000000..0e50b67a1e --- /dev/null +++ b/docs/aws-docs/providers/aws/config/conformance_pack/index.md @@ -0,0 +1,105 @@ +--- +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
DescriptionA conformance pack is a collection of AWS Config rules and remediation actions that can be easily deployed as a single entity in an account and a region or across an entire AWS Organization.
Idaws.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_ssm_document_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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +conformance_pack_name, +delivery_s3_bucket, +delivery_s3_key_prefix, +template_body, +template_s3_uri, +template_ssm_document_details, +conformance_pack_input_parameters +FROM aws.config.conformance_pack +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the conformance_pack resource, the following permissions are required: + +### Read +```json +config:DescribeConformancePacks +``` + +### Update +```json +config:PutConformancePack, +config:DescribeConformancePackStatus, +s3:GetObject, +s3:GetBucketAcl, +iam:CreateServiceLinkedRole, +iam:PassRole +``` + +### Delete +```json +config:DeleteConformancePack, +config:DescribeConformancePackStatus +``` + diff --git a/docs/aws-docs/providers/aws/config/conformance_packs/index.md b/docs/aws-docs/providers/aws/config/conformance_packs/index.md new file mode 100644 index 0000000000..4e8928dc52 --- /dev/null +++ b/docs/aws-docs/providers/aws/config/conformance_packs/index.md @@ -0,0 +1,83 @@ +--- +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
DescriptionA conformance pack is a collection of AWS Config rules and remediation actions that can be easily deployed as a single entity in an account and a region or across an entire AWS Organization.
Idaws.config.conformance_packs
+ +## Fields + + + + + +
NameDatatypeDescription
conformance_pack_namestringName of the conformance pack which will be assigned as the unique identifier.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +conformance_pack_name +FROM aws.config.conformance_packs +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the conformance_packs resource, the following permissions are required: + +### Create +```json +config:PutConformancePack, +config:DescribeConformancePackStatus, +config:DescribeConformancePacks, +s3:GetObject, +s3:GetBucketAcl, +iam:CreateServiceLinkedRole, +iam:PassRole +``` + +### List +```json +config:DescribeConformancePacks +``` + diff --git a/docs/aws-docs/providers/aws/config/index.md b/docs/aws-docs/providers/aws/config/index.md new file mode 100644 index 0000000000..ad49a85b3c --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/config/organization_conformance_pack/index.md b/docs/aws-docs/providers/aws/config/organization_conformance_pack/index.md new file mode 100644 index 0000000000..a965446cd7 --- /dev/null +++ b/docs/aws-docs/providers/aws/config/organization_conformance_pack/index.md @@ -0,0 +1,110 @@ +--- +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
DescriptionResource schema for AWS::Config::OrganizationConformancePack.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.config.organization_conformance_pack +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the organization_conformance_pack resource, the following permissions are required: + +### Read +```json +config:DescribeOrganizationConformancePacks +``` + +### Delete +```json +config:DeleteOrganizationConformancePack, +config:DescribeOrganizationConformancePackStatuses, +config:GetOrganizationConformancePackDetailedStatus, +organizations:ListDelegatedAdministrators +``` + +### Update +```json +config:PutOrganizationConformancePack, +config:DescribeOrganizationConformancePackStatuses, +config:GetOrganizationConformancePackDetailedStatus, +s3:GetObject, +s3:GetBucketAcl, +iam:CreateServiceLinkedRole, +iam:PassRole, +organizations:ListDelegatedAdministrators, +organizations:EnableAWSServiceAccess +``` + diff --git a/docs/aws-docs/providers/aws/config/organization_conformance_packs/index.md b/docs/aws-docs/providers/aws/config/organization_conformance_packs/index.md new file mode 100644 index 0000000000..d9c980d66d --- /dev/null +++ b/docs/aws-docs/providers/aws/config/organization_conformance_packs/index.md @@ -0,0 +1,86 @@ +--- +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
DescriptionResource schema for AWS::Config::OrganizationConformancePack.
Idaws.config.organization_conformance_packs
+ +## Fields + + + + + +
NameDatatypeDescription
organization_conformance_pack_namestringThe name of the organization conformance pack.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +organization_conformance_pack_name +FROM aws.config.organization_conformance_packs +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the organization_conformance_packs resource, the following permissions are required: + +### Create +```json +config:PutOrganizationConformancePack, +config:DescribeOrganizationConformancePackStatuses, +config:GetOrganizationConformancePackDetailedStatus, +config:DescribeOrganizationConformancePacks, +s3:GetObject, +s3:GetBucketAcl, +iam:CreateServiceLinkedRole, +iam:PassRole, +organizations:ListDelegatedAdministrators, +organizations:EnableAWSServiceAccess +``` + +### List +```json +config:DescribeOrganizationConformancePacks +``` + diff --git a/docs/aws-docs/providers/aws/config/stored_queries/index.md b/docs/aws-docs/providers/aws/config/stored_queries/index.md new file mode 100644 index 0000000000..d60c4bec68 --- /dev/null +++ b/docs/aws-docs/providers/aws/config/stored_queries/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource Type definition for AWS::Config::StoredQuery
Idaws.config.stored_queries
+ +## Fields + + + + + +
NameDatatypeDescription
query_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +query_name +FROM aws.config.stored_queries +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the stored_queries resource, the following permissions are required: + +### Create +```json +config:PutStoredQuery, +config:GetStoredQuery, +config:TagResource +``` + +### List +```json +config:ListStoredQueries +``` + diff --git a/docs/aws-docs/providers/aws/config/stored_query/index.md b/docs/aws-docs/providers/aws/config/stored_query/index.md new file mode 100644 index 0000000000..a5cc3d1788 --- /dev/null +++ b/docs/aws-docs/providers/aws/config/stored_query/index.md @@ -0,0 +1,103 @@ +--- +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
DescriptionResource Type definition for AWS::Config::StoredQuery
Idaws.config.stored_query
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
query_arnstring
query_idstring
query_namestring
query_descriptionstring
query_expressionstring
tagsarrayThe tags for the stored query.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +query_arn, +query_id, +query_name, +query_description, +query_expression, +tags +FROM aws.config.stored_query +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the stored_query resource, the following permissions are required: + +### Read +```json +config:GetStoredQuery, +config:ListTagsForResource +``` + +### Update +```json +config:PutStoredQuery, +config:GetStoredQuery, +config:TagResource, +config:UntagResource, +config:ListTagsForResource +``` + +### Delete +```json +config:DeleteStoredQuery, +config:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/connect/approved_origin/index.md b/docs/aws-docs/providers/aws/connect/approved_origin/index.md new file mode 100644 index 0000000000..ebc421aa45 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/approved_origin/index.md @@ -0,0 +1,85 @@ +--- +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
DescriptionResource Type definition for AWS::Connect::ApprovedOrigin
Idaws.connect.approved_origin
+ +## Fields + + + + + + +
NameDatatypeDescription
originstring
instance_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +origin, +instance_id +FROM aws.connect.approved_origin +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the approved_origin resource, the following permissions are required: + +### Read +```json +connect:ListApprovedOrigins +``` + +### Delete +```json +connect:DisassociateApprovedOrigin, +connect:ListApprovedOrigins +``` + diff --git a/docs/aws-docs/providers/aws/connect/approved_origins/index.md b/docs/aws-docs/providers/aws/connect/approved_origins/index.md new file mode 100644 index 0000000000..b7569c44a0 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/approved_origins/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionResource Type definition for AWS::Connect::ApprovedOrigin
Idaws.connect.approved_origins
+ +## Fields + + + + + + +
NameDatatypeDescription
instance_idundefined
originundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +instance_id, +origin +FROM aws.connect.approved_origins +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the approved_origins resource, the following permissions are required: + +### Create +```json +connect:AssociateApprovedOrigin, +connect:ListApprovedOrigins +``` + +### List +```json +connect:ListApprovedOrigins +``` + diff --git a/docs/aws-docs/providers/aws/connect/contact_flow/index.md b/docs/aws-docs/providers/aws/connect/contact_flow/index.md new file mode 100644 index 0000000000..14e10d165d --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/contact_flow/index.md @@ -0,0 +1,105 @@ +--- +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
DescriptionResource Type definition for AWS::Connect::ContactFlow
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +instance_arn, +contact_flow_arn, +name, +content, +description, +state, +type, +tags +FROM aws.connect.contact_flow +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the contact_flow resource, the following permissions are required: + +### Read +```json +connect:DescribeContactFlow +``` + +### Delete +```json +connect:DeleteContactFlow, +connect:UntagResource +``` + +### Update +```json +connect:UpdateContactFlowMetadata, +connect:UpdateContactFlowContent, +connect:TagResource, +connect:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/connect/contact_flow_module/index.md b/docs/aws-docs/providers/aws/connect/contact_flow_module/index.md new file mode 100644 index 0000000000..d05c47d1cf --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/contact_flow_module/index.md @@ -0,0 +1,105 @@ +--- +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
DescriptionResource Type definition for AWS::Connect::ContactFlowModule.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +instance_arn, +contact_flow_module_arn, +name, +content, +description, +state, +status, +tags +FROM aws.connect.contact_flow_module +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the contact_flow_module resource, the following permissions are required: + +### Read +```json +connect:DescribeContactFlowModule +``` + +### Delete +```json +connect:DeleteContactFlowModule, +connect:UntagResource +``` + +### Update +```json +connect:UpdateContactFlowModuleMetadata, +connect:UpdateContactFlowModuleContent, +connect:TagResource, +connect:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/connect/contact_flow_modules/index.md b/docs/aws-docs/providers/aws/connect/contact_flow_modules/index.md new file mode 100644 index 0000000000..a1bc743018 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/contact_flow_modules/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionResource Type definition for AWS::Connect::ContactFlowModule.
Idaws.connect.contact_flow_modules
+ +## Fields + + + + + +
NameDatatypeDescription
contact_flow_module_arnstringThe identifier of the contact flow module (ARN).
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +contact_flow_module_arn +FROM aws.connect.contact_flow_modules +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the contact_flow_modules resource, the following permissions are required: + +### Create +```json +connect:CreateContactFlowModule, +connect:TagResource +``` + +### List +```json +connect:ListContactFlowModules +``` + diff --git a/docs/aws-docs/providers/aws/connect/contact_flows/index.md b/docs/aws-docs/providers/aws/connect/contact_flows/index.md new file mode 100644 index 0000000000..de16da18f3 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/contact_flows/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionResource Type definition for AWS::Connect::ContactFlow
Idaws.connect.contact_flows
+ +## Fields + + + + + +
NameDatatypeDescription
contact_flow_arnstringThe identifier of the contact flow (ARN).
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +contact_flow_arn +FROM aws.connect.contact_flows +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the contact_flows resource, the following permissions are required: + +### Create +```json +connect:CreateContactFlow, +connect:TagResource +``` + +### List +```json +connect:ListContactFlows +``` + diff --git a/docs/aws-docs/providers/aws/connect/evaluation_form/index.md b/docs/aws-docs/providers/aws/connect/evaluation_form/index.md new file mode 100644 index 0000000000..7034b5abcb --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/evaluation_form/index.md @@ -0,0 +1,108 @@ +--- +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
DescriptionResource Type definition for AWS::Connect::EvaluationForm
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +title, +description, +evaluation_form_arn, +instance_arn, +items, +scoring_strategy, +status, +tags +FROM aws.connect.evaluation_form +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the evaluation_form resource, the following permissions are required: + +### Read +```json +connect:DescribeEvaluationForm, +connect:ListEvaluationFormVersions +``` + +### Update +```json +connect:UpdateEvaluationForm, +connect:ListEvaluationFormVersions, +connect:ActivateEvaluationForm, +connect:DeactivateEvaluationForm, +connect:TagResource, +connect:UntagResource +``` + +### Delete +```json +connect:DeleteEvaluationForm, +connect:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/connect/evaluation_forms/index.md b/docs/aws-docs/providers/aws/connect/evaluation_forms/index.md new file mode 100644 index 0000000000..21a472cff9 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/evaluation_forms/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource Type definition for AWS::Connect::EvaluationForm
Idaws.connect.evaluation_forms
+ +## Fields + + + + + +
NameDatatypeDescription
evaluation_form_arnstringThe Amazon Resource Name (ARN) for the evaluation form.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +evaluation_form_arn +FROM aws.connect.evaluation_forms +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the evaluation_forms resource, the following permissions are required: + +### Create +```json +connect:CreateEvaluationForm, +connect:ActivateEvaluationForm, +connect:TagResource +``` + +### List +```json +connect:ListEvaluationForms +``` + diff --git a/docs/aws-docs/providers/aws/connect/hours_of_operation/index.md b/docs/aws-docs/providers/aws/connect/hours_of_operation/index.md new file mode 100644 index 0000000000..4d12d28de8 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/hours_of_operation/index.md @@ -0,0 +1,102 @@ +--- +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
DescriptionResource Type definition for AWS::Connect::HoursOfOperation
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +instance_arn, +name, +description, +time_zone, +config, +hours_of_operation_arn, +tags +FROM aws.connect.hours_of_operation +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the hours_of_operation resource, the following permissions are required: + +### Read +```json +connect:DescribeHoursOfOperation +``` + +### Delete +```json +connect:DeleteHoursOfOperation, +connect:UntagResource +``` + +### Update +```json +connect:UpdateHoursOfOperation, +connect:TagResource, +connect:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/connect/hours_of_operations/index.md b/docs/aws-docs/providers/aws/connect/hours_of_operations/index.md new file mode 100644 index 0000000000..4a6c1790aa --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/hours_of_operations/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionResource Type definition for AWS::Connect::HoursOfOperation
Idaws.connect.hours_of_operations
+ +## Fields + + + + + +
NameDatatypeDescription
hours_of_operation_arnstringThe Amazon Resource Name (ARN) for the hours of operation.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +hours_of_operation_arn +FROM aws.connect.hours_of_operations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the hours_of_operations resource, the following permissions are required: + +### Create +```json +connect:CreateHoursOfOperation, +connect:TagResource +``` + +### List +```json +connect:ListHoursOfOperations +``` + diff --git a/docs/aws-docs/providers/aws/connect/index.md b/docs/aws-docs/providers/aws/connect/index.md new file mode 100644 index 0000000000..b65ec28b0d --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/connect/instance/index.md b/docs/aws-docs/providers/aws/connect/instance/index.md new file mode 100644 index 0000000000..65d80fafff --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/instance/index.md @@ -0,0 +1,117 @@ +--- +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
DescriptionResource Type definition for AWS::Connect::Instance
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +arn, +identity_management_type, +instance_alias, +created_time, +service_role, +instance_status, +directory_id, +attributes, +tags +FROM aws.connect.instance +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the instance resource, the following permissions are required: + +### Read +```json +connect:DescribeInstance, +connect:ListInstanceAttributes, +ds:DescribeDirectories +``` + +### Update +```json +connect:ListInstanceAttributes, +connect:UpdateInstanceAttribute, +iam:CreateServiceLinkedRole, +iam:PutRolePolicy, +connect:TagResource, +connect:UntagResource +``` + +### Delete +```json +connect:DeleteInstance, +connect:DescribeInstance, +connect:UntagResource, +ds:DeleteDirectory, +ds:UnauthorizeApplication, +ds:DescribeDirectories +``` + diff --git a/docs/aws-docs/providers/aws/connect/instance_storage_config/index.md b/docs/aws-docs/providers/aws/connect/instance_storage_config/index.md new file mode 100644 index 0000000000..9c55e74bf9 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/instance_storage_config/index.md @@ -0,0 +1,119 @@ +--- +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
DescriptionResource Type definition for AWS::Connect::InstanceStorageConfig
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.connect.instance_storage_config +WHERE data__Identifier = '||'; +``` + +## Permissions + +To operate on the instance_storage_config resource, the following permissions are required: + +### Read +```json +connect:DescribeInstanceStorageConfig, +connect:ListInstanceStorageConfigs, +connect:DescribeInstance, +ds:DescribeDirectories, +s3:GetBucketAcl, +s3:GetBucketLocation +``` + +### Update +```json +connect:UpdateInstanceStorageConfig, +ds:DescribeDirectories, +s3:GetBucketAcl, +s3:GetBucketLocation, +kinesis:DescribeStream, +iam:PutRolePolicy, +kms:DescribeKey, +kms:CreateGrant, +kms:RetireGrant, +firehose:DescribeDeliveryStream +``` + +### Delete +```json +connect:DisassociateInstanceStorageConfig, +connect:DescribeInstance, +s3:GetBucketAcl, +s3:GetBucketLocation, +kms:RetireGrant +``` + diff --git a/docs/aws-docs/providers/aws/connect/instance_storage_configs/index.md b/docs/aws-docs/providers/aws/connect/instance_storage_configs/index.md new file mode 100644 index 0000000000..55ba566a12 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/instance_storage_configs/index.md @@ -0,0 +1,92 @@ +--- +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
DescriptionResource Type definition for AWS::Connect::InstanceStorageConfig
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +instance_arn, +association_id, +resource_type +FROM aws.connect.instance_storage_configs +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the instance_storage_configs resource, the following permissions are required: + +### Create +```json +connect:AssociateInstanceStorageConfig, +connect:DescribeInstance, +ds:DescribeDirectories, +s3:GetBucketAcl, +s3:GetBucketLocation, +iam:PutRolePolicy, +kinesis:DescribeStream, +kms:DescribeKey, +kms:CreateGrant, +firehose:DescribeDeliveryStream +``` + +### List +```json +connect:DescribeInstance, +connect:ListInstanceStorageConfigs, +ds:DescribeDirectories +``` + diff --git a/docs/aws-docs/providers/aws/connect/instances/index.md b/docs/aws-docs/providers/aws/connect/instances/index.md new file mode 100644 index 0000000000..781662a0da --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/instances/index.md @@ -0,0 +1,92 @@ +--- +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
DescriptionResource Type definition for AWS::Connect::Instance
Idaws.connect.instances
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringAn instanceArn is automatically generated on creation based on instanceId.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.connect.instances +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the instances resource, the following permissions are required: + +### Create +```json +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 +```json +connect:ListInstances, +connect:ListInstanceAttributes, +ds:DescribeDirectories +``` + diff --git a/docs/aws-docs/providers/aws/connect/integration_association/index.md b/docs/aws-docs/providers/aws/connect/integration_association/index.md new file mode 100644 index 0000000000..0705e309c6 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/integration_association/index.md @@ -0,0 +1,108 @@ +--- +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
DescriptionResource Type definition for AWS::Connect::IntegrationAssociation
Idaws.connect.integration_association
+ +## Fields + + + + + + + + +
NameDatatypeDescription
integration_association_idstring
instance_idstring
integration_arnstring
integration_typestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +integration_association_id, +instance_id, +integration_arn, +integration_type +FROM aws.connect.integration_association +WHERE data__Identifier = '||'; +``` + +## Permissions + +To operate on the integration_association resource, the following permissions are required: + +### Read +```json +connect:ListBots, +connect:ListLambdaFunctions, +connect:ListIntegrationAssociations +``` + +### Delete +```json +connect:DescribeInstance, +ds:DescribeDirectories, +app-integrations:DeleteEventIntegrationAssociation, +app-integrations:DeleteApplicationAssociation, +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 +``` + diff --git a/docs/aws-docs/providers/aws/connect/integration_associations/index.md b/docs/aws-docs/providers/aws/connect/integration_associations/index.md new file mode 100644 index 0000000000..9e9b78f8eb --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/integration_associations/index.md @@ -0,0 +1,112 @@ +--- +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
DescriptionResource Type definition for AWS::Connect::IntegrationAssociation
Idaws.connect.integration_associations
+ +## Fields + + + + + + + +
NameDatatypeDescription
instance_idundefined
integration_typeundefined
integration_arnundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +instance_id, +integration_type, +integration_arn +FROM aws.connect.integration_associations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the integration_associations resource, the following permissions are required: + +### Create +```json +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, +app-integrations:CreateApplicationAssociation, +iam:AttachRolePolicy, +iam:CreateServiceLinkedRole, +iam:GetRolePolicy, +iam:PutRolePolicy +``` + +### List +```json +connect:ListBots, +connect:ListLambdaFunctions, +connect:ListIntegrationAssociations +``` + diff --git a/docs/aws-docs/providers/aws/connect/predefined_attribute/index.md b/docs/aws-docs/providers/aws/connect/predefined_attribute/index.md new file mode 100644 index 0000000000..efdced3187 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/predefined_attribute/index.md @@ -0,0 +1,95 @@ +--- +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
DescriptionResource Type definition for AWS::Connect::PredefinedAttribute
Idaws.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.
last_modified_regionstringLast modified region.
last_modified_timenumberLast modified time.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +instance_arn, +name, +values, +last_modified_region, +last_modified_time +FROM aws.connect.predefined_attribute +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the predefined_attribute resource, the following permissions are required: + +### Read +```json +connect:DescribePredefinedAttribute +``` + +### Delete +```json +connect:DeletePredefinedAttribute +``` + +### Update +```json +connect:UpdatePredefinedAttribute +``` + diff --git a/docs/aws-docs/providers/aws/connect/predefined_attributes/index.md b/docs/aws-docs/providers/aws/connect/predefined_attributes/index.md new file mode 100644 index 0000000000..0bc50f7387 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/predefined_attributes/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource Type definition for AWS::Connect::PredefinedAttribute
Idaws.connect.predefined_attributes
+ +## Fields + + + + + + +
NameDatatypeDescription
instance_arnstringThe identifier of the Amazon Connect instance.
namestringThe name of the predefined attribute.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +instance_arn, +name +FROM aws.connect.predefined_attributes +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the predefined_attributes resource, the following permissions are required: + +### Create +```json +connect:CreatePredefinedAttribute +``` + +### List +```json +connect:ListPredefinedAttributes +``` + diff --git a/docs/aws-docs/providers/aws/connect/prompt/index.md b/docs/aws-docs/providers/aws/connect/prompt/index.md new file mode 100644 index 0000000000..3876eddd7e --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/prompt/index.md @@ -0,0 +1,99 @@ +--- +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
DescriptionResource Type definition for AWS::Connect::Prompt
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +instance_arn, +name, +description, +s3_uri, +prompt_arn, +tags +FROM aws.connect.prompt +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the prompt resource, the following permissions are required: + +### Read +```json +connect:DescribePrompt +``` + +### Update +```json +connect:UpdatePrompt, +connect:TagResource, +connect:UntagResource +``` + +### Delete +```json +connect:DeletePrompt +``` + diff --git a/docs/aws-docs/providers/aws/connect/prompts/index.md b/docs/aws-docs/providers/aws/connect/prompts/index.md new file mode 100644 index 0000000000..5edf18a2f4 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/prompts/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionResource Type definition for AWS::Connect::Prompt
Idaws.connect.prompts
+ +## Fields + + + + + +
NameDatatypeDescription
prompt_arnstringThe Amazon Resource Name (ARN) for the prompt.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +prompt_arn +FROM aws.connect.prompts +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the prompts resource, the following permissions are required: + +### Create +```json +connect:CreatePrompt, +connect:TagResource, +s3:GetObject, +kms:Decrypt, +s3:GetObjectAcl +``` + +### List +```json +connect:ListPrompts +``` + diff --git a/docs/aws-docs/providers/aws/connect/queue/index.md b/docs/aws-docs/providers/aws/connect/queue/index.md new file mode 100644 index 0000000000..c411d05e7a --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/queue/index.md @@ -0,0 +1,117 @@ +--- +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
DescriptionResource Type definition for AWS::Connect::Queue
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.connect.queue +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the queue resource, the following permissions are required: + +### Read +```json +connect:DescribeQueue, +connect:ListQueueQuickConnects +``` + +### Delete +```json +connect:DeleteQueue, +connect:UntagResource +``` + +### Update +```json +connect:UpdateQueueHoursOfOperation, +connect:UpdateQueueMaxContacts, +connect:UpdateQueueName, +connect:UpdateQueueOutboundCallerConfig, +connect:UpdateQueueStatus, +connect:AssociateQueueQuickConnects, +connect:DisassociateQueueQuickConnects, +connect:TagResource, +connect:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/connect/queues/index.md b/docs/aws-docs/providers/aws/connect/queues/index.md new file mode 100644 index 0000000000..2ce5652854 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/queues/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource Type definition for AWS::Connect::Queue
Idaws.connect.queues
+ +## Fields + + + + + +
NameDatatypeDescription
queue_arnstringThe Amazon Resource Name (ARN) for the queue.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +queue_arn +FROM aws.connect.queues +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the queues resource, the following permissions are required: + +### Create +```json +connect:CreateQueue, +connect:TagResource +``` + +### List +```json +connect:ListQueues, +connect:ListQueueQuickConnects +``` + diff --git a/docs/aws-docs/providers/aws/connect/quick_connect/index.md b/docs/aws-docs/providers/aws/connect/quick_connect/index.md new file mode 100644 index 0000000000..34d4114026 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/quick_connect/index.md @@ -0,0 +1,103 @@ +--- +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
DescriptionResource Type definition for AWS::Connect::QuickConnect
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +instance_arn, +name, +description, +quick_connect_config, +quick_connect_arn, +tags, +quick_connect_type +FROM aws.connect.quick_connect +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the quick_connect resource, the following permissions are required: + +### Read +```json +connect:DescribeQuickConnect +``` + +### Delete +```json +connect:DeleteQuickConnect, +connect:UntagResource +``` + +### Update +```json +connect:UpdateQuickConnectName, +connect:UpdateQuickConnectConfig, +connect:TagResource, +connect:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/connect/quick_connects/index.md b/docs/aws-docs/providers/aws/connect/quick_connects/index.md new file mode 100644 index 0000000000..0eb7b6fdb1 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/quick_connects/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionResource Type definition for AWS::Connect::QuickConnect
Idaws.connect.quick_connects
+ +## Fields + + + + + +
NameDatatypeDescription
quick_connect_arnstringThe Amazon Resource Name (ARN) for the quick connect.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +quick_connect_arn +FROM aws.connect.quick_connects +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the quick_connects resource, the following permissions are required: + +### Create +```json +connect:CreateQuickConnect, +connect:TagResource +``` + +### List +```json +connect:ListQuickConnects +``` + diff --git a/docs/aws-docs/providers/aws/connect/routing_profile/index.md b/docs/aws-docs/providers/aws/connect/routing_profile/index.md new file mode 100644 index 0000000000..674c0f037d --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/routing_profile/index.md @@ -0,0 +1,114 @@ +--- +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
DescriptionResource Type definition for AWS::Connect::RoutingProfile
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +instance_arn, +name, +description, +media_concurrencies, +default_outbound_queue_arn, +routing_profile_arn, +queue_configs, +tags, +agent_availability_timer +FROM aws.connect.routing_profile +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the routing_profile resource, the following permissions are required: + +### Read +```json +connect:DescribeRoutingProfile, +connect:ListRoutingProfileQueues +``` + +### Delete +```json +connect:DeleteRoutingProfile, +connect:UntagResource +``` + +### Update +```json +connect:AssociateRoutingProfileQueues, +connect:DisassociateRoutingProfileQueues, +connect:UpdateRoutingProfileConcurrency, +connect:UpdateRoutingProfileName, +connect:UpdateRoutingProfileDefaultOutboundQueue, +connect:UpdateRoutingProfileQueues, +connect:TagResource, +connect:UntagResource, +connect:ListRoutingProfileQueues, +connect:UpdateRoutingProfileAgentAvailabilityTimer +``` + diff --git a/docs/aws-docs/providers/aws/connect/routing_profiles/index.md b/docs/aws-docs/providers/aws/connect/routing_profiles/index.md new file mode 100644 index 0000000000..f3cc0b0fd9 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/routing_profiles/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource Type definition for AWS::Connect::RoutingProfile
Idaws.connect.routing_profiles
+ +## Fields + + + + + +
NameDatatypeDescription
routing_profile_arnstringThe Amazon Resource Name (ARN) of the routing profile.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +routing_profile_arn +FROM aws.connect.routing_profiles +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the routing_profiles resource, the following permissions are required: + +### Create +```json +connect:CreateRoutingProfile, +connect:TagResource +``` + +### List +```json +connect:ListRoutingProfiles, +connect:ListRoutingProfileQueues +``` + diff --git a/docs/aws-docs/providers/aws/connect/rule/index.md b/docs/aws-docs/providers/aws/connect/rule/index.md new file mode 100644 index 0000000000..10044c470c --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/rule/index.md @@ -0,0 +1,107 @@ +--- +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
DescriptionResource Type definition for AWS:Connect::Rule
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +rule_arn, +instance_arn, +trigger_event_source, +function, +actions, +publish_status, +tags +FROM aws.connect.rule +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the rule resource, the following permissions are required: + +### Read +```json +connect:DescribeRule +``` + +### Delete +```json +connect:DeleteRule, +connect:UntagResource +``` + +### Update +```json +connect:UpdateRule, +cases:GetTemplate, +cases:ListFields, +cases:ListFieldOptions, +connect:TagResource, +connect:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/connect/rules/index.md b/docs/aws-docs/providers/aws/connect/rules/index.md new file mode 100644 index 0000000000..03cbad92ed --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/rules/index.md @@ -0,0 +1,70 @@ +--- +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
DescriptionResource Type definition for AWS:Connect::Rule
Idaws.connect.rules
+ +## Fields + + + + + +
NameDatatypeDescription
rule_arnstringThe Amazon Resource Name (ARN) of the rule.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +rule_arn +FROM aws.connect.rules +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the rules resource, the following permissions are required: + +### Create +```json +connect:CreateRule, +cases:GetTemplate, +cases:ListFields, +cases:ListFieldOptions +``` + diff --git a/docs/aws-docs/providers/aws/connect/security_key/index.md b/docs/aws-docs/providers/aws/connect/security_key/index.md new file mode 100644 index 0000000000..d99aa10288 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/security_key/index.md @@ -0,0 +1,86 @@ +--- +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
DescriptionResource Type definition for AWS::Connect::SecurityKey
Idaws.connect.security_key
+ +## Fields + + + + + + + +
NameDatatypeDescription
keystring
instance_idstring
association_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +key, +instance_id, +association_id +FROM aws.connect.security_key +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the security_key resource, the following permissions are required: + +### Read +```json +connect:ListSecurityKeys +``` + +### Delete +```json +connect:DisassociateSecurityKey +``` + diff --git a/docs/aws-docs/providers/aws/connect/security_keys/index.md b/docs/aws-docs/providers/aws/connect/security_keys/index.md new file mode 100644 index 0000000000..ca9457f000 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/security_keys/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource Type definition for AWS::Connect::SecurityKey
Idaws.connect.security_keys
+ +## Fields + + + + + + +
NameDatatypeDescription
instance_idundefined
association_idundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +instance_id, +association_id +FROM aws.connect.security_keys +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the security_keys resource, the following permissions are required: + +### Create +```json +connect:AssociateSecurityKey +``` + +### List +```json +connect:ListSecurityKeys +``` + diff --git a/docs/aws-docs/providers/aws/connect/security_profile/index.md b/docs/aws-docs/providers/aws/connect/security_profile/index.md new file mode 100644 index 0000000000..3b145c7049 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/security_profile/index.md @@ -0,0 +1,116 @@ +--- +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
DescriptionResource Type definition for AWS::Connect::SecurityProfile
Idaws.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.
hierarchy_restricted_resourcesarrayThe list of resources that a security profile applies hierarchy restrictions to in Amazon Connect.
allowed_access_control_hierarchy_group_idstringThe identifier of the hierarchy group that a security profile uses to restrict access to resources in Amazon Connect.
applicationsarrayA list of third-party applications that the security profile will give access to.
tagsarrayThe tags used to organize, track, or control access for this resource.
last_modified_regionstringThe AWS Region where this resource was last modified.
last_modified_timenumberThe timestamp when this resource was last modified.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +allowed_access_control_tags, +description, +instance_arn, +permissions, +security_profile_arn, +security_profile_name, +tag_restricted_resources, +hierarchy_restricted_resources, +allowed_access_control_hierarchy_group_id, +applications, +tags, +last_modified_region, +last_modified_time +FROM aws.connect.security_profile +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the security_profile resource, the following permissions are required: + +### Read +```json +connect:DescribeSecurityProfile, +connect:ListSecurityProfileApplications, +connect:ListSecurityProfilePermissions +``` + +### Update +```json +connect:TagResource, +connect:UpdateSecurityProfile, +connect:UntagResource +``` + +### Delete +```json +connect:DeleteSecurityProfile, +connect:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/connect/security_profiles/index.md b/docs/aws-docs/providers/aws/connect/security_profiles/index.md new file mode 100644 index 0000000000..e442b28ba7 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/security_profiles/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionResource Type definition for AWS::Connect::SecurityProfile
Idaws.connect.security_profiles
+ +## Fields + + + + + +
NameDatatypeDescription
security_profile_arnstringThe Amazon Resource Name (ARN) for the security profile.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +security_profile_arn +FROM aws.connect.security_profiles +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the security_profiles resource, the following permissions are required: + +### Create +```json +connect:CreateSecurityProfile, +connect:TagResource +``` + +### List +```json +connect:ListSecurityProfiles +``` + diff --git a/docs/aws-docs/providers/aws/connect/task_template/index.md b/docs/aws-docs/providers/aws/connect/task_template/index.md new file mode 100644 index 0000000000..632e3dbf6c --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/task_template/index.md @@ -0,0 +1,111 @@ +--- +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
DescriptionResource Type definition for AWS::Connect::TaskTemplate.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +instance_arn, +name, +description, +contact_flow_arn, +constraints, +defaults, +fields, +status, +client_token, +tags +FROM aws.connect.task_template +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the task_template resource, the following permissions are required: + +### Read +```json +connect:GetTaskTemplate +``` + +### Update +```json +connect:UpdateTaskTemplate, +connect:TagResource, +connect:UntagResource +``` + +### Delete +```json +connect:DeleteTaskTemplate, +connect:UntagResource, +connect:GetTaskTemplate +``` + diff --git a/docs/aws-docs/providers/aws/connect/task_templates/index.md b/docs/aws-docs/providers/aws/connect/task_templates/index.md new file mode 100644 index 0000000000..f70800d21e --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/task_templates/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionResource Type definition for AWS::Connect::TaskTemplate.
Idaws.connect.task_templates
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe identifier (arn) of the task template.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.connect.task_templates +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the task_templates resource, the following permissions are required: + +### Create +```json +connect:CreateTaskTemplate, +connect:TagResource +``` + +### List +```json +connect:ListTaskTemplates +``` + diff --git a/docs/aws-docs/providers/aws/connect/traffic_distribution_group/index.md b/docs/aws-docs/providers/aws/connect/traffic_distribution_group/index.md new file mode 100644 index 0000000000..a494ecaee6 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/traffic_distribution_group/index.md @@ -0,0 +1,102 @@ +--- +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
DescriptionResource Type definition for AWS::Connect::TrafficDistributionGroup
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +instance_arn, +traffic_distribution_group_arn, +description, +name, +status, +tags, +is_default +FROM aws.connect.traffic_distribution_group +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the traffic_distribution_group resource, the following permissions are required: + +### Read +```json +connect:DescribeTrafficDistributionGroup +``` + +### Update +```json +connect:TagResource, +connect:UntagResource +``` + +### Delete +```json +connect:DeleteTrafficDistributionGroup, +connect:DescribeTrafficDistributionGroup, +connect:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/connect/traffic_distribution_groups/index.md b/docs/aws-docs/providers/aws/connect/traffic_distribution_groups/index.md new file mode 100644 index 0000000000..ec7bf100bd --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/traffic_distribution_groups/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource Type definition for AWS::Connect::TrafficDistributionGroup
Idaws.connect.traffic_distribution_groups
+ +## Fields + + + + + +
NameDatatypeDescription
traffic_distribution_group_arnstringThe identifier of the traffic distribution group.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +traffic_distribution_group_arn +FROM aws.connect.traffic_distribution_groups +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the traffic_distribution_groups resource, the following permissions are required: + +### Create +```json +connect:CreateTrafficDistributionGroup, +connect:DescribeTrafficDistributionGroup, +connect:TagResource +``` + +### List +```json +connect:ListTrafficDistributionGroups +``` + diff --git a/docs/aws-docs/providers/aws/connect/user/index.md b/docs/aws-docs/providers/aws/connect/user/index.md new file mode 100644 index 0000000000..5e3e5d250f --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/user/index.md @@ -0,0 +1,120 @@ +--- +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
DescriptionResource Type definition for AWS::Connect::User
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.connect.user +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the user resource, the following permissions are required: + +### Read +```json +connect:DescribeUser, +connect:ListUserProficiencies +``` + +### Delete +```json +connect:DeleteUser, +connect:UntagResource +``` + +### Update +```json +connect:UpdateUserIdentityInfo, +connect:UpdateUserPhoneConfig, +connect:UpdateUserRoutingProfile, +connect:UpdateUserSecurityProfiles, +connect:UpdateUserHierarchy, +connect:TagResource, +connect:UntagResource, +connect:AssociateUserProficiencies, +connect:DisassociateUserProficiencies, +connect:UpdateUserProficiencies +``` + diff --git a/docs/aws-docs/providers/aws/connect/user_hierarchy_group/index.md b/docs/aws-docs/providers/aws/connect/user_hierarchy_group/index.md new file mode 100644 index 0000000000..77cd9388bd --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/user_hierarchy_group/index.md @@ -0,0 +1,98 @@ +--- +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
DescriptionResource Type definition for AWS::Connect::UserHierarchyGroup
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +instance_arn, +user_hierarchy_group_arn, +parent_group_arn, +name, +tags +FROM aws.connect.user_hierarchy_group +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the user_hierarchy_group resource, the following permissions are required: + +### Read +```json +connect:DescribeUserHierarchyGroup +``` + +### Delete +```json +connect:DeleteUserHierarchyGroup, +connect:UntagResource +``` + +### Update +```json +connect:UpdateUserHierarchyGroupName, +connect:TagResource, +connect:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/connect/user_hierarchy_groups/index.md b/docs/aws-docs/providers/aws/connect/user_hierarchy_groups/index.md new file mode 100644 index 0000000000..3ae308aa54 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/user_hierarchy_groups/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionResource Type definition for AWS::Connect::UserHierarchyGroup
Idaws.connect.user_hierarchy_groups
+ +## Fields + + + + + +
NameDatatypeDescription
user_hierarchy_group_arnundefinedThe Amazon Resource Name (ARN) for the user hierarchy group.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +user_hierarchy_group_arn +FROM aws.connect.user_hierarchy_groups +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the user_hierarchy_groups resource, the following permissions are required: + +### Create +```json +connect:CreateUserHierarchyGroup, +connect:TagResource +``` + +### List +```json +connect:ListUserHierarchyGroups +``` + diff --git a/docs/aws-docs/providers/aws/connect/users/index.md b/docs/aws-docs/providers/aws/connect/users/index.md new file mode 100644 index 0000000000..48c227c335 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/users/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource Type definition for AWS::Connect::User
Idaws.connect.users
+ +## Fields + + + + + +
NameDatatypeDescription
user_arnstringThe Amazon Resource Name (ARN) for the user.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +user_arn +FROM aws.connect.users +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the users resource, the following permissions are required: + +### Create +```json +connect:CreateUser, +connect:TagResource, +connect:AssociateUserProficiencies +``` + +### List +```json +connect:ListUsers +``` + diff --git a/docs/aws-docs/providers/aws/connect/view/index.md b/docs/aws-docs/providers/aws/connect/view/index.md new file mode 100644 index 0000000000..b6a000c96d --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/view/index.md @@ -0,0 +1,107 @@ +--- +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
DescriptionResource Type definition for AWS::Connect::View
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +instance_arn, +view_arn, +view_id, +name, +description, +template, +actions, +view_content_sha256, +tags +FROM aws.connect.view +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the view resource, the following permissions are required: + +### Read +```json +connect:DescribeView +``` + +### Delete +```json +connect:DeleteView, +connect:UntagResource +``` + +### Update +```json +connect:UpdateViewMetadata, +connect:UpdateViewContent, +connect:TagResource, +connect:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/connect/view_version/index.md b/docs/aws-docs/providers/aws/connect/view_version/index.md new file mode 100644 index 0000000000..eaeebc0cf3 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/view_version/index.md @@ -0,0 +1,90 @@ +--- +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
DescriptionResource Type definition for AWS::Connect::ViewVersion
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +view_arn, +view_version_arn, +version_description, +view_content_sha256, +version +FROM aws.connect.view_version +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the view_version resource, the following permissions are required: + +### Read +```json +connect:DescribeView +``` + +### Delete +```json +connect:DeleteViewVersion +``` + diff --git a/docs/aws-docs/providers/aws/connect/view_versions/index.md b/docs/aws-docs/providers/aws/connect/view_versions/index.md new file mode 100644 index 0000000000..6c30ef80d3 --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/view_versions/index.md @@ -0,0 +1,77 @@ +--- +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
DescriptionResource Type definition for AWS::Connect::ViewVersion
Idaws.connect.view_versions
+ +## Fields + + + + + +
NameDatatypeDescription
view_version_arnstringThe Amazon Resource Name (ARN) of the created view version.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +view_version_arn +FROM aws.connect.view_versions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the view_versions resource, the following permissions are required: + +### Create +```json +connect:CreateViewVersion +``` + +### List +```json +connect:ListViewVersions +``` + diff --git a/docs/aws-docs/providers/aws/connect/views/index.md b/docs/aws-docs/providers/aws/connect/views/index.md new file mode 100644 index 0000000000..12d83ac82f --- /dev/null +++ b/docs/aws-docs/providers/aws/connect/views/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionResource Type definition for AWS::Connect::View
Idaws.connect.views
+ +## Fields + + + + + +
NameDatatypeDescription
view_arnstringThe Amazon Resource Name (ARN) of the view.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +view_arn +FROM aws.connect.views +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the views resource, the following permissions are required: + +### Create +```json +connect:CreateView, +connect:TagResource +``` + +### List +```json +connect:ListViews +``` + diff --git a/docs/aws-docs/providers/aws/connectcampaigns/campaign/index.md b/docs/aws-docs/providers/aws/connectcampaigns/campaign/index.md new file mode 100644 index 0000000000..9dd04f091d --- /dev/null +++ b/docs/aws-docs/providers/aws/connectcampaigns/campaign/index.md @@ -0,0 +1,102 @@ +--- +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
DescriptionDefinition of AWS::ConnectCampaigns::Campaign Resource Type
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +connect_instance_arn, +dialer_config, +arn, +name, +outbound_call_config, +tags +FROM aws.connectcampaigns.campaign +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the campaign resource, the following permissions are required: + +### Read +```json +connect-campaigns:DescribeCampaign +``` + +### Delete +```json +connect-campaigns:DeleteCampaign +``` + +### Update +```json +connect-campaigns:UpdateCampaignDialerConfig, +connect-campaigns:UpdateCampaignName, +connect-campaigns:UpdateCampaignOutboundCallConfig, +connect-campaigns:TagResource, +connect-campaigns:UntagResource, +connect-campaigns:DescribeCampaign +``` + diff --git a/docs/aws-docs/providers/aws/connectcampaigns/campaigns/index.md b/docs/aws-docs/providers/aws/connectcampaigns/campaigns/index.md new file mode 100644 index 0000000000..0035e85edf --- /dev/null +++ b/docs/aws-docs/providers/aws/connectcampaigns/campaigns/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionDefinition of AWS::ConnectCampaigns::Campaign Resource Type
Idaws.connectcampaigns.campaigns
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringAmazon Connect Campaign Arn
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.connectcampaigns.campaigns +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the campaigns resource, the following permissions are required: + +### Create +```json +connect-campaigns:CreateCampaign, +connect-campaigns:DescribeCampaign, +connect-campaigns:TagResource, +connect:DescribeContactFlow, +connect:DescribeInstance, +connect:DescribeQueue +``` + +### List +```json +connect-campaigns:ListCampaigns +``` + diff --git a/docs/aws-docs/providers/aws/connectcampaigns/index.md b/docs/aws-docs/providers/aws/connectcampaigns/index.md new file mode 100644 index 0000000000..b05301706c --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/controltower/enabled_baseline/index.md b/docs/aws-docs/providers/aws/controltower/enabled_baseline/index.md new file mode 100644 index 0000000000..cf77829a8b --- /dev/null +++ b/docs/aws-docs/providers/aws/controltower/enabled_baseline/index.md @@ -0,0 +1,148 @@ +--- +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
DescriptionDefinition of AWS::ControlTower::EnabledBaseline Resource Type
Idaws.controltower.enabled_baseline
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
baseline_identifierstring
baseline_versionstring
enabled_baseline_identifierstring
target_identifierstring
parametersarray
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +baseline_identifier, +baseline_version, +enabled_baseline_identifier, +target_identifier, +parameters, +tags +FROM aws.controltower.enabled_baseline +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the enabled_baseline resource, the following permissions are required: + +### Read +```json +controltower:GetEnabledBaseline, +controltower:ListEnabledBaselines, +controltower:ListTagsForResource +``` + +### Update +```json +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 +```json +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 +``` + diff --git a/docs/aws-docs/providers/aws/controltower/enabled_baselines/index.md b/docs/aws-docs/providers/aws/controltower/enabled_baselines/index.md new file mode 100644 index 0000000000..b3b2bc80b8 --- /dev/null +++ b/docs/aws-docs/providers/aws/controltower/enabled_baselines/index.md @@ -0,0 +1,103 @@ +--- +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
DescriptionDefinition of AWS::ControlTower::EnabledBaseline Resource Type
Idaws.controltower.enabled_baselines
+ +## Fields + + + + + +
NameDatatypeDescription
enabled_baseline_identifierstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +enabled_baseline_identifier +FROM aws.controltower.enabled_baselines +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the enabled_baselines resource, the following permissions are required: + +### Create +```json +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 +```json +controltower:ListEnabledBaselines +``` + diff --git a/docs/aws-docs/providers/aws/controltower/enabled_control/index.md b/docs/aws-docs/providers/aws/controltower/enabled_control/index.md new file mode 100644 index 0000000000..5ed7c6b09d --- /dev/null +++ b/docs/aws-docs/providers/aws/controltower/enabled_control/index.md @@ -0,0 +1,116 @@ +--- +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
DescriptionEnables a control on a specified target.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +control_identifier, +target_identifier, +parameters, +tags +FROM aws.controltower.enabled_control +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the enabled_control resource, the following permissions are required: + +### Update +```json +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 +```json +controltower:GetControlOperation, +controltower:DisableControl, +organizations:UpdatePolicy, +organizations:DeletePolicy, +organizations:CreatePolicy, +organizations:AttachPolicy, +organizations:DetachPolicy, +organizations:ListPoliciesForTarget, +organizations:ListTargetsForPolicy, +organizations:DescribePolicy +``` + +### Read +```json +controltower:ListEnabledControls, +controltower:GetEnabledControl, +controltower:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/controltower/enabled_controls/index.md b/docs/aws-docs/providers/aws/controltower/enabled_controls/index.md new file mode 100644 index 0000000000..efbf056cdd --- /dev/null +++ b/docs/aws-docs/providers/aws/controltower/enabled_controls/index.md @@ -0,0 +1,90 @@ +--- +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
DescriptionEnables a control on a specified target.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +target_identifier, +control_identifier +FROM aws.controltower.enabled_controls +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the enabled_controls resource, the following permissions are required: + +### Create +```json +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 +```json +controltower:ListEnabledControls +``` + diff --git a/docs/aws-docs/providers/aws/controltower/index.md b/docs/aws-docs/providers/aws/controltower/index.md new file mode 100644 index 0000000000..ead64a0f6a --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/controltower/landing_zone/index.md b/docs/aws-docs/providers/aws/controltower/landing_zone/index.md new file mode 100644 index 0000000000..d8b9b23f82 --- /dev/null +++ b/docs/aws-docs/providers/aws/controltower/landing_zone/index.md @@ -0,0 +1,154 @@ +--- +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
DescriptionDefinition of AWS::ControlTower::LandingZone Resource Type
Idaws.controltower.landing_zone
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
landing_zone_identifierstring
arnstring
statusstring
latest_available_versionstring
drift_statusstring
manifestundefined
versionstring
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +landing_zone_identifier, +arn, +status, +latest_available_version, +drift_status, +manifest, +version, +tags +FROM aws.controltower.landing_zone +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the landing_zone resource, the following permissions are required: + +### Read +```json +controltower:GetLandingZone, +controltower:ListTagsForResource +``` + +### Update +```json +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 +```json +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 +``` + diff --git a/docs/aws-docs/providers/aws/controltower/landing_zones/index.md b/docs/aws-docs/providers/aws/controltower/landing_zones/index.md new file mode 100644 index 0000000000..7b5aab885c --- /dev/null +++ b/docs/aws-docs/providers/aws/controltower/landing_zones/index.md @@ -0,0 +1,107 @@ +--- +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
DescriptionDefinition of AWS::ControlTower::LandingZone Resource Type
Idaws.controltower.landing_zones
+ +## Fields + + + + + +
NameDatatypeDescription
landing_zone_identifierstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +landing_zone_identifier +FROM aws.controltower.landing_zones +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the landing_zones resource, the following permissions are required: + +### Create +```json +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 +```json +controltower:ListLandingZones +``` + diff --git a/docs/aws-docs/providers/aws/cur/index.md b/docs/aws-docs/providers/aws/cur/index.md new file mode 100644 index 0000000000..591fdf262d --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/cur/report_definition/index.md b/docs/aws-docs/providers/aws/cur/report_definition/index.md new file mode 100644 index 0000000000..58bcf25bb9 --- /dev/null +++ b/docs/aws-docs/providers/aws/cur/report_definition/index.md @@ -0,0 +1,111 @@ +--- +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
DescriptionThe AWS::CUR::ReportDefinition resource creates a Cost & Usage Report with user-defined settings. You can use this resource to define settings like time granularity (hourly, daily, monthly), file format (Parquet, CSV), and S3 bucket for delivery of these reports.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.cur.report_definition +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the report_definition resource, the following permissions are required: + +### Read +```json +cur:DescribeReportDefinitions +``` + +### Update +```json +cur:DescribeReportDefinitions, +cur:ModifyReportDefinition +``` + +### Delete +```json +cur:DescribeReportDefinitions, +cur:DeleteReportDefinition +``` + diff --git a/docs/aws-docs/providers/aws/cur/report_definitions/index.md b/docs/aws-docs/providers/aws/cur/report_definitions/index.md new file mode 100644 index 0000000000..5c8964c42c --- /dev/null +++ b/docs/aws-docs/providers/aws/cur/report_definitions/index.md @@ -0,0 +1,77 @@ +--- +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
DescriptionThe AWS::CUR::ReportDefinition resource creates a Cost & Usage Report with user-defined settings. You can use this resource to define settings like time granularity (hourly, daily, monthly), file format (Parquet, CSV), and S3 bucket for delivery of these reports.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +report_name +FROM aws.cur.report_definitions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the report_definitions resource, the following permissions are required: + +### Create +```json +cur:PutReportDefinition +``` + +### List +```json +cur:DescribeReportDefinitions +``` + diff --git a/docs/aws-docs/providers/aws/customerprofiles/calculated_attribute_definition/index.md b/docs/aws-docs/providers/aws/customerprofiles/calculated_attribute_definition/index.md new file mode 100644 index 0000000000..7a795cc389 --- /dev/null +++ b/docs/aws-docs/providers/aws/customerprofiles/calculated_attribute_definition/index.md @@ -0,0 +1,108 @@ +--- +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
DescriptionA calculated attribute definition for Customer Profiles
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +domain_name, +calculated_attribute_name, +display_name, +description, +attribute_details, +conditions, +statistic, +created_at, +last_updated_at, +tags +FROM aws.customerprofiles.calculated_attribute_definition +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the calculated_attribute_definition resource, the following permissions are required: + +### Read +```json +profile:GetCalculatedAttributeDefinition +``` + +### Update +```json +profile:GetCalculatedAttributeDefinition, +profile:UpdateCalculatedAttributeDefinition, +profile:UntagResource, +profile:TagResource +``` + +### Delete +```json +profile:DeleteCalculatedAttributeDefinition +``` + diff --git a/docs/aws-docs/providers/aws/customerprofiles/calculated_attribute_definitions/index.md b/docs/aws-docs/providers/aws/customerprofiles/calculated_attribute_definitions/index.md new file mode 100644 index 0000000000..01080c2b38 --- /dev/null +++ b/docs/aws-docs/providers/aws/customerprofiles/calculated_attribute_definitions/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionA calculated attribute definition for Customer Profiles
Idaws.customerprofiles.calculated_attribute_definitions
+ +## Fields + + + + + + +
NameDatatypeDescription
domain_nameundefined
calculated_attribute_nameundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +domain_name, +calculated_attribute_name +FROM aws.customerprofiles.calculated_attribute_definitions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the calculated_attribute_definitions resource, the following permissions are required: + +### Create +```json +profile:CreateCalculatedAttributeDefinition, +profile:TagResource +``` + +### List +```json +profile:ListCalculatedAttributeDefinitions +``` + diff --git a/docs/aws-docs/providers/aws/customerprofiles/domain/index.md b/docs/aws-docs/providers/aws/customerprofiles/domain/index.md new file mode 100644 index 0000000000..e1077bb419 --- /dev/null +++ b/docs/aws-docs/providers/aws/customerprofiles/domain/index.md @@ -0,0 +1,108 @@ +--- +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
DescriptionA domain defined for 3rd party data source in Profile Service
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.customerprofiles.domain +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the domain resource, the following permissions are required: + +### Read +```json +profile:GetDomain +``` + +### Update +```json +profile:GetDomain, +profile:UpdateDomain, +profile:UntagResource, +profile:TagResource +``` + +### Delete +```json +profile:DeleteDomain +``` + diff --git a/docs/aws-docs/providers/aws/customerprofiles/domains/index.md b/docs/aws-docs/providers/aws/customerprofiles/domains/index.md new file mode 100644 index 0000000000..0483dc2fe8 --- /dev/null +++ b/docs/aws-docs/providers/aws/customerprofiles/domains/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionA domain defined for 3rd party data source in Profile Service
Idaws.customerprofiles.domains
+ +## Fields + + + + + +
NameDatatypeDescription
domain_namestringThe unique name of the domain.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +domain_name +FROM aws.customerprofiles.domains +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the domains resource, the following permissions are required: + +### Create +```json +profile:CreateDomain, +profile:TagResource +``` + +### List +```json +profile:ListDomains +``` + diff --git a/docs/aws-docs/providers/aws/customerprofiles/event_stream/index.md b/docs/aws-docs/providers/aws/customerprofiles/event_stream/index.md new file mode 100644 index 0000000000..82844a0fae --- /dev/null +++ b/docs/aws-docs/providers/aws/customerprofiles/event_stream/index.md @@ -0,0 +1,106 @@ +--- +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
DescriptionAn Event Stream resource of Amazon Connect Customer Profiles
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +domain_name, +event_stream_name, +uri, +event_stream_arn, +tags, +created_at, +state, +destination_details +FROM aws.customerprofiles.event_stream +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the event_stream resource, the following permissions are required: + +### Read +```json +profile:GetEventStream, +kinesis:DescribeStreamSummary +``` + +### Update +```json +kinesis:DescribeStreamSummary, +profile:GetEventStream, +profile:UntagResource, +profile:TagResource +``` + +### Delete +```json +profile:DeleteEventStream, +iam:DeleteRolePolicy +``` + diff --git a/docs/aws-docs/providers/aws/customerprofiles/event_streams/index.md b/docs/aws-docs/providers/aws/customerprofiles/event_streams/index.md new file mode 100644 index 0000000000..b0f8fa54a9 --- /dev/null +++ b/docs/aws-docs/providers/aws/customerprofiles/event_streams/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionAn Event Stream resource of Amazon Connect Customer Profiles
Idaws.customerprofiles.event_streams
+ +## Fields + + + + + + +
NameDatatypeDescription
domain_namestringThe unique name of the domain.
event_stream_namestringThe name of the event stream.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +domain_name, +event_stream_name +FROM aws.customerprofiles.event_streams +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the event_streams resource, the following permissions are required: + +### Create +```json +profile:CreateEventStream, +iam:PutRolePolicy, +kinesis:DescribeStreamSummary, +profile:TagResource +``` + +### List +```json +profile:ListEventStreams +``` + diff --git a/docs/aws-docs/providers/aws/customerprofiles/index.md b/docs/aws-docs/providers/aws/customerprofiles/index.md new file mode 100644 index 0000000000..3753dbd824 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/customerprofiles/integration/index.md b/docs/aws-docs/providers/aws/customerprofiles/integration/index.md new file mode 100644 index 0000000000..fffe13b98c --- /dev/null +++ b/docs/aws-docs/providers/aws/customerprofiles/integration/index.md @@ -0,0 +1,121 @@ +--- +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
DescriptionThe resource schema for creating an Amazon Connect Customer Profiles Integration.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +domain_name, +uri, +flow_definition, +object_type_name, +created_at, +last_updated_at, +tags, +object_type_names +FROM aws.customerprofiles.integration +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the integration resource, the following permissions are required: + +### Read +```json +profile:GetIntegration +``` + +### Delete +```json +profile:DeleteIntegration, +appflow:DeleteFlow, +app-integrations:ListEventIntegrationAssociations, +app-integrations:DeleteEventIntegrationAssociation, +events:RemoveTargets, +events:ListTargetsByRule, +events:DeleteRule +``` + +### Update +```json +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 +``` + diff --git a/docs/aws-docs/providers/aws/customerprofiles/integrations/index.md b/docs/aws-docs/providers/aws/customerprofiles/integrations/index.md new file mode 100644 index 0000000000..d0ccb2cb53 --- /dev/null +++ b/docs/aws-docs/providers/aws/customerprofiles/integrations/index.md @@ -0,0 +1,88 @@ +--- +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
DescriptionThe resource schema for creating an Amazon Connect Customer Profiles Integration.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +domain_name, +uri +FROM aws.customerprofiles.integrations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the integrations resource, the following permissions are required: + +### Create +```json +profile:GetIntegration, +profile:PutIntegration, +appflow:CreateFlow, +app-integrations:CreateEventIntegrationAssociation, +app-integrations:GetEventIntegration, +events:ListTargetsByRule, +events:PutRule, +events:PutTargets, +events:PutEvents, +profile:TagResource +``` + +### List +```json +profile:ListIntegrations +``` + diff --git a/docs/aws-docs/providers/aws/customerprofiles/object_type/index.md b/docs/aws-docs/providers/aws/customerprofiles/object_type/index.md new file mode 100644 index 0000000000..ef90a90748 --- /dev/null +++ b/docs/aws-docs/providers/aws/customerprofiles/object_type/index.md @@ -0,0 +1,114 @@ +--- +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
DescriptionAn ObjectType resource of Amazon Connect Customer Profiles
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.customerprofiles.object_type +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the object_type resource, the following permissions are required: + +### Read +```json +profile:GetProfileObjectType +``` + +### Update +```json +profile:GetProfileObjectType, +profile:PutProfileObjectType, +profile:UntagResource, +profile:TagResource +``` + +### Delete +```json +profile:DeleteProfileObjectType +``` + diff --git a/docs/aws-docs/providers/aws/customerprofiles/object_types/index.md b/docs/aws-docs/providers/aws/customerprofiles/object_types/index.md new file mode 100644 index 0000000000..2ad5b3ee7f --- /dev/null +++ b/docs/aws-docs/providers/aws/customerprofiles/object_types/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionAn ObjectType resource of Amazon Connect Customer Profiles
Idaws.customerprofiles.object_types
+ +## Fields + + + + + + +
NameDatatypeDescription
domain_namestringThe unique name of the domain.
object_type_namestringThe name of the profile object type.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +domain_name, +object_type_name +FROM aws.customerprofiles.object_types +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the object_types resource, the following permissions are required: + +### Create +```json +profile:GetProfileObjectType, +profile:PutProfileObjectType, +profile:TagResource +``` + +### List +```json +profile:ListProfileObjectTypes +``` + diff --git a/docs/aws-docs/providers/aws/databrew/dataset/index.md b/docs/aws-docs/providers/aws/databrew/dataset/index.md new file mode 100644 index 0000000000..bbea11c04b --- /dev/null +++ b/docs/aws-docs/providers/aws/databrew/dataset/index.md @@ -0,0 +1,101 @@ +--- +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
DescriptionResource schema for AWS::DataBrew::Dataset.
Idaws.databrew.dataset
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
namestringDataset name
formatstringDataset format
format_optionsobjectFormat options for dataset
inputobjectInput
path_optionsobjectPathOptions
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +format, +format_options, +input, +path_options, +tags +FROM aws.databrew.dataset +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the dataset resource, the following permissions are required: + +### Read +```json +databrew:DescribeDataset, +databrew:ListTagsForResource, +iam:ListRoles +``` + +### Update +```json +databrew:UpdateDataset, +glue:GetConnection, +glue:GetTable +``` + +### Delete +```json +databrew:DeleteDataset +``` + diff --git a/docs/aws-docs/providers/aws/databrew/datasets/index.md b/docs/aws-docs/providers/aws/databrew/datasets/index.md new file mode 100644 index 0000000000..ee3096b97b --- /dev/null +++ b/docs/aws-docs/providers/aws/databrew/datasets/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionResource schema for AWS::DataBrew::Dataset.
Idaws.databrew.datasets
+ +## Fields + + + + + +
NameDatatypeDescription
namestringDataset name
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.databrew.datasets +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the datasets resource, the following permissions are required: + +### Create +```json +databrew:CreateDataset, +databrew:TagResource, +databrew:UntagResource, +glue:GetConnection, +glue:GetTable, +iam:PassRole +``` + +### List +```json +databrew:ListDatasets, +databrew:ListTagsForResource, +iam:ListRoles +``` + diff --git a/docs/aws-docs/providers/aws/databrew/index.md b/docs/aws-docs/providers/aws/databrew/index.md new file mode 100644 index 0000000000..6e9d105530 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/databrew/job/index.md b/docs/aws-docs/providers/aws/databrew/job/index.md new file mode 100644 index 0000000000..b0fbad8801 --- /dev/null +++ b/docs/aws-docs/providers/aws/databrew/job/index.md @@ -0,0 +1,129 @@ +--- +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
DescriptionResource schema for AWS::DataBrew::Job.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.databrew.job +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the job resource, the following permissions are required: + +### Read +```json +databrew:DescribeJob, +databrew:ListTagsForResource, +iam:ListRoles +``` + +### Update +```json +databrew:UpdateProfileJob, +databrew:UpdateRecipeJob, +iam:PassRole +``` + +### Delete +```json +databrew:DeleteJob +``` + diff --git a/docs/aws-docs/providers/aws/databrew/jobs/index.md b/docs/aws-docs/providers/aws/databrew/jobs/index.md new file mode 100644 index 0000000000..c6712a974e --- /dev/null +++ b/docs/aws-docs/providers/aws/databrew/jobs/index.md @@ -0,0 +1,83 @@ +--- +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
DescriptionResource schema for AWS::DataBrew::Job.
Idaws.databrew.jobs
+ +## Fields + + + + + +
NameDatatypeDescription
namestringJob name
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.databrew.jobs +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the jobs resource, the following permissions are required: + +### Create +```json +databrew:CreateProfileJob, +databrew:CreateRecipeJob, +databrew:TagResource, +databrew:UntagResource, +iam:PassRole +``` + +### List +```json +databrew:ListJobs, +databrew:ListTagsForResource, +iam:ListRoles +``` + diff --git a/docs/aws-docs/providers/aws/databrew/project/index.md b/docs/aws-docs/providers/aws/databrew/project/index.md new file mode 100644 index 0000000000..dd4e2a1513 --- /dev/null +++ b/docs/aws-docs/providers/aws/databrew/project/index.md @@ -0,0 +1,100 @@ +--- +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
DescriptionResource schema for AWS::DataBrew::Project.
Idaws.databrew.project
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
dataset_namestringDataset name
namestringProject name
recipe_namestringRecipe name
role_arnstringRole arn
sampleobjectSample
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +dataset_name, +name, +recipe_name, +role_arn, +sample, +tags +FROM aws.databrew.project +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the project resource, the following permissions are required: + +### Read +```json +databrew:DescribeProject, +databrew:ListTagsForResource, +iam:ListRoles +``` + +### Update +```json +databrew:UpdateProject, +iam:PassRole +``` + +### Delete +```json +databrew:DeleteProject +``` + diff --git a/docs/aws-docs/providers/aws/databrew/projects/index.md b/docs/aws-docs/providers/aws/databrew/projects/index.md new file mode 100644 index 0000000000..7162dcd093 --- /dev/null +++ b/docs/aws-docs/providers/aws/databrew/projects/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionResource schema for AWS::DataBrew::Project.
Idaws.databrew.projects
+ +## Fields + + + + + +
NameDatatypeDescription
namestringProject name
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.databrew.projects +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the projects resource, the following permissions are required: + +### Create +```json +databrew:CreateProject, +databrew:TagResource, +databrew:UntagResource, +iam:PassRole +``` + +### List +```json +databrew:ListProjects, +databrew:ListTagsForResource, +iam:ListRoles +``` + diff --git a/docs/aws-docs/providers/aws/databrew/recipe/index.md b/docs/aws-docs/providers/aws/databrew/recipe/index.md new file mode 100644 index 0000000000..cccb45e757 --- /dev/null +++ b/docs/aws-docs/providers/aws/databrew/recipe/index.md @@ -0,0 +1,95 @@ +--- +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
DescriptionResource schema for AWS::DataBrew::Recipe.
Idaws.databrew.recipe
+ +## Fields + + + + + + + + +
NameDatatypeDescription
descriptionstringDescription of the recipe
namestringRecipe name
stepsarray
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +description, +name, +steps, +tags +FROM aws.databrew.recipe +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the recipe resource, the following permissions are required: + +### Read +```json +databrew:DescribeRecipe, +databrew:ListTagsForResource, +iam:ListRoles +``` + +### Delete +```json +databrew:DeleteRecipeVersion +``` + +### Update +```json +databrew:UpdateRecipe +``` + diff --git a/docs/aws-docs/providers/aws/databrew/recipes/index.md b/docs/aws-docs/providers/aws/databrew/recipes/index.md new file mode 100644 index 0000000000..6490b3606b --- /dev/null +++ b/docs/aws-docs/providers/aws/databrew/recipes/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionResource schema for AWS::DataBrew::Recipe.
Idaws.databrew.recipes
+ +## Fields + + + + + +
NameDatatypeDescription
namestringRecipe name
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.databrew.recipes +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the recipes resource, the following permissions are required: + +### Create +```json +databrew:CreateRecipe, +databrew:TagResource, +databrew:UntagResource, +iam:PassRole +``` + +### List +```json +databrew:ListRecipes, +databrew:ListTagsForResource, +iam:ListRoles +``` + diff --git a/docs/aws-docs/providers/aws/databrew/ruleset/index.md b/docs/aws-docs/providers/aws/databrew/ruleset/index.md new file mode 100644 index 0000000000..b15f4553eb --- /dev/null +++ b/docs/aws-docs/providers/aws/databrew/ruleset/index.md @@ -0,0 +1,97 @@ +--- +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
DescriptionResource schema for AWS::DataBrew::Ruleset.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +description, +target_arn, +rules, +tags +FROM aws.databrew.ruleset +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the ruleset resource, the following permissions are required: + +### Read +```json +databrew:DescribeRuleset, +databrew:ListTagsForResource, +iam:ListRoles +``` + +### Update +```json +databrew:UpdateRuleset +``` + +### Delete +```json +databrew:DeleteRuleset +``` + diff --git a/docs/aws-docs/providers/aws/databrew/rulesets/index.md b/docs/aws-docs/providers/aws/databrew/rulesets/index.md new file mode 100644 index 0000000000..5a8f90398e --- /dev/null +++ b/docs/aws-docs/providers/aws/databrew/rulesets/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionResource schema for AWS::DataBrew::Ruleset.
Idaws.databrew.rulesets
+ +## Fields + + + + + +
NameDatatypeDescription
namestringName of the Ruleset
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.databrew.rulesets +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the rulesets resource, the following permissions are required: + +### Create +```json +databrew:CreateRuleset, +databrew:TagResource, +databrew:UntagResource, +iam:PassRole +``` + +### List +```json +databrew:ListRulesets, +databrew:ListTagsForResource, +iam:ListRoles +``` + diff --git a/docs/aws-docs/providers/aws/databrew/schedule/index.md b/docs/aws-docs/providers/aws/databrew/schedule/index.md new file mode 100644 index 0000000000..4fb71332cf --- /dev/null +++ b/docs/aws-docs/providers/aws/databrew/schedule/index.md @@ -0,0 +1,95 @@ +--- +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
DescriptionResource schema for AWS::DataBrew::Schedule.
Idaws.databrew.schedule
+ +## Fields + + + + + + + + +
NameDatatypeDescription
job_namesarray
cron_expressionstringSchedule cron
namestringSchedule Name
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +job_names, +cron_expression, +name, +tags +FROM aws.databrew.schedule +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the schedule resource, the following permissions are required: + +### Read +```json +databrew:DescribeSchedule, +databrew:ListTagsForResource, +iam:ListRoles +``` + +### Update +```json +databrew:UpdateSchedule +``` + +### Delete +```json +databrew:DeleteSchedule +``` + diff --git a/docs/aws-docs/providers/aws/databrew/schedules/index.md b/docs/aws-docs/providers/aws/databrew/schedules/index.md new file mode 100644 index 0000000000..0ba1390f3f --- /dev/null +++ b/docs/aws-docs/providers/aws/databrew/schedules/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionResource schema for AWS::DataBrew::Schedule.
Idaws.databrew.schedules
+ +## Fields + + + + + +
NameDatatypeDescription
namestringSchedule Name
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.databrew.schedules +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the schedules resource, the following permissions are required: + +### Create +```json +databrew:CreateSchedule, +databrew:TagResource, +databrew:UntagResource, +iam:PassRole +``` + +### List +```json +databrew:ListSchedules, +databrew:ListTagsForResource, +iam:ListRoles +``` + diff --git a/docs/aws-docs/providers/aws/datapipeline/index.md b/docs/aws-docs/providers/aws/datapipeline/index.md new file mode 100644 index 0000000000..259b13c7ad --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/datapipeline/pipeline/index.md b/docs/aws-docs/providers/aws/datapipeline/pipeline/index.md new file mode 100644 index 0000000000..f3a50d5206 --- /dev/null +++ b/docs/aws-docs/providers/aws/datapipeline/pipeline/index.md @@ -0,0 +1,115 @@ +--- +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
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +activate, +description, +name, +parameter_objects, +parameter_values, +pipeline_objects, +pipeline_tags, +pipeline_id +FROM aws.datapipeline.pipeline +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the pipeline resource, the following permissions are required: + +### Read +```json +datapipeline:GetPipelineDefinition, +datapipeline:DescribePipelines +``` + +### Update +```json +datapipeline:PutPipelineDefinition, +datapipeline:AddTags, +datapipeline:RemoveTags, +datapipeline:DeactivatePipeline, +datapipeline:GetPipelineDefinition, +datapipeline:ActivatePipeline, +datapipeline:ValidatePipelineDefinition, +datapipeline:DescribePipelines, +datapipeline:AddTags, +datapipeline:RemoveTags, +iam:PassRole +``` + +### Delete +```json +datapipeline:DeletePipeline, +datapipeline:DescribePipelines, +datapipeline:GetPipelineDefinition, +datapipeline:RemoveTags +``` + diff --git a/docs/aws-docs/providers/aws/datapipeline/pipelines/index.md b/docs/aws-docs/providers/aws/datapipeline/pipelines/index.md new file mode 100644 index 0000000000..c977b9136b --- /dev/null +++ b/docs/aws-docs/providers/aws/datapipeline/pipelines/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Idaws.datapipeline.pipelines
+ +## Fields + + + + + +
NameDatatypeDescription
pipeline_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +pipeline_id +FROM aws.datapipeline.pipelines +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the pipelines resource, the following permissions are required: + +### Create +```json +datapipeline:CreatePipeline, +datapipeline:PutPipelineDefinition, +datapipeline:GetPipelineDefinition, +datapipeline:DescribePipelines, +datapipeline:ValidatePipelineDefinition, +datapipeline:ActivatePipeline, +datapipeline:AddTags, +iam:PassRole +``` + +### List +```json +datapipeline:ListPipelines +``` + diff --git a/docs/aws-docs/providers/aws/datasync/agent/index.md b/docs/aws-docs/providers/aws/datasync/agent/index.md new file mode 100644 index 0000000000..b2d11979e9 --- /dev/null +++ b/docs/aws-docs/providers/aws/datasync/agent/index.md @@ -0,0 +1,106 @@ +--- +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
DescriptionResource schema for AWS::DataSync::Agent.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +agent_name, +activation_key, +security_group_arns, +subnet_arns, +vpc_endpoint_id, +endpoint_type, +tags, +agent_arn +FROM aws.datasync.agent +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the agent resource, the following permissions are required: + +### Read +```json +datasync:DescribeAgent, +datasync:ListTagsForResource +``` + +### Update +```json +datasync:UpdateAgent, +datasync:DescribeAgent, +datasync:ListTagsForResource, +datasync:TagResource, +datasync:UntagResource +``` + +### Delete +```json +datasync:DeleteAgent +``` + diff --git a/docs/aws-docs/providers/aws/datasync/agents/index.md b/docs/aws-docs/providers/aws/datasync/agents/index.md new file mode 100644 index 0000000000..1fdb4f1f7e --- /dev/null +++ b/docs/aws-docs/providers/aws/datasync/agents/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionResource schema for AWS::DataSync::Agent.
Idaws.datasync.agents
+ +## Fields + + + + + +
NameDatatypeDescription
agent_arnstringThe DataSync Agent ARN.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +agent_arn +FROM aws.datasync.agents +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the agents resource, the following permissions are required: + +### Create +```json +datasync:CreateAgent, +datasync:TagResource, +datasync:DescribeAgent, +datasync:ListTagsForResource, +ec2:DescribeNetworkInterfaces, +ec2:DescribeSecurityGroups, +ec2:DescribeSubnets, +ec2:DescribeVpcEndpoints +``` + +### List +```json +datasync:ListAgents +``` + diff --git a/docs/aws-docs/providers/aws/datasync/index.md b/docs/aws-docs/providers/aws/datasync/index.md new file mode 100644 index 0000000000..6b4751bd1e --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/datasync/location_azure_blob/index.md b/docs/aws-docs/providers/aws/datasync/location_azure_blob/index.md new file mode 100644 index 0000000000..fc6d9ec65a --- /dev/null +++ b/docs/aws-docs/providers/aws/datasync/location_azure_blob/index.md @@ -0,0 +1,110 @@ +--- +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
DescriptionResource schema for AWS::DataSync::LocationAzureBlob.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.datasync.location_azure_blob +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the location_azure_blob resource, the following permissions are required: + +### Read +```json +datasync:DescribeLocationAzureBlob, +datasync:ListTagsForResource +``` + +### Update +```json +datasync:DescribeLocationAzureBlob, +datasync:ListTagsForResource, +datasync:TagResource, +datasync:UntagResource, +datasync:UpdateLocationAzureBlob +``` + +### Delete +```json +datasync:DeleteLocation +``` + diff --git a/docs/aws-docs/providers/aws/datasync/location_azure_blobs/index.md b/docs/aws-docs/providers/aws/datasync/location_azure_blobs/index.md new file mode 100644 index 0000000000..d46e5cb7d0 --- /dev/null +++ b/docs/aws-docs/providers/aws/datasync/location_azure_blobs/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionResource schema for AWS::DataSync::LocationAzureBlob.
Idaws.datasync.location_azure_blobs
+ +## Fields + + + + + +
NameDatatypeDescription
location_arnstringThe Amazon Resource Name (ARN) of the Azure Blob Location that is created.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +location_arn +FROM aws.datasync.location_azure_blobs +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the location_azure_blobs resource, the following permissions are required: + +### Create +```json +datasync:CreateLocationAzureBlob, +datasync:DescribeLocationAzureBlob, +datasync:TagResource, +datasync:ListTagsForResource +``` + +### List +```json +datasync:ListLocations +``` + diff --git a/docs/aws-docs/providers/aws/datasync/location_efs/index.md b/docs/aws-docs/providers/aws/datasync/location_efs/index.md new file mode 100644 index 0000000000..fa29f4d53b --- /dev/null +++ b/docs/aws-docs/providers/aws/datasync/location_efs/index.md @@ -0,0 +1,107 @@ +--- +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
DescriptionResource schema for AWS::DataSync::LocationEFS.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.datasync.location_efs +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the location_efs resource, the following permissions are required: + +### Read +```json +datasync:DescribeLocationEfs, +datasync:ListTagsForResource +``` + +### Update +```json +datasync:DescribeLocationEfs, +datasync:ListTagsForResource, +datasync:TagResource, +datasync:UntagResource +``` + +### Delete +```json +datasync:DeleteLocation +``` + diff --git a/docs/aws-docs/providers/aws/datasync/location_hdfs/index.md b/docs/aws-docs/providers/aws/datasync/location_hdfs/index.md new file mode 100644 index 0000000000..e74b99709f --- /dev/null +++ b/docs/aws-docs/providers/aws/datasync/location_hdfs/index.md @@ -0,0 +1,120 @@ +--- +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
DescriptionResource schema for AWS::DataSync::LocationHDFS.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.datasync.location_hdfs +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the location_hdfs resource, the following permissions are required: + +### Read +```json +datasync:DescribeLocationHdfs, +datasync:ListTagsForResource +``` + +### Update +```json +datasync:UpdateLocationHdfs, +datasync:DescribeLocationHdfs, +datasync:ListTagsForResource, +datasync:TagResource, +datasync:UntagResource +``` + +### Delete +```json +datasync:DeleteLocation +``` + diff --git a/docs/aws-docs/providers/aws/datasync/location_nfs/index.md b/docs/aws-docs/providers/aws/datasync/location_nfs/index.md new file mode 100644 index 0000000000..e70756617e --- /dev/null +++ b/docs/aws-docs/providers/aws/datasync/location_nfs/index.md @@ -0,0 +1,104 @@ +--- +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
DescriptionResource schema for AWS::DataSync::LocationNFS
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +mount_options, +on_prem_config, +server_hostname, +subdirectory, +tags, +location_arn, +location_uri +FROM aws.datasync.location_nfs +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the location_nfs resource, the following permissions are required: + +### Read +```json +datasync:DescribeLocationNfs, +datasync:ListTagsForResource +``` + +### Update +```json +datasync:DescribeLocationNfs, +datasync:ListTagsForResource, +datasync:TagResource, +datasync:UntagResource, +datasync:UpdateLocationNfs +``` + +### Delete +```json +datasync:DeleteLocation +``` + diff --git a/docs/aws-docs/providers/aws/datasync/location_object_storage/index.md b/docs/aws-docs/providers/aws/datasync/location_object_storage/index.md new file mode 100644 index 0000000000..aedd473533 --- /dev/null +++ b/docs/aws-docs/providers/aws/datasync/location_object_storage/index.md @@ -0,0 +1,114 @@ +--- +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
DescriptionResource schema for AWS::DataSync::LocationObjectStorage.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.datasync.location_object_storage +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the location_object_storage resource, the following permissions are required: + +### Read +```json +datasync:DescribeLocationObjectStorage, +datasync:ListTagsForResource +``` + +### Update +```json +datasync:DescribeLocationObjectStorage, +datasync:ListTagsForResource, +datasync:TagResource, +datasync:UntagResource, +datasync:UpdateLocationObjectStorage +``` + +### Delete +```json +datasync:DeleteLocation +``` + diff --git a/docs/aws-docs/providers/aws/datasync/location_object_storages/index.md b/docs/aws-docs/providers/aws/datasync/location_object_storages/index.md new file mode 100644 index 0000000000..810e33af8b --- /dev/null +++ b/docs/aws-docs/providers/aws/datasync/location_object_storages/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionResource schema for AWS::DataSync::LocationObjectStorage.
Idaws.datasync.location_object_storages
+ +## Fields + + + + + +
NameDatatypeDescription
location_arnstringThe Amazon Resource Name (ARN) of the location that is created.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +location_arn +FROM aws.datasync.location_object_storages +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the location_object_storages resource, the following permissions are required: + +### Create +```json +datasync:CreateLocationObjectStorage, +datasync:DescribeLocationObjectStorage, +datasync:ListTagsForResource, +datasync:TagResource +``` + +### List +```json +datasync:ListLocations +``` + diff --git a/docs/aws-docs/providers/aws/datasync/location_s3/index.md b/docs/aws-docs/providers/aws/datasync/location_s3/index.md new file mode 100644 index 0000000000..f70114594d --- /dev/null +++ b/docs/aws-docs/providers/aws/datasync/location_s3/index.md @@ -0,0 +1,103 @@ +--- +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
DescriptionResource schema for AWS::DataSync::LocationS3
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +s3_config, +s3_bucket_arn, +subdirectory, +s3_storage_class, +tags, +location_arn, +location_uri +FROM aws.datasync.location_s3 +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the location_s3 resource, the following permissions are required: + +### Read +```json +datasync:DescribeLocationS3, +datasync:ListTagsForResource +``` + +### Update +```json +datasync:DescribeLocationS3, +datasync:ListTagsForResource, +datasync:TagResource, +datasync:UntagResource +``` + +### Delete +```json +datasync:DeleteLocation +``` + diff --git a/docs/aws-docs/providers/aws/datasync/location_s3s/index.md b/docs/aws-docs/providers/aws/datasync/location_s3s/index.md new file mode 100644 index 0000000000..35bacd55d8 --- /dev/null +++ b/docs/aws-docs/providers/aws/datasync/location_s3s/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionResource schema for AWS::DataSync::LocationS3
Idaws.datasync.location_s3s
+ +## Fields + + + + + +
NameDatatypeDescription
location_arnstringThe Amazon Resource Name (ARN) of the Amazon S3 bucket location.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +location_arn +FROM aws.datasync.location_s3s +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the location_s3s resource, the following permissions are required: + +### Create +```json +datasync:CreateLocationS3, +datasync:DescribeLocationS3, +datasync:ListTagsForResource, +datasync:TagResource, +s3:ListAllMyBuckets, +s3:ListBucket, +iam:GetRole, +iam:PassRole +``` + +### List +```json +datasync:ListLocations +``` + diff --git a/docs/aws-docs/providers/aws/datasync/location_smb/index.md b/docs/aws-docs/providers/aws/datasync/location_smb/index.md new file mode 100644 index 0000000000..aadc3bdf3f --- /dev/null +++ b/docs/aws-docs/providers/aws/datasync/location_smb/index.md @@ -0,0 +1,110 @@ +--- +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
DescriptionResource schema for AWS::DataSync::LocationSMB.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +agent_arns, +domain, +mount_options, +password, +server_hostname, +subdirectory, +user, +tags, +location_arn, +location_uri +FROM aws.datasync.location_smb +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the location_smb resource, the following permissions are required: + +### Read +```json +datasync:DescribeLocationSmb, +datasync:ListTagsForResource +``` + +### Update +```json +datasync:DescribeLocationSmb, +datasync:ListTagsForResource, +datasync:TagResource, +datasync:UntagResource, +datasync:UpdateLocationSmb +``` + +### Delete +```json +datasync:DeleteLocation +``` + diff --git a/docs/aws-docs/providers/aws/datasync/location_smbs/index.md b/docs/aws-docs/providers/aws/datasync/location_smbs/index.md new file mode 100644 index 0000000000..fcea6acf01 --- /dev/null +++ b/docs/aws-docs/providers/aws/datasync/location_smbs/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionResource schema for AWS::DataSync::LocationSMB.
Idaws.datasync.location_smbs
+ +## Fields + + + + + +
NameDatatypeDescription
location_arnstringThe Amazon Resource Name (ARN) of the SMB location that is created.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +location_arn +FROM aws.datasync.location_smbs +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the location_smbs resource, the following permissions are required: + +### Create +```json +datasync:CreateLocationSmb, +datasync:DescribeLocationSmb, +datasync:ListTagsForResource, +datasync:TagResource +``` + +### List +```json +datasync:ListLocations +``` + diff --git a/docs/aws-docs/providers/aws/datasync/locationf_sx_lustre/index.md b/docs/aws-docs/providers/aws/datasync/locationf_sx_lustre/index.md new file mode 100644 index 0000000000..2616d8bc12 --- /dev/null +++ b/docs/aws-docs/providers/aws/datasync/locationf_sx_lustre/index.md @@ -0,0 +1,101 @@ +--- +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
DescriptionResource schema for AWS::DataSync::LocationFSxLustre.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +fsx_filesystem_arn, +security_group_arns, +subdirectory, +tags, +location_arn, +location_uri +FROM aws.datasync.locationf_sx_lustre +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the locationf_sx_lustre resource, the following permissions are required: + +### Read +```json +datasync:DescribeLocationFsxLustre, +datasync:ListTagsForResource +``` + +### Update +```json +datasync:DescribeLocationFsxLustre, +datasync:ListTagsForResource, +datasync:TagResource, +datasync:UntagResource +``` + +### Delete +```json +datasync:DeleteLocation +``` + diff --git a/docs/aws-docs/providers/aws/datasync/locationf_sx_lustres/index.md b/docs/aws-docs/providers/aws/datasync/locationf_sx_lustres/index.md new file mode 100644 index 0000000000..da8cb833f6 --- /dev/null +++ b/docs/aws-docs/providers/aws/datasync/locationf_sx_lustres/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionResource schema for AWS::DataSync::LocationFSxLustre.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +location_arn +FROM aws.datasync.locationf_sx_lustres +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the locationf_sx_lustres resource, the following permissions are required: + +### Create +```json +datasync:CreateLocationFsxLustre, +datasync:DescribeLocationFsxLustre, +datasync:ListTagsForResource, +datasync:TagResource, +fsx:DescribeFileSystems, +ec2:DescribeNetworkInterfaces, +ec2:DescribeSubnets, +ec2:DescribeSecurityGroups +``` + +### List +```json +datasync:ListLocations +``` + diff --git a/docs/aws-docs/providers/aws/datasync/locationf_sx_ontap/index.md b/docs/aws-docs/providers/aws/datasync/locationf_sx_ontap/index.md new file mode 100644 index 0000000000..56707d303d --- /dev/null +++ b/docs/aws-docs/providers/aws/datasync/locationf_sx_ontap/index.md @@ -0,0 +1,105 @@ +--- +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
DescriptionResource schema for AWS::DataSync::LocationFSxONTAP.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +storage_virtual_machine_arn, +fsx_filesystem_arn, +security_group_arns, +protocol, +subdirectory, +tags, +location_arn, +location_uri +FROM aws.datasync.locationf_sx_ontap +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the locationf_sx_ontap resource, the following permissions are required: + +### Read +```json +datasync:DescribeLocationFsxOntap, +datasync:ListTagsForResource +``` + +### Update +```json +datasync:DescribeLocationFsxOntap, +datasync:ListTagsForResource, +datasync:TagResource, +datasync:UntagResource +``` + +### Delete +```json +datasync:DeleteLocation +``` + diff --git a/docs/aws-docs/providers/aws/datasync/locationf_sx_ontaps/index.md b/docs/aws-docs/providers/aws/datasync/locationf_sx_ontaps/index.md new file mode 100644 index 0000000000..fbb08155ea --- /dev/null +++ b/docs/aws-docs/providers/aws/datasync/locationf_sx_ontaps/index.md @@ -0,0 +1,85 @@ +--- +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
DescriptionResource schema for AWS::DataSync::LocationFSxONTAP.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +location_arn +FROM aws.datasync.locationf_sx_ontaps +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the locationf_sx_ontaps resource, the following permissions are required: + +### Create +```json +datasync:CreateLocationFsxOntap, +datasync:DescribeLocationFsxOntap, +datasync:ListTagsForResource, +datasync:TagResource, +fsx:DescribeStorageVirtualMachines, +fsx:DescribeFileSystems, +ec2:DescribeNetworkInterfaces, +ec2:DescribeSubnets, +ec2:DescribeSecurityGroups +``` + +### List +```json +datasync:ListLocations +``` + diff --git a/docs/aws-docs/providers/aws/datasync/locationf_sx_open_zfs/index.md b/docs/aws-docs/providers/aws/datasync/locationf_sx_open_zfs/index.md new file mode 100644 index 0000000000..c9f0a0288e --- /dev/null +++ b/docs/aws-docs/providers/aws/datasync/locationf_sx_open_zfs/index.md @@ -0,0 +1,103 @@ +--- +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
DescriptionResource schema for AWS::DataSync::LocationFSxOpenZFS.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +fsx_filesystem_arn, +security_group_arns, +protocol, +subdirectory, +tags, +location_arn, +location_uri +FROM aws.datasync.locationf_sx_open_zfs +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the locationf_sx_open_zfs resource, the following permissions are required: + +### Read +```json +datasync:DescribeLocationFsxOpenZfs, +datasync:ListTagsForResource +``` + +### Update +```json +datasync:DescribeLocationFsxOpenZfs, +datasync:ListTagsForResource, +datasync:TagResource, +datasync:UntagResource +``` + +### Delete +```json +datasync:DeleteLocation +``` + diff --git a/docs/aws-docs/providers/aws/datasync/locationf_sx_windows/index.md b/docs/aws-docs/providers/aws/datasync/locationf_sx_windows/index.md new file mode 100644 index 0000000000..6e354358e2 --- /dev/null +++ b/docs/aws-docs/providers/aws/datasync/locationf_sx_windows/index.md @@ -0,0 +1,107 @@ +--- +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
DescriptionResource schema for AWS::DataSync::LocationFSxWindows.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +domain, +fsx_filesystem_arn, +password, +security_group_arns, +subdirectory, +user, +tags, +location_arn, +location_uri +FROM aws.datasync.locationf_sx_windows +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the locationf_sx_windows resource, the following permissions are required: + +### Read +```json +datasync:DescribeLocationFsxWindows, +datasync:ListTagsForResource +``` + +### Update +```json +datasync:DescribeLocationFsxWindows, +datasync:ListTagsForResource, +datasync:TagResource, +datasync:UntagResource +``` + +### Delete +```json +datasync:DeleteLocation +``` + diff --git a/docs/aws-docs/providers/aws/datasync/storage_system/index.md b/docs/aws-docs/providers/aws/datasync/storage_system/index.md new file mode 100644 index 0000000000..4e6fd2ce30 --- /dev/null +++ b/docs/aws-docs/providers/aws/datasync/storage_system/index.md @@ -0,0 +1,116 @@ +--- +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
DescriptionResource schema for AWS::DataSync::StorageSystem.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.datasync.storage_system +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the storage_system resource, the following permissions are required: + +### Read +```json +datasync:DescribeStorageSystem, +datasync:ListTagsForResource, +secretsmanager:DescribeSecret +``` + +### Update +```json +datasync:UpdateStorageSystem, +datasync:DescribeStorageSystem, +datasync:ListTagsForResource, +datasync:TagResource, +datasync:UntagResource, +secretsmanager:DescribeSecret, +secretsmanager:PutSecretValue +``` + +### Delete +```json +datasync:DescribeStorageSystem, +datasync:RemoveStorageSystem, +secretsmanager:DescribeSecret, +secretsmanager:DeleteSecret +``` + diff --git a/docs/aws-docs/providers/aws/datasync/storage_systems/index.md b/docs/aws-docs/providers/aws/datasync/storage_systems/index.md new file mode 100644 index 0000000000..1e4f1ac9cb --- /dev/null +++ b/docs/aws-docs/providers/aws/datasync/storage_systems/index.md @@ -0,0 +1,83 @@ +--- +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
DescriptionResource schema for AWS::DataSync::StorageSystem.
Idaws.datasync.storage_systems
+ +## Fields + + + + + +
NameDatatypeDescription
storage_system_arnstringThe ARN of the on-premises storage system added to DataSync Discovery.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +storage_system_arn +FROM aws.datasync.storage_systems +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the storage_systems resource, the following permissions are required: + +### Create +```json +datasync:AddStorageSystem, +datasync:DescribeStorageSystem, +datasync:ListTagsForResource, +datasync:TagResource, +secretsmanager:CreateSecret, +secretsmanager:DescribeSecret, +iam:CreateServiceLinkedRole +``` + +### List +```json +datasync:ListStorageSystems +``` + diff --git a/docs/aws-docs/providers/aws/datasync/task/index.md b/docs/aws-docs/providers/aws/datasync/task/index.md new file mode 100644 index 0000000000..8b8fe847b6 --- /dev/null +++ b/docs/aws-docs/providers/aws/datasync/task/index.md @@ -0,0 +1,130 @@ +--- +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
DescriptionResource schema for AWS::DataSync::Task.
Idaws.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
manifest_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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +excludes, +includes, +tags, +cloud_watch_log_group_arn, +destination_location_arn, +name, +options, +task_report_config, +manifest_config, +schedule, +source_location_arn, +task_arn, +status, +source_network_interface_arns, +destination_network_interface_arns +FROM aws.datasync.task +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the task resource, the following permissions are required: + +### Read +```json +datasync:DescribeTask, +datasync:ListTagsForResource +``` + +### Update +```json +datasync:UpdateTask, +datasync:DescribeTask, +datasync:ListTagsForResource, +datasync:TagResource, +datasync:UntagResource, +logs:DescribeLogGroups, +iam:PassRole +``` + +### Delete +```json +datasync:DeleteTask, +ec2:DescribeNetworkInterfaces, +ec2:DeleteNetworkInterface, +ec2:DescribeSecurityGroups, +ec2:DescribeSubnets, +fsx:DescribeFileSystems, +elasticfilesystem:DescribeFileSystems, +elasticfilesystem:DescribeMountTargets, +iam:GetRole +``` + diff --git a/docs/aws-docs/providers/aws/datasync/tasks/index.md b/docs/aws-docs/providers/aws/datasync/tasks/index.md new file mode 100644 index 0000000000..b2370cf626 --- /dev/null +++ b/docs/aws-docs/providers/aws/datasync/tasks/index.md @@ -0,0 +1,97 @@ +--- +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
DescriptionResource schema for AWS::DataSync::Task.
Idaws.datasync.tasks
+ +## Fields + + + + + +
NameDatatypeDescription
task_arnstringThe ARN of the task.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +task_arn +FROM aws.datasync.tasks +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the tasks resource, the following permissions are required: + +### Create +```json +datasync:CreateTask, +datasync:DescribeTask, +datasync:ListTagsForResource, +datasync:TagResource, +s3:ListAllMyBuckets, +s3:ListBucket, +s3:GetObject, +s3:GetObjectVersion, +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 +```json +datasync:ListTasks +``` + diff --git a/docs/aws-docs/providers/aws/datazone/data_source/index.md b/docs/aws-docs/providers/aws/datazone/data_source/index.md new file mode 100644 index 0000000000..8d11d684b8 --- /dev/null +++ b/docs/aws-docs/providers/aws/datazone/data_source/index.md @@ -0,0 +1,132 @@ +--- +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
DescriptionDefinition of AWS::DataZone::DataSource Resource Type
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.datazone.data_source +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the data_source resource, the following permissions are required: + +### Read +```json +datazone:GetDataSource +``` + +### Update +```json +datazone:UpdateDataSource, +datazone:GetDataSource, +datazone:DeleteDataSource +``` + +### Delete +```json +datazone:DeleteDataSource, +datazone:GetDataSource +``` + diff --git a/docs/aws-docs/providers/aws/datazone/data_sources/index.md b/docs/aws-docs/providers/aws/datazone/data_sources/index.md new file mode 100644 index 0000000000..ef1678cc28 --- /dev/null +++ b/docs/aws-docs/providers/aws/datazone/data_sources/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionDefinition of AWS::DataZone::DataSource Resource Type
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +domain_id, +id +FROM aws.datazone.data_sources +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the data_sources resource, the following permissions are required: + +### Create +```json +datazone:CreateDataSource, +iam:PassRole, +datazone:GetDataSource, +datazone:DeleteDataSource +``` + +### List +```json +datazone:ListDataSources +``` + diff --git a/docs/aws-docs/providers/aws/datazone/domain/index.md b/docs/aws-docs/providers/aws/datazone/domain/index.md new file mode 100644 index 0000000000..8c993ed646 --- /dev/null +++ b/docs/aws-docs/providers/aws/datazone/domain/index.md @@ -0,0 +1,118 @@ +--- +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
DescriptionA domain is an organizing entity for connecting together assets, users, and their projects
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.datazone.domain +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the domain resource, the following permissions are required: + +### Read +```json +datazone:GetDomain +``` + +### Update +```json +datazone:UpdateDomain, +datazone:GetDomain, +datazone:TagResource, +datazone:UntagResource, +sso:CreateManagedApplicationInstance, +sso:DeleteManagedApplicationInstance, +sso:PutApplicationAssignmentConfiguration +``` + +### Delete +```json +datazone:DeleteDomain, +datazone:GetDomain +``` + diff --git a/docs/aws-docs/providers/aws/datazone/domains/index.md b/docs/aws-docs/providers/aws/datazone/domains/index.md new file mode 100644 index 0000000000..6e4849db8e --- /dev/null +++ b/docs/aws-docs/providers/aws/datazone/domains/index.md @@ -0,0 +1,83 @@ +--- +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
DescriptionA domain is an organizing entity for connecting together assets, users, and their projects
Idaws.datazone.domains
+ +## Fields + + + + + +
NameDatatypeDescription
idstringThe id of the Amazon DataZone domain.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.datazone.domains +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the domains resource, the following permissions are required: + +### Create +```json +datazone:CreateDomain, +datazone:UpdateDomain, +datazone:GetDomain, +datazone:TagResource, +sso:CreateManagedApplicationInstance, +sso:DeleteManagedApplicationInstance, +sso:PutApplicationAssignmentConfiguration +``` + +### List +```json +datazone:ListDomains +``` + diff --git a/docs/aws-docs/providers/aws/datazone/environment/index.md b/docs/aws-docs/providers/aws/datazone/environment/index.md new file mode 100644 index 0000000000..05ebd3960a --- /dev/null +++ b/docs/aws-docs/providers/aws/datazone/environment/index.md @@ -0,0 +1,126 @@ +--- +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
DescriptionDefinition of AWS::DataZone::Environment Resource Type
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.datazone.environment +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the environment resource, the following permissions are required: + +### Read +```json +datazone:GetEnvironment +``` + +### Update +```json +datazone:UpdateEnvironment, +datazone:GetEnvironment, +datazone:DeleteEnvironment +``` + +### Delete +```json +datazone:DeleteEnvironment, +datazone:GetEnvironment +``` + diff --git a/docs/aws-docs/providers/aws/datazone/environment_blueprint_configuration/index.md b/docs/aws-docs/providers/aws/datazone/environment_blueprint_configuration/index.md new file mode 100644 index 0000000000..3d897e7901 --- /dev/null +++ b/docs/aws-docs/providers/aws/datazone/environment_blueprint_configuration/index.md @@ -0,0 +1,109 @@ +--- +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
DescriptionDefinition of AWS::DataZone::EnvironmentBlueprintConfiguration Resource Type
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.datazone.environment_blueprint_configuration +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the environment_blueprint_configuration resource, the following permissions are required: + +### Read +```json +datazone:GetEnvironmentBlueprintConfiguration +``` + +### Update +```json +datazone:DeleteEnvironmentBlueprintConfiguration, +iam:PassRole, +datazone:GetEnvironmentBlueprintConfiguration, +datazone:PutEnvironmentBlueprintConfiguration +``` + +### Delete +```json +datazone:GetEnvironmentBlueprintConfiguration, +datazone:DeleteEnvironmentBlueprintConfiguration +``` + diff --git a/docs/aws-docs/providers/aws/datazone/environment_blueprint_configurations/index.md b/docs/aws-docs/providers/aws/datazone/environment_blueprint_configurations/index.md new file mode 100644 index 0000000000..7e35709b9d --- /dev/null +++ b/docs/aws-docs/providers/aws/datazone/environment_blueprint_configurations/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionDefinition of AWS::DataZone::EnvironmentBlueprintConfiguration Resource Type
Idaws.datazone.environment_blueprint_configurations
+ +## Fields + + + + + + +
NameDatatypeDescription
domain_idstring
environment_blueprint_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +domain_id, +environment_blueprint_id +FROM aws.datazone.environment_blueprint_configurations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the environment_blueprint_configurations resource, the following permissions are required: + +### Create +```json +datazone:ListEnvironmentBlueprints, +iam:PassRole, +datazone:GetEnvironmentBlueprintConfiguration, +datazone:PutEnvironmentBlueprintConfiguration +``` + +### List +```json +datazone:ListEnvironmentBlueprintConfigurations +``` + diff --git a/docs/aws-docs/providers/aws/datazone/environment_profile/index.md b/docs/aws-docs/providers/aws/datazone/environment_profile/index.md new file mode 100644 index 0000000000..1a5502f19d --- /dev/null +++ b/docs/aws-docs/providers/aws/datazone/environment_profile/index.md @@ -0,0 +1,117 @@ +--- +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
DescriptionAWS Datazone Environment Profile is pre-configured set of resources and blueprints that provide reusable templates for creating environments.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.datazone.environment_profile +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the environment_profile resource, the following permissions are required: + +### Read +```json +datazone:GetEnvironmentProfile +``` + +### Update +```json +datazone:UpdateEnvironmentProfile, +datazone:GetEnvironmentProfile +``` + +### Delete +```json +datazone:DeleteEnvironmentProfile, +datazone:GetEnvironmentProfile +``` + diff --git a/docs/aws-docs/providers/aws/datazone/environment_profiles/index.md b/docs/aws-docs/providers/aws/datazone/environment_profiles/index.md new file mode 100644 index 0000000000..d87856707a --- /dev/null +++ b/docs/aws-docs/providers/aws/datazone/environment_profiles/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionAWS Datazone Environment Profile is pre-configured set of resources and blueprints that provide reusable templates for creating environments.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +domain_id, +id +FROM aws.datazone.environment_profiles +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the environment_profiles resource, the following permissions are required: + +### Create +```json +datazone:CreateEnvironmentProfile, +datazone:GetEnvironmentProfile +``` + +### List +```json +datazone:ListEnvironmentProfiles +``` + diff --git a/docs/aws-docs/providers/aws/datazone/environments/index.md b/docs/aws-docs/providers/aws/datazone/environments/index.md new file mode 100644 index 0000000000..4141fcaa13 --- /dev/null +++ b/docs/aws-docs/providers/aws/datazone/environments/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionDefinition of AWS::DataZone::Environment Resource Type
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +domain_id, +id +FROM aws.datazone.environments +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the environments resource, the following permissions are required: + +### Create +```json +datazone:CreateEnvironment, +datazone:GetEnvironment, +datazone:DeleteEnvironment +``` + +### List +```json +datazone:ListEnvironments +``` + diff --git a/docs/aws-docs/providers/aws/datazone/index.md b/docs/aws-docs/providers/aws/datazone/index.md new file mode 100644 index 0000000000..7794e2aba6 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/datazone/project/index.md b/docs/aws-docs/providers/aws/datazone/project/index.md new file mode 100644 index 0000000000..5d7f9aa4c5 --- /dev/null +++ b/docs/aws-docs/providers/aws/datazone/project/index.md @@ -0,0 +1,105 @@ +--- +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
DescriptionAmazon DataZone projects are business use case–based groupings of people, assets (data), and tools used to simplify access to the AWS analytics.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +created_at, +created_by, +description, +domain_id, +domain_identifier, +glossary_terms, +id, +last_updated_at, +name +FROM aws.datazone.project +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the project resource, the following permissions are required: + +### Read +```json +datazone:GetProject +``` + +### Update +```json +datazone:UpdateProject, +datazone:GetProject +``` + +### Delete +```json +datazone:DeleteProject, +datazone:GetProject +``` + diff --git a/docs/aws-docs/providers/aws/datazone/projects/index.md b/docs/aws-docs/providers/aws/datazone/projects/index.md new file mode 100644 index 0000000000..160f01d315 --- /dev/null +++ b/docs/aws-docs/providers/aws/datazone/projects/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionAmazon DataZone projects are business use case–based groupings of people, assets (data), and tools used to simplify access to the AWS analytics.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +domain_id, +id +FROM aws.datazone.projects +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the projects resource, the following permissions are required: + +### Create +```json +datazone:CreateProject, +datazone:GetProject +``` + +### List +```json +datazone:ListProjects +``` + diff --git a/docs/aws-docs/providers/aws/datazone/subscription_target/index.md b/docs/aws-docs/providers/aws/datazone/subscription_target/index.md new file mode 100644 index 0000000000..9573aa49b4 --- /dev/null +++ b/docs/aws-docs/providers/aws/datazone/subscription_target/index.md @@ -0,0 +1,121 @@ +--- +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 targets enables one to access the data to which you have subscribed in your projects.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.datazone.subscription_target +WHERE data__Identifier = '||'; +``` + +## Permissions + +To operate on the subscription_target resource, the following permissions are required: + +### Read +```json +datazone:GetSubscriptionTarget +``` + +### Update +```json +datazone:UpdateSubscriptionTarget, +datazone:GetSubscriptionTarget, +iam:PassRole +``` + +### Delete +```json +datazone:DeleteSubscriptionTarget +``` + diff --git a/docs/aws-docs/providers/aws/datazone/subscription_targets/index.md b/docs/aws-docs/providers/aws/datazone/subscription_targets/index.md new file mode 100644 index 0000000000..99012b087e --- /dev/null +++ b/docs/aws-docs/providers/aws/datazone/subscription_targets/index.md @@ -0,0 +1,83 @@ +--- +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 enables one to access the data to which you have subscribed in your projects.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +domain_id, +environment_id, +id +FROM aws.datazone.subscription_targets +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the subscription_targets resource, the following permissions are required: + +### Create +```json +datazone:CreateSubscriptionTarget, +datazone:GetSubscriptionTarget, +iam:PassRole +``` + +### List +```json +datazone:ListSubscriptionTargets +``` + diff --git a/docs/aws-docs/providers/aws/deadline/farm/index.md b/docs/aws-docs/providers/aws/deadline/farm/index.md new file mode 100644 index 0000000000..4a3fa566a5 --- /dev/null +++ b/docs/aws-docs/providers/aws/deadline/farm/index.md @@ -0,0 +1,112 @@ +--- +title: farm +hide_title: false +hide_table_of_contents: false +keywords: + - farm + - deadline + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual farm resource + +## Overview + + + + + +
Namefarm
TypeResource
DescriptionDefinition of AWS::Deadline::Farm Resource Type
Idaws.deadline.farm
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
descriptionstring
display_namestring
farm_idstring
kms_key_arnstring
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +description, +display_name, +farm_id, +kms_key_arn, +arn +FROM aws.deadline.farm +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the farm resource, the following permissions are required: + +### Read +```json +deadline:GetFarm, +identitystore:ListGroupMembershipsForMember, +kms:Encrypt, +kms:Decrypt, +kms:CreateGrant, +kms:GenerateDataKey +``` + +### Update +```json +deadline:UpdateFarm, +deadline:GetFarm, +identitystore:ListGroupMembershipsForMember, +kms:Encrypt, +kms:Decrypt, +kms:CreateGrant, +kms:GenerateDataKey +``` + +### Delete +```json +deadline:DeleteFarm, +deadline:GetFarm, +identitystore:ListGroupMembershipsForMember, +kms:Encrypt, +kms:Decrypt, +kms:CreateGrant, +kms:GenerateDataKey +``` + diff --git a/docs/aws-docs/providers/aws/deadline/farms/index.md b/docs/aws-docs/providers/aws/deadline/farms/index.md new file mode 100644 index 0000000000..31830b2160 --- /dev/null +++ b/docs/aws-docs/providers/aws/deadline/farms/index.md @@ -0,0 +1,83 @@ +--- +title: farms +hide_title: false +hide_table_of_contents: false +keywords: + - farms + - deadline + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Retrieves a list of farms in a region + +## Overview + + + + + +
Namefarms
TypeResource
DescriptionDefinition of AWS::Deadline::Farm Resource Type
Idaws.deadline.farms
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.deadline.farms +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the farms resource, the following permissions are required: + +### Create +```json +deadline:CreateFarm, +deadline:GetFarm, +kms:Encrypt, +kms:Decrypt, +kms:CreateGrant, +kms:GenerateDataKey +``` + +### List +```json +deadline:ListFarms, +identitystore:ListGroupMembershipsForMember +``` + diff --git a/docs/aws-docs/providers/aws/deadline/fleet/index.md b/docs/aws-docs/providers/aws/deadline/fleet/index.md new file mode 100644 index 0000000000..5582cb3cc4 --- /dev/null +++ b/docs/aws-docs/providers/aws/deadline/fleet/index.md @@ -0,0 +1,115 @@ +--- +title: fleet +hide_title: false +hide_table_of_contents: false +keywords: + - fleet + - deadline + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual fleet resource + +## Overview + + + + + +
Namefleet
TypeResource
DescriptionDefinition of AWS::Deadline::Fleet Resource Type
Idaws.deadline.fleet
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
capabilitiesobject
configurationundefined
descriptionstring
display_namestring
farm_idstring
fleet_idstring
max_worker_countinteger
min_worker_countinteger
role_arnstring
statusstring
worker_countinteger
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +capabilities, +configuration, +description, +display_name, +farm_id, +fleet_id, +max_worker_count, +min_worker_count, +role_arn, +status, +worker_count, +arn +FROM aws.deadline.fleet +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the fleet resource, the following permissions are required: + +### Read +```json +deadline:GetFleet, +identitystore:ListGroupMembershipsForMember +``` + +### Update +```json +deadline:UpdateFleet, +deadline:GetFleet, +iam:PassRole, +identitystore:ListGroupMembershipsForMember +``` + +### Delete +```json +deadline:DeleteFleet, +deadline:GetFleet, +identitystore:ListGroupMembershipsForMember +``` + diff --git a/docs/aws-docs/providers/aws/deadline/fleets/index.md b/docs/aws-docs/providers/aws/deadline/fleets/index.md new file mode 100644 index 0000000000..6a2bdbc5af --- /dev/null +++ b/docs/aws-docs/providers/aws/deadline/fleets/index.md @@ -0,0 +1,84 @@ +--- +title: fleets +hide_title: false +hide_table_of_contents: false +keywords: + - fleets + - deadline + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Retrieves a list of fleets in a region + +## Overview + + + + + +
Namefleets
TypeResource
DescriptionDefinition of AWS::Deadline::Fleet Resource Type
Idaws.deadline.fleets
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.deadline.fleets +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the fleets resource, the following permissions are required: + +### Create +```json +deadline:CreateFleet, +deadline:GetFleet, +iam:PassRole, +identitystore:ListGroupMembershipsForMember, +logs:CreateLogGroup +``` + +### List +```json +deadline:ListFleets, +identitystore:DescribeGroup, +identitystore:DescribeUser, +identitystore:ListGroupMembershipsForMember +``` + diff --git a/docs/aws-docs/providers/aws/deadline/index.md b/docs/aws-docs/providers/aws/deadline/index.md new file mode 100644 index 0000000000..1e87b629d4 --- /dev/null +++ b/docs/aws-docs/providers/aws/deadline/index.md @@ -0,0 +1,53 @@ +--- +title: deadline +hide_title: false +hide_table_of_contents: false +keywords: + - deadline + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- + +The deadline service documentation. + +:::info Service Summary + +
+
+total resources: 16
+total selectable resources: 16
+total methods: 16
+
+
+ +::: + +## Resources +
+
+farm
+farms
+fleet
+fleets
+license_endpoint
+license_endpoints
+metered_product
+metered_products +
+
+queue
+queue_environment
+queue_environments
+queue_fleet_association
+queue_fleet_associations
+queues
+storage_profile
+storage_profiles +
+
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/deadline/license_endpoint/index.md b/docs/aws-docs/providers/aws/deadline/license_endpoint/index.md new file mode 100644 index 0000000000..2f2d91a8f6 --- /dev/null +++ b/docs/aws-docs/providers/aws/deadline/license_endpoint/index.md @@ -0,0 +1,94 @@ +--- +title: license_endpoint +hide_title: false +hide_table_of_contents: false +keywords: + - license_endpoint + - deadline + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual license_endpoint resource + +## Overview + + + + + +
Namelicense_endpoint
TypeResource
DescriptionDefinition of AWS::Deadline::LicenseEndpoint Resource Type
Idaws.deadline.license_endpoint
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
dns_namestring
license_endpoint_idstring
security_group_idsarray
statusstring
status_messagestring
subnet_idsarray
vpc_idstring
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +dns_name, +license_endpoint_id, +security_group_ids, +status, +status_message, +subnet_ids, +vpc_id, +arn +FROM aws.deadline.license_endpoint +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the license_endpoint resource, the following permissions are required: + +### Read +```json +deadline:GetLicenseEndpoint +``` + +### Delete +```json +deadline:GetLicenseEndpoint, +deadline:DeleteLicenseEndpoint, +ec2:DeleteVpcEndpoints, +ec2:DescribeVpcEndpoints +``` + diff --git a/docs/aws-docs/providers/aws/deadline/license_endpoints/index.md b/docs/aws-docs/providers/aws/deadline/license_endpoints/index.md new file mode 100644 index 0000000000..7a7b2faa71 --- /dev/null +++ b/docs/aws-docs/providers/aws/deadline/license_endpoints/index.md @@ -0,0 +1,81 @@ +--- +title: license_endpoints +hide_title: false +hide_table_of_contents: false +keywords: + - license_endpoints + - deadline + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Retrieves a list of license_endpoints in a region + +## Overview + + + + + +
Namelicense_endpoints
TypeResource
DescriptionDefinition of AWS::Deadline::LicenseEndpoint Resource Type
Idaws.deadline.license_endpoints
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.deadline.license_endpoints +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the license_endpoints resource, the following permissions are required: + +### Create +```json +deadline:CreateLicenseEndpoint, +deadline:GetLicenseEndpoint, +ec2:CreateTags, +ec2:CreateVpcEndpoint, +ec2:DescribeVpcEndpoints +``` + +### List +```json +deadline:ListLicenseEndpoints +``` + diff --git a/docs/aws-docs/providers/aws/deadline/metered_product/index.md b/docs/aws-docs/providers/aws/deadline/metered_product/index.md new file mode 100644 index 0000000000..12cab634f1 --- /dev/null +++ b/docs/aws-docs/providers/aws/deadline/metered_product/index.md @@ -0,0 +1,89 @@ +--- +title: metered_product +hide_title: false +hide_table_of_contents: false +keywords: + - metered_product + - deadline + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual metered_product resource + +## Overview + + + + + +
Namemetered_product
TypeResource
DescriptionDefinition of AWS::Deadline::MeteredProduct Resource Type
Idaws.deadline.metered_product
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
license_endpoint_idstring
product_idstring
portinteger
familystring
vendorstring
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +license_endpoint_id, +product_id, +port, +family, +vendor, +arn +FROM aws.deadline.metered_product +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the metered_product resource, the following permissions are required: + +### Read +```json +deadline:GetMeteredProduct, +deadline:ListMeteredProducts +``` + +### Delete +```json +deadline:DeleteMeteredProduct, +deadline:ListMeteredProducts +``` + diff --git a/docs/aws-docs/providers/aws/deadline/metered_products/index.md b/docs/aws-docs/providers/aws/deadline/metered_products/index.md new file mode 100644 index 0000000000..a0e60ba44f --- /dev/null +++ b/docs/aws-docs/providers/aws/deadline/metered_products/index.md @@ -0,0 +1,78 @@ +--- +title: metered_products +hide_title: false +hide_table_of_contents: false +keywords: + - metered_products + - deadline + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Retrieves a list of metered_products in a region + +## Overview + + + + + +
Namemetered_products
TypeResource
DescriptionDefinition of AWS::Deadline::MeteredProduct Resource Type
Idaws.deadline.metered_products
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.deadline.metered_products +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the metered_products resource, the following permissions are required: + +### Create +```json +deadline:PutMeteredProduct, +deadline:ListMeteredProducts +``` + +### List +```json +deadline:ListMeteredProducts +``` + diff --git a/docs/aws-docs/providers/aws/deadline/queue/index.md b/docs/aws-docs/providers/aws/deadline/queue/index.md new file mode 100644 index 0000000000..85aa813f04 --- /dev/null +++ b/docs/aws-docs/providers/aws/deadline/queue/index.md @@ -0,0 +1,115 @@ +--- +title: queue +hide_title: false +hide_table_of_contents: false +keywords: + - queue + - deadline + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual queue resource + +## Overview + + + + + +
Namequeue
TypeResource
DescriptionDefinition of AWS::Deadline::Queue Resource Type
Idaws.deadline.queue
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
allowed_storage_profile_idsarray
default_budget_actionstring
descriptionstring
display_namestring
farm_idstring
job_attachment_settingsobject
job_run_as_userobject
queue_idstring
required_file_system_location_namesarray
role_arnstring
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +allowed_storage_profile_ids, +default_budget_action, +description, +display_name, +farm_id, +job_attachment_settings, +job_run_as_user, +queue_id, +required_file_system_location_names, +role_arn, +arn +FROM aws.deadline.queue +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the queue resource, the following permissions are required: + +### Read +```json +deadline:GetQueue, +identitystore:ListGroupMembershipsForMember +``` + +### Update +```json +deadline:UpdateQueue, +deadline:GetQueue, +iam:PassRole, +identitystore:ListGroupMembershipsForMember, +logs:CreateLogGroup, +s3:ListBucket +``` + +### Delete +```json +deadline:DeleteQueue, +deadline:GetQueue, +identitystore:ListGroupMembershipsForMember +``` + diff --git a/docs/aws-docs/providers/aws/deadline/queue_environment/index.md b/docs/aws-docs/providers/aws/deadline/queue_environment/index.md new file mode 100644 index 0000000000..67ef2e3644 --- /dev/null +++ b/docs/aws-docs/providers/aws/deadline/queue_environment/index.md @@ -0,0 +1,103 @@ +--- +title: queue_environment +hide_title: false +hide_table_of_contents: false +keywords: + - queue_environment + - deadline + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual queue_environment resource + +## Overview + + + + + +
Namequeue_environment
TypeResource
DescriptionDefinition of AWS::Deadline::QueueEnvironment Resource Type
Idaws.deadline.queue_environment
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
farm_idstring
namestring
priorityinteger
queue_environment_idstring
queue_idstring
templatestring
template_typestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +farm_id, +name, +priority, +queue_environment_id, +queue_id, +template, +template_type +FROM aws.deadline.queue_environment +WHERE data__Identifier = '||'; +``` + +## Permissions + +To operate on the queue_environment resource, the following permissions are required: + +### Read +```json +deadline:GetQueueEnvironment, +identitystore:ListGroupMembershipsForMember +``` + +### Update +```json +deadline:UpdateQueueEnvironment, +identitystore:ListGroupMembershipsForMember +``` + +### Delete +```json +deadline:DeleteQueueEnvironment, +deadline:GetQueueEnvironment, +identitystore:ListGroupMembershipsForMember +``` + diff --git a/docs/aws-docs/providers/aws/deadline/queue_environments/index.md b/docs/aws-docs/providers/aws/deadline/queue_environments/index.md new file mode 100644 index 0000000000..8d98f1cf1b --- /dev/null +++ b/docs/aws-docs/providers/aws/deadline/queue_environments/index.md @@ -0,0 +1,83 @@ +--- +title: queue_environments +hide_title: false +hide_table_of_contents: false +keywords: + - queue_environments + - deadline + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Retrieves a list of queue_environments in a region + +## Overview + + + + + +
Namequeue_environments
TypeResource
DescriptionDefinition of AWS::Deadline::QueueEnvironment Resource Type
Idaws.deadline.queue_environments
+ +## Fields + + + + + + + +
NameDatatypeDescription
farm_idstring
queue_idstring
queue_environment_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +farm_id, +queue_id, +queue_environment_id +FROM aws.deadline.queue_environments +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the queue_environments resource, the following permissions are required: + +### Create +```json +deadline:CreateQueueEnvironment, +identitystore:ListGroupMembershipsForMember +``` + +### List +```json +deadline:ListQueueEnvironments, +identitystore:ListGroupMembershipsForMember +``` + diff --git a/docs/aws-docs/providers/aws/deadline/queue_fleet_association/index.md b/docs/aws-docs/providers/aws/deadline/queue_fleet_association/index.md new file mode 100644 index 0000000000..3c0d47bcfc --- /dev/null +++ b/docs/aws-docs/providers/aws/deadline/queue_fleet_association/index.md @@ -0,0 +1,85 @@ +--- +title: queue_fleet_association +hide_title: false +hide_table_of_contents: false +keywords: + - queue_fleet_association + - deadline + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual queue_fleet_association resource + +## Overview + + + + + +
Namequeue_fleet_association
TypeResource
DescriptionDefinition of AWS::Deadline::QueueFleetAssociation Resource Type
Idaws.deadline.queue_fleet_association
+ +## Fields + + + + + + + +
NameDatatypeDescription
farm_idstring
fleet_idstring
queue_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +farm_id, +fleet_id, +queue_id +FROM aws.deadline.queue_fleet_association +WHERE data__Identifier = '||'; +``` + +## Permissions + +To operate on the queue_fleet_association resource, the following permissions are required: + +### Read +```json +deadline:GetQueueFleetAssociation, +identitystore:ListGroupMembershipsForMember +``` + +### Delete +```json +deadline:DeleteQueueFleetAssociation, +deadline:GetQueueFleetAssociation, +deadline:UpdateQueueFleetAssociation, +identitystore:ListGroupMembershipsForMember +``` + diff --git a/docs/aws-docs/providers/aws/deadline/queue_fleet_associations/index.md b/docs/aws-docs/providers/aws/deadline/queue_fleet_associations/index.md new file mode 100644 index 0000000000..2df28a9c6c --- /dev/null +++ b/docs/aws-docs/providers/aws/deadline/queue_fleet_associations/index.md @@ -0,0 +1,84 @@ +--- +title: queue_fleet_associations +hide_title: false +hide_table_of_contents: false +keywords: + - queue_fleet_associations + - deadline + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Retrieves a list of queue_fleet_associations in a region + +## Overview + + + + + +
Namequeue_fleet_associations
TypeResource
DescriptionDefinition of AWS::Deadline::QueueFleetAssociation Resource Type
Idaws.deadline.queue_fleet_associations
+ +## Fields + + + + + + + +
NameDatatypeDescription
farm_idstring
fleet_idstring
queue_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +farm_id, +fleet_id, +queue_id +FROM aws.deadline.queue_fleet_associations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the queue_fleet_associations resource, the following permissions are required: + +### Create +```json +deadline:CreateQueueFleetAssociation, +deadline:GetQueueFleetAssociation, +identitystore:ListGroupMembershipsForMember +``` + +### List +```json +deadline:ListQueueFleetAssociations, +identitystore:ListGroupMembershipsForMember +``` + diff --git a/docs/aws-docs/providers/aws/deadline/queues/index.md b/docs/aws-docs/providers/aws/deadline/queues/index.md new file mode 100644 index 0000000000..32ab0e2f4c --- /dev/null +++ b/docs/aws-docs/providers/aws/deadline/queues/index.md @@ -0,0 +1,85 @@ +--- +title: queues +hide_title: false +hide_table_of_contents: false +keywords: + - queues + - deadline + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Retrieves a list of queues in a region + +## Overview + + + + + +
Namequeues
TypeResource
DescriptionDefinition of AWS::Deadline::Queue Resource Type
Idaws.deadline.queues
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.deadline.queues +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the queues resource, the following permissions are required: + +### Create +```json +deadline:CreateQueue, +deadline:GetQueue, +iam:PassRole, +identitystore:ListGroupMembershipsForMember, +logs:CreateLogGroup, +s3:ListBucket +``` + +### List +```json +deadline:ListQueues, +identitystore:DescribeGroup, +identitystore:DescribeUser, +identitystore:ListGroupMembershipsForMember +``` + diff --git a/docs/aws-docs/providers/aws/deadline/storage_profile/index.md b/docs/aws-docs/providers/aws/deadline/storage_profile/index.md new file mode 100644 index 0000000000..5c3cfb13d7 --- /dev/null +++ b/docs/aws-docs/providers/aws/deadline/storage_profile/index.md @@ -0,0 +1,100 @@ +--- +title: storage_profile +hide_title: false +hide_table_of_contents: false +keywords: + - storage_profile + - deadline + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual storage_profile resource + +## Overview + + + + + +
Namestorage_profile
TypeResource
DescriptionDefinition of AWS::Deadline::StorageProfile Resource Type
Idaws.deadline.storage_profile
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
display_namestring
farm_idstring
file_system_locationsarray
os_familystring
storage_profile_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +display_name, +farm_id, +file_system_locations, +os_family, +storage_profile_id +FROM aws.deadline.storage_profile +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the storage_profile resource, the following permissions are required: + +### Read +```json +deadline:GetStorageProfile, +identitystore:ListGroupMembershipsForMember +``` + +### Update +```json +deadline:UpdateStorageProfile, +deadline:GetStorageProfile, +identitystore:ListGroupMembershipsForMember +``` + +### Delete +```json +deadline:DeleteStorageProfile, +deadline:GetStorageProfile, +identitystore:ListGroupMembershipsForMember +``` + diff --git a/docs/aws-docs/providers/aws/deadline/storage_profiles/index.md b/docs/aws-docs/providers/aws/deadline/storage_profiles/index.md new file mode 100644 index 0000000000..2a538d803d --- /dev/null +++ b/docs/aws-docs/providers/aws/deadline/storage_profiles/index.md @@ -0,0 +1,82 @@ +--- +title: storage_profiles +hide_title: false +hide_table_of_contents: false +keywords: + - storage_profiles + - deadline + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Retrieves a list of storage_profiles in a region + +## Overview + + + + + +
Namestorage_profiles
TypeResource
DescriptionDefinition of AWS::Deadline::StorageProfile Resource Type
Idaws.deadline.storage_profiles
+ +## Fields + + + + + + +
NameDatatypeDescription
farm_idstring
storage_profile_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +farm_id, +storage_profile_id +FROM aws.deadline.storage_profiles +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the storage_profiles resource, the following permissions are required: + +### Create +```json +deadline:CreateStorageProfile, +deadline:GetStorageProfile, +identitystore:ListGroupMembershipsForMember +``` + +### List +```json +deadline:ListStorageProfiles, +identitystore:ListGroupMembershipsForMember +``` + diff --git a/docs/aws-docs/providers/aws/detective/graph/index.md b/docs/aws-docs/providers/aws/detective/graph/index.md new file mode 100644 index 0000000000..2f2fb8b3ec --- /dev/null +++ b/docs/aws-docs/providers/aws/detective/graph/index.md @@ -0,0 +1,98 @@ +--- +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
DescriptionResource schema for AWS::Detective::Graph
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +tags, +auto_enable_members +FROM aws.detective.graph +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the graph resource, the following permissions are required: + +### Update +```json +detective:UntagResource, +detective:TagResource, +detective:ListTagsForResource, +detective:UpdateOrganizationConfiguration, +organizations:DescribeOrganization +``` + +### Read +```json +detective:ListGraphs, +detective:ListTagsForResource, +detective:DescribeOrganizationConfiguration, +organizations:DescribeOrganization +``` + +### Delete +```json +detective:DeleteGraph +``` + diff --git a/docs/aws-docs/providers/aws/detective/graphs/index.md b/docs/aws-docs/providers/aws/detective/graphs/index.md new file mode 100644 index 0000000000..d26bf2d3f0 --- /dev/null +++ b/docs/aws-docs/providers/aws/detective/graphs/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionResource schema for AWS::Detective::Graph
Idaws.detective.graphs
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe Detective graph ARN
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.detective.graphs +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the graphs resource, the following permissions are required: + +### Create +```json +detective:CreateGraph, +detective:UpdateOrganizationConfiguration, +organizations:DescribeOrganization +``` + +### List +```json +detective:ListGraphs, +detective:ListTagsForResource, +detective:DescribeOrganizationConfiguration, +organizations:DescribeOrganization +``` + diff --git a/docs/aws-docs/providers/aws/detective/index.md b/docs/aws-docs/providers/aws/detective/index.md new file mode 100644 index 0000000000..4a596b50c0 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/detective/member_invitation/index.md b/docs/aws-docs/providers/aws/detective/member_invitation/index.md new file mode 100644 index 0000000000..356921665b --- /dev/null +++ b/docs/aws-docs/providers/aws/detective/member_invitation/index.md @@ -0,0 +1,90 @@ +--- +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
DescriptionResource schema for AWS::Detective::MemberInvitation
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +graph_arn, +member_id, +member_email_address, +disable_email_notification, +message +FROM aws.detective.member_invitation +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the member_invitation resource, the following permissions are required: + +### Read +```json +detective:GetMembers +``` + +### Delete +```json +detective:DeleteMembers +``` + diff --git a/docs/aws-docs/providers/aws/detective/member_invitations/index.md b/docs/aws-docs/providers/aws/detective/member_invitations/index.md new file mode 100644 index 0000000000..69638946da --- /dev/null +++ b/docs/aws-docs/providers/aws/detective/member_invitations/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionResource schema for AWS::Detective::MemberInvitation
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +graph_arn, +member_id +FROM aws.detective.member_invitations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the member_invitations resource, the following permissions are required: + +### Create +```json +detective:CreateMembers, +detective:GetMembers +``` + +### List +```json +detective:ListGraphs, +detective:ListMembers +``` + diff --git a/docs/aws-docs/providers/aws/detective/organization_admin/index.md b/docs/aws-docs/providers/aws/detective/organization_admin/index.md new file mode 100644 index 0000000000..f5964d1b08 --- /dev/null +++ b/docs/aws-docs/providers/aws/detective/organization_admin/index.md @@ -0,0 +1,87 @@ +--- +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
DescriptionResource schema for AWS::Detective::OrganizationAdmin
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +account_id, +graph_arn +FROM aws.detective.organization_admin +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the organization_admin resource, the following permissions are required: + +### Read +```json +detective:ListOrganizationAdminAccount, +organizations:DescribeOrganization +``` + +### Delete +```json +detective:DisableOrganizationAdminAccount, +detective:ListOrganizationAdminAccount, +organizations:DescribeOrganization +``` + diff --git a/docs/aws-docs/providers/aws/detective/organization_admins/index.md b/docs/aws-docs/providers/aws/detective/organization_admins/index.md new file mode 100644 index 0000000000..f13e68862c --- /dev/null +++ b/docs/aws-docs/providers/aws/detective/organization_admins/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionResource schema for AWS::Detective::OrganizationAdmin
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +account_id +FROM aws.detective.organization_admins +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the organization_admins resource, the following permissions are required: + +### Create +```json +detective:EnableOrganizationAdminAccount, +detective:ListOrganizationAdminAccount, +iam:CreateServiceLinkedRole, +organizations:RegisterDelegatedAdministrator, +organizations:DescribeOrganization, +organizations:EnableAWSServiceAccess, +organizations:ListAccounts +``` + +### List +```json +detective:ListOrganizationAdminAccount, +organizations:DescribeOrganization +``` + diff --git a/docs/aws-docs/providers/aws/devopsguru/index.md b/docs/aws-docs/providers/aws/devopsguru/index.md new file mode 100644 index 0000000000..370c6680e6 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/devopsguru/log_anomaly_detection_integration/index.md b/docs/aws-docs/providers/aws/devopsguru/log_anomaly_detection_integration/index.md new file mode 100644 index 0000000000..a9280ca6e3 --- /dev/null +++ b/docs/aws-docs/providers/aws/devopsguru/log_anomaly_detection_integration/index.md @@ -0,0 +1,92 @@ +--- +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
DescriptionThis resource schema represents the LogAnomalyDetectionIntegration resource in the Amazon DevOps Guru.
Idaws.devopsguru.log_anomaly_detection_integration
+ +## Fields + + + + + +
NameDatatypeDescription
account_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +account_id +FROM aws.devopsguru.log_anomaly_detection_integration +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the log_anomaly_detection_integration resource, the following permissions are required: + +### Read +```json +devops-guru:DescribeServiceIntegration +``` + +### Update +```json +devops-guru:UpdateServiceIntegration, +logs:TagLogGroup, +logs:UntagLogGroup +``` + +### Delete +```json +devops-guru:DescribeServiceIntegration, +devops-guru:UpdateServiceIntegration, +logs:TagLogGroup, +logs:UntagLogGroup +``` + diff --git a/docs/aws-docs/providers/aws/devopsguru/log_anomaly_detection_integrations/index.md b/docs/aws-docs/providers/aws/devopsguru/log_anomaly_detection_integrations/index.md new file mode 100644 index 0000000000..3784d97aa4 --- /dev/null +++ b/docs/aws-docs/providers/aws/devopsguru/log_anomaly_detection_integrations/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionThis resource schema represents the LogAnomalyDetectionIntegration resource in the Amazon DevOps Guru.
Idaws.devopsguru.log_anomaly_detection_integrations
+ +## Fields + + + + + +
NameDatatypeDescription
account_idundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +account_id +FROM aws.devopsguru.log_anomaly_detection_integrations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the log_anomaly_detection_integrations resource, the following permissions are required: + +### Create +```json +devops-guru:DescribeServiceIntegration, +devops-guru:UpdateServiceIntegration, +logs:TagLogGroup, +logs:UntagLogGroup +``` + +### List +```json +devops-guru:DescribeServiceIntegration +``` + diff --git a/docs/aws-docs/providers/aws/devopsguru/notification_channel/index.md b/docs/aws-docs/providers/aws/devopsguru/notification_channel/index.md new file mode 100644 index 0000000000..5d7b03670d --- /dev/null +++ b/docs/aws-docs/providers/aws/devopsguru/notification_channel/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionThis resource schema represents the NotificationChannel resource in the Amazon DevOps Guru.
Idaws.devopsguru.notification_channel
+ +## Fields + + + + + + +
NameDatatypeDescription
configobject
idstringThe ID of a notification channel.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +config, +id +FROM aws.devopsguru.notification_channel +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the notification_channel resource, the following permissions are required: + +### Delete +```json +devops-guru:RemoveNotificationChannel, +devops-guru:ListNotificationChannels +``` + +### Read +```json +devops-guru:ListNotificationChannels +``` + diff --git a/docs/aws-docs/providers/aws/devopsguru/notification_channels/index.md b/docs/aws-docs/providers/aws/devopsguru/notification_channels/index.md new file mode 100644 index 0000000000..7251bbc7b2 --- /dev/null +++ b/docs/aws-docs/providers/aws/devopsguru/notification_channels/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionThis resource schema represents the NotificationChannel resource in the Amazon DevOps Guru.
Idaws.devopsguru.notification_channels
+ +## Fields + + + + + +
NameDatatypeDescription
idstringThe ID of a notification channel.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.devopsguru.notification_channels +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the notification_channels resource, the following permissions are required: + +### Create +```json +devops-guru:AddNotificationChannel, +devops-guru:ListNotificationChannels, +sns:Publish, +sns:GetTopicAttributes, +sns:SetTopicAttributes +``` + +### List +```json +devops-guru:ListNotificationChannels +``` + diff --git a/docs/aws-docs/providers/aws/devopsguru/resource_collection/index.md b/docs/aws-docs/providers/aws/devopsguru/resource_collection/index.md new file mode 100644 index 0000000000..9de4e858e9 --- /dev/null +++ b/docs/aws-docs/providers/aws/devopsguru/resource_collection/index.md @@ -0,0 +1,91 @@ +--- +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
DescriptionThis resource schema represents the ResourceCollection resource in the Amazon DevOps Guru.
Idaws.devopsguru.resource_collection
+ +## Fields + + + + + + +
NameDatatypeDescription
resource_collection_filterobject
resource_collection_typestringThe type of ResourceCollection
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +resource_collection_filter, +resource_collection_type +FROM aws.devopsguru.resource_collection +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the resource_collection resource, the following permissions are required: + +### Read +```json +devops-guru:GetResourceCollection +``` + +### Delete +```json +devops-guru:UpdateResourceCollection, +devops-guru:GetResourceCollection +``` + +### Update +```json +devops-guru:UpdateResourceCollection, +devops-guru:GetResourceCollection +``` + diff --git a/docs/aws-docs/providers/aws/devopsguru/resource_collections/index.md b/docs/aws-docs/providers/aws/devopsguru/resource_collections/index.md new file mode 100644 index 0000000000..4454eeb64f --- /dev/null +++ b/docs/aws-docs/providers/aws/devopsguru/resource_collections/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionThis resource schema represents the ResourceCollection resource in the Amazon DevOps Guru.
Idaws.devopsguru.resource_collections
+ +## Fields + + + + + +
NameDatatypeDescription
resource_collection_typestringThe type of ResourceCollection
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +resource_collection_type +FROM aws.devopsguru.resource_collections +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the resource_collections resource, the following permissions are required: + +### Create +```json +devops-guru:UpdateResourceCollection, +devops-guru:GetResourceCollection +``` + +### List +```json +devops-guru:GetResourceCollection +``` + diff --git a/docs/aws-docs/providers/aws/directoryservice/index.md b/docs/aws-docs/providers/aws/directoryservice/index.md new file mode 100644 index 0000000000..e1defce5e7 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/directoryservice/simple_ad/index.md b/docs/aws-docs/providers/aws/directoryservice/simple_ad/index.md new file mode 100644 index 0000000000..9483e2a60a --- /dev/null +++ b/docs/aws-docs/providers/aws/directoryservice/simple_ad/index.md @@ -0,0 +1,116 @@ +--- +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
DescriptionResource Type definition for AWS::DirectoryService::SimpleAD
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +directory_id, +alias, +dns_ip_addresses, +create_alias, +description, +enable_sso, +name, +password, +short_name, +size, +vpc_settings +FROM aws.directoryservice.simple_ad +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the simple_ad resource, the following permissions are required: + +### Read +```json +ds:DescribeDirectories +``` + +### Update +```json +ds:EnableSso, +ds:DisableSso, +ds:DescribeDirectories +``` + +### Delete +```json +ds:DeleteDirectory, +ds:DescribeDirectories, +ec2:DescribeNetworkInterfaces, +ec2:DeleteSecurityGroup, +ec2:DeleteNetworkInterface, +ec2:RevokeSecurityGroupIngress, +ec2:RevokeSecurityGroupEgress, +ec2:DeleteTags +``` + diff --git a/docs/aws-docs/providers/aws/directoryservice/simple_ads/index.md b/docs/aws-docs/providers/aws/directoryservice/simple_ads/index.md new file mode 100644 index 0000000000..7e9a292b2f --- /dev/null +++ b/docs/aws-docs/providers/aws/directoryservice/simple_ads/index.md @@ -0,0 +1,88 @@ +--- +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
DescriptionResource Type definition for AWS::DirectoryService::SimpleAD
Idaws.directoryservice.simple_ads
+ +## Fields + + + + + +
NameDatatypeDescription
directory_idstringThe unique identifier for a directory.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +directory_id +FROM aws.directoryservice.simple_ads +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the simple_ads resource, the following permissions are required: + +### Create +```json +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 +```json +ds:DescribeDirectories +``` + diff --git a/docs/aws-docs/providers/aws/dms/data_provider/index.md b/docs/aws-docs/providers/aws/dms/data_provider/index.md new file mode 100644 index 0000000000..f52ff4cdc6 --- /dev/null +++ b/docs/aws-docs/providers/aws/dms/data_provider/index.md @@ -0,0 +1,109 @@ +--- +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
DescriptionResource schema for AWS::DMS::DataProvider
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +data_provider_name, +data_provider_identifier, +data_provider_arn, +data_provider_creation_time, +description, +engine, +exact_settings, +settings, +tags +FROM aws.dms.data_provider +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the data_provider resource, the following permissions are required: + +### Read +```json +dms:ListDataProviders, +dms:DescribeDataProviders, +dms:ListTagsForResource +``` + +### Update +```json +dms:UpdateDataProvider, +dms:ModifyDataProvider, +dms:AddTagsToResource, +dms:RemoveTagsToResource, +dms:ListTagsForResource +``` + +### Delete +```json +dms:DeleteDataProvider +``` + diff --git a/docs/aws-docs/providers/aws/dms/data_providers/index.md b/docs/aws-docs/providers/aws/dms/data_providers/index.md new file mode 100644 index 0000000000..d55d11a9ff --- /dev/null +++ b/docs/aws-docs/providers/aws/dms/data_providers/index.md @@ -0,0 +1,83 @@ +--- +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
DescriptionResource schema for AWS::DMS::DataProvider
Idaws.dms.data_providers
+ +## Fields + + + + + +
NameDatatypeDescription
data_provider_arnstringThe data provider ARN.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +data_provider_arn +FROM aws.dms.data_providers +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the data_providers resource, the following permissions are required: + +### Create +```json +dms:CreateDataProvider, +dms:ListDataProviders, +dms:DescribeDataProviders, +dms:AddTagsToResource, +dms:ListTagsForResource +``` + +### List +```json +dms:ListDataProviders, +dms:DescribeDataProviders, +dms:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/dms/index.md b/docs/aws-docs/providers/aws/dms/index.md new file mode 100644 index 0000000000..a5f6a259f7 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/dms/instance_profile/index.md b/docs/aws-docs/providers/aws/dms/instance_profile/index.md new file mode 100644 index 0000000000..4828ac5777 --- /dev/null +++ b/docs/aws-docs/providers/aws/dms/instance_profile/index.md @@ -0,0 +1,115 @@ +--- +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
DescriptionResource schema for AWS::DMS::InstanceProfile.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.dms.instance_profile +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the instance_profile resource, the following permissions are required: + +### Read +```json +dms:ListInstanceProfiles, +dms:DescribeInstanceProfiles, +dms:ListTagsForResource +``` + +### Update +```json +dms:UpdateInstanceProfile, +dms:ModifyInstanceProfile, +dms:AddTagsToResource, +dms:RemoveTagsToResource, +dms:ListTagsForResource +``` + +### Delete +```json +dms:DeleteInstanceProfile +``` + diff --git a/docs/aws-docs/providers/aws/dms/instance_profiles/index.md b/docs/aws-docs/providers/aws/dms/instance_profiles/index.md new file mode 100644 index 0000000000..0c64ce5d06 --- /dev/null +++ b/docs/aws-docs/providers/aws/dms/instance_profiles/index.md @@ -0,0 +1,83 @@ +--- +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
DescriptionResource schema for AWS::DMS::InstanceProfile.
Idaws.dms.instance_profiles
+ +## Fields + + + + + +
NameDatatypeDescription
instance_profile_arnstringThe property describes an ARN of the instance profile.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +instance_profile_arn +FROM aws.dms.instance_profiles +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the instance_profiles resource, the following permissions are required: + +### Create +```json +dms:CreateInstanceProfile, +dms:ListInstanceProfiles, +dms:DescribeInstanceProfiles, +dms:AddTagsToResource, +dms:ListTagsForResource +``` + +### List +```json +dms:ListInstanceProfiles, +dms:DescribeInstanceProfiles, +dms:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/dms/migration_project/index.md b/docs/aws-docs/providers/aws/dms/migration_project/index.md new file mode 100644 index 0000000000..1c08ea6672 --- /dev/null +++ b/docs/aws-docs/providers/aws/dms/migration_project/index.md @@ -0,0 +1,118 @@ +--- +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
DescriptionResource schema for AWS::DMS::MigrationProject
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.dms.migration_project +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the migration_project resource, the following permissions are required: + +### Read +```json +dms:DescribeMigrationProjects, +dms:ListMigrationProjects, +dms:ListTagsForResource +``` + +### Update +```json +dms:UpdateMigrationProject, +dms:ModifyMigrationProject, +dms:AddTagsToResource, +dms:RemoveTagsToResource, +dms:ListTagsForResource, +iam:PassRole +``` + +### Delete +```json +dms:DeleteMigrationProject +``` + diff --git a/docs/aws-docs/providers/aws/dms/migration_projects/index.md b/docs/aws-docs/providers/aws/dms/migration_projects/index.md new file mode 100644 index 0000000000..809b862d69 --- /dev/null +++ b/docs/aws-docs/providers/aws/dms/migration_projects/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionResource schema for AWS::DMS::MigrationProject
Idaws.dms.migration_projects
+ +## Fields + + + + + +
NameDatatypeDescription
migration_project_arnstringThe property describes an ARN of the migration project.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +migration_project_arn +FROM aws.dms.migration_projects +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the migration_projects resource, the following permissions are required: + +### Create +```json +dms:CreateMigrationProject, +dms:ListMigrationProjects, +dms:DescribeMigrationProjects, +dms:AddTagsToResource, +dms:ListTagsForResource, +iam:PassRole +``` + +### List +```json +dms:ListMigrationProjects, +dms:DescribeMigrationProjects, +dms:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/dms/replication_config/index.md b/docs/aws-docs/providers/aws/dms/replication_config/index.md new file mode 100644 index 0000000000..57b7759fe5 --- /dev/null +++ b/docs/aws-docs/providers/aws/dms/replication_config/index.md @@ -0,0 +1,119 @@ +--- +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
DescriptionA replication configuration that you later provide to configure and start a AWS DMS Serverless replication
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.dms.replication_config +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the replication_config resource, the following permissions are required: + +### Read +```json +dms:DescribeReplicationConfigs, +dms:ListTagsForResource +``` + +### Update +```json +dms:ModifyReplicationConfig, +dms:AddTagsToResource, +dms:RemoveTagsToResource, +dms:ListTagsForResource, +iam:CreateServiceLinkedRole, +iam:AttachRolePolicy, +iam:PutRolePolicy, +iam:UpdateRoleDescription +``` + +### Delete +```json +dms:DescribeReplicationConfigs, +dms:DeleteReplicationConfig, +dms:ListTagsForResource, +iam:DeleteServiceLinkedRole, +iam:GetServiceLinkedRoleDeletionStatus +``` + diff --git a/docs/aws-docs/providers/aws/dms/replication_configs/index.md b/docs/aws-docs/providers/aws/dms/replication_configs/index.md new file mode 100644 index 0000000000..e4b78513ab --- /dev/null +++ b/docs/aws-docs/providers/aws/dms/replication_configs/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionA replication configuration that you later provide to configure and start a AWS DMS Serverless replication
Idaws.dms.replication_configs
+ +## Fields + + + + + +
NameDatatypeDescription
replication_config_arnstringThe Amazon Resource Name (ARN) of the Replication Config
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +replication_config_arn +FROM aws.dms.replication_configs +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the replication_configs resource, the following permissions are required: + +### Create +```json +dms:CreateReplicationConfig, +dms:AddTagsToResource, +dms:ListTagsForResource, +iam:CreateServiceLinkedRole, +iam:AttachRolePolicy, +iam:PutRolePolicy, +iam:UpdateRoleDescription +``` + +### List +```json +dms:DescribeReplicationConfigs, +dms:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/docdbelastic/cluster/index.md b/docs/aws-docs/providers/aws/docdbelastic/cluster/index.md new file mode 100644 index 0000000000..ac93073b3a --- /dev/null +++ b/docs/aws-docs/providers/aws/docdbelastic/cluster/index.md @@ -0,0 +1,149 @@ +--- +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
DescriptionThe AWS::DocDBElastic::Cluster Amazon DocumentDB (with MongoDB compatibility) Elastic Scale resource describes a Cluster
Idaws.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
preferred_backup_windowstring
backup_retention_periodinteger
shard_instance_countinteger
kms_key_idstring
tagsarray
auth_typestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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, +preferred_backup_window, +backup_retention_period, +shard_instance_count, +kms_key_id, +tags, +auth_type +FROM aws.docdbelastic.cluster +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the cluster resource, the following permissions are required: + +### Read +```json +docdb-elastic:GetCluster, +docdb-elastic:ListTagsForResource +``` + +### Update +```json +docdb-elastic:UpdateCluster, +docdb-elastic:TagResource, +docdb-elastic:UntagResource, +docdb-elastic:GetCluster, +docdb-elastic:ListTagsForResource, +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 +```json +docdb-elastic:DeleteCluster, +docdb-elastic:GetCluster, +ec2:DescribeVpcEndpoints, +ec2:DeleteVpcEndpoints, +ec2:ModifyVpcEndpoint, +ec2:DescribeSecurityGroups, +ec2:DescribeSubnets, +ec2:DescribeVpcAttribute, +ec2:DescribeVpcs, +ec2:DescribeAvailabilityZones +``` + diff --git a/docs/aws-docs/providers/aws/docdbelastic/clusters/index.md b/docs/aws-docs/providers/aws/docdbelastic/clusters/index.md new file mode 100644 index 0000000000..bd5caaffb9 --- /dev/null +++ b/docs/aws-docs/providers/aws/docdbelastic/clusters/index.md @@ -0,0 +1,99 @@ +--- +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
DescriptionThe AWS::DocDBElastic::Cluster Amazon DocumentDB (with MongoDB compatibility) Elastic Scale resource describes a Cluster
Idaws.docdbelastic.clusters
+ +## Fields + + + + + +
NameDatatypeDescription
cluster_arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +cluster_arn +FROM aws.docdbelastic.clusters +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the clusters resource, the following permissions are required: + +### Create +```json +docdb-elastic:CreateCluster, +docdb-elastic:TagResource, +docdb-elastic:GetCluster, +docdb-elastic:ListTagsForResource, +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 +```json +docdb-elastic:ListClusters +``` + diff --git a/docs/aws-docs/providers/aws/docdbelastic/index.md b/docs/aws-docs/providers/aws/docdbelastic/index.md new file mode 100644 index 0000000000..f6ab3ef41d --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/dynamodb/global_table/index.md b/docs/aws-docs/providers/aws/dynamodb/global_table/index.md new file mode 100644 index 0000000000..247842f851 --- /dev/null +++ b/docs/aws-docs/providers/aws/dynamodb/global_table/index.md @@ -0,0 +1,166 @@ +--- +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
DescriptionVersion: None. Resource Type definition for AWS::DynamoDB::GlobalTable
Idaws.dynamodb.global_table
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
table_idstring
sse_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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +table_id, +sse_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 aws.dynamodb.global_table +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the global_table resource, the following permissions are required: + +### Read +```json +dynamodb:Describe*, +dynamodb:GetResourcePolicy, +application-autoscaling:Describe*, +cloudwatch:PutMetricData, +dynamodb:ListTagsOfResource, +kms:DescribeKey +``` + +### Update +```json +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 +```json +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 +``` + diff --git a/docs/aws-docs/providers/aws/dynamodb/global_tables/index.md b/docs/aws-docs/providers/aws/dynamodb/global_tables/index.md new file mode 100644 index 0000000000..7e3d219806 --- /dev/null +++ b/docs/aws-docs/providers/aws/dynamodb/global_tables/index.md @@ -0,0 +1,115 @@ +--- +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
DescriptionVersion: None. Resource Type definition for AWS::DynamoDB::GlobalTable
Idaws.dynamodb.global_tables
+ +## Fields + + + + + +
NameDatatypeDescription
table_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +table_name +FROM aws.dynamodb.global_tables +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the global_tables resource, the following permissions are required: + +### Create +```json +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 +```json +dynamodb:ListTables, +cloudwatch:PutMetricData +``` + diff --git a/docs/aws-docs/providers/aws/dynamodb/index.md b/docs/aws-docs/providers/aws/dynamodb/index.md new file mode 100644 index 0000000000..da59b72e32 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/dynamodb/table/index.md b/docs/aws-docs/providers/aws/dynamodb/table/index.md new file mode 100644 index 0000000000..f6e73e19f1 --- /dev/null +++ b/docs/aws-docs/providers/aws/dynamodb/table/index.md @@ -0,0 +1,155 @@ +--- +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
DescriptionThe ``AWS::DynamoDB::Table`` resource creates a DDB table. For more information, see [CreateTable](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_CreateTable.html) in the *API Reference*.<br/> You should be aware of the following behaviors when working with DDB tables:<br/> + CFNlong typically creates DDB tables in parallel. However, if your template includes multiple DDB tables with indexes, you must declare dependencies so that the tables are created sequentially. DDBlong limits the number of tables with secondary indexes that are in the creating state. If you create multiple tables with indexes at the same time, DDB returns an error and the stack operation fails. For an example, see [DynamoDB Table with a DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#aws-resource-dynamodb-table--examples--DynamoDB_Table_with_a_DependsOn_Attribute).<br/> <br/> Our guidance is to use the latest schema documented here for your CFNlong templates. This schema supports the provisioning of all table settings below. When using this schema in your CFNlong templates, please ensure that your Identity and Access Management (IAM) policies are updated with appropriate permissions to allow for the authorization of these setting changes.
Idaws.dynamodb.table
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
sse_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 values of global secondary indexes, you can update the table without interruption.<br/> + You can delete or add one global secondary index without interruption. If you do both in the same update (for example, by changing the index's logical ID), the update fails.
resource_policyobjectA resource-based policy document that contains permissions to add to the specified table. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html).<br/> When you attach a resource-based policy while creating a table, the policy creation is *strongly consistent*. For information about the considerations that you should keep in mind while attaching a resource-based policy, see [Resource-based policy considerations](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html).
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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +sse_specification, +kinesis_stream_specification, +stream_specification, +contributor_insights_specification, +import_source_specification, +point_in_time_recovery_specification, +provisioned_throughput, +table_name, +attribute_definitions, +billing_mode, +global_secondary_indexes, +resource_policy, +key_schema, +local_secondary_indexes, +arn, +stream_arn, +deletion_protection_enabled, +table_class, +tags, +time_to_live_specification +FROM aws.dynamodb.table +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the table resource, the following permissions are required: + +### Read +```json +dynamodb:DescribeTable, +dynamodb:DescribeContinuousBackups, +dynamodb:DescribeContributorInsights, +dynamodb:DescribeKinesisStreamingDestination, +dynamodb:ListTagsOfResource, +dynamodb:GetResourcePolicy +``` + +### Update +```json +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 +```json +dynamodb:DeleteTable, +dynamodb:DescribeTable +``` + diff --git a/docs/aws-docs/providers/aws/dynamodb/tables/index.md b/docs/aws-docs/providers/aws/dynamodb/tables/index.md new file mode 100644 index 0000000000..2e328c8009 --- /dev/null +++ b/docs/aws-docs/providers/aws/dynamodb/tables/index.md @@ -0,0 +1,112 @@ +--- +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
DescriptionThe ``AWS::DynamoDB::Table`` resource creates a DDB table. For more information, see [CreateTable](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_CreateTable.html) in the *API Reference*.<br/> You should be aware of the following behaviors when working with DDB tables:<br/> + CFNlong typically creates DDB tables in parallel. However, if your template includes multiple DDB tables with indexes, you must declare dependencies so that the tables are created sequentially. DDBlong limits the number of tables with secondary indexes that are in the creating state. If you create multiple tables with indexes at the same time, DDB returns an error and the stack operation fails. For an example, see [DynamoDB Table with a DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#aws-resource-dynamodb-table--examples--DynamoDB_Table_with_a_DependsOn_Attribute).<br/> <br/> Our guidance is to use the latest schema documented here for your CFNlong templates. This schema supports the provisioning of all table settings below. When using this schema in your CFNlong templates, please ensure that your Identity and Access Management (IAM) policies are updated with appropriate permissions to allow for the authorization of these setting changes.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +table_name +FROM aws.dynamodb.tables +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the tables resource, the following permissions are required: + +### Create +```json +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 +```json +dynamodb:ListTables +``` + diff --git a/docs/aws-docs/providers/aws/ec2/account_attributes/index.md b/docs/aws-docs/providers/aws/ec2/account_attributes/index.md deleted file mode 100644 index 7ae2e6da2c..0000000000 --- a/docs/aws-docs/providers/aws/ec2/account_attributes/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: account_attributes -hide_title: false -hide_table_of_contents: false -keywords: - - account_attributes - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameaccount_attributes
TypeResource
Idaws.ec2.account_attributes
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `attributeName` | `string` | The name of the account attribute. | -| `attributeValueSet` | `array` | The values for the account attribute. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `account_attributes_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2/address/index.md b/docs/aws-docs/providers/aws/ec2/address/index.md deleted file mode 100644 index 456aa48e56..0000000000 --- a/docs/aws-docs/providers/aws/ec2/address/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: address -hide_title: false -hide_table_of_contents: false -keywords: - - address - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameaddress
TypeResource
Idaws.ec2.address
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `address_Allocate` | `EXEC` | `region` | <p>Allocates an Elastic IP address to your Amazon Web Services account. After you allocate the Elastic IP address you can associate it with an instance or network interface. After you release an Elastic IP address, it is released to the IP address pool and can be allocated to a different Amazon Web Services account.</p> <p>You can allocate an Elastic IP address from an address pool owned by Amazon Web Services or from an address pool created from a public IPv4 address range that you have brought to Amazon Web Services for use with your Amazon Web Services resources using bring your own IP addresses (BYOIP). For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html">Bring Your Own IP Addresses (BYOIP)</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>[EC2-VPC] If you release an Elastic IP address, you might be able to recover it. You cannot recover an Elastic IP address that you released after it is allocated to another Amazon Web Services account. You cannot recover an Elastic IP address for EC2-Classic. To attempt to recover an Elastic IP address that you released, specify it in this operation.</p> <p>An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. By default, you can allocate 5 Elastic IP addresses for EC2-Classic per Region and 5 Elastic IP addresses for EC2-VPC per Region.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>You can allocate a carrier IP address which is a public IP address from a telecommunication carrier, to a network interface which resides in a subnet in a Wavelength Zone (for example an EC2 instance). </p> | -| `address_Associate` | `EXEC` | `region` | <p>Associates an Elastic IP address, or carrier IP address (for instances that are in subnets in Wavelength Zones) with an instance or a network interface. Before you can use an Elastic IP address, you must allocate it to your account.</p> <p>An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>[EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance. If you associate an Elastic IP address with an instance that has an existing Elastic IP address, the existing address is disassociated from the instance, but remains allocated to your account.</p> <p>[VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation. You cannot associate an Elastic IP address with an instance or network interface that has an existing Elastic IP address.</p> <p>[Subnets in Wavelength Zones] You can associate an IP address from the telecommunication carrier to the instance or network interface. </p> <p>You cannot associate an Elastic IP address with an interface in a different network border group.</p> <important> <p>This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error, and you may be charged for each time the Elastic IP address is remapped to the same instance. For more information, see the <i>Elastic IP Addresses</i> section of <a href="http://aws.amazon.com/ec2/pricing/">Amazon EC2 Pricing</a>.</p> </important> | -| `address_Disassociate` | `EXEC` | `region` | <p>Disassociates an Elastic IP address from the instance or network interface it's associated with.</p> <p>An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.</p> | -| `address_Release` | `EXEC` | `region` | <p>Releases the specified Elastic IP address.</p> <p>[EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. To disassociate an Elastic IP address without releasing it, use <a>DisassociateAddress</a>.</p> <p>[Nondefault VPC] You must use <a>DisassociateAddress</a> to disassociate the Elastic IP address before you can release it. Otherwise, Amazon EC2 returns an error (<code>InvalidIPAddress.InUse</code>).</p> <p>After releasing an Elastic IP address, it is released to the IP address pool. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you'll get an <code>AuthFailure</code> error if the address is already allocated to another Amazon Web Services account.</p> <p>[EC2-VPC] After you release an Elastic IP address for use in a VPC, you might be able to recover it. For more information, see <a>AllocateAddress</a>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2/address_attribute/index.md b/docs/aws-docs/providers/aws/ec2/address_attribute/index.md deleted file mode 100644 index 9eb6311796..0000000000 --- a/docs/aws-docs/providers/aws/ec2/address_attribute/index.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: address_attribute -hide_title: false -hide_table_of_contents: false -keywords: - - address_attribute - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameaddress_attribute
TypeResource
Idaws.ec2.address_attribute
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `address_attribute_Modify` | `EXEC` | `AllocationId, region` | Modifies an attribute of the specified Elastic IP address. For requirements, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html#Using_Elastic_Addressing_Reverse_DNS">Using reverse DNS for email applications</a>. | -| `address_attribute_Reset` | `EXEC` | `AllocationId, Attribute, region` | Resets the attribute of the specified IP address. For requirements, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html#Using_Elastic_Addressing_Reverse_DNS">Using reverse DNS for email applications</a>. | diff --git a/docs/aws-docs/providers/aws/ec2/address_to_classic/index.md b/docs/aws-docs/providers/aws/ec2/address_to_classic/index.md deleted file mode 100644 index 7369847320..0000000000 --- a/docs/aws-docs/providers/aws/ec2/address_to_classic/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: address_to_classic -hide_title: false -hide_table_of_contents: false -keywords: - - address_to_classic - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameaddress_to_classic
TypeResource
Idaws.ec2.address_to_classic
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `address_to_classic_Restore` | `EXEC` | `PublicIp, region` | diff --git a/docs/aws-docs/providers/aws/ec2/address_to_vpc/index.md b/docs/aws-docs/providers/aws/ec2/address_to_vpc/index.md deleted file mode 100644 index 38007bfd92..0000000000 --- a/docs/aws-docs/providers/aws/ec2/address_to_vpc/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: address_to_vpc -hide_title: false -hide_table_of_contents: false -keywords: - - address_to_vpc - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameaddress_to_vpc
TypeResource
Idaws.ec2.address_to_vpc
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `address_to_vpc_Move` | `EXEC` | `PublicIp, region` | diff --git a/docs/aws-docs/providers/aws/ec2/addresses/index.md b/docs/aws-docs/providers/aws/ec2/addresses/index.md deleted file mode 100644 index f8f6020491..0000000000 --- a/docs/aws-docs/providers/aws/ec2/addresses/index.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: addresses -hide_title: false -hide_table_of_contents: false -keywords: - - addresses - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameaddresses
TypeResource
Idaws.ec2.addresses
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `allocationId` | `string` | The ID representing the allocation of the address for use with EC2-VPC. | -| `associationId` | `string` | The ID representing the association of the address with an instance in a VPC. | -| `carrierIp` | `string` | The carrier IP address associated. This option is only available for network interfaces which reside in a subnet in a Wavelength Zone (for example an EC2 instance). | -| `customerOwnedIp` | `string` | The customer-owned IP address. | -| `customerOwnedIpv4Pool` | `string` | The ID of the customer-owned address pool. | -| `domain` | `string` | Indicates whether this Elastic IP address is for use with instances in EC2-Classic (<code>standard</code>) or instances in a VPC (<code>vpc</code>). | -| `instanceId` | `string` | The ID of the instance that the address is associated with (if any). | -| `networkBorderGroup` | `string` | The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses. | -| `networkInterfaceId` | `string` | The ID of the network interface. | -| `networkInterfaceOwnerId` | `string` | The ID of the Amazon Web Services account that owns the network interface. | -| `privateIpAddress` | `string` | The private IP address associated with the Elastic IP address. | -| `publicIp` | `string` | The Elastic IP address. | -| `publicIpv4Pool` | `string` | The ID of an address pool. | -| `tagSet` | `array` | Any tags assigned to the Elastic IP address. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `addresses_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2/addresses_attribute/index.md b/docs/aws-docs/providers/aws/ec2/addresses_attribute/index.md deleted file mode 100644 index 95821f8e4d..0000000000 --- a/docs/aws-docs/providers/aws/ec2/addresses_attribute/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: addresses_attribute -hide_title: false -hide_table_of_contents: false -keywords: - - addresses_attribute - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameaddresses_attribute
TypeResource
Idaws.ec2.addresses_attribute
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `allocationId` | `string` | [EC2-VPC] The allocation ID. | -| `ptrRecord` | `string` | The pointer (PTR) record for the IP address. | -| `ptrRecordUpdate` | `object` | The status of an updated pointer (PTR) record for an Elastic IP address. | -| `publicIp` | `string` | The public IP address. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `addresses_attribute_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2/aggregate_id_format/index.md b/docs/aws-docs/providers/aws/ec2/aggregate_id_format/index.md deleted file mode 100644 index bf46b65ee5..0000000000 --- a/docs/aws-docs/providers/aws/ec2/aggregate_id_format/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: aggregate_id_format -hide_title: false -hide_table_of_contents: false -keywords: - - aggregate_id_format - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameaggregate_id_format
TypeResource
Idaws.ec2.aggregate_id_format
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `deadline` | `string` | The date in UTC at which you are permanently switched over to using longer IDs. If a deadline is not yet available for this resource type, this field is not returned. | -| `resource` | `string` | The type of resource. | -| `useLongIds` | `boolean` | Indicates whether longer IDs (17-character IDs) are enabled for the resource. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `aggregate_id_format_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2/associated_enclave_certificate_iam_roles/index.md b/docs/aws-docs/providers/aws/ec2/associated_enclave_certificate_iam_roles/index.md deleted file mode 100644 index c01cf125e3..0000000000 --- a/docs/aws-docs/providers/aws/ec2/associated_enclave_certificate_iam_roles/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: associated_enclave_certificate_iam_roles -hide_title: false -hide_table_of_contents: false -keywords: - - associated_enclave_certificate_iam_roles - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameassociated_enclave_certificate_iam_roles
TypeResource
Idaws.ec2.associated_enclave_certificate_iam_roles
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `associatedRoleArn` | `string` | The ARN of the associated IAM role. | -| `certificateS3BucketName` | `string` | The name of the Amazon S3 bucket in which the Amazon S3 object is stored. | -| `certificateS3ObjectKey` | `string` | The key of the Amazon S3 object ey where the certificate, certificate chain, and encrypted private key bundle is stored. The object key is formated as follows: <code>role_arn</code>/<code>certificate_arn</code>. | -| `encryptionKmsKeyId` | `string` | The ID of the KMS customer master key (CMK) used to encrypt the private key. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `associated_enclave_certificate_iam_roles_Get` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2/associated_ipv6_pool_cidrs/index.md b/docs/aws-docs/providers/aws/ec2/associated_ipv6_pool_cidrs/index.md deleted file mode 100644 index 82e6411676..0000000000 --- a/docs/aws-docs/providers/aws/ec2/associated_ipv6_pool_cidrs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: associated_ipv6_pool_cidrs -hide_title: false -hide_table_of_contents: false -keywords: - - associated_ipv6_pool_cidrs - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameassociated_ipv6_pool_cidrs
TypeResource
Idaws.ec2.associated_ipv6_pool_cidrs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `associatedResource` | `string` | The resource that's associated with the IPv6 CIDR block. | -| `ipv6Cidr` | `string` | The IPv6 CIDR block. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `associated_ipv6_pool_cidrs_Get` | `SELECT` | `PoolId, region` | diff --git a/docs/aws-docs/providers/aws/ec2/availability_zone_group/index.md b/docs/aws-docs/providers/aws/ec2/availability_zone_group/index.md deleted file mode 100644 index 6d38ce54a8..0000000000 --- a/docs/aws-docs/providers/aws/ec2/availability_zone_group/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: availability_zone_group -hide_title: false -hide_table_of_contents: false -keywords: - - availability_zone_group - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameavailability_zone_group
TypeResource
Idaws.ec2.availability_zone_group
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `availability_zone_group_Modify` | `EXEC` | `GroupName, OptInStatus, region` | diff --git a/docs/aws-docs/providers/aws/ec2/availability_zones/index.md b/docs/aws-docs/providers/aws/ec2/availability_zones/index.md deleted file mode 100644 index 8bc30d2c18..0000000000 --- a/docs/aws-docs/providers/aws/ec2/availability_zones/index.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: availability_zones -hide_title: false -hide_table_of_contents: false -keywords: - - availability_zones - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameavailability_zones
TypeResource
Idaws.ec2.availability_zones
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `groupName` | `string` | <p> For Availability Zones, this parameter has the same value as the Region name.</p> <p>For Local Zones, the name of the associated group, for example <code>us-west-2-lax-1</code>.</p> <p>For Wavelength Zones, the name of the associated group, for example <code>us-east-1-wl1-bos-wlz-1</code>.</p> | -| `messageSet` | `array` | Any messages about the Availability Zone, Local Zone, or Wavelength Zone. | -| `networkBorderGroup` | `string` | The name of the network border group. | -| `optInStatus` | `string` | <p>For Availability Zones, this parameter always has the value of <code>opt-in-not-required</code>.</p> <p>For Local Zones and Wavelength Zones, this parameter is the opt-in status. The possible values are <code>opted-in</code>, and <code>not-opted-in</code>.</p> | -| `parentZoneId` | `string` | The ID of the zone that handles some of the Local Zone or Wavelength Zone control plane operations, such as API calls. | -| `parentZoneName` | `string` | The name of the zone that handles some of the Local Zone or Wavelength Zone control plane operations, such as API calls. | -| `regionName` | `string` | The name of the Region. | -| `zoneId` | `string` | The ID of the Availability Zone, Local Zone, or Wavelength Zone. | -| `zoneName` | `string` | The name of the Availability Zone, Local Zone, or Wavelength Zone. | -| `zoneState` | `string` | The state of the Availability Zone, Local Zone, or Wavelength Zone. This value is always <code>available</code>. | -| `zoneType` | `string` | The type of zone. The valid values are <code>availability-zone</code>, <code>local-zone</code>, and <code>wavelength-zone</code>. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `availability_zones_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2/bundle_tasks/index.md b/docs/aws-docs/providers/aws/ec2/bundle_tasks/index.md deleted file mode 100644 index b10c82037c..0000000000 --- a/docs/aws-docs/providers/aws/ec2/bundle_tasks/index.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: bundle_tasks -hide_title: false -hide_table_of_contents: false -keywords: - - bundle_tasks - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namebundle_tasks
TypeResource
Idaws.ec2.bundle_tasks
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `bundleId` | `string` | The ID of the bundle task. | -| `error` | `object` | Describes an error for <a>BundleInstance</a>. | -| `instanceId` | `string` | The ID of the instance associated with this bundle task. | -| `progress` | `string` | The level of task completion, as a percent (for example, 20%). | -| `startTime` | `string` | The time this task started. | -| `state` | `string` | The state of the task. | -| `storage` | `object` | Describes the storage location for an instance store-backed AMI. | -| `updateTime` | `string` | The time of the most recent update for the task. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `bundle_tasks_Describe` | `SELECT` | `region` | <p>Describes the specified bundle tasks or all of your bundle tasks.</p> <note> <p>Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use <code>RegisterImage</code> with the Amazon S3 bucket name and image manifest name you provided to the bundle task.</p> </note> | -| `bundle_task_Cancel` | `EXEC` | `BundleId, region` | Cancels a bundling operation for an instance store-backed Windows instance. | diff --git a/docs/aws-docs/providers/aws/ec2/byoip_cidr_to_ipam/index.md b/docs/aws-docs/providers/aws/ec2/byoip_cidr_to_ipam/index.md deleted file mode 100644 index 9c43931dc7..0000000000 --- a/docs/aws-docs/providers/aws/ec2/byoip_cidr_to_ipam/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: byoip_cidr_to_ipam -hide_title: false -hide_table_of_contents: false -keywords: - - byoip_cidr_to_ipam - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namebyoip_cidr_to_ipam
TypeResource
Idaws.ec2.byoip_cidr_to_ipam
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `byoip_cidr_to_ipam_Move` | `EXEC` | `Cidr, IpamPoolId, IpamPoolOwner, region` | diff --git a/docs/aws-docs/providers/aws/ec2/byoip_cidrs/index.md b/docs/aws-docs/providers/aws/ec2/byoip_cidrs/index.md deleted file mode 100644 index 02be753271..0000000000 --- a/docs/aws-docs/providers/aws/ec2/byoip_cidrs/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: byoip_cidrs -hide_title: false -hide_table_of_contents: false -keywords: - - byoip_cidrs - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namebyoip_cidrs
TypeResource
Idaws.ec2.byoip_cidrs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `description` | `string` | The description of the address range. | -| `cidr` | `string` | The address range, in CIDR notation. | -| `state` | `string` | The state of the address pool. | -| `statusMessage` | `string` | Upon success, contains the ID of the address pool. Otherwise, contains an error message. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `byoip_cidrs_Describe` | `SELECT` | `MaxResults, region` | <p>Describes the IP address ranges that were specified in calls to <a>ProvisionByoipCidr</a>.</p> <p>To describe the address pools that were created when you provisioned the address ranges, use <a>DescribePublicIpv4Pools</a> or <a>DescribeIpv6Pools</a>.</p> | -| `byoip_cidr_Advertise` | `EXEC` | `Cidr, region` | <p>Advertises an IPv4 or IPv6 address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP).</p> <p>You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.</p> <p>We recommend that you stop advertising the BYOIP CIDR from other locations when you advertise it from Amazon Web Services. To minimize down time, you can configure your Amazon Web Services resources to use an address from a BYOIP CIDR before it is advertised, and then simultaneously stop advertising it from the current location and start advertising it through Amazon Web Services.</p> <p>It can take a few minutes before traffic to the specified addresses starts routing to Amazon Web Services because of BGP propagation delays.</p> <p>To stop advertising the BYOIP CIDR, use <a>WithdrawByoipCidr</a>.</p> | -| `byoip_cidr_Deprovision` | `EXEC` | `Cidr, region` | <p>Releases the specified address range that you provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool.</p> <p>Before you can release an address range, you must stop advertising it using <a>WithdrawByoipCidr</a> and you must not have any IP addresses allocated from its address range.</p> | -| `byoip_cidr_Provision` | `EXEC` | `Cidr, region` | <p>Provisions an IPv4 or IPv6 address range for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised using <a>AdvertiseByoipCidr</a>.</p> <p>Amazon Web Services verifies that you own the address range and are authorized to advertise it. You must ensure that the address range is registered to you and that you created an RPKI ROA to authorize Amazon ASNs 16509 and 14618 to advertise the address range. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html">Bring your own IP addresses (BYOIP)</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>Provisioning an address range is an asynchronous operation, so the call returns immediately, but the address range is not ready to use until its status changes from <code>pending-provision</code> to <code>provisioned</code>. To monitor the status of an address range, use <a>DescribeByoipCidrs</a>. To allocate an Elastic IP address from your IPv4 address pool, use <a>AllocateAddress</a> with either the specific address from the address pool or the ID of the address pool.</p> | -| `byoip_cidr_Withdraw` | `EXEC` | `Cidr, region` | <p>Stops advertising an address range that is provisioned as an address pool.</p> <p>You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.</p> <p>It can take a few minutes before traffic to the specified addresses stops routing to Amazon Web Services because of BGP propagation delays.</p> | diff --git a/docs/aws-docs/providers/aws/ec2/capacity_reservation/index.md b/docs/aws-docs/providers/aws/ec2/capacity_reservation/index.md new file mode 100644 index 0000000000..37c189a30a --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/capacity_reservation/index.md @@ -0,0 +1,125 @@ +--- +title: capacity_reservation +hide_title: false +hide_table_of_contents: false +keywords: + - capacity_reservation + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual capacity_reservation resource + +## Overview + + + + + +
Namecapacity_reservation
TypeResource
DescriptionResource Type definition for AWS::EC2::CapacityReservation
Idaws.ec2.capacity_reservation
+ +## Fields + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
tenancystring
end_date_typestring
tag_specificationsarray
availability_zonestring
total_instance_countinteger
end_datestring
ebs_optimizedboolean
out_post_arnstring
instance_countinteger
placement_group_arnstring
available_instance_countinteger
instance_platformstring
idstring
instance_typestring
ephemeral_storageboolean
instance_match_criteriastring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +tenancy, +end_date_type, +tag_specifications, +availability_zone, +total_instance_count, +end_date, +ebs_optimized, +out_post_arn, +instance_count, +placement_group_arn, +available_instance_count, +instance_platform, +id, +instance_type, +ephemeral_storage, +instance_match_criteria +FROM aws.ec2.capacity_reservation +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the capacity_reservation resource, the following permissions are required: + +### Delete +```json +ec2:CreateCapacityReservation, +ec2:DescribeCapacityReservations, +ec2:CancelCapacityReservation, +ec2:DeleteTags +``` + +### Read +```json +ec2:DescribeCapacityReservations +``` + +### Update +```json +ec2:ModifyCapacityReservation, +ec2:CreateCapacityReservation, +ec2:DescribeCapacityReservations, +ec2:CancelCapacityReservation, +ec2:CreateTags, +ec2:DeleteTags +``` + diff --git a/docs/aws-docs/providers/aws/ec2/capacity_reservation_fleet/index.md b/docs/aws-docs/providers/aws/ec2/capacity_reservation_fleet/index.md new file mode 100644 index 0000000000..8f6911aa0f --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/capacity_reservation_fleet/index.md @@ -0,0 +1,123 @@ +--- +title: capacity_reservation_fleet +hide_title: false +hide_table_of_contents: false +keywords: + - capacity_reservation_fleet + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual capacity_reservation_fleet resource + +## Overview + + + + + +
Namecapacity_reservation_fleet
TypeResource
DescriptionResource Type definition for AWS::EC2::CapacityReservationFleet
Idaws.ec2.capacity_reservation_fleet
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
allocation_strategystring
tag_specificationsarray
instance_type_specificationsarray
total_target_capacityinteger
end_datestring
instance_match_criteriastring
capacity_reservation_fleet_idstring
tenancystring
remove_end_dateboolean
no_remove_end_dateboolean
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +allocation_strategy, +tag_specifications, +instance_type_specifications, +total_target_capacity, +end_date, +instance_match_criteria, +capacity_reservation_fleet_id, +tenancy, +remove_end_date, +no_remove_end_date +FROM aws.ec2.capacity_reservation_fleet +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the capacity_reservation_fleet resource, the following permissions are required: + +### Delete +```json +ec2:CreateCapacityReservationFleet, +ec2:ModifyCapacityReservationFleet, +ec2:DescribeCapacityReservationFleets, +ec2:CancelCapacityReservationFleets, +ec2:CreateCapacityReservation, +ec2:DescribeCapacityReservations, +ec2:CancelCapacityReservation, +ec2:DeleteTags +``` + +### Read +```json +ec2:DescribeCapacityReservationFleets, +ec2:DescribeInstances, +ec2:DescribeCapacityReservations +``` + +### Update +```json +ec2:CreateCapacityReservationFleet, +ec2:ModifyCapacityReservationFleet, +ec2:DescribeCapacityReservationFleets, +ec2:CancelCapacityReservationFleets, +ec2:CreateCapacityReservation, +ec2:ModifyCapacityReservation, +ec2:DescribeCapacityReservations, +ec2:CancelCapacityReservation, +ec2:DescribeInstances, +ec2:DeleteTags +``` + diff --git a/docs/aws-docs/providers/aws/ec2/capacity_reservation_fleets/index.md b/docs/aws-docs/providers/aws/ec2/capacity_reservation_fleets/index.md index 5bc8066a94..06e3da8005 100644 --- a/docs/aws-docs/providers/aws/ec2/capacity_reservation_fleets/index.md +++ b/docs/aws-docs/providers/aws/ec2/capacity_reservation_fleets/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - capacity_reservation_fleets - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,35 +14,75 @@ description: Query, deploy 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_reservation_fleets in a region ## Overview +
Namecapacity_reservation_fleets
TypeResource
DescriptionResource Type definition for AWS::EC2::CapacityReservationFleet
Idaws.ec2.capacity_reservation_fleets
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `allocationStrategy` | `string` | The strategy used by the Capacity Reservation Fleet to determine which of the specified instance types to use. For more information, see For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#allocation-strategy"> Allocation strategy</a> in the Amazon EC2 User Guide. | -| `capacityReservationFleetArn` | `string` | The ARN of the Capacity Reservation Fleet. | -| `capacityReservationFleetId` | `string` | The ID of the Capacity Reservation Fleet. | -| `createTime` | `string` | The date and time at which the Capacity Reservation Fleet was created. | -| `endDate` | `string` | The date and time at which the Capacity Reservation Fleet expires. | -| `instanceMatchCriteria` | `string` | <p>Indicates the type of instance launches that the Capacity Reservation Fleet accepts. All Capacity Reservations in the Fleet inherit this instance matching criteria.</p> <p>Currently, Capacity Reservation Fleets support <code>open</code> instance matching criteria only. This means that instances that have matching attributes (instance type, platform, and Availability Zone) run in the Capacity Reservations automatically. Instances do not need to explicitly target a Capacity Reservation Fleet to use its reserved capacity.</p> | -| `instanceTypeSpecificationSet` | `array` | Information about the instance types for which to reserve the capacity. | -| `state` | `string` | <p>The state of the Capacity Reservation Fleet. Possible states include:</p> <ul> <li> <p> <code>submitted</code> - The Capacity Reservation Fleet request has been submitted and Amazon Elastic Compute Cloud is preparing to create the Capacity Reservations.</p> </li> <li> <p> <code>modifying</code> - The Capacity Reservation Fleet is being modified. The Fleet remains in this state until the modification is complete.</p> </li> <li> <p> <code>active</code> - The Capacity Reservation Fleet has fulfilled its total target capacity and it is attempting to maintain this capacity. The Fleet remains in this state until it is modified or deleted.</p> </li> <li> <p> <code>partially_fulfilled</code> - The Capacity Reservation Fleet has partially fulfilled its total target capacity. There is insufficient Amazon EC2 to fulfill the total target capacity. The Fleet is attempting to asynchronously fulfill its total target capacity.</p> </li> <li> <p> <code>expiring</code> - The Capacity Reservation Fleet has reach its end date and it is in the process of expiring. One or more of its Capacity reservations might still be active.</p> </li> <li> <p> <code>expired</code> - The Capacity Reservation Fleet has reach its end date. The Fleet and its Capacity Reservations are expired. The Fleet can't create new Capacity Reservations.</p> </li> <li> <p> <code>cancelling</code> - The Capacity Reservation Fleet is in the process of being cancelled. One or more of its Capacity reservations might still be active.</p> </li> <li> <p> <code>cancelled</code> - The Capacity Reservation Fleet has been manually cancelled. The Fleet and its Capacity Reservations are cancelled and the Fleet can't create new Capacity Reservations.</p> </li> <li> <p> <code>failed</code> - The Capacity Reservation Fleet failed to reserve capacity for the specified instance types.</p> </li> </ul> | -| `tagSet` | `array` | The tags assigned to the Capacity Reservation Fleet. | -| `tenancy` | `string` | <p>The tenancy of the Capacity Reservation Fleet. Tenancies include:</p> <ul> <li> <p> <code>default</code> - The Capacity Reservation Fleet is created on hardware that is shared with other Amazon Web Services accounts.</p> </li> <li> <p> <code>dedicated</code> - The Capacity Reservation Fleet is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.</p> </li> </ul> | -| `totalFulfilledCapacity` | `number` | The capacity units that have been fulfilled. | -| `totalTargetCapacity` | `integer` | The total number of capacity units for which the Capacity Reservation Fleet reserves capacity. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#target-capacity">Total target capacity</a> in the Amazon EC2 User Guide. | + + + + + +
NameDatatypeDescription
capacity_reservation_fleet_idstring
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `capacity_reservation_fleets_Describe` | `SELECT` | `region` | Describes one or more Capacity Reservation Fleets. | -| `capacity_reservation_fleet_Create` | `EXEC` | `InstanceTypeSpecification, TotalTargetCapacity, region` | Creates a Capacity Reservation Fleet. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/work-with-cr-fleets.html#create-crfleet">Create a Capacity Reservation Fleet</a> in the Amazon EC2 User Guide. | -| `capacity_reservation_fleet_Modify` | `EXEC` | `CapacityReservationFleetId, region` | <p>Modifies a Capacity Reservation Fleet.</p> <p>When you modify the total target capacity of a Capacity Reservation Fleet, the Fleet automatically creates new Capacity Reservations, or modifies or cancels existing Capacity Reservations in the Fleet to meet the new total target capacity. When you modify the end date for the Fleet, the end dates for all of the individual Capacity Reservations in the Fleet are updated accordingly.</p> | -| `capacity_reservation_fleets_Cancel` | `EXEC` | `CapacityReservationFleetId, region` | <p>Cancels one or more Capacity Reservation Fleets. When you cancel a Capacity Reservation Fleet, the following happens:</p> <ul> <li> <p>The Capacity Reservation Fleet's status changes to <code>cancelled</code>.</p> </li> <li> <p>The individual Capacity Reservations in the Fleet are cancelled. Instances running in the Capacity Reservations at the time of cancelling the Fleet continue to run in shared capacity.</p> </li> <li> <p>The Fleet stops creating new Capacity Reservations.</p> </li> </ul> | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +capacity_reservation_fleet_id +FROM aws.ec2.capacity_reservation_fleets +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the capacity_reservation_fleets resource, the following permissions are required: + +### Create +```json +ec2:CreateCapacityReservationFleet, +ec2:ModifyCapacityReservationFleet, +ec2:DescribeCapacityReservationFleets, +ec2:CancelCapacityReservationFleets, +ec2:CreateCapacityReservation, +ec2:DescribeCapacityReservations, +ec2:CancelCapacityReservation, +ec2:DescribeInstances, +ec2:CreateTags, +iam:CreateServiceLinkedRole +``` + +### List +```json +ec2:DescribeCapacityReservationFleets, +ec2:DescribeCapacityReservations, +ec2:DescribeInstances +``` + diff --git a/docs/aws-docs/providers/aws/ec2/capacity_reservation_usage/index.md b/docs/aws-docs/providers/aws/ec2/capacity_reservation_usage/index.md deleted file mode 100644 index b8183a5f95..0000000000 --- a/docs/aws-docs/providers/aws/ec2/capacity_reservation_usage/index.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: capacity_reservation_usage -hide_title: false -hide_table_of_contents: false -keywords: - - capacity_reservation_usage - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namecapacity_reservation_usage
TypeResource
Idaws.ec2.capacity_reservation_usage
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `availableInstanceCount` | `integer` | The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation. | -| `capacityReservationId` | `string` | The ID of the Capacity Reservation. | -| `instanceType` | `string` | The type of instance for which the Capacity Reservation reserves capacity. | -| `instanceUsageSet` | `array` | Information about the Capacity Reservation usage. | -| `nextToken` | `string` | The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return. | -| `state` | `string` | <p>The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:</p> <ul> <li> <p> <code>active</code> - The Capacity Reservation is active and the capacity is available for your use.</p> </li> <li> <p> <code>expired</code> - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.</p> </li> <li> <p> <code>cancelled</code> - The Capacity Reservation was cancelled. The reserved capacity is no longer available for your use.</p> </li> <li> <p> <code>pending</code> - The Capacity Reservation request was successful but the capacity provisioning is still pending.</p> </li> <li> <p> <code>failed</code> - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.</p> </li> </ul> | -| `totalInstanceCount` | `integer` | The number of instances for which the Capacity Reservation reserves capacity. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `capacity_reservation_usage_Get` | `SELECT` | `CapacityReservationId, region` | diff --git a/docs/aws-docs/providers/aws/ec2/capacity_reservations/index.md b/docs/aws-docs/providers/aws/ec2/capacity_reservations/index.md index 4323228953..f8aaaffdb2 100644 --- a/docs/aws-docs/providers/aws/ec2/capacity_reservations/index.md +++ b/docs/aws-docs/providers/aws/ec2/capacity_reservations/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - capacity_reservations - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,45 +14,67 @@ description: Query, deploy 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
DescriptionResource Type definition for AWS::EC2::CapacityReservation
Idaws.ec2.capacity_reservations
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `availabilityZone` | `string` | The Availability Zone in which the capacity is reserved. | -| `availabilityZoneId` | `string` | The Availability Zone ID of the Capacity Reservation. | -| `availableInstanceCount` | `integer` | The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation. | -| `capacityReservationArn` | `string` | The Amazon Resource Name (ARN) of the Capacity Reservation. | -| `capacityReservationFleetId` | `string` | The ID of the Capacity Reservation Fleet to which the Capacity Reservation belongs. Only valid for Capacity Reservations that were created by a Capacity Reservation Fleet. | -| `capacityReservationId` | `string` | The ID of the Capacity Reservation. | -| `createDate` | `string` | The date and time at which the Capacity Reservation was created. | -| `ebsOptimized` | `boolean` | Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS- optimized instance. | -| `endDate` | `string` | The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to <code>expired</code> when it reaches its end date and time. | -| `endDateType` | `string` | <p>Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:</p> <ul> <li> <p> <code>unlimited</code> - The Capacity Reservation remains active until you explicitly cancel it.</p> </li> <li> <p> <code>limited</code> - The Capacity Reservation expires automatically at a specified date and time.</p> </li> </ul> | -| `ephemeralStorage` | `boolean` | Indicates whether the Capacity Reservation supports instances with temporary, block-level storage. | -| `instanceMatchCriteria` | `string` | <p>Indicates the type of instance launches that the Capacity Reservation accepts. The options include:</p> <ul> <li> <p> <code>open</code> - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation automatically without specifying any additional parameters.</p> </li> <li> <p> <code>targeted</code> - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity. </p> </li> </ul> | -| `instancePlatform` | `string` | The type of operating system for which the Capacity Reservation reserves capacity. | -| `instanceType` | `string` | The type of instance for which the Capacity Reservation reserves capacity. | -| `outpostArn` | `string` | The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created. | -| `ownerId` | `string` | The ID of the Amazon Web Services account that owns the Capacity Reservation. | -| `placementGroupArn` | `string` | The Amazon Resource Name (ARN) of the cluster placement group in which the Capacity Reservation was created. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/cr-cpg.html"> Capacity Reservations for cluster placement groups</a> in the <i>Amazon EC2 User Guide</i>. | -| `startDate` | `string` | The date and time at which the Capacity Reservation was started. | -| `state` | `string` | <p>The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:</p> <ul> <li> <p> <code>active</code> - The Capacity Reservation is active and the capacity is available for your use.</p> </li> <li> <p> <code>expired</code> - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.</p> </li> <li> <p> <code>cancelled</code> - The Capacity Reservation was cancelled. The reserved capacity is no longer available for your use.</p> </li> <li> <p> <code>pending</code> - The Capacity Reservation request was successful but the capacity provisioning is still pending.</p> </li> <li> <p> <code>failed</code> - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.</p> </li> </ul> | -| `tagSet` | `array` | Any tags assigned to the Capacity Reservation. | -| `tenancy` | `string` | <p>Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:</p> <ul> <li> <p> <code>default</code> - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.</p> </li> <li> <p> <code>dedicated</code> - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.</p> </li> </ul> | -| `totalInstanceCount` | `integer` | The total number of instances for which the Capacity Reservation reserves capacity. | + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `capacity_reservations_Describe` | `SELECT` | `region` | Describes one or more of your Capacity Reservations. The results describe only the Capacity Reservations in the Amazon Web Services Region that you're currently using. | -| `capacity_reservation_Cancel` | `EXEC` | `CapacityReservationId, region` | <p>Cancels the specified Capacity Reservation, releases the reserved capacity, and changes the Capacity Reservation's state to <code>cancelled</code>.</p> <p>Instances running in the reserved capacity continue running until you stop them. Stopped instances that target the Capacity Reservation can no longer launch. Modify these instances to either target a different Capacity Reservation, launch On-Demand Instance capacity, or run in any open Capacity Reservation that has matching attributes and sufficient capacity.</p> | -| `capacity_reservation_Create` | `EXEC` | `InstanceCount, InstancePlatform, InstanceType, region` | <p>Creates a new Capacity Reservation with the specified attributes.</p> <p>Capacity Reservations enable you to reserve capacity for your Amazon EC2 instances in a specific Availability Zone for any duration. This gives you the flexibility to selectively add capacity reservations and still get the Regional RI discounts for that usage. By creating Capacity Reservations, you ensure that you always have access to Amazon EC2 capacity when you need it, for as long as you need it. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-capacity-reservations.html">Capacity Reservations</a> in the <i>Amazon EC2 User Guide</i>.</p> <p>Your request to create a Capacity Reservation could fail if Amazon EC2 does not have sufficient capacity to fulfill the request. If your request fails due to Amazon EC2 capacity constraints, either try again at a later time, try in a different Availability Zone, or request a smaller capacity reservation. If your application is flexible across instance types and sizes, try to create a Capacity Reservation with different instance attributes.</p> <p>Your request could also fail if the requested quantity exceeds your On-Demand Instance limit for the selected instance type. If your request fails due to limit constraints, increase your On-Demand Instance limit for the required instance type and try again. For more information about increasing your instance limits, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-resource-limits.html">Amazon EC2 Service Quotas</a> in the <i>Amazon EC2 User Guide</i>.</p> | -| `capacity_reservation_Modify` | `EXEC` | `CapacityReservationId, region` | Modifies a Capacity Reservation's capacity and the conditions under which it is to be released. You cannot change a Capacity Reservation's instance type, EBS optimization, instance store settings, platform, Availability Zone, or instance eligibility. If you need to modify any of these attributes, we recommend that you cancel the Capacity Reservation, and then create a new one with the required attributes. | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.ec2.capacity_reservations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the capacity_reservations resource, the following permissions are required: + +### Create +```json +ec2:CreateCapacityReservation, +ec2:DescribeCapacityReservations, +ec2:CancelCapacityReservation, +ec2:CreateTags +``` + +### List +```json +ec2:DescribeCapacityReservations +``` + diff --git a/docs/aws-docs/providers/aws/ec2/carrier_gateway/index.md b/docs/aws-docs/providers/aws/ec2/carrier_gateway/index.md new file mode 100644 index 0000000000..868456c039 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/carrier_gateway/index.md @@ -0,0 +1,98 @@ +--- +title: carrier_gateway +hide_title: false +hide_table_of_contents: false +keywords: + - carrier_gateway + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual carrier_gateway resource + +## Overview + + + + + +
Namecarrier_gateway
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Idaws.ec2.carrier_gateway
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
carrier_gateway_idstringThe ID of the carrier gateway.
statestringThe state of the carrier gateway.
vpc_idstringThe ID of the VPC.
owner_idstringThe ID of the owner.
tagsarrayThe tags for the carrier gateway.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +carrier_gateway_id, +state, +vpc_id, +owner_id, +tags +FROM aws.ec2.carrier_gateway +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the carrier_gateway resource, the following permissions are required: + +### Read +```json +ec2:DescribeCarrierGateways +``` + +### Update +```json +ec2:DescribeCarrierGateways, +ec2:CreateTags, +ec2:DeleteTags +``` + +### Delete +```json +ec2:DeleteCarrierGateway, +ec2:DescribeCarrierGateways +``` + diff --git a/docs/aws-docs/providers/aws/ec2/carrier_gateways/index.md b/docs/aws-docs/providers/aws/ec2/carrier_gateways/index.md index 5d5dfb787e..858234e13c 100644 --- a/docs/aws-docs/providers/aws/ec2/carrier_gateways/index.md +++ b/docs/aws-docs/providers/aws/ec2/carrier_gateways/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - carrier_gateways - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,27 +14,66 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- - - +Retrieves a list of carrier_gateways in a region ## Overview +
Namecarrier_gateways
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Idaws.ec2.carrier_gateways
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `carrierGatewayId` | `string` | The ID of the carrier gateway. | -| `ownerId` | `string` | The Amazon Web Services account ID of the owner of the carrier gateway. | -| `state` | `string` | The state of the carrier gateway. | -| `tagSet` | `array` | The tags assigned to the carrier gateway. | -| `vpcId` | `string` | The ID of the VPC associated with the carrier gateway. | + + + + + +
NameDatatypeDescription
carrier_gateway_idstringThe ID of the carrier gateway.
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `carrier_gateways_Describe` | `SELECT` | `region` | Describes one or more of your carrier gateways. | -| `carrier_gateway_Delete` | `DELETE` | `CarrierGatewayId, region` | <p>Deletes a carrier gateway.</p> <important> <p>If you do not delete the route that contains the carrier gateway as the Target, the route is a blackhole route. For information about how to delete a route, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeleteRoute.html">DeleteRoute</a>.</p> </important> | -| `carrier_gateway_Create` | `EXEC` | `VpcId, region` | Creates a carrier gateway. For more information about carrier gateways, see <a href="https://docs.aws.amazon.com/wavelength/latest/developerguide/how-wavelengths-work.html#wavelength-carrier-gateway">Carrier gateways</a> in the <i>Amazon Web Services Wavelength Developer Guide</i>. | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +carrier_gateway_id +FROM aws.ec2.carrier_gateways +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the carrier_gateways resource, the following permissions are required: + +### Create +```json +ec2:CreateCarrierGateway, +ec2:DescribeCarrierGateways, +ec2:CreateTags +``` + +### List +```json +ec2:DescribeCarrierGateways +``` + diff --git a/docs/aws-docs/providers/aws/ec2/classic_link_instances/index.md b/docs/aws-docs/providers/aws/ec2/classic_link_instances/index.md deleted file mode 100644 index f0f75fcadd..0000000000 --- a/docs/aws-docs/providers/aws/ec2/classic_link_instances/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: classic_link_instances -hide_title: false -hide_table_of_contents: false -keywords: - - classic_link_instances - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameclassic_link_instances
TypeResource
Idaws.ec2.classic_link_instances
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `groupSet` | `array` | A list of security groups. | -| `instanceId` | `string` | The ID of the instance. | -| `tagSet` | `array` | Any tags assigned to the instance. | -| `vpcId` | `string` | The ID of the VPC. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `classic_link_instances_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2/classic_link_vpc/index.md b/docs/aws-docs/providers/aws/ec2/classic_link_vpc/index.md deleted file mode 100644 index 681c4d97fc..0000000000 --- a/docs/aws-docs/providers/aws/ec2/classic_link_vpc/index.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: classic_link_vpc -hide_title: false -hide_table_of_contents: false -keywords: - - classic_link_vpc - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameclassic_link_vpc
TypeResource
Idaws.ec2.classic_link_vpc
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `classic_link_vpc_Attach` | `EXEC` | `InstanceId, SecurityGroupId, VpcId, region` | <p>Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's security groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You can only link an instance that's in the <code>running</code> state. An instance is automatically unlinked from a VPC when it's stopped - you can link it to the VPC again when you restart it.</p> <p>After you've linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again.</p> <p>Linking your instance to a VPC is sometimes referred to as <i>attaching</i> your instance.</p> | -| `classic_link_vpc_Detach` | `EXEC` | `InstanceId, VpcId, region` | Unlinks (detaches) a linked EC2-Classic instance from a VPC. After the instance has been unlinked, the VPC security groups are no longer associated with it. An instance is automatically unlinked from a VPC when it's stopped. | diff --git a/docs/aws-docs/providers/aws/ec2/client_vpn_authorization_rules/index.md b/docs/aws-docs/providers/aws/ec2/client_vpn_authorization_rules/index.md deleted file mode 100644 index 0c9e4fe820..0000000000 --- a/docs/aws-docs/providers/aws/ec2/client_vpn_authorization_rules/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: client_vpn_authorization_rules -hide_title: false -hide_table_of_contents: false -keywords: - - client_vpn_authorization_rules - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameclient_vpn_authorization_rules
TypeResource
Idaws.ec2.client_vpn_authorization_rules
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `description` | `string` | A brief description of the authorization rule. | -| `accessAll` | `boolean` | Indicates whether the authorization rule grants access to all clients. | -| `clientVpnEndpointId` | `string` | The ID of the Client VPN endpoint with which the authorization rule is associated. | -| `destinationCidr` | `string` | The IPv4 address range, in CIDR notation, of the network to which the authorization rule applies. | -| `groupId` | `string` | The ID of the Active Directory group to which the authorization rule grants access. | -| `status` | `object` | Describes the state of an authorization rule. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `client_vpn_authorization_rules_Describe` | `SELECT` | `ClientVpnEndpointId, region` | diff --git a/docs/aws-docs/providers/aws/ec2/client_vpn_client_certificate_revocation_list/index.md b/docs/aws-docs/providers/aws/ec2/client_vpn_client_certificate_revocation_list/index.md deleted file mode 100644 index 8c9f462844..0000000000 --- a/docs/aws-docs/providers/aws/ec2/client_vpn_client_certificate_revocation_list/index.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: client_vpn_client_certificate_revocation_list -hide_title: false -hide_table_of_contents: false -keywords: - - client_vpn_client_certificate_revocation_list - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameclient_vpn_client_certificate_revocation_list
TypeResource
Idaws.ec2.client_vpn_client_certificate_revocation_list
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `client_vpn_client_certificate_revocation_list_Export` | `EXEC` | `ClientVpnEndpointId, region` | Downloads the client certificate revocation list for the specified Client VPN endpoint. | -| `client_vpn_client_certificate_revocation_list_Import` | `EXEC` | `CertificateRevocationList, ClientVpnEndpointId, region` | <p>Uploads a client certificate revocation list to the specified Client VPN endpoint. Uploading a client certificate revocation list overwrites the existing client certificate revocation list.</p> <p>Uploading a client certificate revocation list resets existing client connections.</p> | diff --git a/docs/aws-docs/providers/aws/ec2/client_vpn_client_configuration/index.md b/docs/aws-docs/providers/aws/ec2/client_vpn_client_configuration/index.md deleted file mode 100644 index 291bc43ebd..0000000000 --- a/docs/aws-docs/providers/aws/ec2/client_vpn_client_configuration/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: client_vpn_client_configuration -hide_title: false -hide_table_of_contents: false -keywords: - - client_vpn_client_configuration - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameclient_vpn_client_configuration
TypeResource
Idaws.ec2.client_vpn_client_configuration
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `client_vpn_client_configuration_Export` | `EXEC` | `ClientVpnEndpointId, region` | diff --git a/docs/aws-docs/providers/aws/ec2/client_vpn_connections/index.md b/docs/aws-docs/providers/aws/ec2/client_vpn_connections/index.md deleted file mode 100644 index c6fc3b16d7..0000000000 --- a/docs/aws-docs/providers/aws/ec2/client_vpn_connections/index.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: client_vpn_connections -hide_title: false -hide_table_of_contents: false -keywords: - - client_vpn_connections - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameclient_vpn_connections
TypeResource
Idaws.ec2.client_vpn_connections
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `clientIp` | `string` | The IP address of the client. | -| `clientVpnEndpointId` | `string` | The ID of the Client VPN endpoint to which the client is connected. | -| `commonName` | `string` | The common name associated with the client. This is either the name of the client certificate, or the Active Directory user name. | -| `connectionEndTime` | `string` | The date and time the client connection was terminated. | -| `connectionEstablishedTime` | `string` | The date and time the client connection was established. | -| `connectionId` | `string` | The ID of the client connection. | -| `egressBytes` | `string` | The number of bytes received by the client. | -| `egressPackets` | `string` | The number of packets received by the client. | -| `ingressBytes` | `string` | The number of bytes sent by the client. | -| `ingressPackets` | `string` | The number of packets sent by the client. | -| `postureComplianceStatusSet` | `array` | The statuses returned by the client connect handler for posture compliance, if applicable. | -| `status` | `object` | Describes the status of a client connection. | -| `timestamp` | `string` | The current date and time. | -| `username` | `string` | The username of the client who established the client connection. This information is only provided if Active Directory client authentication is used. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `client_vpn_connections_Describe` | `SELECT` | `ClientVpnEndpointId, region` | Describes active client connections and connections that have been terminated within the last 60 minutes for the specified Client VPN endpoint. | -| `client_vpn_connections_Terminate` | `EXEC` | `ClientVpnEndpointId, region` | Terminates active Client VPN endpoint connections. This action can be used to terminate a specific client connection, or up to five connections established by a specific user. | diff --git a/docs/aws-docs/providers/aws/ec2/client_vpn_endpoints/index.md b/docs/aws-docs/providers/aws/ec2/client_vpn_endpoints/index.md deleted file mode 100644 index e337b4da96..0000000000 --- a/docs/aws-docs/providers/aws/ec2/client_vpn_endpoints/index.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: client_vpn_endpoints -hide_title: false -hide_table_of_contents: false -keywords: - - client_vpn_endpoints - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameclient_vpn_endpoints
TypeResource
Idaws.ec2.client_vpn_endpoints
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `description` | `string` | A brief description of the endpoint. | -| `associatedTargetNetwork` | `array` | Information about the associated target networks. A target network is a subnet in a VPC.This property is deprecated. To view the target networks associated with a Client VPN endpoint, call DescribeClientVpnTargetNetworks and inspect the clientVpnTargetNetworks response element. | -| `authenticationOptions` | `array` | Information about the authentication method used by the Client VPN endpoint. | -| `clientCidrBlock` | `string` | The IPv4 address range, in CIDR notation, from which client IP addresses are assigned. | -| `clientConnectOptions` | `object` | The options for managing connection authorization for new client connections. | -| `clientLoginBannerOptions` | `object` | Current state of options for customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established. | -| `clientVpnEndpointId` | `string` | The ID of the Client VPN endpoint. | -| `connectionLogOptions` | `object` | Information about the client connection logging options for a Client VPN endpoint. | -| `creationTime` | `string` | The date and time the Client VPN endpoint was created. | -| `deletionTime` | `string` | The date and time the Client VPN endpoint was deleted, if applicable. | -| `dnsName` | `string` | The DNS name to be used by clients when connecting to the Client VPN endpoint. | -| `dnsServer` | `array` | Information about the DNS servers to be used for DNS resolution. | -| `securityGroupIdSet` | `array` | The IDs of the security groups for the target network. | -| `selfServicePortalUrl` | `string` | The URL of the self-service portal. | -| `serverCertificateArn` | `string` | The ARN of the server certificate. | -| `sessionTimeoutHours` | `integer` | <p>The maximum VPN session duration time in hours.</p> <p>Valid values: <code>8 \| 10 \| 12 \| 24</code> </p> <p>Default value: <code>24</code> </p> | -| `splitTunnel` | `boolean` | <p>Indicates whether split-tunnel is enabled in the Client VPN endpoint.</p> <p>For information about split-tunnel VPN endpoints, see <a href="https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/split-tunnel-vpn.html">Split-Tunnel Client VPN endpoint</a> in the <i>Client VPN Administrator Guide</i>.</p> | -| `status` | `object` | Describes the state of a Client VPN endpoint. | -| `tagSet` | `array` | Any tags assigned to the Client VPN endpoint. | -| `transportProtocol` | `string` | The transport protocol used by the Client VPN endpoint. | -| `vpcId` | `string` | The ID of the VPC. | -| `vpnPort` | `integer` | The port number for the Client VPN endpoint. | -| `vpnProtocol` | `string` | The protocol used by the VPN session. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `client_vpn_endpoints_Describe` | `SELECT` | `region` | Describes one or more Client VPN endpoints in the account. | -| `client_vpn_endpoint_Create` | `INSERT` | `Authentication, ClientCidrBlock, ConnectionLogOptions, ServerCertificateArn, region` | Creates a Client VPN endpoint. A Client VPN endpoint is the resource you create and configure to enable and manage client VPN sessions. It is the destination endpoint at which all client VPN sessions are terminated. | -| `client_vpn_endpoint_Delete` | `DELETE` | `ClientVpnEndpointId, region` | Deletes the specified Client VPN endpoint. You must disassociate all target networks before you can delete a Client VPN endpoint. | -| `client_vpn_endpoint_Modify` | `EXEC` | `ClientVpnEndpointId, region` | Modifies the specified Client VPN endpoint. Modifying the DNS server resets existing client connections. | diff --git a/docs/aws-docs/providers/aws/ec2/client_vpn_ingress/index.md b/docs/aws-docs/providers/aws/ec2/client_vpn_ingress/index.md deleted file mode 100644 index a1da2b145d..0000000000 --- a/docs/aws-docs/providers/aws/ec2/client_vpn_ingress/index.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: client_vpn_ingress -hide_title: false -hide_table_of_contents: false -keywords: - - client_vpn_ingress - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameclient_vpn_ingress
TypeResource
Idaws.ec2.client_vpn_ingress
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `client_vpn_ingress_Authorize` | `EXEC` | `ClientVpnEndpointId, TargetNetworkCidr, region` | Adds an ingress authorization rule to a Client VPN endpoint. Ingress authorization rules act as firewall rules that grant access to networks. You must configure ingress authorization rules to enable clients to access resources in Amazon Web Services or on-premises networks. | -| `client_vpn_ingress_Revoke` | `EXEC` | `ClientVpnEndpointId, TargetNetworkCidr, region` | Removes an ingress authorization rule from a Client VPN endpoint. | diff --git a/docs/aws-docs/providers/aws/ec2/client_vpn_routes/index.md b/docs/aws-docs/providers/aws/ec2/client_vpn_routes/index.md deleted file mode 100644 index eb7076f45c..0000000000 --- a/docs/aws-docs/providers/aws/ec2/client_vpn_routes/index.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: client_vpn_routes -hide_title: false -hide_table_of_contents: false -keywords: - - client_vpn_routes - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameclient_vpn_routes
TypeResource
Idaws.ec2.client_vpn_routes
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `description` | `string` | A brief description of the route. | -| `clientVpnEndpointId` | `string` | The ID of the Client VPN endpoint with which the route is associated. | -| `destinationCidr` | `string` | The IPv4 address range, in CIDR notation, of the route destination. | -| `origin` | `string` | Indicates how the route was associated with the Client VPN endpoint. <code>associate</code> indicates that the route was automatically added when the target network was associated with the Client VPN endpoint. <code>add-route</code> indicates that the route was manually added using the <b>CreateClientVpnRoute</b> action. | -| `status` | `object` | Describes the state of a Client VPN endpoint route. | -| `targetSubnet` | `string` | The ID of the subnet through which traffic is routed. | -| `type` | `string` | The route type. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `client_vpn_routes_Describe` | `SELECT` | `ClientVpnEndpointId, region` | Describes the routes for the specified Client VPN endpoint. | -| `client_vpn_route_Create` | `INSERT` | `ClientVpnEndpointId, DestinationCidrBlock, TargetVpcSubnetId, region` | Adds a route to a network to a Client VPN endpoint. Each Client VPN endpoint has a route table that describes the available destination network routes. Each route in the route table specifies the path for traffic to specific resources or networks. | -| `client_vpn_route_Delete` | `DELETE` | `ClientVpnEndpointId, DestinationCidrBlock, region` | Deletes a route from a Client VPN endpoint. You can only delete routes that you manually added using the <b>CreateClientVpnRoute</b> action. You cannot delete routes that were automatically added when associating a subnet. To remove routes that have been automatically added, disassociate the target subnet from the Client VPN endpoint. | diff --git a/docs/aws-docs/providers/aws/ec2/client_vpn_target_networks/index.md b/docs/aws-docs/providers/aws/ec2/client_vpn_target_networks/index.md deleted file mode 100644 index 9c704c2f8d..0000000000 --- a/docs/aws-docs/providers/aws/ec2/client_vpn_target_networks/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: client_vpn_target_networks -hide_title: false -hide_table_of_contents: false -keywords: - - client_vpn_target_networks - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameclient_vpn_target_networks
TypeResource
Idaws.ec2.client_vpn_target_networks
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `associationId` | `string` | The ID of the association. | -| `clientVpnEndpointId` | `string` | The ID of the Client VPN endpoint with which the target network is associated. | -| `securityGroups` | `array` | The IDs of the security groups applied to the target network association. | -| `status` | `object` | Describes the state of a target network association. | -| `targetNetworkId` | `string` | The ID of the subnet specified as the target network. | -| `vpcId` | `string` | The ID of the VPC in which the target network (subnet) is located. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `client_vpn_target_networks_Describe` | `SELECT` | `ClientVpnEndpointId, region` | Describes the target networks associated with the specified Client VPN endpoint. | -| `client_vpn_target_network_Associate` | `EXEC` | `ClientVpnEndpointId, SubnetId, region` | <p>Associates a target network with a Client VPN endpoint. A target network is a subnet in a VPC. You can associate multiple subnets from the same VPC with a Client VPN endpoint. You can associate only one subnet in each Availability Zone. We recommend that you associate at least two subnets to provide Availability Zone redundancy.</p> <p>If you specified a VPC when you created the Client VPN endpoint or if you have previous subnet associations, the specified subnet must be in the same VPC. To specify a subnet that's in a different VPC, you must first modify the Client VPN endpoint (<a>ModifyClientVpnEndpoint</a>) and change the VPC that's associated with it.</p> | -| `client_vpn_target_network_Disassociate` | `EXEC` | `AssociationId, ClientVpnEndpointId, region` | <p>Disassociates a target network from the specified Client VPN endpoint. When you disassociate the last target network from a Client VPN, the following happens:</p> <ul> <li> <p>The route that was automatically added for the VPC is deleted</p> </li> <li> <p>All active client connections are terminated</p> </li> <li> <p>New client connections are disallowed</p> </li> <li> <p>The Client VPN endpoint's status changes to <code>pending-associate</code> </p> </li> </ul> | diff --git a/docs/aws-docs/providers/aws/ec2/coip_pool_usage/index.md b/docs/aws-docs/providers/aws/ec2/coip_pool_usage/index.md deleted file mode 100644 index 9a481e1e4d..0000000000 --- a/docs/aws-docs/providers/aws/ec2/coip_pool_usage/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: coip_pool_usage -hide_title: false -hide_table_of_contents: false -keywords: - - coip_pool_usage - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namecoip_pool_usage
TypeResource
Idaws.ec2.coip_pool_usage
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `allocationId` | `string` | The allocation ID of the address. | -| `awsAccountId` | `string` | The Amazon Web Services account ID. | -| `awsService` | `string` | The Amazon Web Services service. | -| `coIp` | `string` | The customer-owned IP address. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `coip_pool_usage_Get` | `SELECT` | `PoolId, region` | diff --git a/docs/aws-docs/providers/aws/ec2/coip_pools/index.md b/docs/aws-docs/providers/aws/ec2/coip_pools/index.md deleted file mode 100644 index 2373aaeb72..0000000000 --- a/docs/aws-docs/providers/aws/ec2/coip_pools/index.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: coip_pools -hide_title: false -hide_table_of_contents: false -keywords: - - coip_pools - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namecoip_pools
TypeResource
Idaws.ec2.coip_pools
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `localGatewayRouteTableId` | `string` | The ID of the local gateway route table. | -| `poolArn` | `string` | The ARN of the address pool. | -| `poolCidrSet` | `array` | The address ranges of the address pool. | -| `poolId` | `string` | The ID of the address pool. | -| `tagSet` | `array` | The tags. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `coip_pools_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2/console_output/index.md b/docs/aws-docs/providers/aws/ec2/console_output/index.md deleted file mode 100644 index c06c61d23f..0000000000 --- a/docs/aws-docs/providers/aws/ec2/console_output/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: console_output -hide_title: false -hide_table_of_contents: false -keywords: - - console_output - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameconsole_output
TypeResource
Idaws.ec2.console_output
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `instanceId` | `string` | The ID of the instance. | -| `output` | `string` | The console output, base64-encoded. If you are using a command line tool, the tool decodes the output for you. | -| `timestamp` | `string` | The time at which the output was last updated. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `console_output_Get` | `SELECT` | `InstanceId, region` | diff --git a/docs/aws-docs/providers/aws/ec2/console_screenshot/index.md b/docs/aws-docs/providers/aws/ec2/console_screenshot/index.md deleted file mode 100644 index c87a757e4c..0000000000 --- a/docs/aws-docs/providers/aws/ec2/console_screenshot/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: console_screenshot -hide_title: false -hide_table_of_contents: false -keywords: - - console_screenshot - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameconsole_screenshot
TypeResource
Idaws.ec2.console_screenshot
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `imageData` | `string` | The data that comprises the image. | -| `instanceId` | `string` | The ID of the instance. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `console_screenshot_Get` | `SELECT` | `InstanceId, region` | diff --git a/docs/aws-docs/providers/aws/ec2/conversion_tasks/index.md b/docs/aws-docs/providers/aws/ec2/conversion_tasks/index.md deleted file mode 100644 index b1ba5a8af4..0000000000 --- a/docs/aws-docs/providers/aws/ec2/conversion_tasks/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: conversion_tasks -hide_title: false -hide_table_of_contents: false -keywords: - - conversion_tasks - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameconversion_tasks
TypeResource
Idaws.ec2.conversion_tasks
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `conversionTaskId` | `string` | The ID of the conversion task. | -| `expirationTime` | `string` | The time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel the task. | -| `importInstance` | `object` | Describes an import instance task. | -| `importVolume` | `object` | Describes an import volume task. | -| `state` | `string` | The state of the conversion task. | -| `statusMessage` | `string` | The status message related to the conversion task. | -| `tagSet` | `array` | Any tags assigned to the task. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `conversion_tasks_Describe` | `SELECT` | `region` | <p>Describes the specified conversion tasks or all your conversion tasks. For more information, see the <a href="https://docs.aws.amazon.com/vm-import/latest/userguide/">VM Import/Export User Guide</a>.</p> <p>For information about the import manifest referenced by this API action, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/manifest.html">VM Import Manifest</a>.</p> | -| `conversion_task_Cancel` | `EXEC` | `ConversionTaskId, region` | <p>Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/CommandLineReference/ec2-cli-vmimport-export.html">Importing a Virtual Machine Using the Amazon EC2 CLI</a>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2/customer_gateway/index.md b/docs/aws-docs/providers/aws/ec2/customer_gateway/index.md new file mode 100644 index 0000000000..e06eeb8ce1 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/customer_gateway/index.md @@ -0,0 +1,103 @@ +--- +title: customer_gateway +hide_title: false +hide_table_of_contents: false +keywords: + - customer_gateway + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual customer_gateway resource + +## Overview + + + + + +
Namecustomer_gateway
TypeResource
DescriptionSpecifies a customer gateway.
Idaws.ec2.customer_gateway
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
certificate_arnstring
customer_gateway_idstring
bgp_asnintegerFor devices that support BGP, the customer gateway's BGP ASN.<br/> Default: 65000
ip_addressstringIPv4 address for the customer gateway device's outside interface. The address must be static.
tagsarrayOne or more tags for the customer gateway.
typestringThe type of VPN connection that this customer gateway supports (``ipsec.1``).
device_namestringThe name of customer gateway device.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +certificate_arn, +customer_gateway_id, +bgp_asn, +ip_address, +tags, +type, +device_name +FROM aws.ec2.customer_gateway +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the customer_gateway resource, the following permissions are required: + +### Read +```json +ec2:DescribeCustomerGateways +``` + +### Update +```json +ec2:CreateTags, +ec2:DeleteTags, +ec2:DescribeCustomerGateways +``` + +### Delete +```json +ec2:DeleteCustomerGateway, +ec2:DescribeCustomerGateways, +ec2:DeleteTags +``` + diff --git a/docs/aws-docs/providers/aws/ec2/customer_gateways/index.md b/docs/aws-docs/providers/aws/ec2/customer_gateways/index.md index 9125250087..00471aebc4 100644 --- a/docs/aws-docs/providers/aws/ec2/customer_gateways/index.md +++ b/docs/aws-docs/providers/aws/ec2/customer_gateways/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - customer_gateways - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,30 +14,66 @@ description: Query, deploy 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_gateways in a region ## Overview +
Namecustomer_gateways
TypeResource
DescriptionSpecifies a customer gateway.
Idaws.ec2.customer_gateways
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `bgpAsn` | `string` | The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN). | -| `certificateArn` | `string` | The Amazon Resource Name (ARN) for the customer gateway certificate. | -| `customerGatewayId` | `string` | The ID of the customer gateway. | -| `deviceName` | `string` | The name of customer gateway device. | -| `ipAddress` | `string` | The Internet-routable IP address of the customer gateway's outside interface. | -| `state` | `string` | The current state of the customer gateway (<code>pending \| available \| deleting \| deleted</code>). | -| `tagSet` | `array` | Any tags assigned to the customer gateway. | -| `type` | `string` | The type of VPN connection the customer gateway supports (<code>ipsec.1</code>). | + + + + + +
NameDatatypeDescription
customer_gateway_idstring
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `customer_gateways_Describe` | `SELECT` | `region` | <p>Describes one or more of your VPN customer gateways.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html">Amazon Web Services Site-to-Site VPN</a> in the <i>Amazon Web Services Site-to-Site VPN User Guide</i>.</p> | -| `customer_gateway_Create` | `INSERT` | `BgpAsn, Type, region` | <p>Provides information to Amazon Web Services about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the Amazon Web Services side of the VPN connection is the virtual private gateway.) You must provide the internet-routable IP address of the customer gateway's external interface. The IP address must be static and can be behind a device performing network address translation (NAT).</p> <p>For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN. For more information, see <a href="https://docs.aws.amazon.com/vpn/latest/s2svpn/cgw-options.html">Customer gateway options for your Site-to-Site VPN connection</a> in the <i>Amazon Web Services Site-to-Site VPN User Guide</i>.</p> <p>To create more than one customer gateway with the same VPN type, IP address, and BGP ASN, specify a unique device name for each customer gateway. An identical request returns information about the existing customer gateway; it doesn't create a new customer gateway.</p> | -| `customer_gateway_Delete` | `DELETE` | `CustomerGatewayId, region` | Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway. | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +customer_gateway_id +FROM aws.ec2.customer_gateways +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the customer_gateways resource, the following permissions are required: + +### Create +```json +ec2:CreateCustomerGateway, +ec2:DescribeCustomerGateways, +ec2:CreateTags +``` + +### List +```json +ec2:DescribeCustomerGateways +``` + diff --git a/docs/aws-docs/providers/aws/ec2/default_credit_specification/index.md b/docs/aws-docs/providers/aws/ec2/default_credit_specification/index.md deleted file mode 100644 index 600c7318ab..0000000000 --- a/docs/aws-docs/providers/aws/ec2/default_credit_specification/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: default_credit_specification -hide_title: false -hide_table_of_contents: false -keywords: - - default_credit_specification - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namedefault_credit_specification
TypeResource
Idaws.ec2.default_credit_specification
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `cpuCredits` | `string` | The default credit option for CPU usage of the instance family. Valid values are <code>standard</code> and <code>unlimited</code>. | -| `instanceFamily` | `string` | The instance family. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `default_credit_specification_Get` | `SELECT` | `InstanceFamily, region` | <p>Describes the default credit option for CPU usage of a burstable performance instance family.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html">Burstable performance instances</a> in the <i>Amazon EC2 User Guide</i>.</p> | -| `default_credit_specification_Modify` | `EXEC` | `CpuCredits, InstanceFamily, region` | <p>Modifies the default credit option for CPU usage of burstable performance instances. The default credit option is set at the account level per Amazon Web Services Region, and is specified per instance family. All new burstable performance instances in the account launch using the default credit option.</p> <p> <code>ModifyDefaultCreditSpecification</code> is an asynchronous operation, which works at an Amazon Web Services Region level and modifies the credit option for each Availability Zone. All zones in a Region are updated within five minutes. But if instances are launched during this operation, they might not get the new credit option until the zone is updated. To verify whether the update has occurred, you can call <code>GetDefaultCreditSpecification</code> and check <code>DefaultCreditSpecification</code> for updates.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html">Burstable performance instances</a> in the <i>Amazon EC2 User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2/default_subnet/index.md b/docs/aws-docs/providers/aws/ec2/default_subnet/index.md deleted file mode 100644 index 9fb2aca87f..0000000000 --- a/docs/aws-docs/providers/aws/ec2/default_subnet/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: default_subnet -hide_title: false -hide_table_of_contents: false -keywords: - - default_subnet - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namedefault_subnet
TypeResource
Idaws.ec2.default_subnet
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `default_subnet_Create` | `INSERT` | `AvailabilityZone, region` | diff --git a/docs/aws-docs/providers/aws/ec2/default_vpc/index.md b/docs/aws-docs/providers/aws/ec2/default_vpc/index.md deleted file mode 100644 index d9014a2854..0000000000 --- a/docs/aws-docs/providers/aws/ec2/default_vpc/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: default_vpc -hide_title: false -hide_table_of_contents: false -keywords: - - default_vpc - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namedefault_vpc
TypeResource
Idaws.ec2.default_vpc
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `default_vpc_Create` | `INSERT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2/dhcp_options/index.md b/docs/aws-docs/providers/aws/ec2/dhcp_options/index.md index 5d25fce6ab..dcf1e3b2d7 100644 --- a/docs/aws-docs/providers/aws/ec2/dhcp_options/index.md +++ b/docs/aws-docs/providers/aws/ec2/dhcp_options/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - dhcp_options - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,27 +14,93 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- - - +Gets an individual dhcp_options resource ## Overview +
Namedhcp_options
TypeResource
DescriptionResource Type definition for AWS::EC2::DHCPOptions
Idaws.ec2.dhcp_options
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `dhcpConfigurationSet` | `array` | One or more DHCP options in the set. | -| `dhcpOptionsId` | `string` | The ID of the set of DHCP options. | -| `ownerId` | `string` | The ID of the Amazon Web Services account that owns the DHCP options set. | -| `tagSet` | `array` | Any tags assigned to the DHCP options set. | + + + + + + + + + + + + +
NameDatatypeDescription
dhcp_options_idstring
domain_namestringThis value is used to complete unqualified DNS hostnames.
domain_name_serversarrayThe IPv4 addresses of up to four domain name servers, or AmazonProvidedDNS.
netbios_name_serversarrayThe IPv4 addresses of up to four NetBIOS name servers.
netbios_node_typeintegerThe NetBIOS node type (1, 2, 4, or 8).
ntp_serversarrayThe IPv4 addresses of up to four Network Time Protocol (NTP) servers.
ipv6_address_preferred_lease_timeintegerThe preferred Lease Time for ipV6 address in seconds.
tagsarrayAny tags assigned to the DHCP options set.
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `dhcp_options_Describe` | `SELECT` | `region` | <p>Describes one or more of your DHCP options sets.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_DHCP_Options.html">DHCP options sets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p> | -| `dhcp_options_Create` | `INSERT` | `DhcpConfiguration, region` | <p>Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see <a href="http://www.ietf.org/rfc/rfc2132.txt">RFC 2132</a>.</p> <ul> <li> <p> <code>domain-name-servers</code> - The IP addresses of up to four domain name servers, or AmazonProvidedDNS. The default DHCP option set specifies AmazonProvidedDNS. If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas. To have your instance receive a custom DNS hostname as specified in <code>domain-name</code>, you must set <code>domain-name-servers</code> to a custom DNS server.</p> </li> <li> <p> <code>domain-name</code> - If you're using AmazonProvidedDNS in <code>us-east-1</code>, specify <code>ec2.internal</code>. If you're using AmazonProvidedDNS in another Region, specify <code>region.compute.internal</code> (for example, <code>ap-northeast-1.compute.internal</code>). Otherwise, specify a domain name (for example, <code>ExampleCompany.com</code>). This value is used to complete unqualified DNS hostnames. <b>Important</b>: Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP options set is associated with a VPC that has instances with multiple operating systems, specify only one domain name.</p> </li> <li> <p> <code>ntp-servers</code> - The IP addresses of up to four Network Time Protocol (NTP) servers.</p> </li> <li> <p> <code>netbios-name-servers</code> - The IP addresses of up to four NetBIOS name servers.</p> </li> <li> <p> <code>netbios-node-type</code> - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2 (broadcast and multicast are not currently supported). For more information about these node types, see <a href="http://www.ietf.org/rfc/rfc2132.txt">RFC 2132</a>.</p> </li> </ul> <p>Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide (AmazonProvidedDNS). If you create a set of options, and if your VPC has an internet gateway, make sure to set the <code>domain-name-servers</code> option either to <code>AmazonProvidedDNS</code> or to a domain name server of your choice. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_DHCP_Options.html">DHCP options sets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p> | -| `dhcp_options_Delete` | `DELETE` | `DhcpOptionsId, region` | Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC. | -| `dhcp_options_Associate` | `EXEC` | `DhcpOptionsId, VpcId, region` | <p>Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC.</p> <p>After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_DHCP_Options.html">DHCP options sets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p> | + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +dhcp_options_id, +domain_name, +domain_name_servers, +netbios_name_servers, +netbios_node_type, +ntp_servers, +ipv6_address_preferred_lease_time, +tags +FROM aws.ec2.dhcp_options +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the dhcp_options resource, the following permissions are required: + +### Read +```json +ec2:DescribeDhcpOptions, +ec2:DescribeTags +``` + +### Update +```json +ec2:CreateTags, +ec2:DescribeDhcpOptions, +ec2:DeleteTags +``` + +### Delete +```json +ec2:DeleteDhcpOptions, +ec2:DeleteTags, +ec2:DescribeDhcpOptions +``` + diff --git a/docs/aws-docs/providers/aws/ec2/diagnostic_interrupt/index.md b/docs/aws-docs/providers/aws/ec2/diagnostic_interrupt/index.md deleted file mode 100644 index 51ff8ca0be..0000000000 --- a/docs/aws-docs/providers/aws/ec2/diagnostic_interrupt/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: diagnostic_interrupt -hide_title: false -hide_table_of_contents: false -keywords: - - diagnostic_interrupt - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namediagnostic_interrupt
TypeResource
Idaws.ec2.diagnostic_interrupt
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `diagnostic_interrupt_Send` | `EXEC` | `InstanceId, region` | diff --git a/docs/aws-docs/providers/aws/ec2/ebs_default_kms_key_id/index.md b/docs/aws-docs/providers/aws/ec2/ebs_default_kms_key_id/index.md deleted file mode 100644 index e441f36ddf..0000000000 --- a/docs/aws-docs/providers/aws/ec2/ebs_default_kms_key_id/index.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ebs_default_kms_key_id -hide_title: false -hide_table_of_contents: false -keywords: - - ebs_default_kms_key_id - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameebs_default_kms_key_id
TypeResource
Idaws.ec2.ebs_default_kms_key_id
- -## Fields -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `ebs_default_kms_key_id_Get` | `SELECT` | `region` | <p>Describes the default KMS key for EBS encryption by default for your account in this Region. You can change the default KMS key for encryption by default using <a>ModifyEbsDefaultKmsKeyId</a> or <a>ResetEbsDefaultKmsKeyId</a>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html">Amazon EBS encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | -| `ebs_default_kms_key_id_Modify` | `EXEC` | `KmsKeyId, region` | <p>Changes the default KMS key for EBS encryption by default for your account in this Region.</p> <p>Amazon Web Services creates a unique Amazon Web Services managed KMS key in each Region for use with encryption by default. If you change the default KMS key to a symmetric customer managed KMS key, it is used instead of the Amazon Web Services managed KMS key. To reset the default KMS key to the Amazon Web Services managed KMS key for EBS, use <a>ResetEbsDefaultKmsKeyId</a>. Amazon EBS does not support asymmetric KMS keys.</p> <p>If you delete or disable the customer managed KMS key that you specified for use with encryption by default, your instances will fail to launch.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html">Amazon EBS encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | -| `ebs_default_kms_key_id_Reset` | `EXEC` | `region` | <p>Resets the default KMS key for EBS encryption for your account in this Region to the Amazon Web Services managed KMS key for EBS.</p> <p>After resetting the default KMS key to the Amazon Web Services managed KMS key, you can continue to encrypt by a customer managed KMS key by specifying it when you create the volume. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html">Amazon EBS encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2/ebs_encryption_by_default/index.md b/docs/aws-docs/providers/aws/ec2/ebs_encryption_by_default/index.md deleted file mode 100644 index e913897601..0000000000 --- a/docs/aws-docs/providers/aws/ec2/ebs_encryption_by_default/index.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ebs_encryption_by_default -hide_title: false -hide_table_of_contents: false -keywords: - - ebs_encryption_by_default - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameebs_encryption_by_default
TypeResource
Idaws.ec2.ebs_encryption_by_default
- -## Fields -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `ebs_encryption_by_default_Get` | `SELECT` | `region` | <p>Describes whether EBS encryption by default is enabled for your account in the current Region.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html">Amazon EBS encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | -| `ebs_encryption_by_default_Disable` | `EXEC` | `region` | <p>Disables EBS encryption by default for your account in the current Region.</p> <p>After you disable encryption by default, you can still create encrypted volumes by enabling encryption when you create each volume.</p> <p>Disabling encryption by default does not change the encryption status of your existing volumes.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html">Amazon EBS encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | -| `ebs_encryption_by_default_Enable` | `EXEC` | `region` | <p>Enables EBS encryption by default for your account in the current Region.</p> <p>After you enable encryption by default, the EBS volumes that you create are always encrypted, either using the default KMS key or the KMS key that you specified when you created each volume. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html">Amazon EBS encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>You can specify the default KMS key for encryption by default using <a>ModifyEbsDefaultKmsKeyId</a> or <a>ResetEbsDefaultKmsKeyId</a>.</p> <p>Enabling encryption by default has no effect on the encryption status of your existing volumes.</p> <p>After you enable encryption by default, you can no longer launch instances using instance types that do not support encryption. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances">Supported instance types</a>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2/ec2fleet/index.md b/docs/aws-docs/providers/aws/ec2/ec2fleet/index.md new file mode 100644 index 0000000000..2ba95da1bc --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/ec2fleet/index.md @@ -0,0 +1,113 @@ +--- +title: ec2fleet +hide_title: false +hide_table_of_contents: false +keywords: + - ec2fleet + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual ec2fleet resource + +## Overview + + + + + +
Nameec2fleet
TypeResource
DescriptionResource Type definition for AWS::EC2::EC2Fleet
Idaws.ec2.ec2fleet
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
target_capacity_specificationobject
on_demand_optionsobject
typestring
excess_capacity_termination_policystring
tag_specificationsarray
spot_optionsobject
valid_fromstring
replace_unhealthy_instancesboolean
launch_template_configsarray
fleet_idstring
terminate_instances_with_expirationboolean
valid_untilstring
contextstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +target_capacity_specification, +on_demand_options, +type, +excess_capacity_termination_policy, +tag_specifications, +spot_options, +valid_from, +replace_unhealthy_instances, +launch_template_configs, +fleet_id, +terminate_instances_with_expiration, +valid_until, +context +FROM aws.ec2.ec2fleet +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the ec2fleet resource, the following permissions are required: + +### Delete +```json +ec2:DescribeFleets, +ec2:DeleteFleets +``` + +### Read +```json +ec2:DescribeFleets +``` + +### Update +```json +ec2:ModifyFleet, +ec2:DescribeFleets +``` + diff --git a/docs/aws-docs/providers/aws/ec2/ec2fleets/index.md b/docs/aws-docs/providers/aws/ec2/ec2fleets/index.md new file mode 100644 index 0000000000..25ed83e7eb --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/ec2fleets/index.md @@ -0,0 +1,78 @@ +--- +title: ec2fleets +hide_title: false +hide_table_of_contents: false +keywords: + - ec2fleets + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Retrieves a list of ec2fleets in a region + +## Overview + + + + + +
Nameec2fleets
TypeResource
DescriptionResource Type definition for AWS::EC2::EC2Fleet
Idaws.ec2.ec2fleets
+ +## Fields + + + + + +
NameDatatypeDescription
fleet_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +fleet_id +FROM aws.ec2.ec2fleets +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the ec2fleets resource, the following permissions are required: + +### Create +```json +ec2:CreateFleet, +ec2:DescribeFleets +``` + +### List +```json +ec2:DescribeFleets +``` + diff --git a/docs/aws-docs/providers/aws/ec2/egress_only_internet_gateway/index.md b/docs/aws-docs/providers/aws/ec2/egress_only_internet_gateway/index.md new file mode 100644 index 0000000000..8af5bd55c9 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/egress_only_internet_gateway/index.md @@ -0,0 +1,81 @@ +--- +title: egress_only_internet_gateway +hide_title: false +hide_table_of_contents: false +keywords: + - egress_only_internet_gateway + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual egress_only_internet_gateway resource + +## Overview + + + + + +
Nameegress_only_internet_gateway
TypeResource
DescriptionResource Type definition for AWS::EC2::EgressOnlyInternetGateway
Idaws.ec2.egress_only_internet_gateway
+ +## Fields + + + + + + +
NameDatatypeDescription
idstringService Generated ID of the EgressOnlyInternetGateway
vpc_idstringThe ID of the VPC for which to create the egress-only internet gateway.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +vpc_id +FROM aws.ec2.egress_only_internet_gateway +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the egress_only_internet_gateway resource, the following permissions are required: + +### Read +```json +ec2:DescribeEgressOnlyInternetGateways +``` + +### Delete +```json +ec2:DeleteEgressOnlyInternetGateway, +ec2:DescribeEgressOnlyInternetGateways, +ec2:DescribeVpcs +``` + diff --git a/docs/aws-docs/providers/aws/ec2/egress_only_internet_gateways/index.md b/docs/aws-docs/providers/aws/ec2/egress_only_internet_gateways/index.md index 4473607e89..34eb695b0a 100644 --- a/docs/aws-docs/providers/aws/ec2/egress_only_internet_gateways/index.md +++ b/docs/aws-docs/providers/aws/ec2/egress_only_internet_gateways/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - egress_only_internet_gateways - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,25 +14,65 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- - - +Retrieves a list of egress_only_internet_gateways in a region ## Overview +
Nameegress_only_internet_gateways
TypeResource
DescriptionResource Type definition for AWS::EC2::EgressOnlyInternetGateway
Idaws.ec2.egress_only_internet_gateways
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `attachmentSet` | `array` | Information about the attachment of the egress-only internet gateway. | -| `egressOnlyInternetGatewayId` | `string` | The ID of the egress-only internet gateway. | -| `tagSet` | `array` | The tags assigned to the egress-only internet gateway. | + + + + + +
NameDatatypeDescription
idstringService Generated ID of the EgressOnlyInternetGateway
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `egress_only_internet_gateways_Describe` | `SELECT` | `region` | Describes one or more of your egress-only internet gateways. | -| `egress_only_internet_gateway_Create` | `INSERT` | `VpcId, region` | [IPv6 only] Creates an egress-only internet gateway for your VPC. An egress-only internet gateway is used to enable outbound communication over IPv6 from instances in your VPC to the internet, and prevents hosts outside of your VPC from initiating an IPv6 connection with your instance. | -| `egress_only_internet_gateway_Delete` | `DELETE` | `EgressOnlyInternetGatewayId, region` | Deletes an egress-only internet gateway. | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.ec2.egress_only_internet_gateways +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the egress_only_internet_gateways resource, the following permissions are required: + +### Create +```json +ec2:CreateEgressOnlyInternetGateway, +ec2:DescribeEgressOnlyInternetGateways +``` + +### List +```json +ec2:DescribeEgressOnlyInternetGateways +``` + diff --git a/docs/aws-docs/providers/aws/ec2/eip/index.md b/docs/aws-docs/providers/aws/ec2/eip/index.md new file mode 100644 index 0000000000..5b67043b5f --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/eip/index.md @@ -0,0 +1,107 @@ +--- +title: eip +hide_title: false +hide_table_of_contents: false +keywords: + - eip + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual eip resource + +## Overview + + + + + +
Nameeip
TypeResource
DescriptionSpecifies an Elastic IP (EIP) address and can, optionally, associate it with an Amazon EC2 instance.<br/> You can allocate an Elastic IP address from an address pool owned by AWS or from an address pool created from a public IPv4 address range that you have brought to AWS for use with your AWS resources using bring your own IP addresses (BYOIP). For more information, see [Bring Your Own IP Addresses (BYOIP)](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html) in the *Amazon EC2 User Guide*.<br/> For more information, see [Elastic IP Addresses](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) in the *Amazon EC2 User Guide*.
Idaws.ec2.eip
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
public_ipstring
allocation_idstring
domainstringThe network (``vpc``).<br/> If you define an Elastic IP address and associate it with a VPC that is defined in the same template, you must declare a dependency on the VPC-gateway attachment by using the [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) on this resource.
network_border_groupstringA unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network border groups.<br/> Use [DescribeAvailabilityZones](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAvailabilityZones.html) to view the network border groups.
transfer_addressstringThe Elastic IP address you are accepting for transfer. You can only accept one transferred address. For more information on Elastic IP address transfers, see [Transfer Elastic IP addresses](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#transfer-EIPs-intro) in the *Amazon Virtual Private Cloud User Guide*.
instance_idstringThe ID of the instance.<br/> Updates to the ``InstanceId`` property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource.
public_ipv4_poolstringThe ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool.<br/> Updates to the ``PublicIpv4Pool`` property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource.
tagsarrayAny tags assigned to the Elastic IP address.<br/> Updates to the ``Tags`` property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +public_ip, +allocation_id, +domain, +network_border_group, +transfer_address, +instance_id, +public_ipv4_pool, +tags +FROM aws.ec2.eip +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the eip resource, the following permissions are required: + +### Read +```json +ec2:DescribeAddresses +``` + +### Delete +```json +ec2:ReleaseAddress, +ec2:DescribeAddresses, +ec2:DisassociateAddress +``` + +### Update +```json +ec2:DescribeAddresses, +ec2:DisassociateAddress, +ec2:DeleteTags, +ec2:CreateTags, +ec2:AssociateAddress +``` + diff --git a/docs/aws-docs/providers/aws/ec2/eip_association/index.md b/docs/aws-docs/providers/aws/ec2/eip_association/index.md new file mode 100644 index 0000000000..4289142e9a --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/eip_association/index.md @@ -0,0 +1,88 @@ +--- +title: eip_association +hide_title: false +hide_table_of_contents: false +keywords: + - eip_association + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual eip_association resource + +## Overview + + + + + +
Nameeip_association
TypeResource
DescriptionResource schema for EC2 EIP association.
Idaws.ec2.eip_association
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
idstringComposite ID of non-empty properties, to determine the identification.
allocation_idstringThe allocation ID. This is required for EC2-VPC.
network_interface_idstringThe ID of the network interface.
instance_idstringThe ID of the instance.
private_ip_addressstringThe primary or secondary private IP address to associate with the Elastic IP address.
e_ipstringThe Elastic IP address to associate with the instance.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +allocation_id, +network_interface_id, +instance_id, +private_ip_address, +e_ip +FROM aws.ec2.eip_association +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the eip_association resource, the following permissions are required: + +### Read +```json +ec2:DescribeAddresses +``` + +### Delete +```json +ec2:DisassociateAddress, +ec2:DescribeAddresses +``` + diff --git a/docs/aws-docs/providers/aws/ec2/eip_associations/index.md b/docs/aws-docs/providers/aws/ec2/eip_associations/index.md new file mode 100644 index 0000000000..a01d1897b1 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/eip_associations/index.md @@ -0,0 +1,78 @@ +--- +title: eip_associations +hide_title: false +hide_table_of_contents: false +keywords: + - eip_associations + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Retrieves a list of eip_associations in a region + +## Overview + + + + + +
Nameeip_associations
TypeResource
DescriptionResource schema for EC2 EIP association.
Idaws.ec2.eip_associations
+ +## Fields + + + + + +
NameDatatypeDescription
idstringComposite ID of non-empty properties, to determine the identification.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.ec2.eip_associations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the eip_associations resource, the following permissions are required: + +### Create +```json +ec2:DescribeAddresses, +ec2:AssociateAddress +``` + +### List +```json +ec2:DescribeAddresses +``` + diff --git a/docs/aws-docs/providers/aws/ec2/eips/index.md b/docs/aws-docs/providers/aws/ec2/eips/index.md new file mode 100644 index 0000000000..690816d77a --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/eips/index.md @@ -0,0 +1,83 @@ +--- +title: eips +hide_title: false +hide_table_of_contents: false +keywords: + - eips + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Retrieves a list of eips in a region + +## Overview + + + + + +
Nameeips
TypeResource
DescriptionSpecifies an Elastic IP (EIP) address and can, optionally, associate it with an Amazon EC2 instance.<br/> You can allocate an Elastic IP address from an address pool owned by AWS or from an address pool created from a public IPv4 address range that you have brought to AWS for use with your AWS resources using bring your own IP addresses (BYOIP). For more information, see [Bring Your Own IP Addresses (BYOIP)](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html) in the *Amazon EC2 User Guide*.<br/> For more information, see [Elastic IP Addresses](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) in the *Amazon EC2 User Guide*.
Idaws.ec2.eips
+ +## Fields + + + + + + +
NameDatatypeDescription
public_ipstring
allocation_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +public_ip, +allocation_id +FROM aws.ec2.eips +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the eips resource, the following permissions are required: + +### Create +```json +ec2:AllocateAddress, +ec2:AcceptAddressTransfer, +ec2:DescribeAddresses, +ec2:AssociateAddress, +ec2:CreateTags +``` + +### List +```json +ec2:DescribeAddresses +``` + diff --git a/docs/aws-docs/providers/aws/ec2/elastic_gpus/index.md b/docs/aws-docs/providers/aws/ec2/elastic_gpus/index.md deleted file mode 100644 index bc726ff23e..0000000000 --- a/docs/aws-docs/providers/aws/ec2/elastic_gpus/index.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: elastic_gpus -hide_title: false -hide_table_of_contents: false -keywords: - - elastic_gpus - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameelastic_gpus
TypeResource
Idaws.ec2.elastic_gpus
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `availabilityZone` | `string` | The Availability Zone in the which the Elastic Graphics accelerator resides. | -| `elasticGpuHealth` | `object` | Describes the status of an Elastic Graphics accelerator. | -| `elasticGpuId` | `string` | The ID of the Elastic Graphics accelerator. | -| `elasticGpuState` | `string` | The state of the Elastic Graphics accelerator. | -| `elasticGpuType` | `string` | The type of Elastic Graphics accelerator. | -| `instanceId` | `string` | The ID of the instance to which the Elastic Graphics accelerator is attached. | -| `tagSet` | `array` | The tags assigned to the Elastic Graphics accelerator. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `elastic_gpus_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2/enclave_certificate_iam_role/index.md b/docs/aws-docs/providers/aws/ec2/enclave_certificate_iam_role/index.md deleted file mode 100644 index 62d38578a4..0000000000 --- a/docs/aws-docs/providers/aws/ec2/enclave_certificate_iam_role/index.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: enclave_certificate_iam_role -hide_title: false -hide_table_of_contents: false -keywords: - - enclave_certificate_iam_role - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameenclave_certificate_iam_role
TypeResource
Idaws.ec2.enclave_certificate_iam_role
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `enclave_certificate_iam_role_Associate` | `EXEC` | `region` | <p>Associates an Identity and Access Management (IAM) role with an Certificate Manager (ACM) certificate. This enables the certificate to be used by the ACM for Nitro Enclaves application inside an enclave. For more information, see <a href="https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave-refapp.html">Certificate Manager for Nitro Enclaves</a> in the <i>Amazon Web Services Nitro Enclaves User Guide</i>.</p> <p>When the IAM role is associated with the ACM certificate, the certificate, certificate chain, and encrypted private key are placed in an Amazon S3 bucket that only the associated IAM role can access. The private key of the certificate is encrypted with an Amazon Web Services managed key that has an attached attestation-based key policy.</p> <p>To enable the IAM role to access the Amazon S3 object, you must grant it permission to call <code>s3:GetObject</code> on the Amazon S3 bucket returned by the command. To enable the IAM role to access the KMS key, you must grant it permission to call <code>kms:Decrypt</code> on the KMS key returned by the command. For more information, see <a href="https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave-refapp.html#add-policy"> Grant the role permission to access the certificate and encryption key</a> in the <i>Amazon Web Services Nitro Enclaves User Guide</i>.</p> | -| `enclave_certificate_iam_role_Disassociate` | `EXEC` | `region` | Disassociates an IAM role from an Certificate Manager (ACM) certificate. Disassociating an IAM role from an ACM certificate removes the Amazon S3 object that contains the certificate, certificate chain, and encrypted private key from the Amazon S3 bucket. It also revokes the IAM role's permission to use the KMS key used to encrypt the private key. This effectively revokes the role's permission to use the certificate. | diff --git a/docs/aws-docs/providers/aws/ec2/enclave_certificate_iam_role_association/index.md b/docs/aws-docs/providers/aws/ec2/enclave_certificate_iam_role_association/index.md new file mode 100644 index 0000000000..fafc4e319c --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/enclave_certificate_iam_role_association/index.md @@ -0,0 +1,85 @@ +--- +title: enclave_certificate_iam_role_association +hide_title: false +hide_table_of_contents: false +keywords: + - enclave_certificate_iam_role_association + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual enclave_certificate_iam_role_association resource + +## Overview + + + + + +
Nameenclave_certificate_iam_role_association
TypeResource
DescriptionAssociates an AWS Identity and Access Management (IAM) role with an AWS Certificate Manager (ACM) certificate. This association is based on Amazon Resource Names and it enables the certificate to be used by the ACM for Nitro Enclaves application inside an enclave.
Idaws.ec2.enclave_certificate_iam_role_association
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
certificate_arnstringThe Amazon Resource Name (ARN) of the ACM certificate with which to associate the IAM role.
role_arnstringThe Amazon Resource Name (ARN) of the IAM role to associate with the ACM certificate. You can associate up to 16 IAM roles with an ACM certificate.
certificate_s3_bucket_namestringThe name of the Amazon S3 bucket to which the certificate was uploaded.
certificate_s3_object_keystringThe Amazon S3 object key where the certificate, certificate chain, and encrypted private key bundle are stored.
encryption_kms_key_idstringThe ID of the AWS KMS CMK used to encrypt the private key of the certificate.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +certificate_arn, +role_arn, +certificate_s3_bucket_name, +certificate_s3_object_key, +encryption_kms_key_id +FROM aws.ec2.enclave_certificate_iam_role_association +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the enclave_certificate_iam_role_association resource, the following permissions are required: + +### Read +```json +ec2:GetAssociatedEnclaveCertificateIamRoles +``` + +### Delete +```json +ec2:DisassociateEnclaveCertificateIamRole +``` + diff --git a/docs/aws-docs/providers/aws/ec2/enclave_certificate_iam_role_associations/index.md b/docs/aws-docs/providers/aws/ec2/enclave_certificate_iam_role_associations/index.md new file mode 100644 index 0000000000..d4f994a9e2 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/enclave_certificate_iam_role_associations/index.md @@ -0,0 +1,79 @@ +--- +title: enclave_certificate_iam_role_associations +hide_title: false +hide_table_of_contents: false +keywords: + - enclave_certificate_iam_role_associations + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Retrieves a list of enclave_certificate_iam_role_associations in a region + +## Overview + + + + + +
Nameenclave_certificate_iam_role_associations
TypeResource
DescriptionAssociates an AWS Identity and Access Management (IAM) role with an AWS Certificate Manager (ACM) certificate. This association is based on Amazon Resource Names and it enables the certificate to be used by the ACM for Nitro Enclaves application inside an enclave.
Idaws.ec2.enclave_certificate_iam_role_associations
+ +## Fields + + + + + + +
NameDatatypeDescription
certificate_arnstringThe Amazon Resource Name (ARN) of the ACM certificate with which to associate the IAM role.
role_arnstringThe Amazon Resource Name (ARN) of the IAM role to associate with the ACM certificate. You can associate up to 16 IAM roles with an ACM certificate.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +certificate_arn, +role_arn +FROM aws.ec2.enclave_certificate_iam_role_associations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the enclave_certificate_iam_role_associations resource, the following permissions are required: + +### Create +```json +ec2:AssociateEnclaveCertificateIamRole +``` + +### List +```json +ec2:GetAssociatedEnclaveCertificateIamRoles +``` + diff --git a/docs/aws-docs/providers/aws/ec2/export_image_tasks/index.md b/docs/aws-docs/providers/aws/ec2/export_image_tasks/index.md deleted file mode 100644 index 18942bfafc..0000000000 --- a/docs/aws-docs/providers/aws/ec2/export_image_tasks/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: export_image_tasks -hide_title: false -hide_table_of_contents: false -keywords: - - export_image_tasks - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameexport_image_tasks
TypeResource
Idaws.ec2.export_image_tasks
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `description` | `string` | A description of the image being exported. | -| `exportImageTaskId` | `string` | The ID of the export image task. | -| `imageId` | `string` | The ID of the image. | -| `progress` | `string` | The percent complete of the export image task. | -| `s3ExportLocation` | `object` | Describes the destination for an export image task. | -| `status` | `string` | The status of the export image task. The possible values are <code>active</code>, <code>completed</code>, <code>deleting</code>, and <code>deleted</code>. | -| `statusMessage` | `string` | The status message for the export image task. | -| `tagSet` | `array` | Any tags assigned to the export image task. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `export_image_tasks_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2/export_tasks/index.md b/docs/aws-docs/providers/aws/ec2/export_tasks/index.md deleted file mode 100644 index f6e843738a..0000000000 --- a/docs/aws-docs/providers/aws/ec2/export_tasks/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: export_tasks -hide_title: false -hide_table_of_contents: false -keywords: - - export_tasks - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameexport_tasks
TypeResource
Idaws.ec2.export_tasks
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `description` | `string` | A description of the resource being exported. | -| `exportTaskId` | `string` | The ID of the export task. | -| `exportToS3` | `object` | Describes the format and location for the export task. | -| `instanceExport` | `object` | Describes an instance to export. | -| `state` | `string` | The state of the export task. | -| `statusMessage` | `string` | The status message related to the export task. | -| `tagSet` | `array` | The tags for the export task. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `export_tasks_Describe` | `SELECT` | `region` | Describes the specified export instance tasks or all of your export instance tasks. | -| `export_task_Cancel` | `EXEC` | `ExportTaskId, region` | Cancels an active export task. The request removes all artifacts of the export, including any partially-created Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the command fails and returns an error. | diff --git a/docs/aws-docs/providers/aws/ec2/fast_launch/index.md b/docs/aws-docs/providers/aws/ec2/fast_launch/index.md deleted file mode 100644 index 2234c27910..0000000000 --- a/docs/aws-docs/providers/aws/ec2/fast_launch/index.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: fast_launch -hide_title: false -hide_table_of_contents: false -keywords: - - fast_launch - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namefast_launch
TypeResource
Idaws.ec2.fast_launch
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `fast_launch_Disable` | `EXEC` | `ImageId, region` | <p>Discontinue faster launching for a Windows AMI, and clean up existing pre-provisioned snapshots. When you disable faster launching, the AMI uses the standard launch process for each instance. All pre-provisioned snapshots must be removed before you can enable faster launching again.</p> <note> <p>To change these settings, you must own the AMI.</p> </note> | -| `fast_launch_Enable` | `EXEC` | `ImageId, region` | <p>When you enable faster launching for a Windows AMI, images are pre-provisioned, using snapshots to launch instances up to 65% faster. To create the optimized Windows image, Amazon EC2 launches an instance and runs through Sysprep steps, rebooting as required. Then it creates a set of reserved snapshots that are used for subsequent launches. The reserved snapshots are automatically replenished as they are used, depending on your settings for launch frequency.</p> <note> <p>To change these settings, you must own the AMI.</p> </note> | diff --git a/docs/aws-docs/providers/aws/ec2/fast_launch_images/index.md b/docs/aws-docs/providers/aws/ec2/fast_launch_images/index.md deleted file mode 100644 index e7058b86f1..0000000000 --- a/docs/aws-docs/providers/aws/ec2/fast_launch_images/index.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: fast_launch_images -hide_title: false -hide_table_of_contents: false -keywords: - - fast_launch_images - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namefast_launch_images
TypeResource
Idaws.ec2.fast_launch_images
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `imageId` | `string` | The image ID that identifies the fast-launch enabled Windows image. | -| `launchTemplate` | `object` | Identifies the launch template to use for faster launching of the Windows AMI. | -| `maxParallelLaunches` | `integer` | The maximum number of parallel instances that are launched for creating resources. | -| `ownerId` | `string` | The owner ID for the fast-launch enabled Windows AMI. | -| `resourceType` | `string` | The resource type that is used for pre-provisioning the Windows AMI. Supported values include: <code>snapshot</code>. | -| `snapshotConfiguration` | `object` | Configuration settings for creating and managing pre-provisioned snapshots for a fast-launch enabled Windows AMI. | -| `state` | `string` | The current state of faster launching for the specified Windows AMI. | -| `stateTransitionReason` | `string` | The reason that faster launching for the Windows AMI changed to the current state. | -| `stateTransitionTime` | `string` | The time that faster launching for the Windows AMI changed to the current state. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `fast_launch_images_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2/fast_snapshot_restores/index.md b/docs/aws-docs/providers/aws/ec2/fast_snapshot_restores/index.md deleted file mode 100644 index 39b01011ce..0000000000 --- a/docs/aws-docs/providers/aws/ec2/fast_snapshot_restores/index.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: fast_snapshot_restores -hide_title: false -hide_table_of_contents: false -keywords: - - fast_snapshot_restores - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namefast_snapshot_restores
TypeResource
Idaws.ec2.fast_snapshot_restores
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `availabilityZone` | `string` | The Availability Zone. | -| `disabledTime` | `string` | The time at which fast snapshot restores entered the <code>disabled</code> state. | -| `disablingTime` | `string` | The time at which fast snapshot restores entered the <code>disabling</code> state. | -| `enabledTime` | `string` | The time at which fast snapshot restores entered the <code>enabled</code> state. | -| `enablingTime` | `string` | The time at which fast snapshot restores entered the <code>enabling</code> state. | -| `optimizingTime` | `string` | The time at which fast snapshot restores entered the <code>optimizing</code> state. | -| `ownerAlias` | `string` | The Amazon Web Services owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use. | -| `ownerId` | `string` | The ID of the Amazon Web Services account that enabled fast snapshot restores on the snapshot. | -| `snapshotId` | `string` | The ID of the snapshot. | -| `state` | `string` | The state of fast snapshot restores. | -| `stateTransitionReason` | `string` | <p>The reason for the state transition. The possible values are as follows:</p> <ul> <li> <p> <code>Client.UserInitiated</code> - The state successfully transitioned to <code>enabling</code> or <code>disabling</code>.</p> </li> <li> <p> <code>Client.UserInitiated - Lifecycle state transition</code> - The state successfully transitioned to <code>optimizing</code>, <code>enabled</code>, or <code>disabled</code>.</p> </li> </ul> | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `fast_snapshot_restores_Describe` | `SELECT` | `region` | Describes the state of fast snapshot restores for your snapshots. | -| `fast_snapshot_restores_Disable` | `EXEC` | `AvailabilityZone, SourceSnapshotId, region` | Disables fast snapshot restores for the specified snapshots in the specified Availability Zones. | -| `fast_snapshot_restores_Enable` | `EXEC` | `AvailabilityZone, SourceSnapshotId, region` | <p>Enables fast snapshot restores for the specified snapshots in the specified Availability Zones.</p> <p>You get the full benefit of fast snapshot restores after they enter the <code>enabled</code> state. To get the current state of fast snapshot restores, use <a>DescribeFastSnapshotRestores</a>. To disable fast snapshot restores, use <a>DisableFastSnapshotRestores</a>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-fast-snapshot-restore.html">Amazon EBS fast snapshot restore</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2/fleet_history/index.md b/docs/aws-docs/providers/aws/ec2/fleet_history/index.md deleted file mode 100644 index 7cff9409e1..0000000000 --- a/docs/aws-docs/providers/aws/ec2/fleet_history/index.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: fleet_history -hide_title: false -hide_table_of_contents: false -keywords: - - fleet_history - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namefleet_history
TypeResource
Idaws.ec2.fleet_history
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `fleetId` | `string` | The ID of the EC Fleet. | -| `historyRecordSet` | `array` | Information about the events in the history of the EC2 Fleet. | -| `lastEvaluatedTime` | `string` | <p>The last date and time for the events, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z). All records up to this time were retrieved.</p> <p>If <code>nextToken</code> indicates that there are more results, this value is not present.</p> | -| `nextToken` | `string` | The token for the next set of results. | -| `startTime` | `string` | The start date and time for the events, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z). | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `fleet_history_Describe` | `SELECT` | `FleetId, StartTime, region` | diff --git a/docs/aws-docs/providers/aws/ec2/fleet_instances/index.md b/docs/aws-docs/providers/aws/ec2/fleet_instances/index.md deleted file mode 100644 index 9abf234715..0000000000 --- a/docs/aws-docs/providers/aws/ec2/fleet_instances/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: fleet_instances -hide_title: false -hide_table_of_contents: false -keywords: - - fleet_instances - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namefleet_instances
TypeResource
Idaws.ec2.fleet_instances
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `instanceHealth` | `string` | The health status of the instance. If the status of either the instance status check or the system status check is <code>impaired</code>, the health status of the instance is <code>unhealthy</code>. Otherwise, the health status is <code>healthy</code>. | -| `instanceId` | `string` | The ID of the instance. | -| `instanceType` | `string` | The instance type. | -| `spotInstanceRequestId` | `string` | The ID of the Spot Instance request. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `fleet_instances_Describe` | `SELECT` | `FleetId, region` | diff --git a/docs/aws-docs/providers/aws/ec2/fleets/index.md b/docs/aws-docs/providers/aws/ec2/fleets/index.md deleted file mode 100644 index 42a72817cd..0000000000 --- a/docs/aws-docs/providers/aws/ec2/fleets/index.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: fleets -hide_title: false -hide_table_of_contents: false -keywords: - - fleets - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namefleets
TypeResource
Idaws.ec2.fleets
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `activityStatus` | `string` | The progress of the EC2 Fleet. If there is an error, the status is <code>error</code>. After all requests are placed, the status is <code>pending_fulfillment</code>. If the size of the EC2 Fleet is equal to or greater than its target capacity, the status is <code>fulfilled</code>. If the size of the EC2 Fleet is decreased, the status is <code>pending_termination</code> while instances are terminating. | -| `clientToken` | `string` | <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p> <p>Constraints: Maximum 64 ASCII characters</p> | -| `context` | `string` | Reserved. | -| `createTime` | `string` | The creation date and time of the EC2 Fleet. | -| `errorSet` | `array` | Information about the instances that could not be launched by the fleet. Valid only when <b>Type</b> is set to <code>instant</code>. | -| `excessCapacityTerminationPolicy` | `string` | Indicates whether running instances should be terminated if the target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet. | -| `fleetId` | `string` | The ID of the EC2 Fleet. | -| `fleetInstanceSet` | `array` | Information about the instances that were launched by the fleet. Valid only when <b>Type</b> is set to <code>instant</code>. | -| `fleetState` | `string` | The state of the EC2 Fleet. | -| `fulfilledCapacity` | `number` | The number of units fulfilled by this request compared to the set target capacity. | -| `fulfilledOnDemandCapacity` | `number` | The number of units fulfilled by this request compared to the set target On-Demand capacity. | -| `launchTemplateConfigs` | `array` | The launch template and overrides. | -| `onDemandOptions` | `object` | Describes the configuration of On-Demand Instances in an EC2 Fleet. | -| `replaceUnhealthyInstances` | `boolean` | Indicates whether EC2 Fleet should replace unhealthy Spot Instances. Supported only for fleets of type <code>maintain</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#ec2-fleet-health-checks">EC2 Fleet health checks</a> in the <i>Amazon EC2 User Guide</i>. | -| `spotOptions` | `object` | Describes the configuration of Spot Instances in an EC2 Fleet. | -| `tagSet` | `array` | The tags for an EC2 Fleet resource. | -| `targetCapacitySpecification` | `object` | <p>The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is <code>maintain</code>, you can specify a target capacity of 0 and add capacity later.</p> <p>You can use the On-Demand Instance <code>MaxTotalPrice</code> parameter, the Spot Instance <code>MaxTotalPrice</code>, or both to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, EC2 Fleet will launch instances until it reaches the maximum amount that you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity. The <code>MaxTotalPrice</code> parameters are located in <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_OnDemandOptions.html">OnDemandOptions</a> and <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotOptions">SpotOptions</a>.</p> | -| `terminateInstancesWithExpiration` | `boolean` | Indicates whether running instances should be terminated when the EC2 Fleet expires. | -| `type` | `string` | The type of request. Indicates whether the EC2 Fleet only <code>requests</code> the target capacity, or also attempts to <code>maintain</code> it. If you request a certain target capacity, EC2 Fleet only places the required requests; it does not attempt to replenish instances if capacity is diminished, and it does not submit requests in alternative capacity pools if capacity is unavailable. To maintain a certain target capacity, EC2 Fleet places the required requests to meet this target capacity. It also automatically replenishes any interrupted Spot Instances. Default: <code>maintain</code>. | -| `validFrom` | `string` | The start date and time of the request, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z). The default is to start fulfilling the request immediately. | -| `validUntil` | `string` | The end date and time of the request, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z). At this point, no new instance requests are placed or able to fulfill the request. The default end date is 7 days from the current date. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `fleets_Describe` | `SELECT` | `region` | <p>Describes the specified EC2 Fleets or all of your EC2 Fleets.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#monitor-ec2-fleet">Monitor your EC2 Fleet</a> in the <i>Amazon EC2 User Guide</i>.</p> | -| `fleet_Create` | `INSERT` | `LaunchTemplateConfigs, TargetCapacitySpecification, region` | <p>Launches an EC2 Fleet.</p> <p>You can create a single EC2 Fleet that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet.html">EC2 Fleet</a> in the <i>Amazon EC2 User Guide</i>.</p> | -| `fleets_Delete` | `DELETE` | `FleetId, TerminateInstances, region` | <p>Deletes the specified EC2 Fleet.</p> <p>After you delete an EC2 Fleet, it launches no new instances.</p> <p>You must specify whether a deleted EC2 Fleet should also terminate its instances. If you choose to terminate the instances, the EC2 Fleet enters the <code>deleted_terminating</code> state. Otherwise, the EC2 Fleet enters the <code>deleted_running</code> state, and the instances continue to run until they are interrupted or you terminate them manually.</p> <p>For <code>instant</code> fleets, EC2 Fleet must terminate the instances when the fleet is deleted. A deleted <code>instant</code> fleet with running instances is not supported.</p> <p class="title"> <b>Restrictions</b> </p> <ul> <li> <p>You can delete up to 25 <code>instant</code> fleets in a single request. If you exceed this number, no <code>instant</code> fleets are deleted and an error is returned. There is no restriction on the number of fleets of type <code>maintain</code> or <code>request</code> that can be deleted in a single request.</p> </li> <li> <p>Up to 1000 instances can be terminated in a single request to delete <code>instant</code> fleets.</p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#delete-fleet">Delete an EC2 Fleet</a> in the <i>Amazon EC2 User Guide</i>.</p> | -| `fleet_Modify` | `EXEC` | `FleetId, region` | <p>Modifies the specified EC2 Fleet.</p> <p>You can only modify an EC2 Fleet request of type <code>maintain</code>.</p> <p>While the EC2 Fleet is being modified, it is in the <code>modifying</code> state.</p> <p>To scale up your EC2 Fleet, increase its target capacity. The EC2 Fleet launches the additional Spot Instances according to the allocation strategy for the EC2 Fleet request. If the allocation strategy is <code>lowest-price</code>, the EC2 Fleet launches instances using the Spot Instance pool with the lowest price. If the allocation strategy is <code>diversified</code>, the EC2 Fleet distributes the instances across the Spot Instance pools. If the allocation strategy is <code>capacity-optimized</code>, EC2 Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.</p> <p>To scale down your EC2 Fleet, decrease its target capacity. First, the EC2 Fleet cancels any open requests that exceed the new target capacity. You can request that the EC2 Fleet terminate Spot Instances until the size of the fleet no longer exceeds the new target capacity. If the allocation strategy is <code>lowest-price</code>, the EC2 Fleet terminates the instances with the highest price per unit. If the allocation strategy is <code>capacity-optimized</code>, the EC2 Fleet terminates the instances in the Spot Instance pools that have the least available Spot Instance capacity. If the allocation strategy is <code>diversified</code>, the EC2 Fleet terminates instances across the Spot Instance pools. Alternatively, you can request that the EC2 Fleet keep the fleet at its current size, but not replace any Spot Instances that are interrupted or that you terminate manually.</p> <p>If you are finished with your EC2 Fleet for now, but will use it again later, you can set the target capacity to 0.</p> | diff --git a/docs/aws-docs/providers/aws/ec2/flow_log/index.md b/docs/aws-docs/providers/aws/ec2/flow_log/index.md new file mode 100644 index 0000000000..09fffb11f9 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/flow_log/index.md @@ -0,0 +1,115 @@ +--- +title: flow_log +hide_title: false +hide_table_of_contents: false +keywords: + - flow_log + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual flow_log resource + +## Overview + + + + + +
Nameflow_log
TypeResource
DescriptionSpecifies a VPC flow log, which enables you to capture IP traffic for a specific network interface, subnet, or VPC.
Idaws.ec2.flow_log
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
idstringThe Flow Log ID
deliver_cross_account_rolestringThe ARN of the IAM role that allows Amazon EC2 to publish flow logs across accounts.
deliver_logs_permission_arnstringThe ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account. If you specify LogDestinationType as s3 or kinesis-data-firehose, do not specify DeliverLogsPermissionArn or LogGroupName.
log_destinationstringSpecifies the destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group, an Amazon S3 bucket, or a Kinesis Firehose stream. The value specified for this parameter depends on the value specified for LogDestinationType.
log_destination_typestringSpecifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3.
log_formatstringThe fields to include in the flow log record, in the order in which they should appear.
log_group_namestringThe name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs. If you specify LogDestinationType as s3 or kinesis-data-firehose, do not specify DeliverLogsPermissionArn or LogGroupName.
max_aggregation_intervalintegerThe maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes).
resource_idstringThe ID of the subnet, network interface, or VPC for which you want to create a flow log.
resource_typestringThe type of resource for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property.
tagsarrayThe tags to apply to the flow logs.
traffic_typestringThe type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.
destination_optionsobject
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +deliver_cross_account_role, +deliver_logs_permission_arn, +log_destination, +log_destination_type, +log_format, +log_group_name, +max_aggregation_interval, +resource_id, +resource_type, +tags, +traffic_type, +destination_options +FROM aws.ec2.flow_log +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the flow_log resource, the following permissions are required: + +### Read +```json +ec2:DescribeFlowLogs +``` + +### Update +```json +ec2:CreateTags, +ec2:DeleteTags, +ec2:DescribeFlowLogs +``` + +### Delete +```json +ec2:DeleteFlowLogs, +ec2:DescribeFlowLogs, +logs:DeleteLogDelivery +``` + diff --git a/docs/aws-docs/providers/aws/ec2/flow_logs/index.md b/docs/aws-docs/providers/aws/ec2/flow_logs/index.md index a75c7d792c..db63ac1fe3 100644 --- a/docs/aws-docs/providers/aws/ec2/flow_logs/index.md +++ b/docs/aws-docs/providers/aws/ec2/flow_logs/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - flow_logs - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,37 +14,70 @@ description: Query, deploy 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_logs in a region ## Overview +
Nameflow_logs
TypeResource
DescriptionSpecifies a VPC flow log, which enables you to capture IP traffic for a specific network interface, subnet, or VPC.
Idaws.ec2.flow_logs
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `creationTime` | `string` | The date and time the flow log was created. | -| `deliverLogsErrorMessage` | `string` | Information about the error that occurred. <code>Rate limited</code> indicates that CloudWatch Logs throttling has been applied for one or more network interfaces, or that you've reached the limit on the number of log groups that you can create. <code>Access error</code> indicates that the IAM role associated with the flow log does not have sufficient permissions to publish to CloudWatch Logs. <code>Unknown error</code> indicates an internal error. | -| `deliverLogsPermissionArn` | `string` | The ARN of the IAM role that posts logs to CloudWatch Logs. | -| `deliverLogsStatus` | `string` | The status of the logs delivery (<code>SUCCESS</code> \| <code>FAILED</code>). | -| `destinationOptions` | `object` | Describes the destination options for a flow log. | -| `flowLogId` | `string` | The flow log ID. | -| `flowLogStatus` | `string` | The status of the flow log (<code>ACTIVE</code>). | -| `logDestination` | `string` | The destination to which the flow log data is published. Flow log data can be published to an CloudWatch Logs log group or an Amazon S3 bucket. If the flow log publishes to CloudWatch Logs, this element indicates the Amazon Resource Name (ARN) of the CloudWatch Logs log group to which the data is published. If the flow log publishes to Amazon S3, this element indicates the ARN of the Amazon S3 bucket to which the data is published. | -| `logDestinationType` | `string` | The type of destination to which the flow log data is published. Flow log data can be published to CloudWatch Logs or Amazon S3. | -| `logFormat` | `string` | The format of the flow log record. | -| `logGroupName` | `string` | The name of the flow log group. | -| `maxAggregationInterval` | `integer` | <p>The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record.</p> <p>When a network interface is attached to a <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances">Nitro-based instance</a>, the aggregation interval is always 60 seconds (1 minute) or less, regardless of the specified value.</p> <p>Valid Values: <code>60</code> \| <code>600</code> </p> | -| `resourceId` | `string` | The ID of the resource on which the flow log was created. | -| `tagSet` | `array` | The tags for the flow log. | -| `trafficType` | `string` | The type of traffic captured for the flow log. | + + + + + +
NameDatatypeDescription
idstringThe Flow Log ID
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `flow_logs_Describe` | `SELECT` | `region` | Describes one or more flow logs. To view the information in your flow logs (the log streams for the network interfaces), you must use the CloudWatch Logs console or the CloudWatch Logs API. | -| `flow_logs_Create` | `INSERT` | `ResourceId, ResourceType, TrafficType, region` | <p>Creates one or more flow logs to capture information about IP traffic for a specific network interface, subnet, or VPC. </p> <p>Flow log data for a monitored network interface is recorded as flow log records, which are log events consisting of fields that describe the traffic flow. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html#flow-log-records">Flow log records</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p> <p>When publishing to CloudWatch Logs, flow log records are published to a log group, and each network interface has a unique log stream in the log group. When publishing to Amazon S3, flow log records for all of the monitored network interfaces are published to a single log file object that is stored in the specified bucket.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html">VPC Flow Logs</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p> | -| `flow_logs_Delete` | `DELETE` | `FlowLogId, region` | Deletes one or more flow logs. | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.ec2.flow_logs +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the flow_logs resource, the following permissions are required: + +### Create +```json +ec2:CreateFlowLogs, +ec2:DescribeFlowLogs, +ec2:CreateTags, +iam:PassRole, +logs:CreateLogDelivery, +s3:GetBucketPolicy, +s3:PutBucketPolicy +``` + +### List +```json +ec2:DescribeFlowLogs +``` + diff --git a/docs/aws-docs/providers/aws/ec2/flow_logs_integration_template/index.md b/docs/aws-docs/providers/aws/ec2/flow_logs_integration_template/index.md deleted file mode 100644 index 351e7b3402..0000000000 --- a/docs/aws-docs/providers/aws/ec2/flow_logs_integration_template/index.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: flow_logs_integration_template -hide_title: false -hide_table_of_contents: false -keywords: - - flow_logs_integration_template - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameflow_logs_integration_template
TypeResource
Idaws.ec2.flow_logs_integration_template
- -## Fields -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `flow_logs_integration_template_Get` | `SELECT` | `ConfigDeliveryS3DestinationArn, FlowLogId, IntegrateService, region` | diff --git a/docs/aws-docs/providers/aws/ec2/fpga_image_attribute/index.md b/docs/aws-docs/providers/aws/ec2/fpga_image_attribute/index.md deleted file mode 100644 index c32d90e6a3..0000000000 --- a/docs/aws-docs/providers/aws/ec2/fpga_image_attribute/index.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: fpga_image_attribute -hide_title: false -hide_table_of_contents: false -keywords: - - fpga_image_attribute - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namefpga_image_attribute
TypeResource
Idaws.ec2.fpga_image_attribute
- -## Fields -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `fpga_image_attribute_Describe` | `SELECT` | `Attribute, FpgaImageId, region` | Describes the specified attribute of the specified Amazon FPGA Image (AFI). | -| `fpga_image_attribute_Modify` | `EXEC` | `FpgaImageId, region` | Modifies the specified attribute of the specified Amazon FPGA Image (AFI). | -| `fpga_image_attribute_Reset` | `EXEC` | `FpgaImageId, region` | Resets the specified attribute of the specified Amazon FPGA Image (AFI) to its default value. You can only reset the load permission attribute. | diff --git a/docs/aws-docs/providers/aws/ec2/fpga_images/index.md b/docs/aws-docs/providers/aws/ec2/fpga_images/index.md deleted file mode 100644 index 8876ac623f..0000000000 --- a/docs/aws-docs/providers/aws/ec2/fpga_images/index.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: fpga_images -hide_title: false -hide_table_of_contents: false -keywords: - - fpga_images - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namefpga_images
TypeResource
Idaws.ec2.fpga_images
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | The name of the AFI. | -| `description` | `string` | The description of the AFI. | -| `createTime` | `string` | The date and time the AFI was created. | -| `dataRetentionSupport` | `boolean` | Indicates whether data retention support is enabled for the AFI. | -| `fpgaImageGlobalId` | `string` | The global FPGA image identifier (AGFI ID). | -| `fpgaImageId` | `string` | The FPGA image identifier (AFI ID). | -| `ownerAlias` | `string` | The alias of the AFI owner. Possible values include <code>self</code>, <code>amazon</code>, and <code>aws-marketplace</code>. | -| `ownerId` | `string` | The ID of the Amazon Web Services account that owns the AFI. | -| `pciId` | `object` | Describes the data that identifies an Amazon FPGA image (AFI) on the PCI bus. | -| `productCodes` | `array` | The product codes for the AFI. | -| `public` | `boolean` | Indicates whether the AFI is public. | -| `shellVersion` | `string` | The version of the Amazon Web Services Shell that was used to create the bitstream. | -| `state` | `object` | Describes the state of the bitstream generation process for an Amazon FPGA image (AFI). | -| `tags` | `array` | Any tags assigned to the AFI. | -| `updateTime` | `string` | The time of the most recent update to the AFI. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `fpga_images_Describe` | `SELECT` | `region` | Describes the Amazon FPGA Images (AFIs) available to you. These include public AFIs, private AFIs that you own, and AFIs owned by other Amazon Web Services accounts for which you have load permissions. | -| `fpga_image_Create` | `INSERT` | `InputStorageLocation, region` | <p>Creates an Amazon FPGA Image (AFI) from the specified design checkpoint (DCP).</p> <p>The create operation is asynchronous. To verify that the AFI is ready for use, check the output logs.</p> <p>An AFI contains the FPGA bitstream that is ready to download to an FPGA. You can securely deploy an AFI on multiple FPGA-accelerated instances. For more information, see the <a href="https://github.com/aws/aws-fpga/">Amazon Web Services FPGA Hardware Development Kit</a>.</p> | -| `fpga_image_Delete` | `DELETE` | `FpgaImageId, region` | Deletes the specified Amazon FPGA Image (AFI). | -| `fpga_image_Copy` | `EXEC` | `SourceFpgaImageId, SourceRegion, region` | Copies the specified Amazon FPGA Image (AFI) to the current Region. | diff --git a/docs/aws-docs/providers/aws/ec2/gateway_route_table_association/index.md b/docs/aws-docs/providers/aws/ec2/gateway_route_table_association/index.md new file mode 100644 index 0000000000..4a02f894a2 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/gateway_route_table_association/index.md @@ -0,0 +1,93 @@ +--- +title: gateway_route_table_association +hide_title: false +hide_table_of_contents: false +keywords: + - gateway_route_table_association + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual gateway_route_table_association resource + +## Overview + + + + + +
Namegateway_route_table_association
TypeResource
DescriptionAssociates a gateway with a route table. The gateway and route table must be in the same VPC. This association causes the incoming traffic to the gateway to be routed according to the routes in the route table.
Idaws.ec2.gateway_route_table_association
+ +## Fields + + + + + + + +
NameDatatypeDescription
route_table_idstringThe ID of the route table.
gateway_idstringThe ID of the gateway.
association_idstringThe route table association ID.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +route_table_id, +gateway_id, +association_id +FROM aws.ec2.gateway_route_table_association +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the gateway_route_table_association resource, the following permissions are required: + +### Read +```json +ec2:DescribeRouteTables +``` + +### Update +```json +ec2:DescribeRouteTables, +ec2:ReplaceRouteTableAssociation +``` + +### Delete +```json +ec2:DescribeRouteTables, +ec2:DisassociateRouteTable +``` + diff --git a/docs/aws-docs/providers/aws/ec2/gateway_route_table_associations/index.md b/docs/aws-docs/providers/aws/ec2/gateway_route_table_associations/index.md new file mode 100644 index 0000000000..d57c6e9e5d --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/gateway_route_table_associations/index.md @@ -0,0 +1,68 @@ +--- +title: gateway_route_table_associations +hide_title: false +hide_table_of_contents: false +keywords: + - gateway_route_table_associations + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Retrieves a list of gateway_route_table_associations in a region + +## Overview + + + + + +
Namegateway_route_table_associations
TypeResource
DescriptionAssociates a gateway with a route table. The gateway and route table must be in the same VPC. This association causes the incoming traffic to the gateway to be routed according to the routes in the route table.
Idaws.ec2.gateway_route_table_associations
+ +## Fields + + + + + +
NameDatatypeDescription
gateway_idstringThe ID of the gateway.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +gateway_id +FROM aws.ec2.gateway_route_table_associations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the gateway_route_table_associations resource, the following permissions are required: + +### Create +```json +ec2:DescribeRouteTables, +ec2:AssociateRouteTable +``` + diff --git a/docs/aws-docs/providers/aws/ec2/groups_for_capacity_reservation/index.md b/docs/aws-docs/providers/aws/ec2/groups_for_capacity_reservation/index.md deleted file mode 100644 index 31543ee134..0000000000 --- a/docs/aws-docs/providers/aws/ec2/groups_for_capacity_reservation/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: groups_for_capacity_reservation -hide_title: false -hide_table_of_contents: false -keywords: - - groups_for_capacity_reservation - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namegroups_for_capacity_reservation
TypeResource
Idaws.ec2.groups_for_capacity_reservation
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `groupArn` | `string` | The ARN of the resource group. | -| `ownerId` | `string` | The ID of the Amazon Web Services account that owns the resource group. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `groups_for_capacity_reservation_Get` | `SELECT` | `CapacityReservationId, region` | diff --git a/docs/aws-docs/providers/aws/ec2/host/index.md b/docs/aws-docs/providers/aws/ec2/host/index.md new file mode 100644 index 0000000000..89b6fa3d6a --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/host/index.md @@ -0,0 +1,105 @@ +--- +title: host +hide_title: false +hide_table_of_contents: false +keywords: + - host + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual host resource + +## Overview + + + + + +
Namehost
TypeResource
DescriptionResource Type definition for AWS::EC2::Host
Idaws.ec2.host
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
host_idstringID of the host created.
auto_placementstringIndicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID.
availability_zonestringThe Availability Zone in which to allocate the Dedicated Host.
host_recoverystringIndicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default.
instance_typestringSpecifies the instance type to be supported by the Dedicated Hosts. If you specify an instance type, the Dedicated Hosts support instances of the specified instance type only.
instance_familystringSpecifies the instance family to be supported by the Dedicated Hosts. If you specify an instance family, the Dedicated Hosts support multiple instance types within that instance family.
outpost_arnstringThe Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which to allocate the Dedicated Host.
host_maintenancestringAutomatically allocates a new dedicated host and moves your instances on to it if a degradation is detected on your current host.
asset_idstringThe ID of the Outpost hardware asset.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +host_id, +auto_placement, +availability_zone, +host_recovery, +instance_type, +instance_family, +outpost_arn, +host_maintenance, +asset_id +FROM aws.ec2.host +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the host resource, the following permissions are required: + +### Read +```json +ec2:DescribeHosts +``` + +### Update +```json +ec2:ModifyHosts, +ec2:DescribeHosts +``` + +### Delete +```json +ec2:ReleaseHosts, +ec2:DescribeHosts +``` + diff --git a/docs/aws-docs/providers/aws/ec2/host_reservation_offerings/index.md b/docs/aws-docs/providers/aws/ec2/host_reservation_offerings/index.md deleted file mode 100644 index 0b46037b6e..0000000000 --- a/docs/aws-docs/providers/aws/ec2/host_reservation_offerings/index.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: host_reservation_offerings -hide_title: false -hide_table_of_contents: false -keywords: - - host_reservation_offerings - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namehost_reservation_offerings
TypeResource
Idaws.ec2.host_reservation_offerings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `currencyCode` | `string` | The currency of the offering. | -| `duration` | `integer` | The duration of the offering (in seconds). | -| `hourlyPrice` | `string` | The hourly price of the offering. | -| `instanceFamily` | `string` | The instance family of the offering. | -| `offeringId` | `string` | The ID of the offering. | -| `paymentOption` | `string` | The available payment option. | -| `upfrontPrice` | `string` | The upfront price of the offering. Does not apply to No Upfront offerings. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `host_reservation_offerings_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2/host_reservation_purchase_preview/index.md b/docs/aws-docs/providers/aws/ec2/host_reservation_purchase_preview/index.md deleted file mode 100644 index 6b991ead2b..0000000000 --- a/docs/aws-docs/providers/aws/ec2/host_reservation_purchase_preview/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: host_reservation_purchase_preview -hide_title: false -hide_table_of_contents: false -keywords: - - host_reservation_purchase_preview - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namehost_reservation_purchase_preview
TypeResource
Idaws.ec2.host_reservation_purchase_preview
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `currencyCode` | `string` | The currency in which the <code>totalUpfrontPrice</code> and <code>totalHourlyPrice</code> amounts are specified. At this time, the only supported currency is <code>USD</code>. | -| `purchase` | `array` | The purchase information of the Dedicated Host reservation and the Dedicated Hosts associated with it. | -| `totalHourlyPrice` | `string` | The potential total hourly price of the reservation per hour. | -| `totalUpfrontPrice` | `string` | The potential total upfront price. This is billed immediately. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `host_reservation_purchase_preview_Get` | `SELECT` | `HostIdSet, OfferingId, region` | diff --git a/docs/aws-docs/providers/aws/ec2/host_reservations/index.md b/docs/aws-docs/providers/aws/ec2/host_reservations/index.md deleted file mode 100644 index eb31bdbc42..0000000000 --- a/docs/aws-docs/providers/aws/ec2/host_reservations/index.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: host_reservations -hide_title: false -hide_table_of_contents: false -keywords: - - host_reservations - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namehost_reservations
TypeResource
Idaws.ec2.host_reservations
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `count` | `integer` | The number of Dedicated Hosts the reservation is associated with. | -| `currencyCode` | `string` | The currency in which the <code>upfrontPrice</code> and <code>hourlyPrice</code> amounts are specified. At this time, the only supported currency is <code>USD</code>. | -| `duration` | `integer` | The length of the reservation's term, specified in seconds. Can be <code>31536000 (1 year)</code> \| <code>94608000 (3 years)</code>. | -| `end` | `string` | The date and time that the reservation ends. | -| `hostIdSet` | `array` | The IDs of the Dedicated Hosts associated with the reservation. | -| `hostReservationId` | `string` | The ID of the reservation that specifies the associated Dedicated Hosts. | -| `hourlyPrice` | `string` | The hourly price of the reservation. | -| `instanceFamily` | `string` | The instance family of the Dedicated Host Reservation. The instance family on the Dedicated Host must be the same in order for it to benefit from the reservation. | -| `offeringId` | `string` | The ID of the reservation. This remains the same regardless of which Dedicated Hosts are associated with it. | -| `paymentOption` | `string` | The payment option selected for this reservation. | -| `start` | `string` | The date and time that the reservation started. | -| `state` | `string` | The state of the reservation. | -| `tagSet` | `array` | Any tags assigned to the Dedicated Host Reservation. | -| `upfrontPrice` | `string` | The upfront price of the reservation. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `host_reservations_Describe` | `SELECT` | `region` | Describes reservations that are associated with Dedicated Hosts in your account. | -| `host_reservation_Purchase` | `EXEC` | `HostIdSet, OfferingId, region` | Purchase a reservation with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation. This action results in the specified reservation being purchased and charged to your account. | diff --git a/docs/aws-docs/providers/aws/ec2/hosts/index.md b/docs/aws-docs/providers/aws/ec2/hosts/index.md index 7eff500dff..7eb4583968 100644 --- a/docs/aws-docs/providers/aws/ec2/hosts/index.md +++ b/docs/aws-docs/providers/aws/ec2/hosts/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - hosts - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,41 +14,65 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- - - +Retrieves a list of hosts in a region ## Overview +
Namehosts
TypeResource
DescriptionResource Type definition for AWS::EC2::Host
Idaws.ec2.hosts
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `allocationTime` | `string` | The time that the Dedicated Host was allocated. | -| `allowsMultipleInstanceTypes` | `string` | Indicates whether the Dedicated Host supports multiple instance types of the same instance family. If the value is <code>on</code>, the Dedicated Host supports multiple instance types in the instance family. If the value is <code>off</code>, the Dedicated Host supports a single instance type only. | -| `autoPlacement` | `string` | Whether auto-placement is on or off. | -| `availabilityZone` | `string` | The Availability Zone of the Dedicated Host. | -| `availabilityZoneId` | `string` | The ID of the Availability Zone in which the Dedicated Host is allocated. | -| `availableCapacity` | `object` | The capacity information for instances that can be launched onto the Dedicated Host. | -| `clientToken` | `string` | Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring Idempotency</a>. | -| `hostId` | `string` | The ID of the Dedicated Host. | -| `hostProperties` | `object` | Describes the properties of a Dedicated Host. | -| `hostRecovery` | `string` | Indicates whether host recovery is enabled or disabled for the Dedicated Host. | -| `hostReservationId` | `string` | The reservation ID of the Dedicated Host. This returns a <code>null</code> response if the Dedicated Host doesn't have an associated reservation. | -| `instances` | `array` | The IDs and instance type that are currently running on the Dedicated Host. | -| `memberOfServiceLinkedResourceGroup` | `boolean` | Indicates whether the Dedicated Host is in a host resource group. If <b>memberOfServiceLinkedResourceGroup</b> is <code>true</code>, the host is in a host resource group; otherwise, it is not. | -| `outpostArn` | `string` | The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which the Dedicated Host is allocated. | -| `ownerId` | `string` | The ID of the Amazon Web Services account that owns the Dedicated Host. | -| `releaseTime` | `string` | The time that the Dedicated Host was released. | -| `state` | `string` | The Dedicated Host's state. | -| `tagSet` | `array` | Any tags assigned to the Dedicated Host. | + + + + + +
NameDatatypeDescription
host_idstringID of the host created.
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `hosts_Describe` | `SELECT` | `region` | <p>Describes the specified Dedicated Hosts or all your Dedicated Hosts.</p> <p>The results describe only the Dedicated Hosts in the Region you're currently using. All listed instances consume capacity on your Dedicated Host. Dedicated Hosts that have recently been released are listed with the state <code>released</code>.</p> | -| `hosts_Allocate` | `EXEC` | `AvailabilityZone, Quantity, region` | Allocates a Dedicated Host to your account. At a minimum, specify the supported instance type or instance family, the Availability Zone in which to allocate the host, and the number of hosts to allocate. | -| `hosts_Modify` | `EXEC` | `HostId, region` | <p>Modify the auto-placement setting of a Dedicated Host. When auto-placement is enabled, any instances that you launch with a tenancy of <code>host</code> but without a specific host ID are placed onto any available Dedicated Host in your account that has auto-placement enabled. When auto-placement is disabled, you need to provide a host ID to have the instance launch onto a specific host. If no host ID is provided, the instance is launched onto a suitable host with auto-placement enabled.</p> <p>You can also use this API action to modify a Dedicated Host to support either multiple instance types in an instance family, or to support a specific instance type only.</p> | -| `hosts_Release` | `EXEC` | `HostId, region` | <p>When you no longer want to use an On-Demand Dedicated Host it can be released. On-Demand billing is stopped and the host goes into <code>released</code> state. The host ID of Dedicated Hosts that have been released can no longer be specified in another request, for example, to modify the host. You must stop or terminate all instances on a host before it can be released.</p> <p>When Dedicated Hosts are released, it may take some time for them to stop counting toward your limit and you may receive capacity errors when trying to allocate new Dedicated Hosts. Wait a few minutes and then try again.</p> <p>Released hosts still appear in a <a>DescribeHosts</a> response.</p> | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +host_id +FROM aws.ec2.hosts +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the hosts resource, the following permissions are required: + +### Create +```json +ec2:AllocateHosts, +ec2:DescribeHosts +``` + +### List +```json +ec2:DescribeHosts +``` + diff --git a/docs/aws-docs/providers/aws/ec2/iam_instance_profile/index.md b/docs/aws-docs/providers/aws/ec2/iam_instance_profile/index.md deleted file mode 100644 index d16a5bec70..0000000000 --- a/docs/aws-docs/providers/aws/ec2/iam_instance_profile/index.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: iam_instance_profile -hide_title: false -hide_table_of_contents: false -keywords: - - iam_instance_profile - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameiam_instance_profile
TypeResource
Idaws.ec2.iam_instance_profile
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `iam_instance_profile_Associate` | `EXEC` | `IamInstanceProfile, InstanceId, region` | Associates an IAM instance profile with a running or stopped instance. You cannot associate more than one IAM instance profile with an instance. | -| `iam_instance_profile_Disassociate` | `EXEC` | `AssociationId, region` | <p>Disassociates an IAM instance profile from a running or stopped instance.</p> <p>Use <a>DescribeIamInstanceProfileAssociations</a> to get the association ID.</p> | diff --git a/docs/aws-docs/providers/aws/ec2/iam_instance_profile_associations/index.md b/docs/aws-docs/providers/aws/ec2/iam_instance_profile_associations/index.md deleted file mode 100644 index 8d81dba431..0000000000 --- a/docs/aws-docs/providers/aws/ec2/iam_instance_profile_associations/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: iam_instance_profile_associations -hide_title: false -hide_table_of_contents: false -keywords: - - iam_instance_profile_associations - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameiam_instance_profile_associations
TypeResource
Idaws.ec2.iam_instance_profile_associations
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `associationId` | `string` | The ID of the association. | -| `iamInstanceProfile` | `object` | Describes an IAM instance profile. | -| `instanceId` | `string` | The ID of the instance. | -| `state` | `string` | The state of the association. | -| `timestamp` | `string` | The time the IAM instance profile was associated with the instance. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `iam_instance_profile_associations_Describe` | `SELECT` | `region` | Describes your IAM instance profile associations. | -| `iam_instance_profile_association_Replace` | `EXEC` | `AssociationId, IamInstanceProfile, region` | <p>Replaces an IAM instance profile for the specified running instance. You can use this action to change the IAM instance profile that's associated with an instance without having to disassociate the existing IAM instance profile first.</p> <p>Use <a>DescribeIamInstanceProfileAssociations</a> to get the association ID.</p> | diff --git a/docs/aws-docs/providers/aws/ec2/id_format/index.md b/docs/aws-docs/providers/aws/ec2/id_format/index.md deleted file mode 100644 index 2c768b08cd..0000000000 --- a/docs/aws-docs/providers/aws/ec2/id_format/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: id_format -hide_title: false -hide_table_of_contents: false -keywords: - - id_format - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameid_format
TypeResource
Idaws.ec2.id_format
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `deadline` | `string` | The date in UTC at which you are permanently switched over to using longer IDs. If a deadline is not yet available for this resource type, this field is not returned. | -| `resource` | `string` | The type of resource. | -| `useLongIds` | `boolean` | Indicates whether longer IDs (17-character IDs) are enabled for the resource. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `id_format_Describe` | `SELECT` | `region` | <p>Describes the ID format settings for your resources on a per-Region basis, for example, to view which resource types are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types.</p> <p>The following resource types support longer IDs: <code>bundle</code> \| <code>conversion-task</code> \| <code>customer-gateway</code> \| <code>dhcp-options</code> \| <code>elastic-ip-allocation</code> \| <code>elastic-ip-association</code> \| <code>export-task</code> \| <code>flow-log</code> \| <code>image</code> \| <code>import-task</code> \| <code>instance</code> \| <code>internet-gateway</code> \| <code>network-acl</code> \| <code>network-acl-association</code> \| <code>network-interface</code> \| <code>network-interface-attachment</code> \| <code>prefix-list</code> \| <code>reservation</code> \| <code>route-table</code> \| <code>route-table-association</code> \| <code>security-group</code> \| <code>snapshot</code> \| <code>subnet</code> \| <code>subnet-cidr-block-association</code> \| <code>volume</code> \| <code>vpc</code> \| <code>vpc-cidr-block-association</code> \| <code>vpc-endpoint</code> \| <code>vpc-peering-connection</code> \| <code>vpn-connection</code> \| <code>vpn-gateway</code>. </p> <p>These settings apply to the IAM user who makes the request; they do not apply to the entire Amazon Web Services account. By default, an IAM user defaults to the same settings as the root user, unless they explicitly override the settings by running the <a>ModifyIdFormat</a> command. Resources created with longer IDs are visible to all IAM users, regardless of these settings and provided that they have permission to use the relevant <code>Describe</code> command for the resource type.</p> | -| `id_format_Modify` | `EXEC` | `Resource, UseLongIds, region` | <p>Modifies the ID format for the specified resource on a per-Region basis. You can specify that resources should receive longer IDs (17-character IDs) when they are created.</p> <p>This request can only be used to modify longer ID settings for resource types that are within the opt-in period. Resources currently in their opt-in period include: <code>bundle</code> \| <code>conversion-task</code> \| <code>customer-gateway</code> \| <code>dhcp-options</code> \| <code>elastic-ip-allocation</code> \| <code>elastic-ip-association</code> \| <code>export-task</code> \| <code>flow-log</code> \| <code>image</code> \| <code>import-task</code> \| <code>internet-gateway</code> \| <code>network-acl</code> \| <code>network-acl-association</code> \| <code>network-interface</code> \| <code>network-interface-attachment</code> \| <code>prefix-list</code> \| <code>route-table</code> \| <code>route-table-association</code> \| <code>security-group</code> \| <code>subnet</code> \| <code>subnet-cidr-block-association</code> \| <code>vpc</code> \| <code>vpc-cidr-block-association</code> \| <code>vpc-endpoint</code> \| <code>vpc-peering-connection</code> \| <code>vpn-connection</code> \| <code>vpn-gateway</code>.</p> <p>This setting applies to the IAM user who makes the request; it does not apply to the entire Amazon Web Services account. By default, an IAM user defaults to the same settings as the root user. If you're using this action as the root user, then these settings apply to the entire account, unless an IAM user explicitly overrides these settings for themselves. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/resource-ids.html">Resource IDs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant <code>Describe</code> command for the resource type.</p> | diff --git a/docs/aws-docs/providers/aws/ec2/identity_id_format/index.md b/docs/aws-docs/providers/aws/ec2/identity_id_format/index.md deleted file mode 100644 index 70efba5b6b..0000000000 --- a/docs/aws-docs/providers/aws/ec2/identity_id_format/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: identity_id_format -hide_title: false -hide_table_of_contents: false -keywords: - - identity_id_format - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameidentity_id_format
TypeResource
Idaws.ec2.identity_id_format
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `deadline` | `string` | The date in UTC at which you are permanently switched over to using longer IDs. If a deadline is not yet available for this resource type, this field is not returned. | -| `resource` | `string` | The type of resource. | -| `useLongIds` | `boolean` | Indicates whether longer IDs (17-character IDs) are enabled for the resource. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `identity_id_format_Describe` | `SELECT` | `PrincipalArn, region` | <p>Describes the ID format settings for resources for the specified IAM user, IAM role, or root user. For example, you can view the resource types that are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/resource-ids.html">Resource IDs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </p> <p>The following resource types support longer IDs: <code>bundle</code> \| <code>conversion-task</code> \| <code>customer-gateway</code> \| <code>dhcp-options</code> \| <code>elastic-ip-allocation</code> \| <code>elastic-ip-association</code> \| <code>export-task</code> \| <code>flow-log</code> \| <code>image</code> \| <code>import-task</code> \| <code>instance</code> \| <code>internet-gateway</code> \| <code>network-acl</code> \| <code>network-acl-association</code> \| <code>network-interface</code> \| <code>network-interface-attachment</code> \| <code>prefix-list</code> \| <code>reservation</code> \| <code>route-table</code> \| <code>route-table-association</code> \| <code>security-group</code> \| <code>snapshot</code> \| <code>subnet</code> \| <code>subnet-cidr-block-association</code> \| <code>volume</code> \| <code>vpc</code> \| <code>vpc-cidr-block-association</code> \| <code>vpc-endpoint</code> \| <code>vpc-peering-connection</code> \| <code>vpn-connection</code> \| <code>vpn-gateway</code>. </p> <p>These settings apply to the principal specified in the request. They do not apply to the principal that makes the request.</p> | -| `identity_id_format_Modify` | `EXEC` | `PrincipalArn, Resource, UseLongIds, region` | <p>Modifies the ID format of a resource for a specified IAM user, IAM role, or the root user for an account; or all IAM users, IAM roles, and the root user for an account. You can specify that resources should receive longer IDs (17-character IDs) when they are created. </p> <p>This request can only be used to modify longer ID settings for resource types that are within the opt-in period. Resources currently in their opt-in period include: <code>bundle</code> \| <code>conversion-task</code> \| <code>customer-gateway</code> \| <code>dhcp-options</code> \| <code>elastic-ip-allocation</code> \| <code>elastic-ip-association</code> \| <code>export-task</code> \| <code>flow-log</code> \| <code>image</code> \| <code>import-task</code> \| <code>internet-gateway</code> \| <code>network-acl</code> \| <code>network-acl-association</code> \| <code>network-interface</code> \| <code>network-interface-attachment</code> \| <code>prefix-list</code> \| <code>route-table</code> \| <code>route-table-association</code> \| <code>security-group</code> \| <code>subnet</code> \| <code>subnet-cidr-block-association</code> \| <code>vpc</code> \| <code>vpc-cidr-block-association</code> \| <code>vpc-endpoint</code> \| <code>vpc-peering-connection</code> \| <code>vpn-connection</code> \| <code>vpn-gateway</code>. </p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/resource-ids.html">Resource IDs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </p> <p>This setting applies to the principal specified in the request; it does not apply to the principal that makes the request. </p> <p>Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant <code>Describe</code> command for the resource type.</p> | diff --git a/docs/aws-docs/providers/aws/ec2/image_attribute/index.md b/docs/aws-docs/providers/aws/ec2/image_attribute/index.md deleted file mode 100644 index 05e43b47ba..0000000000 --- a/docs/aws-docs/providers/aws/ec2/image_attribute/index.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: image_attribute -hide_title: false -hide_table_of_contents: false -keywords: - - image_attribute - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameimage_attribute
TypeResource
Idaws.ec2.image_attribute
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `description` | `object` | Describes a value for a resource attribute that is a String. | -| `blockDeviceMapping` | `array` | The block device mapping entries. | -| `bootMode` | `object` | Describes a value for a resource attribute that is a String. | -| `imageId` | `string` | The ID of the AMI. | -| `kernel` | `object` | Describes a value for a resource attribute that is a String. | -| `lastLaunchedTime` | `object` | Describes a value for a resource attribute that is a String. | -| `launchPermission` | `array` | The launch permissions. | -| `productCodes` | `array` | The product codes. | -| `ramdisk` | `object` | Describes a value for a resource attribute that is a String. | -| `sriovNetSupport` | `object` | Describes a value for a resource attribute that is a String. | -| `tpmSupport` | `object` | Describes a value for a resource attribute that is a String. | -| `uefiData` | `object` | Describes a value for a resource attribute that is a String. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `image_attribute_Describe` | `SELECT` | `Attribute, ImageId, region` | Describes the specified attribute of the specified AMI. You can specify only one attribute at a time. | -| `image_attribute_Modify` | `EXEC` | `ImageId, region` | <p>Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time. You can use the <code>Attribute</code> parameter to specify the attribute or one of the following parameters: <code>Description</code> or <code>LaunchPermission</code>.</p> <p>Images with an Amazon Web Services Marketplace product code cannot be made public.</p> <p>To enable the SriovNetSupport enhanced networking attribute of an image, enable SriovNetSupport on an instance and create an AMI from the instance.</p> | -| `image_attribute_Reset` | `EXEC` | `Attribute, ImageId, region` | Resets an attribute of an AMI to its default value. | diff --git a/docs/aws-docs/providers/aws/ec2/image_deprecation/index.md b/docs/aws-docs/providers/aws/ec2/image_deprecation/index.md deleted file mode 100644 index b09f063eaa..0000000000 --- a/docs/aws-docs/providers/aws/ec2/image_deprecation/index.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: image_deprecation -hide_title: false -hide_table_of_contents: false -keywords: - - image_deprecation - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameimage_deprecation
TypeResource
Idaws.ec2.image_deprecation
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `image_deprecation_Disable` | `EXEC` | `ImageId, region` | <p>Cancels the deprecation of the specified AMI.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-deprecate.html">Deprecate an AMI</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | -| `image_deprecation_Enable` | `EXEC` | `DeprecateAt, ImageId, region` | <p>Enables deprecation of the specified AMI at the specified date and time.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-deprecate.html">Deprecate an AMI</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2/image_from_recycle_bin/index.md b/docs/aws-docs/providers/aws/ec2/image_from_recycle_bin/index.md deleted file mode 100644 index 7edb0af9ca..0000000000 --- a/docs/aws-docs/providers/aws/ec2/image_from_recycle_bin/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: image_from_recycle_bin -hide_title: false -hide_table_of_contents: false -keywords: - - image_from_recycle_bin - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameimage_from_recycle_bin
TypeResource
Idaws.ec2.image_from_recycle_bin
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `image_from_recycle_bin_Restore` | `EXEC` | `ImageId, region` | diff --git a/docs/aws-docs/providers/aws/ec2/images/index.md b/docs/aws-docs/providers/aws/ec2/images/index.md deleted file mode 100644 index 27cbd83b3e..0000000000 --- a/docs/aws-docs/providers/aws/ec2/images/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: images -hide_title: false -hide_table_of_contents: false -keywords: - - images - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameimages
TypeResource
Idaws.ec2.images
- -## Fields -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `images_Describe` | `SELECT` | `region` | <p>Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you.</p> <p>The images available to you include public images, private images that you own, and private images owned by other Amazon Web Services accounts for which you have explicit launch permissions.</p> <p>Recently deregistered images appear in the returned results for a short interval and then return empty results. After all instances that reference a deregistered AMI are terminated, specifying the ID of the image will eventually return an error indicating that the AMI ID cannot be found.</p> | -| `image_Create` | `INSERT` | `InstanceId, Name, region` | <p>Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.</p> <p>By default, when Amazon EC2 creates the new AMI, it reboots the instance so that it can take snapshots of the attached volumes while data is at rest, in order to ensure a consistent state. You can set the <code>NoReboot</code> parameter to <code>true</code> in the API request, or use the <code>--no-reboot</code> option in the CLI to prevent Amazon EC2 from shutting down and rebooting the instance.</p> <important> <p>If you choose to bypass the shutdown and reboot process by setting the <code>NoReboot</code> parameter to <code>true</code> in the API request, or by using the <code>--no-reboot</code> option in the CLI, we can't guarantee the file system integrity of the created image.</p> </important> <p>If you customized your instance with instance store volumes or Amazon EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami-ebs.html">Creating Amazon EBS-Backed Linux AMIs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | -| `image_Copy` | `EXEC` | `Name, SourceImageId, SourceRegion, region` | <p>Initiates the copy of an AMI. You can copy an AMI from one Region to another, or from a Region to an Outpost. You can't copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost. To copy an AMI to another partition, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateStoreImageTask.html">CreateStoreImageTask</a>.</p> <p>To copy an AMI from one Region to another, specify the source Region using the <b>SourceRegion</b> parameter, and specify the destination Region using its endpoint. Copies of encrypted backing snapshots for the AMI are encrypted. Copies of unencrypted backing snapshots remain unencrypted, unless you set <code>Encrypted</code> during the copy operation. You cannot create an unencrypted copy of an encrypted backing snapshot.</p> <p>To copy an AMI from a Region to an Outpost, specify the source Region using the <b>SourceRegion</b> parameter, and specify the ARN of the destination Outpost using <b>DestinationOutpostArn</b>. Backing snapshots copied to an Outpost are encrypted by default using the default encryption key for the Region, or a different key that you specify in the request using <b>KmsKeyId</b>. Outposts do not support unencrypted snapshots. For more information, <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshots-outposts.html#ami"> Amazon EBS local snapshots on Outposts</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>For more information about the prerequisites and limits when copying an AMI, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/CopyingAMIs.html">Copying an AMI</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | -| `image_Deregister` | `EXEC` | `ImageId, region` | <p>Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances.</p> <p>If you deregister an AMI that matches a Recycle Bin retention rule, the AMI is retained in the Recycle Bin for the specified retention period. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin.html">Recycle Bin</a> in the Amazon Elastic Compute Cloud User Guide.</p> <p>When you deregister an AMI, it doesn't affect any instances that you've already launched from the AMI. You'll continue to incur usage costs for those instances until you terminate them.</p> <p>When you deregister an Amazon EBS-backed AMI, it doesn't affect the snapshot that was created for the root volume of the instance during the AMI creation process. When you deregister an instance store-backed AMI, it doesn't affect the files that you uploaded to Amazon S3 when you created the AMI.</p> | -| `image_Export` | `EXEC` | `DiskImageFormat, ImageId, S3ExportLocation, region` | Exports an Amazon Machine Image (AMI) to a VM file. For more information, see <a href="https://docs.aws.amazon.com/vm-import/latest/userguide/vmexport_image.html">Exporting a VM directly from an Amazon Machine Image (AMI)</a> in the <i>VM Import/Export User Guide</i>. | -| `image_Import` | `EXEC` | `region` | <p>Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI).</p> <p>For more information, see <a href="https://docs.aws.amazon.com/vm-import/latest/userguide/vmimport-image-import.html">Importing a VM as an image using VM Import/Export</a> in the <i>VM Import/Export User Guide</i>.</p> | -| `image_Register` | `EXEC` | `Name, region` | <p>Registers an AMI. When you're creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami.html">Creating your own AMIs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <note> <p>For Amazon EBS-backed instances, <a>CreateImage</a> creates and registers the AMI in a single request, so you don't have to register the AMI yourself.</p> </note> <p>If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image.</p> <p> <b>Register a snapshot of a root device volume</b> </p> <p>You can use <code>RegisterImage</code> to create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. You specify the snapshot using a block device mapping. You can't set the encryption state of the volume using the block device mapping. If the snapshot is encrypted, or encryption by default is enabled, the root volume of an instance launched from the AMI is encrypted.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami-ebs.html#creating-launching-ami-from-snapshot">Create a Linux AMI from a snapshot</a> and <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIEncryption.html">Use encryption with Amazon EBS-backed AMIs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p> <b>Amazon Web Services Marketplace product codes</b> </p> <p>If any snapshots have Amazon Web Services Marketplace product codes, they are copied to the new AMI.</p> <p>Windows and some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the Amazon EC2 billing product code associated with an AMI to verify the subscription status for package updates. To create a new AMI for operating systems that require a billing product code, instead of registering the AMI, do the following to preserve the billing product code association:</p> <ol> <li> <p>Launch an instance from an existing AMI with that billing product code.</p> </li> <li> <p>Customize the instance.</p> </li> <li> <p>Create an AMI from the instance using <a>CreateImage</a>.</p> </li> </ol> <p>If you purchase a Reserved Instance to apply to an On-Demand Instance that was launched from an AMI with a billing product code, make sure that the Reserved Instance has the matching billing product code. If you purchase a Reserved Instance without the matching billing product code, the Reserved Instance will not be applied to the On-Demand Instance. For information about how to obtain the platform details and billing information of an AMI, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-billing-info.html">Understanding AMI billing</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2/images_in_recycle_bin/index.md b/docs/aws-docs/providers/aws/ec2/images_in_recycle_bin/index.md deleted file mode 100644 index a5f0b84426..0000000000 --- a/docs/aws-docs/providers/aws/ec2/images_in_recycle_bin/index.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: images_in_recycle_bin -hide_title: false -hide_table_of_contents: false -keywords: - - images_in_recycle_bin - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameimages_in_recycle_bin
TypeResource
Idaws.ec2.images_in_recycle_bin
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | The name of the AMI. | -| `description` | `string` | The description of the AMI. | -| `imageId` | `string` | The ID of the AMI. | -| `recycleBinEnterTime` | `string` | The date and time when the AMI entered the Recycle Bin. | -| `recycleBinExitTime` | `string` | The date and time when the AMI is to be permanently deleted from the Recycle Bin. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `images_in_recycle_bin_List` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2/import_image_tasks/index.md b/docs/aws-docs/providers/aws/ec2/import_image_tasks/index.md deleted file mode 100644 index ae3588bc2f..0000000000 --- a/docs/aws-docs/providers/aws/ec2/import_image_tasks/index.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: import_image_tasks -hide_title: false -hide_table_of_contents: false -keywords: - - import_image_tasks - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameimport_image_tasks
TypeResource
Idaws.ec2.import_image_tasks
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `description` | `string` | A description of the import task. | -| `architecture` | `string` | <p>The architecture of the virtual machine.</p> <p>Valid values: <code>i386</code> \| <code>x86_64</code> \| <code>arm64</code> </p> | -| `bootMode` | `string` | The boot mode of the virtual machine. | -| `encrypted` | `boolean` | Indicates whether the image is encrypted. | -| `hypervisor` | `string` | <p>The target hypervisor for the import task.</p> <p>Valid values: <code>xen</code> </p> | -| `imageId` | `string` | The ID of the Amazon Machine Image (AMI) of the imported virtual machine. | -| `importTaskId` | `string` | The ID of the import image task. | -| `kmsKeyId` | `string` | The identifier for the KMS key that was used to create the encrypted image. | -| `licenseSpecifications` | `array` | The ARNs of the license configurations that are associated with the import image task. | -| `licenseType` | `string` | The license type of the virtual machine. | -| `platform` | `string` | The description string for the import image task. | -| `progress` | `string` | The percentage of progress of the import image task. | -| `snapshotDetailSet` | `array` | Information about the snapshots. | -| `status` | `string` | A brief status for the import image task. | -| `statusMessage` | `string` | A descriptive status message for the import image task. | -| `tagSet` | `array` | The tags for the import image task. | -| `usageOperation` | `string` | The usage operation value. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `import_image_tasks_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2/import_snapshot_tasks/index.md b/docs/aws-docs/providers/aws/ec2/import_snapshot_tasks/index.md deleted file mode 100644 index b492cb691d..0000000000 --- a/docs/aws-docs/providers/aws/ec2/import_snapshot_tasks/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: import_snapshot_tasks -hide_title: false -hide_table_of_contents: false -keywords: - - import_snapshot_tasks - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameimport_snapshot_tasks
TypeResource
Idaws.ec2.import_snapshot_tasks
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `description` | `string` | A description of the import snapshot task. | -| `importTaskId` | `string` | The ID of the import snapshot task. | -| `snapshotTaskDetail` | `object` | Details about the import snapshot task. | -| `tagSet` | `array` | The tags for the import snapshot task. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `import_snapshot_tasks_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2/import_task/index.md b/docs/aws-docs/providers/aws/ec2/import_task/index.md deleted file mode 100644 index ebdb06b2a0..0000000000 --- a/docs/aws-docs/providers/aws/ec2/import_task/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: import_task -hide_title: false -hide_table_of_contents: false -keywords: - - import_task - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameimport_task
TypeResource
Idaws.ec2.import_task
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `import_task_Cancel` | `EXEC` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2/index.md b/docs/aws-docs/providers/aws/ec2/index.md index df4c0d2aee..ee1bedbae3 100644 --- a/docs/aws-docs/providers/aws/ec2/index.md +++ b/docs/aws-docs/providers/aws/ec2/index.md @@ -13,274 +13,184 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- -ec2 - + +The ec2 service documentation. + :::info Service Summary
-total resources: 241
-total selectable resources: 170
-total methods: 523
+total resources: 159
+total selectable resources: 159
+total methods: 159
::: -## Overview - - - - - - -
Nameaws.ec2
TypeService
Titleec2
Descriptionec2
Idec2:v24.03.00220
- ## Resources
-account_attributes
-address
-address_attribute
-address_to_classic
-address_to_vpc
-addresses
-addresses_attribute
-aggregate_id_format
-associated_enclave_certificate_iam_roles
-associated_ipv6_pool_cidrs
-availability_zone_group
-availability_zones
-bundle_tasks
-byoip_cidr_to_ipam
-byoip_cidrs
+capacity_reservation
+capacity_reservation_fleet
capacity_reservation_fleets
-capacity_reservation_usage
capacity_reservations
+carrier_gateway
carrier_gateways
-classic_link_instances
-classic_link_vpc
-client_vpn_authorization_rules
-client_vpn_client_certificate_revocation_list
-client_vpn_client_configuration
-client_vpn_connections
-client_vpn_endpoints
-client_vpn_ingress
-client_vpn_routes
-client_vpn_target_networks
-coip_pool_usage
-coip_pools
-console_output
-console_screenshot
-conversion_tasks
+customer_gateway
customer_gateways
-default_credit_specification
-default_subnet
-default_vpc
dhcp_options
-diagnostic_interrupt
-ebs_default_kms_key_id
-ebs_encryption_by_default
+ec2fleet
+ec2fleets
+egress_only_internet_gateway
egress_only_internet_gateways
-elastic_gpus
-enclave_certificate_iam_role
-export_image_tasks
-export_tasks
-fast_launch
-fast_launch_images
-fast_snapshot_restores
-fleet_history
-fleet_instances
-fleets
+eip
+eip_association
+eip_associations
+eips
+enclave_certificate_iam_role_association
+enclave_certificate_iam_role_associations
+flow_log
flow_logs
-flow_logs_integration_template
-fpga_image_attribute
-fpga_images
-groups_for_capacity_reservation
-host_reservation_offerings
-host_reservation_purchase_preview
-host_reservations
+gateway_route_table_association
+gateway_route_table_associations
+host
hosts
-iam_instance_profile
-iam_instance_profile_associations
-id_format
-identity_id_format
-image_attribute
-image_deprecation
-image_from_recycle_bin
-images
-images_in_recycle_bin
-import_image_tasks
-import_snapshot_tasks
-import_task
-instance_attribute
-instance_capacity_reservation_attributes
-instance_credit_specifications
-instance_event_notification_attributes
-instance_event_start_time
-instance_event_windows
-instance_export_task
-instance_maintenance_options
-instance_metadata_options
-instance_placement
-instance_status
-instance_type_offerings
-instance_types
-instance_types_from_instance_requirements
-instance_uefi_data
+instance
+instance_connect_endpoint
+instance_connect_endpoints
instances
+internet_gateway
internet_gateways
-ipam_address_history
-ipam_organization_admin_account
-ipam_pool_allocations
+ipam
+ipam_allocation
+ipam_allocations
+ipam_pool
+ipam_pool_cidr
ipam_pool_cidrs
ipam_pools
-ipam_resource_cidrs
+ipam_resource_discoveries
+ipam_resource_discovery
+ipam_resource_discovery_association
+ipam_resource_discovery_associations
+ipam_scope
ipam_scopes
ipams
-ipv6_addresses
-ipv6_pools
+key_pair
key_pairs
-launch_template_data
-launch_template_versions
+launch_template
launch_templates
+local_gateway_route
+local_gateway_route_table
+local_gateway_route_table_virtual_interface_group_association
local_gateway_route_table_virtual_interface_group_associations
-local_gateway_route_table_vpc_associations
local_gateway_route_tables
+local_gateway_route_tablevpc_association
+local_gateway_route_tablevpc_associations
local_gateway_routes
-local_gateway_virtual_interface_groups
-local_gateway_virtual_interfaces
-local_gateways
-managed_prefix_list_associations
-managed_prefix_list_entries
-managed_prefix_list_version
-managed_prefix_lists
-moving_addresses
+nat_gateway
nat_gateways
-network_acl_association
-network_acl_entry
+network_acl
network_acls
-
-
+network_insights_access_scope
network_insights_access_scope_analyses
network_insights_access_scope_analysis
-network_insights_access_scope_analysis_findings
-network_insights_access_scope_content
network_insights_access_scopes
network_insights_analyses
network_insights_analysis
+network_insights_path
network_insights_paths
-network_interface_attribute
-network_interface_permissions
+network_interface
+network_interface_attachment
+network_interface_attachments
network_interfaces
-password_data
+network_performance_metric_subscription
+network_performance_metric_subscriptions
+placement_group
placement_groups
+prefix_list
prefix_lists
-principal_id_format
-private_dns_name_options
-private_ip_addresses
-product_instance
-public_ipv4_pool_cidr
-public_ipv4_pools
-queued_reserved_instances
-regions
-replace_root_volume_tasks
-reserved_instances
-reserved_instances_exchange_quote
-reserved_instances_listings
-reserved_instances_modifications
-reserved_instances_offerings
-restore_image_task
-route
-route_table_association
+route +
+
+route_table
route_tables
-scheduled_instance_availability
-scheduled_instances
+routes
+security_group
security_group_egress
+security_group_egresses
security_group_ingress
-security_group_references
-security_group_rule_descriptions_egress
-security_group_rule_descriptions_ingress
-security_group_rules
+security_group_ingresses
security_groups
-security_groups_to_client_vpn_target_network
-serial_console_access
-serial_console_access_status
-snapshot_attribute
-snapshot_from_recycle_bin
-snapshot_tier
-snapshot_tier_status
+snapshot_block_public_access
+snapshot_block_public_accesses
snapshots
-snapshots_in_recycle_bin
-spot_datafeed_subscription
spot_fleet
-spot_fleet_instances
-spot_fleet_request_history
-spot_fleet_requests
-spot_instance_requests
-spot_instances
-spot_placement_scores
-spot_price_history
-stale_security_groups
-store_image_tasks
-subnet_attribute
+spot_fleets
+subnet
subnet_cidr_block
-subnet_cidr_reservations
+subnet_cidr_blocks
+subnet_network_acl_association
+subnet_network_acl_associations
+subnet_route_table_association
+subnet_route_table_associations
subnets
-tags
-traffic_mirror_filter_network_services
-traffic_mirror_filter_rule
-traffic_mirror_filters
-traffic_mirror_sessions
-traffic_mirror_targets
-transit_gateway_attachment_propagations
+transit_gateway
+transit_gateway_attachment
transit_gateway_attachments
-transit_gateway_connect_peers
+transit_gateway_connect
transit_gateway_connects
+transit_gateway_multicast_domain
+transit_gateway_multicast_domain_association
transit_gateway_multicast_domain_associations
transit_gateway_multicast_domains
+transit_gateway_multicast_group_member
transit_gateway_multicast_group_members
+transit_gateway_multicast_group_source
transit_gateway_multicast_group_sources
-transit_gateway_multicast_groups
+transit_gateway_peering_attachment
transit_gateway_peering_attachments
-transit_gateway_prefix_list_references
+transit_gateway_route_table
+transit_gateway_route_table_association
transit_gateway_route_table_associations
-transit_gateway_route_table_propagations
transit_gateway_route_tables
-transit_gateway_routes
+transit_gateway_vpc_attachment
transit_gateway_vpc_attachments
transit_gateways
-trunk_interface
-trunk_interface_associations
-vgw_route_propagation
-volume_attribute
-volume_i_o
-volume_status
+verified_access_endpoint
+verified_access_endpoints
+verified_access_group
+verified_access_groups
+verified_access_instance
+verified_access_instances
+verified_access_trust_provider
+verified_access_trust_providers
+volume
+volume_attachment
+volume_attachments
volumes
-volumes_modifications
-vpc_attribute
+vpc
vpc_cidr_block
-vpc_classic_link
-vpc_classic_link_dns_support
+vpc_cidr_blocks
+vpc_endpoint
+vpc_endpoint_connection_notification
vpc_endpoint_connection_notifications
-vpc_endpoint_connections
-vpc_endpoint_service_configurations
-vpc_endpoint_service_payer_responsibility
+vpc_endpoint_service
vpc_endpoint_service_permissions
-vpc_endpoint_service_private_dns_verification
vpc_endpoint_services
vpc_endpoints
-vpc_peering_connection_options
+vpc_gateway_attachment
+vpc_gateway_attachments
+vpc_peering_connection
vpc_peering_connections
-vpc_tenancy
+vpcdhcp_options_association
+vpcdhcp_options_associations
vpcs
-vpn_connection_device_sample_configuration
-vpn_connection_device_types
-vpn_connection_options
+vpn_connection
vpn_connection_route
+vpn_connection_routes
vpn_connections
-vpn_gateways
-vpn_tunnel_certificate
-vpn_tunnel_options
-
+vpn_gateway
+vpn_gateways
+ \ No newline at end of file diff --git a/docs/aws-docs/providers/aws/ec2/instance/index.md b/docs/aws-docs/providers/aws/ec2/instance/index.md new file mode 100644 index 0000000000..cdbe410428 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/instance/index.md @@ -0,0 +1,228 @@ +--- +title: instance +hide_title: false +hide_table_of_contents: false +keywords: + - instance + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual instance resource + +## Overview + + + + + +
Nameinstance
TypeResource
DescriptionResource Type definition for AWS::EC2::Instance
Idaws.ec2.instance
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
tenancystringThe tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.
security_groupsarraythe names of the security groups. For a nondefault VPC, you must use security group IDs instead.
private_dns_namestringThe private DNS name of the specified instance. For example: ip-10-24-34-0.ec2.internal.
private_ip_addressstring[EC2-VPC] The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet.
user_datastringThe user data to make available to the instance.
block_device_mappingsarrayThe block device mapping entries that defines the block devices to attach to the instance at launch.
iam_instance_profilestringThe IAM instance profile.
ipv6_addressesarray[EC2-VPC] The IPv6 addresses from the range of the subnet to associate with the primary network interface.
kernel_idstringThe ID of the kernel.
subnet_idstring[EC2-VPC] The ID of the subnet to launch the instance into.<br/><br/>
ebs_optimizedbooleanIndicates whether the instance is optimized for Amazon EBS I/O.
propagate_tags_to_volume_on_creationbooleanIndicates whether to assign the tags from the instance to all of the volumes attached to the instance at launch. If you specify true and you assign tags to the instance, those tags are automatically assigned to all of the volumes that you attach to the instance at launch. If you specify false, those tags are not assigned to the attached volumes.
elastic_gpu_specificationsarrayAn elastic GPU to associate with the instance.
elastic_inference_acceleratorsarrayAn elastic inference accelerator to associate with the instance.
volumesarrayThe volumes to attach to the instance.
private_ipstringThe private IP address of the specified instance. For example: 10.24.34.0.
ipv6_address_countinteger[EC2-VPC] The number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet.
launch_templateobjectThe launch template to use to launch the instances.
enclave_optionsobjectIndicates whether the instance is enabled for AWS Nitro Enclaves.
network_interfacesarrayThe network interfaces to associate with the instance.
image_idstringThe ID of the AMI. An AMI ID is required to launch an instance and must be specified here or in a launch template.
instance_typestringThe instance type.
monitoringbooleanSpecifies whether detailed monitoring is enabled for the instance.
tagsarrayThe tags to add to the instance.
additional_infostringThis property is reserved for internal use. If you use it, the stack fails with this error: Bad property set: [Testing this property] (Service: AmazonEC2; Status Code: 400; Error Code: InvalidParameterCombination; Request ID: 0XXXXXX-49c7-4b40-8bcc-76885dcXXXXX).
hibernation_optionsobjectIndicates whether an instance is enabled for hibernation.
license_specificationsarrayThe license configurations.
instance_idstringThe EC2 Instance ID.
public_ipstringThe public IP address of the specified instance. For example: 192.0.2.0.
instance_initiated_shutdown_behaviorstringIndicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
cpu_optionsobjectThe CPU options for the instance.
availability_zonestringThe Availability Zone of the instance.
private_dns_name_optionsobjectThe options for the instance hostname.
host_idstringIf you specify host for the Affinity property, the ID of a dedicated host that the instance is associated with. If you don't specify an ID, Amazon EC2 launches the instance onto any available, compatible dedicated host in your account.
host_resource_group_arnstringThe ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host.
public_dns_namestringThe public DNS name of the specified instance. For example: ec2-107-20-50-45.compute-1.amazonaws.com.
security_group_idsarrayThe IDs of the security groups.
disable_api_terminationbooleanIf you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can.
key_namestringThe name of the key pair.
ramdisk_idstringThe ID of the RAM disk to select.
source_dest_checkbooleanSpecifies whether to enable an instance launched in a VPC to perform NAT.
placement_group_namestringThe name of an existing placement group that you want to launch the instance into (cluster | partition | spread).
ssm_associationsarrayThe SSM document and parameter values in AWS Systems Manager to associate with this instance.
vpc_idstringThe ID of the VPC that the instance is running in.
affinitystringIndicates whether the instance is associated with a dedicated host. If you want the instance to always restart on the same host on which it was launched, specify host. If you want the instance to restart on any available host, but try to launch onto the last host it ran on (on a best-effort basis), specify default.
credit_specificationobjectThe credit option for CPU usage of the burstable performance instance. Valid values are standard and unlimited.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +tenancy, +security_groups, +private_dns_name, +private_ip_address, +user_data, +block_device_mappings, +iam_instance_profile, +ipv6_addresses, +kernel_id, +subnet_id, +ebs_optimized, +propagate_tags_to_volume_on_creation, +elastic_gpu_specifications, +elastic_inference_accelerators, +volumes, +private_ip, +ipv6_address_count, +launch_template, +enclave_options, +network_interfaces, +image_id, +instance_type, +monitoring, +tags, +additional_info, +hibernation_options, +license_specifications, +instance_id, +public_ip, +instance_initiated_shutdown_behavior, +cpu_options, +availability_zone, +private_dns_name_options, +host_id, +host_resource_group_arn, +public_dns_name, +security_group_ids, +disable_api_termination, +key_name, +ramdisk_id, +source_dest_check, +placement_group_name, +ssm_associations, +vpc_id, +affinity, +credit_specification +FROM aws.ec2.instance +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the instance resource, the following permissions are required: + +### Read +```json +ec2:DescribeElasticGpus, +ec2:DescribeNetworkInterfaces, +ec2:DescribeVolumes, +ec2:DescribeInstances, +ec2:DescribeInstanceAttribute, +ec2:DescribeInstanceCreditSpecifications, +ec2:DescribeLaunchTemplates, +elastic-inference:DescribeAccelerators, +ssm:DescribeAssociation, +ssm:ListAssociations +``` + +### Update +```json +ec2:DescribeElasticGpus, +ec2:ModifyPrivateDnsNameOptions, +ec2:DescribeNetworkInterfaces, +ec2:AssociateIamInstanceProfile, +ec2:DescribeIamInstanceProfileAssociations, +ec2:DescribeInstances, +ec2:DescribeSubnets, +ec2:DescribeKeyPairs, +ec2:DescribeSecurityGroups, +ec2:DescribeVpcs, +ec2:DescribeInstanceAttribute, +ec2:DescribeInstanceCreditSpecifications, +ec2:DescribeLaunchTemplates, +ec2:DetachVolume, +ec2:DisassociateIamInstanceProfile, +ec2:ModifyInstanceAttribute, +ec2:ModifyInstanceCreditSpecification, +ec2:ModifyInstanceMaintenanceOptions, +ec2:ModifyInstancePlacement, +ec2:MonitorInstances, +ec2:AttachVolume, +ec2:CreateTags, +ec2:DeleteTags, +ec2:ReplaceIamInstanceProfileAssociation, +ec2:StartInstances, +ec2:StopInstances, +ec2:UnmonitorInstances, +elastic-inference:DescribeAccelerators, +ssm:CreateAssociation, +ssm:DeleteAssociation, +ssm:DescribeAssociation, +ssm:ListAssociations +``` + +### Delete +```json +ec2:DescribeInstances, +ec2:TerminateInstances, +ec2:DescribeElasticGpus, +ec2:DescribeNetworkInterfaces, +ec2:DescribeVolumes, +ec2:DescribeInstances, +ec2:DescribeInstanceAttribute, +ec2:DescribeInstanceCreditSpecifications, +ec2:DescribeLaunchTemplates, +elastic-inference:DescribeAccelerators, +ssm:DescribeAssociation, +ssm:ListAssociations +``` + diff --git a/docs/aws-docs/providers/aws/ec2/instance_attribute/index.md b/docs/aws-docs/providers/aws/ec2/instance_attribute/index.md deleted file mode 100644 index 80a4d80fd6..0000000000 --- a/docs/aws-docs/providers/aws/ec2/instance_attribute/index.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: instance_attribute -hide_title: false -hide_table_of_contents: false -keywords: - - instance_attribute - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameinstance_attribute
TypeResource
Idaws.ec2.instance_attribute
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `blockDeviceMapping` | `array` | The block device mapping of the instance. | -| `disableApiTermination` | `object` | Describes a value for a resource attribute that is a Boolean value. | -| `ebsOptimized` | `object` | Describes a value for a resource attribute that is a Boolean value. | -| `enaSupport` | `object` | Describes a value for a resource attribute that is a Boolean value. | -| `enclaveOptions` | `object` | Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. | -| `groupSet` | `array` | The security groups associated with the instance. | -| `instanceId` | `string` | The ID of the instance. | -| `instanceInitiatedShutdownBehavior` | `object` | Describes a value for a resource attribute that is a String. | -| `instanceType` | `object` | Describes a value for a resource attribute that is a String. | -| `kernel` | `object` | Describes a value for a resource attribute that is a String. | -| `productCodes` | `array` | A list of product codes. | -| `ramdisk` | `object` | Describes a value for a resource attribute that is a String. | -| `rootDeviceName` | `object` | Describes a value for a resource attribute that is a String. | -| `sourceDestCheck` | `object` | Describes a value for a resource attribute that is a Boolean value. | -| `sriovNetSupport` | `object` | Describes a value for a resource attribute that is a String. | -| `userData` | `object` | Describes a value for a resource attribute that is a String. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `instance_attribute_Describe` | `SELECT` | `Attribute, InstanceId, region` | Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Valid attribute values are: <code>instanceType</code> \| <code>kernel</code> \| <code>ramdisk</code> \| <code>userData</code> \| <code>disableApiTermination</code> \| <code>instanceInitiatedShutdownBehavior</code> \| <code>rootDeviceName</code> \| <code>blockDeviceMapping</code> \| <code>productCodes</code> \| <code>sourceDestCheck</code> \| <code>groupSet</code> \| <code>ebsOptimized</code> \| <code>sriovNetSupport</code> | -| `instance_attribute_Modify` | `EXEC` | `InstanceId, region` | <p>Modifies the specified attribute of the specified instance. You can specify only one attribute at a time.</p> <p> <b>Note: </b>Using this action to change the security groups associated with an elastic network interface (ENI) attached to an instance in a VPC can result in an error if the instance has more than one ENI. To change the security groups associated with an ENI attached to an instance that has multiple ENIs, we recommend that you use the <a>ModifyNetworkInterfaceAttribute</a> action.</p> <p>To modify some attributes, the instance must be stopped. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_ChangingAttributesWhileInstanceStopped.html">Modify a stopped instance</a> in the <i>Amazon EC2 User Guide</i>.</p> | -| `instance_attribute_Reset` | `EXEC` | `Attribute, InstanceId, region` | <p>Resets an attribute of an instance to its default value. To reset the <code>kernel</code> or <code>ramdisk</code>, the instance must be in a stopped state. To reset the <code>sourceDestCheck</code>, the instance can be either running or stopped.</p> <p>The <code>sourceDestCheck</code> attribute controls whether source/destination checking is enabled. The default value is <code>true</code>, which means checking is enabled. This value must be <code>false</code> for a NAT instance to perform NAT. For more information, see <a href="https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_NAT_Instance.html">NAT Instances</a> in the <i>Amazon VPC User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2/instance_capacity_reservation_attributes/index.md b/docs/aws-docs/providers/aws/ec2/instance_capacity_reservation_attributes/index.md deleted file mode 100644 index b526d9cd1e..0000000000 --- a/docs/aws-docs/providers/aws/ec2/instance_capacity_reservation_attributes/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: instance_capacity_reservation_attributes -hide_title: false -hide_table_of_contents: false -keywords: - - instance_capacity_reservation_attributes - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameinstance_capacity_reservation_attributes
TypeResource
Idaws.ec2.instance_capacity_reservation_attributes
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `instance_capacity_reservation_attributes_Modify` | `EXEC` | `CapacityReservationSpecification, InstanceId, region` | diff --git a/docs/aws-docs/providers/aws/ec2/instance_connect_endpoint/index.md b/docs/aws-docs/providers/aws/ec2/instance_connect_endpoint/index.md new file mode 100644 index 0000000000..e552313387 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/instance_connect_endpoint/index.md @@ -0,0 +1,100 @@ +--- +title: instance_connect_endpoint +hide_title: false +hide_table_of_contents: false +keywords: + - instance_connect_endpoint + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual instance_connect_endpoint resource + +## Overview + + + + + +
Nameinstance_connect_endpoint
TypeResource
DescriptionResource Type definition for AWS::EC2::InstanceConnectEndpoint
Idaws.ec2.instance_connect_endpoint
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
idstringThe id of the instance connect endpoint
subnet_idstringThe subnet id of the instance connect endpoint
client_tokenstringThe client token of the instance connect endpoint.
preserve_client_ipbooleanIf true, the address of the instance connect endpoint client is preserved when connecting to the end resource
tagsarrayThe tags of the instance connect endpoint.
security_group_idsarrayThe security group IDs of the instance connect endpoint.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +subnet_id, +client_token, +preserve_client_ip, +tags, +security_group_ids +FROM aws.ec2.instance_connect_endpoint +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the instance_connect_endpoint resource, the following permissions are required: + +### Read +```json +ec2:DescribeInstanceConnectEndpoints +``` + +### Update +```json +ec2:DescribeInstanceConnectEndpoints, +ec2:CreateTags, +ec2:DeleteTags +``` + +### Delete +```json +ec2:DeleteInstanceConnectEndpoint, +ec2:DescribeInstanceConnectEndpoints +``` + diff --git a/docs/aws-docs/providers/aws/ec2/instance_connect_endpoints/index.md b/docs/aws-docs/providers/aws/ec2/instance_connect_endpoints/index.md new file mode 100644 index 0000000000..47f4649ef4 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/instance_connect_endpoints/index.md @@ -0,0 +1,81 @@ +--- +title: instance_connect_endpoints +hide_title: false +hide_table_of_contents: false +keywords: + - instance_connect_endpoints + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Retrieves a list of instance_connect_endpoints in a region + +## Overview + + + + + +
Nameinstance_connect_endpoints
TypeResource
DescriptionResource Type definition for AWS::EC2::InstanceConnectEndpoint
Idaws.ec2.instance_connect_endpoints
+ +## Fields + + + + + +
NameDatatypeDescription
idstringThe id of the instance connect endpoint
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.ec2.instance_connect_endpoints +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the instance_connect_endpoints resource, the following permissions are required: + +### Create +```json +ec2:CreateInstanceConnectEndpoint, +ec2:DescribeInstanceConnectEndpoints, +ec2:CreateTags, +ec2:CreateNetworkInterface, +iam:CreateServiceLinkedRole +``` + +### List +```json +ec2:DescribeInstanceConnectEndpoints +``` + diff --git a/docs/aws-docs/providers/aws/ec2/instance_credit_specifications/index.md b/docs/aws-docs/providers/aws/ec2/instance_credit_specifications/index.md deleted file mode 100644 index 509ba93e4b..0000000000 --- a/docs/aws-docs/providers/aws/ec2/instance_credit_specifications/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: instance_credit_specifications -hide_title: false -hide_table_of_contents: false -keywords: - - instance_credit_specifications - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameinstance_credit_specifications
TypeResource
Idaws.ec2.instance_credit_specifications
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `cpuCredits` | `string` | The credit option for CPU usage of the instance. Valid values are <code>standard</code> and <code>unlimited</code>. | -| `instanceId` | `string` | The ID of the instance. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `instance_credit_specifications_Describe` | `SELECT` | `region` | <p>Describes the credit option for CPU usage of the specified burstable performance instances. The credit options are <code>standard</code> and <code>unlimited</code>.</p> <p>If you do not specify an instance ID, Amazon EC2 returns burstable performance instances with the <code>unlimited</code> credit option, as well as instances that were previously configured as T2, T3, and T3a with the <code>unlimited</code> credit option. For example, if you resize a T2 instance, while it is configured as <code>unlimited</code>, to an M4 instance, Amazon EC2 returns the M4 instance.</p> <p>If you specify one or more instance IDs, Amazon EC2 returns the credit option (<code>standard</code> or <code>unlimited</code>) of those instances. If you specify an instance ID that is not valid, such as an instance that is not a burstable performance instance, an error is returned.</p> <p>Recently terminated instances might appear in the returned results. This interval is usually less than one hour.</p> <p>If an Availability Zone is experiencing a service disruption and you specify instance IDs in the affected zone, or do not specify any instance IDs at all, the call fails. If you specify only instance IDs in an unaffected zone, the call works normally.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html">Burstable performance instances</a> in the <i>Amazon EC2 User Guide</i>.</p> | -| `instance_credit_specification_Modify` | `EXEC` | `InstanceCreditSpecification, region` | <p>Modifies the credit option for CPU usage on a running or stopped burstable performance instance. The credit options are <code>standard</code> and <code>unlimited</code>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html">Burstable performance instances</a> in the <i>Amazon EC2 User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2/instance_event_notification_attributes/index.md b/docs/aws-docs/providers/aws/ec2/instance_event_notification_attributes/index.md deleted file mode 100644 index 19984aac80..0000000000 --- a/docs/aws-docs/providers/aws/ec2/instance_event_notification_attributes/index.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: instance_event_notification_attributes -hide_title: false -hide_table_of_contents: false -keywords: - - instance_event_notification_attributes - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameinstance_event_notification_attributes
TypeResource
Idaws.ec2.instance_event_notification_attributes
- -## Fields -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `instance_event_notification_attributes_Describe` | `SELECT` | `region` | Describes the tag keys that are registered to appear in scheduled event notifications for resources in the current Region. | -| `instance_event_notification_attributes_Deregister` | `EXEC` | `region` | Deregisters tag keys to prevent tags that have the specified tag keys from being included in scheduled event notifications for resources in the Region. | -| `instance_event_notification_attributes_Register` | `EXEC` | `region` | <p>Registers a set of tag keys to include in scheduled event notifications for your resources. </p> <p>To remove tags, use <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeregisterInstanceEventNotificationAttributes.html">DeregisterInstanceEventNotificationAttributes</a>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2/instance_event_start_time/index.md b/docs/aws-docs/providers/aws/ec2/instance_event_start_time/index.md deleted file mode 100644 index 851f92a12c..0000000000 --- a/docs/aws-docs/providers/aws/ec2/instance_event_start_time/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: instance_event_start_time -hide_title: false -hide_table_of_contents: false -keywords: - - instance_event_start_time - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameinstance_event_start_time
TypeResource
Idaws.ec2.instance_event_start_time
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `instance_event_start_time_Modify` | `EXEC` | `InstanceEventId, InstanceId, NotBefore, region` | diff --git a/docs/aws-docs/providers/aws/ec2/instance_event_windows/index.md b/docs/aws-docs/providers/aws/ec2/instance_event_windows/index.md deleted file mode 100644 index 470ae95306..0000000000 --- a/docs/aws-docs/providers/aws/ec2/instance_event_windows/index.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: instance_event_windows -hide_title: false -hide_table_of_contents: false -keywords: - - instance_event_windows - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameinstance_event_windows
TypeResource
Idaws.ec2.instance_event_windows
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | The name of the event window. | -| `associationTarget` | `object` | One or more targets associated with the event window. | -| `cronExpression` | `string` | The cron expression defined for the event window. | -| `instanceEventWindowId` | `string` | The ID of the event window. | -| `state` | `string` | The current state of the event window. | -| `tagSet` | `array` | The instance tags associated with the event window. | -| `timeRangeSet` | `array` | One or more time ranges defined for the event window. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `instance_event_windows_Describe` | `SELECT` | `region` | <p>Describes the specified event windows or all event windows.</p> <p>If you specify event window IDs, the output includes information for only the specified event windows. If you specify filters, the output includes information for only those event windows that meet the filter criteria. If you do not specify event windows IDs or filters, the output includes information for all event windows, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully. </p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html">Define event windows for scheduled events</a> in the <i>Amazon EC2 User Guide</i>.</p> | -| `instance_event_window_Create` | `INSERT` | `region` | <p>Creates an event window in which scheduled events for the associated Amazon EC2 instances can run.</p> <p>You can define either a set of time ranges or a cron expression when creating the event window, but not both. All event window times are in UTC.</p> <p>You can create up to 200 event windows per Amazon Web Services Region.</p> <p>When you create the event window, targets (instance IDs, Dedicated Host IDs, or tags) are not yet associated with it. To ensure that the event window can be used, you must associate one or more targets with it by using the <a>AssociateInstanceEventWindow</a> API.</p> <important> <p>Event windows are applicable only for scheduled events that stop, reboot, or terminate instances.</p> <p>Event windows are <i>not</i> applicable for:</p> <ul> <li> <p>Expedited scheduled events and network maintenance events. </p> </li> <li> <p>Unscheduled maintenance such as AutoRecovery and unplanned reboots.</p> </li> </ul> </important> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html">Define event windows for scheduled events</a> in the <i>Amazon EC2 User Guide</i>.</p> | -| `instance_event_window_Delete` | `DELETE` | `InstanceEventWindowId, region` | <p>Deletes the specified event window.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html">Define event windows for scheduled events</a> in the <i>Amazon EC2 User Guide</i>.</p> | -| `instance_event_window_Associate` | `EXEC` | `AssociationTarget, InstanceEventWindowId, region` | <p>Associates one or more targets with an event window. Only one type of target (instance IDs, Dedicated Host IDs, or tags) can be specified with an event window.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html">Define event windows for scheduled events</a> in the <i>Amazon EC2 User Guide</i>.</p> | -| `instance_event_window_Disassociate` | `EXEC` | `AssociationTarget, InstanceEventWindowId, region` | <p>Disassociates one or more targets from an event window.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html">Define event windows for scheduled events</a> in the <i>Amazon EC2 User Guide</i>.</p> | -| `instance_event_window_Modify` | `EXEC` | `InstanceEventWindowId, region` | <p>Modifies the specified event window.</p> <p>You can define either a set of time ranges or a cron expression when modifying the event window, but not both.</p> <p>To modify the targets associated with the event window, use the <a>AssociateInstanceEventWindow</a> and <a>DisassociateInstanceEventWindow</a> API.</p> <p>If Amazon Web Services has already scheduled an event, modifying an event window won't change the time of the scheduled event.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html">Define event windows for scheduled events</a> in the <i>Amazon EC2 User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2/instance_export_task/index.md b/docs/aws-docs/providers/aws/ec2/instance_export_task/index.md deleted file mode 100644 index 478c527815..0000000000 --- a/docs/aws-docs/providers/aws/ec2/instance_export_task/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: instance_export_task -hide_title: false -hide_table_of_contents: false -keywords: - - instance_export_task - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameinstance_export_task
TypeResource
Idaws.ec2.instance_export_task
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `instance_export_task_Create` | `INSERT` | `ExportToS3, InstanceId, TargetEnvironment, region` | diff --git a/docs/aws-docs/providers/aws/ec2/instance_maintenance_options/index.md b/docs/aws-docs/providers/aws/ec2/instance_maintenance_options/index.md deleted file mode 100644 index a1386aeaba..0000000000 --- a/docs/aws-docs/providers/aws/ec2/instance_maintenance_options/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: instance_maintenance_options -hide_title: false -hide_table_of_contents: false -keywords: - - instance_maintenance_options - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameinstance_maintenance_options
TypeResource
Idaws.ec2.instance_maintenance_options
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `instance_maintenance_options_Modify` | `EXEC` | `InstanceId, region` | diff --git a/docs/aws-docs/providers/aws/ec2/instance_metadata_options/index.md b/docs/aws-docs/providers/aws/ec2/instance_metadata_options/index.md deleted file mode 100644 index b3b02e2c6a..0000000000 --- a/docs/aws-docs/providers/aws/ec2/instance_metadata_options/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: instance_metadata_options -hide_title: false -hide_table_of_contents: false -keywords: - - instance_metadata_options - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameinstance_metadata_options
TypeResource
Idaws.ec2.instance_metadata_options
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `instance_metadata_options_Modify` | `EXEC` | `InstanceId, region` | diff --git a/docs/aws-docs/providers/aws/ec2/instance_placement/index.md b/docs/aws-docs/providers/aws/ec2/instance_placement/index.md deleted file mode 100644 index 208ee1b935..0000000000 --- a/docs/aws-docs/providers/aws/ec2/instance_placement/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: instance_placement -hide_title: false -hide_table_of_contents: false -keywords: - - instance_placement - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameinstance_placement
TypeResource
Idaws.ec2.instance_placement
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `instance_placement_Modify` | `EXEC` | `InstanceId, region` | diff --git a/docs/aws-docs/providers/aws/ec2/instance_status/index.md b/docs/aws-docs/providers/aws/ec2/instance_status/index.md deleted file mode 100644 index 92e13c5002..0000000000 --- a/docs/aws-docs/providers/aws/ec2/instance_status/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: instance_status -hide_title: false -hide_table_of_contents: false -keywords: - - instance_status - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameinstance_status
TypeResource
Idaws.ec2.instance_status
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `availabilityZone` | `string` | The Availability Zone of the instance. | -| `eventsSet` | `array` | Any scheduled events associated with the instance. | -| `instanceId` | `string` | The ID of the instance. | -| `instanceState` | `object` | Describes the current state of an instance. | -| `instanceStatus` | `object` | Describes the status of an instance. | -| `outpostArn` | `string` | The Amazon Resource Name (ARN) of the Outpost. | -| `systemStatus` | `object` | Describes the status of an instance. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `instance_status_Describe` | `SELECT` | `region` | <p>Describes the status of the specified instances or all of your instances. By default, only running instances are described, unless you specifically indicate to return the status of all instances.</p> <p>Instance status includes the following components:</p> <ul> <li> <p> <b>Status checks</b> - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-system-instance-status-check.html">Status checks for your instances</a> and <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstances.html">Troubleshoot instances with failed status checks</a> in the <i>Amazon EC2 User Guide</i>.</p> </li> <li> <p> <b>Scheduled events</b> - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-instances-status-check_sched.html">Scheduled events for your instances</a> in the <i>Amazon EC2 User Guide</i>.</p> </li> <li> <p> <b>Instance state</b> - You can manage your instances from the moment you launch them through their termination. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-lifecycle.html">Instance lifecycle</a> in the <i>Amazon EC2 User Guide</i>.</p> </li> </ul> | -| `instance_status_Report` | `EXEC` | `InstanceId, ReasonCode, Status, region` | <p>Submits feedback about the status of an instance. The instance must be in the <code>running</code> state. If your experience with the instance differs from the instance status returned by <a>DescribeInstanceStatus</a>, use <a>ReportInstanceStatus</a> to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks.</p> <p>Use of this action does not change the value returned by <a>DescribeInstanceStatus</a>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2/instance_type_offerings/index.md b/docs/aws-docs/providers/aws/ec2/instance_type_offerings/index.md deleted file mode 100644 index e7b0e8271f..0000000000 --- a/docs/aws-docs/providers/aws/ec2/instance_type_offerings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: instance_type_offerings -hide_title: false -hide_table_of_contents: false -keywords: - - instance_type_offerings - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameinstance_type_offerings
TypeResource
Idaws.ec2.instance_type_offerings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `instanceType` | `string` | The instance type. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance types</a> in the <i>Amazon EC2 User Guide</i>. | -| `location` | `string` | The identifier for the location. This depends on the location type. For example, if the location type is <code>region</code>, the location is the Region code (for example, <code>us-east-2</code>.) | -| `locationType` | `string` | The location type. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `instance_type_offerings_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2/instance_types/index.md b/docs/aws-docs/providers/aws/ec2/instance_types/index.md deleted file mode 100644 index da12950cc5..0000000000 --- a/docs/aws-docs/providers/aws/ec2/instance_types/index.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: instance_types -hide_title: false -hide_table_of_contents: false -keywords: - - instance_types - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameinstance_types
TypeResource
Idaws.ec2.instance_types
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `autoRecoverySupported` | `boolean` | Indicates whether auto recovery is supported. | -| `bareMetal` | `boolean` | Indicates whether the instance is a bare metal instance type. | -| `burstablePerformanceSupported` | `boolean` | Indicates whether the instance type is a burstable performance instance type. | -| `currentGeneration` | `boolean` | Indicates whether the instance type is current generation. | -| `dedicatedHostsSupported` | `boolean` | Indicates whether Dedicated Hosts are supported on the instance type. | -| `ebsInfo` | `object` | Describes the Amazon EBS features supported by the instance type. | -| `fpgaInfo` | `object` | Describes the FPGAs for the instance type. | -| `freeTierEligible` | `boolean` | Indicates whether the instance type is eligible for the free tier. | -| `gpuInfo` | `object` | Describes the GPU accelerators for the instance type. | -| `hibernationSupported` | `boolean` | Indicates whether On-Demand hibernation is supported. | -| `hypervisor` | `string` | The hypervisor for the instance type. | -| `inferenceAcceleratorInfo` | `object` | Describes the Inference accelerators for the instance type. | -| `instanceStorageInfo` | `object` | Describes the instance store features that are supported by the instance type. | -| `instanceStorageSupported` | `boolean` | Indicates whether instance storage is supported. | -| `instanceType` | `string` | The instance type. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance types</a> in the <i>Amazon EC2 User Guide</i>. | -| `memoryInfo` | `object` | Describes the memory for the instance type. | -| `networkInfo` | `object` | Describes the networking features of the instance type. | -| `placementGroupInfo` | `object` | Describes the placement group support of the instance type. | -| `processorInfo` | `object` | Describes the processor used by the instance type. | -| `supportedBootModes` | `array` | The supported boot modes. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html">Boot modes</a> in the <i>Amazon EC2 User Guide</i>. | -| `supportedRootDeviceTypes` | `array` | The supported root device types. | -| `supportedUsageClasses` | `array` | Indicates whether the instance type is offered for spot or On-Demand. | -| `supportedVirtualizationTypes` | `array` | The supported virtualization types. | -| `vCpuInfo` | `object` | Describes the vCPU configurations for the instance type. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `instance_types_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2/instance_types_from_instance_requirements/index.md b/docs/aws-docs/providers/aws/ec2/instance_types_from_instance_requirements/index.md deleted file mode 100644 index 531d5140b9..0000000000 --- a/docs/aws-docs/providers/aws/ec2/instance_types_from_instance_requirements/index.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: instance_types_from_instance_requirements -hide_title: false -hide_table_of_contents: false -keywords: - - instance_types_from_instance_requirements - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameinstance_types_from_instance_requirements
TypeResource
Idaws.ec2.instance_types_from_instance_requirements
- -## Fields -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `instance_types_from_instance_requirements_Get` | `SELECT` | `ArchitectureType, InstanceRequirements, VirtualizationType, region` | diff --git a/docs/aws-docs/providers/aws/ec2/instance_uefi_data/index.md b/docs/aws-docs/providers/aws/ec2/instance_uefi_data/index.md deleted file mode 100644 index fba271c1e2..0000000000 --- a/docs/aws-docs/providers/aws/ec2/instance_uefi_data/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: instance_uefi_data -hide_title: false -hide_table_of_contents: false -keywords: - - instance_uefi_data - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameinstance_uefi_data
TypeResource
Idaws.ec2.instance_uefi_data
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `instanceId` | `string` | The ID of the instance from which to retrieve the UEFI data. | -| `uefiData` | `string` | Base64 representation of the non-volatile UEFI variable store. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `instance_uefi_data_Get` | `SELECT` | `InstanceId, region` | diff --git a/docs/aws-docs/providers/aws/ec2/instances/index.md b/docs/aws-docs/providers/aws/ec2/instances/index.md index 4e6641aa0a..d9134b06f6 100644 --- a/docs/aws-docs/providers/aws/ec2/instances/index.md +++ b/docs/aws-docs/providers/aws/ec2/instances/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - instances - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,85 +14,94 @@ description: Query, deploy 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
DescriptionResource Type definition for AWS::EC2::Instance
Idaws.ec2.instances
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `amiLaunchIndex` | `integer` | The AMI launch index, which can be used to find this instance in the launch group. | -| `architecture` | `string` | The architecture of the image. | -| `blockDeviceMapping` | `array` | Any block device mapping entries for the instance. | -| `bootMode` | `string` | The boot mode of the instance. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html">Boot modes</a> in the <i>Amazon EC2 User Guide</i>. | -| `capacityReservationId` | `string` | The ID of the Capacity Reservation. | -| `capacityReservationSpecification` | `object` | Describes the instance's Capacity Reservation targeting preferences. The action returns the <code>capacityReservationPreference</code> response element if the instance is configured to run in On-Demand capacity, or if it is configured in run in any <code>open</code> Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). The action returns the <code>capacityReservationTarget</code> response element if the instance explicily targets a specific Capacity Reservation or Capacity Reservation group. | -| `clientToken` | `string` | The idempotency token you provided when you launched the instance, if applicable. | -| `cpuOptions` | `object` | The CPU options for the instance. | -| `dnsName` | `string` | (IPv4 only) The public DNS name assigned to the instance. This name is not available until the instance enters the <code>running</code> state. For EC2-VPC, this name is only available if you've enabled DNS hostnames for your VPC. | -| `ebsOptimized` | `boolean` | Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance. | -| `elasticGpuAssociationSet` | `array` | The Elastic GPU associated with the instance. | -| `elasticInferenceAcceleratorAssociationSet` | `array` | The elastic inference accelerator associated with the instance. | -| `enaSupport` | `boolean` | Specifies whether enhanced networking with ENA is enabled. | -| `enclaveOptions` | `object` | Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. | -| `groupSet` | `array` | The security groups for the instance. | -| `hibernationOptions` | `object` | Indicates whether your instance is configured for hibernation. This parameter is valid only if the instance meets the <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html#hibernating-prerequisites">hibernation prerequisites</a>. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html">Hibernate your instance</a> in the <i>Amazon EC2 User Guide</i>. | -| `hypervisor` | `string` | The hypervisor type of the instance. The value <code>xen</code> is used for both Xen and Nitro hypervisors. | -| `iamInstanceProfile` | `object` | Describes an IAM instance profile. | -| `imageId` | `string` | The ID of the AMI used to launch the instance. | -| `instanceId` | `string` | The ID of the instance. | -| `instanceLifecycle` | `string` | Indicates whether this is a Spot Instance or a Scheduled Instance. | -| `instanceState` | `object` | Describes the current state of an instance. | -| `instanceType` | `string` | The instance type. | -| `ipAddress` | `string` | <p>The public IPv4 address, or the Carrier IP address assigned to the instance, if applicable.</p> <p>A Carrier IP address only applies to an instance launched in a subnet associated with a Wavelength Zone.</p> | -| `ipv6Address` | `string` | The IPv6 address assigned to the instance. | -| `kernelId` | `string` | The kernel associated with this instance, if applicable. | -| `keyName` | `string` | The name of the key pair, if this instance was launched with an associated key pair. | -| `launchTime` | `string` | The time the instance was launched. | -| `licenseSet` | `array` | The license configurations for the instance. | -| `maintenanceOptions` | `object` | The maintenance options for the instance. | -| `metadataOptions` | `object` | The metadata options for the instance. | -| `monitoring` | `object` | Describes the monitoring of an instance. | -| `networkInterfaceSet` | `array` | [EC2-VPC] The network interfaces for the instance. | -| `outpostArn` | `string` | The Amazon Resource Name (ARN) of the Outpost. | -| `placement` | `object` | Describes the placement of an instance. | -| `platform` | `string` | The value is <code>Windows</code> for Windows instances; otherwise blank. | -| `platformDetails` | `string` | The platform details value for the instance. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/billing-info-fields.html">AMI billing information fields</a> in the <i>Amazon EC2 User Guide</i>. | -| `privateDnsName` | `string` | <p>(IPv4 only) The private DNS hostname name assigned to the instance. This DNS hostname can only be used inside the Amazon EC2 network. This name is not available until the instance enters the <code>running</code> state. </p> <p>[EC2-VPC] The Amazon-provided DNS server resolves Amazon-provided private DNS hostnames if you've enabled DNS resolution and DNS hostnames in your VPC. If you are not using the Amazon-provided DNS server in your VPC, your custom domain name servers must resolve the hostname as appropriate.</p> | -| `privateDnsNameOptions` | `object` | Describes the options for instance hostnames. | -| `privateIpAddress` | `string` | The private IPv4 address assigned to the instance. | -| `productCodes` | `array` | The product codes attached to this instance, if applicable. | -| `ramdiskId` | `string` | The RAM disk associated with this instance, if applicable. | -| `reason` | `string` | The reason for the most recent state transition. This might be an empty string. | -| `rootDeviceName` | `string` | The device name of the root device volume (for example, <code>/dev/sda1</code>). | -| `rootDeviceType` | `string` | The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume. | -| `sourceDestCheck` | `boolean` | Indicates whether source/destination checking is enabled. | -| `spotInstanceRequestId` | `string` | If the request is a Spot Instance request, the ID of the request. | -| `sriovNetSupport` | `string` | Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled. | -| `stateReason` | `object` | Describes a state change. | -| `subnetId` | `string` | [EC2-VPC] The ID of the subnet in which the instance is running. | -| `tagSet` | `array` | Any tags assigned to the instance. | -| `tpmSupport` | `string` | If the instance is configured for NitroTPM support, the value is <code>v2.0</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitrotpm.html">NitroTPM</a> in the <i>Amazon EC2 User Guide</i>. | -| `usageOperation` | `string` | The usage operation value for the instance. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/billing-info-fields.html">AMI billing information fields</a> in the <i>Amazon EC2 User Guide</i>. | -| `usageOperationUpdateTime` | `string` | The time that the usage operation was last updated. | -| `virtualizationType` | `string` | The virtualization type of the instance. | -| `vpcId` | `string` | [EC2-VPC] The ID of the VPC in which the instance is running. | + + + + + +
NameDatatypeDescription
instance_idstringThe EC2 Instance ID.
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `instances_Describe` | `SELECT` | `region` | <p>Describes the specified instances or all instances.</p> <p>If you specify instance IDs, the output includes information for only the specified instances. If you specify filters, the output includes information for only those instances that meet the filter criteria. If you do not specify instance IDs or filters, the output includes information for all instances, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully.</p> <p>If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the output.</p> <p>Recently terminated instances might appear in the returned results. This interval is usually less than one hour.</p> <p>If you describe instances in the rare case where an Availability Zone is experiencing a service disruption and you specify instance IDs that are in the affected zone, or do not specify any instance IDs at all, the call fails. If you describe instances and specify only instance IDs that are in an unaffected zone, the call works normally.</p> | -| `instance_Bundle` | `EXEC` | `InstanceId, Storage, region` | <p>Bundles an Amazon instance store-backed Windows instance.</p> <p>During bundling, only the root device volume (C:\) is bundled. Data on other instance store volumes is not preserved.</p> <note> <p>This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS.</p> </note> | -| `instance_Import` | `EXEC` | `Platform, region` | <p>Creates an import instance task using metadata from the specified disk image.</p> <p>This API action supports only single-volume VMs. To import multi-volume VMs, use <a>ImportImage</a> instead.</p> <p>This API action is not supported by the Command Line Interface (CLI). For information about using the Amazon EC2 CLI, which is deprecated, see <a href="https://awsdocs.s3.amazonaws.com/EC2/ec2-clt.pdf#UsingVirtualMachinesinAmazonEC2">Importing a VM to Amazon EC2</a> in the <i>Amazon EC2 CLI Reference</i> PDF file.</p> <p>For information about the import manifest referenced by this API action, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/manifest.html">VM Import Manifest</a>.</p> | -| `instances_Monitor` | `EXEC` | `InstanceId, region` | <p>Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch.html">Monitor your instances using CloudWatch</a> in the <i>Amazon EC2 User Guide</i>.</p> <p>To disable detailed monitoring, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_UnmonitorInstances.html">UnmonitorInstances</a>.</p> | -| `instances_Reboot` | `EXEC` | `InstanceId, region` | <p>Requests a reboot of the specified instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored.</p> <p>If an instance does not cleanly shut down within a few minutes, Amazon EC2 performs a hard reboot.</p> <p>For more information about troubleshooting, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-console.html">Troubleshoot an unreachable instance</a> in the <i>Amazon EC2 User Guide</i>.</p> | -| `instances_Run` | `EXEC` | `MaxCount, MinCount, region` | <p>Launches the specified number of instances using an AMI for which you have permissions.</p> <p>You can specify a number of options, or leave the default options. The following rules apply:</p> <ul> <li> <p>[EC2-VPC] If you don't specify a subnet ID, we choose a default subnet from your default VPC for you. If you don't have a default VPC, you must specify a subnet ID in the request.</p> </li> <li> <p>[EC2-Classic] If don't specify an Availability Zone, we choose one for you.</p> </li> <li> <p>Some instance types must be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID, the request fails. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-vpc.html#vpc-only-instance-types">Instance types available only in a VPC</a>.</p> </li> <li> <p>[EC2-VPC] All instances have a network interface with a primary private IPv4 address. If you don't specify this address, we choose one from the IPv4 range of your subnet.</p> </li> <li> <p>Not all instance types support IPv6 addresses. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance types</a>.</p> </li> <li> <p>If you don't specify a security group ID, we use the default security group. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html">Security groups</a>.</p> </li> <li> <p>If any of the AMIs have a product code attached for which the user has not subscribed, the request fails.</p> </li> </ul> <p>You can create a <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html">launch template</a>, which is a resource that contains the parameters to launch an instance. When you launch an instance using <a>RunInstances</a>, you can specify the launch template instead of specifying the launch parameters.</p> <p>To ensure faster instance launches, break up large requests into smaller batches. For example, create five separate launch requests for 100 instances each instead of one launch request for 500 instances.</p> <p>An instance is ready for you to use when it's in the <code>running</code> state. You can check the state of your instance using <a>DescribeInstances</a>. You can tag instances and EBS volumes during launch, after launch, or both. For more information, see <a>CreateTags</a> and <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html">Tagging your Amazon EC2 resources</a>.</p> <p>Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html">Key pairs</a>.</p> <p>For troubleshooting, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_InstanceStraightToTerminated.html">What to do if an instance immediately terminates</a>, and <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstancesConnecting.html">Troubleshooting connecting to your instance</a>.</p> | -| `instances_Start` | `EXEC` | `InstanceId, region` | <p>Starts an Amazon EBS-backed instance that you've previously stopped.</p> <p>Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for instance usage. However, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.</p> <p>Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.</p> <p>Performing this operation on an instance that uses an instance store as its root device returns an error.</p> <p>If you attempt to start a T3 instance with <code>host</code> tenancy and the <code>unlimted</code> CPU credit option, the request fails. The <code>unlimited</code> CPU credit option is not supported on Dedicated Hosts. Before you start the instance, either change its CPU credit option to <code>standard</code>, or change its tenancy to <code>default</code> or <code>dedicated</code>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html">Stop and start your instance</a> in the <i>Amazon EC2 User Guide</i>.</p> | -| `instances_Stop` | `EXEC` | `InstanceId, region` | <p>Stops an Amazon EBS-backed instance. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html">Stop and start your instance</a> in the <i>Amazon EC2 User Guide</i>.</p> <p>You can use the Stop action to hibernate an instance if the instance is <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html#enabling-hibernation">enabled for hibernation</a> and it meets the <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html#hibernating-prerequisites">hibernation prerequisites</a>. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html">Hibernate your instance</a> in the <i>Amazon EC2 User Guide</i>.</p> <p>We don't charge usage for a stopped instance, or data transfer fees; however, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.</p> <p>You can't stop or hibernate instance store-backed instances. You can't use the Stop action to hibernate Spot Instances, but you can specify that Amazon EC2 should hibernate Spot Instances when they are interrupted. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-interruptions.html#hibernate-spot-instances">Hibernating interrupted Spot Instances</a> in the <i>Amazon EC2 User Guide</i>.</p> <p>When you stop or hibernate an instance, we shut it down. You can restart your instance at any time. Before stopping or hibernating an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM, but hibernating an instance does preserve data stored in RAM. If an instance cannot hibernate successfully, a normal shutdown occurs.</p> <p>Stopping and hibernating an instance is different to rebooting or terminating it. For example, when you stop or hibernate an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between rebooting, stopping, hibernating, and terminating instances, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-lifecycle.html">Instance lifecycle</a> in the <i>Amazon EC2 User Guide</i>.</p> <p>When you stop an instance, we attempt to shut it down forcibly after a short while. If your instance appears stuck in the stopping state after a period of time, there may be an issue with the underlying host computer. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstancesStopping.html">Troubleshoot stopping your instance</a> in the <i>Amazon EC2 User Guide</i>.</p> | -| `instances_Terminate` | `EXEC` | `InstanceId, region` | <p>Shuts down the specified instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds. </p> <p>If you specify multiple instances and the request fails (for example, because of a single incorrect instance ID), none of the instances are terminated.</p> <p>If you terminate multiple instances across multiple Availability Zones, and one or more of the specified instances are enabled for termination protection, the request fails with the following results:</p> <ul> <li> <p>The specified instances that are in the same Availability Zone as the protected instance are not terminated.</p> </li> <li> <p>The specified instances that are in different Availability Zones, where no other specified instances are protected, are successfully terminated.</p> </li> </ul> <p>For example, say you have the following instances:</p> <ul> <li> <p>Instance A: <code>us-east-1a</code>; Not protected</p> </li> <li> <p>Instance B: <code>us-east-1a</code>; Not protected</p> </li> <li> <p>Instance C: <code>us-east-1b</code>; Protected</p> </li> <li> <p>Instance D: <code>us-east-1b</code>; not protected</p> </li> </ul> <p>If you attempt to terminate all of these instances in the same request, the request reports failure with the following results:</p> <ul> <li> <p>Instance A and Instance B are successfully terminated because none of the specified instances in <code>us-east-1a</code> are enabled for termination protection.</p> </li> <li> <p>Instance C and Instance D fail to terminate because at least one of the specified instances in <code>us-east-1b</code> (Instance C) is enabled for termination protection.</p> </li> </ul> <p>Terminated instances remain visible after termination (for approximately one hour).</p> <p>By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running.</p> <p>You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the <code>DeleteOnTermination</code> block device mapping parameter set to <code>true</code> are automatically deleted. For more information about the differences between stopping and terminating instances, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-lifecycle.html">Instance lifecycle</a> in the <i>Amazon EC2 User Guide</i>.</p> <p>For more information about troubleshooting, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstancesShuttingDown.html">Troubleshooting terminating your instance</a> in the <i>Amazon EC2 User Guide</i>.</p> | -| `instances_Unmonitor` | `EXEC` | `InstanceId, region` | Disables detailed monitoring for a running instance. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch.html">Monitoring your instances and volumes</a> in the <i>Amazon EC2 User Guide</i>. | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +instance_id +FROM aws.ec2.instances +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the instances resource, the following permissions are required: + +### Create +```json +iam:PassRole, +ec2:ModifyPrivateDnsNameOptions, +ec2:DescribeElasticGpus, +ec2:DescribeNetworkInterfaces, +ec2:DescribeVolumes, +ec2:RunInstances, +ec2:AssociateIamInstanceProfile, +ec2:DescribeIamInstanceProfileAssociations, +ec2:DescribeInstances, +ec2:DescribeSubnets, +ec2:DescribeKeyPairs, +ec2:DescribeSecurityGroups, +ec2:DescribeVpcs, +ec2:DescribeInstanceAttribute, +ec2:DescribeInstanceCreditSpecifications, +ec2:DescribeLaunchTemplates, +ec2:DescribeLaunchTemplateVersions, +ec2:DetachVolume, +ec2:DisassociateIamInstanceProfile, +ec2:ModifyInstanceAttribute, +ec2:ModifyInstanceCreditSpecification, +ec2:ModifyInstancePlacement, +ec2:MonitorInstances, +ec2:AttachVolume, +ec2:CreateTags, +ec2:ReplaceIamInstanceProfileAssociation, +ec2:StartInstances, +elastic-inference:DescribeAccelerators, +ssm:CreateAssociation, +ssm:DescribeAssociation, +ssm:ListAssociations +``` + +### List +```json +ec2:DescribeInstances +``` + diff --git a/docs/aws-docs/providers/aws/ec2/internet_gateway/index.md b/docs/aws-docs/providers/aws/ec2/internet_gateway/index.md new file mode 100644 index 0000000000..759bc85d70 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/internet_gateway/index.md @@ -0,0 +1,92 @@ +--- +title: internet_gateway +hide_title: false +hide_table_of_contents: false +keywords: + - internet_gateway + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual internet_gateway resource + +## Overview + + + + + +
Nameinternet_gateway
TypeResource
DescriptionAllocates an internet gateway for use with a VPC. After creating the Internet gateway, you then attach it to a VPC.
Idaws.ec2.internet_gateway
+ +## Fields + + + + + + +
NameDatatypeDescription
internet_gateway_idstring
tagsarrayAny tags to assign to the internet gateway.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +internet_gateway_id, +tags +FROM aws.ec2.internet_gateway +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the internet_gateway resource, the following permissions are required: + +### Read +```json +ec2:DescribeInternetGateways +``` + +### Delete +```json +ec2:DeleteInternetGateway, +ec2:DescribeInternetGateways +``` + +### Update +```json +ec2:DeleteTags, +ec2:CreateTags, +ec2:DescribeInternetGateways +``` + diff --git a/docs/aws-docs/providers/aws/ec2/internet_gateways/index.md b/docs/aws-docs/providers/aws/ec2/internet_gateways/index.md index 29a918f8e6..227d51acda 100644 --- a/docs/aws-docs/providers/aws/ec2/internet_gateways/index.md +++ b/docs/aws-docs/providers/aws/ec2/internet_gateways/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - internet_gateways - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,28 +14,66 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- - - +Retrieves a list of internet_gateways in a region ## Overview +
Nameinternet_gateways
TypeResource
DescriptionAllocates an internet gateway for use with a VPC. After creating the Internet gateway, you then attach it to a VPC.
Idaws.ec2.internet_gateways
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `attachmentSet` | `array` | Any VPCs attached to the internet gateway. | -| `internetGatewayId` | `string` | The ID of the internet gateway. | -| `ownerId` | `string` | The ID of the Amazon Web Services account that owns the internet gateway. | -| `tagSet` | `array` | Any tags assigned to the internet gateway. | + + + + + +
NameDatatypeDescription
internet_gateway_idstring
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `internet_gateways_Describe` | `SELECT` | `region` | Describes one or more of your internet gateways. | -| `internet_gateway_Create` | `INSERT` | `region` | <p>Creates an internet gateway for use with a VPC. After creating the internet gateway, you attach it to a VPC using <a>AttachInternetGateway</a>.</p> <p>For more information about your VPC and internet gateway, see the <a href="https://docs.aws.amazon.com/vpc/latest/userguide/">Amazon Virtual Private Cloud User Guide</a>.</p> | -| `internet_gateway_Delete` | `DELETE` | `InternetGatewayId, region` | Deletes the specified internet gateway. You must detach the internet gateway from the VPC before you can delete it. | -| `internet_gateway_Attach` | `EXEC` | `InternetGatewayId, VpcId, region` | Attaches an internet gateway or a virtual private gateway to a VPC, enabling connectivity between the internet and the VPC. For more information about your VPC and internet gateway, see the <a href="https://docs.aws.amazon.com/vpc/latest/userguide/">Amazon Virtual Private Cloud User Guide</a>. | -| `internet_gateway_Detach` | `EXEC` | `InternetGatewayId, VpcId, region` | Detaches an internet gateway from a VPC, disabling connectivity between the internet and the VPC. The VPC must not contain any running instances with Elastic IP addresses or public IPv4 addresses. | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +internet_gateway_id +FROM aws.ec2.internet_gateways +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the internet_gateways resource, the following permissions are required: + +### Create +```json +ec2:CreateInternetGateway, +ec2:CreateTags, +ec2:DescribeInternetGateways +``` + +### List +```json +ec2:DescribeInternetGateways +``` + diff --git a/docs/aws-docs/providers/aws/ec2/ipam/index.md b/docs/aws-docs/providers/aws/ec2/ipam/index.md new file mode 100644 index 0000000000..5111566435 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/ipam/index.md @@ -0,0 +1,114 @@ +--- +title: ipam +hide_title: false +hide_table_of_contents: false +keywords: + - ipam + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual ipam resource + +## Overview + + + + + +
Nameipam
TypeResource
DescriptionResource Schema of AWS::EC2::IPAM Type
Idaws.ec2.ipam
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
ipam_idstringId of the IPAM.
arnstringThe Amazon Resource Name (ARN) of the IPAM.
default_resource_discovery_idstringThe Id of the default resource discovery, created with this IPAM.
default_resource_discovery_association_idstringThe Id of the default association to the default resource discovery, created with this IPAM.
resource_discovery_association_countintegerThe count of resource discoveries associated with this IPAM.
descriptionstring
public_default_scope_idstringThe Id of the default scope for publicly routable IP space, created with this IPAM.
private_default_scope_idstringThe Id of the default scope for publicly routable IP space, created with this IPAM.
scope_countintegerThe number of scopes that currently exist in this IPAM.
operating_regionsarrayThe regions IPAM is enabled for. Allows pools to be created in these regions, as well as enabling monitoring
tierstringThe tier of the IPAM.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +ipam_id, +arn, +default_resource_discovery_id, +default_resource_discovery_association_id, +resource_discovery_association_count, +description, +public_default_scope_id, +private_default_scope_id, +scope_count, +operating_regions, +tier, +tags +FROM aws.ec2.ipam +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the ipam resource, the following permissions are required: + +### Read +```json +ec2:DescribeIpams +``` + +### Update +```json +ec2:ModifyIpam, +ec2:CreateTags, +ec2:DeleteTags, +ec2:DescribeIpams +``` + +### Delete +```json +ec2:DeleteIpam, +ec2:DeleteTags, +ec2:DescribeIpams +``` + diff --git a/docs/aws-docs/providers/aws/ec2/ipam_address_history/index.md b/docs/aws-docs/providers/aws/ec2/ipam_address_history/index.md deleted file mode 100644 index 8e9b237fac..0000000000 --- a/docs/aws-docs/providers/aws/ec2/ipam_address_history/index.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ipam_address_history -hide_title: false -hide_table_of_contents: false -keywords: - - ipam_address_history - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameipam_address_history
TypeResource
Idaws.ec2.ipam_address_history
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `resourceCidr` | `string` | The CIDR of the resource. | -| `resourceComplianceStatus` | `string` | The compliance status of a resource. For more information on compliance statuses, see <a href="/vpc/latest/ipam/monitor-cidr-compliance-ipam.html">Monitor CIDR usage by resource</a> in the <i>Amazon VPC IPAM User Guide</i>. | -| `resourceId` | `string` | The ID of the resource. | -| `resourceName` | `string` | The name of the resource. | -| `resourceOverlapStatus` | `string` | The overlap status of an IPAM resource. The overlap status tells you if the CIDR for a resource overlaps with another CIDR in the scope. For more information on overlap statuses, see <a href="/vpc/latest/ipam/monitor-cidr-compliance-ipam.html">Monitor CIDR usage by resource</a> in the <i>Amazon VPC IPAM User Guide</i>. | -| `resourceOwnerId` | `string` | The ID of the resource owner. | -| `resourceRegion` | `string` | The Amazon Web Services Region of the resource. | -| `resourceType` | `string` | The type of the resource. | -| `sampledEndTime` | `string` | Sampled end time of the resource-to-CIDR association within the IPAM scope. Changes are picked up in periodic snapshots, so the end time may have occurred before this specific time. | -| `sampledStartTime` | `string` | Sampled start time of the resource-to-CIDR association within the IPAM scope. Changes are picked up in periodic snapshots, so the start time may have occurred before this specific time. | -| `vpcId` | `string` | The VPC ID of the resource. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `ipam_address_history_Get` | `SELECT` | `Cidr, IpamScopeId, region` | diff --git a/docs/aws-docs/providers/aws/ec2/ipam_allocation/index.md b/docs/aws-docs/providers/aws/ec2/ipam_allocation/index.md new file mode 100644 index 0000000000..c5760d64d2 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/ipam_allocation/index.md @@ -0,0 +1,85 @@ +--- +title: ipam_allocation +hide_title: false +hide_table_of_contents: false +keywords: + - ipam_allocation + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual ipam_allocation resource + +## Overview + + + + + +
Nameipam_allocation
TypeResource
DescriptionResource Schema of AWS::EC2::IPAMAllocation Type
Idaws.ec2.ipam_allocation
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
ipam_pool_allocation_idstringId of the allocation.
ipam_pool_idstringId of the IPAM Pool.
cidrstring
netmask_lengthintegerThe desired netmask length of the allocation. If set, IPAM will choose a block of free space with this size and return the CIDR representing it.
descriptionstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +ipam_pool_allocation_id, +ipam_pool_id, +cidr, +netmask_length, +description +FROM aws.ec2.ipam_allocation +WHERE data__Identifier = '||'; +``` + +## Permissions + +To operate on the ipam_allocation resource, the following permissions are required: + +### Read +```json +ec2:GetIpamPoolAllocations +``` + +### Delete +```json +ec2:ReleaseIpamPoolAllocation +``` + diff --git a/docs/aws-docs/providers/aws/ec2/ipam_allocations/index.md b/docs/aws-docs/providers/aws/ec2/ipam_allocations/index.md new file mode 100644 index 0000000000..3c0968eb42 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/ipam_allocations/index.md @@ -0,0 +1,82 @@ +--- +title: ipam_allocations +hide_title: false +hide_table_of_contents: false +keywords: + - ipam_allocations + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Retrieves a list of ipam_allocations in a region + +## Overview + + + + + +
Nameipam_allocations
TypeResource
DescriptionResource Schema of AWS::EC2::IPAMAllocation Type
Idaws.ec2.ipam_allocations
+ +## Fields + + + + + + + +
NameDatatypeDescription
ipam_pool_idstringId of the IPAM Pool.
ipam_pool_allocation_idstringId of the allocation.
cidrundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +ipam_pool_id, +ipam_pool_allocation_id, +cidr +FROM aws.ec2.ipam_allocations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the ipam_allocations resource, the following permissions are required: + +### Create +```json +ec2:AllocateIpamPoolCidr, +ec2:GetIpamPoolAllocations +``` + +### List +```json +ec2:GetIpamPoolAllocations +``` + diff --git a/docs/aws-docs/providers/aws/ec2/ipam_organization_admin_account/index.md b/docs/aws-docs/providers/aws/ec2/ipam_organization_admin_account/index.md deleted file mode 100644 index 5820e2a0ba..0000000000 --- a/docs/aws-docs/providers/aws/ec2/ipam_organization_admin_account/index.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ipam_organization_admin_account -hide_title: false -hide_table_of_contents: false -keywords: - - ipam_organization_admin_account - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameipam_organization_admin_account
TypeResource
Idaws.ec2.ipam_organization_admin_account
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `ipam_organization_admin_account_Disable` | `EXEC` | `DelegatedAdminAccountId, region` | Disable the IPAM account. For more information, see <a href="/vpc/latest/ipam/enable-integ-ipam.html">Enable integration with Organizations</a> in the <i>Amazon VPC IPAM User Guide</i>. | -| `ipam_organization_admin_account_Enable` | `EXEC` | `DelegatedAdminAccountId, region` | Enable an Organizations member account as the IPAM admin account. You cannot select the Organizations management account as the IPAM admin account. For more information, see <a href="/vpc/latest/ipam/enable-integ-ipam.html">Enable integration with Organizations</a> in the <i>Amazon VPC IPAM User Guide</i>. | diff --git a/docs/aws-docs/providers/aws/ec2/ipam_pool/index.md b/docs/aws-docs/providers/aws/ec2/ipam_pool/index.md new file mode 100644 index 0000000000..78cc7685e3 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/ipam_pool/index.md @@ -0,0 +1,144 @@ +--- +title: ipam_pool +hide_title: false +hide_table_of_contents: false +keywords: + - ipam_pool + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual ipam_pool resource + +## Overview + + + + + +
Nameipam_pool
TypeResource
DescriptionResource Schema of AWS::EC2::IPAMPool Type
Idaws.ec2.ipam_pool
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
ipam_pool_idstringId of the IPAM Pool.
address_familystringThe address family of the address space in this pool. Either IPv4 or IPv6.
allocation_min_netmask_lengthintegerThe minimum allowed netmask length for allocations made from this pool.
allocation_default_netmask_lengthintegerThe default netmask length for allocations made from this pool. This value is used when the netmask length of an allocation isn't specified.
allocation_max_netmask_lengthintegerThe maximum allowed netmask length for allocations made from this pool.
allocation_resource_tagsarrayWhen specified, an allocation will not be allowed unless a resource has a matching set of tags.
arnstringThe Amazon Resource Name (ARN) of the IPAM Pool.
auto_importbooleanDetermines what to do if IPAM discovers resources that haven't been assigned an allocation. If set to true, an allocation will be made automatically.
aws_servicestringLimits which service in Amazon Web Services that the pool can be used in.
descriptionstring
ipam_scope_idstringThe Id of the scope this pool is a part of.
ipam_scope_arnstringThe Amazon Resource Name (ARN) of the scope this pool is a part of.
ipam_scope_typestringDetermines whether this scope contains publicly routable space or space for a private network
ipam_arnstringThe Amazon Resource Name (ARN) of the IPAM this pool is a part of.
localestringThe region of this pool. If not set, this will default to "None" which will disable non-custom allocations. If the locale has been specified for the source pool, this value must match.
pool_depthintegerThe depth of this pool in the source pool hierarchy.
provisioned_cidrsarrayA list of cidrs representing the address space available for allocation in this pool.
public_ip_sourcestringThe IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is `byoip`.
publicly_advertisablebooleanDetermines whether or not address space from this pool is publicly advertised. Must be set if and only if the pool is IPv6.
source_ipam_pool_idstringThe Id of this pool's source. If set, all space provisioned in this pool must be free space provisioned in the parent pool.
source_resourceobject
statestringThe state of this pool. This can be one of the following values: "create-in-progress", "create-complete", "modify-in-progress", "modify-complete", "delete-in-progress", or "delete-complete"
state_messagestringAn explanation of how the pool arrived at it current state.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +ipam_pool_id, +address_family, +allocation_min_netmask_length, +allocation_default_netmask_length, +allocation_max_netmask_length, +allocation_resource_tags, +arn, +auto_import, +aws_service, +description, +ipam_scope_id, +ipam_scope_arn, +ipam_scope_type, +ipam_arn, +locale, +pool_depth, +provisioned_cidrs, +public_ip_source, +publicly_advertisable, +source_ipam_pool_id, +source_resource, +state, +state_message, +tags +FROM aws.ec2.ipam_pool +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the ipam_pool resource, the following permissions are required: + +### Read +```json +ec2:DescribeIpamPools, +ec2:GetIpamPoolCidrs +``` + +### Update +```json +ec2:ModifyIpamPool, +ec2:DescribeIpamPools, +ec2:GetIpamPoolCidrs, +ec2:ProvisionIpamPoolCidr, +ec2:DeprovisionIpamPoolCidr, +ec2:CreateTags, +ec2:DeleteTags +``` + +### Delete +```json +ec2:DeleteIpamPool, +ec2:DescribeIpamPools, +ec2:GetIpamPoolCidrs, +ec2:DeprovisionIpamPoolCidr, +ec2:DeleteTags +``` + diff --git a/docs/aws-docs/providers/aws/ec2/ipam_pool_allocations/index.md b/docs/aws-docs/providers/aws/ec2/ipam_pool_allocations/index.md deleted file mode 100644 index 6344a843dd..0000000000 --- a/docs/aws-docs/providers/aws/ec2/ipam_pool_allocations/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ipam_pool_allocations -hide_title: false -hide_table_of_contents: false -keywords: - - ipam_pool_allocations - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameipam_pool_allocations
TypeResource
Idaws.ec2.ipam_pool_allocations
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `description` | `string` | A description of the pool allocation. | -| `cidr` | `string` | The CIDR for the allocation. A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is <code>10.24.34.0/23</code>. An IPv6 CIDR example is <code>2001:DB8::/32</code>. | -| `ipamPoolAllocationId` | `string` | The ID of an allocation. | -| `resourceId` | `string` | The ID of the resource. | -| `resourceOwner` | `string` | The owner of the resource. | -| `resourceRegion` | `string` | The Amazon Web Services Region of the resource. | -| `resourceType` | `string` | The type of the resource. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `ipam_pool_allocations_Get` | `SELECT` | `IpamPoolId, region` | Get a list of all the CIDR allocations in an IPAM pool. | -| `ipam_pool_allocation_Release` | `EXEC` | `Cidr, IpamPoolAllocationId, IpamPoolId, region` | Release an allocation within an IPAM pool. You can only use this action to release manual allocations. To remove an allocation for a resource without deleting the resource, set its monitored state to false using <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyIpamResourceCidr.html">ModifyIpamResourceCidr</a>. For more information, see <a href="/vpc/latest/ipam/release-pool-alloc-ipam.html">Release an allocation</a> in the <i>Amazon VPC IPAM User Guide</i>. | diff --git a/docs/aws-docs/providers/aws/ec2/ipam_pool_cidr/index.md b/docs/aws-docs/providers/aws/ec2/ipam_pool_cidr/index.md new file mode 100644 index 0000000000..507cc74279 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/ipam_pool_cidr/index.md @@ -0,0 +1,86 @@ +--- +title: ipam_pool_cidr +hide_title: false +hide_table_of_contents: false +keywords: + - ipam_pool_cidr + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual ipam_pool_cidr resource + +## Overview + + + + + +
Nameipam_pool_cidr
TypeResource
DescriptionResource Schema of AWS::EC2::IPAMPoolCidr Type
Idaws.ec2.ipam_pool_cidr
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
ipam_pool_cidr_idstringId of the IPAM Pool Cidr.
ipam_pool_idstringId of the IPAM Pool.
cidrstringRepresents a single IPv4 or IPv6 CIDR
netmask_lengthintegerThe desired netmask length of the provision. If set, IPAM will choose a block of free space with this size and return the CIDR representing it.
statestringProvisioned state of the cidr.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +ipam_pool_cidr_id, +ipam_pool_id, +cidr, +netmask_length, +state +FROM aws.ec2.ipam_pool_cidr +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the ipam_pool_cidr resource, the following permissions are required: + +### Read +```json +ec2:GetIpamPoolCidrs +``` + +### Delete +```json +ec2:DeprovisionIpamPoolCidr, +ec2:GetIpamPoolCidrs +``` + diff --git a/docs/aws-docs/providers/aws/ec2/ipam_pool_cidrs/index.md b/docs/aws-docs/providers/aws/ec2/ipam_pool_cidrs/index.md index 857788a4fd..9366c8d705 100644 --- a/docs/aws-docs/providers/aws/ec2/ipam_pool_cidrs/index.md +++ b/docs/aws-docs/providers/aws/ec2/ipam_pool_cidrs/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - ipam_pool_cidrs - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,26 +14,67 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- - - +Retrieves a list of ipam_pool_cidrs in a region ## Overview +
Nameipam_pool_cidrs
TypeResource
DescriptionResource Schema of AWS::EC2::IPAMPoolCidr Type
Idaws.ec2.ipam_pool_cidrs
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `cidr` | `string` | The CIDR provisioned to the IPAM pool. A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is <code>10.24.34.0/23</code>. An IPv6 CIDR example is <code>2001:DB8::/32</code>. | -| `failureReason` | `object` | Details related to why an IPAM pool CIDR failed to be provisioned. | -| `state` | `string` | The state of the CIDR. | + + + + + + +
NameDatatypeDescription
ipam_pool_idstringId of the IPAM Pool.
ipam_pool_cidr_idstringId of the IPAM Pool Cidr.
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `ipam_pool_cidrs_Get` | `SELECT` | `IpamPoolId, region` | Get the CIDRs provisioned to an IPAM pool. | -| `ipam_pool_cidr_Allocate` | `EXEC` | `IpamPoolId, region` | Allocate a CIDR from an IPAM pool. In IPAM, an allocation is a CIDR assignment from an IPAM pool to another resource or IPAM pool. For more information, see <a href="/vpc/latest/ipam/allocate-cidrs-ipam.html">Allocate CIDRs</a> in the <i>Amazon VPC IPAM User Guide</i>. | -| `ipam_pool_cidr_Deprovision` | `EXEC` | `IpamPoolId, region` | Deprovision a CIDR provisioned from an IPAM pool. If you deprovision a CIDR from a pool that has a source pool, the CIDR is recycled back into the source pool. For more information, see <a href="/vpc/latest/ipam/depro-pool-cidr-ipam.html">Deprovision pool CIDRs</a> in the <i>Amazon VPC IPAM User Guide</i>. | -| `ipam_pool_cidr_Provision` | `EXEC` | `IpamPoolId, region` | <p>Provision a CIDR to an IPAM pool. You can use this action to provision new CIDRs to a top-level pool or to transfer a CIDR from a top-level pool to a pool within it.</p> <p>For more information, see <a href="/vpc/latest/ipam/prov-cidr-ipam.html">Provision CIDRs to pools</a> in the <i>Amazon VPC IPAM User Guide</i>. </p> | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +ipam_pool_id, +ipam_pool_cidr_id +FROM aws.ec2.ipam_pool_cidrs +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the ipam_pool_cidrs resource, the following permissions are required: + +### Create +```json +ec2:ProvisionIpamPoolCidr, +ec2:GetIpamPoolCidrs +``` + +### List +```json +ec2:GetIpamPoolCidrs +``` + diff --git a/docs/aws-docs/providers/aws/ec2/ipam_pools/index.md b/docs/aws-docs/providers/aws/ec2/ipam_pools/index.md index 61bd9d62b2..aad9b3065b 100644 --- a/docs/aws-docs/providers/aws/ec2/ipam_pools/index.md +++ b/docs/aws-docs/providers/aws/ec2/ipam_pools/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - ipam_pools - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,45 +14,68 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- - - +Retrieves a list of ipam_pools in a region ## Overview +
Nameipam_pools
TypeResource
DescriptionResource Schema of AWS::EC2::IPAMPool Type
Idaws.ec2.ipam_pools
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `description` | `string` | The description of the IPAM pool. | -| `addressFamily` | `string` | The address family of the pool. | -| `allocationDefaultNetmaskLength` | `integer` | The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16. | -| `allocationMaxNetmaskLength` | `integer` | The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. | -| `allocationMinNetmaskLength` | `integer` | The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. | -| `allocationResourceTagSet` | `array` | Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant. | -| `autoImport` | `boolean` | <p>If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only. </p> <p>A locale must be set on the pool for this feature to work.</p> | -| `awsService` | `string` | Limits which service in Amazon Web Services that the pool can be used in. "ec2", for example, allows users to use space for Elastic IP addresses and VPCs. | -| `ipamArn` | `string` | The ARN of the IPAM. | -| `ipamPoolArn` | `string` | The ARN of the IPAM pool. | -| `ipamPoolId` | `string` | The ID of the IPAM pool. | -| `ipamRegion` | `string` | The Amazon Web Services Region of the IPAM pool. | -| `ipamScopeArn` | `string` | The ARN of the scope of the IPAM pool. | -| `ipamScopeType` | `string` | In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict. | -| `locale` | `string` | The locale of the IPAM pool. In IPAM, the locale is the Amazon Web Services Region where you want to make an IPAM pool available for allocations. Only resources in the same Region as the locale of the pool can get IP address allocations from the pool. You can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region. Note that once you choose a Locale for a pool, you cannot modify it. If you choose an Amazon Web Services Region for locale that has not been configured as an operating Region for the IPAM, you'll get an error. | -| `ownerId` | `string` | The Amazon Web Services account ID of the owner of the IPAM pool. | -| `poolDepth` | `integer` | The depth of pools in your IPAM pool. The pool depth quota is 10. For more information, see <a href="/vpc/latest/ipam/quotas-ipam.html">Quotas in IPAM</a> in the <i>Amazon VPC IPAM User Guide</i>. | -| `publiclyAdvertisable` | `boolean` | Determines if a pool is publicly advertisable. This option is not available for pools with AddressFamily set to <code>ipv4</code>. | -| `sourceIpamPoolId` | `string` | The ID of the source IPAM pool. You can use this option to create an IPAM pool within an existing source pool. | -| `state` | `string` | The state of the IPAM pool. | -| `stateMessage` | `string` | A message related to the failed creation of an IPAM pool. | -| `tagSet` | `array` | The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key <code>Owner</code> and the value <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter value. | + + + + + +
NameDatatypeDescription
ipam_pool_idstringId of the IPAM Pool.
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `ipam_pools_Describe` | `SELECT` | `region` | Get information about your IPAM pools. | -| `ipam_pool_Create` | `INSERT` | `AddressFamily, IpamScopeId, region` | <p>Create an IP address pool for Amazon VPC IP Address Manager (IPAM). In IPAM, a pool is a collection of contiguous IP addresses CIDRs. Pools enable you to organize your IP addresses according to your routing and security needs. For example, if you have separate routing and security needs for development and production applications, you can create a pool for each.</p> <p>For more information, see <a href="/vpc/latest/ipam/create-top-ipam.html">Create a top-level pool</a> in the <i>Amazon VPC IPAM User Guide</i>. </p> | -| `ipam_pool_Delete` | `DELETE` | `IpamPoolId, region` | <p>Delete an IPAM pool.</p> <note> <p>You cannot delete an IPAM pool if there are allocations in it or CIDRs provisioned to it. To release allocations, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ReleaseIpamPoolAllocation.html">ReleaseIpamPoolAllocation</a>. To deprovision pool CIDRs, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeprovisionIpamPoolCidr.html">DeprovisionIpamPoolCidr</a>.</p> </note> <p>For more information, see <a href="/vpc/latest/ipam/delete-pool-ipam.html">Delete a pool</a> in the <i>Amazon VPC IPAM User Guide</i>. </p> | -| `ipam_pool_Modify` | `EXEC` | `IpamPoolId, region` | <p>Modify the configurations of an IPAM pool.</p> <p>For more information, see <a href="/vpc/latest/ipam/mod-pool-ipam.html">Modify a pool</a> in the <i>Amazon VPC IPAM User Guide</i>. </p> | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +ipam_pool_id +FROM aws.ec2.ipam_pools +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the ipam_pools resource, the following permissions are required: + +### Create +```json +ec2:CreateIpamPool, +ec2:DescribeIpamPools, +ec2:ProvisionIpamPoolCidr, +ec2:GetIpamPoolCidrs, +ec2:CreateTags +``` + +### List +```json +ec2:DescribeIpamPools +``` + diff --git a/docs/aws-docs/providers/aws/ec2/ipam_resource_cidrs/index.md b/docs/aws-docs/providers/aws/ec2/ipam_resource_cidrs/index.md deleted file mode 100644 index 163f129deb..0000000000 --- a/docs/aws-docs/providers/aws/ec2/ipam_resource_cidrs/index.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: ipam_resource_cidrs -hide_title: false -hide_table_of_contents: false -keywords: - - ipam_resource_cidrs - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameipam_resource_cidrs
TypeResource
Idaws.ec2.ipam_resource_cidrs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `complianceStatus` | `string` | The compliance status of the IPAM resource. For more information on compliance statuses, see <a href="/vpc/latest/ipam/monitor-cidr-compliance-ipam.html">Monitor CIDR usage by resource</a> in the <i>Amazon VPC IPAM User Guide</i>. | -| `ipUsage` | `number` | The IP address space in the IPAM pool that is allocated to this resource. To convert the decimal to a percentage, multiply the decimal by 100. | -| `ipamId` | `string` | The IPAM ID for an IPAM resource. | -| `ipamPoolId` | `string` | The pool ID for an IPAM resource. | -| `ipamScopeId` | `string` | The scope ID for an IPAM resource. | -| `managementState` | `string` | The management state of the resource. For more information about management states, see <a href="/vpc/latest/ipam/monitor-cidr-compliance-ipam.html">Monitor CIDR usage by resource</a> in the <i>Amazon VPC IPAM User Guide</i>. | -| `overlapStatus` | `string` | The overlap status of an IPAM resource. The overlap status tells you if the CIDR for a resource overlaps with another CIDR in the scope. For more information on overlap statuses, see <a href="/vpc/latest/ipam/monitor-cidr-compliance-ipam.html">Monitor CIDR usage by resource</a> in the <i>Amazon VPC IPAM User Guide</i>. | -| `resourceCidr` | `string` | The CIDR for an IPAM resource. | -| `resourceId` | `string` | The ID of an IPAM resource. | -| `resourceName` | `string` | The name of an IPAM resource. | -| `resourceOwnerId` | `string` | The Amazon Web Services account number of the owner of an IPAM resource. | -| `resourceRegion` | `string` | The Amazon Web Services Region for an IPAM resource. | -| `resourceTagSet` | `array` | The tags for an IPAM resource. | -| `resourceType` | `string` | The type of IPAM resource. | -| `vpcId` | `string` | The ID of a VPC. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `ipam_resource_cidrs_Get` | `SELECT` | `IpamScopeId, region` | Get information about the resources in a scope. | -| `ipam_resource_cidr_Modify` | `EXEC` | `CurrentIpamScopeId, Monitored, ResourceCidr, ResourceId, ResourceRegion, region` | <p>Modify a resource CIDR. You can use this action to transfer resource CIDRs between scopes and ignore resource CIDRs that you do not want to manage. If set to false, the resource will not be tracked for overlap, it cannot be auto-imported into a pool, and it will be removed from any pool it has an allocation in.</p> <p>For more information, see <a href="/vpc/latest/ipam/move-resource-ipam.html">Move resource CIDRs between scopes</a> and <a href="/vpc/latest/ipam/change-monitoring-state-ipam.html">Change the monitoring state of resource CIDRs</a> in the <i>Amazon VPC IPAM User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2/ipam_resource_discoveries/index.md b/docs/aws-docs/providers/aws/ec2/ipam_resource_discoveries/index.md new file mode 100644 index 0000000000..029a257282 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/ipam_resource_discoveries/index.md @@ -0,0 +1,79 @@ +--- +title: ipam_resource_discoveries +hide_title: false +hide_table_of_contents: false +keywords: + - ipam_resource_discoveries + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Retrieves a list of ipam_resource_discoveries in a region + +## Overview + + + + + +
Nameipam_resource_discoveries
TypeResource
DescriptionResource Schema of AWS::EC2::IPAMResourceDiscovery Type
Idaws.ec2.ipam_resource_discoveries
+ +## Fields + + + + + +
NameDatatypeDescription
ipam_resource_discovery_idstringId of the IPAM Pool.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +ipam_resource_discovery_id +FROM aws.ec2.ipam_resource_discoveries +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the ipam_resource_discoveries resource, the following permissions are required: + +### Create +```json +ec2:CreateIpamResourceDiscovery, +ec2:DescribeIpamResourceDiscoveries, +ec2:CreateTags +``` + +### List +```json +ec2:DescribeIpamResourceDiscoveries +``` + diff --git a/docs/aws-docs/providers/aws/ec2/ipam_resource_discovery/index.md b/docs/aws-docs/providers/aws/ec2/ipam_resource_discovery/index.md new file mode 100644 index 0000000000..1ef0bc3fc2 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/ipam_resource_discovery/index.md @@ -0,0 +1,108 @@ +--- +title: ipam_resource_discovery +hide_title: false +hide_table_of_contents: false +keywords: + - ipam_resource_discovery + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual ipam_resource_discovery resource + +## Overview + + + + + +
Nameipam_resource_discovery
TypeResource
DescriptionResource Schema of AWS::EC2::IPAMResourceDiscovery Type
Idaws.ec2.ipam_resource_discovery
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
ipam_resource_discovery_idstringId of the IPAM Pool.
owner_idstringOwner Account ID of the Resource Discovery
operating_regionsarrayThe regions Resource Discovery is enabled for. Allows resource discoveries to be created in these regions, as well as enabling monitoring
ipam_resource_discovery_regionstringThe region the resource discovery is setup in.
descriptionstring
is_defaultbooleanDetermines whether or not address space from this pool is publicly advertised. Must be set if and only if the pool is IPv6.
ipam_resource_discovery_arnstringAmazon Resource Name (Arn) for the Resource Discovery.
statestringThe state of this Resource Discovery.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +ipam_resource_discovery_id, +owner_id, +operating_regions, +ipam_resource_discovery_region, +description, +is_default, +ipam_resource_discovery_arn, +state, +tags +FROM aws.ec2.ipam_resource_discovery +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the ipam_resource_discovery resource, the following permissions are required: + +### Read +```json +ec2:DescribeIpamResourceDiscoveries +``` + +### Update +```json +ec2:ModifyIpamResourceDiscovery, +ec2:DescribeIpamResourceDiscoveries, +ec2:CreateTags, +ec2:DeleteTags +``` + +### Delete +```json +ec2:DeleteIpamResourceDiscovery, +ec2:DescribeIpamResourceDiscoveries, +ec2:DeleteTags +``` + diff --git a/docs/aws-docs/providers/aws/ec2/ipam_resource_discovery_association/index.md b/docs/aws-docs/providers/aws/ec2/ipam_resource_discovery_association/index.md new file mode 100644 index 0000000000..639e07bfe8 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/ipam_resource_discovery_association/index.md @@ -0,0 +1,111 @@ +--- +title: ipam_resource_discovery_association +hide_title: false +hide_table_of_contents: false +keywords: + - ipam_resource_discovery_association + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual ipam_resource_discovery_association resource + +## Overview + + + + + +
Nameipam_resource_discovery_association
TypeResource
DescriptionResource Schema of AWS::EC2::IPAMResourceDiscoveryAssociation Type
Idaws.ec2.ipam_resource_discovery_association
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
ipam_arnstringArn of the IPAM.
ipam_regionstringThe home region of the IPAM.
ipam_resource_discovery_association_idstringId of the IPAM Resource Discovery Association.
ipam_resource_discovery_idstringThe Amazon Resource Name (ARN) of the IPAM Resource Discovery Association.
ipam_idstringThe Id of the IPAM this Resource Discovery is associated to.
ipam_resource_discovery_association_arnstringThe Amazon Resource Name (ARN) of the resource discovery association is a part of.
is_defaultbooleanIf the Resource Discovery Association exists due as part of CreateIpam.
owner_idstringThe AWS Account ID for the account where the shared IPAM exists.
statestringThe operational state of the Resource Discovery Association. Related to Create/Delete activities.
resource_discovery_statusstringThe status of the resource discovery.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +ipam_arn, +ipam_region, +ipam_resource_discovery_association_id, +ipam_resource_discovery_id, +ipam_id, +ipam_resource_discovery_association_arn, +is_default, +owner_id, +state, +resource_discovery_status, +tags +FROM aws.ec2.ipam_resource_discovery_association +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the ipam_resource_discovery_association resource, the following permissions are required: + +### Read +```json +ec2:DescribeIpamResourceDiscoveryAssociations +``` + +### Update +```json +ec2:DescribeIpamResourceDiscoveryAssociations, +ec2:CreateTags, +ec2:DeleteTags +``` + +### Delete +```json +ec2:DisassociateIpamResourceDiscovery, +ec2:DescribeIpamResourceDiscoveryAssociations, +ec2:DeleteTags +``` + diff --git a/docs/aws-docs/providers/aws/ec2/ipam_resource_discovery_associations/index.md b/docs/aws-docs/providers/aws/ec2/ipam_resource_discovery_associations/index.md new file mode 100644 index 0000000000..11f1229bef --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/ipam_resource_discovery_associations/index.md @@ -0,0 +1,79 @@ +--- +title: ipam_resource_discovery_associations +hide_title: false +hide_table_of_contents: false +keywords: + - ipam_resource_discovery_associations + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Retrieves a list of ipam_resource_discovery_associations in a region + +## Overview + + + + + +
Nameipam_resource_discovery_associations
TypeResource
DescriptionResource Schema of AWS::EC2::IPAMResourceDiscoveryAssociation Type
Idaws.ec2.ipam_resource_discovery_associations
+ +## Fields + + + + + +
NameDatatypeDescription
ipam_resource_discovery_association_idstringId of the IPAM Resource Discovery Association.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +ipam_resource_discovery_association_id +FROM aws.ec2.ipam_resource_discovery_associations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the ipam_resource_discovery_associations resource, the following permissions are required: + +### Create +```json +ec2:AssociateIpamResourceDiscovery, +ec2:DescribeIpamResourceDiscoveryAssociations, +ec2:CreateTags +``` + +### List +```json +ec2:DescribeIpamResourceDiscoveryAssociations +``` + diff --git a/docs/aws-docs/providers/aws/ec2/ipam_scope/index.md b/docs/aws-docs/providers/aws/ec2/ipam_scope/index.md new file mode 100644 index 0000000000..4678347d64 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/ipam_scope/index.md @@ -0,0 +1,108 @@ +--- +title: ipam_scope +hide_title: false +hide_table_of_contents: false +keywords: + - ipam_scope + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual ipam_scope resource + +## Overview + + + + + +
Nameipam_scope
TypeResource
DescriptionResource Schema of AWS::EC2::IPAMScope Type
Idaws.ec2.ipam_scope
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
ipam_scope_idstringId of the IPAM scope.
arnstringThe Amazon Resource Name (ARN) of the IPAM scope.
ipam_idstringThe Id of the IPAM this scope is a part of.
ipam_arnstringThe Amazon Resource Name (ARN) of the IPAM this scope is a part of.
ipam_scope_typestringDetermines whether this scope contains publicly routable space or space for a private network
is_defaultbooleanIs this one of the default scopes created with the IPAM.
descriptionstring
pool_countintegerThe number of pools that currently exist in this scope.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +ipam_scope_id, +arn, +ipam_id, +ipam_arn, +ipam_scope_type, +is_default, +description, +pool_count, +tags +FROM aws.ec2.ipam_scope +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the ipam_scope resource, the following permissions are required: + +### Read +```json +ec2:DescribeIpamScopes +``` + +### Update +```json +ec2:ModifyIpamScope, +ec2:DescribeIpamScopes, +ec2:CreateTags, +ec2:DeleteTags +``` + +### Delete +```json +ec2:DeleteIpamScope, +ec2:DescribeIpamScopes, +ec2:DeleteTags +``` + diff --git a/docs/aws-docs/providers/aws/ec2/ipam_scopes/index.md b/docs/aws-docs/providers/aws/ec2/ipam_scopes/index.md index dcbd3a8d1f..60115d8dd2 100644 --- a/docs/aws-docs/providers/aws/ec2/ipam_scopes/index.md +++ b/docs/aws-docs/providers/aws/ec2/ipam_scopes/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - ipam_scopes - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,34 +14,66 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- - - +Retrieves a list of ipam_scopes in a region ## Overview +
Nameipam_scopes
TypeResource
DescriptionResource Schema of AWS::EC2::IPAMScope Type
Idaws.ec2.ipam_scopes
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `description` | `string` | The description of the scope. | -| `ipamArn` | `string` | The ARN of the IPAM. | -| `ipamRegion` | `string` | The Amazon Web Services Region of the IPAM scope. | -| `ipamScopeArn` | `string` | The ARN of the scope. | -| `ipamScopeId` | `string` | The ID of the scope. | -| `ipamScopeType` | `string` | The type of the scope. | -| `isDefault` | `boolean` | Defines if the scope is the default scope or not. | -| `ownerId` | `string` | The Amazon Web Services account ID of the owner of the scope. | -| `poolCount` | `integer` | The number of pools in the scope. | -| `state` | `string` | The state of the IPAM scope. | -| `tagSet` | `array` | The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key <code>Owner</code> and the value <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter value. | + + + + + +
NameDatatypeDescription
ipam_scope_idstringId of the IPAM scope.
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `ipam_scopes_Describe` | `SELECT` | `region` | Get information about your IPAM scopes. | -| `ipam_scope_Create` | `INSERT` | `IpamId, region` | <p>Create an IPAM scope. In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.</p> <p>For more information, see <a href="/vpc/latest/ipam/add-scope-ipam.html">Add a scope</a> in the <i>Amazon VPC IPAM User Guide</i>.</p> | -| `ipam_scope_Delete` | `DELETE` | `IpamScopeId, region` | <p>Delete the scope for an IPAM. You cannot delete the default scopes.</p> <p>For more information, see <a href="/vpc/latest/ipam/delete-scope-ipam.html">Delete a scope</a> in the <i>Amazon VPC IPAM User Guide</i>. </p> | -| `ipam_scope_Modify` | `EXEC` | `IpamScopeId, region` | Modify an IPAM scope. | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +ipam_scope_id +FROM aws.ec2.ipam_scopes +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the ipam_scopes resource, the following permissions are required: + +### Create +```json +ec2:CreateIpamScope, +ec2:DescribeIpamScopes, +ec2:CreateTags +``` + +### List +```json +ec2:DescribeIpamScopes +``` + diff --git a/docs/aws-docs/providers/aws/ec2/ipams/index.md b/docs/aws-docs/providers/aws/ec2/ipams/index.md index 0158b4f32b..bdeab9edfd 100644 --- a/docs/aws-docs/providers/aws/ec2/ipams/index.md +++ b/docs/aws-docs/providers/aws/ec2/ipams/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - ipams - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,34 +14,67 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- - - +Retrieves a list of ipams in a region ## Overview +
Nameipams
TypeResource
DescriptionResource Schema of AWS::EC2::IPAM Type
Idaws.ec2.ipams
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `description` | `string` | The description for the IPAM. | -| `ipamArn` | `string` | The ARN of the IPAM. | -| `ipamId` | `string` | The ID of the IPAM. | -| `ipamRegion` | `string` | The Amazon Web Services Region of the IPAM. | -| `operatingRegionSet` | `array` | <p>The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.</p> <p>For more information about operating Regions, see <a href="/vpc/latest/ipam/create-ipam.html">Create an IPAM</a> in the <i>Amazon VPC IPAM User Guide</i>.</p> | -| `ownerId` | `string` | The Amazon Web Services account ID of the owner of the IPAM. | -| `privateDefaultScopeId` | `string` | The ID of the IPAM's default private scope. | -| `publicDefaultScopeId` | `string` | The ID of the IPAM's default public scope. | -| `scopeCount` | `integer` | The number of scopes in the IPAM. The scope quota is 5. For more information on quotas, see <a href="/vpc/latest/ipam/quotas-ipam.html">Quotas in IPAM</a> in the <i>Amazon VPC IPAM User Guide</i>. | -| `state` | `string` | The state of the IPAM. | -| `tagSet` | `array` | The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key <code>Owner</code> and the value <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter value. | + + + + + +
NameDatatypeDescription
ipam_idstringId of the IPAM.
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `ipams_Describe` | `SELECT` | `region` | <p>Get information about your IPAM pools.</p> <p>For more information, see <a href="/vpc/latest/ipam/what-is-it-ipam.html">What is IPAM?</a> in the <i>Amazon VPC IPAM User Guide</i>. </p> | -| `ipam_Create` | `INSERT` | `region` | <p>Create an IPAM. Amazon VPC IP Address Manager (IPAM) is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization.</p> <p>For more information, see <a href="/vpc/latest/ipam/create-ipam.html">Create an IPAM</a> in the <i>Amazon VPC IPAM User Guide</i>. </p> | -| `ipam_Delete` | `DELETE` | `IpamId, region` | <p>Delete an IPAM. Deleting an IPAM removes all monitored data associated with the IPAM including the historical data for CIDRs.</p> <p>For more information, see <a href="/vpc/latest/ipam/delete-ipam.html">Delete an IPAM</a> in the <i>Amazon VPC IPAM User Guide</i>. </p> | -| `ipam_Modify` | `EXEC` | `IpamId, region` | Modify the configurations of an IPAM. | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +ipam_id +FROM aws.ec2.ipams +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the ipams resource, the following permissions are required: + +### Create +```json +ec2:CreateIpam, +iam:CreateServiceLinkedRole, +ec2:CreateTags, +ec2:DescribeIpams +``` + +### List +```json +ec2:DescribeIpams +``` + diff --git a/docs/aws-docs/providers/aws/ec2/ipv6_addresses/index.md b/docs/aws-docs/providers/aws/ec2/ipv6_addresses/index.md deleted file mode 100644 index fe2879ae7a..0000000000 --- a/docs/aws-docs/providers/aws/ec2/ipv6_addresses/index.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ipv6_addresses -hide_title: false -hide_table_of_contents: false -keywords: - - ipv6_addresses - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameipv6_addresses
TypeResource
Idaws.ec2.ipv6_addresses
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `ipv6_addresses_Assign` | `EXEC` | `NetworkInterfaceId, region` | <p>Assigns one or more IPv6 addresses to the specified network interface. You can specify one or more specific IPv6 addresses, or you can specify the number of IPv6 addresses to be automatically assigned from within the subnet's IPv6 CIDR block range. You can assign as many IPv6 addresses to a network interface as you can assign private IPv4 addresses, and the limit varies per instance type. For information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html#AvailableIpPerENI">IP Addresses Per Network Interface Per Instance Type</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>You must specify either the IPv6 addresses or the IPv6 address count in the request. </p> <p>You can optionally use Prefix Delegation on the network interface. You must specify either the IPV6 Prefix Delegation prefixes, or the IPv6 Prefix Delegation count. For information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-prefix-eni.html"> Assigning prefixes to Amazon EC2 network interfaces</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | -| `ipv6_addresses_Unassign` | `EXEC` | `NetworkInterfaceId, region` | Unassigns one or more IPv6 addresses IPv4 Prefix Delegation prefixes from a network interface. | diff --git a/docs/aws-docs/providers/aws/ec2/ipv6_pools/index.md b/docs/aws-docs/providers/aws/ec2/ipv6_pools/index.md deleted file mode 100644 index 280d31c5a7..0000000000 --- a/docs/aws-docs/providers/aws/ec2/ipv6_pools/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ipv6_pools -hide_title: false -hide_table_of_contents: false -keywords: - - ipv6_pools - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameipv6_pools
TypeResource
Idaws.ec2.ipv6_pools
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `description` | `string` | The description for the address pool. | -| `poolCidrBlockSet` | `array` | The CIDR blocks for the address pool. | -| `poolId` | `string` | The ID of the address pool. | -| `tagSet` | `array` | Any tags for the address pool. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `ipv6_pools_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2/key_pair/index.md b/docs/aws-docs/providers/aws/ec2/key_pair/index.md new file mode 100644 index 0000000000..99d8dfcd42 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/key_pair/index.md @@ -0,0 +1,91 @@ +--- +title: key_pair +hide_title: false +hide_table_of_contents: false +keywords: + - key_pair + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual key_pair resource + +## Overview + + + + + +
Namekey_pair
TypeResource
DescriptionThe AWS::EC2::KeyPair creates an SSH key pair
Idaws.ec2.key_pair
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
key_namestringThe name of the SSH key pair
key_typestringThe crypto-system used to generate a key pair.
key_formatstringThe format of the private key
public_key_materialstringPlain text public key to import
key_fingerprintstringA short sequence of bytes used for public key verification
key_pair_idstringAn AWS generated ID for the key pair
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +key_name, +key_type, +key_format, +public_key_material, +key_fingerprint, +key_pair_id, +tags +FROM aws.ec2.key_pair +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the key_pair resource, the following permissions are required: + +### Read +```json +ec2:DescribeKeyPairs +``` + +### Delete +```json +ec2:DeleteKeyPair, +ssm:DeleteParameter, +ec2:DescribeKeyPairs +``` + diff --git a/docs/aws-docs/providers/aws/ec2/key_pairs/index.md b/docs/aws-docs/providers/aws/ec2/key_pairs/index.md index a1140d46e7..a2bc575d2c 100644 --- a/docs/aws-docs/providers/aws/ec2/key_pairs/index.md +++ b/docs/aws-docs/providers/aws/ec2/key_pairs/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - key_pairs - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,21 +14,67 @@ description: Query, deploy 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_pairs in a region ## Overview +
Namekey_pairs
TypeResource
DescriptionThe AWS::EC2::KeyPair creates an SSH key pair
Idaws.ec2.key_pairs
## Fields + + + + + +
NameDatatypeDescription
key_namestringThe name of the SSH key pair
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `key_pairs_Describe` | `SELECT` | `region` | <p>Describes the specified key pairs or all of your key pairs.</p> <p>For more information about key pairs, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html">Amazon EC2 key pairs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | -| `key_pair_Create` | `INSERT` | `KeyName, region` | <p>Creates an ED25519 or 2048-bit RSA key pair with the specified name and in the specified PEM or PPK format. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#1 private key or an unencrypted PPK formatted private key for use with PuTTY. If a key with the specified name already exists, Amazon EC2 returns an error.</p> <p>The key pair returned to you is available only in the Amazon Web Services Region in which you create it. If you prefer, you can create your own key pair using a third-party tool and upload it to any Region using <a>ImportKeyPair</a>.</p> <p>You can have up to 5,000 key pairs per Amazon Web Services Region.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html">Amazon EC2 key pairs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | -| `key_pair_Delete` | `DELETE` | `region` | Deletes the specified key pair, by removing the public key from Amazon EC2. | -| `key_pair_Import` | `EXEC` | `KeyName, PublicKeyMaterial, region` | <p>Imports the public key from an RSA or ED25519 key pair that you created with a third-party tool. Compare this with <a>CreateKeyPair</a>, in which Amazon Web Services creates the key pair and gives the keys to you (Amazon Web Services keeps a copy of the public key). With ImportKeyPair, you create the key pair and give Amazon Web Services just the public key. The private key is never transferred between you and Amazon Web Services.</p> <p>For more information about key pairs, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html">Amazon EC2 key pairs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +key_name +FROM aws.ec2.key_pairs +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the key_pairs resource, the following permissions are required: + +### Create +```json +ec2:CreateKeyPair, +ec2:ImportKeyPair, +ec2:CreateTags, +ssm:PutParameter +``` + +### List +```json +ec2:DescribeKeyPairs +``` + diff --git a/docs/aws-docs/providers/aws/ec2/launch_template/index.md b/docs/aws-docs/providers/aws/ec2/launch_template/index.md new file mode 100644 index 0000000000..5772fc3fdb --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/launch_template/index.md @@ -0,0 +1,101 @@ +--- +title: launch_template +hide_title: false +hide_table_of_contents: false +keywords: + - launch_template + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual launch_template resource + +## Overview + + + + + +
Namelaunch_template
TypeResource
DescriptionSpecifies the properties for creating a launch template.<br/> The minimum required properties for specifying a launch template are as follows:<br/> + You must specify at least one property for the launch template data.<br/> + You do not need to specify a name for the launch template. If you do not specify a name, CFN creates the name for you.<br/> <br/> A launch template can contain some or all of the configuration information to launch an instance. When you launch an instance using a launch template, instance properties that are not specified in the launch template use default values, except the ``ImageId`` property, which has no default value. If you do not specify an AMI ID for the launch template ``ImageId`` property, you must specify an AMI ID for the instance ``ImageId`` property.<br/> For more information, see [Launch an instance from a launch template](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html) in the *Amazon EC2 User Guide*.
Idaws.ec2.launch_template
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
launch_template_namestringA name for the launch template.
launch_template_dataobjectThe information for the launch template.
version_descriptionstringA description for the first version of the launch template.
tag_specificationsarrayThe tags to apply to the launch template on creation. To tag the launch template, the resource type must be ``launch-template``.<br/> To specify the tags for the resources that are created when an instance is launched, you must use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-tagspecifications).
latest_version_numberstring
launch_template_idstring
default_version_numberstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +launch_template_name, +launch_template_data, +version_description, +tag_specifications, +latest_version_number, +launch_template_id, +default_version_number +FROM aws.ec2.launch_template +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the launch_template resource, the following permissions are required: + +### Read +```json +ec2:DescribeLaunchTemplates +``` + +### Update +```json +ec2:CreateLaunchTemplateVersion +``` + +### Delete +```json +ec2:DeleteLaunchTemplate, +ec2:DeleteTags, +ec2:DescribeLaunchTemplates +``` + diff --git a/docs/aws-docs/providers/aws/ec2/launch_template_data/index.md b/docs/aws-docs/providers/aws/ec2/launch_template_data/index.md deleted file mode 100644 index 5eebaba214..0000000000 --- a/docs/aws-docs/providers/aws/ec2/launch_template_data/index.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: launch_template_data -hide_title: false -hide_table_of_contents: false -keywords: - - launch_template_data - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namelaunch_template_data
TypeResource
Idaws.ec2.launch_template_data
- -## Fields -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `launch_template_data_Get` | `SELECT` | `InstanceId, region` | diff --git a/docs/aws-docs/providers/aws/ec2/launch_template_versions/index.md b/docs/aws-docs/providers/aws/ec2/launch_template_versions/index.md deleted file mode 100644 index 1a47232d08..0000000000 --- a/docs/aws-docs/providers/aws/ec2/launch_template_versions/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: launch_template_versions -hide_title: false -hide_table_of_contents: false -keywords: - - launch_template_versions - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namelaunch_template_versions
TypeResource
Idaws.ec2.launch_template_versions
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `createTime` | `string` | The time the version was created. | -| `createdBy` | `string` | The principal that created the version. | -| `defaultVersion` | `boolean` | Indicates whether the version is the default version. | -| `launchTemplateData` | `object` | The information for a launch template. | -| `launchTemplateId` | `string` | The ID of the launch template. | -| `launchTemplateName` | `string` | The name of the launch template. | -| `versionDescription` | `string` | The description for the version. | -| `versionNumber` | `integer` | The version number. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `launch_template_versions_Describe` | `SELECT` | `region` | Describes one or more versions of a specified launch template. You can describe all versions, individual versions, or a range of versions. You can also describe all the latest versions or all the default versions of all the launch templates in your account. | -| `launch_template_version_Create` | `INSERT` | `LaunchTemplateData, region` | <p>Creates a new version for a launch template. You can specify an existing version of launch template from which to base the new version.</p> <p>Launch template versions are numbered in the order in which they are created. You cannot specify, change, or replace the numbering of launch template versions.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#manage-launch-template-versions">Managing launch template versions</a>in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | -| `launch_template_versions_Delete` | `DELETE` | `LaunchTemplateVersion, region` | Deletes one or more versions of a launch template. You cannot delete the default version of a launch template; you must first assign a different version as the default. If the default version is the only version for the launch template, you must delete the entire launch template using <a>DeleteLaunchTemplate</a>. | diff --git a/docs/aws-docs/providers/aws/ec2/launch_templates/index.md b/docs/aws-docs/providers/aws/ec2/launch_templates/index.md index 3517faf447..d516ecea28 100644 --- a/docs/aws-docs/providers/aws/ec2/launch_templates/index.md +++ b/docs/aws-docs/providers/aws/ec2/launch_templates/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - launch_templates - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,30 +14,65 @@ description: Query, deploy 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_templates in a region ## Overview +
Namelaunch_templates
TypeResource
DescriptionSpecifies the properties for creating a launch template.<br/> The minimum required properties for specifying a launch template are as follows:<br/> + You must specify at least one property for the launch template data.<br/> + You do not need to specify a name for the launch template. If you do not specify a name, CFN creates the name for you.<br/> <br/> A launch template can contain some or all of the configuration information to launch an instance. When you launch an instance using a launch template, instance properties that are not specified in the launch template use default values, except the ``ImageId`` property, which has no default value. If you do not specify an AMI ID for the launch template ``ImageId`` property, you must specify an AMI ID for the instance ``ImageId`` property.<br/> For more information, see [Launch an instance from a launch template](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html) in the *Amazon EC2 User Guide*.
Idaws.ec2.launch_templates
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `createTime` | `string` | The time launch template was created. | -| `createdBy` | `string` | The principal that created the launch template. | -| `defaultVersionNumber` | `integer` | The version number of the default version of the launch template. | -| `latestVersionNumber` | `integer` | The version number of the latest version of the launch template. | -| `launchTemplateId` | `string` | The ID of the launch template. | -| `launchTemplateName` | `string` | The name of the launch template. | -| `tagSet` | `array` | The tags for the launch template. | + + + + + +
NameDatatypeDescription
launch_template_idstring
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `launch_templates_Describe` | `SELECT` | `region` | Describes one or more launch templates. | -| `launch_template_Create` | `INSERT` | `LaunchTemplateData, LaunchTemplateName, region` | <p>Creates a launch template.</p> <p>A launch template contains the parameters to launch an instance. When you launch an instance using <a>RunInstances</a>, you can specify a launch template instead of providing the launch parameters in the request. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html">Launching an instance from a launch template</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>If you want to clone an existing launch template as the basis for creating a new launch template, you can use the Amazon EC2 console. The API, SDKs, and CLI do not support cloning a template. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#create-launch-template-from-existing-launch-template">Create a launch template from an existing launch template</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | -| `launch_template_Delete` | `DELETE` | `region` | Deletes a launch template. Deleting a launch template deletes all of its versions. | -| `launch_template_Modify` | `EXEC` | `region` | Modifies a launch template. You can specify which version of the launch template to set as the default version. When launching an instance, the default version applies when a launch template version is not specified. | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +launch_template_id +FROM aws.ec2.launch_templates +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the launch_templates resource, the following permissions are required: + +### Create +```json +ec2:CreateLaunchTemplate, +ec2:CreateTags +``` + +### List +```json +ec2:DescribeLaunchTemplates +``` + diff --git a/docs/aws-docs/providers/aws/ec2/local_gateway_route/index.md b/docs/aws-docs/providers/aws/ec2/local_gateway_route/index.md new file mode 100644 index 0000000000..41e09aa8d7 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/local_gateway_route/index.md @@ -0,0 +1,99 @@ +--- +title: local_gateway_route +hide_title: false +hide_table_of_contents: false +keywords: + - local_gateway_route + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual local_gateway_route resource + +## Overview + + + + + +
Namelocal_gateway_route
TypeResource
DescriptionDescribes a route for a local gateway route table.
Idaws.ec2.local_gateway_route
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
destination_cidr_blockstringThe CIDR block used for destination matches.
local_gateway_route_table_idstringThe ID of the local gateway route table.
local_gateway_virtual_interface_group_idstringThe ID of the virtual interface group.
network_interface_idstringThe ID of the network interface.
statestringThe state of the route.
typestringThe route type.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +destination_cidr_block, +local_gateway_route_table_id, +local_gateway_virtual_interface_group_id, +network_interface_id, +state, +type +FROM aws.ec2.local_gateway_route +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the local_gateway_route resource, the following permissions are required: + +### Read +```json +ec2:SearchLocalGatewayRoutes +``` + +### Delete +```json +ec2:DeleteLocalGatewayRoute, +ec2:SearchLocalGatewayRoutes +``` + +### Update +```json +ec2:ModifyLocalGatewayRoute, +ec2:SearchLocalGatewayRoutes +``` + diff --git a/docs/aws-docs/providers/aws/ec2/local_gateway_route_table/index.md b/docs/aws-docs/providers/aws/ec2/local_gateway_route_table/index.md new file mode 100644 index 0000000000..1470329e1c --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/local_gateway_route_table/index.md @@ -0,0 +1,105 @@ +--- +title: local_gateway_route_table +hide_title: false +hide_table_of_contents: false +keywords: + - local_gateway_route_table + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual local_gateway_route_table resource + +## Overview + + + + + +
Namelocal_gateway_route_table
TypeResource
DescriptionDescribes a route table for a local gateway.
Idaws.ec2.local_gateway_route_table
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
local_gateway_route_table_idstringThe ID of the local gateway route table.
local_gateway_route_table_arnstringThe ARN of the local gateway route table.
local_gateway_idstringThe ID of the local gateway.
outpost_arnstringThe ARN of the outpost.
owner_idstringThe owner of the local gateway route table.
statestringThe state of the local gateway route table.
modestringThe mode of the local gateway route table.
tagsarrayThe tags for the local gateway route table.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +local_gateway_route_table_id, +local_gateway_route_table_arn, +local_gateway_id, +outpost_arn, +owner_id, +state, +mode, +tags +FROM aws.ec2.local_gateway_route_table +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the local_gateway_route_table resource, the following permissions are required: + +### Read +```json +ec2:DescribeLocalGatewayRouteTables +``` + +### Update +```json +ec2:DescribeLocalGatewayRouteTables, +ec2:CreateTags, +ec2:DeleteTags +``` + +### Delete +```json +ec2:DeleteLocalGatewayRouteTable, +ec2:DescribeLocalGatewayRouteTables, +ec2:DeleteTags +``` + diff --git a/docs/aws-docs/providers/aws/ec2/local_gateway_route_table_virtual_interface_group_association/index.md b/docs/aws-docs/providers/aws/ec2/local_gateway_route_table_virtual_interface_group_association/index.md new file mode 100644 index 0000000000..e1591e51ce --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/local_gateway_route_table_virtual_interface_group_association/index.md @@ -0,0 +1,105 @@ +--- +title: local_gateway_route_table_virtual_interface_group_association +hide_title: false +hide_table_of_contents: false +keywords: + - local_gateway_route_table_virtual_interface_group_association + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual local_gateway_route_table_virtual_interface_group_association resource + +## Overview + + + + + +
Namelocal_gateway_route_table_virtual_interface_group_association
TypeResource
DescriptionDescribes a local gateway route table virtual interface group association for a local gateway.
Idaws.ec2.local_gateway_route_table_virtual_interface_group_association
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
local_gateway_route_table_virtual_interface_group_association_idstringThe ID of the local gateway route table virtual interface group association.
local_gateway_idstringThe ID of the local gateway.
local_gateway_route_table_idstringThe ID of the local gateway route table.
local_gateway_route_table_arnstringThe ARN of the local gateway route table.
local_gateway_virtual_interface_group_idstringThe ID of the local gateway route table virtual interface group.
owner_idstringThe owner of the local gateway route table virtual interface group association.
statestringThe state of the local gateway route table virtual interface group association.
tagsarrayThe tags for the local gateway route table virtual interface group association.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +local_gateway_route_table_virtual_interface_group_association_id, +local_gateway_id, +local_gateway_route_table_id, +local_gateway_route_table_arn, +local_gateway_virtual_interface_group_id, +owner_id, +state, +tags +FROM aws.ec2.local_gateway_route_table_virtual_interface_group_association +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the local_gateway_route_table_virtual_interface_group_association resource, the following permissions are required: + +### Read +```json +ec2:DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations +``` + +### Update +```json +ec2:DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations, +ec2:CreateTags, +ec2:DeleteTags +``` + +### Delete +```json +ec2:DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation, +ec2:DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations, +ec2:DeleteTags +``` + diff --git a/docs/aws-docs/providers/aws/ec2/local_gateway_route_table_virtual_interface_group_associations/index.md b/docs/aws-docs/providers/aws/ec2/local_gateway_route_table_virtual_interface_group_associations/index.md index e049d11912..785cefb47a 100644 --- a/docs/aws-docs/providers/aws/ec2/local_gateway_route_table_virtual_interface_group_associations/index.md +++ b/docs/aws-docs/providers/aws/ec2/local_gateway_route_table_virtual_interface_group_associations/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - local_gateway_route_table_virtual_interface_group_associations - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,28 +14,66 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- - - +Retrieves a list of local_gateway_route_table_virtual_interface_group_associations in a region ## Overview +
Namelocal_gateway_route_table_virtual_interface_group_associations
TypeResource
DescriptionDescribes a local gateway route table virtual interface group association for a local gateway.
Idaws.ec2.local_gateway_route_table_virtual_interface_group_associations
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `localGatewayId` | `string` | The ID of the local gateway. | -| `localGatewayRouteTableArn` | `string` | The Amazon Resource Name (ARN) of the local gateway route table for the virtual interface group. | -| `localGatewayRouteTableId` | `string` | The ID of the local gateway route table. | -| `localGatewayRouteTableVirtualInterfaceGroupAssociationId` | `string` | The ID of the association. | -| `localGatewayVirtualInterfaceGroupId` | `string` | The ID of the virtual interface group. | -| `ownerId` | `string` | The ID of the Amazon Web Services account that owns the local gateway virtual interface group association. | -| `state` | `string` | The state of the association. | -| `tagSet` | `array` | The tags assigned to the association. | + + + + + +
NameDatatypeDescription
local_gateway_route_table_virtual_interface_group_association_idstringThe ID of the local gateway route table virtual interface group association.
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `local_gateway_route_table_virtual_interface_group_associations_Describe` | `SELECT` | `region` | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +local_gateway_route_table_virtual_interface_group_association_id +FROM aws.ec2.local_gateway_route_table_virtual_interface_group_associations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the local_gateway_route_table_virtual_interface_group_associations resource, the following permissions are required: + +### Create +```json +ec2:CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation, +ec2:DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations, +ec2:CreateTags +``` + +### List +```json +ec2:DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations +``` + diff --git a/docs/aws-docs/providers/aws/ec2/local_gateway_route_table_vpc_associations/index.md b/docs/aws-docs/providers/aws/ec2/local_gateway_route_table_vpc_associations/index.md deleted file mode 100644 index f615663ec5..0000000000 --- a/docs/aws-docs/providers/aws/ec2/local_gateway_route_table_vpc_associations/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: local_gateway_route_table_vpc_associations -hide_title: false -hide_table_of_contents: false -keywords: - - local_gateway_route_table_vpc_associations - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namelocal_gateway_route_table_vpc_associations
TypeResource
Idaws.ec2.local_gateway_route_table_vpc_associations
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `localGatewayId` | `string` | The ID of the local gateway. | -| `localGatewayRouteTableArn` | `string` | The Amazon Resource Name (ARN) of the local gateway route table for the association. | -| `localGatewayRouteTableId` | `string` | The ID of the local gateway route table. | -| `localGatewayRouteTableVpcAssociationId` | `string` | The ID of the association. | -| `ownerId` | `string` | The ID of the Amazon Web Services account that owns the local gateway route table for the association. | -| `state` | `string` | The state of the association. | -| `tagSet` | `array` | The tags assigned to the association. | -| `vpcId` | `string` | The ID of the VPC. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `local_gateway_route_table_vpc_associations_Describe` | `SELECT` | `region` | Describes the specified associations between VPCs and local gateway route tables. | -| `local_gateway_route_table_vpc_association_Create` | `INSERT` | `LocalGatewayRouteTableId, VpcId, region` | Associates the specified VPC with the specified local gateway route table. | -| `local_gateway_route_table_vpc_association_Delete` | `DELETE` | `LocalGatewayRouteTableVpcAssociationId, region` | Deletes the specified association between a VPC and local gateway route table. | diff --git a/docs/aws-docs/providers/aws/ec2/local_gateway_route_tables/index.md b/docs/aws-docs/providers/aws/ec2/local_gateway_route_tables/index.md index fcf415d68d..49d694cb61 100644 --- a/docs/aws-docs/providers/aws/ec2/local_gateway_route_tables/index.md +++ b/docs/aws-docs/providers/aws/ec2/local_gateway_route_tables/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - local_gateway_route_tables - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,27 +14,66 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- - - +Retrieves a list of local_gateway_route_tables in a region ## Overview +
Namelocal_gateway_route_tables
TypeResource
DescriptionDescribes a route table for a local gateway.
Idaws.ec2.local_gateway_route_tables
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `localGatewayId` | `string` | The ID of the local gateway. | -| `localGatewayRouteTableArn` | `string` | The Amazon Resource Name (ARN) of the local gateway route table. | -| `localGatewayRouteTableId` | `string` | The ID of the local gateway route table. | -| `outpostArn` | `string` | The Amazon Resource Name (ARN) of the Outpost. | -| `ownerId` | `string` | The ID of the Amazon Web Services account that owns the local gateway route table. | -| `state` | `string` | The state of the local gateway route table. | -| `tagSet` | `array` | The tags assigned to the local gateway route table. | + + + + + +
NameDatatypeDescription
local_gateway_route_table_idstringThe ID of the local gateway route table.
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `local_gateway_route_tables_Describe` | `SELECT` | `region` | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +local_gateway_route_table_id +FROM aws.ec2.local_gateway_route_tables +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the local_gateway_route_tables resource, the following permissions are required: + +### Create +```json +ec2:CreateLocalGatewayRouteTable, +ec2:DescribeLocalGatewayRouteTables, +ec2:CreateTags +``` + +### List +```json +ec2:DescribeLocalGatewayRouteTables +``` + diff --git a/docs/aws-docs/providers/aws/ec2/local_gateway_route_tablevpc_association/index.md b/docs/aws-docs/providers/aws/ec2/local_gateway_route_tablevpc_association/index.md new file mode 100644 index 0000000000..e39f3861de --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/local_gateway_route_tablevpc_association/index.md @@ -0,0 +1,101 @@ +--- +title: local_gateway_route_tablevpc_association +hide_title: false +hide_table_of_contents: false +keywords: + - local_gateway_route_tablevpc_association + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual local_gateway_route_tablevpc_association resource + +## Overview + + + + + +
Namelocal_gateway_route_tablevpc_association
TypeResource
DescriptionDescribes an association between a local gateway route table and a VPC.
Idaws.ec2.local_gateway_route_tablevpc_association
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
local_gateway_idstringThe ID of the local gateway.
local_gateway_route_table_idstringThe ID of the local gateway route table.
local_gateway_route_table_vpc_association_idstringThe ID of the association.
statestringThe state of the association.
vpc_idstringThe ID of the VPC.
tagsarrayThe tags for the association.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +local_gateway_id, +local_gateway_route_table_id, +local_gateway_route_table_vpc_association_id, +state, +vpc_id, +tags +FROM aws.ec2.local_gateway_route_tablevpc_association +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the local_gateway_route_tablevpc_association resource, the following permissions are required: + +### Read +```json +ec2:DescribeLocalGatewayRouteTableVpcAssociations +``` + +### Update +```json +ec2:DescribeLocalGatewayRouteTableVpcAssociations, +ec2:CreateTags, +ec2:DeleteTags +``` + +### Delete +```json +ec2:DeleteLocalGatewayRouteTableVpcAssociation, +ec2:DescribeLocalGatewayRouteTableVpcAssociations, +ec2:DeleteTags +``` + diff --git a/docs/aws-docs/providers/aws/ec2/local_gateway_route_tablevpc_associations/index.md b/docs/aws-docs/providers/aws/ec2/local_gateway_route_tablevpc_associations/index.md new file mode 100644 index 0000000000..2d6a7c8c95 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/local_gateway_route_tablevpc_associations/index.md @@ -0,0 +1,79 @@ +--- +title: local_gateway_route_tablevpc_associations +hide_title: false +hide_table_of_contents: false +keywords: + - local_gateway_route_tablevpc_associations + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Retrieves a list of local_gateway_route_tablevpc_associations in a region + +## Overview + + + + + +
Namelocal_gateway_route_tablevpc_associations
TypeResource
DescriptionDescribes an association between a local gateway route table and a VPC.
Idaws.ec2.local_gateway_route_tablevpc_associations
+ +## Fields + + + + + +
NameDatatypeDescription
local_gateway_route_table_vpc_association_idstringThe ID of the association.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +local_gateway_route_table_vpc_association_id +FROM aws.ec2.local_gateway_route_tablevpc_associations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the local_gateway_route_tablevpc_associations resource, the following permissions are required: + +### Create +```json +ec2:CreateLocalGatewayRouteTableVpcAssociation, +ec2:DescribeLocalGatewayRouteTableVpcAssociations, +ec2:CreateTags +``` + +### List +```json +ec2:DescribeLocalGatewayRouteTableVpcAssociations +``` + diff --git a/docs/aws-docs/providers/aws/ec2/local_gateway_routes/index.md b/docs/aws-docs/providers/aws/ec2/local_gateway_routes/index.md index afa398db49..cdb18b0d00 100644 --- a/docs/aws-docs/providers/aws/ec2/local_gateway_routes/index.md +++ b/docs/aws-docs/providers/aws/ec2/local_gateway_routes/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - local_gateway_routes - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,21 +14,68 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- - - +Retrieves a list of local_gateway_routes in a region ## Overview +
Namelocal_gateway_routes
TypeResource
DescriptionDescribes a route for a local gateway route table.
Idaws.ec2.local_gateway_routes
## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command + + + + + + +
NameDatatypeDescription
destination_cidr_blockstringThe CIDR block used for destination matches.
local_gateway_route_table_idstringThe ID of the local gateway route table.
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `local_gateway_route_Create` | `INSERT` | `DestinationCidrBlock, LocalGatewayRouteTableId, LocalGatewayVirtualInterfaceGroupId, region` | Creates a static route for the specified local gateway route table. | -| `local_gateway_route_Delete` | `DELETE` | `DestinationCidrBlock, LocalGatewayRouteTableId, region` | Deletes the specified route from the specified local gateway route table. | -| `local_gateway_routes_Search` | `EXEC` | `LocalGatewayRouteTableId, region` | Searches for routes in the specified local gateway route table. | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +destination_cidr_block, +local_gateway_route_table_id +FROM aws.ec2.local_gateway_routes +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the local_gateway_routes resource, the following permissions are required: + +### Create +```json +ec2:CreateLocalGatewayRoute, +ec2:SearchLocalGatewayRoutes +``` + +### List +```json +ec2:DescribeLocalGatewayRouteTables, +ec2:SearchLocalGatewayRoutes +``` + diff --git a/docs/aws-docs/providers/aws/ec2/local_gateway_virtual_interface_groups/index.md b/docs/aws-docs/providers/aws/ec2/local_gateway_virtual_interface_groups/index.md deleted file mode 100644 index d07c05c412..0000000000 --- a/docs/aws-docs/providers/aws/ec2/local_gateway_virtual_interface_groups/index.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: local_gateway_virtual_interface_groups -hide_title: false -hide_table_of_contents: false -keywords: - - local_gateway_virtual_interface_groups - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namelocal_gateway_virtual_interface_groups
TypeResource
Idaws.ec2.local_gateway_virtual_interface_groups
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `localGatewayId` | `string` | The ID of the local gateway. | -| `localGatewayVirtualInterfaceGroupId` | `string` | The ID of the virtual interface group. | -| `localGatewayVirtualInterfaceIdSet` | `array` | The IDs of the virtual interfaces. | -| `ownerId` | `string` | The ID of the Amazon Web Services account that owns the local gateway virtual interface group. | -| `tagSet` | `array` | The tags assigned to the virtual interface group. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `local_gateway_virtual_interface_groups_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2/local_gateway_virtual_interfaces/index.md b/docs/aws-docs/providers/aws/ec2/local_gateway_virtual_interfaces/index.md deleted file mode 100644 index 0d7cac0ba4..0000000000 --- a/docs/aws-docs/providers/aws/ec2/local_gateway_virtual_interfaces/index.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: local_gateway_virtual_interfaces -hide_title: false -hide_table_of_contents: false -keywords: - - local_gateway_virtual_interfaces - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namelocal_gateway_virtual_interfaces
TypeResource
Idaws.ec2.local_gateway_virtual_interfaces
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `localAddress` | `string` | The local address. | -| `localBgpAsn` | `integer` | The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway. | -| `localGatewayId` | `string` | The ID of the local gateway. | -| `localGatewayVirtualInterfaceId` | `string` | The ID of the virtual interface. | -| `ownerId` | `string` | The ID of the Amazon Web Services account that owns the local gateway virtual interface. | -| `peerAddress` | `string` | The peer address. | -| `peerBgpAsn` | `integer` | The peer BGP ASN. | -| `tagSet` | `array` | The tags assigned to the virtual interface. | -| `vlan` | `integer` | The ID of the VLAN. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `local_gateway_virtual_interfaces_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2/local_gateways/index.md b/docs/aws-docs/providers/aws/ec2/local_gateways/index.md deleted file mode 100644 index 6b45c6de8b..0000000000 --- a/docs/aws-docs/providers/aws/ec2/local_gateways/index.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: local_gateways -hide_title: false -hide_table_of_contents: false -keywords: - - local_gateways - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namelocal_gateways
TypeResource
Idaws.ec2.local_gateways
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `localGatewayId` | `string` | The ID of the local gateway. | -| `outpostArn` | `string` | The Amazon Resource Name (ARN) of the Outpost. | -| `ownerId` | `string` | The ID of the Amazon Web Services account that owns the local gateway. | -| `state` | `string` | The state of the local gateway. | -| `tagSet` | `array` | The tags assigned to the local gateway. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `local_gateways_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2/managed_prefix_list_associations/index.md b/docs/aws-docs/providers/aws/ec2/managed_prefix_list_associations/index.md deleted file mode 100644 index 45074f06de..0000000000 --- a/docs/aws-docs/providers/aws/ec2/managed_prefix_list_associations/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: managed_prefix_list_associations -hide_title: false -hide_table_of_contents: false -keywords: - - managed_prefix_list_associations - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namemanaged_prefix_list_associations
TypeResource
Idaws.ec2.managed_prefix_list_associations
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `resourceId` | `string` | The ID of the resource. | -| `resourceOwner` | `string` | The owner of the resource. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `managed_prefix_list_associations_Get` | `SELECT` | `PrefixListId, region` | diff --git a/docs/aws-docs/providers/aws/ec2/managed_prefix_list_entries/index.md b/docs/aws-docs/providers/aws/ec2/managed_prefix_list_entries/index.md deleted file mode 100644 index ea6a3c6b49..0000000000 --- a/docs/aws-docs/providers/aws/ec2/managed_prefix_list_entries/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: managed_prefix_list_entries -hide_title: false -hide_table_of_contents: false -keywords: - - managed_prefix_list_entries - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namemanaged_prefix_list_entries
TypeResource
Idaws.ec2.managed_prefix_list_entries
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `description` | `string` | The description. | -| `cidr` | `string` | The CIDR block. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `managed_prefix_list_entries_Get` | `SELECT` | `PrefixListId, region` | diff --git a/docs/aws-docs/providers/aws/ec2/managed_prefix_list_version/index.md b/docs/aws-docs/providers/aws/ec2/managed_prefix_list_version/index.md deleted file mode 100644 index 3e35cbcdca..0000000000 --- a/docs/aws-docs/providers/aws/ec2/managed_prefix_list_version/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: managed_prefix_list_version -hide_title: false -hide_table_of_contents: false -keywords: - - managed_prefix_list_version - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namemanaged_prefix_list_version
TypeResource
Idaws.ec2.managed_prefix_list_version
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `managed_prefix_list_version_Restore` | `EXEC` | `CurrentVersion, PrefixListId, PreviousVersion, region` | diff --git a/docs/aws-docs/providers/aws/ec2/managed_prefix_lists/index.md b/docs/aws-docs/providers/aws/ec2/managed_prefix_lists/index.md deleted file mode 100644 index 449623a7b6..0000000000 --- a/docs/aws-docs/providers/aws/ec2/managed_prefix_lists/index.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: managed_prefix_lists -hide_title: false -hide_table_of_contents: false -keywords: - - managed_prefix_lists - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namemanaged_prefix_lists
TypeResource
Idaws.ec2.managed_prefix_lists
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `addressFamily` | `string` | The IP address version. | -| `maxEntries` | `integer` | The maximum number of entries for the prefix list. | -| `ownerId` | `string` | The ID of the owner of the prefix list. | -| `prefixListArn` | `string` | The Amazon Resource Name (ARN) for the prefix list. | -| `prefixListId` | `string` | The ID of the prefix list. | -| `prefixListName` | `string` | The name of the prefix list. | -| `state` | `string` | The current state of the prefix list. | -| `stateMessage` | `string` | The state message. | -| `tagSet` | `array` | The tags for the prefix list. | -| `version` | `integer` | The version of the prefix list. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `managed_prefix_lists_Describe` | `SELECT` | `region` | <p>Describes your managed prefix lists and any Amazon Web Services-managed prefix lists.</p> <p>To view the entries for your prefix list, use <a>GetManagedPrefixListEntries</a>.</p> | -| `managed_prefix_list_Create` | `INSERT` | `AddressFamily, MaxEntries, PrefixListName, region` | Creates a managed prefix list. You can specify one or more entries for the prefix list. Each entry consists of a CIDR block and an optional description. | -| `managed_prefix_list_Delete` | `DELETE` | `PrefixListId, region` | Deletes the specified managed prefix list. You must first remove all references to the prefix list in your resources. | -| `managed_prefix_list_Modify` | `EXEC` | `PrefixListId, region` | <p>Modifies the specified managed prefix list.</p> <p>Adding or removing entries in a prefix list creates a new version of the prefix list. Changing the name of the prefix list does not affect the version.</p> <p>If you specify a current version number that does not match the true current version number, the request fails.</p> | diff --git a/docs/aws-docs/providers/aws/ec2/moving_addresses/index.md b/docs/aws-docs/providers/aws/ec2/moving_addresses/index.md deleted file mode 100644 index 04692ad648..0000000000 --- a/docs/aws-docs/providers/aws/ec2/moving_addresses/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: moving_addresses -hide_title: false -hide_table_of_contents: false -keywords: - - moving_addresses - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namemoving_addresses
TypeResource
Idaws.ec2.moving_addresses
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `moveStatus` | `string` | The status of the Elastic IP address that's being moved to the EC2-VPC platform, or restored to the EC2-Classic platform. | -| `publicIp` | `string` | The Elastic IP address. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `moving_addresses_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2/nat_gateway/index.md b/docs/aws-docs/providers/aws/ec2/nat_gateway/index.md new file mode 100644 index 0000000000..ce7f514e31 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/nat_gateway/index.md @@ -0,0 +1,112 @@ +--- +title: nat_gateway +hide_title: false +hide_table_of_contents: false +keywords: + - nat_gateway + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual nat_gateway resource + +## Overview + + + + + +
Namenat_gateway
TypeResource
DescriptionSpecifies a network address translation (NAT) gateway in the specified subnet. You can create either a public NAT gateway or a private NAT gateway. The default is a public NAT gateway. If you create a public NAT gateway, you must specify an elastic IP address.<br/> With a NAT gateway, instances in a private subnet can connect to the internet, other AWS services, or an on-premises network using the IP address of the NAT gateway. For more information, see [NAT gateways](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html) in the *Amazon VPC User Guide*.<br/> If you add a default route (``AWS::EC2::Route`` resource) that points to a NAT gateway, specify the NAT gateway ID for the route's ``NatGatewayId`` property.<br/> When you associate an Elastic IP address or secondary Elastic IP address with a public NAT gateway, the network border group of the Elastic IP address must match the network border group of the Availability Zone (AZ) that the public NAT gateway is in. Otherwise, the NAT gateway fails to launch. You can see the network border group for the AZ by viewing the details of the subnet. Similarly, you can view the network border group for the Elastic IP address by viewing its details. For more information, see [Allocate an Elastic IP address](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#allocate-eip) in the *Amazon VPC User Guide*.
Idaws.ec2.nat_gateway
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
secondary_allocation_idsarraySecondary EIP allocation IDs. For more information, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon VPC User Guide*.
private_ip_addressstringThe private IPv4 address to assign to the NAT gateway. If you don't provide an address, a private IPv4 address will be automatically assigned.
connectivity_typestringIndicates whether the NAT gateway supports public or private connectivity. The default is public connectivity.
secondary_private_ip_addressesarraySecondary private IPv4 addresses. For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon Virtual Private Cloud User Guide*.<br/> ``SecondaryPrivateIpAddressCount`` and ``SecondaryPrivateIpAddresses`` cannot be set at the same time.
secondary_private_ip_address_countinteger[Private NAT gateway only] The number of secondary private IPv4 addresses you want to assign to the NAT gateway. For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon Virtual Private Cloud User Guide*.<br/> ``SecondaryPrivateIpAddressCount`` and ``SecondaryPrivateIpAddresses`` cannot be set at the same time.
allocation_idstring[Public NAT gateway only] The allocation ID of the Elastic IP address that's associated with the NAT gateway. This property is required for a public NAT gateway and cannot be specified with a private NAT gateway.
subnet_idstringThe ID of the subnet in which the NAT gateway is located.
nat_gateway_idstring
tagsarrayThe tags for the NAT gateway.
max_drain_duration_secondsintegerThe maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress. Default value is 350 seconds.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +secondary_allocation_ids, +private_ip_address, +connectivity_type, +secondary_private_ip_addresses, +secondary_private_ip_address_count, +allocation_id, +subnet_id, +nat_gateway_id, +tags, +max_drain_duration_seconds +FROM aws.ec2.nat_gateway +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the nat_gateway resource, the following permissions are required: + +### Read +```json +ec2:DescribeNatGateways +``` + +### Update +```json +ec2:DescribeNatGateways, +ec2:CreateTags, +ec2:DeleteTags, +ec2:AssociateNatGatewayAddress, +ec2:DisassociateNatGatewayAddress, +ec2:AssignPrivateNatGatewayAddress, +ec2:UnassignPrivateNatGatewayAddress +``` + +### Delete +```json +ec2:DeleteNatGateway, +ec2:DescribeNatGateways +``` + diff --git a/docs/aws-docs/providers/aws/ec2/nat_gateways/index.md b/docs/aws-docs/providers/aws/ec2/nat_gateways/index.md index c6b782fdae..db0c5b90ac 100644 --- a/docs/aws-docs/providers/aws/ec2/nat_gateways/index.md +++ b/docs/aws-docs/providers/aws/ec2/nat_gateways/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - nat_gateways - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,34 +14,66 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- - - +Retrieves a list of nat_gateways in a region ## Overview +
Namenat_gateways
TypeResource
DescriptionSpecifies a network address translation (NAT) gateway in the specified subnet. You can create either a public NAT gateway or a private NAT gateway. The default is a public NAT gateway. If you create a public NAT gateway, you must specify an elastic IP address.<br/> With a NAT gateway, instances in a private subnet can connect to the internet, other AWS services, or an on-premises network using the IP address of the NAT gateway. For more information, see [NAT gateways](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html) in the *Amazon VPC User Guide*.<br/> If you add a default route (``AWS::EC2::Route`` resource) that points to a NAT gateway, specify the NAT gateway ID for the route's ``NatGatewayId`` property.<br/> When you associate an Elastic IP address or secondary Elastic IP address with a public NAT gateway, the network border group of the Elastic IP address must match the network border group of the Availability Zone (AZ) that the public NAT gateway is in. Otherwise, the NAT gateway fails to launch. You can see the network border group for the AZ by viewing the details of the subnet. Similarly, you can view the network border group for the Elastic IP address by viewing its details. For more information, see [Allocate an Elastic IP address](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#allocate-eip) in the *Amazon VPC User Guide*.
Idaws.ec2.nat_gateways
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `connectivityType` | `string` | Indicates whether the NAT gateway supports public or private connectivity. | -| `createTime` | `string` | The date and time the NAT gateway was created. | -| `deleteTime` | `string` | The date and time the NAT gateway was deleted, if applicable. | -| `failureCode` | `string` | If the NAT gateway could not be created, specifies the error code for the failure. (<code>InsufficientFreeAddressesInSubnet</code> \| <code>Gateway.NotAttached</code> \| <code>InvalidAllocationID.NotFound</code> \| <code>Resource.AlreadyAssociated</code> \| <code>InternalError</code> \| <code>InvalidSubnetID.NotFound</code>) | -| `failureMessage` | `string` | <p>If the NAT gateway could not be created, specifies the error message for the failure, that corresponds to the error code.</p> <ul> <li> <p>For InsufficientFreeAddressesInSubnet: "Subnet has insufficient free addresses to create this NAT gateway"</p> </li> <li> <p>For Gateway.NotAttached: "Network vpc-xxxxxxxx has no Internet gateway attached"</p> </li> <li> <p>For InvalidAllocationID.NotFound: "Elastic IP address eipalloc-xxxxxxxx could not be associated with this NAT gateway"</p> </li> <li> <p>For Resource.AlreadyAssociated: "Elastic IP address eipalloc-xxxxxxxx is already associated"</p> </li> <li> <p>For InternalError: "Network interface eni-xxxxxxxx, created and used internally by this NAT gateway is in an invalid state. Please try again."</p> </li> <li> <p>For InvalidSubnetID.NotFound: "The specified subnet subnet-xxxxxxxx does not exist or could not be found."</p> </li> </ul> | -| `natGatewayAddressSet` | `array` | Information about the IP addresses and network interface associated with the NAT gateway. | -| `natGatewayId` | `string` | The ID of the NAT gateway. | -| `provisionedBandwidth` | `object` | Reserved. If you need to sustain traffic greater than the <a href="https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html">documented limits</a>, contact us through the <a href="https://console.aws.amazon.com/support/home?">Support Center</a>. | -| `state` | `string` | <p>The state of the NAT gateway.</p> <ul> <li> <p> <code>pending</code>: The NAT gateway is being created and is not ready to process traffic.</p> </li> <li> <p> <code>failed</code>: The NAT gateway could not be created. Check the <code>failureCode</code> and <code>failureMessage</code> fields for the reason.</p> </li> <li> <p> <code>available</code>: The NAT gateway is able to process traffic. This status remains until you delete the NAT gateway, and does not indicate the health of the NAT gateway.</p> </li> <li> <p> <code>deleting</code>: The NAT gateway is in the process of being terminated and may still be processing traffic.</p> </li> <li> <p> <code>deleted</code>: The NAT gateway has been terminated and is no longer processing traffic.</p> </li> </ul> | -| `subnetId` | `string` | The ID of the subnet in which the NAT gateway is located. | -| `tagSet` | `array` | The tags for the NAT gateway. | -| `vpcId` | `string` | The ID of the VPC in which the NAT gateway is located. | + + + + + +
NameDatatypeDescription
nat_gateway_idstring
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `nat_gateways_Describe` | `SELECT` | `region` | Describes one or more of your NAT gateways. | -| `nat_gateway_Create` | `INSERT` | `SubnetId, region` | <p>Creates a NAT gateway in the specified subnet. This action creates a network interface in the specified subnet with a private IP address from the IP address range of the subnet. You can create either a public NAT gateway or a private NAT gateway.</p> <p>With a public NAT gateway, internet-bound traffic from a private subnet can be routed to the NAT gateway, so that instances in a private subnet can connect to the internet.</p> <p>With a private NAT gateway, private communication is routed across VPCs and on-premises networks through a transit gateway or virtual private gateway. Common use cases include running large workloads behind a small pool of allowlisted IPv4 addresses, preserving private IPv4 addresses, and communicating between overlapping networks.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html">NAT gateways</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p> | -| `nat_gateway_Delete` | `DELETE` | `NatGatewayId, region` | Deletes the specified NAT gateway. Deleting a public NAT gateway disassociates its Elastic IP address, but does not release the address from your account. Deleting a NAT gateway does not delete any NAT gateway routes in your route tables. | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +nat_gateway_id +FROM aws.ec2.nat_gateways +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the nat_gateways resource, the following permissions are required: + +### Create +```json +ec2:CreateNatGateway, +ec2:DescribeNatGateways, +ec2:CreateTags +``` + +### List +```json +ec2:DescribeNatGateways +``` + diff --git a/docs/aws-docs/providers/aws/ec2/network_acl/index.md b/docs/aws-docs/providers/aws/ec2/network_acl/index.md new file mode 100644 index 0000000000..fb60df7c57 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/network_acl/index.md @@ -0,0 +1,96 @@ +--- +title: network_acl +hide_title: false +hide_table_of_contents: false +keywords: + - network_acl + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual network_acl resource + +## Overview + + + + + +
Namenetwork_acl
TypeResource
DescriptionSpecifies a network ACL for your VPC.
Idaws.ec2.network_acl
+ +## Fields + + + + + + + +
NameDatatypeDescription
idstring
tagsarrayThe tags for the network ACL.
vpc_idstringThe ID of the VPC for the network ACL.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +tags, +vpc_id +FROM aws.ec2.network_acl +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the network_acl resource, the following permissions are required: + +### Read +```json +ec2:DescribeNetworkAcls, +ec2:DescribeTags +``` + +### Update +```json +ec2:DescribeNetworkAcls, +ec2:DeleteTags, +ec2:CreateTags +``` + +### Delete +```json +ec2:DeleteTags, +ec2:DeleteNetworkAcl, +ec2:DescribeNetworkAcls +``` + diff --git a/docs/aws-docs/providers/aws/ec2/network_acl_association/index.md b/docs/aws-docs/providers/aws/ec2/network_acl_association/index.md deleted file mode 100644 index d4996e0519..0000000000 --- a/docs/aws-docs/providers/aws/ec2/network_acl_association/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: network_acl_association -hide_title: false -hide_table_of_contents: false -keywords: - - network_acl_association - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namenetwork_acl_association
TypeResource
Idaws.ec2.network_acl_association
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `network_acl_association_Replace` | `EXEC` | `AssociationId, NetworkAclId, region` | diff --git a/docs/aws-docs/providers/aws/ec2/network_acl_entry/index.md b/docs/aws-docs/providers/aws/ec2/network_acl_entry/index.md deleted file mode 100644 index 966b2241fe..0000000000 --- a/docs/aws-docs/providers/aws/ec2/network_acl_entry/index.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: network_acl_entry -hide_title: false -hide_table_of_contents: false -keywords: - - network_acl_entry - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namenetwork_acl_entry
TypeResource
Idaws.ec2.network_acl_entry
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `network_acl_entry_Create` | `INSERT` | `Egress, NetworkAclId, Protocol, RuleAction, RuleNumber, region` | <p>Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of ingress rules and a separate set of egress rules.</p> <p>We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules.</p> <p>After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one.</p> <p>For more information about network ACLs, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_ACLs.html">Network ACLs</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p> | -| `network_acl_entry_Delete` | `DELETE` | `Egress, NetworkAclId, RuleNumber, region` | Deletes the specified ingress or egress entry (rule) from the specified network ACL. | -| `network_acl_entry_Replace` | `EXEC` | `Egress, NetworkAclId, Protocol, RuleAction, RuleNumber, region` | Replaces an entry (rule) in a network ACL. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_ACLs.html">Network ACLs</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. | diff --git a/docs/aws-docs/providers/aws/ec2/network_acls/index.md b/docs/aws-docs/providers/aws/ec2/network_acls/index.md index e11b21ccae..d4b49830f8 100644 --- a/docs/aws-docs/providers/aws/ec2/network_acls/index.md +++ b/docs/aws-docs/providers/aws/ec2/network_acls/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - network_acls - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,29 +14,66 @@ description: Query, deploy 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_acls in a region ## Overview +
Namenetwork_acls
TypeResource
DescriptionSpecifies a network ACL for your VPC.
Idaws.ec2.network_acls
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `associationSet` | `array` | Any associations between the network ACL and one or more subnets | -| `default` | `boolean` | Indicates whether this is the default network ACL for the VPC. | -| `entrySet` | `array` | One or more entries (rules) in the network ACL. | -| `networkAclId` | `string` | The ID of the network ACL. | -| `ownerId` | `string` | The ID of the Amazon Web Services account that owns the network ACL. | -| `tagSet` | `array` | Any tags assigned to the network ACL. | -| `vpcId` | `string` | The ID of the VPC for the network ACL. | + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `network_acls_Describe` | `SELECT` | `region` | <p>Describes one or more of your network ACLs.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_ACLs.html">Network ACLs</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p> | -| `network_acl_Create` | `INSERT` | `VpcId, region` | <p>Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_ACLs.html">Network ACLs</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p> | -| `network_acl_Delete` | `DELETE` | `NetworkAclId, region` | Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. You can't delete the default network ACL. | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.ec2.network_acls +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the network_acls resource, the following permissions are required: + +### Create +```json +ec2:CreateNetworkAcl, +ec2:DescribeNetworkAcls, +ec2:CreateTags +``` + +### List +```json +ec2:DescribeNetworkAcls +``` + diff --git a/docs/aws-docs/providers/aws/ec2/network_insights_access_scope/index.md b/docs/aws-docs/providers/aws/ec2/network_insights_access_scope/index.md new file mode 100644 index 0000000000..7d161d4bae --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/network_insights_access_scope/index.md @@ -0,0 +1,104 @@ +--- +title: network_insights_access_scope +hide_title: false +hide_table_of_contents: false +keywords: + - network_insights_access_scope + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual network_insights_access_scope resource + +## Overview + + + + + +
Namenetwork_insights_access_scope
TypeResource
DescriptionResource schema for AWS::EC2::NetworkInsightsAccessScope
Idaws.ec2.network_insights_access_scope
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
network_insights_access_scope_idstring
network_insights_access_scope_arnstring
created_datestring
updated_datestring
tagsarray
match_pathsarray
exclude_pathsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +network_insights_access_scope_id, +network_insights_access_scope_arn, +created_date, +updated_date, +tags, +match_paths, +exclude_paths +FROM aws.ec2.network_insights_access_scope +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the network_insights_access_scope resource, the following permissions are required: + +### Read +```json +ec2:DescribeNetworkInsightsAccessScopes, +ec2:GetNetworkInsightsAccessScopeContent +``` + +### Update +```json +ec2:DescribeNetworkInsightsAccessScopes, +ec2:GetNetworkInsightsAccessScopeContent, +ec2:CreateTags, +ec2:DeleteTags +``` + +### Delete +```json +ec2:DeleteNetworkInsightsAccessScope, +ec2:DeleteTags +``` + diff --git a/docs/aws-docs/providers/aws/ec2/network_insights_access_scope_analyses/index.md b/docs/aws-docs/providers/aws/ec2/network_insights_access_scope_analyses/index.md index 2fda2dd435..9244cd01e4 100644 --- a/docs/aws-docs/providers/aws/ec2/network_insights_access_scope_analyses/index.md +++ b/docs/aws-docs/providers/aws/ec2/network_insights_access_scope_analyses/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - network_insights_access_scope_analyses - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,31 +14,72 @@ description: Query, deploy 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_insights_access_scope_analyses in a region ## Overview +
Namenetwork_insights_access_scope_analyses
TypeResource
DescriptionResource schema for AWS::EC2::NetworkInsightsAccessScopeAnalysis
Idaws.ec2.network_insights_access_scope_analyses
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `analyzedEniCount` | `integer` | The number of network interfaces analyzed. | -| `endDate` | `string` | The analysis end date. | -| `findingsFound` | `string` | Indicates whether there are findings. | -| `networkInsightsAccessScopeAnalysisArn` | `string` | The Amazon Resource Name (ARN) of the Network Access Scope analysis. | -| `networkInsightsAccessScopeAnalysisId` | `string` | The ID of the Network Access Scope analysis. | -| `networkInsightsAccessScopeId` | `string` | The ID of the Network Access Scope. | -| `startDate` | `string` | The analysis start date. | -| `status` | `string` | The status. | -| `statusMessage` | `string` | The status message. | -| `tagSet` | `array` | The tags. | -| `warningMessage` | `string` | The warning message. | + + + + + +
NameDatatypeDescription
network_insights_access_scope_analysis_idstring
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `network_insights_access_scope_analyses_Describe` | `SELECT` | `region` | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +network_insights_access_scope_analysis_id +FROM aws.ec2.network_insights_access_scope_analyses +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the network_insights_access_scope_analyses resource, the following permissions are required: + +### Create +```json +ec2:CreateTags, +ec2:StartNetworkInsightsAccessScopeAnalysis, +ec2:GetTransitGatewayRouteTablePropagations, +ec2:Describe*, +elasticloadbalancing:Describe*, +directconnect:Describe*, +tiros:CreateQuery, +tiros:GetQueryAnswer, +tiros:GetQueryExplanation +``` + +### List +```json +ec2:DescribeNetworkInsightsAccessScopeAnalyses +``` + diff --git a/docs/aws-docs/providers/aws/ec2/network_insights_access_scope_analysis/index.md b/docs/aws-docs/providers/aws/ec2/network_insights_access_scope_analysis/index.md index 0b91e9ea99..75cdd573a7 100644 --- a/docs/aws-docs/providers/aws/ec2/network_insights_access_scope_analysis/index.md +++ b/docs/aws-docs/providers/aws/ec2/network_insights_access_scope_analysis/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - network_insights_access_scope_analysis - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,20 +14,95 @@ description: Query, 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_insights_access_scope_analysis resource ## Overview +
Namenetwork_insights_access_scope_analysis
TypeResource
DescriptionResource schema for AWS::EC2::NetworkInsightsAccessScopeAnalysis
Idaws.ec2.network_insights_access_scope_analysis
## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command + + + + + + + + + + + + + + +
NameDatatypeDescription
network_insights_access_scope_analysis_idstring
network_insights_access_scope_analysis_arnstring
network_insights_access_scope_idstring
statusstring
status_messagestring
start_datestring
end_datestring
findings_foundstring
analyzed_eni_countinteger
tagsarray
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `network_insights_access_scope_analysis_Delete` | `DELETE` | `NetworkInsightsAccessScopeAnalysisId, region` | Deletes the specified Network Access Scope analysis. | -| `network_insights_access_scope_analysis_Start` | `EXEC` | `ClientToken, NetworkInsightsAccessScopeId, region` | Starts analyzing the specified Network Access Scope. | + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +network_insights_access_scope_analysis_id, +network_insights_access_scope_analysis_arn, +network_insights_access_scope_id, +status, +status_message, +start_date, +end_date, +findings_found, +analyzed_eni_count, +tags +FROM aws.ec2.network_insights_access_scope_analysis +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the network_insights_access_scope_analysis resource, the following permissions are required: + +### Read +```json +ec2:DescribeNetworkInsightsAccessScopeAnalyses +``` + +### Update +```json +ec2:DescribeNetworkInsightsAccessScopeAnalyses, +ec2:CreateTags, +ec2:DeleteTags +``` + +### Delete +```json +ec2:DeleteNetworkInsightsAccessScopeAnalysis, +ec2:DeleteTags +``` + diff --git a/docs/aws-docs/providers/aws/ec2/network_insights_access_scope_analysis_findings/index.md b/docs/aws-docs/providers/aws/ec2/network_insights_access_scope_analysis_findings/index.md deleted file mode 100644 index e6b99e7803..0000000000 --- a/docs/aws-docs/providers/aws/ec2/network_insights_access_scope_analysis_findings/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: network_insights_access_scope_analysis_findings -hide_title: false -hide_table_of_contents: false -keywords: - - network_insights_access_scope_analysis_findings - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namenetwork_insights_access_scope_analysis_findings
TypeResource
Idaws.ec2.network_insights_access_scope_analysis_findings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `findingComponentSet` | `array` | The finding components. | -| `findingId` | `string` | The ID of the finding. | -| `networkInsightsAccessScopeAnalysisId` | `string` | The ID of the Network Access Scope analysis. | -| `networkInsightsAccessScopeId` | `string` | The ID of the Network Access Scope. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `network_insights_access_scope_analysis_findings_Get` | `SELECT` | `NetworkInsightsAccessScopeAnalysisId, region` | diff --git a/docs/aws-docs/providers/aws/ec2/network_insights_access_scope_content/index.md b/docs/aws-docs/providers/aws/ec2/network_insights_access_scope_content/index.md deleted file mode 100644 index e2d4a4002e..0000000000 --- a/docs/aws-docs/providers/aws/ec2/network_insights_access_scope_content/index.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: network_insights_access_scope_content -hide_title: false -hide_table_of_contents: false -keywords: - - network_insights_access_scope_content - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namenetwork_insights_access_scope_content
TypeResource
Idaws.ec2.network_insights_access_scope_content
- -## Fields -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `network_insights_access_scope_content_Get` | `SELECT` | `NetworkInsightsAccessScopeId, region` | diff --git a/docs/aws-docs/providers/aws/ec2/network_insights_access_scopes/index.md b/docs/aws-docs/providers/aws/ec2/network_insights_access_scopes/index.md index e40b3fe4b9..08d4f99d4d 100644 --- a/docs/aws-docs/providers/aws/ec2/network_insights_access_scopes/index.md +++ b/docs/aws-docs/providers/aws/ec2/network_insights_access_scopes/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - network_insights_access_scopes - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,27 +14,66 @@ description: Query, deploy 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_insights_access_scopes in a region ## Overview +
Namenetwork_insights_access_scopes
TypeResource
DescriptionResource schema for AWS::EC2::NetworkInsightsAccessScope
Idaws.ec2.network_insights_access_scopes
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `createdDate` | `string` | The creation date. | -| `networkInsightsAccessScopeArn` | `string` | The Amazon Resource Name (ARN) of the Network Access Scope. | -| `networkInsightsAccessScopeId` | `string` | The ID of the Network Access Scope. | -| `tagSet` | `array` | The tags. | -| `updatedDate` | `string` | The last updated date. | + + + + + +
NameDatatypeDescription
network_insights_access_scope_idstring
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `network_insights_access_scopes_Describe` | `SELECT` | `region` | Describes the specified Network Access Scopes. | -| `network_insights_access_scope_Create` | `INSERT` | `ClientToken, region` | <p>Creates a Network Access Scope.</p> <p>Amazon Web Services Network Access Analyzer enables cloud networking and cloud operations teams to verify that their networks on Amazon Web Services conform to their network security and governance objectives. For more information, see the <a href="https://docs.aws.amazon.com/vpc/latest/network-access-analyzer/">Amazon Web Services Network Access Analyzer Guide</a>.</p> | -| `network_insights_access_scope_Delete` | `DELETE` | `NetworkInsightsAccessScopeId, region` | Deletes the specified Network Access Scope. | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +network_insights_access_scope_id +FROM aws.ec2.network_insights_access_scopes +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the network_insights_access_scopes resource, the following permissions are required: + +### Create +```json +ec2:CreateNetworkInsightsAccessScope, +ec2:CreateTags, +tiros:CreateQuery +``` + +### List +```json +ec2:DescribeNetworkInsightsAccessScopes +``` + diff --git a/docs/aws-docs/providers/aws/ec2/network_insights_analyses/index.md b/docs/aws-docs/providers/aws/ec2/network_insights_analyses/index.md index dce1f6b385..3f3c62139b 100644 --- a/docs/aws-docs/providers/aws/ec2/network_insights_analyses/index.md +++ b/docs/aws-docs/providers/aws/ec2/network_insights_analyses/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - network_insights_analyses - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,34 +14,74 @@ description: Query, deploy 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_insights_analyses in a region ## Overview +
Namenetwork_insights_analyses
TypeResource
DescriptionResource schema for AWS::EC2::NetworkInsightsAnalysis
Idaws.ec2.network_insights_analyses
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `alternatePathHintSet` | `array` | Potential intermediate components. | -| `explanationSet` | `array` | The explanations. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/reachability/explanation-codes.html">Reachability Analyzer explanation codes</a>. | -| `filterInArnSet` | `array` | The Amazon Resource Names (ARN) of the Amazon Web Services resources that the path must traverse. | -| `forwardPathComponentSet` | `array` | The components in the path from source to destination. | -| `networkInsightsAnalysisArn` | `string` | The Amazon Resource Name (ARN) of the network insights analysis. | -| `networkInsightsAnalysisId` | `string` | The ID of the network insights analysis. | -| `networkInsightsPathId` | `string` | The ID of the path. | -| `networkPathFound` | `boolean` | Indicates whether the destination is reachable from the source. | -| `returnPathComponentSet` | `array` | The components in the path from destination to source. | -| `startDate` | `string` | The time the analysis started. | -| `status` | `string` | The status of the network insights analysis. | -| `statusMessage` | `string` | The status message, if the status is <code>failed</code>. | -| `tagSet` | `array` | The tags. | -| `warningMessage` | `string` | The warning message. | + + + + + +
NameDatatypeDescription
network_insights_analysis_idstring
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `network_insights_analyses_Describe` | `SELECT` | `region` | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +network_insights_analysis_id +FROM aws.ec2.network_insights_analyses +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the network_insights_analyses resource, the following permissions are required: + +### Create +```json +ec2:CreateTags, +ec2:StartNetworkInsightsAnalysis, +ec2:GetTransitGatewayRouteTablePropagations, +ec2:SearchTransitGatewayRoutes, +ec2:Describe*, +ec2:GetManagedPrefixListEntries, +elasticloadbalancing:Describe*, +directconnect:Describe*, +tiros:CreateQuery, +tiros:GetQueryAnswer, +tiros:GetQueryExplanation +``` + +### List +```json +ec2:Describe* +``` + diff --git a/docs/aws-docs/providers/aws/ec2/network_insights_analysis/index.md b/docs/aws-docs/providers/aws/ec2/network_insights_analysis/index.md index 660ca3093f..ab50d820bd 100644 --- a/docs/aws-docs/providers/aws/ec2/network_insights_analysis/index.md +++ b/docs/aws-docs/providers/aws/ec2/network_insights_analysis/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - network_insights_analysis - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,20 +14,105 @@ description: Query, 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_insights_analysis resource ## Overview +
Namenetwork_insights_analysis
TypeResource
DescriptionResource schema for AWS::EC2::NetworkInsightsAnalysis
Idaws.ec2.network_insights_analysis
## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
statusstring
return_path_componentsarray
network_insights_analysis_idstring
network_insights_path_idstring
network_path_foundboolean
suggested_accountsarray
filter_in_arnsarray
network_insights_analysis_arnstring
status_messagestring
start_datestring
alternate_path_hintsarray
explanationsarray
forward_path_componentsarray
additional_accountsarray
tagsarray
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `network_insights_analysis_Delete` | `DELETE` | `NetworkInsightsAnalysisId, region` | Deletes the specified network insights analysis. | -| `network_insights_analysis_Start` | `EXEC` | `ClientToken, NetworkInsightsPathId, region` | Starts analyzing the specified path. If the path is reachable, the operation returns the shortest feasible path. | + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +status, +return_path_components, +network_insights_analysis_id, +network_insights_path_id, +network_path_found, +suggested_accounts, +filter_in_arns, +network_insights_analysis_arn, +status_message, +start_date, +alternate_path_hints, +explanations, +forward_path_components, +additional_accounts, +tags +FROM aws.ec2.network_insights_analysis +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the network_insights_analysis resource, the following permissions are required: + +### Read +```json +ec2:Describe* +``` + +### Update +```json +ec2:CreateTags, +ec2:Describe*, +ec2:DeleteTags +``` + +### Delete +```json +ec2:DeleteNetworkInsightsAnalysis, +ec2:DeleteTags +``` + diff --git a/docs/aws-docs/providers/aws/ec2/network_insights_path/index.md b/docs/aws-docs/providers/aws/ec2/network_insights_path/index.md new file mode 100644 index 0000000000..13cbee0913 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/network_insights_path/index.md @@ -0,0 +1,116 @@ +--- +title: network_insights_path +hide_title: false +hide_table_of_contents: false +keywords: + - network_insights_path + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual network_insights_path resource + +## Overview + + + + + +
Namenetwork_insights_path
TypeResource
DescriptionResource schema for AWS::EC2::NetworkInsightsPath
Idaws.ec2.network_insights_path
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
network_insights_path_idstring
network_insights_path_arnstring
created_datestring
source_ipstring
filter_at_sourceobject
filter_at_destinationobject
destination_ipstring
sourcestring
destinationstring
source_arnstring
destination_arnstring
protocolstring
destination_portinteger
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +network_insights_path_id, +network_insights_path_arn, +created_date, +source_ip, +filter_at_source, +filter_at_destination, +destination_ip, +source, +destination, +source_arn, +destination_arn, +protocol, +destination_port, +tags +FROM aws.ec2.network_insights_path +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the network_insights_path resource, the following permissions are required: + +### Delete +```json +ec2:DeleteNetworkInsightsPath, +ec2:DeleteTags +``` + +### Read +```json +ec2:DescribeNetworkInsightsPaths +``` + +### Update +```json +ec2:DescribeNetworkInsightsPaths, +ec2:CreateTags, +ec2:DeleteTags +``` + diff --git a/docs/aws-docs/providers/aws/ec2/network_insights_paths/index.md b/docs/aws-docs/providers/aws/ec2/network_insights_paths/index.md index f2aea588c0..ec7890f3fc 100644 --- a/docs/aws-docs/providers/aws/ec2/network_insights_paths/index.md +++ b/docs/aws-docs/providers/aws/ec2/network_insights_paths/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - network_insights_paths - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,32 +14,65 @@ description: Query, deploy 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_insights_paths in a region ## Overview +
Namenetwork_insights_paths
TypeResource
DescriptionResource schema for AWS::EC2::NetworkInsightsPath
Idaws.ec2.network_insights_paths
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `createdDate` | `string` | The time stamp when the path was created. | -| `destination` | `string` | The Amazon Web Services resource that is the destination of the path. | -| `destinationIp` | `string` | The IP address of the Amazon Web Services resource that is the destination of the path. | -| `destinationPort` | `integer` | The destination port. | -| `networkInsightsPathArn` | `string` | The Amazon Resource Name (ARN) of the path. | -| `networkInsightsPathId` | `string` | The ID of the path. | -| `protocol` | `string` | The protocol. | -| `source` | `string` | The Amazon Web Services resource that is the source of the path. | -| `sourceIp` | `string` | The IP address of the Amazon Web Services resource that is the source of the path. | -| `tagSet` | `array` | The tags associated with the path. | + + + + + +
NameDatatypeDescription
network_insights_path_idstring
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `network_insights_paths_Describe` | `SELECT` | `region` | Describes one or more of your paths. | -| `network_insights_path_Create` | `INSERT` | `ClientToken, Destination, Protocol, Source, region` | <p>Creates a path to analyze for reachability.</p> <p>Reachability Analyzer enables you to analyze and debug network reachability between two resources in your virtual private cloud (VPC). For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/reachability/">What is Reachability Analyzer</a>.</p> | -| `network_insights_path_Delete` | `DELETE` | `NetworkInsightsPathId, region` | Deletes the specified path. | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +network_insights_path_id +FROM aws.ec2.network_insights_paths +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the network_insights_paths resource, the following permissions are required: + +### Create +```json +ec2:CreateNetworkInsightsPath, +ec2:CreateTags +``` + +### List +```json +ec2:DescribeNetworkInsightsPaths +``` + diff --git a/docs/aws-docs/providers/aws/ec2/network_interface/index.md b/docs/aws-docs/providers/aws/ec2/network_interface/index.md new file mode 100644 index 0000000000..68760e14c9 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/network_interface/index.md @@ -0,0 +1,137 @@ +--- +title: network_interface +hide_title: false +hide_table_of_contents: false +keywords: + - network_interface + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual network_interface resource + +## Overview + + + + + +
Namenetwork_interface
TypeResource
DescriptionThe AWS::EC2::NetworkInterface resource creates network interface
Idaws.ec2.network_interface
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
descriptionstringA description for the network interface.
private_ip_addressstringAssigns a single private IP address to the network interface, which is used as the primary private IP address. If you want to specify multiple private IP address, use the PrivateIpAddresses property.
private_ip_addressesarrayAssigns a list of private IP addresses to the network interface. You can specify a primary private IP address by setting the value of the Primary property to true in the PrivateIpAddressSpecification property. If you want EC2 to automatically assign private IP addresses, use the SecondaryPrivateIpAddressCount property and do not specify this property.
secondary_private_ip_address_countintegerThe number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses
primary_private_ip_addressstringReturns the primary private IP address of the network interface.
ipv4_prefixesarrayAssigns a list of IPv4 prefixes to the network interface. If you want EC2 to automatically assign IPv4 prefixes, use the Ipv4PrefixCount property and do not specify this property. Presently, only /28 prefixes are supported. You can't specify IPv4 prefixes if you've specified one of the following: a count of IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.
ipv4_prefix_countintegerThe number of IPv4 prefixes to assign to a network interface. When you specify a number of IPv4 prefixes, Amazon EC2 selects these prefixes from your existing subnet CIDR reservations, if available, or from free spaces in the subnet. By default, these will be /28 prefixes. You can't specify a count of IPv4 prefixes if you've specified one of the following: specific IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.
group_setarrayA list of security group IDs associated with this network interface.
ipv6_addressesarrayOne or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet to associate with the network interface. If you're specifying a number of IPv6 addresses, use the Ipv6AddressCount property and don't specify this property.
ipv6_prefixesarrayAssigns a list of IPv6 prefixes to the network interface. If you want EC2 to automatically assign IPv6 prefixes, use the Ipv6PrefixCount property and do not specify this property. Presently, only /80 prefixes are supported. You can't specify IPv6 prefixes if you've specified one of the following: a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.
ipv6_prefix_countintegerThe number of IPv6 prefixes to assign to a network interface. When you specify a number of IPv6 prefixes, Amazon EC2 selects these prefixes from your existing subnet CIDR reservations, if available, or from free spaces in the subnet. By default, these will be /80 prefixes. You can't specify a count of IPv6 prefixes if you've specified one of the following: specific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.
subnet_idstringThe ID of the subnet to associate with the network interface.
source_dest_checkbooleanIndicates whether traffic to or from the instance is validated.
interface_typestringIndicates the type of network interface.
secondary_private_ip_addressesarrayReturns the secondary private IP addresses of the network interface.
ipv6_address_countintegerThe number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. To specify specific IPv6 addresses, use the Ipv6Addresses property and don't specify this property.
enable_primary_ipv6booleanIf you have instances or ENIs that rely on the IPv6 address not changing, to avoid disrupting traffic to instances or ENIs, you can enable a primary IPv6 address. Enable this option to automatically assign an IPv6 associated with the ENI attached to your instance to be the primary IPv6 address. When you enable an IPv6 address to be a primary IPv6, you cannot disable it. Traffic will be routed to the primary IPv6 address until the instance is terminated or the ENI is detached. If you have multiple IPv6 addresses associated with an ENI and you enable a primary IPv6 address, the first IPv6 address associated with the ENI becomes the primary IPv6 address.
primary_ipv6_addressstringThe primary IPv6 address
connection_tracking_specificationobject
idstringNetwork interface id.
tagsarrayAn arbitrary set of tags (key-value pairs) for this network interface.
vpc_idstringThe ID of the VPC
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +description, +private_ip_address, +private_ip_addresses, +secondary_private_ip_address_count, +primary_private_ip_address, +ipv4_prefixes, +ipv4_prefix_count, +group_set, +ipv6_addresses, +ipv6_prefixes, +ipv6_prefix_count, +subnet_id, +source_dest_check, +interface_type, +secondary_private_ip_addresses, +ipv6_address_count, +enable_primary_ipv6, +primary_ipv6_address, +connection_tracking_specification, +id, +tags, +vpc_id +FROM aws.ec2.network_interface +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the network_interface resource, the following permissions are required: + +### Delete +```json +ec2:DescribeNetworkInterfaces, +ec2:DeleteNetworkInterface +``` + +### Read +```json +ec2:DescribeNetworkInterfaces +``` + +### Update +```json +ec2:DescribeNetworkInterfaces, +ec2:ModifyNetworkInterfaceAttribute, +ec2:UnassignIpv6Addresses, +ec2:AssignIpv6Addresses, +ec2:DeleteTags, +ec2:CreateTags, +ec2:UnassignPrivateIpAddresses, +ec2:AssignPrivateIpAddresses +``` + diff --git a/docs/aws-docs/providers/aws/ec2/network_interface_attachment/index.md b/docs/aws-docs/providers/aws/ec2/network_interface_attachment/index.md new file mode 100644 index 0000000000..9f328f2065 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/network_interface_attachment/index.md @@ -0,0 +1,101 @@ +--- +title: network_interface_attachment +hide_title: false +hide_table_of_contents: false +keywords: + - network_interface_attachment + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual network_interface_attachment resource + +## Overview + + + + + +
Namenetwork_interface_attachment
TypeResource
DescriptionResource Type definition for AWS::EC2::NetworkInterfaceAttachment
Idaws.ec2.network_interface_attachment
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
attachment_idstringThe ID of the network interface attachment.
delete_on_terminationbooleanWhether to delete the network interface when the instance terminates. By default, this value is set to true.
device_indexstringThe network interface's position in the attachment order. For example, the first attached network interface has a DeviceIndex of 0.
instance_idstringThe ID of the instance to which you will attach the ENI.
network_interface_idstringThe ID of the ENI that you want to attach.
ena_srd_specificationobject
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +attachment_id, +delete_on_termination, +device_index, +instance_id, +network_interface_id, +ena_srd_specification +FROM aws.ec2.network_interface_attachment +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the network_interface_attachment resource, the following permissions are required: + +### Read +```json +ec2:DescribeNetworkInterfaces +``` + +### Update +```json +ec2:ModifyNetworkInterfaceAttribute, +ec2:DescribeNetworkInterfaces, +ec2:AttachNetworkInterface, +ec2:DetachNetworkInterface +``` + +### Delete +```json +ec2:DetachNetworkInterface, +ec2:DescribeNetworkInterfaces +``` + diff --git a/docs/aws-docs/providers/aws/ec2/network_interface_attachments/index.md b/docs/aws-docs/providers/aws/ec2/network_interface_attachments/index.md new file mode 100644 index 0000000000..26c34be33e --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/network_interface_attachments/index.md @@ -0,0 +1,79 @@ +--- +title: network_interface_attachments +hide_title: false +hide_table_of_contents: false +keywords: + - network_interface_attachments + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Retrieves a list of network_interface_attachments in a region + +## Overview + + + + + +
Namenetwork_interface_attachments
TypeResource
DescriptionResource Type definition for AWS::EC2::NetworkInterfaceAttachment
Idaws.ec2.network_interface_attachments
+ +## Fields + + + + + +
NameDatatypeDescription
attachment_idstringThe ID of the network interface attachment.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +attachment_id +FROM aws.ec2.network_interface_attachments +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the network_interface_attachments resource, the following permissions are required: + +### Create +```json +ec2:AttachNetworkInterface, +ec2:DescribeNetworkInterfaces, +ec2:ModifyNetworkInterfaceAttribute +``` + +### List +```json +ec2:DescribeNetworkInterfaces +``` + diff --git a/docs/aws-docs/providers/aws/ec2/network_interface_attribute/index.md b/docs/aws-docs/providers/aws/ec2/network_interface_attribute/index.md deleted file mode 100644 index 694eb3a089..0000000000 --- a/docs/aws-docs/providers/aws/ec2/network_interface_attribute/index.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: network_interface_attribute -hide_title: false -hide_table_of_contents: false -keywords: - - network_interface_attribute - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namenetwork_interface_attribute
TypeResource
Idaws.ec2.network_interface_attribute
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `description` | `object` | Describes a value for a resource attribute that is a String. | -| `attachment` | `object` | Describes a network interface attachment. | -| `groupSet` | `array` | The security groups associated with the network interface. | -| `networkInterfaceId` | `string` | The ID of the network interface. | -| `sourceDestCheck` | `object` | Describes a value for a resource attribute that is a Boolean value. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `network_interface_attribute_Describe` | `SELECT` | `NetworkInterfaceId, region` | Describes a network interface attribute. You can specify only one attribute at a time. | -| `network_interface_attribute_Modify` | `EXEC` | `NetworkInterfaceId, region` | Modifies the specified network interface attribute. You can specify only one attribute at a time. You can use this action to attach and detach security groups from an existing EC2 instance. | -| `network_interface_attribute_Reset` | `EXEC` | `NetworkInterfaceId, region` | Resets a network interface attribute. You can specify only one attribute at a time. | diff --git a/docs/aws-docs/providers/aws/ec2/network_interface_permissions/index.md b/docs/aws-docs/providers/aws/ec2/network_interface_permissions/index.md deleted file mode 100644 index 49b8ba2b60..0000000000 --- a/docs/aws-docs/providers/aws/ec2/network_interface_permissions/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: network_interface_permissions -hide_title: false -hide_table_of_contents: false -keywords: - - network_interface_permissions - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namenetwork_interface_permissions
TypeResource
Idaws.ec2.network_interface_permissions
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `awsAccountId` | `string` | The Amazon Web Services account ID. | -| `awsService` | `string` | The Amazon Web Service. | -| `networkInterfaceId` | `string` | The ID of the network interface. | -| `networkInterfacePermissionId` | `string` | The ID of the network interface permission. | -| `permission` | `string` | The type of permission. | -| `permissionState` | `object` | Describes the state of a network interface permission. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `network_interface_permissions_Describe` | `SELECT` | `region` | Describes the permissions for your network interfaces. | -| `network_interface_permission_Create` | `INSERT` | `NetworkInterfaceId, Permission, region` | <p>Grants an Amazon Web Services-authorized account permission to attach the specified network interface to an instance in their account.</p> <p>You can grant permission to a single Amazon Web Services account only, and only one account at a time.</p> | -| `network_interface_permission_Delete` | `DELETE` | `NetworkInterfacePermissionId, region` | Deletes a permission for a network interface. By default, you cannot delete the permission if the account for which you're removing the permission has attached the network interface to an instance. However, you can force delete the permission, regardless of any attachment. | diff --git a/docs/aws-docs/providers/aws/ec2/network_interfaces/index.md b/docs/aws-docs/providers/aws/ec2/network_interfaces/index.md index 2a828e23d0..ef6d41147d 100644 --- a/docs/aws-docs/providers/aws/ec2/network_interfaces/index.md +++ b/docs/aws-docs/providers/aws/ec2/network_interfaces/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - network_interfaces - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,50 +14,67 @@ description: Query, deploy 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_interfaces in a region ## Overview +
Namenetwork_interfaces
TypeResource
DescriptionThe AWS::EC2::NetworkInterface resource creates network interface
Idaws.ec2.network_interfaces
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `description` | `string` | A description. | -| `association` | `object` | Describes association information for an Elastic IP address (IPv4 only), or a Carrier IP address (for a network interface which resides in a subnet in a Wavelength Zone). | -| `attachment` | `object` | Describes a network interface attachment. | -| `availabilityZone` | `string` | The Availability Zone. | -| `denyAllIgwTraffic` | `boolean` | Indicates whether a network interface with an IPv6 address is unreachable from the public internet. If the value is <code>true</code>, inbound traffic from the internet is dropped and you cannot assign an elastic IP address to the network interface. The network interface is reachable from peered VPCs and resources connected through a transit gateway, including on-premises networks. | -| `groupSet` | `array` | Any security groups for the network interface. | -| `interfaceType` | `string` | The type of network interface. | -| `ipv4PrefixSet` | `array` | The IPv4 prefixes that are assigned to the network interface. | -| `ipv6Address` | `string` | The IPv6 globally unique address associated with the network interface. | -| `ipv6AddressesSet` | `array` | The IPv6 addresses associated with the network interface. | -| `ipv6Native` | `boolean` | Indicates whether this is an IPv6 only network interface. | -| `ipv6PrefixSet` | `array` | The IPv6 prefixes that are assigned to the network interface. | -| `macAddress` | `string` | The MAC address. | -| `networkInterfaceId` | `string` | The ID of the network interface. | -| `outpostArn` | `string` | The Amazon Resource Name (ARN) of the Outpost. | -| `ownerId` | `string` | The Amazon Web Services account ID of the owner of the network interface. | -| `privateDnsName` | `string` | The private DNS name. | -| `privateIpAddress` | `string` | The IPv4 address of the network interface within the subnet. | -| `privateIpAddressesSet` | `array` | The private IPv4 addresses associated with the network interface. | -| `requesterId` | `string` | The alias or Amazon Web Services account ID of the principal or service that created the network interface. | -| `requesterManaged` | `boolean` | Indicates whether the network interface is being managed by Amazon Web Services. | -| `sourceDestCheck` | `boolean` | Indicates whether source/destination checking is enabled. | -| `status` | `string` | The status of the network interface. | -| `subnetId` | `string` | The ID of the subnet. | -| `tagSet` | `array` | Any tags assigned to the network interface. | -| `vpcId` | `string` | The ID of the VPC. | + + + + + +
NameDatatypeDescription
idstringNetwork interface id.
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `network_interfaces_Describe` | `SELECT` | `region` | Describes one or more of your network interfaces. | -| `network_interface_Create` | `INSERT` | `SubnetId, region` | <p>Creates a network interface in the specified subnet.</p> <p>For more information about network interfaces, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html">Elastic Network Interfaces</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p> | -| `network_interface_Delete` | `DELETE` | `NetworkInterfaceId, region` | Deletes the specified network interface. You must detach the network interface before you can delete it. | -| `network_interface_Attach` | `EXEC` | `DeviceIndex, InstanceId, NetworkInterfaceId, region` | Attaches a network interface to an instance. | -| `network_interface_Detach` | `EXEC` | `AttachmentId, region` | Detaches a network interface from an instance. | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.ec2.network_interfaces +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the network_interfaces resource, the following permissions are required: + +### Create +```json +ec2:CreateNetworkInterface, +ec2:DescribeNetworkInterfaces, +ec2:CreateTags, +ec2:ModifyNetworkInterfaceAttribute +``` + +### List +```json +ec2:DescribeNetworkInterfaces +``` + diff --git a/docs/aws-docs/providers/aws/ec2/network_performance_metric_subscription/index.md b/docs/aws-docs/providers/aws/ec2/network_performance_metric_subscription/index.md new file mode 100644 index 0000000000..de5271e1d6 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/network_performance_metric_subscription/index.md @@ -0,0 +1,84 @@ +--- +title: network_performance_metric_subscription +hide_title: false +hide_table_of_contents: false +keywords: + - network_performance_metric_subscription + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual network_performance_metric_subscription resource + +## Overview + + + + + +
Namenetwork_performance_metric_subscription
TypeResource
DescriptionResource Type definition for AWS::EC2::NetworkPerformanceMetricSubscription
Idaws.ec2.network_performance_metric_subscription
+ +## Fields + + + + + + + + +
NameDatatypeDescription
sourcestringThe starting Region or Availability Zone for metric to subscribe to.
destinationstringThe target Region or Availability Zone for the metric to subscribe to.
metricstringThe metric type to subscribe to.
statisticstringThe statistic to subscribe to.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +source, +destination, +metric, +statistic +FROM aws.ec2.network_performance_metric_subscription +WHERE data__Identifier = '|||'; +``` + +## Permissions + +To operate on the network_performance_metric_subscription resource, the following permissions are required: + +### Read +```json +ec2:DescribeAwsNetworkPerformanceMetricSubscriptions +``` + +### Delete +```json +ec2:DescribeAwsNetworkPerformanceMetricSubscriptions, +ec2:DisableAwsNetworkPerformanceMetricSubscription +``` + diff --git a/docs/aws-docs/providers/aws/ec2/network_performance_metric_subscriptions/index.md b/docs/aws-docs/providers/aws/ec2/network_performance_metric_subscriptions/index.md new file mode 100644 index 0000000000..c29e404356 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/network_performance_metric_subscriptions/index.md @@ -0,0 +1,84 @@ +--- +title: network_performance_metric_subscriptions +hide_title: false +hide_table_of_contents: false +keywords: + - network_performance_metric_subscriptions + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Retrieves a list of network_performance_metric_subscriptions in a region + +## Overview + + + + + +
Namenetwork_performance_metric_subscriptions
TypeResource
DescriptionResource Type definition for AWS::EC2::NetworkPerformanceMetricSubscription
Idaws.ec2.network_performance_metric_subscriptions
+ +## Fields + + + + + + + + +
NameDatatypeDescription
sourcestringThe starting Region or Availability Zone for metric to subscribe to.
destinationstringThe target Region or Availability Zone for the metric to subscribe to.
metricstringThe metric type to subscribe to.
statisticstringThe statistic to subscribe to.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +source, +destination, +metric, +statistic +FROM aws.ec2.network_performance_metric_subscriptions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the network_performance_metric_subscriptions resource, the following permissions are required: + +### Create +```json +ec2:DescribeAwsNetworkPerformanceMetricSubscriptions, +ec2:EnableAwsNetworkPerformanceMetricSubscription +``` + +### List +```json +ec2:DescribeAwsNetworkPerformanceMetricSubscriptions +``` + diff --git a/docs/aws-docs/providers/aws/ec2/password_data/index.md b/docs/aws-docs/providers/aws/ec2/password_data/index.md deleted file mode 100644 index a4f6d0f097..0000000000 --- a/docs/aws-docs/providers/aws/ec2/password_data/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: password_data -hide_title: false -hide_table_of_contents: false -keywords: - - password_data - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namepassword_data
TypeResource
Idaws.ec2.password_data
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `instanceId` | `string` | The ID of the Windows instance. | -| `passwordData` | `string` | The password of the instance. Returns an empty string if the password is not available. | -| `timestamp` | `string` | The time the data was last updated. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `password_data_Get` | `SELECT` | `InstanceId, region` | diff --git a/docs/aws-docs/providers/aws/ec2/placement_group/index.md b/docs/aws-docs/providers/aws/ec2/placement_group/index.md new file mode 100644 index 0000000000..174527d730 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/placement_group/index.md @@ -0,0 +1,86 @@ +--- +title: placement_group +hide_title: false +hide_table_of_contents: false +keywords: + - placement_group + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual placement_group resource + +## Overview + + + + + +
Nameplacement_group
TypeResource
DescriptionResource Type definition for AWS::EC2::PlacementGroup
Idaws.ec2.placement_group
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
strategystringThe placement strategy.
group_namestringThe Group Name of Placement Group.
spread_levelstringThe Spread Level of Placement Group is an enum where it accepts either host or rack when strategy is spread
partition_countintegerThe number of partitions. Valid only when **Strategy** is set to `partition`
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +strategy, +group_name, +spread_level, +partition_count, +tags +FROM aws.ec2.placement_group +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the placement_group resource, the following permissions are required: + +### Read +```json +ec2:DescribePlacementGroups +``` + +### Delete +```json +ec2:DeletePlacementGroup, +ec2:DescribePlacementGroups +``` + diff --git a/docs/aws-docs/providers/aws/ec2/placement_groups/index.md b/docs/aws-docs/providers/aws/ec2/placement_groups/index.md index 5e4c635f8e..a8c89368d4 100644 --- a/docs/aws-docs/providers/aws/ec2/placement_groups/index.md +++ b/docs/aws-docs/providers/aws/ec2/placement_groups/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - placement_groups - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,29 +14,66 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- - - +Retrieves a list of placement_groups in a region ## Overview +
Nameplacement_groups
TypeResource
DescriptionResource Type definition for AWS::EC2::PlacementGroup
Idaws.ec2.placement_groups
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `groupArn` | `string` | The Amazon Resource Name (ARN) of the placement group. | -| `groupId` | `string` | The ID of the placement group. | -| `groupName` | `string` | The name of the placement group. | -| `partitionCount` | `integer` | The number of partitions. Valid only if <b>strategy</b> is set to <code>partition</code>. | -| `state` | `string` | The state of the placement group. | -| `strategy` | `string` | The placement strategy. | -| `tagSet` | `array` | Any tags applied to the placement group. | + + + + + +
NameDatatypeDescription
group_namestringThe Group Name of Placement Group.
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `placement_groups_Describe` | `SELECT` | `region` | Describes the specified placement groups or all of your placement groups. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html">Placement groups</a> in the <i>Amazon EC2 User Guide</i>. | -| `placement_group_Create` | `INSERT` | `region` | <p>Creates a placement group in which to launch instances. The strategy of the placement group determines how the instances are organized within the group. </p> <p>A <code>cluster</code> placement group is a logical grouping of instances within a single Availability Zone that benefit from low network latency, high network throughput. A <code>spread</code> placement group places instances on distinct hardware. A <code>partition</code> placement group places groups of instances in different partitions, where instances in one partition do not share the same hardware with instances in another partition.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html">Placement groups</a> in the <i>Amazon EC2 User Guide</i>.</p> | -| `placement_group_Delete` | `DELETE` | `GroupName, region` | Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html">Placement groups</a> in the <i>Amazon EC2 User Guide</i>. | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +group_name +FROM aws.ec2.placement_groups +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the placement_groups resource, the following permissions are required: + +### Create +```json +ec2:CreatePlacementGroup, +ec2:DescribePlacementGroups, +ec2:CreateTags +``` + +### List +```json +ec2:DescribePlacementGroups +``` + diff --git a/docs/aws-docs/providers/aws/ec2/prefix_list/index.md b/docs/aws-docs/providers/aws/ec2/prefix_list/index.md new file mode 100644 index 0000000000..f2bfc1e94c --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/prefix_list/index.md @@ -0,0 +1,109 @@ +--- +title: prefix_list +hide_title: false +hide_table_of_contents: false +keywords: + - prefix_list + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual prefix_list resource + +## Overview + + + + + +
Nameprefix_list
TypeResource
DescriptionResource schema of AWS::EC2::PrefixList Type
Idaws.ec2.prefix_list
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
prefix_list_namestringName of Prefix List.
prefix_list_idstringId of Prefix List.
owner_idstringOwner Id of Prefix List.
address_familystringIp Version of Prefix List.
max_entriesintegerMax Entries of Prefix List.
versionintegerVersion of Prefix List.
tagsarrayTags for Prefix List
entriesarrayEntries of Prefix List.
arnstringThe Amazon Resource Name (ARN) of the Prefix List.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +prefix_list_name, +prefix_list_id, +owner_id, +address_family, +max_entries, +version, +tags, +entries, +arn +FROM aws.ec2.prefix_list +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the prefix_list resource, the following permissions are required: + +### Read +```json +EC2:GetManagedPrefixListEntries, +EC2:DescribeManagedPrefixLists +``` + +### Update +```json +EC2:DescribeManagedPrefixLists, +EC2:GetManagedPrefixListEntries, +EC2:ModifyManagedPrefixList, +EC2:CreateTags, +EC2:DeleteTags +``` + +### Delete +```json +EC2:DeleteManagedPrefixList, +EC2:DescribeManagedPrefixLists +``` + diff --git a/docs/aws-docs/providers/aws/ec2/prefix_lists/index.md b/docs/aws-docs/providers/aws/ec2/prefix_lists/index.md index 7a43b727c1..0d164b58ad 100644 --- a/docs/aws-docs/providers/aws/ec2/prefix_lists/index.md +++ b/docs/aws-docs/providers/aws/ec2/prefix_lists/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - prefix_lists - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,23 +14,67 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- - - +Retrieves a list of prefix_lists in a region ## Overview +
Nameprefix_lists
TypeResource
DescriptionResource schema of AWS::EC2::PrefixList Type
Idaws.ec2.prefix_lists
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `cidrSet` | `array` | The IP address range of the Amazon Web Service. | -| `prefixListId` | `string` | The ID of the prefix. | -| `prefixListName` | `string` | The name of the prefix. | + + + + + +
NameDatatypeDescription
prefix_list_idstringId of Prefix List.
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `prefix_lists_Describe` | `SELECT` | `region` | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +prefix_list_id +FROM aws.ec2.prefix_lists +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the prefix_lists resource, the following permissions are required: + +### Create +```json +EC2:CreateManagedPrefixList, +EC2:DescribeManagedPrefixLists, +EC2:CreateTags +``` + +### List +```json +EC2:DescribeManagedPrefixLists, +EC2:GetManagedPrefixListEntries +``` + diff --git a/docs/aws-docs/providers/aws/ec2/principal_id_format/index.md b/docs/aws-docs/providers/aws/ec2/principal_id_format/index.md deleted file mode 100644 index 7241782642..0000000000 --- a/docs/aws-docs/providers/aws/ec2/principal_id_format/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: principal_id_format -hide_title: false -hide_table_of_contents: false -keywords: - - principal_id_format - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameprincipal_id_format
TypeResource
Idaws.ec2.principal_id_format
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `arn` | `string` | PrincipalIdFormatARN description | -| `statusSet` | `array` | PrincipalIdFormatStatuses description | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `principal_id_format_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2/private_dns_name_options/index.md b/docs/aws-docs/providers/aws/ec2/private_dns_name_options/index.md deleted file mode 100644 index a4547ec3e6..0000000000 --- a/docs/aws-docs/providers/aws/ec2/private_dns_name_options/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: private_dns_name_options -hide_title: false -hide_table_of_contents: false -keywords: - - private_dns_name_options - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameprivate_dns_name_options
TypeResource
Idaws.ec2.private_dns_name_options
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `private_dns_name_options_Modify` | `EXEC` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2/private_ip_addresses/index.md b/docs/aws-docs/providers/aws/ec2/private_ip_addresses/index.md deleted file mode 100644 index e744f7196c..0000000000 --- a/docs/aws-docs/providers/aws/ec2/private_ip_addresses/index.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: private_ip_addresses -hide_title: false -hide_table_of_contents: false -keywords: - - private_ip_addresses - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameprivate_ip_addresses
TypeResource
Idaws.ec2.private_ip_addresses
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `private_ip_addresses_Assign` | `EXEC` | `NetworkInterfaceId, region` | <p>Assigns one or more secondary private IP addresses to the specified network interface.</p> <p>You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For information about instance types, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance Types</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. For more information about Elastic IP addresses, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>When you move a secondary private IP address to another network interface, any Elastic IP address that is associated with the IP address is also moved.</p> <p>Remapping an IP address is an asynchronous operation. When you move an IP address from one network interface to another, check <code>network/interfaces/macs/mac/local-ipv4s</code> in the instance metadata to confirm that the remapping is complete.</p> <p>You must specify either the IP addresses or the IP address count in the request.</p> <p>You can optionally use Prefix Delegation on the network interface. You must specify either the IPv4 Prefix Delegation prefixes, or the IPv4 Prefix Delegation count. For information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-prefix-eni.html"> Assigning prefixes to Amazon EC2 network interfaces</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | -| `private_ip_addresses_Unassign` | `EXEC` | `NetworkInterfaceId, region` | Unassigns one or more secondary private IP addresses, or IPv4 Prefix Delegation prefixes from a network interface. | diff --git a/docs/aws-docs/providers/aws/ec2/product_instance/index.md b/docs/aws-docs/providers/aws/ec2/product_instance/index.md deleted file mode 100644 index 1a530760b6..0000000000 --- a/docs/aws-docs/providers/aws/ec2/product_instance/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: product_instance -hide_title: false -hide_table_of_contents: false -keywords: - - product_instance - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameproduct_instance
TypeResource
Idaws.ec2.product_instance
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `product_instance_Confirm` | `EXEC` | `InstanceId, ProductCode, region` | diff --git a/docs/aws-docs/providers/aws/ec2/public_ipv4_pool_cidr/index.md b/docs/aws-docs/providers/aws/ec2/public_ipv4_pool_cidr/index.md deleted file mode 100644 index 3e3d34a5ef..0000000000 --- a/docs/aws-docs/providers/aws/ec2/public_ipv4_pool_cidr/index.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: public_ipv4_pool_cidr -hide_title: false -hide_table_of_contents: false -keywords: - - public_ipv4_pool_cidr - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namepublic_ipv4_pool_cidr
TypeResource
Idaws.ec2.public_ipv4_pool_cidr
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `public_ipv4_pool_cidr_Deprovision` | `EXEC` | `Cidr, PoolId, region` | Deprovision a CIDR from a public IPv4 pool. | -| `public_ipv4_pool_cidr_Provision` | `EXEC` | `IpamPoolId, NetmaskLength, PoolId, region` | <p>Provision a CIDR to a public IPv4 pool.</p> <p>For more information about IPAM, see <a href="/vpc/latest/ipam/what-is-it-ipam.html">What is IPAM?</a> in the <i>Amazon VPC IPAM User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2/public_ipv4_pools/index.md b/docs/aws-docs/providers/aws/ec2/public_ipv4_pools/index.md deleted file mode 100644 index 0e098d9e77..0000000000 --- a/docs/aws-docs/providers/aws/ec2/public_ipv4_pools/index.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: public_ipv4_pools -hide_title: false -hide_table_of_contents: false -keywords: - - public_ipv4_pools - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namepublic_ipv4_pools
TypeResource
Idaws.ec2.public_ipv4_pools
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `description` | `string` | A description of the address pool. | -| `networkBorderGroup` | `string` | The name of the location from which the address pool is advertised. A network border group is a unique set of Availability Zones or Local Zones from where Amazon Web Services advertises public IP addresses. | -| `poolAddressRangeSet` | `array` | The address ranges. | -| `poolId` | `string` | The ID of the address pool. | -| `tagSet` | `array` | Any tags for the address pool. | -| `totalAddressCount` | `integer` | The total number of addresses. | -| `totalAvailableAddressCount` | `integer` | The total number of available addresses. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `public_ipv4_pools_Describe` | `SELECT` | `region` | Describes the specified IPv4 address pools. | -| `public_ipv4_pool_Create` | `INSERT` | `region` | Creates a public IPv4 address pool. A public IPv4 pool is an EC2 IP address pool required for the public IPv4 CIDRs that you own and bring to Amazon Web Services to manage with IPAM. IPv6 addresses you bring to Amazon Web Services, however, use IPAM pools only. To monitor the status of pool creation, use <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribePublicIpv4Pools.html">DescribePublicIpv4Pools</a>. | -| `public_ipv4_pool_Delete` | `DELETE` | `PoolId, region` | Delete a public IPv4 pool. A public IPv4 pool is an EC2 IP address pool required for the public IPv4 CIDRs that you own and bring to Amazon Web Services to manage with IPAM. IPv6 addresses you bring to Amazon Web Services, however, use IPAM pools only. | diff --git a/docs/aws-docs/providers/aws/ec2/queued_reserved_instances/index.md b/docs/aws-docs/providers/aws/ec2/queued_reserved_instances/index.md deleted file mode 100644 index 358d8045c8..0000000000 --- a/docs/aws-docs/providers/aws/ec2/queued_reserved_instances/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: queued_reserved_instances -hide_title: false -hide_table_of_contents: false -keywords: - - queued_reserved_instances - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namequeued_reserved_instances
TypeResource
Idaws.ec2.queued_reserved_instances
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `queued_reserved_instances_Delete` | `DELETE` | `ReservedInstancesId, region` | diff --git a/docs/aws-docs/providers/aws/ec2/regions/index.md b/docs/aws-docs/providers/aws/ec2/regions/index.md deleted file mode 100644 index de5e660196..0000000000 --- a/docs/aws-docs/providers/aws/ec2/regions/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: regions -hide_title: false -hide_table_of_contents: false -keywords: - - regions - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameregions
TypeResource
Idaws.ec2.regions
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `optInStatus` | `string` | The Region opt-in status. The possible values are <code>opt-in-not-required</code>, <code>opted-in</code>, and <code>not-opted-in</code>. | -| `regionEndpoint` | `string` | The Region service endpoint. | -| `regionName` | `string` | The name of the Region. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `regions_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2/replace_root_volume_tasks/index.md b/docs/aws-docs/providers/aws/ec2/replace_root_volume_tasks/index.md deleted file mode 100644 index 50159c7066..0000000000 --- a/docs/aws-docs/providers/aws/ec2/replace_root_volume_tasks/index.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: replace_root_volume_tasks -hide_title: false -hide_table_of_contents: false -keywords: - - replace_root_volume_tasks - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namereplace_root_volume_tasks
TypeResource
Idaws.ec2.replace_root_volume_tasks
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `completeTime` | `string` | The time the task completed. | -| `instanceId` | `string` | The ID of the instance for which the root volume replacement task was created. | -| `replaceRootVolumeTaskId` | `string` | The ID of the root volume replacement task. | -| `startTime` | `string` | The time the task was started. | -| `tagSet` | `array` | The tags assigned to the task. | -| `taskState` | `string` | <p>The state of the task. The task can be in one of the following states:</p> <ul> <li> <p> <code>pending</code> - the replacement volume is being created.</p> </li> <li> <p> <code>in-progress</code> - the original volume is being detached and the replacement volume is being attached.</p> </li> <li> <p> <code>succeeded</code> - the replacement volume has been successfully attached to the instance and the instance is available.</p> </li> <li> <p> <code>failing</code> - the replacement task is in the process of failing.</p> </li> <li> <p> <code>failed</code> - the replacement task has failed but the original root volume is still attached.</p> </li> <li> <p> <code>failing-detached</code> - the replacement task is in the process of failing. The instance might have no root volume attached.</p> </li> <li> <p> <code>failed-detached</code> - the replacement task has failed and the instance has no root volume attached.</p> </li> </ul> | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `replace_root_volume_tasks_Describe` | `SELECT` | `region` | Describes a root volume replacement task. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-restoring-volume.html#replace-root">Replace a root volume</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. | -| `replace_root_volume_task_Create` | `INSERT` | `InstanceId, region` | <p>Creates a root volume replacement task for an Amazon EC2 instance. The root volume can either be restored to its initial launch state, or it can be restored using a specific snapshot.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-restoring-volume.html#replace-root">Replace a root volume</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2/reserved_instances/index.md b/docs/aws-docs/providers/aws/ec2/reserved_instances/index.md deleted file mode 100644 index 3f7f8e5eef..0000000000 --- a/docs/aws-docs/providers/aws/ec2/reserved_instances/index.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: reserved_instances -hide_title: false -hide_table_of_contents: false -keywords: - - reserved_instances - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namereserved_instances
TypeResource
Idaws.ec2.reserved_instances
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `availabilityZone` | `string` | The Availability Zone in which the Reserved Instance can be used. | -| `currencyCode` | `string` | The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is <code>USD</code>. | -| `duration` | `integer` | The duration of the Reserved Instance, in seconds. | -| `end` | `string` | The time when the Reserved Instance expires. | -| `fixedPrice` | `number` | The purchase price of the Reserved Instance. | -| `instanceCount` | `integer` | The number of reservations purchased. | -| `instanceTenancy` | `string` | The tenancy of the instance. | -| `instanceType` | `string` | The instance type on which the Reserved Instance can be used. | -| `offeringClass` | `string` | The offering class of the Reserved Instance. | -| `offeringType` | `string` | The Reserved Instance offering type. | -| `productDescription` | `string` | The Reserved Instance product platform description. | -| `recurringCharges` | `array` | The recurring charge tag assigned to the resource. | -| `reservedInstancesId` | `string` | The ID of the Reserved Instance. | -| `scope` | `string` | The scope of the Reserved Instance. | -| `start` | `string` | The date and time the Reserved Instance started. | -| `state` | `string` | The state of the Reserved Instance purchase. | -| `tagSet` | `array` | Any tags assigned to the resource. | -| `usagePrice` | `number` | The usage price of the Reserved Instance, per hour. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `reserved_instances_Describe` | `SELECT` | `region` | <p>Describes one or more of the Reserved Instances that you purchased.</p> <p>For more information about Reserved Instances, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts-on-demand-reserved-instances.html">Reserved Instances</a> in the <i>Amazon EC2 User Guide</i>.</p> | -| `reserved_instances_Modify` | `EXEC` | `ReservedInstancesConfigurationSetItemType, ReservedInstancesId, region` | <p>Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Reserved Instances. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-modifying.html">Modifying Reserved Instances</a> in the <i>Amazon EC2 User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2/reserved_instances_exchange_quote/index.md b/docs/aws-docs/providers/aws/ec2/reserved_instances_exchange_quote/index.md deleted file mode 100644 index 915af25472..0000000000 --- a/docs/aws-docs/providers/aws/ec2/reserved_instances_exchange_quote/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: reserved_instances_exchange_quote -hide_title: false -hide_table_of_contents: false -keywords: - - reserved_instances_exchange_quote - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namereserved_instances_exchange_quote
TypeResource
Idaws.ec2.reserved_instances_exchange_quote
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `currencyCode` | `string` | The currency of the transaction. | -| `isValidExchange` | `boolean` | If <code>true</code>, the exchange is valid. If <code>false</code>, the exchange cannot be completed. | -| `outputReservedInstancesWillExpireAt` | `string` | The new end date of the reservation term. | -| `paymentDue` | `string` | The total true upfront charge for the exchange. | -| `reservedInstanceValueRollup` | `object` | The cost associated with the Reserved Instance. | -| `reservedInstanceValueSet` | `array` | The configuration of your Convertible Reserved Instances. | -| `targetConfigurationValueRollup` | `object` | The cost associated with the Reserved Instance. | -| `targetConfigurationValueSet` | `array` | The values of the target Convertible Reserved Instances. | -| `validationFailureReason` | `string` | Describes the reason why the exchange cannot be completed. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `reserved_instances_exchange_quote_Get` | `SELECT` | `ReservedInstanceId, region` | Returns a quote and exchange information for exchanging one or more specified Convertible Reserved Instances for a new Convertible Reserved Instance. If the exchange cannot be performed, the reason is returned in the response. Use <a>AcceptReservedInstancesExchangeQuote</a> to perform the exchange. | -| `reserved_instances_exchange_quote_Accept` | `EXEC` | `ReservedInstanceId, region` | Accepts the Convertible Reserved Instance exchange quote described in the <a>GetReservedInstancesExchangeQuote</a> call. | diff --git a/docs/aws-docs/providers/aws/ec2/reserved_instances_listings/index.md b/docs/aws-docs/providers/aws/ec2/reserved_instances_listings/index.md deleted file mode 100644 index 9011c5d7ae..0000000000 --- a/docs/aws-docs/providers/aws/ec2/reserved_instances_listings/index.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: reserved_instances_listings -hide_title: false -hide_table_of_contents: false -keywords: - - reserved_instances_listings - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namereserved_instances_listings
TypeResource
Idaws.ec2.reserved_instances_listings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `clientToken` | `string` | A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring Idempotency</a>. | -| `createDate` | `string` | The time the listing was created. | -| `instanceCounts` | `array` | The number of instances in this state. | -| `priceSchedules` | `array` | The price of the Reserved Instance listing. | -| `reservedInstancesId` | `string` | The ID of the Reserved Instance. | -| `reservedInstancesListingId` | `string` | The ID of the Reserved Instance listing. | -| `status` | `string` | The status of the Reserved Instance listing. | -| `statusMessage` | `string` | The reason for the current status of the Reserved Instance listing. The response can be blank. | -| `tagSet` | `array` | Any tags assigned to the resource. | -| `updateDate` | `string` | The last modified timestamp of the listing. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `reserved_instances_listings_Describe` | `SELECT` | `region` | <p>Describes your account's Reserved Instance listings in the Reserved Instance Marketplace.</p> <p>The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.</p> <p>As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase.</p> <p>As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a> in the <i>Amazon EC2 User Guide</i>.</p> | -| `reserved_instances_listing_Create` | `INSERT` | `ClientToken, InstanceCount, PriceSchedules, ReservedInstancesId, region` | <p>Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Standard Reserved Instance listing at a time. To get a list of your Standard Reserved Instances, you can use the <a>DescribeReservedInstances</a> operation.</p> <note> <p>Only Standard Reserved Instances can be sold in the Reserved Instance Marketplace. Convertible Reserved Instances cannot be sold.</p> </note> <p>The Reserved Instance Marketplace matches sellers who want to resell Standard Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.</p> <p>To sell your Standard Reserved Instances, you must first register as a seller in the Reserved Instance Marketplace. After completing the registration process, you can create a Reserved Instance Marketplace listing of some or all of your Standard Reserved Instances, and specify the upfront price to receive for them. Your Standard Reserved Instance listings then become available for purchase. To view the details of your Standard Reserved Instance listing, you can use the <a>DescribeReservedInstancesListings</a> operation.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a> in the <i>Amazon EC2 User Guide</i>.</p> | -| `reserved_instances_listing_Cancel` | `EXEC` | `ReservedInstancesListingId, region` | <p>Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a> in the <i>Amazon EC2 User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2/reserved_instances_modifications/index.md b/docs/aws-docs/providers/aws/ec2/reserved_instances_modifications/index.md deleted file mode 100644 index 27c3d29231..0000000000 --- a/docs/aws-docs/providers/aws/ec2/reserved_instances_modifications/index.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: reserved_instances_modifications -hide_title: false -hide_table_of_contents: false -keywords: - - reserved_instances_modifications - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namereserved_instances_modifications
TypeResource
Idaws.ec2.reserved_instances_modifications
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `clientToken` | `string` | A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring Idempotency</a>. | -| `createDate` | `string` | The time when the modification request was created. | -| `effectiveDate` | `string` | The time for the modification to become effective. | -| `modificationResultSet` | `array` | Contains target configurations along with their corresponding new Reserved Instance IDs. | -| `reservedInstancesModificationId` | `string` | A unique ID for the Reserved Instance modification. | -| `reservedInstancesSet` | `array` | The IDs of one or more Reserved Instances. | -| `status` | `string` | The status of the Reserved Instances modification request. | -| `statusMessage` | `string` | The reason for the status. | -| `updateDate` | `string` | The time when the modification request was last updated. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `reserved_instances_modifications_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2/reserved_instances_offerings/index.md b/docs/aws-docs/providers/aws/ec2/reserved_instances_offerings/index.md deleted file mode 100644 index 30f6db976d..0000000000 --- a/docs/aws-docs/providers/aws/ec2/reserved_instances_offerings/index.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: reserved_instances_offerings -hide_title: false -hide_table_of_contents: false -keywords: - - reserved_instances_offerings - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namereserved_instances_offerings
TypeResource
Idaws.ec2.reserved_instances_offerings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `availabilityZone` | `string` | The Availability Zone in which the Reserved Instance can be used. | -| `currencyCode` | `string` | The currency of the Reserved Instance offering you are purchasing. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is <code>USD</code>. | -| `duration` | `integer` | The duration of the Reserved Instance, in seconds. | -| `fixedPrice` | `number` | The purchase price of the Reserved Instance. | -| `instanceTenancy` | `string` | The tenancy of the instance. | -| `instanceType` | `string` | The instance type on which the Reserved Instance can be used. | -| `marketplace` | `boolean` | Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or Amazon Web Services. If it's a Reserved Instance Marketplace offering, this is <code>true</code>. | -| `offeringClass` | `string` | If <code>convertible</code> it can be exchanged for Reserved Instances of the same or higher monetary value, with different configurations. If <code>standard</code>, it is not possible to perform an exchange. | -| `offeringType` | `string` | The Reserved Instance offering type. | -| `pricingDetailsSet` | `array` | The pricing details of the Reserved Instance offering. | -| `productDescription` | `string` | The Reserved Instance product platform description. | -| `recurringCharges` | `array` | The recurring charge tag assigned to the resource. | -| `reservedInstancesOfferingId` | `string` | The ID of the Reserved Instance offering. This is the offering ID used in <a>GetReservedInstancesExchangeQuote</a> to confirm that an exchange can be made. | -| `scope` | `string` | Whether the Reserved Instance is applied to instances in a Region or an Availability Zone. | -| `usagePrice` | `number` | The usage price of the Reserved Instance, per hour. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `reserved_instances_offerings_Describe` | `SELECT` | `region` | <p>Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.</p> <p>If you have listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will be excluded from these results. This is to ensure that you do not purchase your own Reserved Instances.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a> in the <i>Amazon EC2 User Guide</i>.</p> | -| `reserved_instances_offering_Purchase` | `EXEC` | `InstanceCount, ReservedInstancesOfferingId, region` | <p>Purchases a Reserved Instance for use with your account. With Reserved Instances, you pay a lower hourly rate compared to On-Demand instance pricing.</p> <p>Use <a>DescribeReservedInstancesOfferings</a> to get a list of Reserved Instance offerings that match your specifications. After you've purchased a Reserved Instance, you can check for your new Reserved Instance with <a>DescribeReservedInstances</a>.</p> <p>To queue a purchase for a future date and time, specify a purchase time. If you do not specify a purchase time, the default is the current time.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts-on-demand-reserved-instances.html">Reserved Instances</a> and <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a> in the <i>Amazon EC2 User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2/restore_image_task/index.md b/docs/aws-docs/providers/aws/ec2/restore_image_task/index.md deleted file mode 100644 index 87d5f5f8af..0000000000 --- a/docs/aws-docs/providers/aws/ec2/restore_image_task/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: restore_image_task -hide_title: false -hide_table_of_contents: false -keywords: - - restore_image_task - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namerestore_image_task
TypeResource
Idaws.ec2.restore_image_task
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `restore_image_task_Create` | `INSERT` | `Bucket, ObjectKey, region` | diff --git a/docs/aws-docs/providers/aws/ec2/route/index.md b/docs/aws-docs/providers/aws/ec2/route/index.md index 98f51754a9..1fedabce6e 100644 --- a/docs/aws-docs/providers/aws/ec2/route/index.md +++ b/docs/aws-docs/providers/aws/ec2/route/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - route - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,21 +14,107 @@ description: Query, 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
DescriptionSpecifies a route in a route table. For more information, see [Routes](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html#route-table-routes) in the *Amazon VPC User Guide*.<br/> You must specify either a destination CIDR block or prefix list ID. You must also specify exactly one of the resources as the target.<br/> If you create a route that references a transit gateway in the same template where you create the transit gateway, you must declare a dependency on the transit gateway attachment. The route table cannot use the transit gateway until it has successfully attached to the VPC. Add a [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) in the ``AWS::EC2::Route`` resource to explicitly declare a dependency on the ``AWS::EC2::TransitGatewayAttachment`` resource.
Idaws.ec2.route
## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
carrier_gateway_idstringThe ID of the carrier gateway.<br/> You can only use this option when the VPC contains a subnet which is associated with a Wavelength Zone.
cidr_blockstring
core_network_arnstringThe Amazon Resource Name (ARN) of the core network.
destination_cidr_blockstringThe IPv4 CIDR address block used for the destination match. Routing decisions are based on the most specific match. We modify the specified CIDR block to its canonical form; for example, if you specify ``100.68.0.18/18``, we modify it to ``100.68.0.0/18``.
destination_ipv6_cidr_blockstringThe IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match.
destination_prefix_list_idstringThe ID of a prefix list used for the destination match.
egress_only_internet_gateway_idstring[IPv6 traffic only] The ID of an egress-only internet gateway.
gateway_idstringThe ID of an internet gateway or virtual private gateway attached to your VPC.
instance_idstringThe ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.
local_gateway_idstringThe ID of the local gateway.
nat_gateway_idstring[IPv4 traffic only] The ID of a NAT gateway.
network_interface_idstringThe ID of a network interface.
route_table_idstringThe ID of the route table for the route.
transit_gateway_idstringThe ID of a transit gateway.
vpc_endpoint_idstringThe ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.
vpc_peering_connection_idstringThe ID of a VPC peering connection.
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `route_Create` | `INSERT` | `RouteTableId, region` | <p>Creates a route in a route table within a VPC.</p> <p>You must specify one of the following targets: internet gateway or virtual private gateway, NAT instance, NAT gateway, VPC peering connection, network interface, egress-only internet gateway, or transit gateway.</p> <p>When determining how to route traffic, we use the route with the most specific match. For example, traffic is destined for the IPv4 address <code>192.0.2.3</code>, and the route table includes the following two IPv4 routes:</p> <ul> <li> <p> <code>192.0.2.0/24</code> (goes to some target A)</p> </li> <li> <p> <code>192.0.2.0/28</code> (goes to some target B)</p> </li> </ul> <p>Both routes apply to the traffic destined for <code>192.0.2.3</code>. However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic.</p> <p>For more information about route tables, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html">Route tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p> | -| `route_Delete` | `DELETE` | `RouteTableId, region` | Deletes the specified route from the specified route table. | -| `route_Replace` | `EXEC` | `RouteTableId, region` | <p>Replaces an existing route within a route table in a VPC. You must provide only one of the following: internet gateway, virtual private gateway, NAT instance, NAT gateway, VPC peering connection, network interface, egress-only internet gateway, or transit gateway.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html">Route tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p> | + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +carrier_gateway_id, +cidr_block, +core_network_arn, +destination_cidr_block, +destination_ipv6_cidr_block, +destination_prefix_list_id, +egress_only_internet_gateway_id, +gateway_id, +instance_id, +local_gateway_id, +nat_gateway_id, +network_interface_id, +route_table_id, +transit_gateway_id, +vpc_endpoint_id, +vpc_peering_connection_id +FROM aws.ec2.route +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the route resource, the following permissions are required: + +### Read +```json +ec2:DescribeRouteTables +``` + +### Update +```json +ec2:ReplaceRoute, +ec2:DescribeRouteTables, +ec2:DescribeNetworkInterfaces +``` + +### Delete +```json +ec2:DeleteRoute, +ec2:DescribeRouteTables +``` + diff --git a/docs/aws-docs/providers/aws/ec2/route_table/index.md b/docs/aws-docs/providers/aws/ec2/route_table/index.md new file mode 100644 index 0000000000..ef9b1b08c2 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/route_table/index.md @@ -0,0 +1,94 @@ +--- +title: route_table +hide_title: false +hide_table_of_contents: false +keywords: + - route_table + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual route_table resource + +## Overview + + + + + +
Nameroute_table
TypeResource
DescriptionSpecifies a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.<br/> For more information, see [Route tables](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html) in the *Amazon VPC User Guide*.
Idaws.ec2.route_table
+ +## Fields + + + + + + + +
NameDatatypeDescription
route_table_idstring
tagsarrayAny tags assigned to the route table.
vpc_idstringThe ID of the VPC.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +route_table_id, +tags, +vpc_id +FROM aws.ec2.route_table +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the route_table resource, the following permissions are required: + +### Read +```json +ec2:DescribeRouteTables +``` + +### Update +```json +ec2:CreateTags, +ec2:DeleteTags, +ec2:DescribeRouteTables +``` + +### Delete +```json +ec2:DescribeRouteTables, +ec2:DeleteRouteTable +``` + diff --git a/docs/aws-docs/providers/aws/ec2/route_table_association/index.md b/docs/aws-docs/providers/aws/ec2/route_table_association/index.md deleted file mode 100644 index cce31c1384..0000000000 --- a/docs/aws-docs/providers/aws/ec2/route_table_association/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: route_table_association -hide_title: false -hide_table_of_contents: false -keywords: - - route_table_association - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameroute_table_association
TypeResource
Idaws.ec2.route_table_association
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `route_table_association_Replace` | `EXEC` | `AssociationId, RouteTableId, region` | diff --git a/docs/aws-docs/providers/aws/ec2/route_tables/index.md b/docs/aws-docs/providers/aws/ec2/route_tables/index.md index 98f859d4d0..97d04d68a6 100644 --- a/docs/aws-docs/providers/aws/ec2/route_tables/index.md +++ b/docs/aws-docs/providers/aws/ec2/route_tables/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - route_tables - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,31 +14,66 @@ description: Query, deploy 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_tables in a region ## Overview +
Nameroute_tables
TypeResource
DescriptionSpecifies a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.<br/> For more information, see [Route tables](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html) in the *Amazon VPC User Guide*.
Idaws.ec2.route_tables
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `associationSet` | `array` | The associations between the route table and one or more subnets or a gateway. | -| `ownerId` | `string` | The ID of the Amazon Web Services account that owns the route table. | -| `propagatingVgwSet` | `array` | Any virtual private gateway (VGW) propagating routes. | -| `routeSet` | `array` | The routes in the route table. | -| `routeTableId` | `string` | The ID of the route table. | -| `tagSet` | `array` | Any tags assigned to the route table. | -| `vpcId` | `string` | The ID of the VPC. | + + + + + +
NameDatatypeDescription
route_table_idstring
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `route_tables_Describe` | `SELECT` | `region` | <p>Describes one or more of your route tables.</p> <p>Each subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html">Route tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p> | -| `route_table_Create` | `INSERT` | `VpcId, region` | <p>Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html">Route tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p> | -| `route_table_Delete` | `DELETE` | `RouteTableId, region` | Deletes the specified route table. You must disassociate the route table from any subnets before you can delete it. You can't delete the main route table. | -| `route_table_Associate` | `EXEC` | `RouteTableId, region` | <p>Associates a subnet in your VPC or an internet gateway or virtual private gateway attached to your VPC with a route table in your VPC. This association causes traffic from the subnet or gateway to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table later. A route table can be associated with multiple subnets.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html">Route tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p> | -| `route_table_Disassociate` | `EXEC` | `AssociationId, region` | <p>Disassociates a subnet or gateway from a route table.</p> <p>After you perform this action, the subnet no longer uses the routes in the route table. Instead, it uses the routes in the VPC's main route table. For more information about route tables, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html">Route tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p> | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +route_table_id +FROM aws.ec2.route_tables +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the route_tables resource, the following permissions are required: + +### Create +```json +ec2:CreateRouteTable, +ec2:CreateTags, +ec2:DescribeRouteTables +``` + +### List +```json +ec2:DescribeRouteTables +``` + diff --git a/docs/aws-docs/providers/aws/ec2/routes/index.md b/docs/aws-docs/providers/aws/ec2/routes/index.md new file mode 100644 index 0000000000..f55852a3a7 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/routes/index.md @@ -0,0 +1,81 @@ +--- +title: routes +hide_title: false +hide_table_of_contents: false +keywords: + - routes + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Retrieves a list of routes in a region + +## Overview + + + + + +
Nameroutes
TypeResource
DescriptionSpecifies a route in a route table. For more information, see [Routes](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html#route-table-routes) in the *Amazon VPC User Guide*.<br/> You must specify either a destination CIDR block or prefix list ID. You must also specify exactly one of the resources as the target.<br/> If you create a route that references a transit gateway in the same template where you create the transit gateway, you must declare a dependency on the transit gateway attachment. The route table cannot use the transit gateway until it has successfully attached to the VPC. Add a [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) in the ``AWS::EC2::Route`` resource to explicitly declare a dependency on the ``AWS::EC2::TransitGatewayAttachment`` resource.
Idaws.ec2.routes
+ +## Fields + + + + + + +
NameDatatypeDescription
route_table_idstringThe ID of the route table for the route.
cidr_blockstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +route_table_id, +cidr_block +FROM aws.ec2.routes +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the routes resource, the following permissions are required: + +### Create +```json +ec2:CreateRoute, +ec2:DescribeRouteTables, +ec2:DescribeNetworkInterfaces +``` + +### List +```json +ec2:DescribeRouteTables +``` + diff --git a/docs/aws-docs/providers/aws/ec2/scheduled_instance_availability/index.md b/docs/aws-docs/providers/aws/ec2/scheduled_instance_availability/index.md deleted file mode 100644 index a2aa61a106..0000000000 --- a/docs/aws-docs/providers/aws/ec2/scheduled_instance_availability/index.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: scheduled_instance_availability -hide_title: false -hide_table_of_contents: false -keywords: - - scheduled_instance_availability - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namescheduled_instance_availability
TypeResource
Idaws.ec2.scheduled_instance_availability
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `availabilityZone` | `string` | The Availability Zone. | -| `availableInstanceCount` | `integer` | The number of available instances. | -| `firstSlotStartTime` | `string` | The time period for the first schedule to start. | -| `hourlyPrice` | `string` | The hourly price for a single instance. | -| `instanceType` | `string` | The instance type. You can specify one of the C3, C4, M4, or R3 instance types. | -| `maxTermDurationInDays` | `integer` | The maximum term. The only possible value is 365 days. | -| `minTermDurationInDays` | `integer` | The minimum term. The only possible value is 365 days. | -| `networkPlatform` | `string` | The network platform (<code>EC2-Classic</code> or <code>EC2-VPC</code>). | -| `platform` | `string` | The platform (<code>Linux/UNIX</code> or <code>Windows</code>). | -| `purchaseToken` | `string` | The purchase token. This token expires in two hours. | -| `recurrence` | `object` | Describes the recurring schedule for a Scheduled Instance. | -| `slotDurationInHours` | `integer` | The number of hours in the schedule. | -| `totalScheduledInstanceHours` | `integer` | The total number of hours for a single instance for the entire term. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `scheduled_instance_availability_Describe` | `SELECT` | `FirstSlotStartTimeRange, Recurrence, region` | diff --git a/docs/aws-docs/providers/aws/ec2/scheduled_instances/index.md b/docs/aws-docs/providers/aws/ec2/scheduled_instances/index.md deleted file mode 100644 index b76225767c..0000000000 --- a/docs/aws-docs/providers/aws/ec2/scheduled_instances/index.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: scheduled_instances -hide_title: false -hide_table_of_contents: false -keywords: - - scheduled_instances - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namescheduled_instances
TypeResource
Idaws.ec2.scheduled_instances
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `availabilityZone` | `string` | The Availability Zone. | -| `createDate` | `string` | The date when the Scheduled Instance was purchased. | -| `hourlyPrice` | `string` | The hourly price for a single instance. | -| `instanceCount` | `integer` | The number of instances. | -| `instanceType` | `string` | The instance type. | -| `networkPlatform` | `string` | The network platform (<code>EC2-Classic</code> or <code>EC2-VPC</code>). | -| `nextSlotStartTime` | `string` | The time for the next schedule to start. | -| `platform` | `string` | The platform (<code>Linux/UNIX</code> or <code>Windows</code>). | -| `previousSlotEndTime` | `string` | The time that the previous schedule ended or will end. | -| `recurrence` | `object` | Describes the recurring schedule for a Scheduled Instance. | -| `scheduledInstanceId` | `string` | The Scheduled Instance ID. | -| `slotDurationInHours` | `integer` | The number of hours in the schedule. | -| `termEndDate` | `string` | The end date for the Scheduled Instance. | -| `termStartDate` | `string` | The start date for the Scheduled Instance. | -| `totalScheduledInstanceHours` | `integer` | The total number of hours for a single instance for the entire term. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `scheduled_instances_Describe` | `SELECT` | `region` | Describes the specified Scheduled Instances or all your Scheduled Instances. | -| `scheduled_instances_Purchase` | `EXEC` | `PurchaseRequest, region` | <p>Purchases the Scheduled Instances with the specified schedule.</p> <p>Scheduled Instances enable you to purchase Amazon EC2 compute capacity by the hour for a one-year term. Before you can purchase a Scheduled Instance, you must call <a>DescribeScheduledInstanceAvailability</a> to check for available schedules and obtain a purchase token. After you purchase a Scheduled Instance, you must call <a>RunScheduledInstances</a> during each scheduled time period.</p> <p>After you purchase a Scheduled Instance, you can't cancel, modify, or resell your purchase.</p> | -| `scheduled_instances_Run` | `EXEC` | `LaunchSpecification, ScheduledInstanceId, region` | <p>Launches the specified Scheduled Instances.</p> <p>Before you can launch a Scheduled Instance, you must purchase it and obtain an identifier using <a>PurchaseScheduledInstances</a>.</p> <p>You must launch a Scheduled Instance during its scheduled time period. You can't stop or reboot a Scheduled Instance, but you can terminate it as needed. If you terminate a Scheduled Instance before the current scheduled time period ends, you can launch it again after a few minutes. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-scheduled-instances.html">Scheduled Instances</a> in the <i>Amazon EC2 User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2/security_group/index.md b/docs/aws-docs/providers/aws/ec2/security_group/index.md new file mode 100644 index 0000000000..b2bbcff335 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/security_group/index.md @@ -0,0 +1,108 @@ +--- +title: security_group +hide_title: false +hide_table_of_contents: false +keywords: + - security_group + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual security_group resource + +## Overview + + + + + +
Namesecurity_group
TypeResource
DescriptionResource Type definition for AWS::EC2::SecurityGroup
Idaws.ec2.security_group
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
group_descriptionstringA description for the security group.
group_namestringThe name of the security group.
vpc_idstringThe ID of the VPC for the security group.
idstringThe group name or group ID depending on whether the SG is created in default or specific VPC
security_group_ingressarrayThe inbound rules associated with the security group. There is a short interruption during which you cannot connect to the security group.
security_group_egressarray[VPC only] The outbound rules associated with the security group. There is a short interruption during which you cannot connect to the security group.
tagsarrayAny tags assigned to the security group.
group_idstringThe group ID of the specified security group.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +group_description, +group_name, +vpc_id, +id, +security_group_ingress, +security_group_egress, +tags, +group_id +FROM aws.ec2.security_group +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the security_group resource, the following permissions are required: + +### Read +```json +ec2:DescribeSecurityGroups +``` + +### Update +```json +ec2:RevokeSecurityGroupEgress, +ec2:RevokeSecurityGroupIngress, +ec2:DescribeSecurityGroups, +ec2:AuthorizeSecurityGroupEgress, +ec2:AuthorizeSecurityGroupIngress, +ec2:CreateTags, +ec2:DeleteTags +``` + +### Delete +```json +ec2:DeleteSecurityGroup, +ec2:DescribeInstances +``` + diff --git a/docs/aws-docs/providers/aws/ec2/security_group_egress/index.md b/docs/aws-docs/providers/aws/ec2/security_group_egress/index.md index b684336d47..78944cce55 100644 --- a/docs/aws-docs/providers/aws/ec2/security_group_egress/index.md +++ b/docs/aws-docs/providers/aws/ec2/security_group_egress/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - security_group_egress - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,20 +14,93 @@ description: Query, 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_group_egress resource ## Overview +
Namesecurity_group_egress
TypeResource
DescriptionAdds the specified outbound (egress) rule to a security group.<br/> An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 address range, the IP addresses that are specified by a prefix list, or the instances that are associated with a destination security group. For more information, see [Security group rules](https://docs.aws.amazon.com/vpc/latest/userguide/security-group-rules.html).<br/> You must specify exactly one of the following destinations: an IPv4 address range, an IPv6 address range, a prefix list, or a security group.<br/> You must specify a protocol for each rule (for example, TCP). If the protocol is TCP or UDP, you must also specify a port or port range. If the protocol is ICMP or ICMPv6, you must also specify the ICMP/ICMPv6 type and code. To specify all types or all codes, use -1.<br/> Rule changes are propagated to instances associated with the security group as quickly as possible. However, a small delay might occur.
Idaws.ec2.security_group_egress
## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command + + + + + + + + + + + + + + +
NameDatatypeDescription
cidr_ipstringThe IPv4 address range, in CIDR format.<br/> You must specify exactly one of the following: ``CidrIp``, ``CidrIpv6``, ``DestinationPrefixListId``, or ``DestinationSecurityGroupId``.<br/> For examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *User Guide*.
cidr_ipv6stringThe IPv6 address range, in CIDR format.<br/> You must specify exactly one of the following: ``CidrIp``, ``CidrIpv6``, ``DestinationPrefixListId``, or ``DestinationSecurityGroupId``.<br/> For examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *User Guide*.
descriptionstringThe description of an egress (outbound) security group rule.<br/> Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
from_portintegerIf the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types).
to_portintegerIf the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes).
ip_protocolstringThe IP protocol name (``tcp``, ``udp``, ``icmp``, ``icmpv6``) or number (see [Protocol Numbers](https://docs.aws.amazon.com/http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml)).<br/> Use ``-1`` to specify all protocols. When authorizing security group rules, specifying ``-1`` or a protocol number other than ``tcp``, ``udp``, ``icmp``, or ``icmpv6`` allows traffic on all ports, regardless of any port range you specify. For ``tcp``, ``udp``, and ``icmp``, you must specify a port range. For ``icmpv6``, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
destination_security_group_idstringThe ID of the security group.<br/> You must specify exactly one of the following: ``CidrIp``, ``CidrIpv6``, ``DestinationPrefixListId``, or ``DestinationSecurityGroupId``.
idstring
destination_prefix_list_idstringThe prefix list IDs for an AWS service. This is the AWS service to access through a VPC endpoint from instances associated with the security group.<br/> You must specify exactly one of the following: ``CidrIp``, ``CidrIpv6``, ``DestinationPrefixListId``, or ``DestinationSecurityGroupId``.
group_idstringThe ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `security_group_egress_Authorize` | `EXEC` | `GroupId, region` | <p>[VPC only] Adds the specified outbound (egress) rules to a security group for use with a VPC.</p> <p>An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 CIDR address ranges, or to the instances that are associated with the specified source security groups.</p> <p>You specify a protocol for each rule (for example, TCP). For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes.</p> <p>Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.</p> <p>For information about VPC security group quotas, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html">Amazon VPC quotas</a>.</p> | -| `security_group_egress_Revoke` | `EXEC` | `GroupId, region` | <p>[VPC only] Removes the specified outbound (egress) rules from a security group for EC2-VPC. This action does not apply to security groups for use in EC2-Classic.</p> <p>You can specify rules using either rule IDs or security group rule properties. If you use rule properties, the values that you specify (for example, ports) must match the existing rule's values exactly. Each rule has a protocol, from and to ports, and destination (CIDR range, security group, or prefix list). For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not need to specify the description to revoke the rule.</p> <p>[Default VPC] If the values you specify do not match the existing rule's values, no error is returned, and the output describes the security group rules that were not revoked.</p> <p>Amazon Web Services recommends that you describe the security group to verify that the rules were removed.</p> <p>Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.</p> | + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +cidr_ip, +cidr_ipv6, +description, +from_port, +to_port, +ip_protocol, +destination_security_group_id, +id, +destination_prefix_list_id, +group_id +FROM aws.ec2.security_group_egress +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the security_group_egress resource, the following permissions are required: + +### Read +```json +ec2:DescribeSecurityGroupRules +``` + +### Update +```json +ec2:UpdateSecurityGroupRuleDescriptionsEgress +``` + +### Delete +```json +ec2:RevokeSecurityGroupEgress, +ec2:DescribeSecurityGroupRules +``` + diff --git a/docs/aws-docs/providers/aws/ec2/security_group_egresses/index.md b/docs/aws-docs/providers/aws/ec2/security_group_egresses/index.md new file mode 100644 index 0000000000..19bb2cf54b --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/security_group_egresses/index.md @@ -0,0 +1,79 @@ +--- +title: security_group_egresses +hide_title: false +hide_table_of_contents: false +keywords: + - security_group_egresses + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Retrieves a list of security_group_egresses in a region + +## Overview + + + + + +
Namesecurity_group_egresses
TypeResource
DescriptionAdds the specified outbound (egress) rule to a security group.<br/> An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 address range, the IP addresses that are specified by a prefix list, or the instances that are associated with a destination security group. For more information, see [Security group rules](https://docs.aws.amazon.com/vpc/latest/userguide/security-group-rules.html).<br/> You must specify exactly one of the following destinations: an IPv4 address range, an IPv6 address range, a prefix list, or a security group.<br/> You must specify a protocol for each rule (for example, TCP). If the protocol is TCP or UDP, you must also specify a port or port range. If the protocol is ICMP or ICMPv6, you must also specify the ICMP/ICMPv6 type and code. To specify all types or all codes, use -1.<br/> Rule changes are propagated to instances associated with the security group as quickly as possible. However, a small delay might occur.
Idaws.ec2.security_group_egresses
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.ec2.security_group_egresses +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the security_group_egresses resource, the following permissions are required: + +### Create +```json +ec2:AuthorizeSecurityGroupEgress, +ec2:RevokeSecurityGroupEgress, +ec2:DescribeSecurityGroupRules +``` + +### List +```json +ec2:DescribeSecurityGroupRules +``` + diff --git a/docs/aws-docs/providers/aws/ec2/security_group_ingress/index.md b/docs/aws-docs/providers/aws/ec2/security_group_ingress/index.md index 320bf546bd..fd1855b304 100644 --- a/docs/aws-docs/providers/aws/ec2/security_group_ingress/index.md +++ b/docs/aws-docs/providers/aws/ec2/security_group_ingress/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - security_group_ingress - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,20 +14,100 @@ description: Query, 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_group_ingress resource ## Overview +
Namesecurity_group_ingress
TypeResource
DescriptionResource Type definition for AWS::EC2::SecurityGroupIngress
Idaws.ec2.security_group_ingress
## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
idstringThe Security Group Rule Id
cidr_ipstringThe IPv4 ranges
cidr_ipv6string[VPC only] The IPv6 ranges
descriptionstringUpdates the description of an ingress (inbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously
from_portintegerThe start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.<br/><br/>Use this for ICMP and any protocol that uses ports.
group_idstringThe ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.<br/><br/>You must specify the GroupName property or the GroupId property. For security groups that are in a VPC, you must use the GroupId property.
group_namestringThe name of the security group.
ip_protocolstringThe IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers).<br/><br/>[VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
source_prefix_list_idstring[EC2-VPC only] The ID of a prefix list.<br/><br/>
source_security_group_idstringThe ID of the security group. You must specify either the security group ID or the security group name. For security groups in a nondefault VPC, you must specify the security group ID.
source_security_group_namestring[EC2-Classic, default VPC] The name of the source security group.<br/><br/>You must specify the GroupName property or the GroupId property. For security groups that are in a VPC, you must use the GroupId property.
source_security_group_owner_idstring[nondefault VPC] The AWS account ID that owns the source security group. You can't specify this property with an IP address range.<br/><br/>If you specify SourceSecurityGroupName or SourceSecurityGroupId and that security group is owned by a different account than the account creating the stack, you must specify the SourceSecurityGroupOwnerId; otherwise, this property is optional.
to_portintegerThe end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes for the specified ICMP type. If you specify all ICMP/ICMPv6 types, you must specify all codes.<br/><br/>Use this for ICMP and any protocol that uses ports.
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `security_group_ingress_Authorize` | `EXEC` | `region` | <p>Adds the specified inbound (ingress) rules to a security group.</p> <p>An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 CIDR address range, or from the instances that are associated with the specified destination security groups.</p> <p>You specify a protocol for each rule (for example, TCP). For TCP and UDP, you must also specify the destination port or port range. For ICMP/ICMPv6, you must also specify the ICMP/ICMPv6 type and code. You can use -1 to mean all types or all codes.</p> <p>Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.</p> <p>For more information about VPC security group quotas, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html">Amazon VPC quotas</a>.</p> | -| `security_group_ingress_Revoke` | `EXEC` | `region` | <p>Removes the specified inbound (ingress) rules from a security group.</p> <p>You can specify rules using either rule IDs or security group rule properties. If you use rule properties, the values that you specify (for example, ports) must match the existing rule's values exactly. Each rule has a protocol, from and to ports, and source (CIDR range, security group, or prefix list). For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not need to specify the description to revoke the rule.</p> <p>[EC2-Classic, default VPC] If the values you specify do not match the existing rule's values, no error is returned, and the output describes the security group rules that were not revoked.</p> <p>Amazon Web Services recommends that you describe the security group to verify that the rules were removed.</p> <p>Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.</p> | + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +cidr_ip, +cidr_ipv6, +description, +from_port, +group_id, +group_name, +ip_protocol, +source_prefix_list_id, +source_security_group_id, +source_security_group_name, +source_security_group_owner_id, +to_port +FROM aws.ec2.security_group_ingress +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the security_group_ingress resource, the following permissions are required: + +### Update +```json +ec2:UpdateSecurityGroupRuleDescriptionsIngress +``` + +### Delete +```json +ec2:DescribeSecurityGroupRules, +ec2:RevokeSecurityGroupIngress +``` + +### Read +```json +ec2:DescribeSecurityGroups, +ec2:DescribeSecurityGroupRules +``` + diff --git a/docs/aws-docs/providers/aws/ec2/security_group_ingresses/index.md b/docs/aws-docs/providers/aws/ec2/security_group_ingresses/index.md new file mode 100644 index 0000000000..52842af919 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/security_group_ingresses/index.md @@ -0,0 +1,78 @@ +--- +title: security_group_ingresses +hide_title: false +hide_table_of_contents: false +keywords: + - security_group_ingresses + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Retrieves a list of security_group_ingresses in a region + +## Overview + + + + + +
Namesecurity_group_ingresses
TypeResource
DescriptionResource Type definition for AWS::EC2::SecurityGroupIngress
Idaws.ec2.security_group_ingresses
+ +## Fields + + + + + +
NameDatatypeDescription
idstringThe Security Group Rule Id
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.ec2.security_group_ingresses +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the security_group_ingresses resource, the following permissions are required: + +### Create +```json +ec2:DescribeSecurityGroupRules, +ec2:AuthorizeSecurityGroupIngress +``` + +### List +```json +ec2:DescribeSecurityGroupRules +``` + diff --git a/docs/aws-docs/providers/aws/ec2/security_group_references/index.md b/docs/aws-docs/providers/aws/ec2/security_group_references/index.md deleted file mode 100644 index b4f65af3c7..0000000000 --- a/docs/aws-docs/providers/aws/ec2/security_group_references/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: security_group_references -hide_title: false -hide_table_of_contents: false -keywords: - - security_group_references - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namesecurity_group_references
TypeResource
Idaws.ec2.security_group_references
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `groupId` | `string` | The ID of your security group. | -| `referencingVpcId` | `string` | The ID of the VPC with the referencing security group. | -| `vpcPeeringConnectionId` | `string` | The ID of the VPC peering connection. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `security_group_references_Describe` | `SELECT` | `GroupId, region` | diff --git a/docs/aws-docs/providers/aws/ec2/security_group_rule_descriptions_egress/index.md b/docs/aws-docs/providers/aws/ec2/security_group_rule_descriptions_egress/index.md deleted file mode 100644 index 9dc823c497..0000000000 --- a/docs/aws-docs/providers/aws/ec2/security_group_rule_descriptions_egress/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: security_group_rule_descriptions_egress -hide_title: false -hide_table_of_contents: false -keywords: - - security_group_rule_descriptions_egress - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namesecurity_group_rule_descriptions_egress
TypeResource
Idaws.ec2.security_group_rule_descriptions_egress
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `security_group_rule_descriptions_egress_Update` | `EXEC` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2/security_group_rule_descriptions_ingress/index.md b/docs/aws-docs/providers/aws/ec2/security_group_rule_descriptions_ingress/index.md deleted file mode 100644 index a8f27fa572..0000000000 --- a/docs/aws-docs/providers/aws/ec2/security_group_rule_descriptions_ingress/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: security_group_rule_descriptions_ingress -hide_title: false -hide_table_of_contents: false -keywords: - - security_group_rule_descriptions_ingress - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namesecurity_group_rule_descriptions_ingress
TypeResource
Idaws.ec2.security_group_rule_descriptions_ingress
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `security_group_rule_descriptions_ingress_Update` | `EXEC` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2/security_group_rules/index.md b/docs/aws-docs/providers/aws/ec2/security_group_rules/index.md deleted file mode 100644 index 4c96ddb60f..0000000000 --- a/docs/aws-docs/providers/aws/ec2/security_group_rules/index.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: security_group_rules -hide_title: false -hide_table_of_contents: false -keywords: - - security_group_rules - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namesecurity_group_rules
TypeResource
Idaws.ec2.security_group_rules
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `description` | `string` | The security group rule description. | -| `cidrIpv4` | `string` | The IPv4 CIDR range. | -| `cidrIpv6` | `string` | The IPv6 CIDR range. | -| `fromPort` | `integer` | The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes. | -| `groupId` | `string` | The ID of the security group. | -| `groupOwnerId` | `string` | The ID of the Amazon Web Services account that owns the security group. | -| `ipProtocol` | `string` | <p>The IP protocol name (<code>tcp</code>, <code>udp</code>, <code>icmp</code>, <code>icmpv6</code>) or number (see <a href="http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml">Protocol Numbers</a>). </p> <p>Use <code>-1</code> to specify all protocols.</p> | -| `isEgress` | `boolean` | Indicates whether the security group rule is an outbound rule. | -| `prefixListId` | `string` | The ID of the prefix list. | -| `referencedGroupInfo` | `object` | Describes the security group that is referenced in the security group rule. | -| `securityGroupRuleId` | `string` | The ID of the security group rule. | -| `tagSet` | `array` | The tags applied to the security group rule. | -| `toPort` | `integer` | The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of <code>-1</code> indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `security_group_rules_Describe` | `SELECT` | `region` | Describes one or more of your security group rules. | -| `security_group_rules_Modify` | `EXEC` | `GroupId, SecurityGroupRule, region` | Modifies the rules of a security group. | diff --git a/docs/aws-docs/providers/aws/ec2/security_groups/index.md b/docs/aws-docs/providers/aws/ec2/security_groups/index.md index 4d462e6e16..25f01ced59 100644 --- a/docs/aws-docs/providers/aws/ec2/security_groups/index.md +++ b/docs/aws-docs/providers/aws/ec2/security_groups/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - security_groups - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,30 +14,69 @@ description: Query, deploy 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_groups in a region ## Overview +
Namesecurity_groups
TypeResource
DescriptionResource Type definition for AWS::EC2::SecurityGroup
Idaws.ec2.security_groups
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `groupDescription` | `string` | A description of the security group. | -| `groupId` | `string` | The ID of the security group. | -| `groupName` | `string` | The name of the security group. | -| `ipPermissions` | `array` | The inbound rules associated with the security group. | -| `ipPermissionsEgress` | `array` | [VPC only] The outbound rules associated with the security group. | -| `ownerId` | `string` | The Amazon Web Services account ID of the owner of the security group. | -| `tagSet` | `array` | Any tags assigned to the security group. | -| `vpcId` | `string` | [VPC only] The ID of the VPC for the security group. | + + + + + +
NameDatatypeDescription
idstringThe group name or group ID depending on whether the SG is created in default or specific VPC
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `security_groups_Describe` | `SELECT` | `region` | <p>Describes the specified security groups or all of your security groups.</p> <p>A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html">Amazon EC2 security groups</a> in the <i>Amazon Elastic Compute Cloud User Guide</i> and <a href="https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html">Security groups for your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p> | -| `security_group_Create` | `INSERT` | `GroupDescription, GroupName, region` | <p>Creates a security group.</p> <p>A security group acts as a virtual firewall for your instance to control inbound and outbound traffic. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html">Amazon EC2 security groups</a> in the <i>Amazon Elastic Compute Cloud User Guide</i> and <a href="https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html">Security groups for your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p> <p>When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.</p> <p>You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other.</p> <p>You can add or remove rules from your security groups using <a>AuthorizeSecurityGroupIngress</a>, <a>AuthorizeSecurityGroupEgress</a>, <a>RevokeSecurityGroupIngress</a>, and <a>RevokeSecurityGroupEgress</a>.</p> <p>For more information about VPC security group limits, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html">Amazon VPC Limits</a>.</p> | -| `security_group_Delete` | `DELETE` | `region` | <p>Deletes a security group.</p> <p>If you attempt to delete a security group that is associated with an instance, or is referenced by another security group, the operation fails with <code>InvalidGroup.InUse</code> in EC2-Classic or <code>DependencyViolation</code> in EC2-VPC.</p> | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.ec2.security_groups +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the security_groups resource, the following permissions are required: + +### Create +```json +ec2:CreateSecurityGroup, +ec2:DescribeSecurityGroups, +ec2:RevokeSecurityGroupEgress, +ec2:AuthorizeSecurityGroupEgress, +ec2:AuthorizeSecurityGroupIngress, +ec2:CreateTags +``` + +### List +```json +ec2:DescribeSecurityGroups +``` + diff --git a/docs/aws-docs/providers/aws/ec2/security_groups_to_client_vpn_target_network/index.md b/docs/aws-docs/providers/aws/ec2/security_groups_to_client_vpn_target_network/index.md deleted file mode 100644 index 086734d125..0000000000 --- a/docs/aws-docs/providers/aws/ec2/security_groups_to_client_vpn_target_network/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: security_groups_to_client_vpn_target_network -hide_title: false -hide_table_of_contents: false -keywords: - - security_groups_to_client_vpn_target_network - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namesecurity_groups_to_client_vpn_target_network
TypeResource
Idaws.ec2.security_groups_to_client_vpn_target_network
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `security_groups_to_client_vpn_target_network_Apply` | `EXEC` | `ClientVpnEndpointId, SecurityGroupId, VpcId, region` | diff --git a/docs/aws-docs/providers/aws/ec2/serial_console_access/index.md b/docs/aws-docs/providers/aws/ec2/serial_console_access/index.md deleted file mode 100644 index 1282876acb..0000000000 --- a/docs/aws-docs/providers/aws/ec2/serial_console_access/index.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: serial_console_access -hide_title: false -hide_table_of_contents: false -keywords: - - serial_console_access - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameserial_console_access
TypeResource
Idaws.ec2.serial_console_access
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `serial_console_access_Disable` | `EXEC` | `region` | Disables access to the EC2 serial console of all instances for your account. By default, access to the EC2 serial console is disabled for your account. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configure-access-to-serial-console.html#serial-console-account-access">Manage account access to the EC2 serial console</a> in the <i>Amazon EC2 User Guide</i>. | -| `serial_console_access_Enable` | `EXEC` | `region` | Enables access to the EC2 serial console of all instances for your account. By default, access to the EC2 serial console is disabled for your account. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configure-access-to-serial-console.html#serial-console-account-access">Manage account access to the EC2 serial console</a> in the <i>Amazon EC2 User Guide</i>. | diff --git a/docs/aws-docs/providers/aws/ec2/serial_console_access_status/index.md b/docs/aws-docs/providers/aws/ec2/serial_console_access_status/index.md deleted file mode 100644 index 1f7586887d..0000000000 --- a/docs/aws-docs/providers/aws/ec2/serial_console_access_status/index.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: serial_console_access_status -hide_title: false -hide_table_of_contents: false -keywords: - - serial_console_access_status - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameserial_console_access_status
TypeResource
Idaws.ec2.serial_console_access_status
- -## Fields -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `serial_console_access_status_Get` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2/snapshot_attribute/index.md b/docs/aws-docs/providers/aws/ec2/snapshot_attribute/index.md deleted file mode 100644 index 385c924f1c..0000000000 --- a/docs/aws-docs/providers/aws/ec2/snapshot_attribute/index.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: snapshot_attribute -hide_title: false -hide_table_of_contents: false -keywords: - - snapshot_attribute - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namesnapshot_attribute
TypeResource
Idaws.ec2.snapshot_attribute
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `createVolumePermission` | `array` | The users and groups that have the permissions for creating volumes from the snapshot. | -| `productCodes` | `array` | The product codes. | -| `snapshotId` | `string` | The ID of the EBS snapshot. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `snapshot_attribute_Describe` | `SELECT` | `Attribute, SnapshotId, region` | <p>Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time.</p> <p>For more information about EBS snapshots, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSSnapshots.html">Amazon EBS snapshots</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | -| `snapshot_attribute_Modify` | `EXEC` | `SnapshotId, region` | <p>Adds or removes permission settings for the specified snapshot. You may add or remove specified Amazon Web Services account IDs from a snapshot's list of create volume permissions, but you cannot do both in a single operation. If you need to both add and remove account IDs for a snapshot, you must use multiple operations. You can make up to 500 modifications to a snapshot in a single operation.</p> <p>Encrypted snapshots and snapshots with Amazon Web Services Marketplace product codes cannot be made public. Snapshots encrypted with your default KMS key cannot be shared with other accounts.</p> <p>For more information about modifying snapshot permissions, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-modifying-snapshot-permissions.html">Share a snapshot</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | -| `snapshot_attribute_Reset` | `EXEC` | `Attribute, SnapshotId, region` | <p>Resets permission settings for the specified snapshot.</p> <p>For more information about modifying snapshot permissions, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-modifying-snapshot-permissions.html">Share a snapshot</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2/snapshot_block_public_access/index.md b/docs/aws-docs/providers/aws/ec2/snapshot_block_public_access/index.md new file mode 100644 index 0000000000..be1acc640b --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/snapshot_block_public_access/index.md @@ -0,0 +1,91 @@ +--- +title: snapshot_block_public_access +hide_title: false +hide_table_of_contents: false +keywords: + - snapshot_block_public_access + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual snapshot_block_public_access resource + +## Overview + + + + + +
Namesnapshot_block_public_access
TypeResource
DescriptionResource Type definition for AWS::EC2::SnapshotBlockPublicAccess
Idaws.ec2.snapshot_block_public_access
+ +## Fields + + + + + + +
NameDatatypeDescription
statestringThe state of EBS Snapshot Block Public Access.
account_idstringThe identifier for the specified AWS account.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +state, +account_id +FROM aws.ec2.snapshot_block_public_access +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the snapshot_block_public_access resource, the following permissions are required: + +### Read +```json +ec2:GetSnapshotBlockPublicAccessState +``` + +### Update +```json +ec2:EnableSnapshotBlockPublicAccess, +ec2:GetSnapshotBlockPublicAccessState +``` + +### Delete +```json +ec2:DisableSnapshotBlockPublicAccess, +ec2:GetSnapshotBlockPublicAccessState +``` + diff --git a/docs/aws-docs/providers/aws/ec2/snapshot_block_public_accesses/index.md b/docs/aws-docs/providers/aws/ec2/snapshot_block_public_accesses/index.md new file mode 100644 index 0000000000..726def6f5a --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/snapshot_block_public_accesses/index.md @@ -0,0 +1,78 @@ +--- +title: snapshot_block_public_accesses +hide_title: false +hide_table_of_contents: false +keywords: + - snapshot_block_public_accesses + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Retrieves a list of snapshot_block_public_accesses in a region + +## Overview + + + + + +
Namesnapshot_block_public_accesses
TypeResource
DescriptionResource Type definition for AWS::EC2::SnapshotBlockPublicAccess
Idaws.ec2.snapshot_block_public_accesses
+ +## Fields + + + + + +
NameDatatypeDescription
account_idstringThe identifier for the specified AWS account.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +account_id +FROM aws.ec2.snapshot_block_public_accesses +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the snapshot_block_public_accesses resource, the following permissions are required: + +### Create +```json +ec2:EnableSnapshotBlockPublicAccess, +ec2:GetSnapshotBlockPublicAccessState +``` + +### List +```json +ec2:GetSnapshotBlockPublicAccessState +``` + diff --git a/docs/aws-docs/providers/aws/ec2/snapshot_from_recycle_bin/index.md b/docs/aws-docs/providers/aws/ec2/snapshot_from_recycle_bin/index.md deleted file mode 100644 index c44eb1e5ed..0000000000 --- a/docs/aws-docs/providers/aws/ec2/snapshot_from_recycle_bin/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: snapshot_from_recycle_bin -hide_title: false -hide_table_of_contents: false -keywords: - - snapshot_from_recycle_bin - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namesnapshot_from_recycle_bin
TypeResource
Idaws.ec2.snapshot_from_recycle_bin
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `snapshot_from_recycle_bin_Restore` | `EXEC` | `SnapshotId, region` | diff --git a/docs/aws-docs/providers/aws/ec2/snapshot_tier/index.md b/docs/aws-docs/providers/aws/ec2/snapshot_tier/index.md deleted file mode 100644 index 9159bce8e1..0000000000 --- a/docs/aws-docs/providers/aws/ec2/snapshot_tier/index.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: snapshot_tier -hide_title: false -hide_table_of_contents: false -keywords: - - snapshot_tier - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namesnapshot_tier
TypeResource
Idaws.ec2.snapshot_tier
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `snapshot_tier_Modify` | `EXEC` | `SnapshotId, region` | Archives an Amazon EBS snapshot. When you archive a snapshot, it is converted to a full snapshot that includes all of the blocks of data that were written to the volume at the time the snapshot was created, and moved from the standard tier to the archive tier. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshot-archive.html">Archive Amazon EBS snapshots</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. | -| `snapshot_tier_Restore` | `EXEC` | `SnapshotId, region` | <p>Restores an archived Amazon EBS snapshot for use temporarily or permanently, or modifies the restore period or restore type for a snapshot that was previously temporarily restored.</p> <p>For more information see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/working-with-snapshot-archiving.html#restore-archived-snapshot"> Restore an archived snapshot</a> and <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/working-with-snapshot-archiving.html#modify-temp-restore-period"> modify the restore period or restore type for a temporarily restored snapshot</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2/snapshot_tier_status/index.md b/docs/aws-docs/providers/aws/ec2/snapshot_tier_status/index.md deleted file mode 100644 index 69e7130030..0000000000 --- a/docs/aws-docs/providers/aws/ec2/snapshot_tier_status/index.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: snapshot_tier_status -hide_title: false -hide_table_of_contents: false -keywords: - - snapshot_tier_status - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namesnapshot_tier_status
TypeResource
Idaws.ec2.snapshot_tier_status
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `archivalCompleteTime` | `string` | The date and time when the last archive process was completed. | -| `lastTieringOperationStatus` | `string` | The status of the last archive or restore process. | -| `lastTieringOperationStatusDetail` | `string` | A message describing the status of the last archive or restore process. | -| `lastTieringProgress` | `integer` | The progress of the last archive or restore process, as a percentage. | -| `lastTieringStartTime` | `string` | The date and time when the last archive or restore process was started. | -| `ownerId` | `string` | The ID of the Amazon Web Services account that owns the snapshot. | -| `restoreExpiryTime` | `string` | Only for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived. | -| `snapshotId` | `string` | The ID of the snapshot. | -| `status` | `string` | The state of the snapshot. | -| `storageTier` | `string` | The storage tier in which the snapshot is stored. <code>standard</code> indicates that the snapshot is stored in the standard snapshot storage tier and that it is ready for use. <code>archive</code> indicates that the snapshot is currently archived and that it must be restored before it can be used. | -| `tagSet` | `array` | The tags that are assigned to the snapshot. | -| `volumeId` | `string` | The ID of the volume from which the snapshot was created. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `snapshot_tier_status_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2/snapshots/index.md b/docs/aws-docs/providers/aws/ec2/snapshots/index.md index 31b20a6a7c..659f620e19 100644 --- a/docs/aws-docs/providers/aws/ec2/snapshots/index.md +++ b/docs/aws-docs/providers/aws/ec2/snapshots/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - snapshots - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,42 +14,82 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- - - +List of snapshots by region (requires `aws` provider to be installed) ## Overview +
Namesnapshots
TypeResource
DescriptionList of snapshots by region (requires `aws` provider to be installed)
Idaws.ec2.snapshots
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `description` | `string` | The description for the snapshot. | -| `dataEncryptionKeyId` | `string` | The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by <a>DescribeSnapshots</a>. | -| `encrypted` | `boolean` | Indicates whether the snapshot is encrypted. | -| `kmsKeyId` | `string` | The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the parent volume. | -| `outpostArn` | `string` | The ARN of the Outpost on which the snapshot is stored. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshots-outposts.html">Amazon EBS local snapshots on Outposts</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. | -| `ownerAlias` | `string` | The Amazon Web Services owner alias, from an Amazon-maintained list (<code>amazon</code>). This is not the user-configured Amazon Web Services account alias set using the IAM console. | -| `ownerId` | `string` | The ID of the Amazon Web Services account that owns the EBS snapshot. | -| `progress` | `string` | The progress of the snapshot, as a percentage. | -| `restoreExpiryTime` | `string` | Only for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived. | -| `snapshotId` | `string` | The ID of the snapshot. Each snapshot receives a unique identifier when it is created. | -| `startTime` | `string` | The time stamp when the snapshot was initiated. | -| `status` | `string` | The snapshot state. | -| `statusMessage` | `string` | Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper Key Management Service (KMS) permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by <a>DescribeSnapshots</a>. | -| `storageTier` | `string` | The storage tier in which the snapshot is stored. <code>standard</code> indicates that the snapshot is stored in the standard snapshot storage tier and that it is ready for use. <code>archive</code> indicates that the snapshot is currently archived and that it must be restored before it can be used. | -| `tagSet` | `array` | Any tags assigned to the snapshot. | -| `volumeId` | `string` | The ID of the volume that was used to create the snapshot. Snapshots created by the <a>CopySnapshot</a> action have an arbitrary volume ID that should not be used for any purpose. | -| `volumeSize` | `integer` | The size of the volume, in GiB. | + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
descriptionstringThe description for the snapshot.
data_encryption_key_idstringThe data encryption key identifier for the snapshot.
encryptedbooleanIndicates whether the snapshot is encrypted.
kms_key_idstringThe Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the parent volume.
outpost_arnstring
owner_aliasstringThe Amazon Web Services owner alias.
owner_idstring
progressstringThe progress of the snapshot, as a percentage.
restore_expiry_timestringOnly for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived.
snapshot_idstringThe ID of the snapshot. Each snapshot receives a unique identifier when it is created.
start_timestringThe time stamp when the snapshot was initiated.
statusstringThe snapshot state.
status_messagestringEncrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper Key Management Service (KMS) permissions are not obtained) this field displays error state details.
storage_tierstringThe storage tier in which the snapshot is stored.
tag_setarray
volume_idstringThe ID of the volume that was used to create the snapshot.
volume_sizeintegerThe size of the volume, in GiB.
regionstring
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `snapshots_Describe` | `SELECT` | `region` | <p>Describes the specified EBS snapshots available to you or all of the EBS snapshots available to you.</p> <p>The snapshots available to you include public snapshots, private snapshots that you own, and private snapshots owned by other Amazon Web Services accounts for which you have explicit create volume permissions.</p> <p>The create volume permissions fall into the following categories:</p> <ul> <li> <p> <i>public</i>: The owner of the snapshot granted create volume permissions for the snapshot to the <code>all</code> group. All Amazon Web Services accounts have create volume permissions for these snapshots.</p> </li> <li> <p> <i>explicit</i>: The owner of the snapshot granted create volume permissions to a specific Amazon Web Services account.</p> </li> <li> <p> <i>implicit</i>: An Amazon Web Services account has implicit create volume permissions for all snapshots it owns.</p> </li> </ul> <p>The list of snapshots returned can be filtered by specifying snapshot IDs, snapshot owners, or Amazon Web Services accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions.</p> <p>If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results.</p> <p>If you specify one or more snapshot owners using the <code>OwnerIds</code> option, only snapshots from the specified owners and for which you have access are returned. The results can include the Amazon Web Services account IDs of the specified owners, <code>amazon</code> for snapshots owned by Amazon, or <code>self</code> for snapshots that you own.</p> <p>If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify Amazon Web Services account IDs (if you own the snapshots), <code>self</code> for snapshots for which you own or have explicit permissions, or <code>all</code> for public snapshots.</p> <p>If you are describing a long list of snapshots, we recommend that you paginate the output to make the list more manageable. The <code>MaxResults</code> parameter sets the maximum number of results returned in a single page. If the list of results exceeds your <code>MaxResults</code> value, then that number of results is returned along with a <code>NextToken</code> value that can be passed to a subsequent <code>DescribeSnapshots</code> request to retrieve the remaining results.</p> <p>To get the state of fast snapshot restores for a snapshot, use <a>DescribeFastSnapshotRestores</a>.</p> <p>For more information about EBS snapshots, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSSnapshots.html">Amazon EBS snapshots</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | -| `snapshot_Create` | `INSERT` | `VolumeId, region` | <p>Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance.</p> <p>You can create snapshots of volumes in a Region and volumes on an Outpost. If you create a snapshot of a volume in a Region, the snapshot must be stored in the same Region as the volume. If you create a snapshot of a volume on an Outpost, the snapshot can be stored on the same Outpost as the volume, or in the Region for that Outpost.</p> <p>When a snapshot is created, any Amazon Web Services Marketplace product codes that are associated with the source volume are propagated to the snapshot.</p> <p>You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your Amazon EBS volume at the time the snapshot command is issued; this might exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is <code>pending</code>.</p> <p>To create a snapshot for Amazon EBS volumes that serve as root devices, you should stop the instance before taking the snapshot.</p> <p>Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected.</p> <p>You can tag your snapshots during creation. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html">Tag your Amazon EC2 resources</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AmazonEBS.html">Amazon Elastic Block Store</a> and <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html">Amazon EBS encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | -| `snapshots_Create` | `INSERT` | `InstanceSpecification, region` | <p>Creates crash-consistent snapshots of multiple EBS volumes and stores the data in S3. Volumes are chosen by specifying an instance. Any attached volumes will produce one snapshot each that is crash-consistent across the instance. Boot volumes can be excluded by changing the parameters. </p> <p>You can create multi-volume snapshots of instances in a Region and instances on an Outpost. If you create snapshots from an instance in a Region, the snapshots must be stored in the same Region as the instance. If you create snapshots from an instance on an Outpost, the snapshots can be stored on the same Outpost as the instance, or in the Region for that Outpost.</p> | -| `snapshot_Delete` | `DELETE` | `SnapshotId, region` | <p>Deletes the specified snapshot.</p> <p>When you make periodic snapshots of a volume, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the volume.</p> <p>You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI. You must first de-register the AMI before you can delete the snapshot.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-deleting-snapshot.html">Delete an Amazon EBS snapshot</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | -| `snapshot_Copy` | `EXEC` | `SourceRegion, SourceSnapshotId, region` | <p>Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy a snapshot within the same Region, from one Region to another, or from a Region to an Outpost. You can't copy a snapshot from an Outpost to a Region, from one Outpost to another, or within the same Outpost.</p> <p>You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs).</p> <p>When copying snapshots to a Region, copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless you enable encryption for the snapshot copy operation. By default, encrypted snapshot copies use the default Key Management Service (KMS) KMS key; however, you can specify a different KMS key. To copy an encrypted snapshot that has been shared from another account, you must have permissions for the KMS key used to encrypt the snapshot.</p> <p>Snapshots copied to an Outpost are encrypted by default using the default encryption key for the Region, or a different key that you specify in the request using <b>KmsKeyId</b>. Outposts do not support unencrypted snapshots. For more information, <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshots-outposts.html#ami"> Amazon EBS local snapshots on Outposts</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>Snapshots created by copying another snapshot have an arbitrary volume ID that should not be used for any purpose.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-copy-snapshot.html">Copy an Amazon EBS snapshot</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | -| `snapshot_Import` | `EXEC` | `region` | <p>Imports a disk into an EBS snapshot.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/vm-import/latest/userguide/vmimport-import-snapshot.html">Importing a disk as a snapshot using VM Import/Export</a> in the <i>VM Import/Export User Guide</i>.</p> | + + + + + + + + + + + + +
NameAccessible byRequired Params
viewSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +description, +data_encryption_key_id, +encrypted, +kms_key_id, +outpost_arn, +owner_alias, +owner_id, +progress, +restore_expiry_time, +snapshot_id, +start_time, +status, +status_message, +storage_tier, +tag_set, +volume_id, +volume_size, +region +FROM aws.ec2.snapshots +WHERE region = ''; +``` + + + + diff --git a/docs/aws-docs/providers/aws/ec2/snapshots_in_recycle_bin/index.md b/docs/aws-docs/providers/aws/ec2/snapshots_in_recycle_bin/index.md deleted file mode 100644 index 5d438f0a12..0000000000 --- a/docs/aws-docs/providers/aws/ec2/snapshots_in_recycle_bin/index.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: snapshots_in_recycle_bin -hide_title: false -hide_table_of_contents: false -keywords: - - snapshots_in_recycle_bin - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namesnapshots_in_recycle_bin
TypeResource
Idaws.ec2.snapshots_in_recycle_bin
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `description` | `string` | The description for the snapshot. | -| `recycleBinEnterTime` | `string` | The date and time when the snaphsot entered the Recycle Bin. | -| `recycleBinExitTime` | `string` | The date and time when the snapshot is to be permanently deleted from the Recycle Bin. | -| `snapshotId` | `string` | The ID of the snapshot. | -| `volumeId` | `string` | The ID of the volume from which the snapshot was created. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `snapshots_in_recycle_bin_List` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2/spot_datafeed_subscription/index.md b/docs/aws-docs/providers/aws/ec2/spot_datafeed_subscription/index.md deleted file mode 100644 index 4a3bacbdf1..0000000000 --- a/docs/aws-docs/providers/aws/ec2/spot_datafeed_subscription/index.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: spot_datafeed_subscription -hide_title: false -hide_table_of_contents: false -keywords: - - spot_datafeed_subscription - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namespot_datafeed_subscription
TypeResource
Idaws.ec2.spot_datafeed_subscription
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `bucket` | `string` | The name of the Amazon S3 bucket where the Spot Instance data feed is located. | -| `fault` | `object` | Describes a Spot Instance state change. | -| `ownerId` | `string` | The Amazon Web Services account ID of the account. | -| `prefix` | `string` | The prefix for the data feed files. | -| `state` | `string` | The state of the Spot Instance data feed subscription. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `spot_datafeed_subscription_Describe` | `SELECT` | `region` | Describes the data feed for Spot Instances. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-data-feeds.html">Spot Instance data feed</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>. | -| `spot_datafeed_subscription_Create` | `INSERT` | `Bucket, region` | Creates a data feed for Spot Instances, enabling you to view Spot Instance usage logs. You can create one data feed per Amazon Web Services account. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-data-feeds.html">Spot Instance data feed</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>. | -| `spot_datafeed_subscription_Delete` | `DELETE` | `region` | Deletes the data feed for Spot Instances. | diff --git a/docs/aws-docs/providers/aws/ec2/spot_fleet/index.md b/docs/aws-docs/providers/aws/ec2/spot_fleet/index.md index 849e2e65ed..f77f49897a 100644 --- a/docs/aws-docs/providers/aws/ec2/spot_fleet/index.md +++ b/docs/aws-docs/providers/aws/ec2/spot_fleet/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - spot_fleet - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,19 +14,78 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- - - +Gets an individual spot_fleet resource ## Overview +
Namespot_fleet
TypeResource
DescriptionResource Type definition for AWS::EC2::SpotFleet
Idaws.ec2.spot_fleet
## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command + + + + + + +
NameDatatypeDescription
idstring
spot_fleet_request_config_dataobject
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `spot_fleet_Request` | `EXEC` | `SpotFleetRequestConfig, region` | + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +spot_fleet_request_config_data +FROM aws.ec2.spot_fleet +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the spot_fleet resource, the following permissions are required: + +### Delete +```json +ec2:DescribeSpotFleetRequests, +ec2:CancelSpotFleetRequests +``` + +### Read +```json +ec2:DescribeSpotFleetRequests +``` + +### Update +```json +ec2:ModifySpotFleetRequest, +ec2:DescribeSpotFleetRequests +``` + diff --git a/docs/aws-docs/providers/aws/ec2/spot_fleet_instances/index.md b/docs/aws-docs/providers/aws/ec2/spot_fleet_instances/index.md deleted file mode 100644 index 884d68df79..0000000000 --- a/docs/aws-docs/providers/aws/ec2/spot_fleet_instances/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: spot_fleet_instances -hide_title: false -hide_table_of_contents: false -keywords: - - spot_fleet_instances - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namespot_fleet_instances
TypeResource
Idaws.ec2.spot_fleet_instances
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `instanceHealth` | `string` | The health status of the instance. If the status of either the instance status check or the system status check is <code>impaired</code>, the health status of the instance is <code>unhealthy</code>. Otherwise, the health status is <code>healthy</code>. | -| `instanceId` | `string` | The ID of the instance. | -| `instanceType` | `string` | The instance type. | -| `spotInstanceRequestId` | `string` | The ID of the Spot Instance request. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `spot_fleet_instances_Describe` | `SELECT` | `SpotFleetRequestId, region` | diff --git a/docs/aws-docs/providers/aws/ec2/spot_fleet_request_history/index.md b/docs/aws-docs/providers/aws/ec2/spot_fleet_request_history/index.md deleted file mode 100644 index c565d61f59..0000000000 --- a/docs/aws-docs/providers/aws/ec2/spot_fleet_request_history/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: spot_fleet_request_history -hide_title: false -hide_table_of_contents: false -keywords: - - spot_fleet_request_history - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namespot_fleet_request_history
TypeResource
Idaws.ec2.spot_fleet_request_history
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `eventInformation` | `object` | Describes an EC2 Fleet or Spot Fleet event. | -| `eventType` | `string` | <p>The event type.</p> <ul> <li> <p> <code>error</code> - An error with the Spot Fleet request.</p> </li> <li> <p> <code>fleetRequestChange</code> - A change in the status or configuration of the Spot Fleet request.</p> </li> <li> <p> <code>instanceChange</code> - An instance was launched or terminated.</p> </li> <li> <p> <code>Information</code> - An informational event.</p> </li> </ul> | -| `timestamp` | `string` | The date and time of the event, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z). | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `spot_fleet_request_history_Describe` | `SELECT` | `SpotFleetRequestId, StartTime, region` | diff --git a/docs/aws-docs/providers/aws/ec2/spot_fleet_requests/index.md b/docs/aws-docs/providers/aws/ec2/spot_fleet_requests/index.md deleted file mode 100644 index 01ba64f05a..0000000000 --- a/docs/aws-docs/providers/aws/ec2/spot_fleet_requests/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: spot_fleet_requests -hide_title: false -hide_table_of_contents: false -keywords: - - spot_fleet_requests - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namespot_fleet_requests
TypeResource
Idaws.ec2.spot_fleet_requests
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `activityStatus` | `string` | The progress of the Spot Fleet request. If there is an error, the status is <code>error</code>. After all requests are placed, the status is <code>pending_fulfillment</code>. If the size of the fleet is equal to or greater than its target capacity, the status is <code>fulfilled</code>. If the size of the fleet is decreased, the status is <code>pending_termination</code> while Spot Instances are terminating. | -| `createTime` | `string` | The creation date and time of the request. | -| `spotFleetRequestConfig` | `object` | Describes the configuration of a Spot Fleet request. | -| `spotFleetRequestId` | `string` | The ID of the Spot Fleet request. | -| `spotFleetRequestState` | `string` | The state of the Spot Fleet request. | -| `tagSet` | `array` | The tags for a Spot Fleet resource. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `spot_fleet_requests_Describe` | `SELECT` | `region` | <p>Describes your Spot Fleet requests.</p> <p>Spot Fleet requests are deleted 48 hours after they are canceled and their instances are terminated.</p> | -| `spot_fleet_request_Modify` | `EXEC` | `SpotFleetRequestId, region` | <p>Modifies the specified Spot Fleet request.</p> <p>You can only modify a Spot Fleet request of type <code>maintain</code>.</p> <p>While the Spot Fleet request is being modified, it is in the <code>modifying</code> state.</p> <p>To scale up your Spot Fleet, increase its target capacity. The Spot Fleet launches the additional Spot Instances according to the allocation strategy for the Spot Fleet request. If the allocation strategy is <code>lowestPrice</code>, the Spot Fleet launches instances using the Spot Instance pool with the lowest price. If the allocation strategy is <code>diversified</code>, the Spot Fleet distributes the instances across the Spot Instance pools. If the allocation strategy is <code>capacityOptimized</code>, Spot Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.</p> <p>To scale down your Spot Fleet, decrease its target capacity. First, the Spot Fleet cancels any open requests that exceed the new target capacity. You can request that the Spot Fleet terminate Spot Instances until the size of the fleet no longer exceeds the new target capacity. If the allocation strategy is <code>lowestPrice</code>, the Spot Fleet terminates the instances with the highest price per unit. If the allocation strategy is <code>capacityOptimized</code>, the Spot Fleet terminates the instances in the Spot Instance pools that have the least available Spot Instance capacity. If the allocation strategy is <code>diversified</code>, the Spot Fleet terminates instances across the Spot Instance pools. Alternatively, you can request that the Spot Fleet keep the fleet at its current size, but not replace any Spot Instances that are interrupted or that you terminate manually.</p> <p>If you are finished with your Spot Fleet for now, but will use it again later, you can set the target capacity to 0.</p> | -| `spot_fleet_requests_Cancel` | `EXEC` | `SpotFleetRequestId, TerminateInstances, region` | <p>Cancels the specified Spot Fleet requests.</p> <p>After you cancel a Spot Fleet request, the Spot Fleet launches no new Spot Instances. You must specify whether the Spot Fleet should also terminate its Spot Instances. If you terminate the instances, the Spot Fleet request enters the <code>cancelled_terminating</code> state. Otherwise, the Spot Fleet request enters the <code>cancelled_running</code> state and the instances continue to run until they are interrupted or you terminate them manually.</p> | diff --git a/docs/aws-docs/providers/aws/ec2/spot_fleets/index.md b/docs/aws-docs/providers/aws/ec2/spot_fleets/index.md new file mode 100644 index 0000000000..f265591093 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/spot_fleets/index.md @@ -0,0 +1,81 @@ +--- +title: spot_fleets +hide_title: false +hide_table_of_contents: false +keywords: + - spot_fleets + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Retrieves a list of spot_fleets in a region + +## Overview + + + + + +
Namespot_fleets
TypeResource
DescriptionResource Type definition for AWS::EC2::SpotFleet
Idaws.ec2.spot_fleets
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.ec2.spot_fleets +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the spot_fleets resource, the following permissions are required: + +### Create +```json +iam:PassRole, +ec2:CreateTags, +ec2:RequestSpotFleet, +ec2:DescribeSpotFleetRequests, +ec2:RunInstances +``` + +### List +```json +ec2:DescribeSpotFleetRequests +``` + diff --git a/docs/aws-docs/providers/aws/ec2/spot_instance_requests/index.md b/docs/aws-docs/providers/aws/ec2/spot_instance_requests/index.md deleted file mode 100644 index 2e7318004d..0000000000 --- a/docs/aws-docs/providers/aws/ec2/spot_instance_requests/index.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: spot_instance_requests -hide_title: false -hide_table_of_contents: false -keywords: - - spot_instance_requests - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namespot_instance_requests
TypeResource
Idaws.ec2.spot_instance_requests
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `actualBlockHourlyPrice` | `string` | Deprecated. | -| `availabilityZoneGroup` | `string` | The Availability Zone group. If you specify the same Availability Zone group for all Spot Instance requests, all Spot Instances are launched in the same Availability Zone. | -| `blockDurationMinutes` | `integer` | Deprecated. | -| `createTime` | `string` | The date and time when the Spot Instance request was created, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z). | -| `fault` | `object` | Describes a Spot Instance state change. | -| `instanceId` | `string` | The instance ID, if an instance has been launched to fulfill the Spot Instance request. | -| `instanceInterruptionBehavior` | `string` | The behavior when a Spot Instance is interrupted. | -| `launchGroup` | `string` | The instance launch group. Launch groups are Spot Instances that launch together and terminate together. | -| `launchSpecification` | `object` | Describes the launch specification for an instance. | -| `launchedAvailabilityZone` | `string` | The Availability Zone in which the request is launched. | -| `productDescription` | `string` | The product description associated with the Spot Instance. | -| `spotInstanceRequestId` | `string` | The ID of the Spot Instance request. | -| `spotPrice` | `string` | The maximum price per hour that you are willing to pay for a Spot Instance. | -| `state` | `string` | The state of the Spot Instance request. Spot request status information helps track your Spot Instance requests. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-request-status.html">Spot request status</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>. | -| `status` | `object` | Describes the status of a Spot Instance request. | -| `tagSet` | `array` | Any tags assigned to the resource. | -| `type` | `string` | The Spot Instance request type. | -| `validFrom` | `string` | The start date of the request, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z). The request becomes active at this date and time. | -| `validUntil` | `string` | <p>The end date of the request, in UTC format (<i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z).</p> <ul> <li> <p>For a persistent request, the request remains active until the <code>validUntil</code> date and time is reached. Otherwise, the request remains active until you cancel it. </p> </li> <li> <p>For a one-time request, the request remains active until all instances launch, the request is canceled, or the <code>validUntil</code> date and time is reached. By default, the request is valid for 7 days from the date the request was created.</p> </li> </ul> | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `spot_instance_requests_Describe` | `SELECT` | `region` | <p>Describes the specified Spot Instance requests.</p> <p>You can use <code>DescribeSpotInstanceRequests</code> to find a running Spot Instance by examining the response. If the status of the Spot Instance is <code>fulfilled</code>, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances">DescribeInstances</a> with a filter to look for instances where the instance lifecycle is <code>spot</code>.</p> <p>We recommend that you set <code>MaxResults</code> to a value between 5 and 1000 to limit the number of results returned. This paginates the output, which makes the list more manageable and returns the results faster. If the list of results exceeds your <code>MaxResults</code> value, then that number of results is returned along with a <code>NextToken</code> value that can be passed to a subsequent <code>DescribeSpotInstanceRequests</code> request to retrieve the remaining results.</p> <p>Spot Instance requests are deleted four hours after they are canceled and their instances are terminated.</p> | -| `spot_instance_requests_Cancel` | `EXEC` | `SpotInstanceRequestId, region` | <p>Cancels one or more Spot Instance requests.</p> <important> <p>Canceling a Spot Instance request does not terminate running Spot Instances associated with the request.</p> </important> | diff --git a/docs/aws-docs/providers/aws/ec2/spot_instances/index.md b/docs/aws-docs/providers/aws/ec2/spot_instances/index.md deleted file mode 100644 index f158b4b05d..0000000000 --- a/docs/aws-docs/providers/aws/ec2/spot_instances/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: spot_instances -hide_title: false -hide_table_of_contents: false -keywords: - - spot_instances - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namespot_instances
TypeResource
Idaws.ec2.spot_instances
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `spot_instances_Request` | `EXEC` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2/spot_placement_scores/index.md b/docs/aws-docs/providers/aws/ec2/spot_placement_scores/index.md deleted file mode 100644 index ccc1b6a690..0000000000 --- a/docs/aws-docs/providers/aws/ec2/spot_placement_scores/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: spot_placement_scores -hide_title: false -hide_table_of_contents: false -keywords: - - spot_placement_scores - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namespot_placement_scores
TypeResource
Idaws.ec2.spot_placement_scores
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `availabilityZoneId` | `string` | The Availability Zone. | -| `region` | `string` | The Region. | -| `score` | `integer` | The placement score, on a scale from <code>1</code> to <code>10</code>. A score of <code>10</code> indicates that your Spot request is highly likely to succeed in this Region or Availability Zone. A score of <code>1</code> indicates that your Spot request is not likely to succeed. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `spot_placement_scores_Get` | `SELECT` | `TargetCapacity, region` | diff --git a/docs/aws-docs/providers/aws/ec2/spot_price_history/index.md b/docs/aws-docs/providers/aws/ec2/spot_price_history/index.md deleted file mode 100644 index cc5a4d37a5..0000000000 --- a/docs/aws-docs/providers/aws/ec2/spot_price_history/index.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: spot_price_history -hide_title: false -hide_table_of_contents: false -keywords: - - spot_price_history - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namespot_price_history
TypeResource
Idaws.ec2.spot_price_history
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `availabilityZone` | `string` | The Availability Zone. | -| `instanceType` | `string` | The instance type. | -| `productDescription` | `string` | A general description of the AMI. | -| `spotPrice` | `string` | The maximum price per hour that you are willing to pay for a Spot Instance. | -| `timestamp` | `string` | The date and time the request was created, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z). | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `spot_price_history_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2/stale_security_groups/index.md b/docs/aws-docs/providers/aws/ec2/stale_security_groups/index.md deleted file mode 100644 index 0d8ffa4c9e..0000000000 --- a/docs/aws-docs/providers/aws/ec2/stale_security_groups/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: stale_security_groups -hide_title: false -hide_table_of_contents: false -keywords: - - stale_security_groups - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namestale_security_groups
TypeResource
Idaws.ec2.stale_security_groups
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `description` | `string` | The description of the security group. | -| `groupId` | `string` | The ID of the security group. | -| `groupName` | `string` | The name of the security group. | -| `staleIpPermissions` | `array` | Information about the stale inbound rules in the security group. | -| `staleIpPermissionsEgress` | `array` | Information about the stale outbound rules in the security group. | -| `vpcId` | `string` | The ID of the VPC for the security group. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `stale_security_groups_Describe` | `SELECT` | `VpcId, region` | diff --git a/docs/aws-docs/providers/aws/ec2/store_image_tasks/index.md b/docs/aws-docs/providers/aws/ec2/store_image_tasks/index.md deleted file mode 100644 index e5c36d3836..0000000000 --- a/docs/aws-docs/providers/aws/ec2/store_image_tasks/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: store_image_tasks -hide_title: false -hide_table_of_contents: false -keywords: - - store_image_tasks - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namestore_image_tasks
TypeResource
Idaws.ec2.store_image_tasks
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `amiId` | `string` | The ID of the AMI that is being stored. | -| `bucket` | `string` | The name of the Amazon S3 bucket that contains the stored AMI object. | -| `progressPercentage` | `integer` | The progress of the task as a percentage. | -| `s3objectKey` | `string` | The name of the stored AMI object in the bucket. | -| `storeTaskFailureReason` | `string` | If the tasks fails, the reason for the failure is returned. If the task succeeds, <code>null</code> is returned. | -| `storeTaskState` | `string` | The state of the store task (<code>InProgress</code>, <code>Completed</code>, or <code>Failed</code>). | -| `taskStartTime` | `string` | The time the task started. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `store_image_tasks_Describe` | `SELECT` | `region` | <p>Describes the progress of the AMI store tasks. You can describe the store tasks for specified AMIs. If you don't specify the AMIs, you get a paginated list of store tasks from the last 31 days.</p> <p>For each AMI task, the response indicates if the task is <code>InProgress</code>, <code>Completed</code>, or <code>Failed</code>. For tasks <code>InProgress</code>, the response shows the estimated progress as a percentage.</p> <p>Tasks are listed in reverse chronological order. Currently, only tasks from the past 31 days can be viewed.</p> <p>To use this API, you must have the required permissions. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html#ami-s3-permissions">Permissions for storing and restoring AMIs using Amazon S3</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html">Store and restore an AMI using Amazon S3</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | -| `store_image_task_Create` | `INSERT` | `Bucket, ImageId, region` | <p>Stores an AMI as a single object in an Amazon S3 bucket.</p> <p>To use this API, you must have the required permissions. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html#ami-s3-permissions">Permissions for storing and restoring AMIs using Amazon S3</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html">Store and restore an AMI using Amazon S3</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2/subnet/index.md b/docs/aws-docs/providers/aws/ec2/subnet/index.md new file mode 100644 index 0000000000..0304a1b586 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/subnet/index.md @@ -0,0 +1,132 @@ +--- +title: subnet +hide_title: false +hide_table_of_contents: false +keywords: + - subnet + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual subnet resource + +## Overview + + + + + +
Namesubnet
TypeResource
DescriptionSpecifies a subnet for the specified VPC.<br/> For an IPv4 only subnet, specify an IPv4 CIDR block. If the VPC has an IPv6 CIDR block, you can create an IPv6 only subnet or a dual stack subnet instead. For an IPv6 only subnet, specify an IPv6 CIDR block. For a dual stack subnet, specify both an IPv4 CIDR block and an IPv6 CIDR block.<br/> For more information, see [Subnets for your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/configure-subnets.html) in the *Amazon VPC User Guide*.
Idaws.ec2.subnet
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
assign_ipv6_address_on_creationbooleanIndicates whether a network interface created in this subnet receives an IPv6 address. The default value is ``false``.<br/> If you specify ``AssignIpv6AddressOnCreation``, you must also specify an IPv6 CIDR block.
vpc_idstringThe ID of the VPC the subnet is in.<br/> If you update this property, you must also update the ``CidrBlock`` property.
map_public_ip_on_launchbooleanIndicates whether instances launched in this subnet receive a public IPv4 address. The default value is ``false``.<br/> AWS charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the *Public IPv4 Address* tab on the [VPC pricing page](https://docs.aws.amazon.com/vpc/pricing/).
enable_lni_at_device_indexintegerIndicates the device position for local network interfaces in this subnet. For example, ``1`` indicates local network interfaces in this subnet are the secondary network interface (eth1).
network_acl_association_idstring
availability_zonestringThe Availability Zone of the subnet.<br/> If you update this property, you must also update the ``CidrBlock`` property.
availability_zone_idstringThe AZ ID of the subnet.
cidr_blockstringThe IPv4 CIDR block assigned to the subnet.<br/> If you update this property, we create a new subnet, and then delete the existing one.
subnet_idstring
ipv6_cidr_blocksarrayThe IPv6 network ranges for the subnet, in CIDR notation.
ipv6_cidr_blockstringThe IPv6 CIDR block.<br/> If you specify ``AssignIpv6AddressOnCreation``, you must also specify an IPv6 CIDR block.
outpost_arnstringThe Amazon Resource Name (ARN) of the Outpost.
ipv6_nativebooleanIndicates whether this is an IPv6 only subnet. For more information, see [Subnet basics](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html#subnet-basics) in the *User Guide*.
enable_dns64booleanIndicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations. For more information, see [DNS64 and NAT64](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-nat64-dns64) in the *User Guide*.
private_dns_name_options_on_launchobjectThe hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries to the instances should be handled. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *User Guide*.<br/> Available options:<br/> + EnableResourceNameDnsAAAARecord (true | false)<br/> + EnableResourceNameDnsARecord (true | false)<br/> + HostnameType (ip-name | resource-name)
tagsarrayAny tags assigned to the subnet.
ipv4_ipam_pool_idstringAn IPv4 IPAM pool ID for the subnet.
ipv4_netmask_lengthintegerAn IPv4 netmask length for the subnet.
ipv6_ipam_pool_idstringAn IPv6 IPAM pool ID for the subnet.
ipv6_netmask_lengthintegerAn IPv6 netmask length for the subnet.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +assign_ipv6_address_on_creation, +vpc_id, +map_public_ip_on_launch, +enable_lni_at_device_index, +network_acl_association_id, +availability_zone, +availability_zone_id, +cidr_block, +subnet_id, +ipv6_cidr_blocks, +ipv6_cidr_block, +outpost_arn, +ipv6_native, +enable_dns64, +private_dns_name_options_on_launch, +tags, +ipv4_ipam_pool_id, +ipv4_netmask_length, +ipv6_ipam_pool_id, +ipv6_netmask_length +FROM aws.ec2.subnet +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the subnet resource, the following permissions are required: + +### Read +```json +ec2:DescribeSubnets, +ec2:DescribeNetworkAcls +``` + +### Update +```json +ec2:DescribeSubnets, +ec2:ModifySubnetAttribute, +ec2:CreateTags, +ec2:DeleteTags, +ec2:AssociateSubnetCidrBlock, +ec2:DisassociateSubnetCidrBlock +``` + +### Delete +```json +ec2:DescribeSubnets, +ec2:DeleteSubnet +``` + diff --git a/docs/aws-docs/providers/aws/ec2/subnet_attribute/index.md b/docs/aws-docs/providers/aws/ec2/subnet_attribute/index.md deleted file mode 100644 index 5232a600f4..0000000000 --- a/docs/aws-docs/providers/aws/ec2/subnet_attribute/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: subnet_attribute -hide_title: false -hide_table_of_contents: false -keywords: - - subnet_attribute - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namesubnet_attribute
TypeResource
Idaws.ec2.subnet_attribute
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `subnet_attribute_Modify` | `EXEC` | `SubnetId, region` | diff --git a/docs/aws-docs/providers/aws/ec2/subnet_cidr_block/index.md b/docs/aws-docs/providers/aws/ec2/subnet_cidr_block/index.md index c0a33a7252..2e4de6bae8 100644 --- a/docs/aws-docs/providers/aws/ec2/subnet_cidr_block/index.md +++ b/docs/aws-docs/providers/aws/ec2/subnet_cidr_block/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - subnet_cidr_block - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,20 +14,73 @@ description: Query, 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_cidr_block resource ## Overview +
Namesubnet_cidr_block
TypeResource
DescriptionThe AWS::EC2::SubnetCidrBlock resource creates association between subnet and IPv6 CIDR
Idaws.ec2.subnet_cidr_block
## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command + + + + + + + + + +
NameDatatypeDescription
idstringInformation about the IPv6 association.
ipv6_cidr_blockstringThe IPv6 network range for the subnet, in CIDR notation. The subnet size must use a /64 prefix length
ipv6_ipam_pool_idstringThe ID of an IPv6 Amazon VPC IP Address Manager (IPAM) pool from which to allocate, to get the subnet's CIDR
ipv6_netmask_lengthintegerThe netmask length of the IPv6 CIDR to allocate to the subnet from an IPAM pool
subnet_idstringThe ID of the subnet
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `subnet_cidr_block_Associate` | `EXEC` | `Ipv6CidrBlock, SubnetId, region` | Associates a CIDR block with your subnet. You can only associate a single IPv6 CIDR block with your subnet. An IPv6 CIDR block must have a prefix length of /64. | -| `subnet_cidr_block_Disassociate` | `EXEC` | `AssociationId, region` | Disassociates a CIDR block from a subnet. Currently, you can disassociate an IPv6 CIDR block only. You must detach or delete all gateways and resources that are associated with the CIDR block before you can disassociate it. | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +ipv6_cidr_block, +ipv6_ipam_pool_id, +ipv6_netmask_length, +subnet_id +FROM aws.ec2.subnet_cidr_block +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the subnet_cidr_block resource, the following permissions are required: + +### Delete +```json +ec2:DisassociateSubnetCidrBlock, +ec2:DescribeSubnets +``` + +### Read +```json +ec2:DescribeSubnets +``` + diff --git a/docs/aws-docs/providers/aws/ec2/subnet_cidr_blocks/index.md b/docs/aws-docs/providers/aws/ec2/subnet_cidr_blocks/index.md new file mode 100644 index 0000000000..fdf2feb7dc --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/subnet_cidr_blocks/index.md @@ -0,0 +1,78 @@ +--- +title: subnet_cidr_blocks +hide_title: false +hide_table_of_contents: false +keywords: + - subnet_cidr_blocks + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Retrieves a list of subnet_cidr_blocks in a region + +## Overview + + + + + +
Namesubnet_cidr_blocks
TypeResource
DescriptionThe AWS::EC2::SubnetCidrBlock resource creates association between subnet and IPv6 CIDR
Idaws.ec2.subnet_cidr_blocks
+ +## Fields + + + + + +
NameDatatypeDescription
idstringInformation about the IPv6 association.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.ec2.subnet_cidr_blocks +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the subnet_cidr_blocks resource, the following permissions are required: + +### Create +```json +ec2:AssociateSubnetCidrBlock, +ec2:DescribeSubnets +``` + +### List +```json +ec2:DescribeSubnets +``` + diff --git a/docs/aws-docs/providers/aws/ec2/subnet_cidr_reservations/index.md b/docs/aws-docs/providers/aws/ec2/subnet_cidr_reservations/index.md deleted file mode 100644 index cca54b17c1..0000000000 --- a/docs/aws-docs/providers/aws/ec2/subnet_cidr_reservations/index.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: subnet_cidr_reservations -hide_title: false -hide_table_of_contents: false -keywords: - - subnet_cidr_reservations - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namesubnet_cidr_reservations
TypeResource
Idaws.ec2.subnet_cidr_reservations
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `nextToken` | `string` | The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return. | -| `subnetIpv4CidrReservationSet` | `array` | Information about the IPv4 subnet CIDR reservations. | -| `subnetIpv6CidrReservationSet` | `array` | Information about the IPv6 subnet CIDR reservations. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `subnet_cidr_reservations_Get` | `SELECT` | `SubnetId, region` | Gets information about the subnet CIDR reservations. | -| `subnet_cidr_reservation_Create` | `INSERT` | `Cidr, ReservationType, SubnetId, region` | Creates a subnet CIDR reservation. For information about subnet CIDR reservations, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/subnet-cidr-reservation.html">Subnet CIDR reservations</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. | -| `subnet_cidr_reservation_Delete` | `DELETE` | `SubnetCidrReservationId, region` | Deletes a subnet CIDR reservation. | diff --git a/docs/aws-docs/providers/aws/ec2/subnet_network_acl_association/index.md b/docs/aws-docs/providers/aws/ec2/subnet_network_acl_association/index.md new file mode 100644 index 0000000000..076138e6ea --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/subnet_network_acl_association/index.md @@ -0,0 +1,82 @@ +--- +title: subnet_network_acl_association +hide_title: false +hide_table_of_contents: false +keywords: + - subnet_network_acl_association + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual subnet_network_acl_association resource + +## Overview + + + + + +
Namesubnet_network_acl_association
TypeResource
DescriptionResource Type definition for AWS::EC2::SubnetNetworkAclAssociation
Idaws.ec2.subnet_network_acl_association
+ +## Fields + + + + + + + +
NameDatatypeDescription
subnet_idstringThe ID of the subnet
network_acl_idstringThe ID of the network ACL
association_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +subnet_id, +network_acl_id, +association_id +FROM aws.ec2.subnet_network_acl_association +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the subnet_network_acl_association resource, the following permissions are required: + +### Read +```json +ec2:DescribeNetworkAcls +``` + +### Delete +```json +ec2:DescribeNetworkAcls, +ec2:ReplaceNetworkAclAssociation +``` + diff --git a/docs/aws-docs/providers/aws/ec2/subnet_network_acl_associations/index.md b/docs/aws-docs/providers/aws/ec2/subnet_network_acl_associations/index.md new file mode 100644 index 0000000000..c595bab1a5 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/subnet_network_acl_associations/index.md @@ -0,0 +1,78 @@ +--- +title: subnet_network_acl_associations +hide_title: false +hide_table_of_contents: false +keywords: + - subnet_network_acl_associations + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Retrieves a list of subnet_network_acl_associations in a region + +## Overview + + + + + +
Namesubnet_network_acl_associations
TypeResource
DescriptionResource Type definition for AWS::EC2::SubnetNetworkAclAssociation
Idaws.ec2.subnet_network_acl_associations
+ +## Fields + + + + + +
NameDatatypeDescription
association_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +association_id +FROM aws.ec2.subnet_network_acl_associations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the subnet_network_acl_associations resource, the following permissions are required: + +### Create +```json +ec2:DescribeNetworkAcls, +ec2:ReplaceNetworkAclAssociation +``` + +### List +```json +ec2:DescribeNetworkAcls +``` + diff --git a/docs/aws-docs/providers/aws/ec2/subnet_route_table_association/index.md b/docs/aws-docs/providers/aws/ec2/subnet_route_table_association/index.md new file mode 100644 index 0000000000..9111d9afcd --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/subnet_route_table_association/index.md @@ -0,0 +1,83 @@ +--- +title: subnet_route_table_association +hide_title: false +hide_table_of_contents: false +keywords: + - subnet_route_table_association + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual subnet_route_table_association resource + +## Overview + + + + + +
Namesubnet_route_table_association
TypeResource
DescriptionAssociates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet to be routed according to the routes in the route table. A route table can be associated with multiple subnets. To create a route table, see [AWS::EC2::RouteTable](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routetable.html).
Idaws.ec2.subnet_route_table_association
+ +## Fields + + + + + + + +
NameDatatypeDescription
idstring
route_table_idstringThe ID of the route table.<br/> The physical ID changes when the route table ID is changed.
subnet_idstringThe ID of the subnet.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +route_table_id, +subnet_id +FROM aws.ec2.subnet_route_table_association +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the subnet_route_table_association resource, the following permissions are required: + +### Read +```json +ec2:DescribeRouteTables +``` + +### Delete +```json +ec2:DisassociateRouteTable, +ec2:DescribeSubnets, +ec2:DescribeRouteTables +``` + diff --git a/docs/aws-docs/providers/aws/ec2/subnet_route_table_associations/index.md b/docs/aws-docs/providers/aws/ec2/subnet_route_table_associations/index.md new file mode 100644 index 0000000000..01e135a2cd --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/subnet_route_table_associations/index.md @@ -0,0 +1,80 @@ +--- +title: subnet_route_table_associations +hide_title: false +hide_table_of_contents: false +keywords: + - subnet_route_table_associations + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Retrieves a list of subnet_route_table_associations in a region + +## Overview + + + + + +
Namesubnet_route_table_associations
TypeResource
DescriptionAssociates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet to be routed according to the routes in the route table. A route table can be associated with multiple subnets. To create a route table, see [AWS::EC2::RouteTable](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routetable.html).
Idaws.ec2.subnet_route_table_associations
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.ec2.subnet_route_table_associations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the subnet_route_table_associations resource, the following permissions are required: + +### Create +```json +ec2:AssociateRouteTable, +ec2:ReplaceRouteTableAssociation, +ec2:DescribeSubnets, +ec2:DescribeRouteTables +``` + +### List +```json +ec2:DescribeRouteTables +``` + diff --git a/docs/aws-docs/providers/aws/ec2/subnets/index.md b/docs/aws-docs/providers/aws/ec2/subnets/index.md index 69ba9168ff..f5a55b8cb2 100644 --- a/docs/aws-docs/providers/aws/ec2/subnets/index.md +++ b/docs/aws-docs/providers/aws/ec2/subnets/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - subnets - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,43 +14,68 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- - - +Retrieves a list of subnets in a region ## Overview +
Namesubnets
TypeResource
DescriptionSpecifies a subnet for the specified VPC.<br/> For an IPv4 only subnet, specify an IPv4 CIDR block. If the VPC has an IPv6 CIDR block, you can create an IPv6 only subnet or a dual stack subnet instead. For an IPv6 only subnet, specify an IPv6 CIDR block. For a dual stack subnet, specify both an IPv4 CIDR block and an IPv6 CIDR block.<br/> For more information, see [Subnets for your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/configure-subnets.html) in the *Amazon VPC User Guide*.
Idaws.ec2.subnets
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `assignIpv6AddressOnCreation` | `boolean` | Indicates whether a network interface created in this subnet (including a network interface created by <a>RunInstances</a>) receives an IPv6 address. | -| `availabilityZone` | `string` | The Availability Zone of the subnet. | -| `availabilityZoneId` | `string` | The AZ ID of the subnet. | -| `availableIpAddressCount` | `integer` | The number of unused private IPv4 addresses in the subnet. The IPv4 addresses for any stopped instances are considered unavailable. | -| `cidrBlock` | `string` | The IPv4 CIDR block assigned to the subnet. | -| `customerOwnedIpv4Pool` | `string` | The customer-owned IPv4 address pool associated with the subnet. | -| `defaultForAz` | `boolean` | Indicates whether this is the default subnet for the Availability Zone. | -| `enableDns64` | `boolean` | Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations. | -| `enableLniAtDeviceIndex` | `integer` | Indicates the device position for local network interfaces in this subnet. For example, <code>1</code> indicates local network interfaces in this subnet are the secondary network interface (eth1). | -| `ipv6CidrBlockAssociationSet` | `array` | Information about the IPv6 CIDR blocks associated with the subnet. | -| `ipv6Native` | `boolean` | Indicates whether this is an IPv6 only subnet. | -| `mapCustomerOwnedIpOnLaunch` | `boolean` | Indicates whether a network interface created in this subnet (including a network interface created by <a>RunInstances</a>) receives a customer-owned IPv4 address. | -| `mapPublicIpOnLaunch` | `boolean` | Indicates whether instances launched in this subnet receive a public IPv4 address. | -| `outpostArn` | `string` | The Amazon Resource Name (ARN) of the Outpost. | -| `ownerId` | `string` | The ID of the Amazon Web Services account that owns the subnet. | -| `privateDnsNameOptionsOnLaunch` | `object` | Describes the options for instance hostnames. | -| `state` | `string` | The current state of the subnet. | -| `subnetArn` | `string` | The Amazon Resource Name (ARN) of the subnet. | -| `subnetId` | `string` | The ID of the subnet. | -| `tagSet` | `array` | Any tags assigned to the subnet. | -| `vpcId` | `string` | The ID of the VPC the subnet is in. | + + + + + +
NameDatatypeDescription
subnet_idstring
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `subnets_Describe` | `SELECT` | `region` | <p>Describes one or more of your subnets.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html">Your VPC and subnets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p> | -| `subnet_Create` | `INSERT` | `VpcId, region` | <p>Creates a subnet in a specified VPC.</p> <p>You must specify an IPv4 CIDR block for the subnet. After you create a subnet, you can't change its CIDR block. The allowed block size is between a /16 netmask (65,536 IP addresses) and /28 netmask (16 IP addresses). The CIDR block must not overlap with the CIDR block of an existing subnet in the VPC.</p> <p>If you've associated an IPv6 CIDR block with your VPC, you can create a subnet with an IPv6 CIDR block that uses a /64 prefix length. </p> <important> <p>Amazon Web Services reserves both the first four and the last IPv4 address in each subnet's CIDR block. They're not available for use.</p> </important> <p>If you add more than one subnet to a VPC, they're set up in a star topology with a logical router in the middle.</p> <p>When you stop an instance in a subnet, it retains its private IPv4 address. It's therefore possible to have a subnet with no running instances (they're all stopped), but no remaining IP addresses available.</p> <p>For more information about subnets, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html">Your VPC and subnets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p> | -| `subnet_Delete` | `DELETE` | `SubnetId, region` | Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet. | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +subnet_id +FROM aws.ec2.subnets +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the subnets resource, the following permissions are required: + +### Create +```json +ec2:DescribeSubnets, +ec2:CreateSubnet, +ec2:CreateTags, +ec2:ModifySubnetAttribute +``` + +### List +```json +ec2:DescribeSubnets, +ec2:DescribeNetworkAcls +``` + diff --git a/docs/aws-docs/providers/aws/ec2/tags/index.md b/docs/aws-docs/providers/aws/ec2/tags/index.md deleted file mode 100644 index cbac19d7ea..0000000000 --- a/docs/aws-docs/providers/aws/ec2/tags/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: tags -hide_title: false -hide_table_of_contents: false -keywords: - - tags - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nametags
TypeResource
Idaws.ec2.tags
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `key` | `string` | The tag key. | -| `resourceId` | `string` | The ID of the resource. | -| `resourceType` | `string` | The resource type. | -| `value` | `string` | The tag value. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `tags_Describe` | `SELECT` | `region` | <p>Describes the specified tags for your EC2 resources.</p> <p>For more information about tags, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html">Tagging Your Resources</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | -| `tags_Create` | `INSERT` | `ResourceId, Tag, region` | <p>Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.</p> <p>For more information about tags, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html">Tagging Your Resources</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. For more information about creating IAM policies that control users' access to resources based on tags, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-iam-actions-resources.html">Supported Resource-Level Permissions for Amazon EC2 API Actions</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | -| `tags_Delete` | `DELETE` | `ResourceId, region` | <p>Deletes the specified set of tags from the specified set of resources.</p> <p>To list the current tags, use <a>DescribeTags</a>. For more information about tags, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html">Tagging Your Resources</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2/traffic_mirror_filter_network_services/index.md b/docs/aws-docs/providers/aws/ec2/traffic_mirror_filter_network_services/index.md deleted file mode 100644 index c66eb52b87..0000000000 --- a/docs/aws-docs/providers/aws/ec2/traffic_mirror_filter_network_services/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: traffic_mirror_filter_network_services -hide_title: false -hide_table_of_contents: false -keywords: - - traffic_mirror_filter_network_services - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nametraffic_mirror_filter_network_services
TypeResource
Idaws.ec2.traffic_mirror_filter_network_services
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `traffic_mirror_filter_network_services_Modify` | `EXEC` | `TrafficMirrorFilterId, region` | diff --git a/docs/aws-docs/providers/aws/ec2/traffic_mirror_filter_rule/index.md b/docs/aws-docs/providers/aws/ec2/traffic_mirror_filter_rule/index.md deleted file mode 100644 index 7767d04a99..0000000000 --- a/docs/aws-docs/providers/aws/ec2/traffic_mirror_filter_rule/index.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: traffic_mirror_filter_rule -hide_title: false -hide_table_of_contents: false -keywords: - - traffic_mirror_filter_rule - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nametraffic_mirror_filter_rule
TypeResource
Idaws.ec2.traffic_mirror_filter_rule
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `traffic_mirror_filter_rule_Create` | `INSERT` | `DestinationCidrBlock, RuleAction, RuleNumber, SourceCidrBlock, TrafficDirection, TrafficMirrorFilterId, region` | <p>Creates a Traffic Mirror filter rule.</p> <p>A Traffic Mirror rule defines the Traffic Mirror source traffic to mirror.</p> <p>You need the Traffic Mirror filter ID when you create the rule.</p> | -| `traffic_mirror_filter_rule_Delete` | `DELETE` | `TrafficMirrorFilterRuleId, region` | Deletes the specified Traffic Mirror rule. | -| `traffic_mirror_filter_rule_Modify` | `EXEC` | `TrafficMirrorFilterRuleId, region` | <p>Modifies the specified Traffic Mirror rule.</p> <p> <code>DestinationCidrBlock</code> and <code>SourceCidrBlock</code> must both be an IPv4 range or an IPv6 range.</p> | diff --git a/docs/aws-docs/providers/aws/ec2/traffic_mirror_filters/index.md b/docs/aws-docs/providers/aws/ec2/traffic_mirror_filters/index.md deleted file mode 100644 index 8bb2ccfd59..0000000000 --- a/docs/aws-docs/providers/aws/ec2/traffic_mirror_filters/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: traffic_mirror_filters -hide_title: false -hide_table_of_contents: false -keywords: - - traffic_mirror_filters - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nametraffic_mirror_filters
TypeResource
Idaws.ec2.traffic_mirror_filters
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `description` | `string` | The description of the Traffic Mirror filter. | -| `egressFilterRuleSet` | `array` | Information about the egress rules that are associated with the Traffic Mirror filter. | -| `ingressFilterRuleSet` | `array` | Information about the ingress rules that are associated with the Traffic Mirror filter. | -| `networkServiceSet` | `array` | The network service traffic that is associated with the Traffic Mirror filter. | -| `tagSet` | `array` | The tags assigned to the Traffic Mirror filter. | -| `trafficMirrorFilterId` | `string` | The ID of the Traffic Mirror filter. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `traffic_mirror_filters_Describe` | `SELECT` | `region` | Describes one or more Traffic Mirror filters. | -| `traffic_mirror_filter_Create` | `INSERT` | `region` | <p>Creates a Traffic Mirror filter.</p> <p>A Traffic Mirror filter is a set of rules that defines the traffic to mirror.</p> <p>By default, no traffic is mirrored. To mirror traffic, use <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTrafficMirrorFilterRule.htm">CreateTrafficMirrorFilterRule</a> to add Traffic Mirror rules to the filter. The rules you add define what traffic gets mirrored. You can also use <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyTrafficMirrorFilterNetworkServices.html">ModifyTrafficMirrorFilterNetworkServices</a> to mirror supported network services.</p> | -| `traffic_mirror_filter_Delete` | `DELETE` | `TrafficMirrorFilterId, region` | <p>Deletes the specified Traffic Mirror filter.</p> <p>You cannot delete a Traffic Mirror filter that is in use by a Traffic Mirror session.</p> | diff --git a/docs/aws-docs/providers/aws/ec2/traffic_mirror_sessions/index.md b/docs/aws-docs/providers/aws/ec2/traffic_mirror_sessions/index.md deleted file mode 100644 index 3d296b39cd..0000000000 --- a/docs/aws-docs/providers/aws/ec2/traffic_mirror_sessions/index.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: traffic_mirror_sessions -hide_title: false -hide_table_of_contents: false -keywords: - - traffic_mirror_sessions - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nametraffic_mirror_sessions
TypeResource
Idaws.ec2.traffic_mirror_sessions
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `description` | `string` | The description of the Traffic Mirror session. | -| `networkInterfaceId` | `string` | The ID of the Traffic Mirror session's network interface. | -| `ownerId` | `string` | The ID of the account that owns the Traffic Mirror session. | -| `packetLength` | `integer` | The number of bytes in each packet to mirror. These are the bytes after the VXLAN header. To mirror a subset, set this to the length (in bytes) to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target. Do not specify this parameter when you want to mirror the entire packet | -| `sessionNumber` | `integer` | <p>The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.</p> <p>Valid values are 1-32766.</p> | -| `tagSet` | `array` | The tags assigned to the Traffic Mirror session. | -| `trafficMirrorFilterId` | `string` | The ID of the Traffic Mirror filter. | -| `trafficMirrorSessionId` | `string` | The ID for the Traffic Mirror session. | -| `trafficMirrorTargetId` | `string` | The ID of the Traffic Mirror target. | -| `virtualNetworkId` | `integer` | The virtual network ID associated with the Traffic Mirror session. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `traffic_mirror_sessions_Describe` | `SELECT` | `region` | Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results. | -| `traffic_mirror_session_Create` | `INSERT` | `NetworkInterfaceId, SessionNumber, TrafficMirrorFilterId, TrafficMirrorTargetId, region` | <p>Creates a Traffic Mirror session.</p> <p>A Traffic Mirror session actively copies packets from a Traffic Mirror source to a Traffic Mirror target. Create a filter, and then assign it to the session to define a subset of the traffic to mirror, for example all TCP traffic.</p> <p>The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in a different VPC connected via VPC peering or a transit gateway. </p> <p>By default, no traffic is mirrored. Use <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTrafficMirrorFilter.htm">CreateTrafficMirrorFilter</a> to create filter rules that specify the traffic to mirror.</p> | -| `traffic_mirror_session_Delete` | `DELETE` | `TrafficMirrorSessionId, region` | Deletes the specified Traffic Mirror session. | -| `traffic_mirror_session_Modify` | `EXEC` | `TrafficMirrorSessionId, region` | Modifies a Traffic Mirror session. | diff --git a/docs/aws-docs/providers/aws/ec2/traffic_mirror_targets/index.md b/docs/aws-docs/providers/aws/ec2/traffic_mirror_targets/index.md deleted file mode 100644 index 6e80729e61..0000000000 --- a/docs/aws-docs/providers/aws/ec2/traffic_mirror_targets/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: traffic_mirror_targets -hide_title: false -hide_table_of_contents: false -keywords: - - traffic_mirror_targets - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nametraffic_mirror_targets
TypeResource
Idaws.ec2.traffic_mirror_targets
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `description` | `string` | Information about the Traffic Mirror target. | -| `gatewayLoadBalancerEndpointId` | `string` | The ID of the Gateway Load Balancer endpoint. | -| `networkInterfaceId` | `string` | The network interface ID that is attached to the target. | -| `networkLoadBalancerArn` | `string` | The Amazon Resource Name (ARN) of the Network Load Balancer. | -| `ownerId` | `string` | The ID of the account that owns the Traffic Mirror target. | -| `tagSet` | `array` | The tags assigned to the Traffic Mirror target. | -| `trafficMirrorTargetId` | `string` | The ID of the Traffic Mirror target. | -| `type` | `string` | The type of Traffic Mirror target. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `traffic_mirror_targets_Describe` | `SELECT` | `region` | Information about one or more Traffic Mirror targets. | -| `traffic_mirror_target_Create` | `INSERT` | `region` | <p>Creates a target for your Traffic Mirror session.</p> <p>A Traffic Mirror target is the destination for mirrored traffic. The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in different VPCs connected via VPC peering or a transit gateway.</p> <p>A Traffic Mirror target can be a network interface, a Network Load Balancer, or a Gateway Load Balancer endpoint.</p> <p>To use the target in a Traffic Mirror session, use <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTrafficMirrorSession.htm">CreateTrafficMirrorSession</a>.</p> | -| `traffic_mirror_target_Delete` | `DELETE` | `TrafficMirrorTargetId, region` | <p>Deletes the specified Traffic Mirror target.</p> <p>You cannot delete a Traffic Mirror target that is in use by a Traffic Mirror session.</p> | diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway/index.md new file mode 100644 index 0000000000..872584d8cf --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway/index.md @@ -0,0 +1,134 @@ +--- +title: transit_gateway +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual transit_gateway resource + +## Overview + + + + + +
Nametransit_gateway
TypeResource
DescriptionResource Type definition for AWS::EC2::TransitGateway
Idaws.ec2.transit_gateway
+ +## Fields + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
descriptionstring
association_default_route_table_idstring
auto_accept_shared_attachmentsstring
transit_gateway_arnstring
default_route_table_propagationstring
transit_gateway_cidr_blocksarray
propagation_default_route_table_idstring
default_route_table_associationstring
idstring
vpn_ecmp_supportstring
dns_supportstring
multicast_supportstring
amazon_side_asninteger
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +description, +association_default_route_table_id, +auto_accept_shared_attachments, +transit_gateway_arn, +default_route_table_propagation, +transit_gateway_cidr_blocks, +propagation_default_route_table_id, +default_route_table_association, +id, +vpn_ecmp_support, +dns_support, +multicast_support, +amazon_side_asn, +tags +FROM aws.ec2.transit_gateway +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the transit_gateway resource, the following permissions are required: + +### Read +```json +ec2:CreateTransitGateway, +ec2:CreateTags, +ec2:DescribeTransitGateways, +ec2:DescribeTags, +ec2:DeleteTransitGateway, +ec2:DeleteTags, +ec2:ModifyTransitGateway, +ec2:ModifyTransitGatewayOptions +``` + +### Update +```json +ec2:CreateTransitGateway, +ec2:CreateTags, +ec2:DescribeTransitGateways, +ec2:DescribeTags, +ec2:DeleteTransitGateway, +ec2:DeleteTags, +ec2:ModifyTransitGateway, +ec2:ModifyTransitGatewayOptions +``` + +### Delete +```json +ec2:CreateTransitGateway, +ec2:CreateTags, +ec2:DescribeTransitGateways, +ec2:DescribeTags, +ec2:DeleteTransitGateway, +ec2:DeleteTags, +ec2:ModifyTransitGateway, +ec2:ModifyTransitGatewayOptions +``` + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_attachment/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_attachment/index.md new file mode 100644 index 0000000000..117163a858 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_attachment/index.md @@ -0,0 +1,120 @@ +--- +title: transit_gateway_attachment +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_attachment + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual transit_gateway_attachment resource + +## Overview + + + + + +
Nametransit_gateway_attachment
TypeResource
DescriptionResource Type definition for AWS::EC2::TransitGatewayAttachment
Idaws.ec2.transit_gateway_attachment
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
idstring
transit_gateway_idstring
vpc_idstring
subnet_idsarray
tagsarray
optionsobjectThe options for the transit gateway vpc attachment.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +transit_gateway_id, +vpc_id, +subnet_ids, +tags, +options +FROM aws.ec2.transit_gateway_attachment +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the transit_gateway_attachment resource, the following permissions are required: + +### Read +```json +ec2:DescribeTransitGatewayAttachments, +ec2:DescribeTransitGatewayVpcAttachments, +ec2:CreateTransitGatewayVpcAttachment, +ec2:DeleteTransitGatewayVpcAttachment, +ec2:CreateTags, +ec2:DeleteTags, +ec2:DescribeTags, +ec2:DescribeTransitGatewayAttachments, +ec2:ModifyTransitGatewayVpcAttachment +``` + +### Delete +```json +ec2:DescribeTransitGatewayAttachments, +ec2:DescribeTransitGatewayVpcAttachments, +ec2:CreateTransitGatewayVpcAttachment, +ec2:DeleteTransitGatewayVpcAttachment, +ec2:CreateTags, +ec2:DeleteTags, +ec2:DescribeTags, +ec2:DescribeTransitGatewayAttachments, +ec2:ModifyTransitGatewayVpcAttachment +``` + +### Update +```json +ec2:DescribeTransitGatewayAttachments, +ec2:DescribeTransitGatewayVpcAttachments, +ec2:DescribeTags, +ec2:CreateTransitGatewayVpcAttachment, +ec2:CreateTags, +ec2:DeleteTransitGatewayVpcAttachment, +ec2:DeleteTags, +ec2:ModifyTransitGatewayVpcAttachment +``` + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_attachment_propagations/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_attachment_propagations/index.md deleted file mode 100644 index 79f8d878a3..0000000000 --- a/docs/aws-docs/providers/aws/ec2/transit_gateway_attachment_propagations/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: transit_gateway_attachment_propagations -hide_title: false -hide_table_of_contents: false -keywords: - - transit_gateway_attachment_propagations - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nametransit_gateway_attachment_propagations
TypeResource
Idaws.ec2.transit_gateway_attachment_propagations
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `state` | `string` | The state of the propagation route table. | -| `transitGatewayRouteTableId` | `string` | The ID of the propagation route table. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `transit_gateway_attachment_propagations_Get` | `SELECT` | `TransitGatewayAttachmentId, region` | diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_attachments/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_attachments/index.md index 0da6b2e844..b4df451484 100644 --- a/docs/aws-docs/providers/aws/ec2/transit_gateway_attachments/index.md +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_attachments/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - transit_gateway_attachments - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,30 +14,79 @@ description: Query, deploy 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_attachments in a region ## Overview +
Nametransit_gateway_attachments
TypeResource
DescriptionResource Type definition for AWS::EC2::TransitGatewayAttachment
Idaws.ec2.transit_gateway_attachments
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `association` | `object` | Describes an association. | -| `creationTime` | `string` | The creation time. | -| `resourceId` | `string` | The ID of the resource. | -| `resourceOwnerId` | `string` | The ID of the Amazon Web Services account that owns the resource. | -| `resourceType` | `string` | The resource type. Note that the <code>tgw-peering</code> resource type has been deprecated. | -| `state` | `string` | The attachment state. Note that the <code>initiating</code> state has been deprecated. | -| `tagSet` | `array` | The tags for the attachment. | -| `transitGatewayAttachmentId` | `string` | The ID of the attachment. | -| `transitGatewayId` | `string` | The ID of the transit gateway. | -| `transitGatewayOwnerId` | `string` | The ID of the Amazon Web Services account that owns the transit gateway. | + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `transit_gateway_attachments_Describe` | `SELECT` | `region` | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.ec2.transit_gateway_attachments +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the transit_gateway_attachments resource, the following permissions are required: + +### Create +```json +ec2:DescribeTransitGatewayAttachments, +ec2:DescribeTransitGatewayVpcAttachments, +ec2:CreateTransitGatewayVpcAttachment, +ec2:DeleteTransitGatewayVpcAttachment, +ec2:CreateTags, +ec2:DeleteTags, +ec2:DescribeTags, +ec2:DescribeTransitGatewayAttachments, +ec2:ModifyTransitGatewayVpcAttachment +``` + +### List +```json +ec2:DescribeTransitGatewayAttachments, +ec2:DescribeTransitGatewayVpcAttachments, +ec2:DescribeTags, +ec2:CreateTransitGatewayVpcAttachment, +ec2:CreateTags, +ec2:DeleteTransitGatewayVpcAttachment, +ec2:DeleteTags, +ec2:ModifyTransitGatewayVpcAttachment +``` + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_connect/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_connect/index.md new file mode 100644 index 0000000000..a5049d7551 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_connect/index.md @@ -0,0 +1,103 @@ +--- +title: transit_gateway_connect +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_connect + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual transit_gateway_connect resource + +## Overview + + + + + +
Nametransit_gateway_connect
TypeResource
DescriptionThe AWS::EC2::TransitGatewayConnect type
Idaws.ec2.transit_gateway_connect
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
transit_gateway_attachment_idstringThe ID of the Connect attachment.
transport_transit_gateway_attachment_idstringThe ID of the attachment from which the Connect attachment was created.
transit_gateway_idstringThe ID of the transit gateway.
statestringThe state of the attachment.
creation_timestringThe creation time.
tagsarrayThe tags for the attachment.
optionsobjectThe Connect attachment options.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +transit_gateway_attachment_id, +transport_transit_gateway_attachment_id, +transit_gateway_id, +state, +creation_time, +tags, +options +FROM aws.ec2.transit_gateway_connect +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the transit_gateway_connect resource, the following permissions are required: + +### Read +```json +ec2:DescribeTransitGatewayConnects +``` + +### Update +```json +ec2:DescribeTransitGatewayConnects, +ec2:DeleteTags, +ec2:CreateTags +``` + +### Delete +```json +ec2:DeleteTransitGatewayConnect, +ec2:DescribeTransitGatewayConnects, +ec2:DeleteTags +``` + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_connect_peers/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_connect_peers/index.md deleted file mode 100644 index 516b4b1f4d..0000000000 --- a/docs/aws-docs/providers/aws/ec2/transit_gateway_connect_peers/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: transit_gateway_connect_peers -hide_title: false -hide_table_of_contents: false -keywords: - - transit_gateway_connect_peers - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nametransit_gateway_connect_peers
TypeResource
Idaws.ec2.transit_gateway_connect_peers
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `connectPeerConfiguration` | `object` | Describes the Connect peer details. | -| `creationTime` | `string` | The creation time. | -| `state` | `string` | The state of the Connect peer. | -| `tagSet` | `array` | The tags for the Connect peer. | -| `transitGatewayAttachmentId` | `string` | The ID of the Connect attachment. | -| `transitGatewayConnectPeerId` | `string` | The ID of the Connect peer. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `transit_gateway_connect_peers_Describe` | `SELECT` | `region` | Describes one or more Connect peers. | -| `transit_gateway_connect_peer_Create` | `INSERT` | `InsideCidrBlocks, PeerAddress, TransitGatewayAttachmentId, region` | <p>Creates a Connect peer for a specified transit gateway Connect attachment between a transit gateway and an appliance.</p> <p>The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).</p> <p>For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/tgw/tgw-connect.html#tgw-connect-peer">Connect peers</a> in the <i>Transit Gateways Guide</i>.</p> | -| `transit_gateway_connect_peer_Delete` | `DELETE` | `TransitGatewayConnectPeerId, region` | Deletes the specified Connect peer. | diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_connects/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_connects/index.md index c0a0e7d617..af71f659cb 100644 --- a/docs/aws-docs/providers/aws/ec2/transit_gateway_connects/index.md +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_connects/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - transit_gateway_connects - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,29 +14,66 @@ description: Query, deploy 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_connects in a region ## Overview +
Nametransit_gateway_connects
TypeResource
DescriptionThe AWS::EC2::TransitGatewayConnect type
Idaws.ec2.transit_gateway_connects
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `creationTime` | `string` | The creation time. | -| `options` | `object` | Describes the Connect attachment options. | -| `state` | `string` | The state of the attachment. | -| `tagSet` | `array` | The tags for the attachment. | -| `transitGatewayAttachmentId` | `string` | The ID of the Connect attachment. | -| `transitGatewayId` | `string` | The ID of the transit gateway. | -| `transportTransitGatewayAttachmentId` | `string` | The ID of the attachment from which the Connect attachment was created. | + + + + + +
NameDatatypeDescription
transit_gateway_attachment_idstringThe ID of the Connect attachment.
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `transit_gateway_connects_Describe` | `SELECT` | `region` | Describes one or more Connect attachments. | -| `transit_gateway_connect_Create` | `INSERT` | `Options, TransportTransitGatewayAttachmentId, region` | <p>Creates a Connect attachment from a specified transit gateway attachment. A Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a transit gateway and an appliance.</p> <p>A Connect attachment uses an existing VPC or Amazon Web Services Direct Connect attachment as the underlying transport mechanism.</p> | -| `transit_gateway_connect_Delete` | `DELETE` | `TransitGatewayAttachmentId, region` | Deletes the specified Connect attachment. You must first delete any Connect peers for the attachment. | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +transit_gateway_attachment_id +FROM aws.ec2.transit_gateway_connects +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the transit_gateway_connects resource, the following permissions are required: + +### Create +```json +ec2:CreateTransitGatewayConnect, +ec2:DescribeTransitGatewayConnects, +ec2:CreateTags +``` + +### List +```json +ec2:DescribeTransitGatewayConnects +``` + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_domain/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_domain/index.md new file mode 100644 index 0000000000..916c82c7bb --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_domain/index.md @@ -0,0 +1,103 @@ +--- +title: transit_gateway_multicast_domain +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_multicast_domain + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual transit_gateway_multicast_domain resource + +## Overview + + + + + +
Nametransit_gateway_multicast_domain
TypeResource
DescriptionThe AWS::EC2::TransitGatewayMulticastDomain type
Idaws.ec2.transit_gateway_multicast_domain
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
transit_gateway_multicast_domain_idstringThe ID of the transit gateway multicast domain.
transit_gateway_multicast_domain_arnstringThe Amazon Resource Name (ARN) of the transit gateway multicast domain.
transit_gateway_idstringThe ID of the transit gateway.
statestringThe state of the transit gateway multicast domain.
creation_timestringThe time the transit gateway multicast domain was created.
tagsarrayThe tags for the transit gateway multicast domain.
optionsobjectThe options for the transit gateway multicast domain.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +transit_gateway_multicast_domain_id, +transit_gateway_multicast_domain_arn, +transit_gateway_id, +state, +creation_time, +tags, +options +FROM aws.ec2.transit_gateway_multicast_domain +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the transit_gateway_multicast_domain resource, the following permissions are required: + +### Read +```json +ec2:DescribeTransitGatewayMulticastDomains +``` + +### Update +```json +ec2:DescribeTransitGatewayMulticastDomains, +ec2:DeleteTags, +ec2:CreateTags +``` + +### Delete +```json +ec2:DescribeTransitGatewayMulticastDomains, +ec2:DeleteTransitGatewayMulticastDomain, +ec2:DeleteTags +``` + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_domain_association/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_domain_association/index.md new file mode 100644 index 0000000000..064c3dd8b6 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_domain_association/index.md @@ -0,0 +1,88 @@ +--- +title: transit_gateway_multicast_domain_association +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_multicast_domain_association + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual transit_gateway_multicast_domain_association resource + +## Overview + + + + + +
Nametransit_gateway_multicast_domain_association
TypeResource
DescriptionThe AWS::EC2::TransitGatewayMulticastDomainAssociation type
Idaws.ec2.transit_gateway_multicast_domain_association
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
transit_gateway_multicast_domain_idstringThe ID of the transit gateway multicast domain.
transit_gateway_attachment_idstringThe ID of the transit gateway attachment.
resource_idstringThe ID of the resource.
resource_typestringThe type of resource, for example a VPC attachment.
statestringThe state of the subnet association.
subnet_idstringThe IDs of the subnets to associate with the transit gateway multicast domain.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +transit_gateway_multicast_domain_id, +transit_gateway_attachment_id, +resource_id, +resource_type, +state, +subnet_id +FROM aws.ec2.transit_gateway_multicast_domain_association +WHERE data__Identifier = '||'; +``` + +## Permissions + +To operate on the transit_gateway_multicast_domain_association resource, the following permissions are required: + +### Read +```json +ec2:GetTransitGatewayMulticastDomainAssociations +``` + +### Delete +```json +ec2:DisassociateTransitGatewayMulticastDomain, +ec2:GetTransitGatewayMulticastDomainAssociations +``` + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_domain_associations/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_domain_associations/index.md index 0690e0c490..551ea06ab6 100644 --- a/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_domain_associations/index.md +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_domain_associations/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - transit_gateway_multicast_domain_associations - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,27 +14,69 @@ description: Query, deploy 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_multicast_domain_associations in a region ## Overview +
Nametransit_gateway_multicast_domain_associations
TypeResource
DescriptionThe AWS::EC2::TransitGatewayMulticastDomainAssociation type
Idaws.ec2.transit_gateway_multicast_domain_associations
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `resourceId` | `string` | The ID of the resource. | -| `resourceOwnerId` | `string` | The ID of the Amazon Web Services account that owns the transit gateway multicast domain association resource. | -| `resourceType` | `string` | The type of resource, for example a VPC attachment. | -| `subnet` | `object` | Describes the subnet association with the transit gateway multicast domain. | -| `transitGatewayAttachmentId` | `string` | The ID of the transit gateway attachment. | + + + + + + + +
NameDatatypeDescription
transit_gateway_multicast_domain_idstringThe ID of the transit gateway multicast domain.
transit_gateway_attachment_idstringThe ID of the transit gateway attachment.
subnet_idstringThe IDs of the subnets to associate with the transit gateway multicast domain.
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `transit_gateway_multicast_domain_associations_Get` | `SELECT` | `region` | Gets information about the associations for the transit gateway multicast domain. | -| `transit_gateway_multicast_domain_associations_Accept` | `EXEC` | `region` | Accepts a request to associate subnets with a transit gateway multicast domain. | -| `transit_gateway_multicast_domain_associations_Reject` | `EXEC` | `region` | Rejects a request to associate cross-account subnets with a transit gateway multicast domain. | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +transit_gateway_multicast_domain_id, +transit_gateway_attachment_id, +subnet_id +FROM aws.ec2.transit_gateway_multicast_domain_associations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the transit_gateway_multicast_domain_associations resource, the following permissions are required: + +### Create +```json +ec2:AssociateTransitGatewayMulticastDomain, +ec2:GetTransitGatewayMulticastDomainAssociations +``` + +### List +```json +ec2:GetTransitGatewayMulticastDomainAssociations +``` + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_domains/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_domains/index.md index c6c8501185..81f7daa429 100644 --- a/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_domains/index.md +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_domains/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - transit_gateway_multicast_domains - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,32 +14,66 @@ description: Query, deploy 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_multicast_domains in a region ## Overview +
Nametransit_gateway_multicast_domains
TypeResource
DescriptionThe AWS::EC2::TransitGatewayMulticastDomain type
Idaws.ec2.transit_gateway_multicast_domains
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `creationTime` | `string` | The time the transit gateway multicast domain was created. | -| `options` | `object` | Describes the options for a transit gateway multicast domain. | -| `ownerId` | `string` | The ID of the Amazon Web Services account that owns the transit gateway multicast domain. | -| `state` | `string` | The state of the transit gateway multicast domain. | -| `tagSet` | `array` | The tags for the transit gateway multicast domain. | -| `transitGatewayId` | `string` | The ID of the transit gateway. | -| `transitGatewayMulticastDomainArn` | `string` | The Amazon Resource Name (ARN) of the transit gateway multicast domain. | -| `transitGatewayMulticastDomainId` | `string` | The ID of the transit gateway multicast domain. | + + + + + +
NameDatatypeDescription
transit_gateway_multicast_domain_idstringThe ID of the transit gateway multicast domain.
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `transit_gateway_multicast_domains_Describe` | `SELECT` | `region` | Describes one or more transit gateway multicast domains. | -| `transit_gateway_multicast_domain_Create` | `INSERT` | `TransitGatewayId, region` | <p>Creates a multicast domain using the specified transit gateway.</p> <p>The transit gateway must be in the available state before you create a domain. Use <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeTransitGateways.html">DescribeTransitGateways</a> to see the state of transit gateway.</p> | -| `transit_gateway_multicast_domain_Delete` | `DELETE` | `TransitGatewayMulticastDomainId, region` | Deletes the specified transit gateway multicast domain. | -| `transit_gateway_multicast_domain_Associate` | `EXEC` | `region` | <p>Associates the specified subnets and transit gateway attachments with the specified transit gateway multicast domain.</p> <p>The transit gateway attachment must be in the available state before you can add a resource. Use <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeTransitGatewayAttachments.html">DescribeTransitGatewayAttachments</a> to see the state of the attachment.</p> | -| `transit_gateway_multicast_domain_Disassociate` | `EXEC` | `region` | Disassociates the specified subnets from the transit gateway multicast domain. | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +transit_gateway_multicast_domain_id +FROM aws.ec2.transit_gateway_multicast_domains +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the transit_gateway_multicast_domains resource, the following permissions are required: + +### Create +```json +ec2:DescribeTransitGatewayMulticastDomains, +ec2:CreateTransitGatewayMulticastDomain, +ec2:CreateTags +``` + +### List +```json +ec2:DescribeTransitGatewayMulticastDomains +``` + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_group_member/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_group_member/index.md new file mode 100644 index 0000000000..ae513db785 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_group_member/index.md @@ -0,0 +1,98 @@ +--- +title: transit_gateway_multicast_group_member +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_multicast_group_member + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual transit_gateway_multicast_group_member resource + +## Overview + + + + + +
Nametransit_gateway_multicast_group_member
TypeResource
DescriptionThe AWS::EC2::TransitGatewayMulticastGroupMember registers and deregisters members and sources (network interfaces) with the transit gateway multicast group
Idaws.ec2.transit_gateway_multicast_group_member
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
group_ip_addressstringThe IP address assigned to the transit gateway multicast group.
transit_gateway_attachment_idstringThe ID of the transit gateway attachment.
transit_gateway_multicast_domain_idstringThe ID of the transit gateway multicast domain.
subnet_idstringThe ID of the subnet.
resource_idstringThe ID of the resource.
resource_typestringThe type of resource, for example a VPC attachment.
network_interface_idstringThe ID of the transit gateway attachment.
group_memberbooleanIndicates that the resource is a transit gateway multicast group member.
group_sourcebooleanIndicates that the resource is a transit gateway multicast group member.
member_typestringThe member type (for example, static).
source_typestringThe source type.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +group_ip_address, +transit_gateway_attachment_id, +transit_gateway_multicast_domain_id, +subnet_id, +resource_id, +resource_type, +network_interface_id, +group_member, +group_source, +member_type, +source_type +FROM aws.ec2.transit_gateway_multicast_group_member +WHERE data__Identifier = '||'; +``` + +## Permissions + +To operate on the transit_gateway_multicast_group_member resource, the following permissions are required: + +### Read +```json +ec2:SearchTransitGatewayMulticastGroups +``` + +### Delete +```json +ec2:DeregisterTransitGatewayMulticastGroupMembers, +ec2:SearchTransitGatewayMulticastGroups +``` + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_group_members/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_group_members/index.md index 719ffbfff7..587b4838b1 100644 --- a/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_group_members/index.md +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_group_members/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - transit_gateway_multicast_group_members - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,20 +14,69 @@ description: Query, deploy 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_multicast_group_members in a region ## Overview +
Nametransit_gateway_multicast_group_members
TypeResource
DescriptionThe AWS::EC2::TransitGatewayMulticastGroupMember registers and deregisters members and sources (network interfaces) with the transit gateway multicast group
Idaws.ec2.transit_gateway_multicast_group_members
## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command + + + + + + + +
NameDatatypeDescription
transit_gateway_multicast_domain_idstringThe ID of the transit gateway multicast domain.
group_ip_addressstringThe IP address assigned to the transit gateway multicast group.
network_interface_idstringThe ID of the transit gateway attachment.
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `transit_gateway_multicast_group_members_Deregister` | `EXEC` | `region` | Deregisters the specified members (network interfaces) from the transit gateway multicast group. | -| `transit_gateway_multicast_group_members_Register` | `EXEC` | `region` | <p>Registers members (network interfaces) with the transit gateway multicast group. A member is a network interface associated with a supported EC2 instance that receives multicast traffic. For information about supported instances, see <a href="https://docs.aws.amazon.com/vpc/latest/tgw/transit-gateway-limits.html#multicast-limits">Multicast Consideration</a> in <i>Amazon VPC Transit Gateways</i>.</p> <p>After you add the members, use <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SearchTransitGatewayMulticastGroups.html">SearchTransitGatewayMulticastGroups</a> to verify that the members were added to the transit gateway multicast group.</p> | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +transit_gateway_multicast_domain_id, +group_ip_address, +network_interface_id +FROM aws.ec2.transit_gateway_multicast_group_members +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the transit_gateway_multicast_group_members resource, the following permissions are required: + +### Create +```json +ec2:RegisterTransitGatewayMulticastGroupMembers, +ec2:SearchTransitGatewayMulticastGroups +``` + +### List +```json +ec2:SearchTransitGatewayMulticastGroups +``` + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_group_source/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_group_source/index.md new file mode 100644 index 0000000000..7b81a2fde1 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_group_source/index.md @@ -0,0 +1,98 @@ +--- +title: transit_gateway_multicast_group_source +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_multicast_group_source + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual transit_gateway_multicast_group_source resource + +## Overview + + + + + +
Nametransit_gateway_multicast_group_source
TypeResource
DescriptionThe AWS::EC2::TransitGatewayMulticastGroupSource registers and deregisters members and sources (network interfaces) with the transit gateway multicast group
Idaws.ec2.transit_gateway_multicast_group_source
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
group_ip_addressstringThe IP address assigned to the transit gateway multicast group.
transit_gateway_attachment_idstringThe ID of the transit gateway attachment.
transit_gateway_multicast_domain_idstringThe ID of the transit gateway multicast domain.
subnet_idstringThe ID of the subnet.
resource_idstringThe ID of the resource.
resource_typestringThe type of resource, for example a VPC attachment.
network_interface_idstringThe ID of the transit gateway attachment.
group_memberbooleanIndicates that the resource is a transit gateway multicast group member.
group_sourcebooleanIndicates that the resource is a transit gateway multicast group member.
member_typestringThe member type (for example, static).
source_typestringThe source type.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +group_ip_address, +transit_gateway_attachment_id, +transit_gateway_multicast_domain_id, +subnet_id, +resource_id, +resource_type, +network_interface_id, +group_member, +group_source, +member_type, +source_type +FROM aws.ec2.transit_gateway_multicast_group_source +WHERE data__Identifier = '||'; +``` + +## Permissions + +To operate on the transit_gateway_multicast_group_source resource, the following permissions are required: + +### Read +```json +ec2:SearchTransitGatewayMulticastGroups +``` + +### Delete +```json +ec2:DeregisterTransitGatewayMulticastGroupSources, +ec2:SearchTransitGatewayMulticastGroups +``` + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_group_sources/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_group_sources/index.md index 7bc9d8941e..1f6b3c58a2 100644 --- a/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_group_sources/index.md +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_group_sources/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - transit_gateway_multicast_group_sources - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,20 +14,69 @@ description: Query, deploy 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_multicast_group_sources in a region ## Overview +
Nametransit_gateway_multicast_group_sources
TypeResource
DescriptionThe AWS::EC2::TransitGatewayMulticastGroupSource registers and deregisters members and sources (network interfaces) with the transit gateway multicast group
Idaws.ec2.transit_gateway_multicast_group_sources
## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command + + + + + + + +
NameDatatypeDescription
transit_gateway_multicast_domain_idstringThe ID of the transit gateway multicast domain.
group_ip_addressstringThe IP address assigned to the transit gateway multicast group.
network_interface_idstringThe ID of the transit gateway attachment.
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `transit_gateway_multicast_group_sources_Deregister` | `EXEC` | `region` | Deregisters the specified sources (network interfaces) from the transit gateway multicast group. | -| `transit_gateway_multicast_group_sources_Register` | `EXEC` | `region` | <p>Registers sources (network interfaces) with the specified transit gateway multicast group.</p> <p>A multicast source is a network interface attached to a supported instance that sends multicast traffic. For information about supported instances, see <a href="https://docs.aws.amazon.com/vpc/latest/tgw/transit-gateway-limits.html#multicast-limits">Multicast Considerations</a> in <i>Amazon VPC Transit Gateways</i>.</p> <p>After you add the source, use <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SearchTransitGatewayMulticastGroups.html">SearchTransitGatewayMulticastGroups</a> to verify that the source was added to the multicast group.</p> | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +transit_gateway_multicast_domain_id, +group_ip_address, +network_interface_id +FROM aws.ec2.transit_gateway_multicast_group_sources +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the transit_gateway_multicast_group_sources resource, the following permissions are required: + +### Create +```json +ec2:RegisterTransitGatewayMulticastGroupSources, +ec2:SearchTransitGatewayMulticastGroups +``` + +### List +```json +ec2:SearchTransitGatewayMulticastGroups +``` + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_groups/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_groups/index.md deleted file mode 100644 index bf7487f2e3..0000000000 --- a/docs/aws-docs/providers/aws/ec2/transit_gateway_multicast_groups/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: transit_gateway_multicast_groups -hide_title: false -hide_table_of_contents: false -keywords: - - transit_gateway_multicast_groups - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nametransit_gateway_multicast_groups
TypeResource
Idaws.ec2.transit_gateway_multicast_groups
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `transit_gateway_multicast_groups_Search` | `EXEC` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_peering_attachment/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_peering_attachment/index.md new file mode 100644 index 0000000000..1d7071d469 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_peering_attachment/index.md @@ -0,0 +1,104 @@ +--- +title: transit_gateway_peering_attachment +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_peering_attachment + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual transit_gateway_peering_attachment resource + +## Overview + + + + + +
Nametransit_gateway_peering_attachment
TypeResource
DescriptionThe AWS::EC2::TransitGatewayPeeringAttachment type
Idaws.ec2.transit_gateway_peering_attachment
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
statusobjectThe status of the transit gateway peering attachment.
transit_gateway_idstringThe ID of the transit gateway.
peer_transit_gateway_idstringThe ID of the peer transit gateway.
peer_account_idstringThe ID of the peer account
statestringThe state of the transit gateway peering attachment. Note that the initiating state has been deprecated.
creation_timestringThe time the transit gateway peering attachment was created.
peer_regionstringPeer Region
tagsarrayThe tags for the transit gateway peering attachment.
transit_gateway_attachment_idstringThe ID of the transit gateway peering attachment.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +status, +transit_gateway_id, +peer_transit_gateway_id, +peer_account_id, +state, +creation_time, +peer_region, +tags, +transit_gateway_attachment_id +FROM aws.ec2.transit_gateway_peering_attachment +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the transit_gateway_peering_attachment resource, the following permissions are required: + +### Read +```json +ec2:DescribeTransitGatewayPeeringAttachments +``` + +### Update +```json +ec2:DescribeTransitGatewayPeeringAttachments +``` + +### Delete +```json +ec2:DeleteTransitGatewayPeeringAttachment, +ec2:DescribeTransitGatewayPeeringAttachments +``` + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_peering_attachments/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_peering_attachments/index.md index c421ea23dc..5f532c51a0 100644 --- a/docs/aws-docs/providers/aws/ec2/transit_gateway_peering_attachments/index.md +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_peering_attachments/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - transit_gateway_peering_attachments - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,31 +14,65 @@ description: Query, deploy 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_peering_attachments in a region ## Overview +
Nametransit_gateway_peering_attachments
TypeResource
DescriptionThe AWS::EC2::TransitGatewayPeeringAttachment type
Idaws.ec2.transit_gateway_peering_attachments
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `accepterTgwInfo` | `object` | Information about the transit gateway in the peering attachment. | -| `creationTime` | `string` | The time the transit gateway peering attachment was created. | -| `requesterTgwInfo` | `object` | Information about the transit gateway in the peering attachment. | -| `state` | `string` | The state of the transit gateway peering attachment. Note that the <code>initiating</code> state has been deprecated. | -| `status` | `object` | The status of the transit gateway peering attachment. | -| `tagSet` | `array` | The tags for the transit gateway peering attachment. | -| `transitGatewayAttachmentId` | `string` | The ID of the transit gateway peering attachment. | + + + + + +
NameDatatypeDescription
transit_gateway_attachment_idstringThe ID of the transit gateway peering attachment.
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `transit_gateway_peering_attachments_Describe` | `SELECT` | `region` | Describes your transit gateway peering attachments. | -| `transit_gateway_peering_attachment_Create` | `INSERT` | `PeerAccountId, PeerRegion, PeerTransitGatewayId, TransitGatewayId, region` | <p>Requests a transit gateway peering attachment between the specified transit gateway (requester) and a peer transit gateway (accepter). The transit gateways must be in different Regions. The peer transit gateway can be in your account or a different Amazon Web Services account.</p> <p>After you create the peering attachment, the owner of the accepter transit gateway must accept the attachment request.</p> | -| `transit_gateway_peering_attachment_Delete` | `DELETE` | `TransitGatewayAttachmentId, region` | Deletes a transit gateway peering attachment. | -| `transit_gateway_peering_attachment_Accept` | `EXEC` | `TransitGatewayAttachmentId, region` | Accepts a transit gateway peering attachment request. The peering attachment must be in the <code>pendingAcceptance</code> state. | -| `transit_gateway_peering_attachment_Reject` | `EXEC` | `TransitGatewayAttachmentId, region` | Rejects a transit gateway peering attachment request. | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +transit_gateway_attachment_id +FROM aws.ec2.transit_gateway_peering_attachments +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the transit_gateway_peering_attachments resource, the following permissions are required: + +### Create +```json +ec2:CreateTransitGatewayPeeringAttachment, +ec2:DescribeTransitGatewayPeeringAttachments +``` + +### List +```json +ec2:DescribeTransitGatewayPeeringAttachments +``` + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_prefix_list_references/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_prefix_list_references/index.md deleted file mode 100644 index 2eef6914b1..0000000000 --- a/docs/aws-docs/providers/aws/ec2/transit_gateway_prefix_list_references/index.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: transit_gateway_prefix_list_references -hide_title: false -hide_table_of_contents: false -keywords: - - transit_gateway_prefix_list_references - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nametransit_gateway_prefix_list_references
TypeResource
Idaws.ec2.transit_gateway_prefix_list_references
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `blackhole` | `boolean` | Indicates whether traffic that matches this route is dropped. | -| `prefixListId` | `string` | The ID of the prefix list. | -| `prefixListOwnerId` | `string` | The ID of the prefix list owner. | -| `state` | `string` | The state of the prefix list reference. | -| `transitGatewayAttachment` | `object` | Describes a transit gateway prefix list attachment. | -| `transitGatewayRouteTableId` | `string` | The ID of the transit gateway route table. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `transit_gateway_prefix_list_references_Get` | `SELECT` | `TransitGatewayRouteTableId, region` | Gets information about the prefix list references in a specified transit gateway route table. | -| `transit_gateway_prefix_list_reference_Create` | `INSERT` | `PrefixListId, TransitGatewayRouteTableId, region` | Creates a reference (route) to a prefix list in a specified transit gateway route table. | -| `transit_gateway_prefix_list_reference_Delete` | `DELETE` | `PrefixListId, TransitGatewayRouteTableId, region` | Deletes a reference (route) to a prefix list in a specified transit gateway route table. | -| `transit_gateway_prefix_list_reference_Modify` | `EXEC` | `PrefixListId, TransitGatewayRouteTableId, region` | Modifies a reference (route) to a prefix list in a specified transit gateway route table. | diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_route_table/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_route_table/index.md new file mode 100644 index 0000000000..d0a7971074 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_route_table/index.md @@ -0,0 +1,84 @@ +--- +title: transit_gateway_route_table +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_route_table + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual transit_gateway_route_table resource + +## Overview + + + + + +
Nametransit_gateway_route_table
TypeResource
DescriptionResource Type definition for AWS::EC2::TransitGatewayRouteTable
Idaws.ec2.transit_gateway_route_table
+ +## Fields + + + + + + + +
NameDatatypeDescription
transit_gateway_route_table_idstringTransit Gateway Route Table primary identifier
transit_gateway_idstringThe ID of the transit gateway.
tagsarrayTags are composed of a Key/Value pair. You can use tags to categorize and track each parameter group. The tag value null is permitted.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +transit_gateway_route_table_id, +transit_gateway_id, +tags +FROM aws.ec2.transit_gateway_route_table +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the transit_gateway_route_table resource, the following permissions are required: + +### Read +```json +ec2:DescribeTransitGatewayRouteTables +``` + +### Delete +```json +ec2:DeleteTransitGatewayRouteTable, +ec2:DescribeTransitGatewayRouteTables, +ec2:GetTransitGatewayRouteTableAssociations, +ec2:DisassociateTransitGatewayRouteTable +``` + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_route_table_association/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_route_table_association/index.md new file mode 100644 index 0000000000..9a01dfa628 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_route_table_association/index.md @@ -0,0 +1,80 @@ +--- +title: transit_gateway_route_table_association +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_route_table_association + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual transit_gateway_route_table_association resource + +## Overview + + + + + +
Nametransit_gateway_route_table_association
TypeResource
DescriptionResource Type definition for AWS::EC2::TransitGatewayRouteTableAssociation
Idaws.ec2.transit_gateway_route_table_association
+ +## Fields + + + + + + +
NameDatatypeDescription
transit_gateway_route_table_idstringThe ID of transit gateway route table.
transit_gateway_attachment_idstringThe ID of transit gateway attachment.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +transit_gateway_route_table_id, +transit_gateway_attachment_id +FROM aws.ec2.transit_gateway_route_table_association +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the transit_gateway_route_table_association resource, the following permissions are required: + +### Read +```json +ec2:GetTransitGatewayRouteTableAssociations +``` + +### Delete +```json +ec2:GetTransitGatewayRouteTableAssociations, +ec2:DisassociateTransitGatewayRouteTable +``` + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_route_table_associations/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_route_table_associations/index.md index ae4906f405..b665271baa 100644 --- a/docs/aws-docs/providers/aws/ec2/transit_gateway_route_table_associations/index.md +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_route_table_associations/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - transit_gateway_route_table_associations - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,24 +14,67 @@ description: Query, deploy 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_associations in a region ## Overview +
Nametransit_gateway_route_table_associations
TypeResource
DescriptionResource Type definition for AWS::EC2::TransitGatewayRouteTableAssociation
Idaws.ec2.transit_gateway_route_table_associations
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `resourceId` | `string` | The ID of the resource. | -| `resourceType` | `string` | The resource type. Note that the <code>tgw-peering</code> resource type has been deprecated. | -| `state` | `string` | The state of the association. | -| `transitGatewayAttachmentId` | `string` | The ID of the attachment. | + + + + + + +
NameDatatypeDescription
transit_gateway_route_table_idstringThe ID of transit gateway route table.
transit_gateway_attachment_idstringThe ID of transit gateway attachment.
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `transit_gateway_route_table_associations_Get` | `SELECT` | `TransitGatewayRouteTableId, region` | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +transit_gateway_route_table_id, +transit_gateway_attachment_id +FROM aws.ec2.transit_gateway_route_table_associations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the transit_gateway_route_table_associations resource, the following permissions are required: + +### Create +```json +ec2:AssociateTransitGatewayRouteTable, +ec2:GetTransitGatewayRouteTableAssociations +``` + +### List +```json +ec2:GetTransitGatewayRouteTableAssociations +``` + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_route_table_propagations/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_route_table_propagations/index.md deleted file mode 100644 index 2eef882d46..0000000000 --- a/docs/aws-docs/providers/aws/ec2/transit_gateway_route_table_propagations/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: transit_gateway_route_table_propagations -hide_title: false -hide_table_of_contents: false -keywords: - - transit_gateway_route_table_propagations - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nametransit_gateway_route_table_propagations
TypeResource
Idaws.ec2.transit_gateway_route_table_propagations
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `resourceId` | `string` | The ID of the resource. | -| `resourceType` | `string` | The type of resource. Note that the <code>tgw-peering</code> resource type has been deprecated. | -| `state` | `string` | The state of the resource. | -| `transitGatewayAttachmentId` | `string` | The ID of the attachment. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `transit_gateway_route_table_propagations_Get` | `SELECT` | `TransitGatewayRouteTableId, region` | Gets information about the route table propagations for the specified transit gateway route table. | -| `transit_gateway_route_table_propagation_Disable` | `EXEC` | `TransitGatewayAttachmentId, TransitGatewayRouteTableId, region` | Disables the specified resource attachment from propagating routes to the specified propagation route table. | -| `transit_gateway_route_table_propagation_Enable` | `EXEC` | `TransitGatewayAttachmentId, TransitGatewayRouteTableId, region` | Enables the specified attachment to propagate routes to the specified propagation route table. | diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_route_tables/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_route_tables/index.md index 25190474d7..a712d1e694 100644 --- a/docs/aws-docs/providers/aws/ec2/transit_gateway_route_tables/index.md +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_route_tables/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - transit_gateway_route_tables - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,31 +14,66 @@ description: Query, deploy 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_tables in a region ## Overview +
Nametransit_gateway_route_tables
TypeResource
DescriptionResource Type definition for AWS::EC2::TransitGatewayRouteTable
Idaws.ec2.transit_gateway_route_tables
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `creationTime` | `string` | The creation time. | -| `defaultAssociationRouteTable` | `boolean` | Indicates whether this is the default association route table for the transit gateway. | -| `defaultPropagationRouteTable` | `boolean` | Indicates whether this is the default propagation route table for the transit gateway. | -| `state` | `string` | The state of the transit gateway route table. | -| `tagSet` | `array` | Any tags assigned to the route table. | -| `transitGatewayId` | `string` | The ID of the transit gateway. | -| `transitGatewayRouteTableId` | `string` | The ID of the transit gateway route table. | + + + + + +
NameDatatypeDescription
transit_gateway_route_table_idstringTransit Gateway Route Table primary identifier
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `transit_gateway_route_tables_Describe` | `SELECT` | `region` | Describes one or more transit gateway route tables. By default, all transit gateway route tables are described. Alternatively, you can filter the results. | -| `transit_gateway_route_table_Create` | `INSERT` | `TransitGatewayId, region` | Creates a route table for the specified transit gateway. | -| `transit_gateway_route_table_Delete` | `DELETE` | `TransitGatewayRouteTableId, region` | Deletes the specified transit gateway route table. You must disassociate the route table from any transit gateway route tables before you can delete it. | -| `transit_gateway_route_table_Associate` | `EXEC` | `TransitGatewayAttachmentId, TransitGatewayRouteTableId, region` | Associates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment. | -| `transit_gateway_route_table_Disassociate` | `EXEC` | `TransitGatewayAttachmentId, TransitGatewayRouteTableId, region` | Disassociates a resource attachment from a transit gateway route table. | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +transit_gateway_route_table_id +FROM aws.ec2.transit_gateway_route_tables +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the transit_gateway_route_tables resource, the following permissions are required: + +### Create +```json +ec2:CreateTransitGatewayRouteTable, +ec2:CreateTags, +ec2:DescribeTransitGatewayRouteTables +``` + +### List +```json +ec2:DescribeTransitGatewayRouteTables +``` + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_routes/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_routes/index.md deleted file mode 100644 index e6f358eedc..0000000000 --- a/docs/aws-docs/providers/aws/ec2/transit_gateway_routes/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: transit_gateway_routes -hide_title: false -hide_table_of_contents: false -keywords: - - transit_gateway_routes - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nametransit_gateway_routes
TypeResource
Idaws.ec2.transit_gateway_routes
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `transit_gateway_route_Create` | `INSERT` | `DestinationCidrBlock, TransitGatewayRouteTableId, region` | Creates a static route for the specified transit gateway route table. | -| `transit_gateway_route_Delete` | `DELETE` | `DestinationCidrBlock, TransitGatewayRouteTableId, region` | Deletes the specified route from the specified transit gateway route table. | -| `transit_gateway_route_Replace` | `EXEC` | `DestinationCidrBlock, TransitGatewayRouteTableId, region` | Replaces the specified route in the specified transit gateway route table. | -| `transit_gateway_routes_Export` | `EXEC` | `S3Bucket, TransitGatewayRouteTableId, region` | <p>Exports routes from the specified transit gateway route table to the specified S3 bucket. By default, all routes are exported. Alternatively, you can filter by CIDR range.</p> <p>The routes are saved to the specified bucket in a JSON file. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/tgw/tgw-route-tables.html#tgw-export-route-tables">Export Route Tables to Amazon S3</a> in <i>Transit Gateways</i>.</p> | -| `transit_gateway_routes_Search` | `EXEC` | `Filter, TransitGatewayRouteTableId, region` | Searches for routes in the specified transit gateway route table. | diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_vpc_attachment/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_vpc_attachment/index.md new file mode 100644 index 0000000000..3d26cee965 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_vpc_attachment/index.md @@ -0,0 +1,124 @@ +--- +title: transit_gateway_vpc_attachment +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_vpc_attachment + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual transit_gateway_vpc_attachment resource + +## Overview + + + + + +
Nametransit_gateway_vpc_attachment
TypeResource
DescriptionResource Type definition for AWS::EC2::TransitGatewayVpcAttachment
Idaws.ec2.transit_gateway_vpc_attachment
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
optionsobjectThe options for the transit gateway vpc attachment.
transit_gateway_idstring
vpc_idstring
remove_subnet_idsarray
idstring
subnet_idsarray
add_subnet_idsarray
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +options, +transit_gateway_id, +vpc_id, +remove_subnet_ids, +id, +subnet_ids, +add_subnet_ids, +tags +FROM aws.ec2.transit_gateway_vpc_attachment +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the transit_gateway_vpc_attachment resource, the following permissions are required: + +### Read +```json +ec2:DescribeTransitGatewayAttachments, +ec2:DescribeTransitGatewayVpcAttachments, +ec2:CreateTransitGatewayVpcAttachment, +ec2:DeleteTransitGatewayVpcAttachment, +ec2:CreateTags, +ec2:DeleteTags, +ec2:DescribeTags, +ec2:DescribeTransitGatewayAttachments, +ec2:ModifyTransitGatewayVpcAttachment +``` + +### Update +```json +ec2:DescribeTransitGatewayAttachments, +ec2:DescribeTransitGatewayVpcAttachments, +ec2:DescribeTags, +ec2:CreateTransitGatewayVpcAttachment, +ec2:CreateTags, +ec2:DeleteTransitGatewayVpcAttachment, +ec2:DeleteTags, +ec2:ModifyTransitGatewayVpcAttachment +``` + +### Delete +```json +ec2:DescribeTransitGatewayAttachments, +ec2:DescribeTransitGatewayVpcAttachments, +ec2:CreateTransitGatewayVpcAttachment, +ec2:DeleteTransitGatewayVpcAttachment, +ec2:CreateTags, +ec2:DeleteTags, +ec2:DescribeTags, +ec2:DescribeTransitGatewayAttachments, +ec2:ModifyTransitGatewayVpcAttachment +``` + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateway_vpc_attachments/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateway_vpc_attachments/index.md index 6bba6eb4fc..6993d8ba7c 100644 --- a/docs/aws-docs/providers/aws/ec2/transit_gateway_vpc_attachments/index.md +++ b/docs/aws-docs/providers/aws/ec2/transit_gateway_vpc_attachments/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - transit_gateway_vpc_attachments - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,34 +14,79 @@ description: Query, deploy 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_vpc_attachments in a region ## Overview +
Nametransit_gateway_vpc_attachments
TypeResource
DescriptionResource Type definition for AWS::EC2::TransitGatewayVpcAttachment
Idaws.ec2.transit_gateway_vpc_attachments
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `creationTime` | `string` | The creation time. | -| `options` | `object` | Describes the VPC attachment options. | -| `state` | `string` | The state of the VPC attachment. Note that the <code>initiating</code> state has been deprecated. | -| `subnetIds` | `array` | The IDs of the subnets. | -| `tagSet` | `array` | The tags for the VPC attachment. | -| `transitGatewayAttachmentId` | `string` | The ID of the attachment. | -| `transitGatewayId` | `string` | The ID of the transit gateway. | -| `vpcId` | `string` | The ID of the VPC. | -| `vpcOwnerId` | `string` | The ID of the Amazon Web Services account that owns the VPC. | + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `transit_gateway_vpc_attachments_Describe` | `SELECT` | `region` | Describes one or more VPC attachments. By default, all VPC attachments are described. Alternatively, you can filter the results. | -| `transit_gateway_vpc_attachment_Create` | `INSERT` | `SubnetIds, TransitGatewayId, VpcId, region` | <p>Attaches the specified VPC to the specified transit gateway.</p> <p>If you attach a VPC with a CIDR range that overlaps the CIDR range of a VPC that is already attached, the new VPC CIDR range is not propagated to the default propagation route table.</p> <p>To send VPC traffic to an attached transit gateway, add a route to the VPC route table using <a>CreateRoute</a>.</p> | -| `transit_gateway_vpc_attachment_Delete` | `DELETE` | `TransitGatewayAttachmentId, region` | Deletes the specified VPC attachment. | -| `transit_gateway_vpc_attachment_Accept` | `EXEC` | `TransitGatewayAttachmentId, region` | <p>Accepts a request to attach a VPC to a transit gateway.</p> <p>The VPC attachment must be in the <code>pendingAcceptance</code> state. Use <a>DescribeTransitGatewayVpcAttachments</a> to view your pending VPC attachment requests. Use <a>RejectTransitGatewayVpcAttachment</a> to reject a VPC attachment request.</p> | -| `transit_gateway_vpc_attachment_Modify` | `EXEC` | `TransitGatewayAttachmentId, region` | Modifies the specified VPC attachment. | -| `transit_gateway_vpc_attachment_Reject` | `EXEC` | `TransitGatewayAttachmentId, region` | <p>Rejects a request to attach a VPC to a transit gateway.</p> <p>The VPC attachment must be in the <code>pendingAcceptance</code> state. Use <a>DescribeTransitGatewayVpcAttachments</a> to view your pending VPC attachment requests. Use <a>AcceptTransitGatewayVpcAttachment</a> to accept a VPC attachment request.</p> | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.ec2.transit_gateway_vpc_attachments +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the transit_gateway_vpc_attachments resource, the following permissions are required: + +### Create +```json +ec2:DescribeTransitGatewayAttachments, +ec2:DescribeTransitGatewayVpcAttachments, +ec2:CreateTransitGatewayVpcAttachment, +ec2:DeleteTransitGatewayVpcAttachment, +ec2:CreateTags, +ec2:DeleteTags, +ec2:DescribeTags, +ec2:DescribeTransitGatewayAttachments, +ec2:ModifyTransitGatewayVpcAttachment +``` + +### List +```json +ec2:DescribeTransitGatewayAttachments, +ec2:DescribeTransitGatewayVpcAttachments, +ec2:DescribeTags, +ec2:CreateTransitGatewayVpcAttachment, +ec2:CreateTags, +ec2:DeleteTransitGatewayVpcAttachment, +ec2:DeleteTags, +ec2:ModifyTransitGatewayVpcAttachment +``` + diff --git a/docs/aws-docs/providers/aws/ec2/transit_gateways/index.md b/docs/aws-docs/providers/aws/ec2/transit_gateways/index.md index 6e8434aa94..27e9ab4db8 100644 --- a/docs/aws-docs/providers/aws/ec2/transit_gateways/index.md +++ b/docs/aws-docs/providers/aws/ec2/transit_gateways/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - transit_gateways - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,31 +14,78 @@ description: Query, deploy 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_gateways in a region ## Overview +
Nametransit_gateways
TypeResource
DescriptionResource Type definition for AWS::EC2::TransitGateway
Idaws.ec2.transit_gateways
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `description` | `string` | The description of the transit gateway. | -| `creationTime` | `string` | The creation time. | -| `options` | `object` | Describes the options for a transit gateway. | -| `ownerId` | `string` | The ID of the Amazon Web Services account that owns the transit gateway. | -| `state` | `string` | The state of the transit gateway. | -| `tagSet` | `array` | The tags for the transit gateway. | -| `transitGatewayArn` | `string` | The Amazon Resource Name (ARN) of the transit gateway. | -| `transitGatewayId` | `string` | The ID of the transit gateway. | + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `transit_gateways_Describe` | `SELECT` | `region` | Describes one or more transit gateways. By default, all transit gateways are described. Alternatively, you can filter the results. | -| `transit_gateway_Create` | `INSERT` | `region` | <p>Creates a transit gateway.</p> <p>You can use a transit gateway to interconnect your virtual private clouds (VPC) and on-premises networks. After the transit gateway enters the <code>available</code> state, you can attach your VPCs and VPN connections to the transit gateway.</p> <p>To attach your VPCs, use <a>CreateTransitGatewayVpcAttachment</a>.</p> <p>To attach a VPN connection, use <a>CreateCustomerGateway</a> to create a customer gateway and specify the ID of the customer gateway and the ID of the transit gateway in a call to <a>CreateVpnConnection</a>.</p> <p>When you create a transit gateway, we create a default transit gateway route table and use it as the default association route table and the default propagation route table. You can use <a>CreateTransitGatewayRouteTable</a> to create additional transit gateway route tables. If you disable automatic route propagation, we do not create a default transit gateway route table. You can use <a>EnableTransitGatewayRouteTablePropagation</a> to propagate routes from a resource attachment to a transit gateway route table. If you disable automatic associations, you can use <a>AssociateTransitGatewayRouteTable</a> to associate a resource attachment with a transit gateway route table.</p> | -| `transit_gateway_Delete` | `DELETE` | `TransitGatewayId, region` | Deletes the specified transit gateway. | -| `transit_gateway_Modify` | `EXEC` | `TransitGatewayId, region` | Modifies the specified transit gateway. When you modify a transit gateway, the modified options are applied to new transit gateway attachments only. Your existing transit gateway attachments are not modified. | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.ec2.transit_gateways +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the transit_gateways resource, the following permissions are required: + +### Create +```json +ec2:CreateTransitGateway, +ec2:CreateTags, +ec2:DescribeTransitGateways, +ec2:DescribeTags, +ec2:DeleteTransitGateway, +ec2:DeleteTags, +ec2:ModifyTransitGateway, +ec2:ModifyTransitGatewayOptions +``` + +### List +```json +ec2:CreateTransitGateway, +ec2:CreateTags, +ec2:DescribeTransitGateways, +ec2:DescribeTags, +ec2:DeleteTransitGateway, +ec2:DeleteTags, +ec2:ModifyTransitGateway, +ec2:ModifyTransitGatewayOptions +``` + diff --git a/docs/aws-docs/providers/aws/ec2/trunk_interface/index.md b/docs/aws-docs/providers/aws/ec2/trunk_interface/index.md deleted file mode 100644 index d832ad3a0d..0000000000 --- a/docs/aws-docs/providers/aws/ec2/trunk_interface/index.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: trunk_interface -hide_title: false -hide_table_of_contents: false -keywords: - - trunk_interface - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nametrunk_interface
TypeResource
Idaws.ec2.trunk_interface
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `trunk_interface_Associate` | `EXEC` | `BranchInterfaceId, TrunkInterfaceId, region` | <note> <p>This API action is currently in <b>limited preview only</b>. If you are interested in using this feature, contact your account manager.</p> </note> <p>Associates a branch network interface with a trunk network interface.</p> <p>Before you create the association, run the <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateNetworkInterface.html">create-network-interface</a> command and set <code>--interface-type</code> to <code>trunk</code>. You must also create a network interface for each branch network interface that you want to associate with the trunk network interface.</p> | -| `trunk_interface_Disassociate` | `EXEC` | `AssociationId, region` | <note> <p>This API action is currently in <b>limited preview only</b>. If you are interested in using this feature, contact your account manager.</p> </note> <p>Removes an association between a branch network interface with a trunk network interface.</p> | diff --git a/docs/aws-docs/providers/aws/ec2/trunk_interface_associations/index.md b/docs/aws-docs/providers/aws/ec2/trunk_interface_associations/index.md deleted file mode 100644 index 910bc07cb8..0000000000 --- a/docs/aws-docs/providers/aws/ec2/trunk_interface_associations/index.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: trunk_interface_associations -hide_title: false -hide_table_of_contents: false -keywords: - - trunk_interface_associations - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nametrunk_interface_associations
TypeResource
Idaws.ec2.trunk_interface_associations
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `associationId` | `string` | The ID of the association. | -| `branchInterfaceId` | `string` | The ID of the branch network interface. | -| `greKey` | `integer` | The application key when you use the GRE protocol. | -| `interfaceProtocol` | `string` | The interface protocol. Valid values are <code>VLAN</code> and <code>GRE</code>. | -| `tagSet` | `array` | The tags for the trunk interface association. | -| `trunkInterfaceId` | `string` | The ID of the trunk network interface. | -| `vlanId` | `integer` | The ID of the VLAN when you use the VLAN protocol. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `trunk_interface_associations_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2/verified_access_endpoint/index.md b/docs/aws-docs/providers/aws/ec2/verified_access_endpoint/index.md new file mode 100644 index 0000000000..07d95aa1b6 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/verified_access_endpoint/index.md @@ -0,0 +1,220 @@ +--- +title: verified_access_endpoint +hide_title: false +hide_table_of_contents: false +keywords: + - verified_access_endpoint + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual verified_access_endpoint resource + +## Overview + + + + + +
Nameverified_access_endpoint
TypeResource
DescriptionThe AWS::EC2::VerifiedAccessEndpoint resource creates an AWS EC2 Verified Access Endpoint.
Idaws.ec2.verified_access_endpoint
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
verified_access_endpoint_idstringThe ID of the AWS Verified Access endpoint.
verified_access_group_idstringThe ID of the AWS Verified Access group.
verified_access_instance_idstringThe ID of the AWS Verified Access instance.
statusstringThe endpoint status.
security_group_idsarrayThe IDs of the security groups for the endpoint.
network_interface_optionsobjectThe options for network-interface type endpoint.
load_balancer_optionsobjectThe load balancer details if creating the AWS Verified Access endpoint as load-balancer type.
endpoint_typestringThe type of AWS Verified Access endpoint. Incoming application requests will be sent to an IP address, load balancer or a network interface depending on the endpoint type specified.The type of AWS Verified Access endpoint. Incoming application requests will be sent to an IP address, load balancer or a network interface depending on the endpoint type specified.
endpoint_domainstringA DNS name that is generated for the endpoint.
endpoint_domain_prefixstringA custom identifier that gets prepended to a DNS name that is generated for the endpoint.
device_validation_domainstringReturned if endpoint has a device trust provider attached.
domain_certificate_arnstringThe ARN of a public TLS/SSL certificate imported into or created with ACM.
attachment_typestringThe type of attachment used to provide connectivity between the AWS Verified Access endpoint and the application.
application_domainstringThe DNS name for users to reach your application.
creation_timestringThe creation time.
last_updated_timestringThe last updated time.
descriptionstringA description for the AWS Verified Access endpoint.
policy_documentstringThe AWS Verified Access policy document.
policy_enabledbooleanThe status of the Verified Access policy.
tagsarrayAn array of key-value pairs to apply to this resource.
sse_specificationobjectThe configuration options for customer provided KMS encryption.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +verified_access_endpoint_id, +verified_access_group_id, +verified_access_instance_id, +status, +security_group_ids, +network_interface_options, +load_balancer_options, +endpoint_type, +endpoint_domain, +endpoint_domain_prefix, +device_validation_domain, +domain_certificate_arn, +attachment_type, +application_domain, +creation_time, +last_updated_time, +description, +policy_document, +policy_enabled, +tags, +sse_specification +FROM aws.ec2.verified_access_endpoint +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the verified_access_endpoint resource, the following permissions are required: + +### Read +```json +ec2:DescribeVerifiedAccessEndpoints, +ec2:GetVerifiedAccessEndpointPolicy, +ec2:DescribeTags, +acm:CreateCertificateRelation, +acm:DeleteCertificateRelation, +acm:DescribeCertificate, +acm:GetCertificateWithPK, +ec2:CreateTags, +ec2:CreateVerifiedAccessEndpoint, +ec2:DeleteTags, +ec2:DeleteVerifiedAccessEndpoint, +ec2:DescribeAccountAttributes, +ec2:DescribeNetworkInterfaces, +ec2:DescribeSecurityGroups, +ec2:DescribeSubnets, +ec2:ModifyVerifiedAccessEndpoint, +ec2:ModifyVerifiedAccessEndpointPolicy, +elasticloadbalancing:DescribeListenerCertificates, +elasticloadbalancing:DescribeListeners, +elasticloadbalancing:DescribeLoadBalancers, +iam:CreateServiceLinkedRole, +iam:ListRoles, +sso:CreateManagedApplicationInstance, +sso:DeleteManagedApplicationInstance, +sso:GetManagedApplicationInstance, +sso:GetPeregrineStatus, +sso:GetSharedSsoConfiguration, +kms:DescribeKey, +kms:RetireGrant, +kms:CreateGrant, +kms:GenerateDataKey, +kms:Decrypt +``` + +### Update +```json +ec2:ModifyVerifiedAccessEndpoint, +ec2:ModifyVerifiedAccessEndpointPolicy, +ec2:DescribeVerifiedAccessEndpoints, +ec2:GetVerifiedAccessEndpointPolicy, +ec2:DescribeTags, +ec2:DeleteTags, +ec2:CreateTags, +acm:GetCertificateWithPK, +acm:DescribeCertificate, +acm:CreateCertificateRelation, +acm:DeleteCertificateRelation, +sso:GetManagedApplicationInstance, +sso:GetPeregrineStatus, +sso:GetSharedSsoConfiguration, +sso:CreateManagedApplicationInstance, +sso:DeleteManagedApplicationInstance, +ec2:DescribeSubnets, +ec2:DescribeSecurityGroups, +ec2:DescribeNetworkInterfaces, +ec2:DescribeAccountAttributes, +elasticloadbalancing:DescribeLoadBalancers, +elasticloadbalancing:DescribeListeners, +elasticloadbalancing:DescribeListenerCertificates, +ec2:CreateVerifiedAccessEndpoint, +ec2:DeleteVerifiedAccessEndpoint, +iam:CreateServiceLinkedRole, +iam:ListRoles, +kms:DescribeKey, +kms:RetireGrant, +kms:CreateGrant, +kms:GenerateDataKey, +kms:Decrypt +``` + +### Delete +```json +ec2:DescribeVerifiedAccessEndpoints, +ec2:DescribeTags, +ec2:DeleteVerifiedAccessEndpoint, +ec2:DeleteTags, +sso:DeleteManagedApplicationInstance, +acm:DeleteCertificateRelation, +acm:DescribeCertificate, +acm:CreateCertificateRelation, +acm:GetCertificateWithPK, +ec2:CreateTags, +ec2:CreateVerifiedAccessEndpoint, +ec2:DescribeAccountAttributes, +ec2:DescribeNetworkInterfaces, +ec2:DescribeSecurityGroups, +ec2:DescribeSubnets, +ec2:GetVerifiedAccessEndpointPolicy, +ec2:ModifyVerifiedAccessEndpoint, +ec2:ModifyVerifiedAccessEndpointPolicy, +elasticloadbalancing:DescribeListenerCertificates, +elasticloadbalancing:DescribeListeners, +elasticloadbalancing:DescribeLoadBalancers, +iam:CreateServiceLinkedRole, +iam:ListRoles, +sso:CreateManagedApplicationInstance, +sso:GetManagedApplicationInstance, +sso:GetPeregrineStatus, +sso:GetSharedSsoConfiguration, +kms:DescribeKey, +kms:RetireGrant, +kms:CreateGrant, +kms:GenerateDataKey, +kms:Decrypt +``` + diff --git a/docs/aws-docs/providers/aws/ec2/verified_access_endpoints/index.md b/docs/aws-docs/providers/aws/ec2/verified_access_endpoints/index.md new file mode 100644 index 0000000000..8a424faabc --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/verified_access_endpoints/index.md @@ -0,0 +1,139 @@ +--- +title: verified_access_endpoints +hide_title: false +hide_table_of_contents: false +keywords: + - verified_access_endpoints + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Retrieves a list of verified_access_endpoints in a region + +## Overview + + + + + +
Nameverified_access_endpoints
TypeResource
DescriptionThe AWS::EC2::VerifiedAccessEndpoint resource creates an AWS EC2 Verified Access Endpoint.
Idaws.ec2.verified_access_endpoints
+ +## Fields + + + + + +
NameDatatypeDescription
verified_access_endpoint_idstringThe ID of the AWS Verified Access endpoint.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +verified_access_endpoint_id +FROM aws.ec2.verified_access_endpoints +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the verified_access_endpoints resource, the following permissions are required: + +### Create +```json +ec2:CreateVerifiedAccessEndpoint, +ec2:DescribeVerifiedAccessEndpoints, +ec2:CreateTags, +ec2:DescribeTags, +iam:CreateServiceLinkedRole, +iam:ListRoles, +acm:GetCertificateWithPK, +acm:DescribeCertificate, +acm:CreateCertificateRelation, +sso:GetManagedApplicationInstance, +sso:GetPeregrineStatus, +sso:GetSharedSsoConfiguration, +sso:CreateManagedApplicationInstance, +ec2:DescribeSubnets, +ec2:DescribeSecurityGroups, +ec2:DescribeNetworkInterfaces, +ec2:DescribeAccountAttributes, +elasticloadbalancing:DescribeLoadBalancers, +elasticloadbalancing:DescribeListeners, +elasticloadbalancing:DescribeListenerCertificates, +acm:DeleteCertificateRelation, +ec2:DeleteTags, +ec2:DeleteVerifiedAccessEndpoint, +ec2:GetVerifiedAccessEndpointPolicy, +ec2:ModifyVerifiedAccessEndpoint, +ec2:ModifyVerifiedAccessEndpointPolicy, +sso:DeleteManagedApplicationInstance, +kms:DescribeKey, +kms:RetireGrant, +kms:CreateGrant, +kms:GenerateDataKey, +kms:Decrypt +``` + +### List +```json +ec2:DescribeVerifiedAccessEndpoints, +ec2:DescribeTags, +acm:CreateCertificateRelation, +acm:DeleteCertificateRelation, +acm:DescribeCertificate, +acm:GetCertificateWithPK, +ec2:CreateTags, +ec2:CreateVerifiedAccessEndpoint, +ec2:DeleteTags, +ec2:DeleteVerifiedAccessEndpoint, +ec2:DescribeAccountAttributes, +ec2:DescribeNetworkInterfaces, +ec2:DescribeSecurityGroups, +ec2:DescribeSubnets, +ec2:GetVerifiedAccessEndpointPolicy, +ec2:ModifyVerifiedAccessEndpoint, +ec2:ModifyVerifiedAccessEndpointPolicy, +elasticloadbalancing:DescribeListenerCertificates, +elasticloadbalancing:DescribeListeners, +elasticloadbalancing:DescribeLoadBalancers, +iam:CreateServiceLinkedRole, +iam:ListRoles, +sso:CreateManagedApplicationInstance, +sso:DeleteManagedApplicationInstance, +sso:GetManagedApplicationInstance, +sso:GetPeregrineStatus, +sso:GetSharedSsoConfiguration, +kms:DescribeKey, +kms:RetireGrant, +kms:CreateGrant, +kms:GenerateDataKey, +kms:Decrypt +``` + diff --git a/docs/aws-docs/providers/aws/ec2/verified_access_group/index.md b/docs/aws-docs/providers/aws/ec2/verified_access_group/index.md new file mode 100644 index 0000000000..2afd7eb656 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/verified_access_group/index.md @@ -0,0 +1,133 @@ +--- +title: verified_access_group +hide_title: false +hide_table_of_contents: false +keywords: + - verified_access_group + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual verified_access_group resource + +## Overview + + + + + +
Nameverified_access_group
TypeResource
DescriptionThe AWS::EC2::VerifiedAccessGroup resource creates an AWS EC2 Verified Access Group.
Idaws.ec2.verified_access_group
+ +## Fields + + + + + + + + + + + + + + + +
NameDatatypeDescription
verified_access_group_idstringThe ID of the AWS Verified Access group.
verified_access_instance_idstringThe ID of the AWS Verified Access instance.
verified_access_group_arnstringThe ARN of the Verified Access group.
ownerstringThe AWS account number that owns the group.
creation_timestringTime this Verified Access Group was created.
last_updated_timestringTime this Verified Access Group was last updated.
descriptionstringA description for the AWS Verified Access group.
policy_documentstringThe AWS Verified Access policy document.
policy_enabledbooleanThe status of the Verified Access policy.
tagsarrayAn array of key-value pairs to apply to this resource.
sse_specificationobjectThe configuration options for customer provided KMS encryption.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +verified_access_group_id, +verified_access_instance_id, +verified_access_group_arn, +owner, +creation_time, +last_updated_time, +description, +policy_document, +policy_enabled, +tags, +sse_specification +FROM aws.ec2.verified_access_group +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the verified_access_group resource, the following permissions are required: + +### Read +```json +ec2:DescribeVerifiedAccessGroups, +ec2:GetVerifiedAccessGroupPolicy, +ec2:DescribeTags, +kms:DescribeKey, +kms:RetireGrant, +kms:CreateGrant, +kms:GenerateDataKey, +kms:Decrypt +``` + +### Update +```json +ec2:ModifyVerifiedAccessGroup, +ec2:ModifyVerifiedAccessGroupPolicy, +ec2:DescribeVerifiedAccessGroups, +ec2:GetVerifiedAccessGroupPolicy, +ec2:DescribeTags, +ec2:DeleteTags, +ec2:CreateTags, +kms:DescribeKey, +kms:RetireGrant, +kms:CreateGrant, +kms:GenerateDataKey, +kms:Decrypt +``` + +### Delete +```json +ec2:DeleteVerifiedAccessGroup, +ec2:DeleteTags, +ec2:DescribeVerifiedAccessGroups, +ec2:DescribeTags, +kms:DescribeKey, +kms:RetireGrant, +kms:CreateGrant, +kms:GenerateDataKey, +kms:Decrypt +``` + diff --git a/docs/aws-docs/providers/aws/ec2/verified_access_groups/index.md b/docs/aws-docs/providers/aws/ec2/verified_access_groups/index.md new file mode 100644 index 0000000000..d7f50a85e3 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/verified_access_groups/index.md @@ -0,0 +1,92 @@ +--- +title: verified_access_groups +hide_title: false +hide_table_of_contents: false +keywords: + - verified_access_groups + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Retrieves a list of verified_access_groups in a region + +## Overview + + + + + +
Nameverified_access_groups
TypeResource
DescriptionThe AWS::EC2::VerifiedAccessGroup resource creates an AWS EC2 Verified Access Group.
Idaws.ec2.verified_access_groups
+ +## Fields + + + + + +
NameDatatypeDescription
verified_access_group_idstringThe ID of the AWS Verified Access group.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +verified_access_group_id +FROM aws.ec2.verified_access_groups +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the verified_access_groups resource, the following permissions are required: + +### Create +```json +ec2:CreateVerifiedAccessGroup, +ec2:DescribeVerifiedAccessGroups, +ec2:GetVerifiedAccessGroupPolicy, +ec2:CreateTags, +ec2:DescribeTags, +kms:DescribeKey, +kms:RetireGrant, +kms:CreateGrant, +kms:GenerateDataKey, +kms:Decrypt +``` + +### List +```json +ec2:DescribeVerifiedAccessGroups, +ec2:DescribeTags, +kms:DescribeKey, +kms:RetireGrant, +kms:CreateGrant, +kms:GenerateDataKey, +kms:Decrypt +``` + diff --git a/docs/aws-docs/providers/aws/ec2/verified_access_instance/index.md b/docs/aws-docs/providers/aws/ec2/verified_access_instance/index.md new file mode 100644 index 0000000000..4d53ca1c2f --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/verified_access_instance/index.md @@ -0,0 +1,142 @@ +--- +title: verified_access_instance +hide_title: false +hide_table_of_contents: false +keywords: + - verified_access_instance + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual verified_access_instance resource + +## Overview + + + + + +
Nameverified_access_instance
TypeResource
DescriptionThe AWS::EC2::VerifiedAccessInstance resource creates an AWS EC2 Verified Access Instance.
Idaws.ec2.verified_access_instance
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
verified_access_instance_idstringThe ID of the AWS Verified Access instance.
verified_access_trust_providersarrayAWS Verified Access trust providers.
verified_access_trust_provider_idsarrayThe IDs of the AWS Verified Access trust providers.
creation_timestringTime this Verified Access Instance was created.
last_updated_timestringTime this Verified Access Instance was last updated.
descriptionstringA description for the AWS Verified Access instance.
logging_configurationsobjectThe configuration options for AWS Verified Access instances.
tagsarrayAn array of key-value pairs to apply to this resource.
fips_enabledbooleanIndicates whether FIPS is enabled
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +verified_access_instance_id, +verified_access_trust_providers, +verified_access_trust_provider_ids, +creation_time, +last_updated_time, +description, +logging_configurations, +tags, +fips_enabled +FROM aws.ec2.verified_access_instance +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the verified_access_instance resource, the following permissions are required: + +### Read +```json +ec2:DescribeVerifiedAccessInstances, +ec2:DescribeVerifiedAccessInstanceLoggingConfigurations, +ec2:DescribeTags, +logs:GetLogDelivery, +logs:ListLogDeliveries +``` + +### Update +```json +ec2:ModifyVerifiedAccessInstance, +ec2:ModifyVerifiedAccessInstanceLoggingConfiguration, +ec2:DescribeVerifiedAccessInstances, +ec2:DescribeVerifiedAccessInstanceLoggingConfigurations, +ec2:DescribeTags, +ec2:AttachVerifiedAccessTrustProvider, +ec2:DetachVerifiedAccessTrustProvider, +ec2:DeleteTags, +ec2:CreateTags, +ec2:DescribeTags, +logs:CreateLogDelivery, +logs:GetLogDelivery, +logs:ListLogDeliveries, +logs:UpdateLogDelivery, +logs:DeleteLogDelivery, +logs:PutDestination, +logs:PutLogEvents, +logs:DescribeLogStreams, +s3:listBuckets, +s3:PutObject, +s3:GetBucketPolicy, +s3:PutBucketPolicy, +logs:DescribeLogGroups, +logs:PutResourcePolicy, +firehose:TagDeliveryStream, +iam:CreateServiceLinkedRole, +logs:DescribeResourcePolicies +``` + +### Delete +```json +ec2:DeleteVerifiedAccessInstance, +ec2:DeleteTags, +ec2:DescribeVerifiedAccessInstances, +ec2:DescribeVerifiedAccessInstanceLoggingConfigurations, +ec2:DetachVerifiedAccessTrustProvider, +ec2:GetVerifiedAccessGroupPolicy, +ec2:DescribeTags, +logs:ListLogDeliveries, +logs:GetLogDelivery, +logs:DeleteLogDelivery +``` + diff --git a/docs/aws-docs/providers/aws/ec2/verified_access_instances/index.md b/docs/aws-docs/providers/aws/ec2/verified_access_instances/index.md new file mode 100644 index 0000000000..c258755da3 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/verified_access_instances/index.md @@ -0,0 +1,104 @@ +--- +title: verified_access_instances +hide_title: false +hide_table_of_contents: false +keywords: + - verified_access_instances + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Retrieves a list of verified_access_instances in a region + +## Overview + + + + + +
Nameverified_access_instances
TypeResource
DescriptionThe AWS::EC2::VerifiedAccessInstance resource creates an AWS EC2 Verified Access Instance.
Idaws.ec2.verified_access_instances
+ +## Fields + + + + + +
NameDatatypeDescription
verified_access_instance_idstringThe ID of the AWS Verified Access instance.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +verified_access_instance_id +FROM aws.ec2.verified_access_instances +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the verified_access_instances resource, the following permissions are required: + +### Create +```json +ec2:CreateVerifiedAccessInstance, +ec2:AttachVerifiedAccessTrustProvider, +ec2:ModifyVerifiedAccessInstanceLoggingConfiguration, +ec2:DescribeVerifiedAccessInstances, +ec2:DescribeVerifiedAccessInstanceLoggingConfigurations, +ec2:CreateTags, +ec2:DescribeTags, +logs:CreateLogDelivery, +logs:GetLogDelivery, +logs:UpdateLogDelivery, +logs:PutDestination, +logs:DeleteLogDelivery, +logs:ListLogDeliveries, +logs:PutLogEvents, +logs:DescribeLogStreams, +s3:listBuckets, +s3:PutObject, +s3:GetBucketPolicy, +s3:PutBucketPolicy, +logs:DescribeLogGroups, +logs:PutResourcePolicy, +firehose:TagDeliveryStream, +logs:DescribeResourcePolicies, +iam:CreateServiceLinkedRole, +verified-access:AllowVerifiedAccess +``` + +### List +```json +ec2:DescribeVerifiedAccessInstances, +ec2:DescribeTags, +logs:ListLogDeliveries, +logs:GetLogDelivery +``` + diff --git a/docs/aws-docs/providers/aws/ec2/verified_access_trust_provider/index.md b/docs/aws-docs/providers/aws/ec2/verified_access_trust_provider/index.md new file mode 100644 index 0000000000..a89fd000da --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/verified_access_trust_provider/index.md @@ -0,0 +1,130 @@ +--- +title: verified_access_trust_provider +hide_title: false +hide_table_of_contents: false +keywords: + - verified_access_trust_provider + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual verified_access_trust_provider resource + +## Overview + + + + + +
Nameverified_access_trust_provider
TypeResource
DescriptionThe AWS::EC2::VerifiedAccessTrustProvider type describes a verified access trust provider
Idaws.ec2.verified_access_trust_provider
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
trust_provider_typestringType of trust provider. Possible values: user|device
device_trust_provider_typestringThe type of device-based trust provider. Possible values: jamf|crowdstrike
user_trust_provider_typestringThe type of device-based trust provider. Possible values: oidc|iam-identity-center
oidc_optionsobject
device_optionsobject
policy_reference_namestringThe identifier to be used when working with policy rules.
creation_timestringThe creation time.
last_updated_timestringThe last updated time.
verified_access_trust_provider_idstringThe ID of the Amazon Web Services Verified Access trust provider.
descriptionstringA description for the Amazon Web Services Verified Access trust provider.
tagsarrayAn array of key-value pairs to apply to this resource.
sse_specificationobjectThe configuration options for customer provided KMS encryption.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +trust_provider_type, +device_trust_provider_type, +user_trust_provider_type, +oidc_options, +device_options, +policy_reference_name, +creation_time, +last_updated_time, +verified_access_trust_provider_id, +description, +tags, +sse_specification +FROM aws.ec2.verified_access_trust_provider +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the verified_access_trust_provider resource, the following permissions are required: + +### Read +```json +ec2:DescribeVerifiedAccessTrustProviders, +ec2:DescribeTags, +kms:DescribeKey, +kms:GenerateDataKey, +kms:Decrypt +``` + +### Update +```json +ec2:ModifyVerifiedAccessTrustProvider, +ec2:DescribeVerifiedAccessTrustProviders, +ec2:DescribeTags, +ec2:DeleteTags, +ec2:CreateTags, +kms:DescribeKey, +kms:RetireGrant, +kms:CreateGrant, +kms:GenerateDataKey, +kms:Decrypt +``` + +### Delete +```json +ec2:DeleteVerifiedAccessTrustProvider, +ec2:DeleteTags, +ec2:DescribeVerifiedAccessTrustProviders, +ec2:DescribeTags, +kms:DescribeKey, +kms:RetireGrant, +kms:CreateGrant, +kms:GenerateDataKey, +kms:Decrypt +``` + diff --git a/docs/aws-docs/providers/aws/ec2/verified_access_trust_providers/index.md b/docs/aws-docs/providers/aws/ec2/verified_access_trust_providers/index.md new file mode 100644 index 0000000000..db270d576a --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/verified_access_trust_providers/index.md @@ -0,0 +1,90 @@ +--- +title: verified_access_trust_providers +hide_title: false +hide_table_of_contents: false +keywords: + - verified_access_trust_providers + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Retrieves a list of verified_access_trust_providers in a region + +## Overview + + + + + +
Nameverified_access_trust_providers
TypeResource
DescriptionThe AWS::EC2::VerifiedAccessTrustProvider type describes a verified access trust provider
Idaws.ec2.verified_access_trust_providers
+ +## Fields + + + + + +
NameDatatypeDescription
verified_access_trust_provider_idstringThe ID of the Amazon Web Services Verified Access trust provider.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +verified_access_trust_provider_id +FROM aws.ec2.verified_access_trust_providers +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the verified_access_trust_providers resource, the following permissions are required: + +### Create +```json +ec2:CreateVerifiedAccessTrustProvider, +ec2:DescribeVerifiedAccessTrustProviders, +ec2:CreateTags, +ec2:DescribeTags, +sso:GetSharedSsoConfiguration, +kms:DescribeKey, +kms:RetireGrant, +kms:CreateGrant, +kms:GenerateDataKey, +kms:Decrypt +``` + +### List +```json +ec2:DescribeVerifiedAccessTrustProviders, +ec2:DescribeTags, +kms:DescribeKey, +kms:GenerateDataKey, +kms:Decrypt +``` + diff --git a/docs/aws-docs/providers/aws/ec2/vgw_route_propagation/index.md b/docs/aws-docs/providers/aws/ec2/vgw_route_propagation/index.md deleted file mode 100644 index ca9b7be8eb..0000000000 --- a/docs/aws-docs/providers/aws/ec2/vgw_route_propagation/index.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: vgw_route_propagation -hide_title: false -hide_table_of_contents: false -keywords: - - vgw_route_propagation - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namevgw_route_propagation
TypeResource
Idaws.ec2.vgw_route_propagation
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `vgw_route_propagation_Disable` | `EXEC` | `GatewayId, RouteTableId, region` | Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC. | -| `vgw_route_propagation_Enable` | `EXEC` | `GatewayId, RouteTableId, region` | Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC. | diff --git a/docs/aws-docs/providers/aws/ec2/volume/index.md b/docs/aws-docs/providers/aws/ec2/volume/index.md new file mode 100644 index 0000000000..def3b3b228 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/volume/index.md @@ -0,0 +1,123 @@ +--- +title: volume +hide_title: false +hide_table_of_contents: false +keywords: + - volume + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual volume resource + +## Overview + + + + + +
Namevolume
TypeResource
DescriptionSpecifies an Amazon Elastic Block Store (Amazon EBS) volume.<br/> When you use CFNlong to update an Amazon EBS volume that modifies ``Iops``, ``Size``, or ``VolumeType``, there is a cooldown period before another operation can occur. This can cause your stack to report being in ``UPDATE_IN_PROGRESS`` or ``UPDATE_ROLLBACK_IN_PROGRESS`` for long periods of time.<br/> Amazon EBS does not support sizing down an Amazon EBS volume. CFNlong does not attempt to modify an Amazon EBS volume to a smaller size on rollback.<br/> Some common scenarios when you might encounter a cooldown period for Amazon EBS include:<br/> + You successfully update an Amazon EBS volume and the update succeeds. When you attempt another update within the cooldown window, that update will be subject to a cooldown period.<br/> + You successfully update an Amazon EBS volume and the update succeeds but another change in your ``update-stack`` call fails. The rollback will be subject to a cooldown period.<br/> <br/> For more information on the coo
Idaws.ec2.volume
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
multi_attach_enabledbooleanIndicates whether Amazon EBS Multi-Attach is enabled.<br/> CFNlong does not currently support updating a single-attach volume to be multi-attach enabled, updating a multi-attach enabled volume to be single-attach, or updating the size or number of I/O operations per second (IOPS) of a multi-attach enabled volume.
kms_key_idstringThe identifier of the kms-key-long to use for Amazon EBS encryption. If ``KmsKeyId`` is specified, the encrypted state must be ``true``.<br/> If you omit this property and your account is enabled for encryption by default, or *Encrypted* is set to ``true``, then the volume is encrypted using the default key specified for your account. If your account does not have a default key, then the volume is encrypted using the aws-managed-key.<br/> Alternatively, if you want to specify a different key, you can specify one of the following:<br/> + Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.<br/> + Key alias. Specify the alias for the key, prefixed with ``alias/``. For example, for a key with the alias ``my_cmk``, use ``alias/my_cmk``. Or to specify the aws-managed-key, use ``alias/aws/ebs``.<br/> + Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.<br/> + Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
encryptedbooleanIndicates whether the volume should be encrypted. The effect of setting the encryption state to ``true`` depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see [Encryption by default](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default) in the *Amazon Elastic Compute Cloud User Guide*.<br/> Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see [Supported instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances).
sizeintegerThe size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.<br/> The following are the supported volumes sizes for each volume type:<br/> + ``gp2`` and ``gp3``: 1 - 16,384 GiB<br/> + ``io1``: 4 - 16,384 GiB<br/> + ``io2``: 4 - 65,536 GiB<br/> + ``st1`` and ``sc1``: 125 - 16,384 GiB<br/> + ``standard``: 1 - 1024 GiB
auto_enable_iobooleanIndicates whether the volume is auto-enabled for I/O operations. By default, Amazon EBS disables I/O to the volume from attached EC2 instances when it determines that a volume's data is potentially inconsistent. If the consistency of the volume is not a concern, and you prefer that the volume be made available immediately if it's impaired, you can configure the volume to automatically enable I/O.
outpost_arnstringThe Amazon Resource Name (ARN) of the Outpost.
availability_zonestringThe ID of the Availability Zone in which to create the volume. For example, ``us-east-1a``.
throughputintegerThe throughput to provision for a volume, with a maximum of 1,000 MiB/s.<br/> This parameter is valid only for ``gp3`` volumes. The default value is 125.<br/> Valid Range: Minimum value of 125. Maximum value of 1000.
iopsintegerThe number of I/O operations per second (IOPS). For ``gp3``, ``io1``, and ``io2`` volumes, this represents the number of IOPS that are provisioned for the volume. For ``gp2`` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.<br/> The following are the supported values for each volume type:<br/> + ``gp3``: 3,000 - 16,000 IOPS<br/> + ``io1``: 100 - 64,000 IOPS<br/> + ``io2``: 100 - 256,000 IOPS<br/> <br/> For ``io2`` volumes, you can achieve up to 256,000 IOPS on [instances built on the Nitro System](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances). On other instances, you can achieve performance up to 32,000 IOPS.<br/> This parameter is required for ``io1`` and ``io2`` volumes. The default for ``gp3`` volumes is 3,000 IOPS. This parameter is not supported for ``gp2``, ``st1``, ``sc1``, or ``standard`` volumes.
snapshot_idstringThe snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.
volume_typestringThe volume type. This parameter can be one of the following values:<br/> + General Purpose SSD: ``gp2`` | ``gp3`` <br/> + Provisioned IOPS SSD: ``io1`` | ``io2`` <br/> + Throughput Optimized HDD: ``st1`` <br/> + Cold HDD: ``sc1`` <br/> + Magnetic: ``standard`` <br/> <br/> For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the *Amazon Elastic Compute Cloud User Guide*.<br/> Default: ``gp2``
volume_idstring
tagsarrayThe tags to apply to the volume during creation.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +multi_attach_enabled, +kms_key_id, +encrypted, +size, +auto_enable_io, +outpost_arn, +availability_zone, +throughput, +iops, +snapshot_id, +volume_type, +volume_id, +tags +FROM aws.ec2.volume +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the volume resource, the following permissions are required: + +### Read +```json +ec2:DescribeVolumes, +ec2:DescribeVolumeAttribute, +ec2:DescribeTags +``` + +### Update +```json +ec2:ModifyVolume, +ec2:ModifyVolumeAttribute, +ec2:DescribeVolumeAttribute, +ec2:DescribeVolumesModifications, +ec2:DescribeVolumes, +ec2:CreateTags, +ec2:DeleteTags +``` + +### Delete +```json +ec2:DeleteVolume, +ec2:CreateSnapshot, +ec2:DescribeSnapshots, +ec2:DeleteTags, +ec2:DescribeVolumes +``` + diff --git a/docs/aws-docs/providers/aws/ec2/volume_attachment/index.md b/docs/aws-docs/providers/aws/ec2/volume_attachment/index.md new file mode 100644 index 0000000000..81d28e7b54 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/volume_attachment/index.md @@ -0,0 +1,82 @@ +--- +title: volume_attachment +hide_title: false +hide_table_of_contents: false +keywords: + - volume_attachment + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual volume_attachment resource + +## Overview + + + + + +
Namevolume_attachment
TypeResource
DescriptionAttaches an Amazon EBS volume to a running instance and exposes it to the instance with the specified device name.<br/> Before this resource can be deleted (and therefore the volume detached), you must first unmount the volume in the instance. Failure to do so results in the volume being stuck in the busy state while it is trying to detach, which could possibly damage the file system or the data it contains.<br/> If an Amazon EBS volume is the root device of an instance, it cannot be detached while the instance is in the "running" state. To detach the root volume, stop the instance first.<br/> If the root volume is detached from an instance with an MKT product code, then the product codes from that volume are no longer associated with the instance.
Idaws.ec2.volume_attachment
+ +## Fields + + + + + + + +
NameDatatypeDescription
volume_idstringThe ID of the Amazon EBS volume. The volume and instance must be within the same Availability Zone. This value can be a reference to an [AWS::EC2::Volume](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html) resource, or it can be the volume ID of an existing Amazon EBS volume.
instance_idstringThe ID of the instance to which the volume attaches. This value can be a reference to an [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource, or it can be the physical ID of an existing EC2 instance.
devicestringThe device name (for example, ``/dev/sdh`` or ``xvdh``).
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +volume_id, +instance_id, +device +FROM aws.ec2.volume_attachment +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the volume_attachment resource, the following permissions are required: + +### Read +```json +ec2:DescribeVolumes +``` + +### Delete +```json +ec2:DetachVolume, +ec2:DescribeVolumes +``` + diff --git a/docs/aws-docs/providers/aws/ec2/volume_attachments/index.md b/docs/aws-docs/providers/aws/ec2/volume_attachments/index.md new file mode 100644 index 0000000000..2633d9fbe4 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/volume_attachments/index.md @@ -0,0 +1,80 @@ +--- +title: volume_attachments +hide_title: false +hide_table_of_contents: false +keywords: + - volume_attachments + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Retrieves a list of volume_attachments in a region + +## Overview + + + + + +
Namevolume_attachments
TypeResource
DescriptionAttaches an Amazon EBS volume to a running instance and exposes it to the instance with the specified device name.<br/> Before this resource can be deleted (and therefore the volume detached), you must first unmount the volume in the instance. Failure to do so results in the volume being stuck in the busy state while it is trying to detach, which could possibly damage the file system or the data it contains.<br/> If an Amazon EBS volume is the root device of an instance, it cannot be detached while the instance is in the "running" state. To detach the root volume, stop the instance first.<br/> If the root volume is detached from an instance with an MKT product code, then the product codes from that volume are no longer associated with the instance.
Idaws.ec2.volume_attachments
+ +## Fields + + + + + + +
NameDatatypeDescription
volume_idundefinedThe ID of the Amazon EBS volume. The volume and instance must be within the same Availability Zone. This value can be a reference to an [AWS::EC2::Volume](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html) resource, or it can be the volume ID of an existing Amazon EBS volume.
instance_idundefinedThe ID of the instance to which the volume attaches. This value can be a reference to an [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource, or it can be the physical ID of an existing EC2 instance.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +volume_id, +instance_id +FROM aws.ec2.volume_attachments +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the volume_attachments resource, the following permissions are required: + +### Create +```json +ec2:AttachVolume, +ec2:DescribeVolumes +``` + +### List +```json +ec2:DescribeVolumes +``` + diff --git a/docs/aws-docs/providers/aws/ec2/volume_attribute/index.md b/docs/aws-docs/providers/aws/ec2/volume_attribute/index.md deleted file mode 100644 index 6a8e260b1f..0000000000 --- a/docs/aws-docs/providers/aws/ec2/volume_attribute/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: volume_attribute -hide_title: false -hide_table_of_contents: false -keywords: - - volume_attribute - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namevolume_attribute
TypeResource
Idaws.ec2.volume_attribute
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `autoEnableIO` | `object` | Describes a value for a resource attribute that is a Boolean value. | -| `productCodes` | `array` | A list of product codes. | -| `volumeId` | `string` | The ID of the volume. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `volume_attribute_Describe` | `SELECT` | `Attribute, VolumeId, region` | <p>Describes the specified attribute of the specified volume. You can specify only one attribute at a time.</p> <p>For more information about EBS volumes, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumes.html">Amazon EBS volumes</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | -| `volume_attribute_Modify` | `EXEC` | `VolumeId, region` | <p>Modifies a volume attribute.</p> <p>By default, all I/O operations for the volume are suspended when the data on the volume is determined to be potentially inconsistent, to prevent undetectable, latent data corruption. The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume.</p> <p>You can change the default behavior to resume I/O operations. We recommend that you change this only for boot volumes or for volumes that are stateless or disposable.</p> | diff --git a/docs/aws-docs/providers/aws/ec2/volume_i_o/index.md b/docs/aws-docs/providers/aws/ec2/volume_i_o/index.md deleted file mode 100644 index c5a50e3f73..0000000000 --- a/docs/aws-docs/providers/aws/ec2/volume_i_o/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: volume_i_o -hide_title: false -hide_table_of_contents: false -keywords: - - volume_i_o - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namevolume_i_o
TypeResource
Idaws.ec2.volume_i_o
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `volume_i_o_Enable` | `EXEC` | `VolumeId, region` | diff --git a/docs/aws-docs/providers/aws/ec2/volume_status/index.md b/docs/aws-docs/providers/aws/ec2/volume_status/index.md deleted file mode 100644 index 747015bf6b..0000000000 --- a/docs/aws-docs/providers/aws/ec2/volume_status/index.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: volume_status -hide_title: false -hide_table_of_contents: false -keywords: - - volume_status - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namevolume_status
TypeResource
Idaws.ec2.volume_status
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `actionsSet` | `array` | The details of the operation. | -| `attachmentStatuses` | `array` | Information about the instances to which the volume is attached. | -| `availabilityZone` | `string` | The Availability Zone of the volume. | -| `eventsSet` | `array` | A list of events associated with the volume. | -| `outpostArn` | `string` | The Amazon Resource Name (ARN) of the Outpost. | -| `volumeId` | `string` | The volume ID. | -| `volumeStatus` | `object` | Describes the status of a volume. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `volume_status_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2/volumes/index.md b/docs/aws-docs/providers/aws/ec2/volumes/index.md index 1690233ce0..3d52722bbe 100644 --- a/docs/aws-docs/providers/aws/ec2/volumes/index.md +++ b/docs/aws-docs/providers/aws/ec2/volumes/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - volumes - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,42 +14,72 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- - - +Retrieves a list of volumes in a region ## Overview +
Namevolumes
TypeResource
DescriptionSpecifies an Amazon Elastic Block Store (Amazon EBS) volume.<br/> When you use CFNlong to update an Amazon EBS volume that modifies ``Iops``, ``Size``, or ``VolumeType``, there is a cooldown period before another operation can occur. This can cause your stack to report being in ``UPDATE_IN_PROGRESS`` or ``UPDATE_ROLLBACK_IN_PROGRESS`` for long periods of time.<br/> Amazon EBS does not support sizing down an Amazon EBS volume. CFNlong does not attempt to modify an Amazon EBS volume to a smaller size on rollback.<br/> Some common scenarios when you might encounter a cooldown period for Amazon EBS include:<br/> + You successfully update an Amazon EBS volume and the update succeeds. When you attempt another update within the cooldown window, that update will be subject to a cooldown period.<br/> + You successfully update an Amazon EBS volume and the update succeeds but another change in your ``update-stack`` call fails. The rollback will be subject to a cooldown period.<br/> <br/> For more information on the coo
Idaws.ec2.volumes
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `AvailabilityZone` | `string` | The Availability Zone for the volume. | -| `attachmentSet` | `array` | Information about the volume attachments. | -| `createTime` | `string` | The time stamp when volume creation was initiated. | -| `encrypted` | `boolean` | Indicates whether the volume is encrypted. | -| `fastRestored` | `boolean` | Indicates whether the volume was created using fast snapshot restore. | -| `iops` | `integer` | The number of I/O operations per second (IOPS). For <code>gp3</code>, <code>io1</code>, and <code>io2</code> volumes, this represents the number of IOPS that are provisioned for the volume. For <code>gp2</code> volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. | -| `kmsKeyId` | `string` | The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the volume. | -| `multiAttachEnabled` | `boolean` | Indicates whether Amazon EBS Multi-Attach is enabled. | -| `outpostArn` | `string` | The Amazon Resource Name (ARN) of the Outpost. | -| `size` | `integer` | The size of the volume, in GiBs. | -| `snapshotId` | `string` | The snapshot from which the volume was created, if applicable. | -| `status` | `string` | The volume state. | -| `tagSet` | `array` | Any tags assigned to the volume. | -| `throughput` | `integer` | The throughput that the volume supports, in MiB/s. | -| `volumeId` | `string` | The ID of the volume. | -| `volumeType` | `string` | The volume type. | + + + + + +
NameDatatypeDescription
volume_idstring
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `volumes_Describe` | `SELECT` | `region` | <p>Describes the specified EBS volumes or all of your EBS volumes.</p> <p>If you are describing a long list of volumes, we recommend that you paginate the output to make the list more manageable. The <code>MaxResults</code> parameter sets the maximum number of results returned in a single page. If the list of results exceeds your <code>MaxResults</code> value, then that number of results is returned along with a <code>NextToken</code> value that can be passed to a subsequent <code>DescribeVolumes</code> request to retrieve the remaining results.</p> <p>For more information about EBS volumes, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumes.html">Amazon EBS volumes</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | -| `volume_Create` | `INSERT` | `AvailabilityZone, region` | <p>Creates an EBS volume that can be attached to an instance in the same Availability Zone.</p> <p>You can create a new empty volume or restore a volume from an EBS snapshot. Any Amazon Web Services Marketplace product codes from the snapshot are propagated to the volume.</p> <p>You can create encrypted volumes. Encrypted volumes must be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html">Amazon EBS encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>You can tag your volumes during creation. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html">Tag your Amazon EC2 resources</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-creating-volume.html">Create an Amazon EBS volume</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | -| `volume_Delete` | `DELETE` | `VolumeId, region` | <p>Deletes the specified EBS volume. The volume must be in the <code>available</code> state (not attached to an instance).</p> <p>The volume can remain in the <code>deleting</code> state for several minutes.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-deleting-volume.html">Delete an Amazon EBS volume</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | -| `volume_Modify` | `UPDATE` | `VolumeId, region` | <p>You can modify several parameters of an existing EBS volume, including volume size, volume type, and IOPS capacity. If your EBS volume is attached to a current-generation EC2 instance type, you might be able to apply these changes without stopping the instance or detaching the volume from it. For more information about modifying EBS volumes, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-modify-volume.html">Amazon EBS Elastic Volumes</a> (Linux instances) or <a href="https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ebs-modify-volume.html">Amazon EBS Elastic Volumes</a> (Windows instances).</p> <p>When you complete a resize operation on your volume, you need to extend the volume's file-system size to take advantage of the new storage capacity. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-expand-volume.html#recognize-expanded-volume-linux">Extend a Linux file system</a> or <a href="https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ebs-expand-volume.html#recognize-expanded-volume-windows">Extend a Windows file system</a>.</p> <p> You can use CloudWatch Events to check the status of a modification to an EBS volume. For information about CloudWatch Events, see the <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/">Amazon CloudWatch Events User Guide</a>. You can also track the status of a modification using <a>DescribeVolumesModifications</a>. For information about tracking status changes using either method, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-volume-modifications.html">Monitor the progress of volume modifications</a>.</p> <p>With previous-generation instance types, resizing an EBS volume might require detaching and reattaching the volume or stopping and restarting the instance.</p> <p>After modifying a volume, you must wait at least six hours and ensure that the volume is in the <code>in-use</code> or <code>available</code> state before you can modify the same volume. This is sometimes referred to as a cooldown period.</p> | -| `volume_Attach` | `EXEC` | `Device, InstanceId, VolumeId, region` | <p>Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.</p> <p>Encrypted EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html">Amazon EBS encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>After you attach an EBS volume, you must make it available. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-using-volumes.html">Make an EBS volume available for use</a>.</p> <p>If a volume has an Amazon Web Services Marketplace product code:</p> <ul> <li> <p>The volume can be attached only to a stopped instance.</p> </li> <li> <p>Amazon Web Services Marketplace product codes are copied from the volume to the instance.</p> </li> <li> <p>You must be subscribed to the product.</p> </li> <li> <p>The instance type and operating system of the instance must support the product. For example, you can't detach a volume from a Windows instance and attach it to a Linux instance.</p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-attaching-volume.html">Attach an Amazon EBS volume to an instance</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | -| `volume_Detach` | `EXEC` | `VolumeId, region` | <p>Detaches an EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so can result in the volume becoming stuck in the <code>busy</code> state while detaching. If this happens, detachment can be delayed indefinitely until you unmount the volume, force detachment, reboot the instance, or all three. If an EBS volume is the root device of an instance, it can't be detached while the instance is running. To detach the root volume, stop the instance first.</p> <p>When a volume with an Amazon Web Services Marketplace product code is detached from an instance, the product code is no longer associated with the instance.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-detaching-volume.html">Detach an Amazon EBS volume</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | -| `volume_Import` | `EXEC` | `AvailabilityZone, Image, Volume, region` | <p>Creates an import volume task using metadata from the specified disk image.</p> <p>This API action supports only single-volume VMs. To import multi-volume VMs, use <a>ImportImage</a> instead. To import a disk to a snapshot, use <a>ImportSnapshot</a> instead.</p> <p>This API action is not supported by the Command Line Interface (CLI). For information about using the Amazon EC2 CLI, which is deprecated, see <a href="https://awsdocs.s3.amazonaws.com/EC2/ec2-clt.pdf#importing-your-volumes-into-amazon-ebs">Importing Disks to Amazon EBS</a> in the <i>Amazon EC2 CLI Reference</i> PDF file.</p> <p>For information about the import manifest referenced by this API action, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/manifest.html">VM Import Manifest</a>.</p> | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +volume_id +FROM aws.ec2.volumes +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the volumes resource, the following permissions are required: + +### Create +```json +ec2:CreateVolume, +ec2:DescribeVolumes, +ec2:DescribeVolumeAttribute, +ec2:ModifyVolumeAttribute, +ec2:CreateTags, +kms:GenerateDataKeyWithoutPlaintext, +kms:CreateGrant +``` + +### List +```json +ec2:DescribeVolumes, +ec2:DescribeTags, +ec2:DescribeVolumeAttribute +``` + diff --git a/docs/aws-docs/providers/aws/ec2/volumes_modifications/index.md b/docs/aws-docs/providers/aws/ec2/volumes_modifications/index.md deleted file mode 100644 index 74592afbc4..0000000000 --- a/docs/aws-docs/providers/aws/ec2/volumes_modifications/index.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: volumes_modifications -hide_title: false -hide_table_of_contents: false -keywords: - - volumes_modifications - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namevolumes_modifications
TypeResource
Idaws.ec2.volumes_modifications
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `endTime` | `string` | The modification completion or failure time. | -| `modificationState` | `string` | The current modification state. The modification state is null for unmodified volumes. | -| `originalIops` | `integer` | The original IOPS rate of the volume. | -| `originalMultiAttachEnabled` | `boolean` | The original setting for Amazon EBS Multi-Attach. | -| `originalSize` | `integer` | The original size of the volume, in GiB. | -| `originalThroughput` | `integer` | The original throughput of the volume, in MiB/s. | -| `originalVolumeType` | `string` | The original EBS volume type of the volume. | -| `progress` | `integer` | The modification progress, from 0 to 100 percent complete. | -| `startTime` | `string` | The modification start time. | -| `statusMessage` | `string` | A status message about the modification progress or failure. | -| `targetIops` | `integer` | The target IOPS rate of the volume. | -| `targetMultiAttachEnabled` | `boolean` | The target setting for Amazon EBS Multi-Attach. | -| `targetSize` | `integer` | The target size of the volume, in GiB. | -| `targetThroughput` | `integer` | The target throughput of the volume, in MiB/s. | -| `targetVolumeType` | `string` | The target EBS volume type of the volume. | -| `volumeId` | `string` | The ID of the volume. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `volumes_modifications_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2/vpc/index.md b/docs/aws-docs/providers/aws/ec2/vpc/index.md new file mode 100644 index 0000000000..6eef924b29 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/vpc/index.md @@ -0,0 +1,116 @@ +--- +title: vpc +hide_title: false +hide_table_of_contents: false +keywords: + - vpc + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual vpc resource + +## Overview + + + + + +
Namevpc
TypeResource
DescriptionSpecifies a virtual private cloud (VPC).<br/> You can optionally request an IPv6 CIDR block for the VPC. You can request an Amazon-provided IPv6 CIDR block from Amazon's pool of IPv6 addresses, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP).<br/> For more information, see [Virtual private clouds (VPC)](https://docs.aws.amazon.com/vpc/latest/userguide/configure-your-vpc.html) in the *Amazon VPC User Guide*.
Idaws.ec2.vpc
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
vpc_idstring
instance_tenancystringThe allowed tenancy of instances launched into the VPC.<br/> + ``default``: An instance launched into the VPC runs on shared hardware by default, unless you explicitly specify a different tenancy during instance launch.<br/> + ``dedicated``: An instance launched into the VPC runs on dedicated hardware by default, unless you explicitly specify a tenancy of ``host`` during instance launch. You cannot specify a tenancy of ``default`` during instance launch.<br/> <br/> Updating ``InstanceTenancy`` requires no replacement only if you are updating its value from ``dedicated`` to ``default``. Updating ``InstanceTenancy`` from ``default`` to ``dedicated`` requires replacement.
ipv4_netmask_lengthintegerThe netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*.
cidr_block_associationsarray
cidr_blockstringThe IPv4 network range for the VPC, in CIDR notation. For example, ``10.0.0.0/16``. We modify the specified CIDR block to its canonical form; for example, if you specify ``100.68.0.18/18``, we modify it to ``100.68.0.0/18``.<br/> You must specify either``CidrBlock`` or ``Ipv4IpamPoolId``.
ipv4_ipam_pool_idstringThe ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. For more information, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*.<br/> You must specify either``CidrBlock`` or ``Ipv4IpamPoolId``.
default_network_aclstring
enable_dns_supportbooleanIndicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range "plus two" succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled. Enabled by default. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support).
ipv6_cidr_blocksarray
default_security_groupstring
enable_dns_hostnamesbooleanIndicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not. Disabled by default for nondefault VPCs. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support).<br/> You can only enable DNS hostnames if you've enabled DNS support.
tagsarrayThe tags for the VPC.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +vpc_id, +instance_tenancy, +ipv4_netmask_length, +cidr_block_associations, +cidr_block, +ipv4_ipam_pool_id, +default_network_acl, +enable_dns_support, +ipv6_cidr_blocks, +default_security_group, +enable_dns_hostnames, +tags +FROM aws.ec2.vpc +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the vpc resource, the following permissions are required: + +### Read +```json +ec2:DescribeVpcs, +ec2:DescribeSecurityGroups, +ec2:DescribeNetworkAcls, +ec2:DescribeVpcAttribute +``` + +### Update +```json +ec2:CreateTags, +ec2:ModifyVpcAttribute, +ec2:DeleteTags, +ec2:ModifyVpcTenancy +``` + +### Delete +```json +ec2:DeleteVpc, +ec2:DescribeVpcs +``` + diff --git a/docs/aws-docs/providers/aws/ec2/vpc_attribute/index.md b/docs/aws-docs/providers/aws/ec2/vpc_attribute/index.md deleted file mode 100644 index c22f22759b..0000000000 --- a/docs/aws-docs/providers/aws/ec2/vpc_attribute/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: vpc_attribute -hide_title: false -hide_table_of_contents: false -keywords: - - vpc_attribute - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namevpc_attribute
TypeResource
Idaws.ec2.vpc_attribute
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `enableDnsHostnames` | `object` | Describes a value for a resource attribute that is a Boolean value. | -| `enableDnsSupport` | `object` | Describes a value for a resource attribute that is a Boolean value. | -| `vpcId` | `string` | The ID of the VPC. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `vpc_attribute_Describe` | `SELECT` | `Attribute, VpcId, region` | Describes the specified attribute of the specified VPC. You can specify only one attribute at a time. | -| `vpc_attribute_Modify` | `EXEC` | `VpcId, region` | Modifies the specified attribute of the specified VPC. | diff --git a/docs/aws-docs/providers/aws/ec2/vpc_cidr_block/index.md b/docs/aws-docs/providers/aws/ec2/vpc_cidr_block/index.md index 4cba35f6ea..6a19f5507d 100644 --- a/docs/aws-docs/providers/aws/ec2/vpc_cidr_block/index.md +++ b/docs/aws-docs/providers/aws/ec2/vpc_cidr_block/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - vpc_cidr_block - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,20 +14,83 @@ description: Query, 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_cidr_block resource ## Overview +
Namevpc_cidr_block
TypeResource
DescriptionResource Type definition for AWS::EC2::VPCCidrBlock
Idaws.ec2.vpc_cidr_block
## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command + + + + + + + + + + + + + + +
NameDatatypeDescription
cidr_blockstringAn IPv4 CIDR block to associate with the VPC.
ipv6_poolstringThe ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.
idstringThe Id of the VPC associated CIDR Block.
vpc_idstringThe ID of the VPC.
ipv6_cidr_blockstringAn IPv6 CIDR block from the IPv6 address pool.
ipv4_ipam_pool_idstringThe ID of the IPv4 IPAM pool to Associate a CIDR from to a VPC.
ipv4_netmask_lengthintegerThe netmask length of the IPv4 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool.
ipv6_ipam_pool_idstringThe ID of the IPv6 IPAM pool to Associate a CIDR from to a VPC.
ipv6_netmask_lengthintegerThe netmask length of the IPv6 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool.
amazon_provided_ipv6_cidr_blockbooleanRequests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IPv6 addresses, or the size of the CIDR block.
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `vpc_cidr_block_Associate` | `EXEC` | `VpcId, region` | <p>Associates a CIDR block with your VPC. You can associate a secondary IPv4 CIDR block, an Amazon-provided IPv6 CIDR block, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (<a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html">BYOIP</a>). The IPv6 CIDR block size is fixed at /56.</p> <p>You must specify one of the following in the request: an IPv4 CIDR block, an IPv6 pool, or an Amazon-provided IPv6 CIDR block.</p> <p>For more information about associating CIDR blocks with your VPC and applicable restrictions, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html#VPC_Sizing">VPC and subnet sizing</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p> | -| `vpc_cidr_block_Disassociate` | `EXEC` | `AssociationId, region` | <p>Disassociates a CIDR block from a VPC. To disassociate the CIDR block, you must specify its association ID. You can get the association ID by using <a>DescribeVpcs</a>. You must detach or delete all gateways and resources that are associated with the CIDR block before you can disassociate it. </p> <p>You cannot disassociate the CIDR block with which you originally created the VPC (the primary CIDR block).</p> | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +cidr_block, +ipv6_pool, +id, +vpc_id, +ipv6_cidr_block, +ipv4_ipam_pool_id, +ipv4_netmask_length, +ipv6_ipam_pool_id, +ipv6_netmask_length, +amazon_provided_ipv6_cidr_block +FROM aws.ec2.vpc_cidr_block +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the vpc_cidr_block resource, the following permissions are required: + +### Read +```json +ec2:DescribeVpcs +``` + +### Delete +```json +ec2:DescribeVpcs, +ec2:DisassociateVpcCidrBlock +``` + diff --git a/docs/aws-docs/providers/aws/ec2/vpc_cidr_blocks/index.md b/docs/aws-docs/providers/aws/ec2/vpc_cidr_blocks/index.md new file mode 100644 index 0000000000..c439229464 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/vpc_cidr_blocks/index.md @@ -0,0 +1,81 @@ +--- +title: vpc_cidr_blocks +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_cidr_blocks + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Retrieves a list of vpc_cidr_blocks in a region + +## Overview + + + + + +
Namevpc_cidr_blocks
TypeResource
DescriptionResource Type definition for AWS::EC2::VPCCidrBlock
Idaws.ec2.vpc_cidr_blocks
+ +## Fields + + + + + + +
NameDatatypeDescription
idstringThe Id of the VPC associated CIDR Block.
vpc_idstringThe ID of the VPC.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id, +vpc_id +FROM aws.ec2.vpc_cidr_blocks +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the vpc_cidr_blocks resource, the following permissions are required: + +### Create +```json +ec2:AssociateVpcCidrBlock, +ec2:DescribeVpcs, +ec2:AllocateIpamPoolCidr +``` + +### List +```json +ec2:DescribeVpcs +``` + diff --git a/docs/aws-docs/providers/aws/ec2/vpc_classic_link/index.md b/docs/aws-docs/providers/aws/ec2/vpc_classic_link/index.md deleted file mode 100644 index 95bf6f54be..0000000000 --- a/docs/aws-docs/providers/aws/ec2/vpc_classic_link/index.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: vpc_classic_link -hide_title: false -hide_table_of_contents: false -keywords: - - vpc_classic_link - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namevpc_classic_link
TypeResource
Idaws.ec2.vpc_classic_link
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `classicLinkEnabled` | `boolean` | Indicates whether the VPC is enabled for ClassicLink. | -| `tagSet` | `array` | Any tags assigned to the VPC. | -| `vpcId` | `string` | The ID of the VPC. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `vpc_classic_link_Describe` | `SELECT` | `region` | Describes the ClassicLink status of one or more VPCs. | -| `vpc_classic_link_Disable` | `EXEC` | `VpcId, region` | Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it. | -| `vpc_classic_link_Enable` | `EXEC` | `VpcId, region` | Enables a VPC for ClassicLink. You can then link EC2-Classic instances to your ClassicLink-enabled VPC to allow communication over private IP addresses. You cannot enable your VPC for ClassicLink if any of your VPC route tables have existing routes for address ranges within the <code>10.0.0.0/8</code> IP address range, excluding local routes for VPCs in the <code>10.0.0.0/16</code> and <code>10.1.0.0/16</code> IP address ranges. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html">ClassicLink</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. | diff --git a/docs/aws-docs/providers/aws/ec2/vpc_classic_link_dns_support/index.md b/docs/aws-docs/providers/aws/ec2/vpc_classic_link_dns_support/index.md deleted file mode 100644 index dbb0908766..0000000000 --- a/docs/aws-docs/providers/aws/ec2/vpc_classic_link_dns_support/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: vpc_classic_link_dns_support -hide_title: false -hide_table_of_contents: false -keywords: - - vpc_classic_link_dns_support - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namevpc_classic_link_dns_support
TypeResource
Idaws.ec2.vpc_classic_link_dns_support
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `classicLinkDnsSupported` | `boolean` | Indicates whether ClassicLink DNS support is enabled for the VPC. | -| `vpcId` | `string` | The ID of the VPC. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `vpc_classic_link_dns_support_Describe` | `SELECT` | `region` | Describes the ClassicLink DNS support status of one or more VPCs. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html">ClassicLink</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. | -| `vpc_classic_link_dns_support_Disable` | `EXEC` | `region` | <p>Disables ClassicLink DNS support for a VPC. If disabled, DNS hostnames resolve to public IP addresses when addressed between a linked EC2-Classic instance and instances in the VPC to which it's linked. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html">ClassicLink</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>You must specify a VPC ID in the request.</p> | -| `vpc_classic_link_dns_support_Enable` | `EXEC` | `region` | <p>Enables a VPC to support DNS hostname resolution for ClassicLink. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html">ClassicLink</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>You must specify a VPC ID in the request.</p> | diff --git a/docs/aws-docs/providers/aws/ec2/vpc_endpoint/index.md b/docs/aws-docs/providers/aws/ec2/vpc_endpoint/index.md new file mode 100644 index 0000000000..ec78473ee3 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/vpc_endpoint/index.md @@ -0,0 +1,111 @@ +--- +title: vpc_endpoint +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_endpoint + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual vpc_endpoint resource + +## Overview + + + + + +
Namevpc_endpoint
TypeResource
DescriptionSpecifies a VPC endpoint. A VPC endpoint provides a private connection between your VPC and an endpoint service. You can use an endpoint service provided by AWS, an MKT Partner, or another AWS accounts in your organization. For more information, see the [User Guide](https://docs.aws.amazon.com/vpc/latest/privatelink/).<br/> An endpoint of type ``Interface`` establishes connections between the subnets in your VPC and an AWS-service, your own service, or a service hosted by another AWS-account. With an interface VPC endpoint, you specify the subnets in which to create the endpoint and the security groups to associate with the endpoint network interfaces.<br/> An endpoint of type ``gateway`` serves as a target for a route in your route table for traffic destined for S3 or DDB. You can specify an endpoint policy for the endpoint, which controls access to the service from your VPC. You can also specify the VPC route tables that use the endpoint. For more information about connectivity to S3, see [W
Idaws.ec2.vpc_endpoint
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
idstring
creation_timestampstring
dns_entriesarray
network_interface_idsarray
policy_documentobjectAn endpoint policy, which controls access to the service from the VPC. The default endpoint policy allows full access to the service. Endpoint policies are supported only for gateway and interface endpoints.<br/> For CloudFormation templates in YAML, you can provide the policy in JSON or YAML format. CFNlong converts YAML policies to JSON format before calling the API to create or modify the VPC endpoint.
private_dns_enabledbooleanIndicate whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, ``kinesis.us-east-1.amazonaws.com``), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service.<br/> To use a private hosted zone, you must set the following VPC attributes to ``true``: ``enableDnsHostnames`` and ``enableDnsSupport``.<br/> This property is supported only for interface endpoints.<br/> Default: ``false``
route_table_idsarrayThe IDs of the route tables. Routing is supported only for gateway endpoints.
security_group_idsarrayThe IDs of the security groups to associate with the endpoint network interfaces. If this parameter is not specified, we use the default security group for the VPC. Security groups are supported only for interface endpoints.
service_namestringThe name of the endpoint service.
subnet_idsarrayThe IDs of the subnets in which to create endpoint network interfaces. You must specify this property for an interface endpoint or a Gateway Load Balancer endpoint. You can't specify this property for a gateway endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet.
vpc_endpoint_typestringThe type of endpoint.<br/> Default: Gateway
vpc_idstringThe ID of the VPC.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +creation_timestamp, +dns_entries, +network_interface_ids, +policy_document, +private_dns_enabled, +route_table_ids, +security_group_ids, +service_name, +subnet_ids, +vpc_endpoint_type, +vpc_id +FROM aws.ec2.vpc_endpoint +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the vpc_endpoint resource, the following permissions are required: + +### Read +```json +ec2:DescribeVpcEndpoints +``` + +### Update +```json +ec2:ModifyVpcEndpoint, +ec2:DescribeVpcEndpoints +``` + +### Delete +```json +ec2:DeleteVpcEndpoints, +ec2:DescribeVpcEndpoints +``` + diff --git a/docs/aws-docs/providers/aws/ec2/vpc_endpoint_connection_notification/index.md b/docs/aws-docs/providers/aws/ec2/vpc_endpoint_connection_notification/index.md new file mode 100644 index 0000000000..c04b474bc8 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/vpc_endpoint_connection_notification/index.md @@ -0,0 +1,96 @@ +--- +title: vpc_endpoint_connection_notification +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_endpoint_connection_notification + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual vpc_endpoint_connection_notification resource + +## Overview + + + + + +
Namevpc_endpoint_connection_notification
TypeResource
DescriptionResource Type definition for AWS::EC2::VPCEndpointConnectionNotification
Idaws.ec2.vpc_endpoint_connection_notification
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
vpc_endpoint_connection_notification_idstringVPC Endpoint Connection ID generated by service
connection_eventsarrayThe endpoint events for which to receive notifications.
connection_notification_arnstringThe ARN of the SNS topic for the notifications.
service_idstringThe ID of the endpoint service.
vpc_endpoint_idstringThe ID of the endpoint.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +vpc_endpoint_connection_notification_id, +connection_events, +connection_notification_arn, +service_id, +vpc_endpoint_id +FROM aws.ec2.vpc_endpoint_connection_notification +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the vpc_endpoint_connection_notification resource, the following permissions are required: + +### Read +```json +ec2:DescribeVpcEndpointConnectionNotifications +``` + +### Update +```json +ec2:ModifyVpcEndpointConnectionNotification, +ec2:DescribeVpcEndpointConnectionNotifications +``` + +### Delete +```json +ec2:DeleteVpcEndpointConnectionNotifications +``` + diff --git a/docs/aws-docs/providers/aws/ec2/vpc_endpoint_connection_notifications/index.md b/docs/aws-docs/providers/aws/ec2/vpc_endpoint_connection_notifications/index.md index a8dd3a039b..bf065d48a6 100644 --- a/docs/aws-docs/providers/aws/ec2/vpc_endpoint_connection_notifications/index.md +++ b/docs/aws-docs/providers/aws/ec2/vpc_endpoint_connection_notifications/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - vpc_endpoint_connection_notifications - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,30 +14,64 @@ description: Query, deploy 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_endpoint_connection_notifications in a region ## Overview +
Namevpc_endpoint_connection_notifications
TypeResource
DescriptionResource Type definition for AWS::EC2::VPCEndpointConnectionNotification
Idaws.ec2.vpc_endpoint_connection_notifications
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `connectionEvents` | `array` | The events for the notification. Valid values are <code>Accept</code>, <code>Connect</code>, <code>Delete</code>, and <code>Reject</code>. | -| `connectionNotificationArn` | `string` | The ARN of the SNS topic for the notification. | -| `connectionNotificationId` | `string` | The ID of the notification. | -| `connectionNotificationState` | `string` | The state of the notification. | -| `connectionNotificationType` | `string` | The type of notification. | -| `serviceId` | `string` | The ID of the endpoint service. | -| `vpcEndpointId` | `string` | The ID of the VPC endpoint. | + + + + + +
NameDatatypeDescription
vpc_endpoint_connection_notification_idstringVPC Endpoint Connection ID generated by service
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `vpc_endpoint_connection_notifications_Describe` | `SELECT` | `region` | Describes the connection notifications for VPC endpoints and VPC endpoint services. | -| `vpc_endpoint_connection_notification_Create` | `INSERT` | `ConnectionEvents, ConnectionNotificationArn, region` | <p>Creates a connection notification for a specified VPC endpoint or VPC endpoint service. A connection notification notifies you of specific endpoint events. You must create an SNS topic to receive notifications. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html">Create a Topic</a> in the <i>Amazon Simple Notification Service Developer Guide</i>.</p> <p>You can create a connection notification for interface endpoints only.</p> | -| `vpc_endpoint_connection_notifications_Delete` | `DELETE` | `ConnectionNotificationId, region` | Deletes one or more VPC endpoint connection notifications. | -| `vpc_endpoint_connection_notification_Modify` | `EXEC` | `ConnectionNotificationId, region` | Modifies a connection notification for VPC endpoint or VPC endpoint service. You can change the SNS topic for the notification, or the events for which to be notified. | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +vpc_endpoint_connection_notification_id +FROM aws.ec2.vpc_endpoint_connection_notifications +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the vpc_endpoint_connection_notifications resource, the following permissions are required: + +### Create +```json +ec2:CreateVpcEndpointConnectionNotification +``` + +### List +```json +ec2:DescribeVpcEndpointConnectionNotifications +``` + diff --git a/docs/aws-docs/providers/aws/ec2/vpc_endpoint_connections/index.md b/docs/aws-docs/providers/aws/ec2/vpc_endpoint_connections/index.md deleted file mode 100644 index dc997f64a0..0000000000 --- a/docs/aws-docs/providers/aws/ec2/vpc_endpoint_connections/index.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: vpc_endpoint_connections -hide_title: false -hide_table_of_contents: false -keywords: - - vpc_endpoint_connections - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namevpc_endpoint_connections
TypeResource
Idaws.ec2.vpc_endpoint_connections
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `creationTimestamp` | `string` | The date and time that the VPC endpoint was created. | -| `dnsEntrySet` | `array` | The DNS entries for the VPC endpoint. | -| `gatewayLoadBalancerArnSet` | `array` | The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service. | -| `ipAddressType` | `string` | The IP address type for the endpoint. | -| `networkLoadBalancerArnSet` | `array` | The Amazon Resource Names (ARNs) of the network load balancers for the service. | -| `serviceId` | `string` | The ID of the service to which the endpoint is connected. | -| `vpcEndpointId` | `string` | The ID of the VPC endpoint. | -| `vpcEndpointOwner` | `string` | The ID of the Amazon Web Services account that owns the VPC endpoint. | -| `vpcEndpointState` | `string` | The state of the VPC endpoint. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `vpc_endpoint_connections_Describe` | `SELECT` | `region` | Describes the VPC endpoint connections to your VPC endpoint services, including any endpoints that are pending your acceptance. | -| `vpc_endpoint_connections_Accept` | `EXEC` | `ServiceId, VpcEndpointId, region` | Accepts one or more interface VPC endpoint connection requests to your VPC endpoint service. | -| `vpc_endpoint_connections_Reject` | `EXEC` | `ServiceId, VpcEndpointId, region` | Rejects one or more VPC endpoint connection requests to your VPC endpoint service. | diff --git a/docs/aws-docs/providers/aws/ec2/vpc_endpoint_service/index.md b/docs/aws-docs/providers/aws/ec2/vpc_endpoint_service/index.md new file mode 100644 index 0000000000..9bbdae1b38 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/vpc_endpoint_service/index.md @@ -0,0 +1,107 @@ +--- +title: vpc_endpoint_service +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_endpoint_service + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual vpc_endpoint_service resource + +## Overview + + + + + +
Namevpc_endpoint_service
TypeResource
DescriptionResource Type definition for AWS::EC2::VPCEndpointService
Idaws.ec2.vpc_endpoint_service
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
network_load_balancer_arnsarray
contributor_insights_enabledboolean
payer_responsibilitystring
service_idstring
acceptance_requiredboolean
gateway_load_balancer_arnsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +network_load_balancer_arns, +contributor_insights_enabled, +payer_responsibility, +service_id, +acceptance_required, +gateway_load_balancer_arns +FROM aws.ec2.vpc_endpoint_service +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the vpc_endpoint_service resource, the following permissions are required: + +### Update +```json +ec2:ModifyVpcEndpointServiceConfiguration, +ec2:DeleteVpcEndpointServiceConfigurations, +ec2:DescribeVpcEndpointServiceConfigurations, +ec2:ModifyVpcEndpointServicePayerResponsibility, +cloudwatch:ListManagedInsightRules, +cloudwatch:DeleteInsightRules, +cloudwatch:PutManagedInsightRules +``` + +### Read +```json +ec2:DescribeVpcEndpointServiceConfigurations, +cloudwatch:ListManagedInsightRules +``` + +### Delete +```json +ec2:DeleteVpcEndpointServiceConfigurations, +ec2:DescribeVpcEndpointServiceConfigurations, +cloudwatch:ListManagedInsightRules, +cloudwatch:DeleteInsightRules +``` + diff --git a/docs/aws-docs/providers/aws/ec2/vpc_endpoint_service_configurations/index.md b/docs/aws-docs/providers/aws/ec2/vpc_endpoint_service_configurations/index.md deleted file mode 100644 index 1b95aef94a..0000000000 --- a/docs/aws-docs/providers/aws/ec2/vpc_endpoint_service_configurations/index.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: vpc_endpoint_service_configurations -hide_title: false -hide_table_of_contents: false -keywords: - - vpc_endpoint_service_configurations - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namevpc_endpoint_service_configurations
TypeResource
Idaws.ec2.vpc_endpoint_service_configurations
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `acceptanceRequired` | `boolean` | Indicates whether requests from other Amazon Web Services accounts to create an endpoint to the service must first be accepted. | -| `availabilityZoneSet` | `array` | The Availability Zones in which the service is available. | -| `baseEndpointDnsNameSet` | `array` | The DNS names for the service. | -| `gatewayLoadBalancerArnSet` | `array` | The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service. | -| `managesVpcEndpoints` | `boolean` | Indicates whether the service manages its VPC endpoints. Management of the service VPC endpoints using the VPC endpoint API is restricted. | -| `networkLoadBalancerArnSet` | `array` | The Amazon Resource Names (ARNs) of the Network Load Balancers for the service. | -| `payerResponsibility` | `string` | The payer responsibility. | -| `privateDnsName` | `string` | The private DNS name for the service. | -| `privateDnsNameConfiguration` | `object` | Information about the private DNS name for the service endpoint. | -| `serviceId` | `string` | The ID of the service. | -| `serviceName` | `string` | The name of the service. | -| `serviceState` | `string` | The service state. | -| `serviceType` | `array` | The type of service. | -| `supportedIpAddressTypeSet` | `array` | The supported IP address types. | -| `tagSet` | `array` | Any tags assigned to the service. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `vpc_endpoint_service_configurations_Describe` | `SELECT` | `region` | Describes the VPC endpoint service configurations in your account (your services). | -| `vpc_endpoint_service_configuration_Create` | `INSERT` | `region` | <p>Creates a VPC endpoint service to which service consumers (Amazon Web Services accounts, IAM users, and IAM roles) can connect.</p> <p>Before you create an endpoint service, you must create one of the following for your service:</p> <ul> <li> <p>A <a href="https://docs.aws.amazon.com/elasticloadbalancing/latest/network/">Network Load Balancer</a>. Service consumers connect to your service using an interface endpoint.</p> </li> <li> <p>A <a href="https://docs.aws.amazon.com/elasticloadbalancing/latest/gateway/">Gateway Load Balancer</a>. Service consumers connect to your service using a Gateway Load Balancer endpoint.</p> </li> </ul> <p>If you set the private DNS name, you must prove that you own the private DNS domain name.</p> <p>For more information, see the <a href="https://docs.aws.amazon.com/vpc/latest/privatelink/">Amazon Web Services PrivateLink Guide</a>.</p> | -| `vpc_endpoint_service_configurations_Delete` | `DELETE` | `ServiceId, region` | Deletes one or more VPC endpoint service configurations in your account. Before you delete the endpoint service configuration, you must reject any <code>Available</code> or <code>PendingAcceptance</code> interface endpoint connections that are attached to the service. | -| `vpc_endpoint_service_configuration_Modify` | `EXEC` | `ServiceId, region` | <p>Modifies the attributes of your VPC endpoint service configuration. You can change the Network Load Balancers or Gateway Load Balancers for your service, and you can specify whether acceptance is required for requests to connect to your endpoint service through an interface VPC endpoint.</p> <p>If you set or modify the private DNS name, you must prove that you own the private DNS domain name.</p> | diff --git a/docs/aws-docs/providers/aws/ec2/vpc_endpoint_service_payer_responsibility/index.md b/docs/aws-docs/providers/aws/ec2/vpc_endpoint_service_payer_responsibility/index.md deleted file mode 100644 index f6a1e51efa..0000000000 --- a/docs/aws-docs/providers/aws/ec2/vpc_endpoint_service_payer_responsibility/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: vpc_endpoint_service_payer_responsibility -hide_title: false -hide_table_of_contents: false -keywords: - - vpc_endpoint_service_payer_responsibility - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namevpc_endpoint_service_payer_responsibility
TypeResource
Idaws.ec2.vpc_endpoint_service_payer_responsibility
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `vpc_endpoint_service_payer_responsibility_Modify` | `EXEC` | `PayerResponsibility, ServiceId, region` | diff --git a/docs/aws-docs/providers/aws/ec2/vpc_endpoint_service_permissions/index.md b/docs/aws-docs/providers/aws/ec2/vpc_endpoint_service_permissions/index.md index cd709d3fb5..6a31243ea8 100644 --- a/docs/aws-docs/providers/aws/ec2/vpc_endpoint_service_permissions/index.md +++ b/docs/aws-docs/providers/aws/ec2/vpc_endpoint_service_permissions/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - vpc_endpoint_service_permissions - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,23 +14,85 @@ description: Query, 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_service_permissions resource ## Overview +
Namevpc_endpoint_service_permissions
TypeResource
DescriptionResource Type definition for AWS::EC2::VPCEndpointServicePermissions
Idaws.ec2.vpc_endpoint_service_permissions
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `principal` | `string` | The Amazon Resource Name (ARN) of the principal. | -| `principalType` | `string` | The type of principal. | + + + + + + +
NameDatatypeDescription
allowed_principalsarray
service_idstring
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `vpc_endpoint_service_permissions_Describe` | `SELECT` | `ServiceId, region` | Describes the principals (service consumers) that are permitted to discover your VPC endpoint service. | -| `vpc_endpoint_service_permissions_Modify` | `EXEC` | `ServiceId, region` | <p>Modifies the permissions for your VPC endpoint service. You can add or remove permissions for service consumers (IAM users, IAM roles, and Amazon Web Services accounts) to connect to your endpoint service.</p> <p>If you grant permissions to all principals, the service is public. Any users who know the name of a public service can send a request to attach an endpoint. If the service does not require manual approval, attachments are automatically approved.</p> | + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +allowed_principals, +service_id +FROM aws.ec2.vpc_endpoint_service_permissions +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the vpc_endpoint_service_permissions resource, the following permissions are required: + +### Update +```json +ec2:CreateVpcEndpointServicePermissions, +ec2:ModifyVpcEndpointServicePermissions, +ec2:DeleteVpcEndpointServicePermissions, +ec2:DescribeVpcEndpointServicePermissions +``` + +### Read +```json +ec2:CreateVpcEndpointServicePermissions, +ec2:ModifyVpcEndpointServicePermissions, +ec2:DeleteVpcEndpointServicePermissions, +ec2:DescribeVpcEndpointServicePermissions +``` + +### Delete +```json +ec2:CreateVpcEndpointServicePermissions, +ec2:ModifyVpcEndpointServicePermissions, +ec2:DeleteVpcEndpointServicePermissions, +ec2:DescribeVpcEndpointServicePermissions +``` + diff --git a/docs/aws-docs/providers/aws/ec2/vpc_endpoint_service_private_dns_verification/index.md b/docs/aws-docs/providers/aws/ec2/vpc_endpoint_service_private_dns_verification/index.md deleted file mode 100644 index 875a26720d..0000000000 --- a/docs/aws-docs/providers/aws/ec2/vpc_endpoint_service_private_dns_verification/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: vpc_endpoint_service_private_dns_verification -hide_title: false -hide_table_of_contents: false -keywords: - - vpc_endpoint_service_private_dns_verification - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namevpc_endpoint_service_private_dns_verification
TypeResource
Idaws.ec2.vpc_endpoint_service_private_dns_verification
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `vpc_endpoint_service_private_dns_verification_Start` | `EXEC` | `ServiceId, region` | diff --git a/docs/aws-docs/providers/aws/ec2/vpc_endpoint_services/index.md b/docs/aws-docs/providers/aws/ec2/vpc_endpoint_services/index.md index e028a30a32..ceb26bdfcd 100644 --- a/docs/aws-docs/providers/aws/ec2/vpc_endpoint_services/index.md +++ b/docs/aws-docs/providers/aws/ec2/vpc_endpoint_services/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - vpc_endpoint_services - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,35 +14,71 @@ description: Query, deploy 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_endpoint_services in a region ## Overview +
Namevpc_endpoint_services
TypeResource
DescriptionResource Type definition for AWS::EC2::VPCEndpointService
Idaws.ec2.vpc_endpoint_services
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `acceptanceRequired` | `boolean` | Indicates whether VPC endpoint connection requests to the service must be accepted by the service owner. | -| `availabilityZoneSet` | `array` | The Availability Zones in which the service is available. | -| `baseEndpointDnsNameSet` | `array` | The DNS names for the service. | -| `managesVpcEndpoints` | `boolean` | Indicates whether the service manages its VPC endpoints. Management of the service VPC endpoints using the VPC endpoint API is restricted. | -| `owner` | `string` | The Amazon Web Services account ID of the service owner. | -| `payerResponsibility` | `string` | The payer responsibility. | -| `privateDnsName` | `string` | The private DNS name for the service. | -| `privateDnsNameSet` | `array` | The private DNS names assigned to the VPC endpoint service. | -| `privateDnsNameVerificationState` | `string` | <p>The verification state of the VPC endpoint service.</p> <p>Consumers of the endpoint service cannot use the private name when the state is not <code>verified</code>.</p> | -| `serviceId` | `string` | The ID of the endpoint service. | -| `serviceName` | `string` | The Amazon Resource Name (ARN) of the service. | -| `serviceType` | `array` | The type of service. | -| `supportedIpAddressTypeSet` | `array` | The supported IP address types. | -| `tagSet` | `array` | Any tags assigned to the service. | -| `vpcEndpointPolicySupported` | `boolean` | Indicates whether the service supports endpoint policies. | + + + + + +
NameDatatypeDescription
service_idstring
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `vpc_endpoint_services_Describe` | `SELECT` | `region` | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +service_id +FROM aws.ec2.vpc_endpoint_services +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the vpc_endpoint_services resource, the following permissions are required: + +### Create +```json +ec2:CreateVpcEndpointServiceConfiguration, +ec2:ModifyVpcEndpointServiceConfiguration, +ec2:ModifyVpcEndpointServicePayerResponsibility, +cloudwatch:ListManagedInsightRules, +cloudwatch:DeleteInsightRules, +cloudwatch:PutManagedInsightRules, +ec2:DescribeVpcEndpointServiceConfigurations +``` + +### List +```json +ec2:DescribeVpcEndpointServiceConfigurations, +cloudwatch:ListManagedInsightRules +``` + diff --git a/docs/aws-docs/providers/aws/ec2/vpc_endpoints/index.md b/docs/aws-docs/providers/aws/ec2/vpc_endpoints/index.md index f57f105b79..2f91d281bf 100644 --- a/docs/aws-docs/providers/aws/ec2/vpc_endpoints/index.md +++ b/docs/aws-docs/providers/aws/ec2/vpc_endpoints/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - vpc_endpoints - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,42 +14,65 @@ description: Query, deploy 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
DescriptionSpecifies a VPC endpoint. A VPC endpoint provides a private connection between your VPC and an endpoint service. You can use an endpoint service provided by AWS, an MKT Partner, or another AWS accounts in your organization. For more information, see the [User Guide](https://docs.aws.amazon.com/vpc/latest/privatelink/).<br/> An endpoint of type ``Interface`` establishes connections between the subnets in your VPC and an AWS-service, your own service, or a service hosted by another AWS-account. With an interface VPC endpoint, you specify the subnets in which to create the endpoint and the security groups to associate with the endpoint network interfaces.<br/> An endpoint of type ``gateway`` serves as a target for a route in your route table for traffic destined for S3 or DDB. You can specify an endpoint policy for the endpoint, which controls access to the service from your VPC. You can also specify the VPC route tables that use the endpoint. For more information about connectivity to S3, see [W
Idaws.ec2.vpc_endpoints
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `creationTimestamp` | `string` | The date and time that the endpoint was created. | -| `dnsEntrySet` | `array` | (Interface endpoint) The DNS entries for the endpoint. | -| `dnsOptions` | `object` | Describes the DNS options for an endpoint. | -| `groupSet` | `array` | (Interface endpoint) Information about the security groups that are associated with the network interface. | -| `ipAddressType` | `string` | The IP address type for the endpoint. | -| `lastError` | `object` | The last error that occurred for a VPC endpoint. | -| `networkInterfaceIdSet` | `array` | (Interface endpoint) One or more network interfaces for the endpoint. | -| `ownerId` | `string` | The ID of the Amazon Web Services account that owns the endpoint. | -| `policyDocument` | `string` | The policy document associated with the endpoint, if applicable. | -| `privateDnsEnabled` | `boolean` | (Interface endpoint) Indicates whether the VPC is associated with a private hosted zone. | -| `requesterManaged` | `boolean` | Indicates whether the endpoint is being managed by its service. | -| `routeTableIdSet` | `array` | (Gateway endpoint) One or more route tables associated with the endpoint. | -| `serviceName` | `string` | The name of the service to which the endpoint is associated. | -| `state` | `string` | The state of the endpoint. | -| `subnetIdSet` | `array` | (Interface endpoint) The subnets for the endpoint. | -| `tagSet` | `array` | Any tags assigned to the endpoint. | -| `vpcEndpointId` | `string` | The ID of the endpoint. | -| `vpcEndpointType` | `string` | The type of endpoint. | -| `vpcId` | `string` | The ID of the VPC to which the endpoint is associated. | + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `vpc_endpoints_Describe` | `SELECT` | `region` | Describes one or more of your VPC endpoints. | -| `vpc_endpoint_Create` | `INSERT` | `ServiceName, VpcId, region` | Creates a VPC endpoint for a specified service. An endpoint enables you to create a private connection between your VPC and the service. The service may be provided by Amazon Web Services, an Amazon Web Services Marketplace Partner, or another Amazon Web Services account. For more information, see the <a href="https://docs.aws.amazon.com/vpc/latest/privatelink/">Amazon Web Services PrivateLink Guide</a>. | -| `vpc_endpoints_Delete` | `DELETE` | `VpcEndpointId, region` | <p>Deletes one or more specified VPC endpoints. You can delete any of the following types of VPC endpoints. </p> <ul> <li> <p>Gateway endpoint,</p> </li> <li> <p>Gateway Load Balancer endpoint,</p> </li> <li> <p>Interface endpoint</p> </li> </ul> <p>The following rules apply when you delete a VPC endpoint:</p> <ul> <li> <p>When you delete a gateway endpoint, we delete the endpoint routes in the route tables that are associated with the endpoint.</p> </li> <li> <p>When you delete a Gateway Load Balancer endpoint, we delete the endpoint network interfaces. </p> <p>You can only delete Gateway Load Balancer endpoints when the routes that are associated with the endpoint are deleted.</p> </li> <li> <p>When you delete an interface endpoint, we delete the endpoint network interfaces.</p> </li> </ul> | -| `vpc_endpoint_Modify` | `EXEC` | `VpcEndpointId, region` | Modifies attributes of a specified VPC endpoint. The attributes that you can modify depend on the type of VPC endpoint (interface, gateway, or Gateway Load Balancer). For more information, see the <a href="https://docs.aws.amazon.com/vpc/latest/privatelink/">Amazon Web Services PrivateLink Guide</a>. | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.ec2.vpc_endpoints +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the vpc_endpoints resource, the following permissions are required: + +### Create +```json +ec2:CreateVpcEndpoint, +ec2:DescribeVpcEndpoints +``` + +### List +```json +ec2:DescribeVpcEndpoints +``` + diff --git a/docs/aws-docs/providers/aws/ec2/vpc_gateway_attachment/index.md b/docs/aws-docs/providers/aws/ec2/vpc_gateway_attachment/index.md new file mode 100644 index 0000000000..1df9e023a7 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/vpc_gateway_attachment/index.md @@ -0,0 +1,102 @@ +--- +title: vpc_gateway_attachment +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_gateway_attachment + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual vpc_gateway_attachment resource + +## Overview + + + + + +
Namevpc_gateway_attachment
TypeResource
DescriptionResource Type definition for AWS::EC2::VPCGatewayAttachment
Idaws.ec2.vpc_gateway_attachment
+ +## Fields + + + + + + + + +
NameDatatypeDescription
attachment_typestringUsed to identify if this resource is an Internet Gateway or Vpn Gateway Attachment
internet_gateway_idstringThe ID of the internet gateway. You must specify either InternetGatewayId or VpnGatewayId, but not both.
vpc_idstringThe ID of the VPC.
vpn_gateway_idstringThe ID of the virtual private gateway. You must specify either InternetGatewayId or VpnGatewayId, but not both.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +attachment_type, +internet_gateway_id, +vpc_id, +vpn_gateway_id +FROM aws.ec2.vpc_gateway_attachment +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the vpc_gateway_attachment resource, the following permissions are required: + +### Read +```json +ec2:DescribeInternetGateways, +ec2:DescribeVpnGateways +``` + +### Update +```json +ec2:AttachInternetGateway, +ec2:AttachVpnGateway, +ec2:DetachInternetGateway, +ec2:DetachVpnGateway, +ec2:DescribeInternetGateways, +ec2:DescribeVpnGateways +``` + +### Delete +```json +ec2:DetachInternetGateway, +ec2:DetachVpnGateway, +ec2:DescribeInternetGateways, +ec2:DescribeVpnGateways +``` + diff --git a/docs/aws-docs/providers/aws/ec2/vpc_gateway_attachments/index.md b/docs/aws-docs/providers/aws/ec2/vpc_gateway_attachments/index.md new file mode 100644 index 0000000000..0436937075 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/vpc_gateway_attachments/index.md @@ -0,0 +1,83 @@ +--- +title: vpc_gateway_attachments +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_gateway_attachments + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Retrieves a list of vpc_gateway_attachments in a region + +## Overview + + + + + +
Namevpc_gateway_attachments
TypeResource
DescriptionResource Type definition for AWS::EC2::VPCGatewayAttachment
Idaws.ec2.vpc_gateway_attachments
+ +## Fields + + + + + + +
NameDatatypeDescription
attachment_typestringUsed to identify if this resource is an Internet Gateway or Vpn Gateway Attachment
vpc_idstringThe ID of the VPC.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +attachment_type, +vpc_id +FROM aws.ec2.vpc_gateway_attachments +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the vpc_gateway_attachments resource, the following permissions are required: + +### Create +```json +ec2:AttachInternetGateway, +ec2:AttachVpnGateway, +ec2:DescribeInternetGateways, +ec2:DescribeVpnGateways +``` + +### List +```json +ec2:DescribeInternetGateways, +ec2:DescribeVpnGateways +``` + diff --git a/docs/aws-docs/providers/aws/ec2/vpc_peering_connection/index.md b/docs/aws-docs/providers/aws/ec2/vpc_peering_connection/index.md new file mode 100644 index 0000000000..3c32b30467 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/vpc_peering_connection/index.md @@ -0,0 +1,102 @@ +--- +title: vpc_peering_connection +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_peering_connection + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual vpc_peering_connection resource + +## Overview + + + + + +
Namevpc_peering_connection
TypeResource
DescriptionResource Type definition for AWS::EC2::VPCPeeringConnection
Idaws.ec2.vpc_peering_connection
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
idstring
peer_owner_idstringThe AWS account ID of the owner of the accepter VPC.
peer_regionstringThe Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request.
peer_role_arnstringThe Amazon Resource Name (ARN) of the VPC peer role for the peering connection in another AWS account.
peer_vpc_idstringThe ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request.
vpc_idstringThe ID of the VPC.
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +peer_owner_id, +peer_region, +peer_role_arn, +peer_vpc_id, +vpc_id, +tags +FROM aws.ec2.vpc_peering_connection +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the vpc_peering_connection resource, the following permissions are required: + +### Read +```json +ec2:DescribeVpcPeeringConnections +``` + +### Update +```json +ec2:CreateTags, +ec2:DeleteTags, +ec2:DescribeVpcPeeringConnections +``` + +### Delete +```json +ec2:DeleteVpcPeeringConnection, +ec2:DescribeVpcPeeringConnections +``` + diff --git a/docs/aws-docs/providers/aws/ec2/vpc_peering_connection_options/index.md b/docs/aws-docs/providers/aws/ec2/vpc_peering_connection_options/index.md deleted file mode 100644 index b696d2635f..0000000000 --- a/docs/aws-docs/providers/aws/ec2/vpc_peering_connection_options/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: vpc_peering_connection_options -hide_title: false -hide_table_of_contents: false -keywords: - - vpc_peering_connection_options - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namevpc_peering_connection_options
TypeResource
Idaws.ec2.vpc_peering_connection_options
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `vpc_peering_connection_options_Modify` | `EXEC` | `VpcPeeringConnectionId, region` | diff --git a/docs/aws-docs/providers/aws/ec2/vpc_peering_connections/index.md b/docs/aws-docs/providers/aws/ec2/vpc_peering_connections/index.md index 66f3f08587..0afa981684 100644 --- a/docs/aws-docs/providers/aws/ec2/vpc_peering_connections/index.md +++ b/docs/aws-docs/providers/aws/ec2/vpc_peering_connections/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - vpc_peering_connections - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,30 +14,68 @@ description: Query, deploy 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_peering_connections in a region ## Overview +
Namevpc_peering_connections
TypeResource
DescriptionResource Type definition for AWS::EC2::VPCPeeringConnection
Idaws.ec2.vpc_peering_connections
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `accepterVpcInfo` | `object` | Describes a VPC in a VPC peering connection. | -| `expirationTime` | `string` | The time that an unaccepted VPC peering connection will expire. | -| `requesterVpcInfo` | `object` | Describes a VPC in a VPC peering connection. | -| `status` | `object` | Describes the status of a VPC peering connection. | -| `tagSet` | `array` | Any tags assigned to the resource. | -| `vpcPeeringConnectionId` | `string` | The ID of the VPC peering connection. | + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `vpc_peering_connections_Describe` | `SELECT` | `region` | Describes one or more of your VPC peering connections. | -| `vpc_peering_connection_Create` | `INSERT` | `region` | <p>Requests a VPC peering connection between two VPCs: a requester VPC that you own and an accepter VPC with which to create the connection. The accepter VPC can belong to another Amazon Web Services account and can be in a different Region to the requester VPC. The requester VPC and accepter VPC cannot have overlapping CIDR blocks.</p> <note> <p>Limitations and rules apply to a VPC peering connection. For more information, see the <a href="https://docs.aws.amazon.com/vpc/latest/peering/vpc-peering-basics.html#vpc-peering-limitations">limitations</a> section in the <i>VPC Peering Guide</i>.</p> </note> <p>The owner of the accepter VPC must accept the peering request to activate the peering connection. The VPC peering connection request expires after 7 days, after which it cannot be accepted or rejected.</p> <p>If you create a VPC peering connection request between VPCs with overlapping CIDR blocks, the VPC peering connection has a status of <code>failed</code>.</p> | -| `vpc_peering_connection_Delete` | `DELETE` | `VpcPeeringConnectionId, region` | Deletes a VPC peering connection. Either the owner of the requester VPC or the owner of the accepter VPC can delete the VPC peering connection if it's in the <code>active</code> state. The owner of the requester VPC can delete a VPC peering connection in the <code>pending-acceptance</code> state. You cannot delete a VPC peering connection that's in the <code>failed</code> state. | -| `vpc_peering_connection_Accept` | `EXEC` | `region` | <p>Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the <code>pending-acceptance</code> state, and you must be the owner of the peer VPC. Use <a>DescribeVpcPeeringConnections</a> to view your outstanding VPC peering connection requests.</p> <p>For an inter-Region VPC peering connection request, you must accept the VPC peering connection in the Region of the accepter VPC.</p> | -| `vpc_peering_connection_Reject` | `EXEC` | `VpcPeeringConnectionId, region` | Rejects a VPC peering connection request. The VPC peering connection must be in the <code>pending-acceptance</code> state. Use the <a>DescribeVpcPeeringConnections</a> request to view your outstanding VPC peering connection requests. To delete an active VPC peering connection, or to delete a VPC peering connection request that you initiated, use <a>DeleteVpcPeeringConnection</a>. | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.ec2.vpc_peering_connections +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the vpc_peering_connections resource, the following permissions are required: + +### Create +```json +ec2:CreateVpcPeeringConnection, +ec2:DescribeVpcPeeringConnections, +ec2:AcceptVpcPeeringConnection, +ec2:CreateTags, +sts:AssumeRole +``` + +### List +```json +ec2:DescribeVpcPeeringConnections +``` + diff --git a/docs/aws-docs/providers/aws/ec2/vpc_tenancy/index.md b/docs/aws-docs/providers/aws/ec2/vpc_tenancy/index.md deleted file mode 100644 index c495d9cad2..0000000000 --- a/docs/aws-docs/providers/aws/ec2/vpc_tenancy/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: vpc_tenancy -hide_title: false -hide_table_of_contents: false -keywords: - - vpc_tenancy - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namevpc_tenancy
TypeResource
Idaws.ec2.vpc_tenancy
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `vpc_tenancy_Modify` | `EXEC` | `InstanceTenancy, VpcId, region` | diff --git a/docs/aws-docs/providers/aws/ec2/vpcdhcp_options_association/index.md b/docs/aws-docs/providers/aws/ec2/vpcdhcp_options_association/index.md new file mode 100644 index 0000000000..b1bb76b8cc --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/vpcdhcp_options_association/index.md @@ -0,0 +1,89 @@ +--- +title: vpcdhcp_options_association +hide_title: false +hide_table_of_contents: false +keywords: + - vpcdhcp_options_association + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual vpcdhcp_options_association resource + +## Overview + + + + + +
Namevpcdhcp_options_association
TypeResource
DescriptionAssociates a set of DHCP options with a VPC, or associates no DHCP options with the VPC.
Idaws.ec2.vpcdhcp_options_association
+ +## Fields + + + + + + +
NameDatatypeDescription
dhcp_options_idstringThe ID of the DHCP options set, or default to associate no DHCP options with the VPC.
vpc_idstringThe ID of the VPC.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +dhcp_options_id, +vpc_id +FROM aws.ec2.vpcdhcp_options_association +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the vpcdhcp_options_association resource, the following permissions are required: + +### Update +```json +ec2:AssociateDhcpOptions +``` + +### Delete +```json +ec2:AssociateDhcpOptions +``` + +### Read +```json +ec2:DescribeVpcs +``` + diff --git a/docs/aws-docs/providers/aws/ec2/vpcdhcp_options_associations/index.md b/docs/aws-docs/providers/aws/ec2/vpcdhcp_options_associations/index.md new file mode 100644 index 0000000000..7e8ce4561f --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/vpcdhcp_options_associations/index.md @@ -0,0 +1,79 @@ +--- +title: vpcdhcp_options_associations +hide_title: false +hide_table_of_contents: false +keywords: + - vpcdhcp_options_associations + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Retrieves a list of vpcdhcp_options_associations in a region + +## Overview + + + + + +
Namevpcdhcp_options_associations
TypeResource
DescriptionAssociates a set of DHCP options with a VPC, or associates no DHCP options with the VPC.
Idaws.ec2.vpcdhcp_options_associations
+ +## Fields + + + + + + +
NameDatatypeDescription
dhcp_options_idstringThe ID of the DHCP options set, or default to associate no DHCP options with the VPC.
vpc_idstringThe ID of the VPC.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +dhcp_options_id, +vpc_id +FROM aws.ec2.vpcdhcp_options_associations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the vpcdhcp_options_associations resource, the following permissions are required: + +### Create +```json +ec2:AssociateDhcpOptions +``` + +### List +```json +ec2:DescribeVpcs +``` + diff --git a/docs/aws-docs/providers/aws/ec2/vpcs/index.md b/docs/aws-docs/providers/aws/ec2/vpcs/index.md index 2ba9449330..e5d3615903 100644 --- a/docs/aws-docs/providers/aws/ec2/vpcs/index.md +++ b/docs/aws-docs/providers/aws/ec2/vpcs/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - vpcs - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,32 +14,67 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- - - +Retrieves a list of vpcs in a region ## Overview +
Namevpcs
TypeResource
DescriptionSpecifies a virtual private cloud (VPC).<br/> You can optionally request an IPv6 CIDR block for the VPC. You can request an Amazon-provided IPv6 CIDR block from Amazon's pool of IPv6 addresses, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP).<br/> For more information, see [Virtual private clouds (VPC)](https://docs.aws.amazon.com/vpc/latest/userguide/configure-your-vpc.html) in the *Amazon VPC User Guide*.
Idaws.ec2.vpcs
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `cidrBlock` | `string` | The primary IPv4 CIDR block for the VPC. | -| `cidrBlockAssociationSet` | `array` | Information about the IPv4 CIDR blocks associated with the VPC. | -| `dhcpOptionsId` | `string` | The ID of the set of DHCP options you've associated with the VPC. | -| `instanceTenancy` | `string` | The allowed tenancy of instances launched into the VPC. | -| `ipv6CidrBlockAssociationSet` | `array` | Information about the IPv6 CIDR blocks associated with the VPC. | -| `isDefault` | `boolean` | Indicates whether the VPC is the default VPC. | -| `ownerId` | `string` | The ID of the Amazon Web Services account that owns the VPC. | -| `state` | `string` | The current state of the VPC. | -| `tagSet` | `array` | Any tags assigned to the VPC. | -| `vpcId` | `string` | The ID of the VPC. | + + + + + +
NameDatatypeDescription
vpc_idstring
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `vpcs_Describe` | `SELECT` | `region` | Describes one or more of your VPCs. | -| `vpc_Create` | `INSERT` | `region` | <p>Creates a VPC with the specified IPv4 CIDR block. The smallest VPC you can create uses a /28 netmask (16 IPv4 addresses), and the largest uses a /16 netmask (65,536 IPv4 addresses). For more information about how large to make your VPC, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html">Your VPC and subnets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p> <p>You can optionally request an IPv6 CIDR block for the VPC. You can request an Amazon-provided IPv6 CIDR block from Amazon's pool of IPv6 addresses, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (<a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html">BYOIP</a>).</p> <p>By default, each instance you launch in the VPC has the default DHCP options, which include only a default DNS server that we provide (AmazonProvidedDNS). For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_DHCP_Options.html">DHCP options sets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p> <p>You can specify the instance tenancy value for the VPC when you create it. You can't change this value for the VPC after you create it. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-instance.html">Dedicated Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | -| `vpc_Delete` | `DELETE` | `VpcId, region` | Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on. | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +vpc_id +FROM aws.ec2.vpcs +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the vpcs resource, the following permissions are required: + +### Create +```json +ec2:CreateVpc, +ec2:DescribeVpcs, +ec2:ModifyVpcAttribute, +ec2:CreateTags +``` + +### List +```json +ec2:DescribeVpcs +``` + diff --git a/docs/aws-docs/providers/aws/ec2/vpn_connection/index.md b/docs/aws-docs/providers/aws/ec2/vpn_connection/index.md new file mode 100644 index 0000000000..1de3dcaa0b --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/vpn_connection/index.md @@ -0,0 +1,105 @@ +--- +title: vpn_connection +hide_title: false +hide_table_of_contents: false +keywords: + - vpn_connection + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual vpn_connection resource + +## Overview + + + + + +
Namevpn_connection
TypeResource
DescriptionResource Type definition for AWS::EC2::VPNConnection
Idaws.ec2.vpn_connection
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
vpn_connection_idstringThe provider-assigned unique ID for this managed resource
customer_gateway_idstringThe ID of the customer gateway at your end of the VPN connection.
static_routes_onlybooleanIndicates whether the VPN connection uses static routes only.
tagsarrayAny tags assigned to the VPN connection.
transit_gateway_idstringThe ID of the transit gateway associated with the VPN connection.
typestringThe type of VPN connection.
vpn_gateway_idstringThe ID of the virtual private gateway at the AWS side of the VPN connection.
vpn_tunnel_options_specificationsarrayThe tunnel options for the VPN connection.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +vpn_connection_id, +customer_gateway_id, +static_routes_only, +tags, +transit_gateway_id, +type, +vpn_gateway_id, +vpn_tunnel_options_specifications +FROM aws.ec2.vpn_connection +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the vpn_connection resource, the following permissions are required: + +### Delete +```json +ec2:DescribeVpnConnections, +ec2:DeleteVpnConnection, +ec2:DeleteTags +``` + +### Update +```json +ec2:DescribeVpnConnections, +ec2:CreateTags, +ec2:DeleteTags +``` + +### Read +```json +ec2:DescribeVpnConnections +``` + diff --git a/docs/aws-docs/providers/aws/ec2/vpn_connection_device_sample_configuration/index.md b/docs/aws-docs/providers/aws/ec2/vpn_connection_device_sample_configuration/index.md deleted file mode 100644 index d112a3865f..0000000000 --- a/docs/aws-docs/providers/aws/ec2/vpn_connection_device_sample_configuration/index.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: vpn_connection_device_sample_configuration -hide_title: false -hide_table_of_contents: false -keywords: - - vpn_connection_device_sample_configuration - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namevpn_connection_device_sample_configuration
TypeResource
Idaws.ec2.vpn_connection_device_sample_configuration
- -## Fields -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `vpn_connection_device_sample_configuration_Get` | `SELECT` | `VpnConnectionDeviceTypeId, VpnConnectionId, region` | diff --git a/docs/aws-docs/providers/aws/ec2/vpn_connection_device_types/index.md b/docs/aws-docs/providers/aws/ec2/vpn_connection_device_types/index.md deleted file mode 100644 index 0a6895edd5..0000000000 --- a/docs/aws-docs/providers/aws/ec2/vpn_connection_device_types/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: vpn_connection_device_types -hide_title: false -hide_table_of_contents: false -keywords: - - vpn_connection_device_types - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namevpn_connection_device_types
TypeResource
Idaws.ec2.vpn_connection_device_types
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `platform` | `string` | Customer gateway device platform. | -| `software` | `string` | Customer gateway device software version. | -| `vendor` | `string` | Customer gateway device vendor. | -| `vpnConnectionDeviceTypeId` | `string` | Customer gateway device identifier. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `vpn_connection_device_types_Get` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2/vpn_connection_options/index.md b/docs/aws-docs/providers/aws/ec2/vpn_connection_options/index.md deleted file mode 100644 index a25065f844..0000000000 --- a/docs/aws-docs/providers/aws/ec2/vpn_connection_options/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: vpn_connection_options -hide_title: false -hide_table_of_contents: false -keywords: - - vpn_connection_options - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namevpn_connection_options
TypeResource
Idaws.ec2.vpn_connection_options
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `vpn_connection_options_Modify` | `EXEC` | `VpnConnectionId, region` | diff --git a/docs/aws-docs/providers/aws/ec2/vpn_connection_route/index.md b/docs/aws-docs/providers/aws/ec2/vpn_connection_route/index.md index b0867d0686..62a3e932cf 100644 --- a/docs/aws-docs/providers/aws/ec2/vpn_connection_route/index.md +++ b/docs/aws-docs/providers/aws/ec2/vpn_connection_route/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - vpn_connection_route - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,20 +14,67 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- - - +Gets an individual vpn_connection_route resource ## Overview +
Namevpn_connection_route
TypeResource
DescriptionResource Type definition for AWS::EC2::VPNConnectionRoute
Idaws.ec2.vpn_connection_route
## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command + + + + + + +
NameDatatypeDescription
destination_cidr_blockstringThe CIDR block associated with the local subnet of the customer network.
vpn_connection_idstringThe ID of the VPN connection.
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `vpn_connection_route_Create` | `INSERT` | `DestinationCidrBlock, VpnConnectionId, region` | <p>Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html">Amazon Web Services Site-to-Site VPN</a> in the <i>Amazon Web Services Site-to-Site VPN User Guide</i>.</p> | -| `vpn_connection_route_Delete` | `DELETE` | `DestinationCidrBlock, VpnConnectionId, region` | Deletes the specified static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway. | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +destination_cidr_block, +vpn_connection_id +FROM aws.ec2.vpn_connection_route +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the vpn_connection_route resource, the following permissions are required: + +### Read +```json +ec2:DescribeVpnConnections +``` + +### Delete +```json +ec2:DeleteVpnConnectionRoute, +ec2:DescribeVpnConnections +``` + diff --git a/docs/aws-docs/providers/aws/ec2/vpn_connection_routes/index.md b/docs/aws-docs/providers/aws/ec2/vpn_connection_routes/index.md new file mode 100644 index 0000000000..796ef53a9f --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/vpn_connection_routes/index.md @@ -0,0 +1,80 @@ +--- +title: vpn_connection_routes +hide_title: false +hide_table_of_contents: false +keywords: + - vpn_connection_routes + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Retrieves a list of vpn_connection_routes in a region + +## Overview + + + + + +
Namevpn_connection_routes
TypeResource
DescriptionResource Type definition for AWS::EC2::VPNConnectionRoute
Idaws.ec2.vpn_connection_routes
+ +## Fields + + + + + + +
NameDatatypeDescription
destination_cidr_blockstringThe CIDR block associated with the local subnet of the customer network.
vpn_connection_idstringThe ID of the VPN connection.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +destination_cidr_block, +vpn_connection_id +FROM aws.ec2.vpn_connection_routes +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the vpn_connection_routes resource, the following permissions are required: + +### Create +```json +ec2:CreateVpnConnectionRoute, +ec2:DescribeVpnConnections +``` + +### List +```json +ec2:DescribeVpnConnections +``` + diff --git a/docs/aws-docs/providers/aws/ec2/vpn_connections/index.md b/docs/aws-docs/providers/aws/ec2/vpn_connections/index.md index f531dfe92e..228ee47d82 100644 --- a/docs/aws-docs/providers/aws/ec2/vpn_connections/index.md +++ b/docs/aws-docs/providers/aws/ec2/vpn_connections/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - vpn_connections - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,38 +14,66 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- - - +Retrieves a list of vpn_connections in a region ## Overview +
Namevpn_connections
TypeResource
DescriptionResource Type definition for AWS::EC2::VPNConnection
Idaws.ec2.vpn_connections
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `category` | `string` | The category of the VPN connection. A value of <code>VPN</code> indicates an Amazon Web Services VPN connection. A value of <code>VPN-Classic</code> indicates an Amazon Web Services Classic VPN connection. | -| `coreNetworkArn` | `string` | The ARN of the core network. | -| `coreNetworkAttachmentArn` | `string` | The ARN of the core network attachment. | -| `customerGatewayConfiguration` | `string` | The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the <a>CreateVpnConnection</a> response; however, it's present in the <a>DescribeVpnConnections</a> response only if the VPN connection is in the <code>pending</code> or <code>available</code> state. | -| `customerGatewayId` | `string` | The ID of the customer gateway at your end of the VPN connection. | -| `gatewayAssociationState` | `string` | The current state of the gateway association. | -| `options` | `object` | Describes VPN connection options. | -| `routes` | `array` | The static routes associated with the VPN connection. | -| `state` | `string` | The current state of the VPN connection. | -| `tagSet` | `array` | Any tags assigned to the VPN connection. | -| `transitGatewayId` | `string` | The ID of the transit gateway associated with the VPN connection. | -| `type` | `string` | The type of VPN connection. | -| `vgwTelemetry` | `array` | Information about the VPN tunnel. | -| `vpnConnectionId` | `string` | The ID of the VPN connection. | -| `vpnGatewayId` | `string` | The ID of the virtual private gateway at the Amazon Web Services side of the VPN connection. | + + + + + +
NameDatatypeDescription
vpn_connection_idstringThe provider-assigned unique ID for this managed resource
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `vpn_connections_Describe` | `SELECT` | `region` | <p>Describes one or more of your VPN connections.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html">Amazon Web Services Site-to-Site VPN</a> in the <i>Amazon Web Services Site-to-Site VPN User Guide</i>.</p> | -| `vpn_connection_Create` | `INSERT` | `CustomerGatewayId, Type, region` | <p>Creates a VPN connection between an existing virtual private gateway or transit gateway and a customer gateway. The supported connection type is <code>ipsec.1</code>.</p> <p>The response includes information that you need to give to your network administrator to configure your customer gateway.</p> <important> <p>We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway device.</p> </important> <p>If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call.</p> <p>This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html">Amazon Web Services Site-to-Site VPN</a> in the <i>Amazon Web Services Site-to-Site VPN User Guide</i>.</p> | -| `vpn_connection_Delete` | `DELETE` | `VpnConnectionId, region` | <p>Deletes the specified VPN connection.</p> <p>If you're deleting the VPC and its associated components, we recommend that you detach the virtual private gateway from the VPC and delete the VPC before deleting the VPN connection. If you believe that the tunnel credentials for your VPN connection have been compromised, you can delete the VPN connection and create a new one that has new keys, without needing to delete the VPC or virtual private gateway. If you create a new VPN connection, you must reconfigure the customer gateway device using the new configuration information returned with the new VPN connection ID.</p> <p>For certificate-based authentication, delete all Certificate Manager (ACM) private certificates used for the Amazon Web Services-side tunnel endpoints for the VPN connection before deleting the VPN connection.</p> | -| `vpn_connection_Modify` | `EXEC` | `VpnConnectionId, region` | <p>Modifies the customer gateway or the target gateway of an Amazon Web Services Site-to-Site VPN connection. To modify the target gateway, the following migration options are available:</p> <ul> <li> <p>An existing virtual private gateway to a new virtual private gateway</p> </li> <li> <p>An existing virtual private gateway to a transit gateway</p> </li> <li> <p>An existing transit gateway to a new transit gateway</p> </li> <li> <p>An existing transit gateway to a virtual private gateway</p> </li> </ul> <p>Before you perform the migration to the new gateway, you must configure the new gateway. Use <a>CreateVpnGateway</a> to create a virtual private gateway, or <a>CreateTransitGateway</a> to create a transit gateway.</p> <p>This step is required when you migrate from a virtual private gateway with static routes to a transit gateway. </p> <p>You must delete the static routes before you migrate to the new gateway.</p> <p>Keep a copy of the static route before you delete it. You will need to add back these routes to the transit gateway after the VPN connection migration is complete.</p> <p>After you migrate to the new gateway, you might need to modify your VPC route table. Use <a>CreateRoute</a> and <a>DeleteRoute</a> to make the changes described in <a href="https://docs.aws.amazon.com/vpn/latest/s2svpn/modify-vpn-target.html#step-update-routing">Update VPC route tables</a> in the <i>Amazon Web Services Site-to-Site VPN User Guide</i>.</p> <p>When the new gateway is a transit gateway, modify the transit gateway route table to allow traffic between the VPC and the Amazon Web Services Site-to-Site VPN connection. Use <a>CreateTransitGatewayRoute</a> to add the routes.</p> <p> If you deleted VPN static routes, you must add the static routes to the transit gateway route table.</p> <p>After you perform this operation, the VPN endpoint's IP addresses on the Amazon Web Services side and the tunnel options remain intact. Your Amazon Web Services Site-to-Site VPN connection will be temporarily unavailable for a brief period while we provision the new endpoints.</p> | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +vpn_connection_id +FROM aws.ec2.vpn_connections +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the vpn_connections resource, the following permissions are required: + +### Create +```json +ec2:DescribeVpnConnections, +ec2:CreateVpnConnection, +ec2:CreateTags +``` + +### List +```json +ec2:DescribeVpnConnections +``` + diff --git a/docs/aws-docs/providers/aws/ec2/vpn_gateway/index.md b/docs/aws-docs/providers/aws/ec2/vpn_gateway/index.md new file mode 100644 index 0000000000..700f7dd640 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2/vpn_gateway/index.md @@ -0,0 +1,94 @@ +--- +title: vpn_gateway +hide_title: false +hide_table_of_contents: false +keywords: + - vpn_gateway + - ec2 + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual vpn_gateway resource + +## Overview + + + + + +
Namevpn_gateway
TypeResource
DescriptionSchema for EC2 VPN Gateway
Idaws.ec2.vpn_gateway
+ +## Fields + + + + + + + + +
NameDatatypeDescription
v_pn_gateway_idstringVPN Gateway ID generated by service
amazon_side_asnintegerThe private Autonomous System Number (ASN) for the Amazon side of a BGP session.
tagsarrayAny tags assigned to the virtual private gateway.
typestringThe type of VPN connection the virtual private gateway supports.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +v_pn_gateway_id, +amazon_side_asn, +tags, +type +FROM aws.ec2.vpn_gateway +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the vpn_gateway resource, the following permissions are required: + +### Read +```json +ec2:DescribeVpnGateways +``` + +### Update +```json +ec2:CreateTags, +ec2:DeleteTags +``` + +### Delete +```json +ec2:DeleteVpnGateway +``` + diff --git a/docs/aws-docs/providers/aws/ec2/vpn_gateways/index.md b/docs/aws-docs/providers/aws/ec2/vpn_gateways/index.md index d44836146a..767de460a5 100644 --- a/docs/aws-docs/providers/aws/ec2/vpn_gateways/index.md +++ b/docs/aws-docs/providers/aws/ec2/vpn_gateways/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - vpn_gateways - ec2 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,31 +14,65 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- - - +Retrieves a list of vpn_gateways in a region ## Overview +
Namevpn_gateways
TypeResource
DescriptionSchema for EC2 VPN Gateway
Idaws.ec2.vpn_gateways
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `amazonSideAsn` | `integer` | The private Autonomous System Number (ASN) for the Amazon side of a BGP session. | -| `attachments` | `array` | Any VPCs attached to the virtual private gateway. | -| `availabilityZone` | `string` | The Availability Zone where the virtual private gateway was created, if applicable. This field may be empty or not returned. | -| `state` | `string` | The current state of the virtual private gateway. | -| `tagSet` | `array` | Any tags assigned to the virtual private gateway. | -| `type` | `string` | The type of VPN connection the virtual private gateway supports. | -| `vpnGatewayId` | `string` | The ID of the virtual private gateway. | + + + + + +
NameDatatypeDescription
v_pn_gateway_idstringVPN Gateway ID generated by service
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `vpn_gateways_Describe` | `SELECT` | `region` | <p>Describes one or more of your virtual private gateways.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html">Amazon Web Services Site-to-Site VPN</a> in the <i>Amazon Web Services Site-to-Site VPN User Guide</i>.</p> | -| `vpn_gateway_Create` | `INSERT` | `Type, region` | <p>Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html">Amazon Web Services Site-to-Site VPN</a> in the <i>Amazon Web Services Site-to-Site VPN User Guide</i>.</p> | -| `vpn_gateway_Delete` | `DELETE` | `VpnGatewayId, region` | Deletes the specified virtual private gateway. You must first detach the virtual private gateway from the VPC. Note that you don't need to delete the virtual private gateway if you plan to delete and recreate the VPN connection between your VPC and your network. | -| `vpn_gateway_Attach` | `EXEC` | `VpcId, VpnGatewayId, region` | <p>Attaches a virtual private gateway to a VPC. You can attach one virtual private gateway to one VPC at a time.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html">Amazon Web Services Site-to-Site VPN</a> in the <i>Amazon Web Services Site-to-Site VPN User Guide</i>.</p> | -| `vpn_gateway_Detach` | `EXEC` | `VpcId, VpnGatewayId, region` | <p>Detaches a virtual private gateway from a VPC. You do this if you're planning to turn off the VPC and not use it anymore. You can confirm a virtual private gateway has been completely detached from a VPC by describing the virtual private gateway (any attachments to the virtual private gateway are also described).</p> <p>You must wait for the attachment's state to switch to <code>detached</code> before you can delete the VPC or attach a different VPC to the virtual private gateway.</p> | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +v_pn_gateway_id +FROM aws.ec2.vpn_gateways +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the vpn_gateways resource, the following permissions are required: + +### Create +```json +ec2:CreateVpnGateway, +ec2:DescribeVpnGateways +``` + +### List +```json +ec2:DescribeVpnGateways +``` + diff --git a/docs/aws-docs/providers/aws/ec2/vpn_tunnel_certificate/index.md b/docs/aws-docs/providers/aws/ec2/vpn_tunnel_certificate/index.md deleted file mode 100644 index 01f9bd93b3..0000000000 --- a/docs/aws-docs/providers/aws/ec2/vpn_tunnel_certificate/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: vpn_tunnel_certificate -hide_title: false -hide_table_of_contents: false -keywords: - - vpn_tunnel_certificate - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namevpn_tunnel_certificate
TypeResource
Idaws.ec2.vpn_tunnel_certificate
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `vpn_tunnel_certificate_Modify` | `EXEC` | `VpnConnectionId, VpnTunnelOutsideIpAddress, region` | diff --git a/docs/aws-docs/providers/aws/ec2/vpn_tunnel_options/index.md b/docs/aws-docs/providers/aws/ec2/vpn_tunnel_options/index.md deleted file mode 100644 index 0985a20495..0000000000 --- a/docs/aws-docs/providers/aws/ec2/vpn_tunnel_options/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: vpn_tunnel_options -hide_title: false -hide_table_of_contents: false -keywords: - - vpn_tunnel_options - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namevpn_tunnel_options
TypeResource
Idaws.ec2.vpn_tunnel_options
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `vpn_tunnel_options_Modify` | `EXEC` | `TunnelOptions, VpnConnectionId, VpnTunnelOutsideIpAddress, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/account_attributes/index.md b/docs/aws-docs/providers/aws/ec2_api/account_attributes/index.md new file mode 100644 index 0000000000..ea336eb0bf --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/account_attributes/index.md @@ -0,0 +1,35 @@ +--- +title: account_attributes +hide_title: false +hide_table_of_contents: false +keywords: + - account_attributes + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameaccount_attributes
TypeResource
Idaws.ec2_api.account_attributes
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `attributeName` | `string` | The name of the account attribute. | +| `attributeValueSet` | `array` | The values for the account attribute. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `account_attributes_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/address/index.md b/docs/aws-docs/providers/aws/ec2_api/address/index.md new file mode 100644 index 0000000000..b1afd74bc4 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/address/index.md @@ -0,0 +1,35 @@ +--- +title: address +hide_title: false +hide_table_of_contents: false +keywords: + - address + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameaddress
TypeResource
Idaws.ec2_api.address
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `address_Allocate` | `EXEC` | `region` | <p>Allocates an Elastic IP address to your Amazon Web Services account. After you allocate the Elastic IP address you can associate it with an instance or network interface. After you release an Elastic IP address, it is released to the IP address pool and can be allocated to a different Amazon Web Services account.</p> <p>You can allocate an Elastic IP address from an address pool owned by Amazon Web Services or from an address pool created from a public IPv4 address range that you have brought to Amazon Web Services for use with your Amazon Web Services resources using bring your own IP addresses (BYOIP). For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html">Bring Your Own IP Addresses (BYOIP)</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>[EC2-VPC] If you release an Elastic IP address, you might be able to recover it. You cannot recover an Elastic IP address that you released after it is allocated to another Amazon Web Services account. You cannot recover an Elastic IP address for EC2-Classic. To attempt to recover an Elastic IP address that you released, specify it in this operation.</p> <p>An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. By default, you can allocate 5 Elastic IP addresses for EC2-Classic per Region and 5 Elastic IP addresses for EC2-VPC per Region.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>You can allocate a carrier IP address which is a public IP address from a telecommunication carrier, to a network interface which resides in a subnet in a Wavelength Zone (for example an EC2 instance). </p> | +| `address_Associate` | `EXEC` | `region` | <p>Associates an Elastic IP address, or carrier IP address (for instances that are in subnets in Wavelength Zones) with an instance or a network interface. Before you can use an Elastic IP address, you must allocate it to your account.</p> <p>An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>[EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance. If you associate an Elastic IP address with an instance that has an existing Elastic IP address, the existing address is disassociated from the instance, but remains allocated to your account.</p> <p>[VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation. You cannot associate an Elastic IP address with an instance or network interface that has an existing Elastic IP address.</p> <p>[Subnets in Wavelength Zones] You can associate an IP address from the telecommunication carrier to the instance or network interface. </p> <p>You cannot associate an Elastic IP address with an interface in a different network border group.</p> <important> <p>This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error, and you may be charged for each time the Elastic IP address is remapped to the same instance. For more information, see the <i>Elastic IP Addresses</i> section of <a href="http://aws.amazon.com/ec2/pricing/">Amazon EC2 Pricing</a>.</p> </important> | +| `address_Disassociate` | `EXEC` | `region` | <p>Disassociates an Elastic IP address from the instance or network interface it's associated with.</p> <p>An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.</p> | +| `address_Release` | `EXEC` | `region` | <p>Releases the specified Elastic IP address.</p> <p>[EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. To disassociate an Elastic IP address without releasing it, use <a>DisassociateAddress</a>.</p> <p>[Nondefault VPC] You must use <a>DisassociateAddress</a> to disassociate the Elastic IP address before you can release it. Otherwise, Amazon EC2 returns an error (<code>InvalidIPAddress.InUse</code>).</p> <p>After releasing an Elastic IP address, it is released to the IP address pool. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you'll get an <code>AuthFailure</code> error if the address is already allocated to another Amazon Web Services account.</p> <p>[EC2-VPC] After you release an Elastic IP address for use in a VPC, you might be able to recover it. For more information, see <a>AllocateAddress</a>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/address_attribute/index.md b/docs/aws-docs/providers/aws/ec2_api/address_attribute/index.md new file mode 100644 index 0000000000..9e071e4eb2 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/address_attribute/index.md @@ -0,0 +1,33 @@ +--- +title: address_attribute +hide_title: false +hide_table_of_contents: false +keywords: + - address_attribute + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameaddress_attribute
TypeResource
Idaws.ec2_api.address_attribute
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `address_attribute_Modify` | `EXEC` | `AllocationId, region` | Modifies an attribute of the specified Elastic IP address. For requirements, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html#Using_Elastic_Addressing_Reverse_DNS">Using reverse DNS for email applications</a>. | +| `address_attribute_Reset` | `EXEC` | `AllocationId, Attribute, region` | Resets the attribute of the specified IP address. For requirements, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html#Using_Elastic_Addressing_Reverse_DNS">Using reverse DNS for email applications</a>. | diff --git a/docs/aws-docs/providers/aws/ec2_api/address_to_classic/index.md b/docs/aws-docs/providers/aws/ec2_api/address_to_classic/index.md new file mode 100644 index 0000000000..73a9aa31fe --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/address_to_classic/index.md @@ -0,0 +1,32 @@ +--- +title: address_to_classic +hide_title: false +hide_table_of_contents: false +keywords: + - address_to_classic + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameaddress_to_classic
TypeResource
Idaws.ec2_api.address_to_classic
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `address_to_classic_Restore` | `EXEC` | `PublicIp, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/address_to_vpc/index.md b/docs/aws-docs/providers/aws/ec2_api/address_to_vpc/index.md new file mode 100644 index 0000000000..671d7a485f --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/address_to_vpc/index.md @@ -0,0 +1,32 @@ +--- +title: address_to_vpc +hide_title: false +hide_table_of_contents: false +keywords: + - address_to_vpc + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameaddress_to_vpc
TypeResource
Idaws.ec2_api.address_to_vpc
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `address_to_vpc_Move` | `EXEC` | `PublicIp, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/addresses/index.md b/docs/aws-docs/providers/aws/ec2_api/addresses/index.md new file mode 100644 index 0000000000..08e357955f --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/addresses/index.md @@ -0,0 +1,47 @@ +--- +title: addresses +hide_title: false +hide_table_of_contents: false +keywords: + - addresses + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameaddresses
TypeResource
Idaws.ec2_api.addresses
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `allocationId` | `string` | The ID representing the allocation of the address for use with EC2-VPC. | +| `associationId` | `string` | The ID representing the association of the address with an instance in a VPC. | +| `carrierIp` | `string` | The carrier IP address associated. This option is only available for network interfaces which reside in a subnet in a Wavelength Zone (for example an EC2 instance). | +| `customerOwnedIp` | `string` | The customer-owned IP address. | +| `customerOwnedIpv4Pool` | `string` | The ID of the customer-owned address pool. | +| `domain` | `string` | Indicates whether this Elastic IP address is for use with instances in EC2-Classic (<code>standard</code>) or instances in a VPC (<code>vpc</code>). | +| `instanceId` | `string` | The ID of the instance that the address is associated with (if any). | +| `networkBorderGroup` | `string` | The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses. | +| `networkInterfaceId` | `string` | The ID of the network interface. | +| `networkInterfaceOwnerId` | `string` | The ID of the Amazon Web Services account that owns the network interface. | +| `privateIpAddress` | `string` | The private IP address associated with the Elastic IP address. | +| `publicIp` | `string` | The Elastic IP address. | +| `publicIpv4Pool` | `string` | The ID of an address pool. | +| `tagSet` | `array` | Any tags assigned to the Elastic IP address. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `addresses_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/addresses_attribute/index.md b/docs/aws-docs/providers/aws/ec2_api/addresses_attribute/index.md new file mode 100644 index 0000000000..8ffc439e6a --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/addresses_attribute/index.md @@ -0,0 +1,37 @@ +--- +title: addresses_attribute +hide_title: false +hide_table_of_contents: false +keywords: + - addresses_attribute + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameaddresses_attribute
TypeResource
Idaws.ec2_api.addresses_attribute
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `allocationId` | `string` | [EC2-VPC] The allocation ID. | +| `ptrRecord` | `string` | The pointer (PTR) record for the IP address. | +| `ptrRecordUpdate` | `object` | The status of an updated pointer (PTR) record for an Elastic IP address. | +| `publicIp` | `string` | The public IP address. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `addresses_attribute_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/aggregate_id_format/index.md b/docs/aws-docs/providers/aws/ec2_api/aggregate_id_format/index.md new file mode 100644 index 0000000000..d3b06b3ae3 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/aggregate_id_format/index.md @@ -0,0 +1,36 @@ +--- +title: aggregate_id_format +hide_title: false +hide_table_of_contents: false +keywords: + - aggregate_id_format + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameaggregate_id_format
TypeResource
Idaws.ec2_api.aggregate_id_format
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `deadline` | `string` | The date in UTC at which you are permanently switched over to using longer IDs. If a deadline is not yet available for this resource type, this field is not returned. | +| `resource` | `string` | The type of resource. | +| `useLongIds` | `boolean` | Indicates whether longer IDs (17-character IDs) are enabled for the resource. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `aggregate_id_format_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/associated_enclave_certificate_iam_roles/index.md b/docs/aws-docs/providers/aws/ec2_api/associated_enclave_certificate_iam_roles/index.md new file mode 100644 index 0000000000..96e191967e --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/associated_enclave_certificate_iam_roles/index.md @@ -0,0 +1,37 @@ +--- +title: associated_enclave_certificate_iam_roles +hide_title: false +hide_table_of_contents: false +keywords: + - associated_enclave_certificate_iam_roles + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameassociated_enclave_certificate_iam_roles
TypeResource
Idaws.ec2_api.associated_enclave_certificate_iam_roles
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `associatedRoleArn` | `string` | The ARN of the associated IAM role. | +| `certificateS3BucketName` | `string` | The name of the Amazon S3 bucket in which the Amazon S3 object is stored. | +| `certificateS3ObjectKey` | `string` | The key of the Amazon S3 object ey where the certificate, certificate chain, and encrypted private key bundle is stored. The object key is formated as follows: <code>role_arn</code>/<code>certificate_arn</code>. | +| `encryptionKmsKeyId` | `string` | The ID of the KMS customer master key (CMK) used to encrypt the private key. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `associated_enclave_certificate_iam_roles_Get` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/associated_ipv6_pool_cidrs/index.md b/docs/aws-docs/providers/aws/ec2_api/associated_ipv6_pool_cidrs/index.md new file mode 100644 index 0000000000..66b718a630 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/associated_ipv6_pool_cidrs/index.md @@ -0,0 +1,35 @@ +--- +title: associated_ipv6_pool_cidrs +hide_title: false +hide_table_of_contents: false +keywords: + - associated_ipv6_pool_cidrs + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameassociated_ipv6_pool_cidrs
TypeResource
Idaws.ec2_api.associated_ipv6_pool_cidrs
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `associatedResource` | `string` | The resource that's associated with the IPv6 CIDR block. | +| `ipv6Cidr` | `string` | The IPv6 CIDR block. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `associated_ipv6_pool_cidrs_Get` | `SELECT` | `PoolId, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/availability_zone_group/index.md b/docs/aws-docs/providers/aws/ec2_api/availability_zone_group/index.md new file mode 100644 index 0000000000..43258c3ce9 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/availability_zone_group/index.md @@ -0,0 +1,32 @@ +--- +title: availability_zone_group +hide_title: false +hide_table_of_contents: false +keywords: + - availability_zone_group + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameavailability_zone_group
TypeResource
Idaws.ec2_api.availability_zone_group
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `availability_zone_group_Modify` | `EXEC` | `GroupName, OptInStatus, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/availability_zones/index.md b/docs/aws-docs/providers/aws/ec2_api/availability_zones/index.md new file mode 100644 index 0000000000..fd1a5548a4 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/availability_zones/index.md @@ -0,0 +1,44 @@ +--- +title: availability_zones +hide_title: false +hide_table_of_contents: false +keywords: + - availability_zones + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameavailability_zones
TypeResource
Idaws.ec2_api.availability_zones
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `groupName` | `string` | <p> For Availability Zones, this parameter has the same value as the Region name.</p> <p>For Local Zones, the name of the associated group, for example <code>us-west-2-lax-1</code>.</p> <p>For Wavelength Zones, the name of the associated group, for example <code>us-east-1-wl1-bos-wlz-1</code>.</p> | +| `messageSet` | `array` | Any messages about the Availability Zone, Local Zone, or Wavelength Zone. | +| `networkBorderGroup` | `string` | The name of the network border group. | +| `optInStatus` | `string` | <p>For Availability Zones, this parameter always has the value of <code>opt-in-not-required</code>.</p> <p>For Local Zones and Wavelength Zones, this parameter is the opt-in status. The possible values are <code>opted-in</code>, and <code>not-opted-in</code>.</p> | +| `parentZoneId` | `string` | The ID of the zone that handles some of the Local Zone or Wavelength Zone control plane operations, such as API calls. | +| `parentZoneName` | `string` | The name of the zone that handles some of the Local Zone or Wavelength Zone control plane operations, such as API calls. | +| `regionName` | `string` | The name of the Region. | +| `zoneId` | `string` | The ID of the Availability Zone, Local Zone, or Wavelength Zone. | +| `zoneName` | `string` | The name of the Availability Zone, Local Zone, or Wavelength Zone. | +| `zoneState` | `string` | The state of the Availability Zone, Local Zone, or Wavelength Zone. This value is always <code>available</code>. | +| `zoneType` | `string` | The type of zone. The valid values are <code>availability-zone</code>, <code>local-zone</code>, and <code>wavelength-zone</code>. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `availability_zones_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/bundle_tasks/index.md b/docs/aws-docs/providers/aws/ec2_api/bundle_tasks/index.md new file mode 100644 index 0000000000..c822440e04 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/bundle_tasks/index.md @@ -0,0 +1,42 @@ +--- +title: bundle_tasks +hide_title: false +hide_table_of_contents: false +keywords: + - bundle_tasks + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namebundle_tasks
TypeResource
Idaws.ec2_api.bundle_tasks
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `bundleId` | `string` | The ID of the bundle task. | +| `error` | `object` | Describes an error for <a>BundleInstance</a>. | +| `instanceId` | `string` | The ID of the instance associated with this bundle task. | +| `progress` | `string` | The level of task completion, as a percent (for example, 20%). | +| `startTime` | `string` | The time this task started. | +| `state` | `string` | The state of the task. | +| `storage` | `object` | Describes the storage location for an instance store-backed AMI. | +| `updateTime` | `string` | The time of the most recent update for the task. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `bundle_tasks_Describe` | `SELECT` | `region` | <p>Describes the specified bundle tasks or all of your bundle tasks.</p> <note> <p>Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use <code>RegisterImage</code> with the Amazon S3 bucket name and image manifest name you provided to the bundle task.</p> </note> | +| `bundle_task_Cancel` | `EXEC` | `BundleId, region` | Cancels a bundling operation for an instance store-backed Windows instance. | diff --git a/docs/aws-docs/providers/aws/ec2_api/byoip_cidr_to_ipam/index.md b/docs/aws-docs/providers/aws/ec2_api/byoip_cidr_to_ipam/index.md new file mode 100644 index 0000000000..a2392ee94c --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/byoip_cidr_to_ipam/index.md @@ -0,0 +1,32 @@ +--- +title: byoip_cidr_to_ipam +hide_title: false +hide_table_of_contents: false +keywords: + - byoip_cidr_to_ipam + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namebyoip_cidr_to_ipam
TypeResource
Idaws.ec2_api.byoip_cidr_to_ipam
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `byoip_cidr_to_ipam_Move` | `EXEC` | `Cidr, IpamPoolId, IpamPoolOwner, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/byoip_cidrs/index.md b/docs/aws-docs/providers/aws/ec2_api/byoip_cidrs/index.md new file mode 100644 index 0000000000..2913e07358 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/byoip_cidrs/index.md @@ -0,0 +1,41 @@ +--- +title: byoip_cidrs +hide_title: false +hide_table_of_contents: false +keywords: + - byoip_cidrs + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namebyoip_cidrs
TypeResource
Idaws.ec2_api.byoip_cidrs
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `description` | `string` | The description of the address range. | +| `cidr` | `string` | The address range, in CIDR notation. | +| `state` | `string` | The state of the address pool. | +| `statusMessage` | `string` | Upon success, contains the ID of the address pool. Otherwise, contains an error message. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `byoip_cidrs_Describe` | `SELECT` | `MaxResults, region` | <p>Describes the IP address ranges that were specified in calls to <a>ProvisionByoipCidr</a>.</p> <p>To describe the address pools that were created when you provisioned the address ranges, use <a>DescribePublicIpv4Pools</a> or <a>DescribeIpv6Pools</a>.</p> | +| `byoip_cidr_Advertise` | `EXEC` | `Cidr, region` | <p>Advertises an IPv4 or IPv6 address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP).</p> <p>You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.</p> <p>We recommend that you stop advertising the BYOIP CIDR from other locations when you advertise it from Amazon Web Services. To minimize down time, you can configure your Amazon Web Services resources to use an address from a BYOIP CIDR before it is advertised, and then simultaneously stop advertising it from the current location and start advertising it through Amazon Web Services.</p> <p>It can take a few minutes before traffic to the specified addresses starts routing to Amazon Web Services because of BGP propagation delays.</p> <p>To stop advertising the BYOIP CIDR, use <a>WithdrawByoipCidr</a>.</p> | +| `byoip_cidr_Deprovision` | `EXEC` | `Cidr, region` | <p>Releases the specified address range that you provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool.</p> <p>Before you can release an address range, you must stop advertising it using <a>WithdrawByoipCidr</a> and you must not have any IP addresses allocated from its address range.</p> | +| `byoip_cidr_Provision` | `EXEC` | `Cidr, region` | <p>Provisions an IPv4 or IPv6 address range for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised using <a>AdvertiseByoipCidr</a>.</p> <p>Amazon Web Services verifies that you own the address range and are authorized to advertise it. You must ensure that the address range is registered to you and that you created an RPKI ROA to authorize Amazon ASNs 16509 and 14618 to advertise the address range. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html">Bring your own IP addresses (BYOIP)</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>Provisioning an address range is an asynchronous operation, so the call returns immediately, but the address range is not ready to use until its status changes from <code>pending-provision</code> to <code>provisioned</code>. To monitor the status of an address range, use <a>DescribeByoipCidrs</a>. To allocate an Elastic IP address from your IPv4 address pool, use <a>AllocateAddress</a> with either the specific address from the address pool or the ID of the address pool.</p> | +| `byoip_cidr_Withdraw` | `EXEC` | `Cidr, region` | <p>Stops advertising an address range that is provisioned as an address pool.</p> <p>You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.</p> <p>It can take a few minutes before traffic to the specified addresses stops routing to Amazon Web Services because of BGP propagation delays.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/capacity_reservation_fleets/index.md b/docs/aws-docs/providers/aws/ec2_api/capacity_reservation_fleets/index.md new file mode 100644 index 0000000000..03e1e9dad2 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/capacity_reservation_fleets/index.md @@ -0,0 +1,48 @@ +--- +title: capacity_reservation_fleets +hide_title: false +hide_table_of_contents: false +keywords: + - capacity_reservation_fleets + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namecapacity_reservation_fleets
TypeResource
Idaws.ec2_api.capacity_reservation_fleets
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `allocationStrategy` | `string` | The strategy used by the Capacity Reservation Fleet to determine which of the specified instance types to use. For more information, see For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#allocation-strategy"> Allocation strategy</a> in the Amazon EC2 User Guide. | +| `capacityReservationFleetArn` | `string` | The ARN of the Capacity Reservation Fleet. | +| `capacityReservationFleetId` | `string` | The ID of the Capacity Reservation Fleet. | +| `createTime` | `string` | The date and time at which the Capacity Reservation Fleet was created. | +| `endDate` | `string` | The date and time at which the Capacity Reservation Fleet expires. | +| `instanceMatchCriteria` | `string` | <p>Indicates the type of instance launches that the Capacity Reservation Fleet accepts. All Capacity Reservations in the Fleet inherit this instance matching criteria.</p> <p>Currently, Capacity Reservation Fleets support <code>open</code> instance matching criteria only. This means that instances that have matching attributes (instance type, platform, and Availability Zone) run in the Capacity Reservations automatically. Instances do not need to explicitly target a Capacity Reservation Fleet to use its reserved capacity.</p> | +| `instanceTypeSpecificationSet` | `array` | Information about the instance types for which to reserve the capacity. | +| `state` | `string` | <p>The state of the Capacity Reservation Fleet. Possible states include:</p> <ul> <li> <p> <code>submitted</code> - The Capacity Reservation Fleet request has been submitted and Amazon Elastic Compute Cloud is preparing to create the Capacity Reservations.</p> </li> <li> <p> <code>modifying</code> - The Capacity Reservation Fleet is being modified. The Fleet remains in this state until the modification is complete.</p> </li> <li> <p> <code>active</code> - The Capacity Reservation Fleet has fulfilled its total target capacity and it is attempting to maintain this capacity. The Fleet remains in this state until it is modified or deleted.</p> </li> <li> <p> <code>partially_fulfilled</code> - The Capacity Reservation Fleet has partially fulfilled its total target capacity. There is insufficient Amazon EC2 to fulfill the total target capacity. The Fleet is attempting to asynchronously fulfill its total target capacity.</p> </li> <li> <p> <code>expiring</code> - The Capacity Reservation Fleet has reach its end date and it is in the process of expiring. One or more of its Capacity reservations might still be active.</p> </li> <li> <p> <code>expired</code> - The Capacity Reservation Fleet has reach its end date. The Fleet and its Capacity Reservations are expired. The Fleet can't create new Capacity Reservations.</p> </li> <li> <p> <code>cancelling</code> - The Capacity Reservation Fleet is in the process of being cancelled. One or more of its Capacity reservations might still be active.</p> </li> <li> <p> <code>cancelled</code> - The Capacity Reservation Fleet has been manually cancelled. The Fleet and its Capacity Reservations are cancelled and the Fleet can't create new Capacity Reservations.</p> </li> <li> <p> <code>failed</code> - The Capacity Reservation Fleet failed to reserve capacity for the specified instance types.</p> </li> </ul> | +| `tagSet` | `array` | The tags assigned to the Capacity Reservation Fleet. | +| `tenancy` | `string` | <p>The tenancy of the Capacity Reservation Fleet. Tenancies include:</p> <ul> <li> <p> <code>default</code> - The Capacity Reservation Fleet is created on hardware that is shared with other Amazon Web Services accounts.</p> </li> <li> <p> <code>dedicated</code> - The Capacity Reservation Fleet is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.</p> </li> </ul> | +| `totalFulfilledCapacity` | `number` | The capacity units that have been fulfilled. | +| `totalTargetCapacity` | `integer` | The total number of capacity units for which the Capacity Reservation Fleet reserves capacity. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#target-capacity">Total target capacity</a> in the Amazon EC2 User Guide. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `capacity_reservation_fleets_Describe` | `SELECT` | `region` | Describes one or more Capacity Reservation Fleets. | +| `capacity_reservation_fleet_Create` | `INSERT` | `InstanceTypeSpecification, TotalTargetCapacity, region` | Creates a Capacity Reservation Fleet. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/work-with-cr-fleets.html#create-crfleet">Create a Capacity Reservation Fleet</a> in the Amazon EC2 User Guide. | +| `capacity_reservation_fleet_Modify` | `EXEC` | `CapacityReservationFleetId, region` | <p>Modifies a Capacity Reservation Fleet.</p> <p>When you modify the total target capacity of a Capacity Reservation Fleet, the Fleet automatically creates new Capacity Reservations, or modifies or cancels existing Capacity Reservations in the Fleet to meet the new total target capacity. When you modify the end date for the Fleet, the end dates for all of the individual Capacity Reservations in the Fleet are updated accordingly.</p> | +| `capacity_reservation_fleets_Cancel` | `EXEC` | `CapacityReservationFleetId, region` | <p>Cancels one or more Capacity Reservation Fleets. When you cancel a Capacity Reservation Fleet, the following happens:</p> <ul> <li> <p>The Capacity Reservation Fleet's status changes to <code>cancelled</code>.</p> </li> <li> <p>The individual Capacity Reservations in the Fleet are cancelled. Instances running in the Capacity Reservations at the time of cancelling the Fleet continue to run in shared capacity.</p> </li> <li> <p>The Fleet stops creating new Capacity Reservations.</p> </li> </ul> | diff --git a/docs/aws-docs/providers/aws/ec2_api/capacity_reservation_usage/index.md b/docs/aws-docs/providers/aws/ec2_api/capacity_reservation_usage/index.md new file mode 100644 index 0000000000..e64b12cccb --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/capacity_reservation_usage/index.md @@ -0,0 +1,40 @@ +--- +title: capacity_reservation_usage +hide_title: false +hide_table_of_contents: false +keywords: + - capacity_reservation_usage + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namecapacity_reservation_usage
TypeResource
Idaws.ec2_api.capacity_reservation_usage
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `availableInstanceCount` | `integer` | The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation. | +| `capacityReservationId` | `string` | The ID of the Capacity Reservation. | +| `instanceType` | `string` | The type of instance for which the Capacity Reservation reserves capacity. | +| `instanceUsageSet` | `array` | Information about the Capacity Reservation usage. | +| `nextToken` | `string` | The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return. | +| `state` | `string` | <p>The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:</p> <ul> <li> <p> <code>active</code> - The Capacity Reservation is active and the capacity is available for your use.</p> </li> <li> <p> <code>expired</code> - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.</p> </li> <li> <p> <code>cancelled</code> - The Capacity Reservation was cancelled. The reserved capacity is no longer available for your use.</p> </li> <li> <p> <code>pending</code> - The Capacity Reservation request was successful but the capacity provisioning is still pending.</p> </li> <li> <p> <code>failed</code> - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.</p> </li> </ul> | +| `totalInstanceCount` | `integer` | The number of instances for which the Capacity Reservation reserves capacity. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `capacity_reservation_usage_Get` | `SELECT` | `CapacityReservationId, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/capacity_reservations/index.md b/docs/aws-docs/providers/aws/ec2_api/capacity_reservations/index.md new file mode 100644 index 0000000000..b98c930ed1 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/capacity_reservations/index.md @@ -0,0 +1,58 @@ +--- +title: capacity_reservations +hide_title: false +hide_table_of_contents: false +keywords: + - capacity_reservations + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namecapacity_reservations
TypeResource
Idaws.ec2_api.capacity_reservations
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `availabilityZone` | `string` | The Availability Zone in which the capacity is reserved. | +| `availabilityZoneId` | `string` | The Availability Zone ID of the Capacity Reservation. | +| `availableInstanceCount` | `integer` | The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation. | +| `capacityReservationArn` | `string` | The Amazon Resource Name (ARN) of the Capacity Reservation. | +| `capacityReservationFleetId` | `string` | The ID of the Capacity Reservation Fleet to which the Capacity Reservation belongs. Only valid for Capacity Reservations that were created by a Capacity Reservation Fleet. | +| `capacityReservationId` | `string` | The ID of the Capacity Reservation. | +| `createDate` | `string` | The date and time at which the Capacity Reservation was created. | +| `ebsOptimized` | `boolean` | Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS- optimized instance. | +| `endDate` | `string` | The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to <code>expired</code> when it reaches its end date and time. | +| `endDateType` | `string` | <p>Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:</p> <ul> <li> <p> <code>unlimited</code> - The Capacity Reservation remains active until you explicitly cancel it.</p> </li> <li> <p> <code>limited</code> - The Capacity Reservation expires automatically at a specified date and time.</p> </li> </ul> | +| `ephemeralStorage` | `boolean` | Indicates whether the Capacity Reservation supports instances with temporary, block-level storage. | +| `instanceMatchCriteria` | `string` | <p>Indicates the type of instance launches that the Capacity Reservation accepts. The options include:</p> <ul> <li> <p> <code>open</code> - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation automatically without specifying any additional parameters.</p> </li> <li> <p> <code>targeted</code> - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity. </p> </li> </ul> | +| `instancePlatform` | `string` | The type of operating system for which the Capacity Reservation reserves capacity. | +| `instanceType` | `string` | The type of instance for which the Capacity Reservation reserves capacity. | +| `outpostArn` | `string` | The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created. | +| `ownerId` | `string` | The ID of the Amazon Web Services account that owns the Capacity Reservation. | +| `placementGroupArn` | `string` | The Amazon Resource Name (ARN) of the cluster placement group in which the Capacity Reservation was created. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/cr-cpg.html"> Capacity Reservations for cluster placement groups</a> in the <i>Amazon EC2 User Guide</i>. | +| `startDate` | `string` | The date and time at which the Capacity Reservation was started. | +| `state` | `string` | <p>The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:</p> <ul> <li> <p> <code>active</code> - The Capacity Reservation is active and the capacity is available for your use.</p> </li> <li> <p> <code>expired</code> - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.</p> </li> <li> <p> <code>cancelled</code> - The Capacity Reservation was cancelled. The reserved capacity is no longer available for your use.</p> </li> <li> <p> <code>pending</code> - The Capacity Reservation request was successful but the capacity provisioning is still pending.</p> </li> <li> <p> <code>failed</code> - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.</p> </li> </ul> | +| `tagSet` | `array` | Any tags assigned to the Capacity Reservation. | +| `tenancy` | `string` | <p>Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:</p> <ul> <li> <p> <code>default</code> - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.</p> </li> <li> <p> <code>dedicated</code> - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.</p> </li> </ul> | +| `totalInstanceCount` | `integer` | The total number of instances for which the Capacity Reservation reserves capacity. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `capacity_reservations_Describe` | `SELECT` | `region` | Describes one or more of your Capacity Reservations. The results describe only the Capacity Reservations in the Amazon Web Services Region that you're currently using. | +| `capacity_reservation_Create` | `INSERT` | `InstanceCount, InstancePlatform, InstanceType, region` | <p>Creates a new Capacity Reservation with the specified attributes.</p> <p>Capacity Reservations enable you to reserve capacity for your Amazon EC2 instances in a specific Availability Zone for any duration. This gives you the flexibility to selectively add capacity reservations and still get the Regional RI discounts for that usage. By creating Capacity Reservations, you ensure that you always have access to Amazon EC2 capacity when you need it, for as long as you need it. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-capacity-reservations.html">Capacity Reservations</a> in the <i>Amazon EC2 User Guide</i>.</p> <p>Your request to create a Capacity Reservation could fail if Amazon EC2 does not have sufficient capacity to fulfill the request. If your request fails due to Amazon EC2 capacity constraints, either try again at a later time, try in a different Availability Zone, or request a smaller capacity reservation. If your application is flexible across instance types and sizes, try to create a Capacity Reservation with different instance attributes.</p> <p>Your request could also fail if the requested quantity exceeds your On-Demand Instance limit for the selected instance type. If your request fails due to limit constraints, increase your On-Demand Instance limit for the required instance type and try again. For more information about increasing your instance limits, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-resource-limits.html">Amazon EC2 Service Quotas</a> in the <i>Amazon EC2 User Guide</i>.</p> | +| `capacity_reservation_Cancel` | `EXEC` | `CapacityReservationId, region` | <p>Cancels the specified Capacity Reservation, releases the reserved capacity, and changes the Capacity Reservation's state to <code>cancelled</code>.</p> <p>Instances running in the reserved capacity continue running until you stop them. Stopped instances that target the Capacity Reservation can no longer launch. Modify these instances to either target a different Capacity Reservation, launch On-Demand Instance capacity, or run in any open Capacity Reservation that has matching attributes and sufficient capacity.</p> | +| `capacity_reservation_Modify` | `EXEC` | `CapacityReservationId, region` | Modifies a Capacity Reservation's capacity and the conditions under which it is to be released. You cannot change a Capacity Reservation's instance type, EBS optimization, instance store settings, platform, Availability Zone, or instance eligibility. If you need to modify any of these attributes, we recommend that you cancel the Capacity Reservation, and then create a new one with the required attributes. | diff --git a/docs/aws-docs/providers/aws/ec2_api/carrier_gateways/index.md b/docs/aws-docs/providers/aws/ec2_api/carrier_gateways/index.md new file mode 100644 index 0000000000..c74e31ee9a --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/carrier_gateways/index.md @@ -0,0 +1,40 @@ +--- +title: carrier_gateways +hide_title: false +hide_table_of_contents: false +keywords: + - carrier_gateways + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namecarrier_gateways
TypeResource
Idaws.ec2_api.carrier_gateways
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `carrierGatewayId` | `string` | The ID of the carrier gateway. | +| `ownerId` | `string` | The Amazon Web Services account ID of the owner of the carrier gateway. | +| `state` | `string` | The state of the carrier gateway. | +| `tagSet` | `array` | The tags assigned to the carrier gateway. | +| `vpcId` | `string` | The ID of the VPC associated with the carrier gateway. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `carrier_gateways_Describe` | `SELECT` | `region` | Describes one or more of your carrier gateways. | +| `carrier_gateway_Create` | `INSERT` | `VpcId, region` | Creates a carrier gateway. For more information about carrier gateways, see <a href="https://docs.aws.amazon.com/wavelength/latest/developerguide/how-wavelengths-work.html#wavelength-carrier-gateway">Carrier gateways</a> in the <i>Amazon Web Services Wavelength Developer Guide</i>. | +| `carrier_gateway_Delete` | `DELETE` | `CarrierGatewayId, region` | <p>Deletes a carrier gateway.</p> <important> <p>If you do not delete the route that contains the carrier gateway as the Target, the route is a blackhole route. For information about how to delete a route, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeleteRoute.html">DeleteRoute</a>.</p> </important> | diff --git a/docs/aws-docs/providers/aws/ec2_api/classic_link_instances/index.md b/docs/aws-docs/providers/aws/ec2_api/classic_link_instances/index.md new file mode 100644 index 0000000000..2ea8842060 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/classic_link_instances/index.md @@ -0,0 +1,37 @@ +--- +title: classic_link_instances +hide_title: false +hide_table_of_contents: false +keywords: + - classic_link_instances + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameclassic_link_instances
TypeResource
Idaws.ec2_api.classic_link_instances
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `groupSet` | `array` | A list of security groups. | +| `instanceId` | `string` | The ID of the instance. | +| `tagSet` | `array` | Any tags assigned to the instance. | +| `vpcId` | `string` | The ID of the VPC. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `classic_link_instances_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/classic_link_vpc/index.md b/docs/aws-docs/providers/aws/ec2_api/classic_link_vpc/index.md new file mode 100644 index 0000000000..fb286cb9fa --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/classic_link_vpc/index.md @@ -0,0 +1,33 @@ +--- +title: classic_link_vpc +hide_title: false +hide_table_of_contents: false +keywords: + - classic_link_vpc + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameclassic_link_vpc
TypeResource
Idaws.ec2_api.classic_link_vpc
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `classic_link_vpc_Attach` | `EXEC` | `InstanceId, SecurityGroupId, VpcId, region` | <p>Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's security groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You can only link an instance that's in the <code>running</code> state. An instance is automatically unlinked from a VPC when it's stopped - you can link it to the VPC again when you restart it.</p> <p>After you've linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again.</p> <p>Linking your instance to a VPC is sometimes referred to as <i>attaching</i> your instance.</p> | +| `classic_link_vpc_Detach` | `EXEC` | `InstanceId, VpcId, region` | Unlinks (detaches) a linked EC2-Classic instance from a VPC. After the instance has been unlinked, the VPC security groups are no longer associated with it. An instance is automatically unlinked from a VPC when it's stopped. | diff --git a/docs/aws-docs/providers/aws/ec2_api/client_vpn_authorization_rules/index.md b/docs/aws-docs/providers/aws/ec2_api/client_vpn_authorization_rules/index.md new file mode 100644 index 0000000000..c74c506ec4 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/client_vpn_authorization_rules/index.md @@ -0,0 +1,39 @@ +--- +title: client_vpn_authorization_rules +hide_title: false +hide_table_of_contents: false +keywords: + - client_vpn_authorization_rules + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameclient_vpn_authorization_rules
TypeResource
Idaws.ec2_api.client_vpn_authorization_rules
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `description` | `string` | A brief description of the authorization rule. | +| `accessAll` | `boolean` | Indicates whether the authorization rule grants access to all clients. | +| `clientVpnEndpointId` | `string` | The ID of the Client VPN endpoint with which the authorization rule is associated. | +| `destinationCidr` | `string` | The IPv4 address range, in CIDR notation, of the network to which the authorization rule applies. | +| `groupId` | `string` | The ID of the Active Directory group to which the authorization rule grants access. | +| `status` | `object` | Describes the state of an authorization rule. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `client_vpn_authorization_rules_Describe` | `SELECT` | `ClientVpnEndpointId, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/client_vpn_client_certificate_revocation_list/index.md b/docs/aws-docs/providers/aws/ec2_api/client_vpn_client_certificate_revocation_list/index.md new file mode 100644 index 0000000000..38c8caf316 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/client_vpn_client_certificate_revocation_list/index.md @@ -0,0 +1,33 @@ +--- +title: client_vpn_client_certificate_revocation_list +hide_title: false +hide_table_of_contents: false +keywords: + - client_vpn_client_certificate_revocation_list + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameclient_vpn_client_certificate_revocation_list
TypeResource
Idaws.ec2_api.client_vpn_client_certificate_revocation_list
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `client_vpn_client_certificate_revocation_list_Export` | `EXEC` | `ClientVpnEndpointId, region` | Downloads the client certificate revocation list for the specified Client VPN endpoint. | +| `client_vpn_client_certificate_revocation_list_Import` | `EXEC` | `CertificateRevocationList, ClientVpnEndpointId, region` | <p>Uploads a client certificate revocation list to the specified Client VPN endpoint. Uploading a client certificate revocation list overwrites the existing client certificate revocation list.</p> <p>Uploading a client certificate revocation list resets existing client connections.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/client_vpn_client_configuration/index.md b/docs/aws-docs/providers/aws/ec2_api/client_vpn_client_configuration/index.md new file mode 100644 index 0000000000..dc0db6bc66 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/client_vpn_client_configuration/index.md @@ -0,0 +1,32 @@ +--- +title: client_vpn_client_configuration +hide_title: false +hide_table_of_contents: false +keywords: + - client_vpn_client_configuration + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameclient_vpn_client_configuration
TypeResource
Idaws.ec2_api.client_vpn_client_configuration
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `client_vpn_client_configuration_Export` | `EXEC` | `ClientVpnEndpointId, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/client_vpn_connections/index.md b/docs/aws-docs/providers/aws/ec2_api/client_vpn_connections/index.md new file mode 100644 index 0000000000..f63fd99e8a --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/client_vpn_connections/index.md @@ -0,0 +1,48 @@ +--- +title: client_vpn_connections +hide_title: false +hide_table_of_contents: false +keywords: + - client_vpn_connections + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameclient_vpn_connections
TypeResource
Idaws.ec2_api.client_vpn_connections
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `clientIp` | `string` | The IP address of the client. | +| `clientVpnEndpointId` | `string` | The ID of the Client VPN endpoint to which the client is connected. | +| `commonName` | `string` | The common name associated with the client. This is either the name of the client certificate, or the Active Directory user name. | +| `connectionEndTime` | `string` | The date and time the client connection was terminated. | +| `connectionEstablishedTime` | `string` | The date and time the client connection was established. | +| `connectionId` | `string` | The ID of the client connection. | +| `egressBytes` | `string` | The number of bytes received by the client. | +| `egressPackets` | `string` | The number of packets received by the client. | +| `ingressBytes` | `string` | The number of bytes sent by the client. | +| `ingressPackets` | `string` | The number of packets sent by the client. | +| `postureComplianceStatusSet` | `array` | The statuses returned by the client connect handler for posture compliance, if applicable. | +| `status` | `object` | Describes the status of a client connection. | +| `timestamp` | `string` | The current date and time. | +| `username` | `string` | The username of the client who established the client connection. This information is only provided if Active Directory client authentication is used. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `client_vpn_connections_Describe` | `SELECT` | `ClientVpnEndpointId, region` | Describes active client connections and connections that have been terminated within the last 60 minutes for the specified Client VPN endpoint. | +| `client_vpn_connections_Terminate` | `EXEC` | `ClientVpnEndpointId, region` | Terminates active Client VPN endpoint connections. This action can be used to terminate a specific client connection, or up to five connections established by a specific user. | diff --git a/docs/aws-docs/providers/aws/ec2_api/client_vpn_endpoints/index.md b/docs/aws-docs/providers/aws/ec2_api/client_vpn_endpoints/index.md new file mode 100644 index 0000000000..55d04d6873 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/client_vpn_endpoints/index.md @@ -0,0 +1,59 @@ +--- +title: client_vpn_endpoints +hide_title: false +hide_table_of_contents: false +keywords: + - client_vpn_endpoints + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameclient_vpn_endpoints
TypeResource
Idaws.ec2_api.client_vpn_endpoints
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `description` | `string` | A brief description of the endpoint. | +| `associatedTargetNetwork` | `array` | Information about the associated target networks. A target network is a subnet in a VPC.This property is deprecated. To view the target networks associated with a Client VPN endpoint, call DescribeClientVpnTargetNetworks and inspect the clientVpnTargetNetworks response element. | +| `authenticationOptions` | `array` | Information about the authentication method used by the Client VPN endpoint. | +| `clientCidrBlock` | `string` | The IPv4 address range, in CIDR notation, from which client IP addresses are assigned. | +| `clientConnectOptions` | `object` | The options for managing connection authorization for new client connections. | +| `clientLoginBannerOptions` | `object` | Current state of options for customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established. | +| `clientVpnEndpointId` | `string` | The ID of the Client VPN endpoint. | +| `connectionLogOptions` | `object` | Information about the client connection logging options for a Client VPN endpoint. | +| `creationTime` | `string` | The date and time the Client VPN endpoint was created. | +| `deletionTime` | `string` | The date and time the Client VPN endpoint was deleted, if applicable. | +| `dnsName` | `string` | The DNS name to be used by clients when connecting to the Client VPN endpoint. | +| `dnsServer` | `array` | Information about the DNS servers to be used for DNS resolution. | +| `securityGroupIdSet` | `array` | The IDs of the security groups for the target network. | +| `selfServicePortalUrl` | `string` | The URL of the self-service portal. | +| `serverCertificateArn` | `string` | The ARN of the server certificate. | +| `sessionTimeoutHours` | `integer` | <p>The maximum VPN session duration time in hours.</p> <p>Valid values: <code>8 \| 10 \| 12 \| 24</code> </p> <p>Default value: <code>24</code> </p> | +| `splitTunnel` | `boolean` | <p>Indicates whether split-tunnel is enabled in the Client VPN endpoint.</p> <p>For information about split-tunnel VPN endpoints, see <a href="https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/split-tunnel-vpn.html">Split-Tunnel Client VPN endpoint</a> in the <i>Client VPN Administrator Guide</i>.</p> | +| `status` | `object` | Describes the state of a Client VPN endpoint. | +| `tagSet` | `array` | Any tags assigned to the Client VPN endpoint. | +| `transportProtocol` | `string` | The transport protocol used by the Client VPN endpoint. | +| `vpcId` | `string` | The ID of the VPC. | +| `vpnPort` | `integer` | The port number for the Client VPN endpoint. | +| `vpnProtocol` | `string` | The protocol used by the VPN session. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `client_vpn_endpoints_Describe` | `SELECT` | `region` | Describes one or more Client VPN endpoints in the account. | +| `client_vpn_endpoint_Create` | `INSERT` | `Authentication, ClientCidrBlock, ConnectionLogOptions, ServerCertificateArn, region` | Creates a Client VPN endpoint. A Client VPN endpoint is the resource you create and configure to enable and manage client VPN sessions. It is the destination endpoint at which all client VPN sessions are terminated. | +| `client_vpn_endpoint_Delete` | `DELETE` | `ClientVpnEndpointId, region` | Deletes the specified Client VPN endpoint. You must disassociate all target networks before you can delete a Client VPN endpoint. | +| `client_vpn_endpoint_Modify` | `EXEC` | `ClientVpnEndpointId, region` | Modifies the specified Client VPN endpoint. Modifying the DNS server resets existing client connections. | diff --git a/docs/aws-docs/providers/aws/ec2_api/client_vpn_ingress/index.md b/docs/aws-docs/providers/aws/ec2_api/client_vpn_ingress/index.md new file mode 100644 index 0000000000..9f6b4aa093 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/client_vpn_ingress/index.md @@ -0,0 +1,33 @@ +--- +title: client_vpn_ingress +hide_title: false +hide_table_of_contents: false +keywords: + - client_vpn_ingress + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameclient_vpn_ingress
TypeResource
Idaws.ec2_api.client_vpn_ingress
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `client_vpn_ingress_Authorize` | `EXEC` | `ClientVpnEndpointId, TargetNetworkCidr, region` | Adds an ingress authorization rule to a Client VPN endpoint. Ingress authorization rules act as firewall rules that grant access to networks. You must configure ingress authorization rules to enable clients to access resources in Amazon Web Services or on-premises networks. | +| `client_vpn_ingress_Revoke` | `EXEC` | `ClientVpnEndpointId, TargetNetworkCidr, region` | Removes an ingress authorization rule from a Client VPN endpoint. | diff --git a/docs/aws-docs/providers/aws/ec2_api/client_vpn_routes/index.md b/docs/aws-docs/providers/aws/ec2_api/client_vpn_routes/index.md new file mode 100644 index 0000000000..36b14060d6 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/client_vpn_routes/index.md @@ -0,0 +1,42 @@ +--- +title: client_vpn_routes +hide_title: false +hide_table_of_contents: false +keywords: + - client_vpn_routes + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameclient_vpn_routes
TypeResource
Idaws.ec2_api.client_vpn_routes
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `description` | `string` | A brief description of the route. | +| `clientVpnEndpointId` | `string` | The ID of the Client VPN endpoint with which the route is associated. | +| `destinationCidr` | `string` | The IPv4 address range, in CIDR notation, of the route destination. | +| `origin` | `string` | Indicates how the route was associated with the Client VPN endpoint. <code>associate</code> indicates that the route was automatically added when the target network was associated with the Client VPN endpoint. <code>add-route</code> indicates that the route was manually added using the <b>CreateClientVpnRoute</b> action. | +| `status` | `object` | Describes the state of a Client VPN endpoint route. | +| `targetSubnet` | `string` | The ID of the subnet through which traffic is routed. | +| `type` | `string` | The route type. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `client_vpn_routes_Describe` | `SELECT` | `ClientVpnEndpointId, region` | Describes the routes for the specified Client VPN endpoint. | +| `client_vpn_route_Create` | `INSERT` | `ClientVpnEndpointId, DestinationCidrBlock, TargetVpcSubnetId, region` | Adds a route to a network to a Client VPN endpoint. Each Client VPN endpoint has a route table that describes the available destination network routes. Each route in the route table specifies the path for traffic to specific resources or networks. | +| `client_vpn_route_Delete` | `DELETE` | `ClientVpnEndpointId, DestinationCidrBlock, region` | Deletes a route from a Client VPN endpoint. You can only delete routes that you manually added using the <b>CreateClientVpnRoute</b> action. You cannot delete routes that were automatically added when associating a subnet. To remove routes that have been automatically added, disassociate the target subnet from the Client VPN endpoint. | diff --git a/docs/aws-docs/providers/aws/ec2_api/client_vpn_target_networks/index.md b/docs/aws-docs/providers/aws/ec2_api/client_vpn_target_networks/index.md new file mode 100644 index 0000000000..1d47b9992f --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/client_vpn_target_networks/index.md @@ -0,0 +1,41 @@ +--- +title: client_vpn_target_networks +hide_title: false +hide_table_of_contents: false +keywords: + - client_vpn_target_networks + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameclient_vpn_target_networks
TypeResource
Idaws.ec2_api.client_vpn_target_networks
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `associationId` | `string` | The ID of the association. | +| `clientVpnEndpointId` | `string` | The ID of the Client VPN endpoint with which the target network is associated. | +| `securityGroups` | `array` | The IDs of the security groups applied to the target network association. | +| `status` | `object` | Describes the state of a target network association. | +| `targetNetworkId` | `string` | The ID of the subnet specified as the target network. | +| `vpcId` | `string` | The ID of the VPC in which the target network (subnet) is located. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `client_vpn_target_networks_Describe` | `SELECT` | `ClientVpnEndpointId, region` | Describes the target networks associated with the specified Client VPN endpoint. | +| `client_vpn_target_network_Associate` | `EXEC` | `ClientVpnEndpointId, SubnetId, region` | <p>Associates a target network with a Client VPN endpoint. A target network is a subnet in a VPC. You can associate multiple subnets from the same VPC with a Client VPN endpoint. You can associate only one subnet in each Availability Zone. We recommend that you associate at least two subnets to provide Availability Zone redundancy.</p> <p>If you specified a VPC when you created the Client VPN endpoint or if you have previous subnet associations, the specified subnet must be in the same VPC. To specify a subnet that's in a different VPC, you must first modify the Client VPN endpoint (<a>ModifyClientVpnEndpoint</a>) and change the VPC that's associated with it.</p> | +| `client_vpn_target_network_Disassociate` | `EXEC` | `AssociationId, ClientVpnEndpointId, region` | <p>Disassociates a target network from the specified Client VPN endpoint. When you disassociate the last target network from a Client VPN, the following happens:</p> <ul> <li> <p>The route that was automatically added for the VPC is deleted</p> </li> <li> <p>All active client connections are terminated</p> </li> <li> <p>New client connections are disallowed</p> </li> <li> <p>The Client VPN endpoint's status changes to <code>pending-associate</code> </p> </li> </ul> | diff --git a/docs/aws-docs/providers/aws/ec2_api/coip_pool_usage/index.md b/docs/aws-docs/providers/aws/ec2_api/coip_pool_usage/index.md new file mode 100644 index 0000000000..bf6e69548e --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/coip_pool_usage/index.md @@ -0,0 +1,37 @@ +--- +title: coip_pool_usage +hide_title: false +hide_table_of_contents: false +keywords: + - coip_pool_usage + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namecoip_pool_usage
TypeResource
Idaws.ec2_api.coip_pool_usage
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `allocationId` | `string` | The allocation ID of the address. | +| `awsAccountId` | `string` | The Amazon Web Services account ID. | +| `awsService` | `string` | The Amazon Web Services service. | +| `coIp` | `string` | The customer-owned IP address. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `coip_pool_usage_Get` | `SELECT` | `PoolId, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/coip_pools/index.md b/docs/aws-docs/providers/aws/ec2_api/coip_pools/index.md new file mode 100644 index 0000000000..c74faaf08d --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/coip_pools/index.md @@ -0,0 +1,38 @@ +--- +title: coip_pools +hide_title: false +hide_table_of_contents: false +keywords: + - coip_pools + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namecoip_pools
TypeResource
Idaws.ec2_api.coip_pools
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `localGatewayRouteTableId` | `string` | The ID of the local gateway route table. | +| `poolArn` | `string` | The ARN of the address pool. | +| `poolCidrSet` | `array` | The address ranges of the address pool. | +| `poolId` | `string` | The ID of the address pool. | +| `tagSet` | `array` | The tags. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `coip_pools_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/console_output/index.md b/docs/aws-docs/providers/aws/ec2_api/console_output/index.md new file mode 100644 index 0000000000..cfa12fed02 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/console_output/index.md @@ -0,0 +1,36 @@ +--- +title: console_output +hide_title: false +hide_table_of_contents: false +keywords: + - console_output + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameconsole_output
TypeResource
Idaws.ec2_api.console_output
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `instanceId` | `string` | The ID of the instance. | +| `output` | `string` | The console output, base64-encoded. If you are using a command line tool, the tool decodes the output for you. | +| `timestamp` | `string` | The time at which the output was last updated. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `console_output_Get` | `SELECT` | `InstanceId, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/console_screenshot/index.md b/docs/aws-docs/providers/aws/ec2_api/console_screenshot/index.md new file mode 100644 index 0000000000..6a4ee8b837 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/console_screenshot/index.md @@ -0,0 +1,35 @@ +--- +title: console_screenshot +hide_title: false +hide_table_of_contents: false +keywords: + - console_screenshot + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameconsole_screenshot
TypeResource
Idaws.ec2_api.console_screenshot
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `imageData` | `string` | The data that comprises the image. | +| `instanceId` | `string` | The ID of the instance. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `console_screenshot_Get` | `SELECT` | `InstanceId, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/conversion_tasks/index.md b/docs/aws-docs/providers/aws/ec2_api/conversion_tasks/index.md new file mode 100644 index 0000000000..4171a745bf --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/conversion_tasks/index.md @@ -0,0 +1,41 @@ +--- +title: conversion_tasks +hide_title: false +hide_table_of_contents: false +keywords: + - conversion_tasks + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameconversion_tasks
TypeResource
Idaws.ec2_api.conversion_tasks
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `conversionTaskId` | `string` | The ID of the conversion task. | +| `expirationTime` | `string` | The time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel the task. | +| `importInstance` | `object` | Describes an import instance task. | +| `importVolume` | `object` | Describes an import volume task. | +| `state` | `string` | The state of the conversion task. | +| `statusMessage` | `string` | The status message related to the conversion task. | +| `tagSet` | `array` | Any tags assigned to the task. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `conversion_tasks_Describe` | `SELECT` | `region` | <p>Describes the specified conversion tasks or all your conversion tasks. For more information, see the <a href="https://docs.aws.amazon.com/vm-import/latest/userguide/">VM Import/Export User Guide</a>.</p> <p>For information about the import manifest referenced by this API action, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/manifest.html">VM Import Manifest</a>.</p> | +| `conversion_task_Cancel` | `EXEC` | `ConversionTaskId, region` | <p>Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/CommandLineReference/ec2-cli-vmimport-export.html">Importing a Virtual Machine Using the Amazon EC2 CLI</a>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/customer_gateways/index.md b/docs/aws-docs/providers/aws/ec2_api/customer_gateways/index.md new file mode 100644 index 0000000000..b019310385 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/customer_gateways/index.md @@ -0,0 +1,43 @@ +--- +title: customer_gateways +hide_title: false +hide_table_of_contents: false +keywords: + - customer_gateways + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namecustomer_gateways
TypeResource
Idaws.ec2_api.customer_gateways
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `bgpAsn` | `string` | The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN). | +| `certificateArn` | `string` | The Amazon Resource Name (ARN) for the customer gateway certificate. | +| `customerGatewayId` | `string` | The ID of the customer gateway. | +| `deviceName` | `string` | The name of customer gateway device. | +| `ipAddress` | `string` | The Internet-routable IP address of the customer gateway's outside interface. | +| `state` | `string` | The current state of the customer gateway (<code>pending \| available \| deleting \| deleted</code>). | +| `tagSet` | `array` | Any tags assigned to the customer gateway. | +| `type` | `string` | The type of VPN connection the customer gateway supports (<code>ipsec.1</code>). | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `customer_gateways_Describe` | `SELECT` | `region` | <p>Describes one or more of your VPN customer gateways.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html">Amazon Web Services Site-to-Site VPN</a> in the <i>Amazon Web Services Site-to-Site VPN User Guide</i>.</p> | +| `customer_gateway_Create` | `INSERT` | `BgpAsn, Type, region` | <p>Provides information to Amazon Web Services about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the Amazon Web Services side of the VPN connection is the virtual private gateway.) You must provide the internet-routable IP address of the customer gateway's external interface. The IP address must be static and can be behind a device performing network address translation (NAT).</p> <p>For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN. For more information, see <a href="https://docs.aws.amazon.com/vpn/latest/s2svpn/cgw-options.html">Customer gateway options for your Site-to-Site VPN connection</a> in the <i>Amazon Web Services Site-to-Site VPN User Guide</i>.</p> <p>To create more than one customer gateway with the same VPN type, IP address, and BGP ASN, specify a unique device name for each customer gateway. An identical request returns information about the existing customer gateway; it doesn't create a new customer gateway.</p> | +| `customer_gateway_Delete` | `DELETE` | `CustomerGatewayId, region` | Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway. | diff --git a/docs/aws-docs/providers/aws/ec2_api/default_credit_specification/index.md b/docs/aws-docs/providers/aws/ec2_api/default_credit_specification/index.md new file mode 100644 index 0000000000..eebbb1afa7 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/default_credit_specification/index.md @@ -0,0 +1,36 @@ +--- +title: default_credit_specification +hide_title: false +hide_table_of_contents: false +keywords: + - default_credit_specification + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namedefault_credit_specification
TypeResource
Idaws.ec2_api.default_credit_specification
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `cpuCredits` | `string` | The default credit option for CPU usage of the instance family. Valid values are <code>standard</code> and <code>unlimited</code>. | +| `instanceFamily` | `string` | The instance family. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `default_credit_specification_Get` | `SELECT` | `InstanceFamily, region` | <p>Describes the default credit option for CPU usage of a burstable performance instance family.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html">Burstable performance instances</a> in the <i>Amazon EC2 User Guide</i>.</p> | +| `default_credit_specification_Modify` | `EXEC` | `CpuCredits, InstanceFamily, region` | <p>Modifies the default credit option for CPU usage of burstable performance instances. The default credit option is set at the account level per Amazon Web Services Region, and is specified per instance family. All new burstable performance instances in the account launch using the default credit option.</p> <p> <code>ModifyDefaultCreditSpecification</code> is an asynchronous operation, which works at an Amazon Web Services Region level and modifies the credit option for each Availability Zone. All zones in a Region are updated within five minutes. But if instances are launched during this operation, they might not get the new credit option until the zone is updated. To verify whether the update has occurred, you can call <code>GetDefaultCreditSpecification</code> and check <code>DefaultCreditSpecification</code> for updates.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html">Burstable performance instances</a> in the <i>Amazon EC2 User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/default_subnet/index.md b/docs/aws-docs/providers/aws/ec2_api/default_subnet/index.md new file mode 100644 index 0000000000..fd3fcf2ee4 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/default_subnet/index.md @@ -0,0 +1,32 @@ +--- +title: default_subnet +hide_title: false +hide_table_of_contents: false +keywords: + - default_subnet + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namedefault_subnet
TypeResource
Idaws.ec2_api.default_subnet
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `default_subnet_Create` | `INSERT` | `AvailabilityZone, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/default_vpc/index.md b/docs/aws-docs/providers/aws/ec2_api/default_vpc/index.md new file mode 100644 index 0000000000..c28505d271 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/default_vpc/index.md @@ -0,0 +1,32 @@ +--- +title: default_vpc +hide_title: false +hide_table_of_contents: false +keywords: + - default_vpc + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namedefault_vpc
TypeResource
Idaws.ec2_api.default_vpc
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `default_vpc_Create` | `INSERT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/dhcp_options/index.md b/docs/aws-docs/providers/aws/ec2_api/dhcp_options/index.md new file mode 100644 index 0000000000..06e678c8b1 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/dhcp_options/index.md @@ -0,0 +1,40 @@ +--- +title: dhcp_options +hide_title: false +hide_table_of_contents: false +keywords: + - dhcp_options + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namedhcp_options
TypeResource
Idaws.ec2_api.dhcp_options
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `dhcpConfigurationSet` | `array` | One or more DHCP options in the set. | +| `dhcpOptionsId` | `string` | The ID of the set of DHCP options. | +| `ownerId` | `string` | The ID of the Amazon Web Services account that owns the DHCP options set. | +| `tagSet` | `array` | Any tags assigned to the DHCP options set. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `dhcp_options_Describe` | `SELECT` | `region` | <p>Describes one or more of your DHCP options sets.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_DHCP_Options.html">DHCP options sets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p> | +| `dhcp_options_Create` | `INSERT` | `DhcpConfiguration, region` | <p>Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see <a href="http://www.ietf.org/rfc/rfc2132.txt">RFC 2132</a>.</p> <ul> <li> <p> <code>domain-name-servers</code> - The IP addresses of up to four domain name servers, or AmazonProvidedDNS. The default DHCP option set specifies AmazonProvidedDNS. If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas. To have your instance receive a custom DNS hostname as specified in <code>domain-name</code>, you must set <code>domain-name-servers</code> to a custom DNS server.</p> </li> <li> <p> <code>domain-name</code> - If you're using AmazonProvidedDNS in <code>us-east-1</code>, specify <code>ec2.internal</code>. If you're using AmazonProvidedDNS in another Region, specify <code>region.compute.internal</code> (for example, <code>ap-northeast-1.compute.internal</code>). Otherwise, specify a domain name (for example, <code>ExampleCompany.com</code>). This value is used to complete unqualified DNS hostnames. <b>Important</b>: Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP options set is associated with a VPC that has instances with multiple operating systems, specify only one domain name.</p> </li> <li> <p> <code>ntp-servers</code> - The IP addresses of up to four Network Time Protocol (NTP) servers.</p> </li> <li> <p> <code>netbios-name-servers</code> - The IP addresses of up to four NetBIOS name servers.</p> </li> <li> <p> <code>netbios-node-type</code> - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2 (broadcast and multicast are not currently supported). For more information about these node types, see <a href="http://www.ietf.org/rfc/rfc2132.txt">RFC 2132</a>.</p> </li> </ul> <p>Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide (AmazonProvidedDNS). If you create a set of options, and if your VPC has an internet gateway, make sure to set the <code>domain-name-servers</code> option either to <code>AmazonProvidedDNS</code> or to a domain name server of your choice. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_DHCP_Options.html">DHCP options sets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p> | +| `dhcp_options_Delete` | `DELETE` | `DhcpOptionsId, region` | Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC. | +| `dhcp_options_Associate` | `EXEC` | `DhcpOptionsId, VpcId, region` | <p>Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC.</p> <p>After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_DHCP_Options.html">DHCP options sets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/diagnostic_interrupt/index.md b/docs/aws-docs/providers/aws/ec2_api/diagnostic_interrupt/index.md new file mode 100644 index 0000000000..8306bcbff4 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/diagnostic_interrupt/index.md @@ -0,0 +1,32 @@ +--- +title: diagnostic_interrupt +hide_title: false +hide_table_of_contents: false +keywords: + - diagnostic_interrupt + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namediagnostic_interrupt
TypeResource
Idaws.ec2_api.diagnostic_interrupt
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `diagnostic_interrupt_Send` | `EXEC` | `InstanceId, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/ebs_default_kms_key_id/index.md b/docs/aws-docs/providers/aws/ec2_api/ebs_default_kms_key_id/index.md new file mode 100644 index 0000000000..c1ff6327d7 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/ebs_default_kms_key_id/index.md @@ -0,0 +1,33 @@ +--- +title: ebs_default_kms_key_id +hide_title: false +hide_table_of_contents: false +keywords: + - ebs_default_kms_key_id + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameebs_default_kms_key_id
TypeResource
Idaws.ec2_api.ebs_default_kms_key_id
+ +## Fields +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `ebs_default_kms_key_id_Get` | `SELECT` | `region` | <p>Describes the default KMS key for EBS encryption by default for your account in this Region. You can change the default KMS key for encryption by default using <a>ModifyEbsDefaultKmsKeyId</a> or <a>ResetEbsDefaultKmsKeyId</a>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html">Amazon EBS encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | +| `ebs_default_kms_key_id_Modify` | `EXEC` | `KmsKeyId, region` | <p>Changes the default KMS key for EBS encryption by default for your account in this Region.</p> <p>Amazon Web Services creates a unique Amazon Web Services managed KMS key in each Region for use with encryption by default. If you change the default KMS key to a symmetric customer managed KMS key, it is used instead of the Amazon Web Services managed KMS key. To reset the default KMS key to the Amazon Web Services managed KMS key for EBS, use <a>ResetEbsDefaultKmsKeyId</a>. Amazon EBS does not support asymmetric KMS keys.</p> <p>If you delete or disable the customer managed KMS key that you specified for use with encryption by default, your instances will fail to launch.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html">Amazon EBS encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | +| `ebs_default_kms_key_id_Reset` | `EXEC` | `region` | <p>Resets the default KMS key for EBS encryption for your account in this Region to the Amazon Web Services managed KMS key for EBS.</p> <p>After resetting the default KMS key to the Amazon Web Services managed KMS key, you can continue to encrypt by a customer managed KMS key by specifying it when you create the volume. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html">Amazon EBS encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/ebs_encryption_by_default/index.md b/docs/aws-docs/providers/aws/ec2_api/ebs_encryption_by_default/index.md new file mode 100644 index 0000000000..5541e667d1 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/ebs_encryption_by_default/index.md @@ -0,0 +1,33 @@ +--- +title: ebs_encryption_by_default +hide_title: false +hide_table_of_contents: false +keywords: + - ebs_encryption_by_default + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameebs_encryption_by_default
TypeResource
Idaws.ec2_api.ebs_encryption_by_default
+ +## Fields +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `ebs_encryption_by_default_Get` | `SELECT` | `region` | <p>Describes whether EBS encryption by default is enabled for your account in the current Region.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html">Amazon EBS encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | +| `ebs_encryption_by_default_Disable` | `EXEC` | `region` | <p>Disables EBS encryption by default for your account in the current Region.</p> <p>After you disable encryption by default, you can still create encrypted volumes by enabling encryption when you create each volume.</p> <p>Disabling encryption by default does not change the encryption status of your existing volumes.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html">Amazon EBS encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | +| `ebs_encryption_by_default_Enable` | `EXEC` | `region` | <p>Enables EBS encryption by default for your account in the current Region.</p> <p>After you enable encryption by default, the EBS volumes that you create are always encrypted, either using the default KMS key or the KMS key that you specified when you created each volume. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html">Amazon EBS encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>You can specify the default KMS key for encryption by default using <a>ModifyEbsDefaultKmsKeyId</a> or <a>ResetEbsDefaultKmsKeyId</a>.</p> <p>Enabling encryption by default has no effect on the encryption status of your existing volumes.</p> <p>After you enable encryption by default, you can no longer launch instances using instance types that do not support encryption. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances">Supported instance types</a>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/egress_only_internet_gateways/index.md b/docs/aws-docs/providers/aws/ec2_api/egress_only_internet_gateways/index.md new file mode 100644 index 0000000000..110146eda9 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/egress_only_internet_gateways/index.md @@ -0,0 +1,38 @@ +--- +title: egress_only_internet_gateways +hide_title: false +hide_table_of_contents: false +keywords: + - egress_only_internet_gateways + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameegress_only_internet_gateways
TypeResource
Idaws.ec2_api.egress_only_internet_gateways
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `attachmentSet` | `array` | Information about the attachment of the egress-only internet gateway. | +| `egressOnlyInternetGatewayId` | `string` | The ID of the egress-only internet gateway. | +| `tagSet` | `array` | The tags assigned to the egress-only internet gateway. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `egress_only_internet_gateways_Describe` | `SELECT` | `region` | Describes one or more of your egress-only internet gateways. | +| `egress_only_internet_gateway_Create` | `INSERT` | `VpcId, region` | [IPv6 only] Creates an egress-only internet gateway for your VPC. An egress-only internet gateway is used to enable outbound communication over IPv6 from instances in your VPC to the internet, and prevents hosts outside of your VPC from initiating an IPv6 connection with your instance. | +| `egress_only_internet_gateway_Delete` | `DELETE` | `EgressOnlyInternetGatewayId, region` | Deletes an egress-only internet gateway. | diff --git a/docs/aws-docs/providers/aws/ec2_api/elastic_gpus/index.md b/docs/aws-docs/providers/aws/ec2_api/elastic_gpus/index.md new file mode 100644 index 0000000000..59545dc63b --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/elastic_gpus/index.md @@ -0,0 +1,40 @@ +--- +title: elastic_gpus +hide_title: false +hide_table_of_contents: false +keywords: + - elastic_gpus + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameelastic_gpus
TypeResource
Idaws.ec2_api.elastic_gpus
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `availabilityZone` | `string` | The Availability Zone in the which the Elastic Graphics accelerator resides. | +| `elasticGpuHealth` | `object` | Describes the status of an Elastic Graphics accelerator. | +| `elasticGpuId` | `string` | The ID of the Elastic Graphics accelerator. | +| `elasticGpuState` | `string` | The state of the Elastic Graphics accelerator. | +| `elasticGpuType` | `string` | The type of Elastic Graphics accelerator. | +| `instanceId` | `string` | The ID of the instance to which the Elastic Graphics accelerator is attached. | +| `tagSet` | `array` | The tags assigned to the Elastic Graphics accelerator. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `elastic_gpus_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/enclave_certificate_iam_role/index.md b/docs/aws-docs/providers/aws/ec2_api/enclave_certificate_iam_role/index.md new file mode 100644 index 0000000000..b682c87665 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/enclave_certificate_iam_role/index.md @@ -0,0 +1,33 @@ +--- +title: enclave_certificate_iam_role +hide_title: false +hide_table_of_contents: false +keywords: + - enclave_certificate_iam_role + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameenclave_certificate_iam_role
TypeResource
Idaws.ec2_api.enclave_certificate_iam_role
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `enclave_certificate_iam_role_Associate` | `EXEC` | `region` | <p>Associates an Identity and Access Management (IAM) role with an Certificate Manager (ACM) certificate. This enables the certificate to be used by the ACM for Nitro Enclaves application inside an enclave. For more information, see <a href="https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave-refapp.html">Certificate Manager for Nitro Enclaves</a> in the <i>Amazon Web Services Nitro Enclaves User Guide</i>.</p> <p>When the IAM role is associated with the ACM certificate, the certificate, certificate chain, and encrypted private key are placed in an Amazon S3 bucket that only the associated IAM role can access. The private key of the certificate is encrypted with an Amazon Web Services managed key that has an attached attestation-based key policy.</p> <p>To enable the IAM role to access the Amazon S3 object, you must grant it permission to call <code>s3:GetObject</code> on the Amazon S3 bucket returned by the command. To enable the IAM role to access the KMS key, you must grant it permission to call <code>kms:Decrypt</code> on the KMS key returned by the command. For more information, see <a href="https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave-refapp.html#add-policy"> Grant the role permission to access the certificate and encryption key</a> in the <i>Amazon Web Services Nitro Enclaves User Guide</i>.</p> | +| `enclave_certificate_iam_role_Disassociate` | `EXEC` | `region` | Disassociates an IAM role from an Certificate Manager (ACM) certificate. Disassociating an IAM role from an ACM certificate removes the Amazon S3 object that contains the certificate, certificate chain, and encrypted private key from the Amazon S3 bucket. It also revokes the IAM role's permission to use the KMS key used to encrypt the private key. This effectively revokes the role's permission to use the certificate. | diff --git a/docs/aws-docs/providers/aws/ec2_api/export_image_tasks/index.md b/docs/aws-docs/providers/aws/ec2_api/export_image_tasks/index.md new file mode 100644 index 0000000000..321f646dc5 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/export_image_tasks/index.md @@ -0,0 +1,41 @@ +--- +title: export_image_tasks +hide_title: false +hide_table_of_contents: false +keywords: + - export_image_tasks + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameexport_image_tasks
TypeResource
Idaws.ec2_api.export_image_tasks
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `description` | `string` | A description of the image being exported. | +| `exportImageTaskId` | `string` | The ID of the export image task. | +| `imageId` | `string` | The ID of the image. | +| `progress` | `string` | The percent complete of the export image task. | +| `s3ExportLocation` | `object` | Describes the destination for an export image task. | +| `status` | `string` | The status of the export image task. The possible values are <code>active</code>, <code>completed</code>, <code>deleting</code>, and <code>deleted</code>. | +| `statusMessage` | `string` | The status message for the export image task. | +| `tagSet` | `array` | Any tags assigned to the export image task. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `export_image_tasks_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/export_tasks/index.md b/docs/aws-docs/providers/aws/ec2_api/export_tasks/index.md new file mode 100644 index 0000000000..0886966041 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/export_tasks/index.md @@ -0,0 +1,41 @@ +--- +title: export_tasks +hide_title: false +hide_table_of_contents: false +keywords: + - export_tasks + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameexport_tasks
TypeResource
Idaws.ec2_api.export_tasks
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `description` | `string` | A description of the resource being exported. | +| `exportTaskId` | `string` | The ID of the export task. | +| `exportToS3` | `object` | Describes the format and location for the export task. | +| `instanceExport` | `object` | Describes an instance to export. | +| `state` | `string` | The state of the export task. | +| `statusMessage` | `string` | The status message related to the export task. | +| `tagSet` | `array` | The tags for the export task. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `export_tasks_Describe` | `SELECT` | `region` | Describes the specified export instance tasks or all of your export instance tasks. | +| `export_task_Cancel` | `EXEC` | `ExportTaskId, region` | Cancels an active export task. The request removes all artifacts of the export, including any partially-created Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the command fails and returns an error. | diff --git a/docs/aws-docs/providers/aws/ec2_api/fast_launch/index.md b/docs/aws-docs/providers/aws/ec2_api/fast_launch/index.md new file mode 100644 index 0000000000..9e9697c818 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/fast_launch/index.md @@ -0,0 +1,33 @@ +--- +title: fast_launch +hide_title: false +hide_table_of_contents: false +keywords: + - fast_launch + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namefast_launch
TypeResource
Idaws.ec2_api.fast_launch
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `fast_launch_Disable` | `EXEC` | `ImageId, region` | <p>Discontinue faster launching for a Windows AMI, and clean up existing pre-provisioned snapshots. When you disable faster launching, the AMI uses the standard launch process for each instance. All pre-provisioned snapshots must be removed before you can enable faster launching again.</p> <note> <p>To change these settings, you must own the AMI.</p> </note> | +| `fast_launch_Enable` | `EXEC` | `ImageId, region` | <p>When you enable faster launching for a Windows AMI, images are pre-provisioned, using snapshots to launch instances up to 65% faster. To create the optimized Windows image, Amazon EC2 launches an instance and runs through Sysprep steps, rebooting as required. Then it creates a set of reserved snapshots that are used for subsequent launches. The reserved snapshots are automatically replenished as they are used, depending on your settings for launch frequency.</p> <note> <p>To change these settings, you must own the AMI.</p> </note> | diff --git a/docs/aws-docs/providers/aws/ec2_api/fast_launch_images/index.md b/docs/aws-docs/providers/aws/ec2_api/fast_launch_images/index.md new file mode 100644 index 0000000000..af88b7b0b5 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/fast_launch_images/index.md @@ -0,0 +1,42 @@ +--- +title: fast_launch_images +hide_title: false +hide_table_of_contents: false +keywords: + - fast_launch_images + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namefast_launch_images
TypeResource
Idaws.ec2_api.fast_launch_images
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `imageId` | `string` | The image ID that identifies the fast-launch enabled Windows image. | +| `launchTemplate` | `object` | Identifies the launch template to use for faster launching of the Windows AMI. | +| `maxParallelLaunches` | `integer` | The maximum number of parallel instances that are launched for creating resources. | +| `ownerId` | `string` | The owner ID for the fast-launch enabled Windows AMI. | +| `resourceType` | `string` | The resource type that is used for pre-provisioning the Windows AMI. Supported values include: <code>snapshot</code>. | +| `snapshotConfiguration` | `object` | Configuration settings for creating and managing pre-provisioned snapshots for a fast-launch enabled Windows AMI. | +| `state` | `string` | The current state of faster launching for the specified Windows AMI. | +| `stateTransitionReason` | `string` | The reason that faster launching for the Windows AMI changed to the current state. | +| `stateTransitionTime` | `string` | The time that faster launching for the Windows AMI changed to the current state. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `fast_launch_images_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/fast_snapshot_restores/index.md b/docs/aws-docs/providers/aws/ec2_api/fast_snapshot_restores/index.md new file mode 100644 index 0000000000..d71822c7e6 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/fast_snapshot_restores/index.md @@ -0,0 +1,46 @@ +--- +title: fast_snapshot_restores +hide_title: false +hide_table_of_contents: false +keywords: + - fast_snapshot_restores + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namefast_snapshot_restores
TypeResource
Idaws.ec2_api.fast_snapshot_restores
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `availabilityZone` | `string` | The Availability Zone. | +| `disabledTime` | `string` | The time at which fast snapshot restores entered the <code>disabled</code> state. | +| `disablingTime` | `string` | The time at which fast snapshot restores entered the <code>disabling</code> state. | +| `enabledTime` | `string` | The time at which fast snapshot restores entered the <code>enabled</code> state. | +| `enablingTime` | `string` | The time at which fast snapshot restores entered the <code>enabling</code> state. | +| `optimizingTime` | `string` | The time at which fast snapshot restores entered the <code>optimizing</code> state. | +| `ownerAlias` | `string` | The Amazon Web Services owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use. | +| `ownerId` | `string` | The ID of the Amazon Web Services account that enabled fast snapshot restores on the snapshot. | +| `snapshotId` | `string` | The ID of the snapshot. | +| `state` | `string` | The state of fast snapshot restores. | +| `stateTransitionReason` | `string` | <p>The reason for the state transition. The possible values are as follows:</p> <ul> <li> <p> <code>Client.UserInitiated</code> - The state successfully transitioned to <code>enabling</code> or <code>disabling</code>.</p> </li> <li> <p> <code>Client.UserInitiated - Lifecycle state transition</code> - The state successfully transitioned to <code>optimizing</code>, <code>enabled</code>, or <code>disabled</code>.</p> </li> </ul> | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `fast_snapshot_restores_Describe` | `SELECT` | `region` | Describes the state of fast snapshot restores for your snapshots. | +| `fast_snapshot_restores_Disable` | `EXEC` | `AvailabilityZone, SourceSnapshotId, region` | Disables fast snapshot restores for the specified snapshots in the specified Availability Zones. | +| `fast_snapshot_restores_Enable` | `EXEC` | `AvailabilityZone, SourceSnapshotId, region` | <p>Enables fast snapshot restores for the specified snapshots in the specified Availability Zones.</p> <p>You get the full benefit of fast snapshot restores after they enter the <code>enabled</code> state. To get the current state of fast snapshot restores, use <a>DescribeFastSnapshotRestores</a>. To disable fast snapshot restores, use <a>DisableFastSnapshotRestores</a>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-fast-snapshot-restore.html">Amazon EBS fast snapshot restore</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/fleet_history/index.md b/docs/aws-docs/providers/aws/ec2_api/fleet_history/index.md new file mode 100644 index 0000000000..cead7788ac --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/fleet_history/index.md @@ -0,0 +1,38 @@ +--- +title: fleet_history +hide_title: false +hide_table_of_contents: false +keywords: + - fleet_history + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namefleet_history
TypeResource
Idaws.ec2_api.fleet_history
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `fleetId` | `string` | The ID of the EC Fleet. | +| `historyRecordSet` | `array` | Information about the events in the history of the EC2 Fleet. | +| `lastEvaluatedTime` | `string` | <p>The last date and time for the events, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z). All records up to this time were retrieved.</p> <p>If <code>nextToken</code> indicates that there are more results, this value is not present.</p> | +| `nextToken` | `string` | The token for the next set of results. | +| `startTime` | `string` | The start date and time for the events, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z). | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `fleet_history_Describe` | `SELECT` | `FleetId, StartTime, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/fleet_instances/index.md b/docs/aws-docs/providers/aws/ec2_api/fleet_instances/index.md new file mode 100644 index 0000000000..4afc154fa5 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/fleet_instances/index.md @@ -0,0 +1,37 @@ +--- +title: fleet_instances +hide_title: false +hide_table_of_contents: false +keywords: + - fleet_instances + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namefleet_instances
TypeResource
Idaws.ec2_api.fleet_instances
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `instanceHealth` | `string` | The health status of the instance. If the status of either the instance status check or the system status check is <code>impaired</code>, the health status of the instance is <code>unhealthy</code>. Otherwise, the health status is <code>healthy</code>. | +| `instanceId` | `string` | The ID of the instance. | +| `instanceType` | `string` | The instance type. | +| `spotInstanceRequestId` | `string` | The ID of the Spot Instance request. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `fleet_instances_Describe` | `SELECT` | `FleetId, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/fleets/index.md b/docs/aws-docs/providers/aws/ec2_api/fleets/index.md new file mode 100644 index 0000000000..de0412e450 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/fleets/index.md @@ -0,0 +1,57 @@ +--- +title: fleets +hide_title: false +hide_table_of_contents: false +keywords: + - fleets + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namefleets
TypeResource
Idaws.ec2_api.fleets
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `activityStatus` | `string` | The progress of the EC2 Fleet. If there is an error, the status is <code>error</code>. After all requests are placed, the status is <code>pending_fulfillment</code>. If the size of the EC2 Fleet is equal to or greater than its target capacity, the status is <code>fulfilled</code>. If the size of the EC2 Fleet is decreased, the status is <code>pending_termination</code> while instances are terminating. | +| `clientToken` | `string` | <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p> <p>Constraints: Maximum 64 ASCII characters</p> | +| `context` | `string` | Reserved. | +| `createTime` | `string` | The creation date and time of the EC2 Fleet. | +| `errorSet` | `array` | Information about the instances that could not be launched by the fleet. Valid only when <b>Type</b> is set to <code>instant</code>. | +| `excessCapacityTerminationPolicy` | `string` | Indicates whether running instances should be terminated if the target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet. | +| `fleetId` | `string` | The ID of the EC2 Fleet. | +| `fleetInstanceSet` | `array` | Information about the instances that were launched by the fleet. Valid only when <b>Type</b> is set to <code>instant</code>. | +| `fleetState` | `string` | The state of the EC2 Fleet. | +| `fulfilledCapacity` | `number` | The number of units fulfilled by this request compared to the set target capacity. | +| `fulfilledOnDemandCapacity` | `number` | The number of units fulfilled by this request compared to the set target On-Demand capacity. | +| `launchTemplateConfigs` | `array` | The launch template and overrides. | +| `onDemandOptions` | `object` | Describes the configuration of On-Demand Instances in an EC2 Fleet. | +| `replaceUnhealthyInstances` | `boolean` | Indicates whether EC2 Fleet should replace unhealthy Spot Instances. Supported only for fleets of type <code>maintain</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#ec2-fleet-health-checks">EC2 Fleet health checks</a> in the <i>Amazon EC2 User Guide</i>. | +| `spotOptions` | `object` | Describes the configuration of Spot Instances in an EC2 Fleet. | +| `tagSet` | `array` | The tags for an EC2 Fleet resource. | +| `targetCapacitySpecification` | `object` | <p>The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is <code>maintain</code>, you can specify a target capacity of 0 and add capacity later.</p> <p>You can use the On-Demand Instance <code>MaxTotalPrice</code> parameter, the Spot Instance <code>MaxTotalPrice</code>, or both to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, EC2 Fleet will launch instances until it reaches the maximum amount that you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity. The <code>MaxTotalPrice</code> parameters are located in <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_OnDemandOptions.html">OnDemandOptions</a> and <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotOptions">SpotOptions</a>.</p> | +| `terminateInstancesWithExpiration` | `boolean` | Indicates whether running instances should be terminated when the EC2 Fleet expires. | +| `type` | `string` | The type of request. Indicates whether the EC2 Fleet only <code>requests</code> the target capacity, or also attempts to <code>maintain</code> it. If you request a certain target capacity, EC2 Fleet only places the required requests; it does not attempt to replenish instances if capacity is diminished, and it does not submit requests in alternative capacity pools if capacity is unavailable. To maintain a certain target capacity, EC2 Fleet places the required requests to meet this target capacity. It also automatically replenishes any interrupted Spot Instances. Default: <code>maintain</code>. | +| `validFrom` | `string` | The start date and time of the request, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z). The default is to start fulfilling the request immediately. | +| `validUntil` | `string` | The end date and time of the request, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z). At this point, no new instance requests are placed or able to fulfill the request. The default end date is 7 days from the current date. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `fleets_Describe` | `SELECT` | `region` | <p>Describes the specified EC2 Fleets or all of your EC2 Fleets.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#monitor-ec2-fleet">Monitor your EC2 Fleet</a> in the <i>Amazon EC2 User Guide</i>.</p> | +| `fleet_Create` | `INSERT` | `LaunchTemplateConfigs, TargetCapacitySpecification, region` | <p>Launches an EC2 Fleet.</p> <p>You can create a single EC2 Fleet that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet.html">EC2 Fleet</a> in the <i>Amazon EC2 User Guide</i>.</p> | +| `fleets_Delete` | `DELETE` | `FleetId, TerminateInstances, region` | <p>Deletes the specified EC2 Fleet.</p> <p>After you delete an EC2 Fleet, it launches no new instances.</p> <p>You must specify whether a deleted EC2 Fleet should also terminate its instances. If you choose to terminate the instances, the EC2 Fleet enters the <code>deleted_terminating</code> state. Otherwise, the EC2 Fleet enters the <code>deleted_running</code> state, and the instances continue to run until they are interrupted or you terminate them manually.</p> <p>For <code>instant</code> fleets, EC2 Fleet must terminate the instances when the fleet is deleted. A deleted <code>instant</code> fleet with running instances is not supported.</p> <p class="title"> <b>Restrictions</b> </p> <ul> <li> <p>You can delete up to 25 <code>instant</code> fleets in a single request. If you exceed this number, no <code>instant</code> fleets are deleted and an error is returned. There is no restriction on the number of fleets of type <code>maintain</code> or <code>request</code> that can be deleted in a single request.</p> </li> <li> <p>Up to 1000 instances can be terminated in a single request to delete <code>instant</code> fleets.</p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#delete-fleet">Delete an EC2 Fleet</a> in the <i>Amazon EC2 User Guide</i>.</p> | +| `fleet_Modify` | `EXEC` | `FleetId, region` | <p>Modifies the specified EC2 Fleet.</p> <p>You can only modify an EC2 Fleet request of type <code>maintain</code>.</p> <p>While the EC2 Fleet is being modified, it is in the <code>modifying</code> state.</p> <p>To scale up your EC2 Fleet, increase its target capacity. The EC2 Fleet launches the additional Spot Instances according to the allocation strategy for the EC2 Fleet request. If the allocation strategy is <code>lowest-price</code>, the EC2 Fleet launches instances using the Spot Instance pool with the lowest price. If the allocation strategy is <code>diversified</code>, the EC2 Fleet distributes the instances across the Spot Instance pools. If the allocation strategy is <code>capacity-optimized</code>, EC2 Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.</p> <p>To scale down your EC2 Fleet, decrease its target capacity. First, the EC2 Fleet cancels any open requests that exceed the new target capacity. You can request that the EC2 Fleet terminate Spot Instances until the size of the fleet no longer exceeds the new target capacity. If the allocation strategy is <code>lowest-price</code>, the EC2 Fleet terminates the instances with the highest price per unit. If the allocation strategy is <code>capacity-optimized</code>, the EC2 Fleet terminates the instances in the Spot Instance pools that have the least available Spot Instance capacity. If the allocation strategy is <code>diversified</code>, the EC2 Fleet terminates instances across the Spot Instance pools. Alternatively, you can request that the EC2 Fleet keep the fleet at its current size, but not replace any Spot Instances that are interrupted or that you terminate manually.</p> <p>If you are finished with your EC2 Fleet for now, but will use it again later, you can set the target capacity to 0.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/flow_logs/index.md b/docs/aws-docs/providers/aws/ec2_api/flow_logs/index.md new file mode 100644 index 0000000000..0b4e48f1a1 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/flow_logs/index.md @@ -0,0 +1,50 @@ +--- +title: flow_logs +hide_title: false +hide_table_of_contents: false +keywords: + - flow_logs + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameflow_logs
TypeResource
Idaws.ec2_api.flow_logs
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `creationTime` | `string` | The date and time the flow log was created. | +| `deliverLogsErrorMessage` | `string` | Information about the error that occurred. <code>Rate limited</code> indicates that CloudWatch Logs throttling has been applied for one or more network interfaces, or that you've reached the limit on the number of log groups that you can create. <code>Access error</code> indicates that the IAM role associated with the flow log does not have sufficient permissions to publish to CloudWatch Logs. <code>Unknown error</code> indicates an internal error. | +| `deliverLogsPermissionArn` | `string` | The ARN of the IAM role that posts logs to CloudWatch Logs. | +| `deliverLogsStatus` | `string` | The status of the logs delivery (<code>SUCCESS</code> \| <code>FAILED</code>). | +| `destinationOptions` | `object` | Describes the destination options for a flow log. | +| `flowLogId` | `string` | The flow log ID. | +| `flowLogStatus` | `string` | The status of the flow log (<code>ACTIVE</code>). | +| `logDestination` | `string` | The destination to which the flow log data is published. Flow log data can be published to an CloudWatch Logs log group or an Amazon S3 bucket. If the flow log publishes to CloudWatch Logs, this element indicates the Amazon Resource Name (ARN) of the CloudWatch Logs log group to which the data is published. If the flow log publishes to Amazon S3, this element indicates the ARN of the Amazon S3 bucket to which the data is published. | +| `logDestinationType` | `string` | The type of destination to which the flow log data is published. Flow log data can be published to CloudWatch Logs or Amazon S3. | +| `logFormat` | `string` | The format of the flow log record. | +| `logGroupName` | `string` | The name of the flow log group. | +| `maxAggregationInterval` | `integer` | <p>The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record.</p> <p>When a network interface is attached to a <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances">Nitro-based instance</a>, the aggregation interval is always 60 seconds (1 minute) or less, regardless of the specified value.</p> <p>Valid Values: <code>60</code> \| <code>600</code> </p> | +| `resourceId` | `string` | The ID of the resource on which the flow log was created. | +| `tagSet` | `array` | The tags for the flow log. | +| `trafficType` | `string` | The type of traffic captured for the flow log. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `flow_logs_Describe` | `SELECT` | `region` | Describes one or more flow logs. To view the information in your flow logs (the log streams for the network interfaces), you must use the CloudWatch Logs console or the CloudWatch Logs API. | +| `flow_logs_Create` | `INSERT` | `ResourceId, ResourceType, TrafficType, region` | <p>Creates one or more flow logs to capture information about IP traffic for a specific network interface, subnet, or VPC. </p> <p>Flow log data for a monitored network interface is recorded as flow log records, which are log events consisting of fields that describe the traffic flow. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html#flow-log-records">Flow log records</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p> <p>When publishing to CloudWatch Logs, flow log records are published to a log group, and each network interface has a unique log stream in the log group. When publishing to Amazon S3, flow log records for all of the monitored network interfaces are published to a single log file object that is stored in the specified bucket.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html">VPC Flow Logs</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p> | +| `flow_logs_Delete` | `DELETE` | `FlowLogId, region` | Deletes one or more flow logs. | diff --git a/docs/aws-docs/providers/aws/ec2_api/flow_logs_integration_template/index.md b/docs/aws-docs/providers/aws/ec2_api/flow_logs_integration_template/index.md new file mode 100644 index 0000000000..297482783a --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/flow_logs_integration_template/index.md @@ -0,0 +1,31 @@ +--- +title: flow_logs_integration_template +hide_title: false +hide_table_of_contents: false +keywords: + - flow_logs_integration_template + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameflow_logs_integration_template
TypeResource
Idaws.ec2_api.flow_logs_integration_template
+ +## Fields +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `flow_logs_integration_template_Get` | `SELECT` | `ConfigDeliveryS3DestinationArn, FlowLogId, IntegrateService, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/fpga_image_attribute/index.md b/docs/aws-docs/providers/aws/ec2_api/fpga_image_attribute/index.md new file mode 100644 index 0000000000..44ee845db8 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/fpga_image_attribute/index.md @@ -0,0 +1,33 @@ +--- +title: fpga_image_attribute +hide_title: false +hide_table_of_contents: false +keywords: + - fpga_image_attribute + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namefpga_image_attribute
TypeResource
Idaws.ec2_api.fpga_image_attribute
+ +## Fields +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `fpga_image_attribute_Describe` | `SELECT` | `Attribute, FpgaImageId, region` | Describes the specified attribute of the specified Amazon FPGA Image (AFI). | +| `fpga_image_attribute_Modify` | `EXEC` | `FpgaImageId, region` | Modifies the specified attribute of the specified Amazon FPGA Image (AFI). | +| `fpga_image_attribute_Reset` | `EXEC` | `FpgaImageId, region` | Resets the specified attribute of the specified Amazon FPGA Image (AFI) to its default value. You can only reset the load permission attribute. | diff --git a/docs/aws-docs/providers/aws/ec2_api/fpga_images/index.md b/docs/aws-docs/providers/aws/ec2_api/fpga_images/index.md new file mode 100644 index 0000000000..3207fc49cf --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/fpga_images/index.md @@ -0,0 +1,51 @@ +--- +title: fpga_images +hide_title: false +hide_table_of_contents: false +keywords: + - fpga_images + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namefpga_images
TypeResource
Idaws.ec2_api.fpga_images
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | The name of the AFI. | +| `description` | `string` | The description of the AFI. | +| `createTime` | `string` | The date and time the AFI was created. | +| `dataRetentionSupport` | `boolean` | Indicates whether data retention support is enabled for the AFI. | +| `fpgaImageGlobalId` | `string` | The global FPGA image identifier (AGFI ID). | +| `fpgaImageId` | `string` | The FPGA image identifier (AFI ID). | +| `ownerAlias` | `string` | The alias of the AFI owner. Possible values include <code>self</code>, <code>amazon</code>, and <code>aws-marketplace</code>. | +| `ownerId` | `string` | The ID of the Amazon Web Services account that owns the AFI. | +| `pciId` | `object` | Describes the data that identifies an Amazon FPGA image (AFI) on the PCI bus. | +| `productCodes` | `array` | The product codes for the AFI. | +| `public` | `boolean` | Indicates whether the AFI is public. | +| `shellVersion` | `string` | The version of the Amazon Web Services Shell that was used to create the bitstream. | +| `state` | `object` | Describes the state of the bitstream generation process for an Amazon FPGA image (AFI). | +| `tags` | `array` | Any tags assigned to the AFI. | +| `updateTime` | `string` | The time of the most recent update to the AFI. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `fpga_images_Describe` | `SELECT` | `region` | Describes the Amazon FPGA Images (AFIs) available to you. These include public AFIs, private AFIs that you own, and AFIs owned by other Amazon Web Services accounts for which you have load permissions. | +| `fpga_image_Create` | `INSERT` | `InputStorageLocation, region` | <p>Creates an Amazon FPGA Image (AFI) from the specified design checkpoint (DCP).</p> <p>The create operation is asynchronous. To verify that the AFI is ready for use, check the output logs.</p> <p>An AFI contains the FPGA bitstream that is ready to download to an FPGA. You can securely deploy an AFI on multiple FPGA-accelerated instances. For more information, see the <a href="https://github.com/aws/aws-fpga/">Amazon Web Services FPGA Hardware Development Kit</a>.</p> | +| `fpga_image_Delete` | `DELETE` | `FpgaImageId, region` | Deletes the specified Amazon FPGA Image (AFI). | +| `fpga_image_Copy` | `EXEC` | `SourceFpgaImageId, SourceRegion, region` | Copies the specified Amazon FPGA Image (AFI) to the current Region. | diff --git a/docs/aws-docs/providers/aws/ec2_api/groups_for_capacity_reservation/index.md b/docs/aws-docs/providers/aws/ec2_api/groups_for_capacity_reservation/index.md new file mode 100644 index 0000000000..0bda249dc7 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/groups_for_capacity_reservation/index.md @@ -0,0 +1,35 @@ +--- +title: groups_for_capacity_reservation +hide_title: false +hide_table_of_contents: false +keywords: + - groups_for_capacity_reservation + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namegroups_for_capacity_reservation
TypeResource
Idaws.ec2_api.groups_for_capacity_reservation
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `groupArn` | `string` | The ARN of the resource group. | +| `ownerId` | `string` | The ID of the Amazon Web Services account that owns the resource group. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `groups_for_capacity_reservation_Get` | `SELECT` | `CapacityReservationId, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/host_reservation_offerings/index.md b/docs/aws-docs/providers/aws/ec2_api/host_reservation_offerings/index.md new file mode 100644 index 0000000000..f60e2dff28 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/host_reservation_offerings/index.md @@ -0,0 +1,40 @@ +--- +title: host_reservation_offerings +hide_title: false +hide_table_of_contents: false +keywords: + - host_reservation_offerings + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namehost_reservation_offerings
TypeResource
Idaws.ec2_api.host_reservation_offerings
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `currencyCode` | `string` | The currency of the offering. | +| `duration` | `integer` | The duration of the offering (in seconds). | +| `hourlyPrice` | `string` | The hourly price of the offering. | +| `instanceFamily` | `string` | The instance family of the offering. | +| `offeringId` | `string` | The ID of the offering. | +| `paymentOption` | `string` | The available payment option. | +| `upfrontPrice` | `string` | The upfront price of the offering. Does not apply to No Upfront offerings. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `host_reservation_offerings_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/host_reservation_purchase_preview/index.md b/docs/aws-docs/providers/aws/ec2_api/host_reservation_purchase_preview/index.md new file mode 100644 index 0000000000..a8ae0f07e4 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/host_reservation_purchase_preview/index.md @@ -0,0 +1,37 @@ +--- +title: host_reservation_purchase_preview +hide_title: false +hide_table_of_contents: false +keywords: + - host_reservation_purchase_preview + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namehost_reservation_purchase_preview
TypeResource
Idaws.ec2_api.host_reservation_purchase_preview
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `currencyCode` | `string` | The currency in which the <code>totalUpfrontPrice</code> and <code>totalHourlyPrice</code> amounts are specified. At this time, the only supported currency is <code>USD</code>. | +| `purchase` | `array` | The purchase information of the Dedicated Host reservation and the Dedicated Hosts associated with it. | +| `totalHourlyPrice` | `string` | The potential total hourly price of the reservation per hour. | +| `totalUpfrontPrice` | `string` | The potential total upfront price. This is billed immediately. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `host_reservation_purchase_preview_Get` | `SELECT` | `HostIdSet, OfferingId, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/host_reservations/index.md b/docs/aws-docs/providers/aws/ec2_api/host_reservations/index.md new file mode 100644 index 0000000000..b88394293b --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/host_reservations/index.md @@ -0,0 +1,48 @@ +--- +title: host_reservations +hide_title: false +hide_table_of_contents: false +keywords: + - host_reservations + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namehost_reservations
TypeResource
Idaws.ec2_api.host_reservations
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `count` | `integer` | The number of Dedicated Hosts the reservation is associated with. | +| `currencyCode` | `string` | The currency in which the <code>upfrontPrice</code> and <code>hourlyPrice</code> amounts are specified. At this time, the only supported currency is <code>USD</code>. | +| `duration` | `integer` | The length of the reservation's term, specified in seconds. Can be <code>31536000 (1 year)</code> \| <code>94608000 (3 years)</code>. | +| `end` | `string` | The date and time that the reservation ends. | +| `hostIdSet` | `array` | The IDs of the Dedicated Hosts associated with the reservation. | +| `hostReservationId` | `string` | The ID of the reservation that specifies the associated Dedicated Hosts. | +| `hourlyPrice` | `string` | The hourly price of the reservation. | +| `instanceFamily` | `string` | The instance family of the Dedicated Host Reservation. The instance family on the Dedicated Host must be the same in order for it to benefit from the reservation. | +| `offeringId` | `string` | The ID of the reservation. This remains the same regardless of which Dedicated Hosts are associated with it. | +| `paymentOption` | `string` | The payment option selected for this reservation. | +| `start` | `string` | The date and time that the reservation started. | +| `state` | `string` | The state of the reservation. | +| `tagSet` | `array` | Any tags assigned to the Dedicated Host Reservation. | +| `upfrontPrice` | `string` | The upfront price of the reservation. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `host_reservations_Describe` | `SELECT` | `region` | Describes reservations that are associated with Dedicated Hosts in your account. | +| `host_reservation_Purchase` | `EXEC` | `HostIdSet, OfferingId, region` | Purchase a reservation with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation. This action results in the specified reservation being purchased and charged to your account. | diff --git a/docs/aws-docs/providers/aws/ec2_api/hosts/index.md b/docs/aws-docs/providers/aws/ec2_api/hosts/index.md new file mode 100644 index 0000000000..80f659d800 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/hosts/index.md @@ -0,0 +1,54 @@ +--- +title: hosts +hide_title: false +hide_table_of_contents: false +keywords: + - hosts + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namehosts
TypeResource
Idaws.ec2_api.hosts
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `allocationTime` | `string` | The time that the Dedicated Host was allocated. | +| `allowsMultipleInstanceTypes` | `string` | Indicates whether the Dedicated Host supports multiple instance types of the same instance family. If the value is <code>on</code>, the Dedicated Host supports multiple instance types in the instance family. If the value is <code>off</code>, the Dedicated Host supports a single instance type only. | +| `autoPlacement` | `string` | Whether auto-placement is on or off. | +| `availabilityZone` | `string` | The Availability Zone of the Dedicated Host. | +| `availabilityZoneId` | `string` | The ID of the Availability Zone in which the Dedicated Host is allocated. | +| `availableCapacity` | `object` | The capacity information for instances that can be launched onto the Dedicated Host. | +| `clientToken` | `string` | Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring Idempotency</a>. | +| `hostId` | `string` | The ID of the Dedicated Host. | +| `hostProperties` | `object` | Describes the properties of a Dedicated Host. | +| `hostRecovery` | `string` | Indicates whether host recovery is enabled or disabled for the Dedicated Host. | +| `hostReservationId` | `string` | The reservation ID of the Dedicated Host. This returns a <code>null</code> response if the Dedicated Host doesn't have an associated reservation. | +| `instances` | `array` | The IDs and instance type that are currently running on the Dedicated Host. | +| `memberOfServiceLinkedResourceGroup` | `boolean` | Indicates whether the Dedicated Host is in a host resource group. If <b>memberOfServiceLinkedResourceGroup</b> is <code>true</code>, the host is in a host resource group; otherwise, it is not. | +| `outpostArn` | `string` | The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which the Dedicated Host is allocated. | +| `ownerId` | `string` | The ID of the Amazon Web Services account that owns the Dedicated Host. | +| `releaseTime` | `string` | The time that the Dedicated Host was released. | +| `state` | `string` | The Dedicated Host's state. | +| `tagSet` | `array` | Any tags assigned to the Dedicated Host. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `hosts_Describe` | `SELECT` | `region` | <p>Describes the specified Dedicated Hosts or all your Dedicated Hosts.</p> <p>The results describe only the Dedicated Hosts in the Region you're currently using. All listed instances consume capacity on your Dedicated Host. Dedicated Hosts that have recently been released are listed with the state <code>released</code>.</p> | +| `hosts_Allocate` | `EXEC` | `AvailabilityZone, Quantity, region` | Allocates a Dedicated Host to your account. At a minimum, specify the supported instance type or instance family, the Availability Zone in which to allocate the host, and the number of hosts to allocate. | +| `hosts_Modify` | `EXEC` | `HostId, region` | <p>Modify the auto-placement setting of a Dedicated Host. When auto-placement is enabled, any instances that you launch with a tenancy of <code>host</code> but without a specific host ID are placed onto any available Dedicated Host in your account that has auto-placement enabled. When auto-placement is disabled, you need to provide a host ID to have the instance launch onto a specific host. If no host ID is provided, the instance is launched onto a suitable host with auto-placement enabled.</p> <p>You can also use this API action to modify a Dedicated Host to support either multiple instance types in an instance family, or to support a specific instance type only.</p> | +| `hosts_Release` | `EXEC` | `HostId, region` | <p>When you no longer want to use an On-Demand Dedicated Host it can be released. On-Demand billing is stopped and the host goes into <code>released</code> state. The host ID of Dedicated Hosts that have been released can no longer be specified in another request, for example, to modify the host. You must stop or terminate all instances on a host before it can be released.</p> <p>When Dedicated Hosts are released, it may take some time for them to stop counting toward your limit and you may receive capacity errors when trying to allocate new Dedicated Hosts. Wait a few minutes and then try again.</p> <p>Released hosts still appear in a <a>DescribeHosts</a> response.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/iam_instance_profile/index.md b/docs/aws-docs/providers/aws/ec2_api/iam_instance_profile/index.md new file mode 100644 index 0000000000..08bf572815 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/iam_instance_profile/index.md @@ -0,0 +1,33 @@ +--- +title: iam_instance_profile +hide_title: false +hide_table_of_contents: false +keywords: + - iam_instance_profile + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameiam_instance_profile
TypeResource
Idaws.ec2_api.iam_instance_profile
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `iam_instance_profile_Associate` | `EXEC` | `IamInstanceProfile, InstanceId, region` | Associates an IAM instance profile with a running or stopped instance. You cannot associate more than one IAM instance profile with an instance. | +| `iam_instance_profile_Disassociate` | `EXEC` | `AssociationId, region` | <p>Disassociates an IAM instance profile from a running or stopped instance.</p> <p>Use <a>DescribeIamInstanceProfileAssociations</a> to get the association ID.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/iam_instance_profile_associations/index.md b/docs/aws-docs/providers/aws/ec2_api/iam_instance_profile_associations/index.md new file mode 100644 index 0000000000..670e24e8f7 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/iam_instance_profile_associations/index.md @@ -0,0 +1,39 @@ +--- +title: iam_instance_profile_associations +hide_title: false +hide_table_of_contents: false +keywords: + - iam_instance_profile_associations + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameiam_instance_profile_associations
TypeResource
Idaws.ec2_api.iam_instance_profile_associations
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `associationId` | `string` | The ID of the association. | +| `iamInstanceProfile` | `object` | Describes an IAM instance profile. | +| `instanceId` | `string` | The ID of the instance. | +| `state` | `string` | The state of the association. | +| `timestamp` | `string` | The time the IAM instance profile was associated with the instance. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `iam_instance_profile_associations_Describe` | `SELECT` | `region` | Describes your IAM instance profile associations. | +| `iam_instance_profile_association_Replace` | `EXEC` | `AssociationId, IamInstanceProfile, region` | <p>Replaces an IAM instance profile for the specified running instance. You can use this action to change the IAM instance profile that's associated with an instance without having to disassociate the existing IAM instance profile first.</p> <p>Use <a>DescribeIamInstanceProfileAssociations</a> to get the association ID.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/id_format/index.md b/docs/aws-docs/providers/aws/ec2_api/id_format/index.md new file mode 100644 index 0000000000..0b9cf655e8 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/id_format/index.md @@ -0,0 +1,37 @@ +--- +title: id_format +hide_title: false +hide_table_of_contents: false +keywords: + - id_format + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameid_format
TypeResource
Idaws.ec2_api.id_format
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `deadline` | `string` | The date in UTC at which you are permanently switched over to using longer IDs. If a deadline is not yet available for this resource type, this field is not returned. | +| `resource` | `string` | The type of resource. | +| `useLongIds` | `boolean` | Indicates whether longer IDs (17-character IDs) are enabled for the resource. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `id_format_Describe` | `SELECT` | `region` | <p>Describes the ID format settings for your resources on a per-Region basis, for example, to view which resource types are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types.</p> <p>The following resource types support longer IDs: <code>bundle</code> \| <code>conversion-task</code> \| <code>customer-gateway</code> \| <code>dhcp-options</code> \| <code>elastic-ip-allocation</code> \| <code>elastic-ip-association</code> \| <code>export-task</code> \| <code>flow-log</code> \| <code>image</code> \| <code>import-task</code> \| <code>instance</code> \| <code>internet-gateway</code> \| <code>network-acl</code> \| <code>network-acl-association</code> \| <code>network-interface</code> \| <code>network-interface-attachment</code> \| <code>prefix-list</code> \| <code>reservation</code> \| <code>route-table</code> \| <code>route-table-association</code> \| <code>security-group</code> \| <code>snapshot</code> \| <code>subnet</code> \| <code>subnet-cidr-block-association</code> \| <code>volume</code> \| <code>vpc</code> \| <code>vpc-cidr-block-association</code> \| <code>vpc-endpoint</code> \| <code>vpc-peering-connection</code> \| <code>vpn-connection</code> \| <code>vpn-gateway</code>. </p> <p>These settings apply to the IAM user who makes the request; they do not apply to the entire Amazon Web Services account. By default, an IAM user defaults to the same settings as the root user, unless they explicitly override the settings by running the <a>ModifyIdFormat</a> command. Resources created with longer IDs are visible to all IAM users, regardless of these settings and provided that they have permission to use the relevant <code>Describe</code> command for the resource type.</p> | +| `id_format_Modify` | `EXEC` | `Resource, UseLongIds, region` | <p>Modifies the ID format for the specified resource on a per-Region basis. You can specify that resources should receive longer IDs (17-character IDs) when they are created.</p> <p>This request can only be used to modify longer ID settings for resource types that are within the opt-in period. Resources currently in their opt-in period include: <code>bundle</code> \| <code>conversion-task</code> \| <code>customer-gateway</code> \| <code>dhcp-options</code> \| <code>elastic-ip-allocation</code> \| <code>elastic-ip-association</code> \| <code>export-task</code> \| <code>flow-log</code> \| <code>image</code> \| <code>import-task</code> \| <code>internet-gateway</code> \| <code>network-acl</code> \| <code>network-acl-association</code> \| <code>network-interface</code> \| <code>network-interface-attachment</code> \| <code>prefix-list</code> \| <code>route-table</code> \| <code>route-table-association</code> \| <code>security-group</code> \| <code>subnet</code> \| <code>subnet-cidr-block-association</code> \| <code>vpc</code> \| <code>vpc-cidr-block-association</code> \| <code>vpc-endpoint</code> \| <code>vpc-peering-connection</code> \| <code>vpn-connection</code> \| <code>vpn-gateway</code>.</p> <p>This setting applies to the IAM user who makes the request; it does not apply to the entire Amazon Web Services account. By default, an IAM user defaults to the same settings as the root user. If you're using this action as the root user, then these settings apply to the entire account, unless an IAM user explicitly overrides these settings for themselves. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/resource-ids.html">Resource IDs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant <code>Describe</code> command for the resource type.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/identity_id_format/index.md b/docs/aws-docs/providers/aws/ec2_api/identity_id_format/index.md new file mode 100644 index 0000000000..c7ac2cb22b --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/identity_id_format/index.md @@ -0,0 +1,37 @@ +--- +title: identity_id_format +hide_title: false +hide_table_of_contents: false +keywords: + - identity_id_format + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameidentity_id_format
TypeResource
Idaws.ec2_api.identity_id_format
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `deadline` | `string` | The date in UTC at which you are permanently switched over to using longer IDs. If a deadline is not yet available for this resource type, this field is not returned. | +| `resource` | `string` | The type of resource. | +| `useLongIds` | `boolean` | Indicates whether longer IDs (17-character IDs) are enabled for the resource. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `identity_id_format_Describe` | `SELECT` | `PrincipalArn, region` | <p>Describes the ID format settings for resources for the specified IAM user, IAM role, or root user. For example, you can view the resource types that are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/resource-ids.html">Resource IDs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </p> <p>The following resource types support longer IDs: <code>bundle</code> \| <code>conversion-task</code> \| <code>customer-gateway</code> \| <code>dhcp-options</code> \| <code>elastic-ip-allocation</code> \| <code>elastic-ip-association</code> \| <code>export-task</code> \| <code>flow-log</code> \| <code>image</code> \| <code>import-task</code> \| <code>instance</code> \| <code>internet-gateway</code> \| <code>network-acl</code> \| <code>network-acl-association</code> \| <code>network-interface</code> \| <code>network-interface-attachment</code> \| <code>prefix-list</code> \| <code>reservation</code> \| <code>route-table</code> \| <code>route-table-association</code> \| <code>security-group</code> \| <code>snapshot</code> \| <code>subnet</code> \| <code>subnet-cidr-block-association</code> \| <code>volume</code> \| <code>vpc</code> \| <code>vpc-cidr-block-association</code> \| <code>vpc-endpoint</code> \| <code>vpc-peering-connection</code> \| <code>vpn-connection</code> \| <code>vpn-gateway</code>. </p> <p>These settings apply to the principal specified in the request. They do not apply to the principal that makes the request.</p> | +| `identity_id_format_Modify` | `EXEC` | `PrincipalArn, Resource, UseLongIds, region` | <p>Modifies the ID format of a resource for a specified IAM user, IAM role, or the root user for an account; or all IAM users, IAM roles, and the root user for an account. You can specify that resources should receive longer IDs (17-character IDs) when they are created. </p> <p>This request can only be used to modify longer ID settings for resource types that are within the opt-in period. Resources currently in their opt-in period include: <code>bundle</code> \| <code>conversion-task</code> \| <code>customer-gateway</code> \| <code>dhcp-options</code> \| <code>elastic-ip-allocation</code> \| <code>elastic-ip-association</code> \| <code>export-task</code> \| <code>flow-log</code> \| <code>image</code> \| <code>import-task</code> \| <code>internet-gateway</code> \| <code>network-acl</code> \| <code>network-acl-association</code> \| <code>network-interface</code> \| <code>network-interface-attachment</code> \| <code>prefix-list</code> \| <code>route-table</code> \| <code>route-table-association</code> \| <code>security-group</code> \| <code>subnet</code> \| <code>subnet-cidr-block-association</code> \| <code>vpc</code> \| <code>vpc-cidr-block-association</code> \| <code>vpc-endpoint</code> \| <code>vpc-peering-connection</code> \| <code>vpn-connection</code> \| <code>vpn-gateway</code>. </p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/resource-ids.html">Resource IDs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </p> <p>This setting applies to the principal specified in the request; it does not apply to the principal that makes the request. </p> <p>Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant <code>Describe</code> command for the resource type.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/image_attribute/index.md b/docs/aws-docs/providers/aws/ec2_api/image_attribute/index.md new file mode 100644 index 0000000000..54f445c6fe --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/image_attribute/index.md @@ -0,0 +1,47 @@ +--- +title: image_attribute +hide_title: false +hide_table_of_contents: false +keywords: + - image_attribute + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameimage_attribute
TypeResource
Idaws.ec2_api.image_attribute
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `description` | `object` | Describes a value for a resource attribute that is a String. | +| `blockDeviceMapping` | `array` | The block device mapping entries. | +| `bootMode` | `object` | Describes a value for a resource attribute that is a String. | +| `imageId` | `string` | The ID of the AMI. | +| `kernel` | `object` | Describes a value for a resource attribute that is a String. | +| `lastLaunchedTime` | `object` | Describes a value for a resource attribute that is a String. | +| `launchPermission` | `array` | The launch permissions. | +| `productCodes` | `array` | The product codes. | +| `ramdisk` | `object` | Describes a value for a resource attribute that is a String. | +| `sriovNetSupport` | `object` | Describes a value for a resource attribute that is a String. | +| `tpmSupport` | `object` | Describes a value for a resource attribute that is a String. | +| `uefiData` | `object` | Describes a value for a resource attribute that is a String. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `image_attribute_Describe` | `SELECT` | `Attribute, ImageId, region` | Describes the specified attribute of the specified AMI. You can specify only one attribute at a time. | +| `image_attribute_Modify` | `EXEC` | `ImageId, region` | <p>Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time. You can use the <code>Attribute</code> parameter to specify the attribute or one of the following parameters: <code>Description</code> or <code>LaunchPermission</code>.</p> <p>Images with an Amazon Web Services Marketplace product code cannot be made public.</p> <p>To enable the SriovNetSupport enhanced networking attribute of an image, enable SriovNetSupport on an instance and create an AMI from the instance.</p> | +| `image_attribute_Reset` | `EXEC` | `Attribute, ImageId, region` | Resets an attribute of an AMI to its default value. | diff --git a/docs/aws-docs/providers/aws/ec2_api/image_deprecation/index.md b/docs/aws-docs/providers/aws/ec2_api/image_deprecation/index.md new file mode 100644 index 0000000000..2050ae7c9b --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/image_deprecation/index.md @@ -0,0 +1,33 @@ +--- +title: image_deprecation +hide_title: false +hide_table_of_contents: false +keywords: + - image_deprecation + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameimage_deprecation
TypeResource
Idaws.ec2_api.image_deprecation
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `image_deprecation_Disable` | `EXEC` | `ImageId, region` | <p>Cancels the deprecation of the specified AMI.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-deprecate.html">Deprecate an AMI</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | +| `image_deprecation_Enable` | `EXEC` | `DeprecateAt, ImageId, region` | <p>Enables deprecation of the specified AMI at the specified date and time.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-deprecate.html">Deprecate an AMI</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/image_from_recycle_bin/index.md b/docs/aws-docs/providers/aws/ec2_api/image_from_recycle_bin/index.md new file mode 100644 index 0000000000..f575759dec --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/image_from_recycle_bin/index.md @@ -0,0 +1,32 @@ +--- +title: image_from_recycle_bin +hide_title: false +hide_table_of_contents: false +keywords: + - image_from_recycle_bin + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameimage_from_recycle_bin
TypeResource
Idaws.ec2_api.image_from_recycle_bin
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `image_from_recycle_bin_Restore` | `EXEC` | `ImageId, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/images/index.md b/docs/aws-docs/providers/aws/ec2_api/images/index.md new file mode 100644 index 0000000000..cbe5e03e55 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/images/index.md @@ -0,0 +1,37 @@ +--- +title: images +hide_title: false +hide_table_of_contents: false +keywords: + - images + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameimages
TypeResource
Idaws.ec2_api.images
+ +## Fields +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `images_Describe` | `SELECT` | `region` | <p>Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you.</p> <p>The images available to you include public images, private images that you own, and private images owned by other Amazon Web Services accounts for which you have explicit launch permissions.</p> <p>Recently deregistered images appear in the returned results for a short interval and then return empty results. After all instances that reference a deregistered AMI are terminated, specifying the ID of the image will eventually return an error indicating that the AMI ID cannot be found.</p> | +| `image_Create` | `INSERT` | `InstanceId, Name, region` | <p>Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.</p> <p>By default, when Amazon EC2 creates the new AMI, it reboots the instance so that it can take snapshots of the attached volumes while data is at rest, in order to ensure a consistent state. You can set the <code>NoReboot</code> parameter to <code>true</code> in the API request, or use the <code>--no-reboot</code> option in the CLI to prevent Amazon EC2 from shutting down and rebooting the instance.</p> <important> <p>If you choose to bypass the shutdown and reboot process by setting the <code>NoReboot</code> parameter to <code>true</code> in the API request, or by using the <code>--no-reboot</code> option in the CLI, we can't guarantee the file system integrity of the created image.</p> </important> <p>If you customized your instance with instance store volumes or Amazon EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami-ebs.html">Creating Amazon EBS-Backed Linux AMIs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | +| `image_Copy` | `EXEC` | `Name, SourceImageId, SourceRegion, region` | <p>Initiates the copy of an AMI. You can copy an AMI from one Region to another, or from a Region to an Outpost. You can't copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost. To copy an AMI to another partition, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateStoreImageTask.html">CreateStoreImageTask</a>.</p> <p>To copy an AMI from one Region to another, specify the source Region using the <b>SourceRegion</b> parameter, and specify the destination Region using its endpoint. Copies of encrypted backing snapshots for the AMI are encrypted. Copies of unencrypted backing snapshots remain unencrypted, unless you set <code>Encrypted</code> during the copy operation. You cannot create an unencrypted copy of an encrypted backing snapshot.</p> <p>To copy an AMI from a Region to an Outpost, specify the source Region using the <b>SourceRegion</b> parameter, and specify the ARN of the destination Outpost using <b>DestinationOutpostArn</b>. Backing snapshots copied to an Outpost are encrypted by default using the default encryption key for the Region, or a different key that you specify in the request using <b>KmsKeyId</b>. Outposts do not support unencrypted snapshots. For more information, <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshots-outposts.html#ami"> Amazon EBS local snapshots on Outposts</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>For more information about the prerequisites and limits when copying an AMI, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/CopyingAMIs.html">Copying an AMI</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | +| `image_Deregister` | `EXEC` | `ImageId, region` | <p>Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances.</p> <p>If you deregister an AMI that matches a Recycle Bin retention rule, the AMI is retained in the Recycle Bin for the specified retention period. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin.html">Recycle Bin</a> in the Amazon Elastic Compute Cloud User Guide.</p> <p>When you deregister an AMI, it doesn't affect any instances that you've already launched from the AMI. You'll continue to incur usage costs for those instances until you terminate them.</p> <p>When you deregister an Amazon EBS-backed AMI, it doesn't affect the snapshot that was created for the root volume of the instance during the AMI creation process. When you deregister an instance store-backed AMI, it doesn't affect the files that you uploaded to Amazon S3 when you created the AMI.</p> | +| `image_Export` | `EXEC` | `DiskImageFormat, ImageId, S3ExportLocation, region` | Exports an Amazon Machine Image (AMI) to a VM file. For more information, see <a href="https://docs.aws.amazon.com/vm-import/latest/userguide/vmexport_image.html">Exporting a VM directly from an Amazon Machine Image (AMI)</a> in the <i>VM Import/Export User Guide</i>. | +| `image_Import` | `EXEC` | `region` | <p>Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI).</p> <p>For more information, see <a href="https://docs.aws.amazon.com/vm-import/latest/userguide/vmimport-image-import.html">Importing a VM as an image using VM Import/Export</a> in the <i>VM Import/Export User Guide</i>.</p> | +| `image_Register` | `EXEC` | `Name, region` | <p>Registers an AMI. When you're creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami.html">Creating your own AMIs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <note> <p>For Amazon EBS-backed instances, <a>CreateImage</a> creates and registers the AMI in a single request, so you don't have to register the AMI yourself.</p> </note> <p>If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image.</p> <p> <b>Register a snapshot of a root device volume</b> </p> <p>You can use <code>RegisterImage</code> to create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. You specify the snapshot using a block device mapping. You can't set the encryption state of the volume using the block device mapping. If the snapshot is encrypted, or encryption by default is enabled, the root volume of an instance launched from the AMI is encrypted.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami-ebs.html#creating-launching-ami-from-snapshot">Create a Linux AMI from a snapshot</a> and <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIEncryption.html">Use encryption with Amazon EBS-backed AMIs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p> <b>Amazon Web Services Marketplace product codes</b> </p> <p>If any snapshots have Amazon Web Services Marketplace product codes, they are copied to the new AMI.</p> <p>Windows and some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the Amazon EC2 billing product code associated with an AMI to verify the subscription status for package updates. To create a new AMI for operating systems that require a billing product code, instead of registering the AMI, do the following to preserve the billing product code association:</p> <ol> <li> <p>Launch an instance from an existing AMI with that billing product code.</p> </li> <li> <p>Customize the instance.</p> </li> <li> <p>Create an AMI from the instance using <a>CreateImage</a>.</p> </li> </ol> <p>If you purchase a Reserved Instance to apply to an On-Demand Instance that was launched from an AMI with a billing product code, make sure that the Reserved Instance has the matching billing product code. If you purchase a Reserved Instance without the matching billing product code, the Reserved Instance will not be applied to the On-Demand Instance. For information about how to obtain the platform details and billing information of an AMI, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-billing-info.html">Understanding AMI billing</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/images_in_recycle_bin/index.md b/docs/aws-docs/providers/aws/ec2_api/images_in_recycle_bin/index.md new file mode 100644 index 0000000000..51ed05568c --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/images_in_recycle_bin/index.md @@ -0,0 +1,38 @@ +--- +title: images_in_recycle_bin +hide_title: false +hide_table_of_contents: false +keywords: + - images_in_recycle_bin + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameimages_in_recycle_bin
TypeResource
Idaws.ec2_api.images_in_recycle_bin
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | The name of the AMI. | +| `description` | `string` | The description of the AMI. | +| `imageId` | `string` | The ID of the AMI. | +| `recycleBinEnterTime` | `string` | The date and time when the AMI entered the Recycle Bin. | +| `recycleBinExitTime` | `string` | The date and time when the AMI is to be permanently deleted from the Recycle Bin. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `images_in_recycle_bin_List` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/import_image_tasks/index.md b/docs/aws-docs/providers/aws/ec2_api/import_image_tasks/index.md new file mode 100644 index 0000000000..c1069a65cf --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/import_image_tasks/index.md @@ -0,0 +1,50 @@ +--- +title: import_image_tasks +hide_title: false +hide_table_of_contents: false +keywords: + - import_image_tasks + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameimport_image_tasks
TypeResource
Idaws.ec2_api.import_image_tasks
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `description` | `string` | A description of the import task. | +| `architecture` | `string` | <p>The architecture of the virtual machine.</p> <p>Valid values: <code>i386</code> \| <code>x86_64</code> \| <code>arm64</code> </p> | +| `bootMode` | `string` | The boot mode of the virtual machine. | +| `encrypted` | `boolean` | Indicates whether the image is encrypted. | +| `hypervisor` | `string` | <p>The target hypervisor for the import task.</p> <p>Valid values: <code>xen</code> </p> | +| `imageId` | `string` | The ID of the Amazon Machine Image (AMI) of the imported virtual machine. | +| `importTaskId` | `string` | The ID of the import image task. | +| `kmsKeyId` | `string` | The identifier for the KMS key that was used to create the encrypted image. | +| `licenseSpecifications` | `array` | The ARNs of the license configurations that are associated with the import image task. | +| `licenseType` | `string` | The license type of the virtual machine. | +| `platform` | `string` | The description string for the import image task. | +| `progress` | `string` | The percentage of progress of the import image task. | +| `snapshotDetailSet` | `array` | Information about the snapshots. | +| `status` | `string` | A brief status for the import image task. | +| `statusMessage` | `string` | A descriptive status message for the import image task. | +| `tagSet` | `array` | The tags for the import image task. | +| `usageOperation` | `string` | The usage operation value. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `import_image_tasks_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/import_snapshot_tasks/index.md b/docs/aws-docs/providers/aws/ec2_api/import_snapshot_tasks/index.md new file mode 100644 index 0000000000..9871724168 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/import_snapshot_tasks/index.md @@ -0,0 +1,37 @@ +--- +title: import_snapshot_tasks +hide_title: false +hide_table_of_contents: false +keywords: + - import_snapshot_tasks + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameimport_snapshot_tasks
TypeResource
Idaws.ec2_api.import_snapshot_tasks
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `description` | `string` | A description of the import snapshot task. | +| `importTaskId` | `string` | The ID of the import snapshot task. | +| `snapshotTaskDetail` | `object` | Details about the import snapshot task. | +| `tagSet` | `array` | The tags for the import snapshot task. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `import_snapshot_tasks_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/import_task/index.md b/docs/aws-docs/providers/aws/ec2_api/import_task/index.md new file mode 100644 index 0000000000..a49ca8d705 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/import_task/index.md @@ -0,0 +1,32 @@ +--- +title: import_task +hide_title: false +hide_table_of_contents: false +keywords: + - import_task + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameimport_task
TypeResource
Idaws.ec2_api.import_task
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `import_task_Cancel` | `EXEC` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/index.md b/docs/aws-docs/providers/aws/ec2_api/index.md new file mode 100644 index 0000000000..2dc9715840 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/index.md @@ -0,0 +1,286 @@ +--- +title: ec2_api +hide_title: false +hide_table_of_contents: false +keywords: + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +ec2_api + +:::info Service Summary + +
+
+total resources: 241
+total selectable resources: 170
+total methods: 523
+
+
+ +::: + +## Overview + + + + + + +
Nameaws.ec2_api
TypeService
Titleec2_api
Descriptionec2_api
Idec2_api:v00.00.00000
+ +## Resources +
+
+account_attributes
+address
+address_attribute
+address_to_classic
+address_to_vpc
+addresses
+addresses_attribute
+aggregate_id_format
+associated_enclave_certificate_iam_roles
+associated_ipv6_pool_cidrs
+availability_zone_group
+availability_zones
+bundle_tasks
+byoip_cidr_to_ipam
+byoip_cidrs
+capacity_reservation_fleets
+capacity_reservation_usage
+capacity_reservations
+carrier_gateways
+classic_link_instances
+classic_link_vpc
+client_vpn_authorization_rules
+client_vpn_client_certificate_revocation_list
+client_vpn_client_configuration
+client_vpn_connections
+client_vpn_endpoints
+client_vpn_ingress
+client_vpn_routes
+client_vpn_target_networks
+coip_pool_usage
+coip_pools
+console_output
+console_screenshot
+conversion_tasks
+customer_gateways
+default_credit_specification
+default_subnet
+default_vpc
+dhcp_options
+diagnostic_interrupt
+ebs_default_kms_key_id
+ebs_encryption_by_default
+egress_only_internet_gateways
+elastic_gpus
+enclave_certificate_iam_role
+export_image_tasks
+export_tasks
+fast_launch
+fast_launch_images
+fast_snapshot_restores
+fleet_history
+fleet_instances
+fleets
+flow_logs
+flow_logs_integration_template
+fpga_image_attribute
+fpga_images
+groups_for_capacity_reservation
+host_reservation_offerings
+host_reservation_purchase_preview
+host_reservations
+hosts
+iam_instance_profile
+iam_instance_profile_associations
+id_format
+identity_id_format
+image_attribute
+image_deprecation
+image_from_recycle_bin
+images
+images_in_recycle_bin
+import_image_tasks
+import_snapshot_tasks
+import_task
+instance_attribute
+instance_capacity_reservation_attributes
+instance_credit_specifications
+instance_event_notification_attributes
+instance_event_start_time
+instance_event_windows
+instance_export_task
+instance_maintenance_options
+instance_metadata_options
+instance_placement
+instance_status
+instance_type_offerings
+instance_types
+instance_types_from_instance_requirements
+instance_uefi_data
+instances
+internet_gateways
+ipam_address_history
+ipam_organization_admin_account
+ipam_pool_allocations
+ipam_pool_cidrs
+ipam_pools
+ipam_resource_cidrs
+ipam_scopes
+ipams
+ipv6_addresses
+ipv6_pools
+key_pairs
+launch_template_data
+launch_template_versions
+launch_templates
+local_gateway_route_table_virtual_interface_group_associations
+local_gateway_route_table_vpc_associations
+local_gateway_route_tables
+local_gateway_routes
+local_gateway_virtual_interface_groups
+local_gateway_virtual_interfaces
+local_gateways
+managed_prefix_list_associations
+managed_prefix_list_entries
+managed_prefix_list_version
+managed_prefix_lists
+moving_addresses
+nat_gateways
+network_acl_association
+network_acl_entry
+network_acls
+
+
+network_insights_access_scope_analyses
+network_insights_access_scope_analysis
+network_insights_access_scope_analysis_findings
+network_insights_access_scope_content
+network_insights_access_scopes
+network_insights_analyses
+network_insights_analysis
+network_insights_paths
+network_interface_attribute
+network_interface_permissions
+network_interfaces
+password_data
+placement_groups
+prefix_lists
+principal_id_format
+private_dns_name_options
+private_ip_addresses
+product_instance
+public_ipv4_pool_cidr
+public_ipv4_pools
+queued_reserved_instances
+regions
+replace_root_volume_tasks
+reserved_instances
+reserved_instances_exchange_quote
+reserved_instances_listings
+reserved_instances_modifications
+reserved_instances_offerings
+restore_image_task
+route
+route_table_association
+route_tables
+scheduled_instance_availability
+scheduled_instances
+security_group_egress
+security_group_ingress
+security_group_references
+security_group_rule_descriptions_egress
+security_group_rule_descriptions_ingress
+security_group_rules
+security_groups
+security_groups_to_client_vpn_target_network
+serial_console_access
+serial_console_access_status
+snapshot_attribute
+snapshot_from_recycle_bin
+snapshot_tier
+snapshot_tier_status
+snapshots
+snapshots_in_recycle_bin
+spot_datafeed_subscription
+spot_fleet
+spot_fleet_instances
+spot_fleet_request_history
+spot_fleet_requests
+spot_instance_requests
+spot_instances
+spot_placement_scores
+spot_price_history
+stale_security_groups
+store_image_tasks
+subnet_attribute
+subnet_cidr_block
+subnet_cidr_reservations
+subnets
+tags
+traffic_mirror_filter_network_services
+traffic_mirror_filter_rule
+traffic_mirror_filters
+traffic_mirror_sessions
+traffic_mirror_targets
+transit_gateway_attachment_propagations
+transit_gateway_attachments
+transit_gateway_connect_peers
+transit_gateway_connects
+transit_gateway_multicast_domain_associations
+transit_gateway_multicast_domains
+transit_gateway_multicast_group_members
+transit_gateway_multicast_group_sources
+transit_gateway_multicast_groups
+transit_gateway_peering_attachments
+transit_gateway_prefix_list_references
+transit_gateway_route_table_associations
+transit_gateway_route_table_propagations
+transit_gateway_route_tables
+transit_gateway_routes
+transit_gateway_vpc_attachments
+transit_gateways
+trunk_interface
+trunk_interface_associations
+vgw_route_propagation
+volume_attribute
+volume_i_o
+volume_status
+volumes
+volumes_modifications
+vpc_attribute
+vpc_cidr_block
+vpc_classic_link
+vpc_classic_link_dns_support
+vpc_endpoint_connection_notifications
+vpc_endpoint_connections
+vpc_endpoint_service_configurations
+vpc_endpoint_service_payer_responsibility
+vpc_endpoint_service_permissions
+vpc_endpoint_service_private_dns_verification
+vpc_endpoint_services
+vpc_endpoints
+vpc_peering_connection_options
+vpc_peering_connections
+vpc_tenancy
+vpcs
+vpn_connection_device_sample_configuration
+vpn_connection_device_types
+vpn_connection_options
+vpn_connection_route
+vpn_connections
+vpn_gateways
+vpn_tunnel_certificate
+vpn_tunnel_options
+
+
diff --git a/docs/aws-docs/providers/aws/ec2_api/instance_attribute/index.md b/docs/aws-docs/providers/aws/ec2_api/instance_attribute/index.md new file mode 100644 index 0000000000..40c242ff31 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/instance_attribute/index.md @@ -0,0 +1,51 @@ +--- +title: instance_attribute +hide_title: false +hide_table_of_contents: false +keywords: + - instance_attribute + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameinstance_attribute
TypeResource
Idaws.ec2_api.instance_attribute
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `blockDeviceMapping` | `array` | The block device mapping of the instance. | +| `disableApiTermination` | `object` | Describes a value for a resource attribute that is a Boolean value. | +| `ebsOptimized` | `object` | Describes a value for a resource attribute that is a Boolean value. | +| `enaSupport` | `object` | Describes a value for a resource attribute that is a Boolean value. | +| `enclaveOptions` | `object` | Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. | +| `groupSet` | `array` | The security groups associated with the instance. | +| `instanceId` | `string` | The ID of the instance. | +| `instanceInitiatedShutdownBehavior` | `object` | Describes a value for a resource attribute that is a String. | +| `instanceType` | `object` | Describes a value for a resource attribute that is a String. | +| `kernel` | `object` | Describes a value for a resource attribute that is a String. | +| `productCodes` | `array` | A list of product codes. | +| `ramdisk` | `object` | Describes a value for a resource attribute that is a String. | +| `rootDeviceName` | `object` | Describes a value for a resource attribute that is a String. | +| `sourceDestCheck` | `object` | Describes a value for a resource attribute that is a Boolean value. | +| `sriovNetSupport` | `object` | Describes a value for a resource attribute that is a String. | +| `userData` | `object` | Describes a value for a resource attribute that is a String. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `instance_attribute_Describe` | `SELECT` | `Attribute, InstanceId, region` | Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Valid attribute values are: <code>instanceType</code> \| <code>kernel</code> \| <code>ramdisk</code> \| <code>userData</code> \| <code>disableApiTermination</code> \| <code>instanceInitiatedShutdownBehavior</code> \| <code>rootDeviceName</code> \| <code>blockDeviceMapping</code> \| <code>productCodes</code> \| <code>sourceDestCheck</code> \| <code>groupSet</code> \| <code>ebsOptimized</code> \| <code>sriovNetSupport</code> | +| `instance_attribute_Modify` | `EXEC` | `InstanceId, region` | <p>Modifies the specified attribute of the specified instance. You can specify only one attribute at a time.</p> <p> <b>Note: </b>Using this action to change the security groups associated with an elastic network interface (ENI) attached to an instance in a VPC can result in an error if the instance has more than one ENI. To change the security groups associated with an ENI attached to an instance that has multiple ENIs, we recommend that you use the <a>ModifyNetworkInterfaceAttribute</a> action.</p> <p>To modify some attributes, the instance must be stopped. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_ChangingAttributesWhileInstanceStopped.html">Modify a stopped instance</a> in the <i>Amazon EC2 User Guide</i>.</p> | +| `instance_attribute_Reset` | `EXEC` | `Attribute, InstanceId, region` | <p>Resets an attribute of an instance to its default value. To reset the <code>kernel</code> or <code>ramdisk</code>, the instance must be in a stopped state. To reset the <code>sourceDestCheck</code>, the instance can be either running or stopped.</p> <p>The <code>sourceDestCheck</code> attribute controls whether source/destination checking is enabled. The default value is <code>true</code>, which means checking is enabled. This value must be <code>false</code> for a NAT instance to perform NAT. For more information, see <a href="https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_NAT_Instance.html">NAT Instances</a> in the <i>Amazon VPC User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/instance_capacity_reservation_attributes/index.md b/docs/aws-docs/providers/aws/ec2_api/instance_capacity_reservation_attributes/index.md new file mode 100644 index 0000000000..92f581db4f --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/instance_capacity_reservation_attributes/index.md @@ -0,0 +1,32 @@ +--- +title: instance_capacity_reservation_attributes +hide_title: false +hide_table_of_contents: false +keywords: + - instance_capacity_reservation_attributes + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameinstance_capacity_reservation_attributes
TypeResource
Idaws.ec2_api.instance_capacity_reservation_attributes
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `instance_capacity_reservation_attributes_Modify` | `EXEC` | `CapacityReservationSpecification, InstanceId, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/instance_credit_specifications/index.md b/docs/aws-docs/providers/aws/ec2_api/instance_credit_specifications/index.md new file mode 100644 index 0000000000..5d928ae987 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/instance_credit_specifications/index.md @@ -0,0 +1,36 @@ +--- +title: instance_credit_specifications +hide_title: false +hide_table_of_contents: false +keywords: + - instance_credit_specifications + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameinstance_credit_specifications
TypeResource
Idaws.ec2_api.instance_credit_specifications
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `cpuCredits` | `string` | The credit option for CPU usage of the instance. Valid values are <code>standard</code> and <code>unlimited</code>. | +| `instanceId` | `string` | The ID of the instance. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `instance_credit_specifications_Describe` | `SELECT` | `region` | <p>Describes the credit option for CPU usage of the specified burstable performance instances. The credit options are <code>standard</code> and <code>unlimited</code>.</p> <p>If you do not specify an instance ID, Amazon EC2 returns burstable performance instances with the <code>unlimited</code> credit option, as well as instances that were previously configured as T2, T3, and T3a with the <code>unlimited</code> credit option. For example, if you resize a T2 instance, while it is configured as <code>unlimited</code>, to an M4 instance, Amazon EC2 returns the M4 instance.</p> <p>If you specify one or more instance IDs, Amazon EC2 returns the credit option (<code>standard</code> or <code>unlimited</code>) of those instances. If you specify an instance ID that is not valid, such as an instance that is not a burstable performance instance, an error is returned.</p> <p>Recently terminated instances might appear in the returned results. This interval is usually less than one hour.</p> <p>If an Availability Zone is experiencing a service disruption and you specify instance IDs in the affected zone, or do not specify any instance IDs at all, the call fails. If you specify only instance IDs in an unaffected zone, the call works normally.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html">Burstable performance instances</a> in the <i>Amazon EC2 User Guide</i>.</p> | +| `instance_credit_specification_Modify` | `EXEC` | `InstanceCreditSpecification, region` | <p>Modifies the credit option for CPU usage on a running or stopped burstable performance instance. The credit options are <code>standard</code> and <code>unlimited</code>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html">Burstable performance instances</a> in the <i>Amazon EC2 User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/instance_event_notification_attributes/index.md b/docs/aws-docs/providers/aws/ec2_api/instance_event_notification_attributes/index.md new file mode 100644 index 0000000000..ea98ea7d21 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/instance_event_notification_attributes/index.md @@ -0,0 +1,33 @@ +--- +title: instance_event_notification_attributes +hide_title: false +hide_table_of_contents: false +keywords: + - instance_event_notification_attributes + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameinstance_event_notification_attributes
TypeResource
Idaws.ec2_api.instance_event_notification_attributes
+ +## Fields +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `instance_event_notification_attributes_Describe` | `SELECT` | `region` | Describes the tag keys that are registered to appear in scheduled event notifications for resources in the current Region. | +| `instance_event_notification_attributes_Deregister` | `EXEC` | `region` | Deregisters tag keys to prevent tags that have the specified tag keys from being included in scheduled event notifications for resources in the Region. | +| `instance_event_notification_attributes_Register` | `EXEC` | `region` | <p>Registers a set of tag keys to include in scheduled event notifications for your resources. </p> <p>To remove tags, use <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeregisterInstanceEventNotificationAttributes.html">DeregisterInstanceEventNotificationAttributes</a>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/instance_event_start_time/index.md b/docs/aws-docs/providers/aws/ec2_api/instance_event_start_time/index.md new file mode 100644 index 0000000000..974ad78791 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/instance_event_start_time/index.md @@ -0,0 +1,32 @@ +--- +title: instance_event_start_time +hide_title: false +hide_table_of_contents: false +keywords: + - instance_event_start_time + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameinstance_event_start_time
TypeResource
Idaws.ec2_api.instance_event_start_time
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `instance_event_start_time_Modify` | `EXEC` | `InstanceEventId, InstanceId, NotBefore, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/instance_event_windows/index.md b/docs/aws-docs/providers/aws/ec2_api/instance_event_windows/index.md new file mode 100644 index 0000000000..94ff2e2a47 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/instance_event_windows/index.md @@ -0,0 +1,45 @@ +--- +title: instance_event_windows +hide_title: false +hide_table_of_contents: false +keywords: + - instance_event_windows + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameinstance_event_windows
TypeResource
Idaws.ec2_api.instance_event_windows
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | The name of the event window. | +| `associationTarget` | `object` | One or more targets associated with the event window. | +| `cronExpression` | `string` | The cron expression defined for the event window. | +| `instanceEventWindowId` | `string` | The ID of the event window. | +| `state` | `string` | The current state of the event window. | +| `tagSet` | `array` | The instance tags associated with the event window. | +| `timeRangeSet` | `array` | One or more time ranges defined for the event window. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `instance_event_windows_Describe` | `SELECT` | `region` | <p>Describes the specified event windows or all event windows.</p> <p>If you specify event window IDs, the output includes information for only the specified event windows. If you specify filters, the output includes information for only those event windows that meet the filter criteria. If you do not specify event windows IDs or filters, the output includes information for all event windows, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully. </p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html">Define event windows for scheduled events</a> in the <i>Amazon EC2 User Guide</i>.</p> | +| `instance_event_window_Create` | `INSERT` | `region` | <p>Creates an event window in which scheduled events for the associated Amazon EC2 instances can run.</p> <p>You can define either a set of time ranges or a cron expression when creating the event window, but not both. All event window times are in UTC.</p> <p>You can create up to 200 event windows per Amazon Web Services Region.</p> <p>When you create the event window, targets (instance IDs, Dedicated Host IDs, or tags) are not yet associated with it. To ensure that the event window can be used, you must associate one or more targets with it by using the <a>AssociateInstanceEventWindow</a> API.</p> <important> <p>Event windows are applicable only for scheduled events that stop, reboot, or terminate instances.</p> <p>Event windows are <i>not</i> applicable for:</p> <ul> <li> <p>Expedited scheduled events and network maintenance events. </p> </li> <li> <p>Unscheduled maintenance such as AutoRecovery and unplanned reboots.</p> </li> </ul> </important> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html">Define event windows for scheduled events</a> in the <i>Amazon EC2 User Guide</i>.</p> | +| `instance_event_window_Delete` | `DELETE` | `InstanceEventWindowId, region` | <p>Deletes the specified event window.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html">Define event windows for scheduled events</a> in the <i>Amazon EC2 User Guide</i>.</p> | +| `instance_event_window_Associate` | `EXEC` | `AssociationTarget, InstanceEventWindowId, region` | <p>Associates one or more targets with an event window. Only one type of target (instance IDs, Dedicated Host IDs, or tags) can be specified with an event window.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html">Define event windows for scheduled events</a> in the <i>Amazon EC2 User Guide</i>.</p> | +| `instance_event_window_Disassociate` | `EXEC` | `AssociationTarget, InstanceEventWindowId, region` | <p>Disassociates one or more targets from an event window.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html">Define event windows for scheduled events</a> in the <i>Amazon EC2 User Guide</i>.</p> | +| `instance_event_window_Modify` | `EXEC` | `InstanceEventWindowId, region` | <p>Modifies the specified event window.</p> <p>You can define either a set of time ranges or a cron expression when modifying the event window, but not both.</p> <p>To modify the targets associated with the event window, use the <a>AssociateInstanceEventWindow</a> and <a>DisassociateInstanceEventWindow</a> API.</p> <p>If Amazon Web Services has already scheduled an event, modifying an event window won't change the time of the scheduled event.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html">Define event windows for scheduled events</a> in the <i>Amazon EC2 User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/instance_export_task/index.md b/docs/aws-docs/providers/aws/ec2_api/instance_export_task/index.md new file mode 100644 index 0000000000..c2da3c6832 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/instance_export_task/index.md @@ -0,0 +1,32 @@ +--- +title: instance_export_task +hide_title: false +hide_table_of_contents: false +keywords: + - instance_export_task + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameinstance_export_task
TypeResource
Idaws.ec2_api.instance_export_task
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `instance_export_task_Create` | `INSERT` | `ExportToS3, InstanceId, TargetEnvironment, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/instance_maintenance_options/index.md b/docs/aws-docs/providers/aws/ec2_api/instance_maintenance_options/index.md new file mode 100644 index 0000000000..5e31c86ddb --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/instance_maintenance_options/index.md @@ -0,0 +1,32 @@ +--- +title: instance_maintenance_options +hide_title: false +hide_table_of_contents: false +keywords: + - instance_maintenance_options + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameinstance_maintenance_options
TypeResource
Idaws.ec2_api.instance_maintenance_options
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `instance_maintenance_options_Modify` | `EXEC` | `InstanceId, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/instance_metadata_options/index.md b/docs/aws-docs/providers/aws/ec2_api/instance_metadata_options/index.md new file mode 100644 index 0000000000..daf2676d5e --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/instance_metadata_options/index.md @@ -0,0 +1,32 @@ +--- +title: instance_metadata_options +hide_title: false +hide_table_of_contents: false +keywords: + - instance_metadata_options + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameinstance_metadata_options
TypeResource
Idaws.ec2_api.instance_metadata_options
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `instance_metadata_options_Modify` | `EXEC` | `InstanceId, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/instance_placement/index.md b/docs/aws-docs/providers/aws/ec2_api/instance_placement/index.md new file mode 100644 index 0000000000..be5a82f380 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/instance_placement/index.md @@ -0,0 +1,32 @@ +--- +title: instance_placement +hide_title: false +hide_table_of_contents: false +keywords: + - instance_placement + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameinstance_placement
TypeResource
Idaws.ec2_api.instance_placement
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `instance_placement_Modify` | `EXEC` | `InstanceId, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/instance_status/index.md b/docs/aws-docs/providers/aws/ec2_api/instance_status/index.md new file mode 100644 index 0000000000..e75f9e0115 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/instance_status/index.md @@ -0,0 +1,41 @@ +--- +title: instance_status +hide_title: false +hide_table_of_contents: false +keywords: + - instance_status + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameinstance_status
TypeResource
Idaws.ec2_api.instance_status
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `availabilityZone` | `string` | The Availability Zone of the instance. | +| `eventsSet` | `array` | Any scheduled events associated with the instance. | +| `instanceId` | `string` | The ID of the instance. | +| `instanceState` | `object` | Describes the current state of an instance. | +| `instanceStatus` | `object` | Describes the status of an instance. | +| `outpostArn` | `string` | The Amazon Resource Name (ARN) of the Outpost. | +| `systemStatus` | `object` | Describes the status of an instance. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `instance_status_Describe` | `SELECT` | `region` | <p>Describes the status of the specified instances or all of your instances. By default, only running instances are described, unless you specifically indicate to return the status of all instances.</p> <p>Instance status includes the following components:</p> <ul> <li> <p> <b>Status checks</b> - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-system-instance-status-check.html">Status checks for your instances</a> and <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstances.html">Troubleshoot instances with failed status checks</a> in the <i>Amazon EC2 User Guide</i>.</p> </li> <li> <p> <b>Scheduled events</b> - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-instances-status-check_sched.html">Scheduled events for your instances</a> in the <i>Amazon EC2 User Guide</i>.</p> </li> <li> <p> <b>Instance state</b> - You can manage your instances from the moment you launch them through their termination. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-lifecycle.html">Instance lifecycle</a> in the <i>Amazon EC2 User Guide</i>.</p> </li> </ul> | +| `instance_status_Report` | `EXEC` | `InstanceId, ReasonCode, Status, region` | <p>Submits feedback about the status of an instance. The instance must be in the <code>running</code> state. If your experience with the instance differs from the instance status returned by <a>DescribeInstanceStatus</a>, use <a>ReportInstanceStatus</a> to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks.</p> <p>Use of this action does not change the value returned by <a>DescribeInstanceStatus</a>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/instance_type_offerings/index.md b/docs/aws-docs/providers/aws/ec2_api/instance_type_offerings/index.md new file mode 100644 index 0000000000..cf93ecb384 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/instance_type_offerings/index.md @@ -0,0 +1,36 @@ +--- +title: instance_type_offerings +hide_title: false +hide_table_of_contents: false +keywords: + - instance_type_offerings + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameinstance_type_offerings
TypeResource
Idaws.ec2_api.instance_type_offerings
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `instanceType` | `string` | The instance type. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance types</a> in the <i>Amazon EC2 User Guide</i>. | +| `location` | `string` | The identifier for the location. This depends on the location type. For example, if the location type is <code>region</code>, the location is the Region code (for example, <code>us-east-2</code>.) | +| `locationType` | `string` | The location type. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `instance_type_offerings_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/instance_types/index.md b/docs/aws-docs/providers/aws/ec2_api/instance_types/index.md new file mode 100644 index 0000000000..ca04206353 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/instance_types/index.md @@ -0,0 +1,57 @@ +--- +title: instance_types +hide_title: false +hide_table_of_contents: false +keywords: + - instance_types + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameinstance_types
TypeResource
Idaws.ec2_api.instance_types
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `autoRecoverySupported` | `boolean` | Indicates whether auto recovery is supported. | +| `bareMetal` | `boolean` | Indicates whether the instance is a bare metal instance type. | +| `burstablePerformanceSupported` | `boolean` | Indicates whether the instance type is a burstable performance instance type. | +| `currentGeneration` | `boolean` | Indicates whether the instance type is current generation. | +| `dedicatedHostsSupported` | `boolean` | Indicates whether Dedicated Hosts are supported on the instance type. | +| `ebsInfo` | `object` | Describes the Amazon EBS features supported by the instance type. | +| `fpgaInfo` | `object` | Describes the FPGAs for the instance type. | +| `freeTierEligible` | `boolean` | Indicates whether the instance type is eligible for the free tier. | +| `gpuInfo` | `object` | Describes the GPU accelerators for the instance type. | +| `hibernationSupported` | `boolean` | Indicates whether On-Demand hibernation is supported. | +| `hypervisor` | `string` | The hypervisor for the instance type. | +| `inferenceAcceleratorInfo` | `object` | Describes the Inference accelerators for the instance type. | +| `instanceStorageInfo` | `object` | Describes the instance store features that are supported by the instance type. | +| `instanceStorageSupported` | `boolean` | Indicates whether instance storage is supported. | +| `instanceType` | `string` | The instance type. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance types</a> in the <i>Amazon EC2 User Guide</i>. | +| `memoryInfo` | `object` | Describes the memory for the instance type. | +| `networkInfo` | `object` | Describes the networking features of the instance type. | +| `placementGroupInfo` | `object` | Describes the placement group support of the instance type. | +| `processorInfo` | `object` | Describes the processor used by the instance type. | +| `supportedBootModes` | `array` | The supported boot modes. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html">Boot modes</a> in the <i>Amazon EC2 User Guide</i>. | +| `supportedRootDeviceTypes` | `array` | The supported root device types. | +| `supportedUsageClasses` | `array` | Indicates whether the instance type is offered for spot or On-Demand. | +| `supportedVirtualizationTypes` | `array` | The supported virtualization types. | +| `vCpuInfo` | `object` | Describes the vCPU configurations for the instance type. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `instance_types_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/instance_types_from_instance_requirements/index.md b/docs/aws-docs/providers/aws/ec2_api/instance_types_from_instance_requirements/index.md new file mode 100644 index 0000000000..b1ccc7e6e4 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/instance_types_from_instance_requirements/index.md @@ -0,0 +1,31 @@ +--- +title: instance_types_from_instance_requirements +hide_title: false +hide_table_of_contents: false +keywords: + - instance_types_from_instance_requirements + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameinstance_types_from_instance_requirements
TypeResource
Idaws.ec2_api.instance_types_from_instance_requirements
+ +## Fields +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `instance_types_from_instance_requirements_Get` | `SELECT` | `ArchitectureType, InstanceRequirements, VirtualizationType, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/instance_uefi_data/index.md b/docs/aws-docs/providers/aws/ec2_api/instance_uefi_data/index.md new file mode 100644 index 0000000000..21849bdfe1 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/instance_uefi_data/index.md @@ -0,0 +1,35 @@ +--- +title: instance_uefi_data +hide_title: false +hide_table_of_contents: false +keywords: + - instance_uefi_data + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameinstance_uefi_data
TypeResource
Idaws.ec2_api.instance_uefi_data
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `instanceId` | `string` | The ID of the instance from which to retrieve the UEFI data. | +| `uefiData` | `string` | Base64 representation of the non-volatile UEFI variable store. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `instance_uefi_data_Get` | `SELECT` | `InstanceId, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/instances/index.md b/docs/aws-docs/providers/aws/ec2_api/instances/index.md new file mode 100644 index 0000000000..aff0e45832 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/instances/index.md @@ -0,0 +1,98 @@ +--- +title: instances +hide_title: false +hide_table_of_contents: false +keywords: + - instances + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameinstances
TypeResource
Idaws.ec2_api.instances
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `amiLaunchIndex` | `integer` | The AMI launch index, which can be used to find this instance in the launch group. | +| `architecture` | `string` | The architecture of the image. | +| `blockDeviceMapping` | `array` | Any block device mapping entries for the instance. | +| `bootMode` | `string` | The boot mode of the instance. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html">Boot modes</a> in the <i>Amazon EC2 User Guide</i>. | +| `capacityReservationId` | `string` | The ID of the Capacity Reservation. | +| `capacityReservationSpecification` | `object` | Describes the instance's Capacity Reservation targeting preferences. The action returns the <code>capacityReservationPreference</code> response element if the instance is configured to run in On-Demand capacity, or if it is configured in run in any <code>open</code> Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). The action returns the <code>capacityReservationTarget</code> response element if the instance explicily targets a specific Capacity Reservation or Capacity Reservation group. | +| `clientToken` | `string` | The idempotency token you provided when you launched the instance, if applicable. | +| `cpuOptions` | `object` | The CPU options for the instance. | +| `dnsName` | `string` | (IPv4 only) The public DNS name assigned to the instance. This name is not available until the instance enters the <code>running</code> state. For EC2-VPC, this name is only available if you've enabled DNS hostnames for your VPC. | +| `ebsOptimized` | `boolean` | Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance. | +| `elasticGpuAssociationSet` | `array` | The Elastic GPU associated with the instance. | +| `elasticInferenceAcceleratorAssociationSet` | `array` | The elastic inference accelerator associated with the instance. | +| `enaSupport` | `boolean` | Specifies whether enhanced networking with ENA is enabled. | +| `enclaveOptions` | `object` | Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. | +| `groupSet` | `array` | The security groups for the instance. | +| `hibernationOptions` | `object` | Indicates whether your instance is configured for hibernation. This parameter is valid only if the instance meets the <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html#hibernating-prerequisites">hibernation prerequisites</a>. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html">Hibernate your instance</a> in the <i>Amazon EC2 User Guide</i>. | +| `hypervisor` | `string` | The hypervisor type of the instance. The value <code>xen</code> is used for both Xen and Nitro hypervisors. | +| `iamInstanceProfile` | `object` | Describes an IAM instance profile. | +| `imageId` | `string` | The ID of the AMI used to launch the instance. | +| `instanceId` | `string` | The ID of the instance. | +| `instanceLifecycle` | `string` | Indicates whether this is a Spot Instance or a Scheduled Instance. | +| `instanceState` | `object` | Describes the current state of an instance. | +| `instanceType` | `string` | The instance type. | +| `ipAddress` | `string` | <p>The public IPv4 address, or the Carrier IP address assigned to the instance, if applicable.</p> <p>A Carrier IP address only applies to an instance launched in a subnet associated with a Wavelength Zone.</p> | +| `ipv6Address` | `string` | The IPv6 address assigned to the instance. | +| `kernelId` | `string` | The kernel associated with this instance, if applicable. | +| `keyName` | `string` | The name of the key pair, if this instance was launched with an associated key pair. | +| `launchTime` | `string` | The time the instance was launched. | +| `licenseSet` | `array` | The license configurations for the instance. | +| `maintenanceOptions` | `object` | The maintenance options for the instance. | +| `metadataOptions` | `object` | The metadata options for the instance. | +| `monitoring` | `object` | Describes the monitoring of an instance. | +| `networkInterfaceSet` | `array` | [EC2-VPC] The network interfaces for the instance. | +| `outpostArn` | `string` | The Amazon Resource Name (ARN) of the Outpost. | +| `placement` | `object` | Describes the placement of an instance. | +| `platform` | `string` | The value is <code>Windows</code> for Windows instances; otherwise blank. | +| `platformDetails` | `string` | The platform details value for the instance. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/billing-info-fields.html">AMI billing information fields</a> in the <i>Amazon EC2 User Guide</i>. | +| `privateDnsName` | `string` | <p>(IPv4 only) The private DNS hostname name assigned to the instance. This DNS hostname can only be used inside the Amazon EC2 network. This name is not available until the instance enters the <code>running</code> state. </p> <p>[EC2-VPC] The Amazon-provided DNS server resolves Amazon-provided private DNS hostnames if you've enabled DNS resolution and DNS hostnames in your VPC. If you are not using the Amazon-provided DNS server in your VPC, your custom domain name servers must resolve the hostname as appropriate.</p> | +| `privateDnsNameOptions` | `object` | Describes the options for instance hostnames. | +| `privateIpAddress` | `string` | The private IPv4 address assigned to the instance. | +| `productCodes` | `array` | The product codes attached to this instance, if applicable. | +| `ramdiskId` | `string` | The RAM disk associated with this instance, if applicable. | +| `reason` | `string` | The reason for the most recent state transition. This might be an empty string. | +| `rootDeviceName` | `string` | The device name of the root device volume (for example, <code>/dev/sda1</code>). | +| `rootDeviceType` | `string` | The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume. | +| `sourceDestCheck` | `boolean` | Indicates whether source/destination checking is enabled. | +| `spotInstanceRequestId` | `string` | If the request is a Spot Instance request, the ID of the request. | +| `sriovNetSupport` | `string` | Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled. | +| `stateReason` | `object` | Describes a state change. | +| `subnetId` | `string` | [EC2-VPC] The ID of the subnet in which the instance is running. | +| `tagSet` | `array` | Any tags assigned to the instance. | +| `tpmSupport` | `string` | If the instance is configured for NitroTPM support, the value is <code>v2.0</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitrotpm.html">NitroTPM</a> in the <i>Amazon EC2 User Guide</i>. | +| `usageOperation` | `string` | The usage operation value for the instance. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/billing-info-fields.html">AMI billing information fields</a> in the <i>Amazon EC2 User Guide</i>. | +| `usageOperationUpdateTime` | `string` | The time that the usage operation was last updated. | +| `virtualizationType` | `string` | The virtualization type of the instance. | +| `vpcId` | `string` | [EC2-VPC] The ID of the VPC in which the instance is running. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `instances_Describe` | `SELECT` | `region` | <p>Describes the specified instances or all instances.</p> <p>If you specify instance IDs, the output includes information for only the specified instances. If you specify filters, the output includes information for only those instances that meet the filter criteria. If you do not specify instance IDs or filters, the output includes information for all instances, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully.</p> <p>If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the output.</p> <p>Recently terminated instances might appear in the returned results. This interval is usually less than one hour.</p> <p>If you describe instances in the rare case where an Availability Zone is experiencing a service disruption and you specify instance IDs that are in the affected zone, or do not specify any instance IDs at all, the call fails. If you describe instances and specify only instance IDs that are in an unaffected zone, the call works normally.</p> | +| `instance_Bundle` | `EXEC` | `InstanceId, Storage, region` | <p>Bundles an Amazon instance store-backed Windows instance.</p> <p>During bundling, only the root device volume (C:\) is bundled. Data on other instance store volumes is not preserved.</p> <note> <p>This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS.</p> </note> | +| `instance_Import` | `EXEC` | `Platform, region` | <p>Creates an import instance task using metadata from the specified disk image.</p> <p>This API action supports only single-volume VMs. To import multi-volume VMs, use <a>ImportImage</a> instead.</p> <p>This API action is not supported by the Command Line Interface (CLI). For information about using the Amazon EC2 CLI, which is deprecated, see <a href="https://awsdocs.s3.amazonaws.com/EC2/ec2-clt.pdf#UsingVirtualMachinesinAmazonEC2">Importing a VM to Amazon EC2</a> in the <i>Amazon EC2 CLI Reference</i> PDF file.</p> <p>For information about the import manifest referenced by this API action, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/manifest.html">VM Import Manifest</a>.</p> | +| `instances_Monitor` | `EXEC` | `InstanceId, region` | <p>Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch.html">Monitor your instances using CloudWatch</a> in the <i>Amazon EC2 User Guide</i>.</p> <p>To disable detailed monitoring, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_UnmonitorInstances.html">UnmonitorInstances</a>.</p> | +| `instances_Reboot` | `EXEC` | `InstanceId, region` | <p>Requests a reboot of the specified instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored.</p> <p>If an instance does not cleanly shut down within a few minutes, Amazon EC2 performs a hard reboot.</p> <p>For more information about troubleshooting, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-console.html">Troubleshoot an unreachable instance</a> in the <i>Amazon EC2 User Guide</i>.</p> | +| `instances_Run` | `EXEC` | `MaxCount, MinCount, region` | <p>Launches the specified number of instances using an AMI for which you have permissions.</p> <p>You can specify a number of options, or leave the default options. The following rules apply:</p> <ul> <li> <p>[EC2-VPC] If you don't specify a subnet ID, we choose a default subnet from your default VPC for you. If you don't have a default VPC, you must specify a subnet ID in the request.</p> </li> <li> <p>[EC2-Classic] If don't specify an Availability Zone, we choose one for you.</p> </li> <li> <p>Some instance types must be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID, the request fails. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-vpc.html#vpc-only-instance-types">Instance types available only in a VPC</a>.</p> </li> <li> <p>[EC2-VPC] All instances have a network interface with a primary private IPv4 address. If you don't specify this address, we choose one from the IPv4 range of your subnet.</p> </li> <li> <p>Not all instance types support IPv6 addresses. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance types</a>.</p> </li> <li> <p>If you don't specify a security group ID, we use the default security group. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html">Security groups</a>.</p> </li> <li> <p>If any of the AMIs have a product code attached for which the user has not subscribed, the request fails.</p> </li> </ul> <p>You can create a <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html">launch template</a>, which is a resource that contains the parameters to launch an instance. When you launch an instance using <a>RunInstances</a>, you can specify the launch template instead of specifying the launch parameters.</p> <p>To ensure faster instance launches, break up large requests into smaller batches. For example, create five separate launch requests for 100 instances each instead of one launch request for 500 instances.</p> <p>An instance is ready for you to use when it's in the <code>running</code> state. You can check the state of your instance using <a>DescribeInstances</a>. You can tag instances and EBS volumes during launch, after launch, or both. For more information, see <a>CreateTags</a> and <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html">Tagging your Amazon EC2 resources</a>.</p> <p>Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html">Key pairs</a>.</p> <p>For troubleshooting, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_InstanceStraightToTerminated.html">What to do if an instance immediately terminates</a>, and <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstancesConnecting.html">Troubleshooting connecting to your instance</a>.</p> | +| `instances_Start` | `EXEC` | `InstanceId, region` | <p>Starts an Amazon EBS-backed instance that you've previously stopped.</p> <p>Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for instance usage. However, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.</p> <p>Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.</p> <p>Performing this operation on an instance that uses an instance store as its root device returns an error.</p> <p>If you attempt to start a T3 instance with <code>host</code> tenancy and the <code>unlimted</code> CPU credit option, the request fails. The <code>unlimited</code> CPU credit option is not supported on Dedicated Hosts. Before you start the instance, either change its CPU credit option to <code>standard</code>, or change its tenancy to <code>default</code> or <code>dedicated</code>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html">Stop and start your instance</a> in the <i>Amazon EC2 User Guide</i>.</p> | +| `instances_Stop` | `EXEC` | `InstanceId, region` | <p>Stops an Amazon EBS-backed instance. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html">Stop and start your instance</a> in the <i>Amazon EC2 User Guide</i>.</p> <p>You can use the Stop action to hibernate an instance if the instance is <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html#enabling-hibernation">enabled for hibernation</a> and it meets the <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html#hibernating-prerequisites">hibernation prerequisites</a>. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html">Hibernate your instance</a> in the <i>Amazon EC2 User Guide</i>.</p> <p>We don't charge usage for a stopped instance, or data transfer fees; however, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.</p> <p>You can't stop or hibernate instance store-backed instances. You can't use the Stop action to hibernate Spot Instances, but you can specify that Amazon EC2 should hibernate Spot Instances when they are interrupted. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-interruptions.html#hibernate-spot-instances">Hibernating interrupted Spot Instances</a> in the <i>Amazon EC2 User Guide</i>.</p> <p>When you stop or hibernate an instance, we shut it down. You can restart your instance at any time. Before stopping or hibernating an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM, but hibernating an instance does preserve data stored in RAM. If an instance cannot hibernate successfully, a normal shutdown occurs.</p> <p>Stopping and hibernating an instance is different to rebooting or terminating it. For example, when you stop or hibernate an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between rebooting, stopping, hibernating, and terminating instances, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-lifecycle.html">Instance lifecycle</a> in the <i>Amazon EC2 User Guide</i>.</p> <p>When you stop an instance, we attempt to shut it down forcibly after a short while. If your instance appears stuck in the stopping state after a period of time, there may be an issue with the underlying host computer. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstancesStopping.html">Troubleshoot stopping your instance</a> in the <i>Amazon EC2 User Guide</i>.</p> | +| `instances_Terminate` | `EXEC` | `InstanceId, region` | <p>Shuts down the specified instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds. </p> <p>If you specify multiple instances and the request fails (for example, because of a single incorrect instance ID), none of the instances are terminated.</p> <p>If you terminate multiple instances across multiple Availability Zones, and one or more of the specified instances are enabled for termination protection, the request fails with the following results:</p> <ul> <li> <p>The specified instances that are in the same Availability Zone as the protected instance are not terminated.</p> </li> <li> <p>The specified instances that are in different Availability Zones, where no other specified instances are protected, are successfully terminated.</p> </li> </ul> <p>For example, say you have the following instances:</p> <ul> <li> <p>Instance A: <code>us-east-1a</code>; Not protected</p> </li> <li> <p>Instance B: <code>us-east-1a</code>; Not protected</p> </li> <li> <p>Instance C: <code>us-east-1b</code>; Protected</p> </li> <li> <p>Instance D: <code>us-east-1b</code>; not protected</p> </li> </ul> <p>If you attempt to terminate all of these instances in the same request, the request reports failure with the following results:</p> <ul> <li> <p>Instance A and Instance B are successfully terminated because none of the specified instances in <code>us-east-1a</code> are enabled for termination protection.</p> </li> <li> <p>Instance C and Instance D fail to terminate because at least one of the specified instances in <code>us-east-1b</code> (Instance C) is enabled for termination protection.</p> </li> </ul> <p>Terminated instances remain visible after termination (for approximately one hour).</p> <p>By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running.</p> <p>You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the <code>DeleteOnTermination</code> block device mapping parameter set to <code>true</code> are automatically deleted. For more information about the differences between stopping and terminating instances, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-lifecycle.html">Instance lifecycle</a> in the <i>Amazon EC2 User Guide</i>.</p> <p>For more information about troubleshooting, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstancesShuttingDown.html">Troubleshooting terminating your instance</a> in the <i>Amazon EC2 User Guide</i>.</p> | +| `instances_Unmonitor` | `EXEC` | `InstanceId, region` | Disables detailed monitoring for a running instance. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch.html">Monitoring your instances and volumes</a> in the <i>Amazon EC2 User Guide</i>. | diff --git a/docs/aws-docs/providers/aws/ec2_api/internet_gateways/index.md b/docs/aws-docs/providers/aws/ec2_api/internet_gateways/index.md new file mode 100644 index 0000000000..8b5ea50e58 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/internet_gateways/index.md @@ -0,0 +1,41 @@ +--- +title: internet_gateways +hide_title: false +hide_table_of_contents: false +keywords: + - internet_gateways + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameinternet_gateways
TypeResource
Idaws.ec2_api.internet_gateways
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `attachmentSet` | `array` | Any VPCs attached to the internet gateway. | +| `internetGatewayId` | `string` | The ID of the internet gateway. | +| `ownerId` | `string` | The ID of the Amazon Web Services account that owns the internet gateway. | +| `tagSet` | `array` | Any tags assigned to the internet gateway. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `internet_gateways_Describe` | `SELECT` | `region` | Describes one or more of your internet gateways. | +| `internet_gateway_Create` | `INSERT` | `region` | <p>Creates an internet gateway for use with a VPC. After creating the internet gateway, you attach it to a VPC using <a>AttachInternetGateway</a>.</p> <p>For more information about your VPC and internet gateway, see the <a href="https://docs.aws.amazon.com/vpc/latest/userguide/">Amazon Virtual Private Cloud User Guide</a>.</p> | +| `internet_gateway_Delete` | `DELETE` | `InternetGatewayId, region` | Deletes the specified internet gateway. You must detach the internet gateway from the VPC before you can delete it. | +| `internet_gateway_Attach` | `EXEC` | `InternetGatewayId, VpcId, region` | Attaches an internet gateway or a virtual private gateway to a VPC, enabling connectivity between the internet and the VPC. For more information about your VPC and internet gateway, see the <a href="https://docs.aws.amazon.com/vpc/latest/userguide/">Amazon Virtual Private Cloud User Guide</a>. | +| `internet_gateway_Detach` | `EXEC` | `InternetGatewayId, VpcId, region` | Detaches an internet gateway from a VPC, disabling connectivity between the internet and the VPC. The VPC must not contain any running instances with Elastic IP addresses or public IPv4 addresses. | diff --git a/docs/aws-docs/providers/aws/ec2_api/ipam_address_history/index.md b/docs/aws-docs/providers/aws/ec2_api/ipam_address_history/index.md new file mode 100644 index 0000000000..563edae19d --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/ipam_address_history/index.md @@ -0,0 +1,44 @@ +--- +title: ipam_address_history +hide_title: false +hide_table_of_contents: false +keywords: + - ipam_address_history + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameipam_address_history
TypeResource
Idaws.ec2_api.ipam_address_history
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `resourceCidr` | `string` | The CIDR of the resource. | +| `resourceComplianceStatus` | `string` | The compliance status of a resource. For more information on compliance statuses, see <a href="/vpc/latest/ipam/monitor-cidr-compliance-ipam.html">Monitor CIDR usage by resource</a> in the <i>Amazon VPC IPAM User Guide</i>. | +| `resourceId` | `string` | The ID of the resource. | +| `resourceName` | `string` | The name of the resource. | +| `resourceOverlapStatus` | `string` | The overlap status of an IPAM resource. The overlap status tells you if the CIDR for a resource overlaps with another CIDR in the scope. For more information on overlap statuses, see <a href="/vpc/latest/ipam/monitor-cidr-compliance-ipam.html">Monitor CIDR usage by resource</a> in the <i>Amazon VPC IPAM User Guide</i>. | +| `resourceOwnerId` | `string` | The ID of the resource owner. | +| `resourceRegion` | `string` | The Amazon Web Services Region of the resource. | +| `resourceType` | `string` | The type of the resource. | +| `sampledEndTime` | `string` | Sampled end time of the resource-to-CIDR association within the IPAM scope. Changes are picked up in periodic snapshots, so the end time may have occurred before this specific time. | +| `sampledStartTime` | `string` | Sampled start time of the resource-to-CIDR association within the IPAM scope. Changes are picked up in periodic snapshots, so the start time may have occurred before this specific time. | +| `vpcId` | `string` | The VPC ID of the resource. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `ipam_address_history_Get` | `SELECT` | `Cidr, IpamScopeId, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/ipam_organization_admin_account/index.md b/docs/aws-docs/providers/aws/ec2_api/ipam_organization_admin_account/index.md new file mode 100644 index 0000000000..4c2f82ceb2 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/ipam_organization_admin_account/index.md @@ -0,0 +1,33 @@ +--- +title: ipam_organization_admin_account +hide_title: false +hide_table_of_contents: false +keywords: + - ipam_organization_admin_account + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameipam_organization_admin_account
TypeResource
Idaws.ec2_api.ipam_organization_admin_account
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `ipam_organization_admin_account_Disable` | `EXEC` | `DelegatedAdminAccountId, region` | Disable the IPAM account. For more information, see <a href="/vpc/latest/ipam/enable-integ-ipam.html">Enable integration with Organizations</a> in the <i>Amazon VPC IPAM User Guide</i>. | +| `ipam_organization_admin_account_Enable` | `EXEC` | `DelegatedAdminAccountId, region` | Enable an Organizations member account as the IPAM admin account. You cannot select the Organizations management account as the IPAM admin account. For more information, see <a href="/vpc/latest/ipam/enable-integ-ipam.html">Enable integration with Organizations</a> in the <i>Amazon VPC IPAM User Guide</i>. | diff --git a/docs/aws-docs/providers/aws/ec2_api/ipam_pool_allocations/index.md b/docs/aws-docs/providers/aws/ec2_api/ipam_pool_allocations/index.md new file mode 100644 index 0000000000..3f701a57da --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/ipam_pool_allocations/index.md @@ -0,0 +1,41 @@ +--- +title: ipam_pool_allocations +hide_title: false +hide_table_of_contents: false +keywords: + - ipam_pool_allocations + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameipam_pool_allocations
TypeResource
Idaws.ec2_api.ipam_pool_allocations
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `description` | `string` | A description of the pool allocation. | +| `cidr` | `string` | The CIDR for the allocation. A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is <code>10.24.34.0/23</code>. An IPv6 CIDR example is <code>2001:DB8::/32</code>. | +| `ipamPoolAllocationId` | `string` | The ID of an allocation. | +| `resourceId` | `string` | The ID of the resource. | +| `resourceOwner` | `string` | The owner of the resource. | +| `resourceRegion` | `string` | The Amazon Web Services Region of the resource. | +| `resourceType` | `string` | The type of the resource. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `ipam_pool_allocations_Get` | `SELECT` | `IpamPoolId, region` | Get a list of all the CIDR allocations in an IPAM pool. | +| `ipam_pool_allocation_Release` | `EXEC` | `Cidr, IpamPoolAllocationId, IpamPoolId, region` | Release an allocation within an IPAM pool. You can only use this action to release manual allocations. To remove an allocation for a resource without deleting the resource, set its monitored state to false using <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyIpamResourceCidr.html">ModifyIpamResourceCidr</a>. For more information, see <a href="/vpc/latest/ipam/release-pool-alloc-ipam.html">Release an allocation</a> in the <i>Amazon VPC IPAM User Guide</i>. | diff --git a/docs/aws-docs/providers/aws/ec2_api/ipam_pool_cidrs/index.md b/docs/aws-docs/providers/aws/ec2_api/ipam_pool_cidrs/index.md new file mode 100644 index 0000000000..eabdb7260e --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/ipam_pool_cidrs/index.md @@ -0,0 +1,39 @@ +--- +title: ipam_pool_cidrs +hide_title: false +hide_table_of_contents: false +keywords: + - ipam_pool_cidrs + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameipam_pool_cidrs
TypeResource
Idaws.ec2_api.ipam_pool_cidrs
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `cidr` | `string` | The CIDR provisioned to the IPAM pool. A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is <code>10.24.34.0/23</code>. An IPv6 CIDR example is <code>2001:DB8::/32</code>. | +| `failureReason` | `object` | Details related to why an IPAM pool CIDR failed to be provisioned. | +| `state` | `string` | The state of the CIDR. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `ipam_pool_cidrs_Get` | `SELECT` | `IpamPoolId, region` | Get the CIDRs provisioned to an IPAM pool. | +| `ipam_pool_cidr_Allocate` | `EXEC` | `IpamPoolId, region` | Allocate a CIDR from an IPAM pool. In IPAM, an allocation is a CIDR assignment from an IPAM pool to another resource or IPAM pool. For more information, see <a href="/vpc/latest/ipam/allocate-cidrs-ipam.html">Allocate CIDRs</a> in the <i>Amazon VPC IPAM User Guide</i>. | +| `ipam_pool_cidr_Deprovision` | `EXEC` | `IpamPoolId, region` | Deprovision a CIDR provisioned from an IPAM pool. If you deprovision a CIDR from a pool that has a source pool, the CIDR is recycled back into the source pool. For more information, see <a href="/vpc/latest/ipam/depro-pool-cidr-ipam.html">Deprovision pool CIDRs</a> in the <i>Amazon VPC IPAM User Guide</i>. | +| `ipam_pool_cidr_Provision` | `EXEC` | `IpamPoolId, region` | <p>Provision a CIDR to an IPAM pool. You can use this action to provision new CIDRs to a top-level pool or to transfer a CIDR from a top-level pool to a pool within it.</p> <p>For more information, see <a href="/vpc/latest/ipam/prov-cidr-ipam.html">Provision CIDRs to pools</a> in the <i>Amazon VPC IPAM User Guide</i>. </p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/ipam_pools/index.md b/docs/aws-docs/providers/aws/ec2_api/ipam_pools/index.md new file mode 100644 index 0000000000..5357d2e318 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/ipam_pools/index.md @@ -0,0 +1,58 @@ +--- +title: ipam_pools +hide_title: false +hide_table_of_contents: false +keywords: + - ipam_pools + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameipam_pools
TypeResource
Idaws.ec2_api.ipam_pools
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `description` | `string` | The description of the IPAM pool. | +| `addressFamily` | `string` | The address family of the pool. | +| `allocationDefaultNetmaskLength` | `integer` | The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16. | +| `allocationMaxNetmaskLength` | `integer` | The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. | +| `allocationMinNetmaskLength` | `integer` | The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. | +| `allocationResourceTagSet` | `array` | Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant. | +| `autoImport` | `boolean` | <p>If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only. </p> <p>A locale must be set on the pool for this feature to work.</p> | +| `awsService` | `string` | Limits which service in Amazon Web Services that the pool can be used in. "ec2", for example, allows users to use space for Elastic IP addresses and VPCs. | +| `ipamArn` | `string` | The ARN of the IPAM. | +| `ipamPoolArn` | `string` | The ARN of the IPAM pool. | +| `ipamPoolId` | `string` | The ID of the IPAM pool. | +| `ipamRegion` | `string` | The Amazon Web Services Region of the IPAM pool. | +| `ipamScopeArn` | `string` | The ARN of the scope of the IPAM pool. | +| `ipamScopeType` | `string` | In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict. | +| `locale` | `string` | The locale of the IPAM pool. In IPAM, the locale is the Amazon Web Services Region where you want to make an IPAM pool available for allocations. Only resources in the same Region as the locale of the pool can get IP address allocations from the pool. You can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region. Note that once you choose a Locale for a pool, you cannot modify it. If you choose an Amazon Web Services Region for locale that has not been configured as an operating Region for the IPAM, you'll get an error. | +| `ownerId` | `string` | The Amazon Web Services account ID of the owner of the IPAM pool. | +| `poolDepth` | `integer` | The depth of pools in your IPAM pool. The pool depth quota is 10. For more information, see <a href="/vpc/latest/ipam/quotas-ipam.html">Quotas in IPAM</a> in the <i>Amazon VPC IPAM User Guide</i>. | +| `publiclyAdvertisable` | `boolean` | Determines if a pool is publicly advertisable. This option is not available for pools with AddressFamily set to <code>ipv4</code>. | +| `sourceIpamPoolId` | `string` | The ID of the source IPAM pool. You can use this option to create an IPAM pool within an existing source pool. | +| `state` | `string` | The state of the IPAM pool. | +| `stateMessage` | `string` | A message related to the failed creation of an IPAM pool. | +| `tagSet` | `array` | The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key <code>Owner</code> and the value <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter value. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `ipam_pools_Describe` | `SELECT` | `region` | Get information about your IPAM pools. | +| `ipam_pool_Create` | `INSERT` | `AddressFamily, IpamScopeId, region` | <p>Create an IP address pool for Amazon VPC IP Address Manager (IPAM). In IPAM, a pool is a collection of contiguous IP addresses CIDRs. Pools enable you to organize your IP addresses according to your routing and security needs. For example, if you have separate routing and security needs for development and production applications, you can create a pool for each.</p> <p>For more information, see <a href="/vpc/latest/ipam/create-top-ipam.html">Create a top-level pool</a> in the <i>Amazon VPC IPAM User Guide</i>. </p> | +| `ipam_pool_Delete` | `DELETE` | `IpamPoolId, region` | <p>Delete an IPAM pool.</p> <note> <p>You cannot delete an IPAM pool if there are allocations in it or CIDRs provisioned to it. To release allocations, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ReleaseIpamPoolAllocation.html">ReleaseIpamPoolAllocation</a>. To deprovision pool CIDRs, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeprovisionIpamPoolCidr.html">DeprovisionIpamPoolCidr</a>.</p> </note> <p>For more information, see <a href="/vpc/latest/ipam/delete-pool-ipam.html">Delete a pool</a> in the <i>Amazon VPC IPAM User Guide</i>. </p> | +| `ipam_pool_Modify` | `EXEC` | `IpamPoolId, region` | <p>Modify the configurations of an IPAM pool.</p> <p>For more information, see <a href="/vpc/latest/ipam/mod-pool-ipam.html">Modify a pool</a> in the <i>Amazon VPC IPAM User Guide</i>. </p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/ipam_resource_cidrs/index.md b/docs/aws-docs/providers/aws/ec2_api/ipam_resource_cidrs/index.md new file mode 100644 index 0000000000..2d15f57af6 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/ipam_resource_cidrs/index.md @@ -0,0 +1,49 @@ +--- +title: ipam_resource_cidrs +hide_title: false +hide_table_of_contents: false +keywords: + - ipam_resource_cidrs + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameipam_resource_cidrs
TypeResource
Idaws.ec2_api.ipam_resource_cidrs
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `complianceStatus` | `string` | The compliance status of the IPAM resource. For more information on compliance statuses, see <a href="/vpc/latest/ipam/monitor-cidr-compliance-ipam.html">Monitor CIDR usage by resource</a> in the <i>Amazon VPC IPAM User Guide</i>. | +| `ipUsage` | `number` | The IP address space in the IPAM pool that is allocated to this resource. To convert the decimal to a percentage, multiply the decimal by 100. | +| `ipamId` | `string` | The IPAM ID for an IPAM resource. | +| `ipamPoolId` | `string` | The pool ID for an IPAM resource. | +| `ipamScopeId` | `string` | The scope ID for an IPAM resource. | +| `managementState` | `string` | The management state of the resource. For more information about management states, see <a href="/vpc/latest/ipam/monitor-cidr-compliance-ipam.html">Monitor CIDR usage by resource</a> in the <i>Amazon VPC IPAM User Guide</i>. | +| `overlapStatus` | `string` | The overlap status of an IPAM resource. The overlap status tells you if the CIDR for a resource overlaps with another CIDR in the scope. For more information on overlap statuses, see <a href="/vpc/latest/ipam/monitor-cidr-compliance-ipam.html">Monitor CIDR usage by resource</a> in the <i>Amazon VPC IPAM User Guide</i>. | +| `resourceCidr` | `string` | The CIDR for an IPAM resource. | +| `resourceId` | `string` | The ID of an IPAM resource. | +| `resourceName` | `string` | The name of an IPAM resource. | +| `resourceOwnerId` | `string` | The Amazon Web Services account number of the owner of an IPAM resource. | +| `resourceRegion` | `string` | The Amazon Web Services Region for an IPAM resource. | +| `resourceTagSet` | `array` | The tags for an IPAM resource. | +| `resourceType` | `string` | The type of IPAM resource. | +| `vpcId` | `string` | The ID of a VPC. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `ipam_resource_cidrs_Get` | `SELECT` | `IpamScopeId, region` | Get information about the resources in a scope. | +| `ipam_resource_cidr_Modify` | `EXEC` | `CurrentIpamScopeId, Monitored, ResourceCidr, ResourceId, ResourceRegion, region` | <p>Modify a resource CIDR. You can use this action to transfer resource CIDRs between scopes and ignore resource CIDRs that you do not want to manage. If set to false, the resource will not be tracked for overlap, it cannot be auto-imported into a pool, and it will be removed from any pool it has an allocation in.</p> <p>For more information, see <a href="/vpc/latest/ipam/move-resource-ipam.html">Move resource CIDRs between scopes</a> and <a href="/vpc/latest/ipam/change-monitoring-state-ipam.html">Change the monitoring state of resource CIDRs</a> in the <i>Amazon VPC IPAM User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/ipam_scopes/index.md b/docs/aws-docs/providers/aws/ec2_api/ipam_scopes/index.md new file mode 100644 index 0000000000..5806873986 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/ipam_scopes/index.md @@ -0,0 +1,47 @@ +--- +title: ipam_scopes +hide_title: false +hide_table_of_contents: false +keywords: + - ipam_scopes + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameipam_scopes
TypeResource
Idaws.ec2_api.ipam_scopes
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `description` | `string` | The description of the scope. | +| `ipamArn` | `string` | The ARN of the IPAM. | +| `ipamRegion` | `string` | The Amazon Web Services Region of the IPAM scope. | +| `ipamScopeArn` | `string` | The ARN of the scope. | +| `ipamScopeId` | `string` | The ID of the scope. | +| `ipamScopeType` | `string` | The type of the scope. | +| `isDefault` | `boolean` | Defines if the scope is the default scope or not. | +| `ownerId` | `string` | The Amazon Web Services account ID of the owner of the scope. | +| `poolCount` | `integer` | The number of pools in the scope. | +| `state` | `string` | The state of the IPAM scope. | +| `tagSet` | `array` | The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key <code>Owner</code> and the value <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter value. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `ipam_scopes_Describe` | `SELECT` | `region` | Get information about your IPAM scopes. | +| `ipam_scope_Create` | `INSERT` | `IpamId, region` | <p>Create an IPAM scope. In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.</p> <p>For more information, see <a href="/vpc/latest/ipam/add-scope-ipam.html">Add a scope</a> in the <i>Amazon VPC IPAM User Guide</i>.</p> | +| `ipam_scope_Delete` | `DELETE` | `IpamScopeId, region` | <p>Delete the scope for an IPAM. You cannot delete the default scopes.</p> <p>For more information, see <a href="/vpc/latest/ipam/delete-scope-ipam.html">Delete a scope</a> in the <i>Amazon VPC IPAM User Guide</i>. </p> | +| `ipam_scope_Modify` | `EXEC` | `IpamScopeId, region` | Modify an IPAM scope. | diff --git a/docs/aws-docs/providers/aws/ec2_api/ipams/index.md b/docs/aws-docs/providers/aws/ec2_api/ipams/index.md new file mode 100644 index 0000000000..7f495203fc --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/ipams/index.md @@ -0,0 +1,47 @@ +--- +title: ipams +hide_title: false +hide_table_of_contents: false +keywords: + - ipams + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameipams
TypeResource
Idaws.ec2_api.ipams
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `description` | `string` | The description for the IPAM. | +| `ipamArn` | `string` | The ARN of the IPAM. | +| `ipamId` | `string` | The ID of the IPAM. | +| `ipamRegion` | `string` | The Amazon Web Services Region of the IPAM. | +| `operatingRegionSet` | `array` | <p>The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.</p> <p>For more information about operating Regions, see <a href="/vpc/latest/ipam/create-ipam.html">Create an IPAM</a> in the <i>Amazon VPC IPAM User Guide</i>.</p> | +| `ownerId` | `string` | The Amazon Web Services account ID of the owner of the IPAM. | +| `privateDefaultScopeId` | `string` | The ID of the IPAM's default private scope. | +| `publicDefaultScopeId` | `string` | The ID of the IPAM's default public scope. | +| `scopeCount` | `integer` | The number of scopes in the IPAM. The scope quota is 5. For more information on quotas, see <a href="/vpc/latest/ipam/quotas-ipam.html">Quotas in IPAM</a> in the <i>Amazon VPC IPAM User Guide</i>. | +| `state` | `string` | The state of the IPAM. | +| `tagSet` | `array` | The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key <code>Owner</code> and the value <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter value. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `ipams_Describe` | `SELECT` | `region` | <p>Get information about your IPAM pools.</p> <p>For more information, see <a href="/vpc/latest/ipam/what-is-it-ipam.html">What is IPAM?</a> in the <i>Amazon VPC IPAM User Guide</i>. </p> | +| `ipam_Create` | `INSERT` | `region` | <p>Create an IPAM. Amazon VPC IP Address Manager (IPAM) is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization.</p> <p>For more information, see <a href="/vpc/latest/ipam/create-ipam.html">Create an IPAM</a> in the <i>Amazon VPC IPAM User Guide</i>. </p> | +| `ipam_Delete` | `DELETE` | `IpamId, region` | <p>Delete an IPAM. Deleting an IPAM removes all monitored data associated with the IPAM including the historical data for CIDRs.</p> <p>For more information, see <a href="/vpc/latest/ipam/delete-ipam.html">Delete an IPAM</a> in the <i>Amazon VPC IPAM User Guide</i>. </p> | +| `ipam_Modify` | `EXEC` | `IpamId, region` | Modify the configurations of an IPAM. | diff --git a/docs/aws-docs/providers/aws/ec2_api/ipv6_addresses/index.md b/docs/aws-docs/providers/aws/ec2_api/ipv6_addresses/index.md new file mode 100644 index 0000000000..4f0fb7acfc --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/ipv6_addresses/index.md @@ -0,0 +1,33 @@ +--- +title: ipv6_addresses +hide_title: false +hide_table_of_contents: false +keywords: + - ipv6_addresses + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameipv6_addresses
TypeResource
Idaws.ec2_api.ipv6_addresses
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `ipv6_addresses_Assign` | `EXEC` | `NetworkInterfaceId, region` | <p>Assigns one or more IPv6 addresses to the specified network interface. You can specify one or more specific IPv6 addresses, or you can specify the number of IPv6 addresses to be automatically assigned from within the subnet's IPv6 CIDR block range. You can assign as many IPv6 addresses to a network interface as you can assign private IPv4 addresses, and the limit varies per instance type. For information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html#AvailableIpPerENI">IP Addresses Per Network Interface Per Instance Type</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>You must specify either the IPv6 addresses or the IPv6 address count in the request. </p> <p>You can optionally use Prefix Delegation on the network interface. You must specify either the IPV6 Prefix Delegation prefixes, or the IPv6 Prefix Delegation count. For information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-prefix-eni.html"> Assigning prefixes to Amazon EC2 network interfaces</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | +| `ipv6_addresses_Unassign` | `EXEC` | `NetworkInterfaceId, region` | Unassigns one or more IPv6 addresses IPv4 Prefix Delegation prefixes from a network interface. | diff --git a/docs/aws-docs/providers/aws/ec2_api/ipv6_pools/index.md b/docs/aws-docs/providers/aws/ec2_api/ipv6_pools/index.md new file mode 100644 index 0000000000..ca3de995f5 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/ipv6_pools/index.md @@ -0,0 +1,37 @@ +--- +title: ipv6_pools +hide_title: false +hide_table_of_contents: false +keywords: + - ipv6_pools + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameipv6_pools
TypeResource
Idaws.ec2_api.ipv6_pools
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `description` | `string` | The description for the address pool. | +| `poolCidrBlockSet` | `array` | The CIDR blocks for the address pool. | +| `poolId` | `string` | The ID of the address pool. | +| `tagSet` | `array` | Any tags for the address pool. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `ipv6_pools_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/key_pairs/index.md b/docs/aws-docs/providers/aws/ec2_api/key_pairs/index.md new file mode 100644 index 0000000000..65feafe433 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/key_pairs/index.md @@ -0,0 +1,34 @@ +--- +title: key_pairs +hide_title: false +hide_table_of_contents: false +keywords: + - key_pairs + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namekey_pairs
TypeResource
Idaws.ec2_api.key_pairs
+ +## Fields +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `key_pairs_Describe` | `SELECT` | `region` | <p>Describes the specified key pairs or all of your key pairs.</p> <p>For more information about key pairs, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html">Amazon EC2 key pairs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | +| `key_pair_Create` | `INSERT` | `KeyName, region` | <p>Creates an ED25519 or 2048-bit RSA key pair with the specified name and in the specified PEM or PPK format. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#1 private key or an unencrypted PPK formatted private key for use with PuTTY. If a key with the specified name already exists, Amazon EC2 returns an error.</p> <p>The key pair returned to you is available only in the Amazon Web Services Region in which you create it. If you prefer, you can create your own key pair using a third-party tool and upload it to any Region using <a>ImportKeyPair</a>.</p> <p>You can have up to 5,000 key pairs per Amazon Web Services Region.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html">Amazon EC2 key pairs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | +| `key_pair_Delete` | `DELETE` | `region` | Deletes the specified key pair, by removing the public key from Amazon EC2. | +| `key_pair_Import` | `EXEC` | `KeyName, PublicKeyMaterial, region` | <p>Imports the public key from an RSA or ED25519 key pair that you created with a third-party tool. Compare this with <a>CreateKeyPair</a>, in which Amazon Web Services creates the key pair and gives the keys to you (Amazon Web Services keeps a copy of the public key). With ImportKeyPair, you create the key pair and give Amazon Web Services just the public key. The private key is never transferred between you and Amazon Web Services.</p> <p>For more information about key pairs, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html">Amazon EC2 key pairs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/launch_template_data/index.md b/docs/aws-docs/providers/aws/ec2_api/launch_template_data/index.md new file mode 100644 index 0000000000..468ca3dedd --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/launch_template_data/index.md @@ -0,0 +1,31 @@ +--- +title: launch_template_data +hide_title: false +hide_table_of_contents: false +keywords: + - launch_template_data + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namelaunch_template_data
TypeResource
Idaws.ec2_api.launch_template_data
+ +## Fields +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `launch_template_data_Get` | `SELECT` | `InstanceId, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/launch_template_versions/index.md b/docs/aws-docs/providers/aws/ec2_api/launch_template_versions/index.md new file mode 100644 index 0000000000..bd3c2f640c --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/launch_template_versions/index.md @@ -0,0 +1,43 @@ +--- +title: launch_template_versions +hide_title: false +hide_table_of_contents: false +keywords: + - launch_template_versions + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namelaunch_template_versions
TypeResource
Idaws.ec2_api.launch_template_versions
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `createTime` | `string` | The time the version was created. | +| `createdBy` | `string` | The principal that created the version. | +| `defaultVersion` | `boolean` | Indicates whether the version is the default version. | +| `launchTemplateData` | `object` | The information for a launch template. | +| `launchTemplateId` | `string` | The ID of the launch template. | +| `launchTemplateName` | `string` | The name of the launch template. | +| `versionDescription` | `string` | The description for the version. | +| `versionNumber` | `integer` | The version number. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `launch_template_versions_Describe` | `SELECT` | `region` | Describes one or more versions of a specified launch template. You can describe all versions, individual versions, or a range of versions. You can also describe all the latest versions or all the default versions of all the launch templates in your account. | +| `launch_template_version_Create` | `INSERT` | `LaunchTemplateData, region` | <p>Creates a new version for a launch template. You can specify an existing version of launch template from which to base the new version.</p> <p>Launch template versions are numbered in the order in which they are created. You cannot specify, change, or replace the numbering of launch template versions.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#manage-launch-template-versions">Managing launch template versions</a>in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | +| `launch_template_versions_Delete` | `DELETE` | `LaunchTemplateVersion, region` | Deletes one or more versions of a launch template. You cannot delete the default version of a launch template; you must first assign a different version as the default. If the default version is the only version for the launch template, you must delete the entire launch template using <a>DeleteLaunchTemplate</a>. | diff --git a/docs/aws-docs/providers/aws/ec2_api/launch_templates/index.md b/docs/aws-docs/providers/aws/ec2_api/launch_templates/index.md new file mode 100644 index 0000000000..45a538a78a --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/launch_templates/index.md @@ -0,0 +1,43 @@ +--- +title: launch_templates +hide_title: false +hide_table_of_contents: false +keywords: + - launch_templates + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namelaunch_templates
TypeResource
Idaws.ec2_api.launch_templates
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `createTime` | `string` | The time launch template was created. | +| `createdBy` | `string` | The principal that created the launch template. | +| `defaultVersionNumber` | `integer` | The version number of the default version of the launch template. | +| `latestVersionNumber` | `integer` | The version number of the latest version of the launch template. | +| `launchTemplateId` | `string` | The ID of the launch template. | +| `launchTemplateName` | `string` | The name of the launch template. | +| `tagSet` | `array` | The tags for the launch template. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `launch_templates_Describe` | `SELECT` | `region` | Describes one or more launch templates. | +| `launch_template_Create` | `INSERT` | `LaunchTemplateData, LaunchTemplateName, region` | <p>Creates a launch template.</p> <p>A launch template contains the parameters to launch an instance. When you launch an instance using <a>RunInstances</a>, you can specify a launch template instead of providing the launch parameters in the request. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html">Launching an instance from a launch template</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>If you want to clone an existing launch template as the basis for creating a new launch template, you can use the Amazon EC2 console. The API, SDKs, and CLI do not support cloning a template. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#create-launch-template-from-existing-launch-template">Create a launch template from an existing launch template</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | +| `launch_template_Delete` | `DELETE` | `region` | Deletes a launch template. Deleting a launch template deletes all of its versions. | +| `launch_template_Modify` | `EXEC` | `region` | Modifies a launch template. You can specify which version of the launch template to set as the default version. When launching an instance, the default version applies when a launch template version is not specified. | diff --git a/docs/aws-docs/providers/aws/ec2_api/local_gateway_route_table_virtual_interface_group_associations/index.md b/docs/aws-docs/providers/aws/ec2_api/local_gateway_route_table_virtual_interface_group_associations/index.md new file mode 100644 index 0000000000..f37a73391b --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/local_gateway_route_table_virtual_interface_group_associations/index.md @@ -0,0 +1,41 @@ +--- +title: local_gateway_route_table_virtual_interface_group_associations +hide_title: false +hide_table_of_contents: false +keywords: + - local_gateway_route_table_virtual_interface_group_associations + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namelocal_gateway_route_table_virtual_interface_group_associations
TypeResource
Idaws.ec2_api.local_gateway_route_table_virtual_interface_group_associations
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `localGatewayId` | `string` | The ID of the local gateway. | +| `localGatewayRouteTableArn` | `string` | The Amazon Resource Name (ARN) of the local gateway route table for the virtual interface group. | +| `localGatewayRouteTableId` | `string` | The ID of the local gateway route table. | +| `localGatewayRouteTableVirtualInterfaceGroupAssociationId` | `string` | The ID of the association. | +| `localGatewayVirtualInterfaceGroupId` | `string` | The ID of the virtual interface group. | +| `ownerId` | `string` | The ID of the Amazon Web Services account that owns the local gateway virtual interface group association. | +| `state` | `string` | The state of the association. | +| `tagSet` | `array` | The tags assigned to the association. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `local_gateway_route_table_virtual_interface_group_associations_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/local_gateway_route_table_vpc_associations/index.md b/docs/aws-docs/providers/aws/ec2_api/local_gateway_route_table_vpc_associations/index.md new file mode 100644 index 0000000000..0742c40a86 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/local_gateway_route_table_vpc_associations/index.md @@ -0,0 +1,43 @@ +--- +title: local_gateway_route_table_vpc_associations +hide_title: false +hide_table_of_contents: false +keywords: + - local_gateway_route_table_vpc_associations + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namelocal_gateway_route_table_vpc_associations
TypeResource
Idaws.ec2_api.local_gateway_route_table_vpc_associations
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `localGatewayId` | `string` | The ID of the local gateway. | +| `localGatewayRouteTableArn` | `string` | The Amazon Resource Name (ARN) of the local gateway route table for the association. | +| `localGatewayRouteTableId` | `string` | The ID of the local gateway route table. | +| `localGatewayRouteTableVpcAssociationId` | `string` | The ID of the association. | +| `ownerId` | `string` | The ID of the Amazon Web Services account that owns the local gateway route table for the association. | +| `state` | `string` | The state of the association. | +| `tagSet` | `array` | The tags assigned to the association. | +| `vpcId` | `string` | The ID of the VPC. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `local_gateway_route_table_vpc_associations_Describe` | `SELECT` | `region` | Describes the specified associations between VPCs and local gateway route tables. | +| `local_gateway_route_table_vpc_association_Create` | `INSERT` | `LocalGatewayRouteTableId, VpcId, region` | Associates the specified VPC with the specified local gateway route table. | +| `local_gateway_route_table_vpc_association_Delete` | `DELETE` | `LocalGatewayRouteTableVpcAssociationId, region` | Deletes the specified association between a VPC and local gateway route table. | diff --git a/docs/aws-docs/providers/aws/ec2_api/local_gateway_route_tables/index.md b/docs/aws-docs/providers/aws/ec2_api/local_gateway_route_tables/index.md new file mode 100644 index 0000000000..0acddfe23d --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/local_gateway_route_tables/index.md @@ -0,0 +1,40 @@ +--- +title: local_gateway_route_tables +hide_title: false +hide_table_of_contents: false +keywords: + - local_gateway_route_tables + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namelocal_gateway_route_tables
TypeResource
Idaws.ec2_api.local_gateway_route_tables
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `localGatewayId` | `string` | The ID of the local gateway. | +| `localGatewayRouteTableArn` | `string` | The Amazon Resource Name (ARN) of the local gateway route table. | +| `localGatewayRouteTableId` | `string` | The ID of the local gateway route table. | +| `outpostArn` | `string` | The Amazon Resource Name (ARN) of the Outpost. | +| `ownerId` | `string` | The ID of the Amazon Web Services account that owns the local gateway route table. | +| `state` | `string` | The state of the local gateway route table. | +| `tagSet` | `array` | The tags assigned to the local gateway route table. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `local_gateway_route_tables_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/local_gateway_routes/index.md b/docs/aws-docs/providers/aws/ec2_api/local_gateway_routes/index.md new file mode 100644 index 0000000000..6214ddc9b4 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/local_gateway_routes/index.md @@ -0,0 +1,34 @@ +--- +title: local_gateway_routes +hide_title: false +hide_table_of_contents: false +keywords: + - local_gateway_routes + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namelocal_gateway_routes
TypeResource
Idaws.ec2_api.local_gateway_routes
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `local_gateway_route_Create` | `INSERT` | `DestinationCidrBlock, LocalGatewayRouteTableId, LocalGatewayVirtualInterfaceGroupId, region` | Creates a static route for the specified local gateway route table. | +| `local_gateway_route_Delete` | `DELETE` | `DestinationCidrBlock, LocalGatewayRouteTableId, region` | Deletes the specified route from the specified local gateway route table. | +| `local_gateway_routes_Search` | `EXEC` | `LocalGatewayRouteTableId, region` | Searches for routes in the specified local gateway route table. | diff --git a/docs/aws-docs/providers/aws/ec2_api/local_gateway_virtual_interface_groups/index.md b/docs/aws-docs/providers/aws/ec2_api/local_gateway_virtual_interface_groups/index.md new file mode 100644 index 0000000000..5d0d9035dd --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/local_gateway_virtual_interface_groups/index.md @@ -0,0 +1,38 @@ +--- +title: local_gateway_virtual_interface_groups +hide_title: false +hide_table_of_contents: false +keywords: + - local_gateway_virtual_interface_groups + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namelocal_gateway_virtual_interface_groups
TypeResource
Idaws.ec2_api.local_gateway_virtual_interface_groups
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `localGatewayId` | `string` | The ID of the local gateway. | +| `localGatewayVirtualInterfaceGroupId` | `string` | The ID of the virtual interface group. | +| `localGatewayVirtualInterfaceIdSet` | `array` | The IDs of the virtual interfaces. | +| `ownerId` | `string` | The ID of the Amazon Web Services account that owns the local gateway virtual interface group. | +| `tagSet` | `array` | The tags assigned to the virtual interface group. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `local_gateway_virtual_interface_groups_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/local_gateway_virtual_interfaces/index.md b/docs/aws-docs/providers/aws/ec2_api/local_gateway_virtual_interfaces/index.md new file mode 100644 index 0000000000..412a980849 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/local_gateway_virtual_interfaces/index.md @@ -0,0 +1,42 @@ +--- +title: local_gateway_virtual_interfaces +hide_title: false +hide_table_of_contents: false +keywords: + - local_gateway_virtual_interfaces + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namelocal_gateway_virtual_interfaces
TypeResource
Idaws.ec2_api.local_gateway_virtual_interfaces
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `localAddress` | `string` | The local address. | +| `localBgpAsn` | `integer` | The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway. | +| `localGatewayId` | `string` | The ID of the local gateway. | +| `localGatewayVirtualInterfaceId` | `string` | The ID of the virtual interface. | +| `ownerId` | `string` | The ID of the Amazon Web Services account that owns the local gateway virtual interface. | +| `peerAddress` | `string` | The peer address. | +| `peerBgpAsn` | `integer` | The peer BGP ASN. | +| `tagSet` | `array` | The tags assigned to the virtual interface. | +| `vlan` | `integer` | The ID of the VLAN. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `local_gateway_virtual_interfaces_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/local_gateways/index.md b/docs/aws-docs/providers/aws/ec2_api/local_gateways/index.md new file mode 100644 index 0000000000..62fd767a69 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/local_gateways/index.md @@ -0,0 +1,38 @@ +--- +title: local_gateways +hide_title: false +hide_table_of_contents: false +keywords: + - local_gateways + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namelocal_gateways
TypeResource
Idaws.ec2_api.local_gateways
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `localGatewayId` | `string` | The ID of the local gateway. | +| `outpostArn` | `string` | The Amazon Resource Name (ARN) of the Outpost. | +| `ownerId` | `string` | The ID of the Amazon Web Services account that owns the local gateway. | +| `state` | `string` | The state of the local gateway. | +| `tagSet` | `array` | The tags assigned to the local gateway. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `local_gateways_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/managed_prefix_list_associations/index.md b/docs/aws-docs/providers/aws/ec2_api/managed_prefix_list_associations/index.md new file mode 100644 index 0000000000..293bd0b8fd --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/managed_prefix_list_associations/index.md @@ -0,0 +1,35 @@ +--- +title: managed_prefix_list_associations +hide_title: false +hide_table_of_contents: false +keywords: + - managed_prefix_list_associations + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namemanaged_prefix_list_associations
TypeResource
Idaws.ec2_api.managed_prefix_list_associations
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `resourceId` | `string` | The ID of the resource. | +| `resourceOwner` | `string` | The owner of the resource. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `managed_prefix_list_associations_Get` | `SELECT` | `PrefixListId, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/managed_prefix_list_entries/index.md b/docs/aws-docs/providers/aws/ec2_api/managed_prefix_list_entries/index.md new file mode 100644 index 0000000000..bdc3f15e33 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/managed_prefix_list_entries/index.md @@ -0,0 +1,35 @@ +--- +title: managed_prefix_list_entries +hide_title: false +hide_table_of_contents: false +keywords: + - managed_prefix_list_entries + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namemanaged_prefix_list_entries
TypeResource
Idaws.ec2_api.managed_prefix_list_entries
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `description` | `string` | The description. | +| `cidr` | `string` | The CIDR block. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `managed_prefix_list_entries_Get` | `SELECT` | `PrefixListId, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/managed_prefix_list_version/index.md b/docs/aws-docs/providers/aws/ec2_api/managed_prefix_list_version/index.md new file mode 100644 index 0000000000..f988b72477 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/managed_prefix_list_version/index.md @@ -0,0 +1,32 @@ +--- +title: managed_prefix_list_version +hide_title: false +hide_table_of_contents: false +keywords: + - managed_prefix_list_version + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namemanaged_prefix_list_version
TypeResource
Idaws.ec2_api.managed_prefix_list_version
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `managed_prefix_list_version_Restore` | `EXEC` | `CurrentVersion, PrefixListId, PreviousVersion, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/managed_prefix_lists/index.md b/docs/aws-docs/providers/aws/ec2_api/managed_prefix_lists/index.md new file mode 100644 index 0000000000..115da787db --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/managed_prefix_lists/index.md @@ -0,0 +1,46 @@ +--- +title: managed_prefix_lists +hide_title: false +hide_table_of_contents: false +keywords: + - managed_prefix_lists + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namemanaged_prefix_lists
TypeResource
Idaws.ec2_api.managed_prefix_lists
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `addressFamily` | `string` | The IP address version. | +| `maxEntries` | `integer` | The maximum number of entries for the prefix list. | +| `ownerId` | `string` | The ID of the owner of the prefix list. | +| `prefixListArn` | `string` | The Amazon Resource Name (ARN) for the prefix list. | +| `prefixListId` | `string` | The ID of the prefix list. | +| `prefixListName` | `string` | The name of the prefix list. | +| `state` | `string` | The current state of the prefix list. | +| `stateMessage` | `string` | The state message. | +| `tagSet` | `array` | The tags for the prefix list. | +| `version` | `integer` | The version of the prefix list. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `managed_prefix_lists_Describe` | `SELECT` | `region` | <p>Describes your managed prefix lists and any Amazon Web Services-managed prefix lists.</p> <p>To view the entries for your prefix list, use <a>GetManagedPrefixListEntries</a>.</p> | +| `managed_prefix_list_Create` | `INSERT` | `AddressFamily, MaxEntries, PrefixListName, region` | Creates a managed prefix list. You can specify one or more entries for the prefix list. Each entry consists of a CIDR block and an optional description. | +| `managed_prefix_list_Delete` | `DELETE` | `PrefixListId, region` | Deletes the specified managed prefix list. You must first remove all references to the prefix list in your resources. | +| `managed_prefix_list_Modify` | `EXEC` | `PrefixListId, region` | <p>Modifies the specified managed prefix list.</p> <p>Adding or removing entries in a prefix list creates a new version of the prefix list. Changing the name of the prefix list does not affect the version.</p> <p>If you specify a current version number that does not match the true current version number, the request fails.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/moving_addresses/index.md b/docs/aws-docs/providers/aws/ec2_api/moving_addresses/index.md new file mode 100644 index 0000000000..cfa90feb70 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/moving_addresses/index.md @@ -0,0 +1,35 @@ +--- +title: moving_addresses +hide_title: false +hide_table_of_contents: false +keywords: + - moving_addresses + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namemoving_addresses
TypeResource
Idaws.ec2_api.moving_addresses
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `moveStatus` | `string` | The status of the Elastic IP address that's being moved to the EC2-VPC platform, or restored to the EC2-Classic platform. | +| `publicIp` | `string` | The Elastic IP address. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `moving_addresses_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/nat_gateways/index.md b/docs/aws-docs/providers/aws/ec2_api/nat_gateways/index.md new file mode 100644 index 0000000000..b782559451 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/nat_gateways/index.md @@ -0,0 +1,47 @@ +--- +title: nat_gateways +hide_title: false +hide_table_of_contents: false +keywords: + - nat_gateways + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namenat_gateways
TypeResource
Idaws.ec2_api.nat_gateways
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `connectivityType` | `string` | Indicates whether the NAT gateway supports public or private connectivity. | +| `createTime` | `string` | The date and time the NAT gateway was created. | +| `deleteTime` | `string` | The date and time the NAT gateway was deleted, if applicable. | +| `failureCode` | `string` | If the NAT gateway could not be created, specifies the error code for the failure. (<code>InsufficientFreeAddressesInSubnet</code> \| <code>Gateway.NotAttached</code> \| <code>InvalidAllocationID.NotFound</code> \| <code>Resource.AlreadyAssociated</code> \| <code>InternalError</code> \| <code>InvalidSubnetID.NotFound</code>) | +| `failureMessage` | `string` | <p>If the NAT gateway could not be created, specifies the error message for the failure, that corresponds to the error code.</p> <ul> <li> <p>For InsufficientFreeAddressesInSubnet: "Subnet has insufficient free addresses to create this NAT gateway"</p> </li> <li> <p>For Gateway.NotAttached: "Network vpc-xxxxxxxx has no Internet gateway attached"</p> </li> <li> <p>For InvalidAllocationID.NotFound: "Elastic IP address eipalloc-xxxxxxxx could not be associated with this NAT gateway"</p> </li> <li> <p>For Resource.AlreadyAssociated: "Elastic IP address eipalloc-xxxxxxxx is already associated"</p> </li> <li> <p>For InternalError: "Network interface eni-xxxxxxxx, created and used internally by this NAT gateway is in an invalid state. Please try again."</p> </li> <li> <p>For InvalidSubnetID.NotFound: "The specified subnet subnet-xxxxxxxx does not exist or could not be found."</p> </li> </ul> | +| `natGatewayAddressSet` | `array` | Information about the IP addresses and network interface associated with the NAT gateway. | +| `natGatewayId` | `string` | The ID of the NAT gateway. | +| `provisionedBandwidth` | `object` | Reserved. If you need to sustain traffic greater than the <a href="https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html">documented limits</a>, contact us through the <a href="https://console.aws.amazon.com/support/home?">Support Center</a>. | +| `state` | `string` | <p>The state of the NAT gateway.</p> <ul> <li> <p> <code>pending</code>: The NAT gateway is being created and is not ready to process traffic.</p> </li> <li> <p> <code>failed</code>: The NAT gateway could not be created. Check the <code>failureCode</code> and <code>failureMessage</code> fields for the reason.</p> </li> <li> <p> <code>available</code>: The NAT gateway is able to process traffic. This status remains until you delete the NAT gateway, and does not indicate the health of the NAT gateway.</p> </li> <li> <p> <code>deleting</code>: The NAT gateway is in the process of being terminated and may still be processing traffic.</p> </li> <li> <p> <code>deleted</code>: The NAT gateway has been terminated and is no longer processing traffic.</p> </li> </ul> | +| `subnetId` | `string` | The ID of the subnet in which the NAT gateway is located. | +| `tagSet` | `array` | The tags for the NAT gateway. | +| `vpcId` | `string` | The ID of the VPC in which the NAT gateway is located. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `nat_gateways_Describe` | `SELECT` | `region` | Describes one or more of your NAT gateways. | +| `nat_gateway_Create` | `INSERT` | `SubnetId, region` | <p>Creates a NAT gateway in the specified subnet. This action creates a network interface in the specified subnet with a private IP address from the IP address range of the subnet. You can create either a public NAT gateway or a private NAT gateway.</p> <p>With a public NAT gateway, internet-bound traffic from a private subnet can be routed to the NAT gateway, so that instances in a private subnet can connect to the internet.</p> <p>With a private NAT gateway, private communication is routed across VPCs and on-premises networks through a transit gateway or virtual private gateway. Common use cases include running large workloads behind a small pool of allowlisted IPv4 addresses, preserving private IPv4 addresses, and communicating between overlapping networks.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html">NAT gateways</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p> | +| `nat_gateway_Delete` | `DELETE` | `NatGatewayId, region` | Deletes the specified NAT gateway. Deleting a public NAT gateway disassociates its Elastic IP address, but does not release the address from your account. Deleting a NAT gateway does not delete any NAT gateway routes in your route tables. | diff --git a/docs/aws-docs/providers/aws/ec2_api/network_acl_association/index.md b/docs/aws-docs/providers/aws/ec2_api/network_acl_association/index.md new file mode 100644 index 0000000000..b0a8989571 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/network_acl_association/index.md @@ -0,0 +1,32 @@ +--- +title: network_acl_association +hide_title: false +hide_table_of_contents: false +keywords: + - network_acl_association + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namenetwork_acl_association
TypeResource
Idaws.ec2_api.network_acl_association
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `network_acl_association_Replace` | `EXEC` | `AssociationId, NetworkAclId, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/network_acl_entry/index.md b/docs/aws-docs/providers/aws/ec2_api/network_acl_entry/index.md new file mode 100644 index 0000000000..b7ede62954 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/network_acl_entry/index.md @@ -0,0 +1,34 @@ +--- +title: network_acl_entry +hide_title: false +hide_table_of_contents: false +keywords: + - network_acl_entry + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namenetwork_acl_entry
TypeResource
Idaws.ec2_api.network_acl_entry
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `network_acl_entry_Create` | `INSERT` | `Egress, NetworkAclId, Protocol, RuleAction, RuleNumber, region` | <p>Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of ingress rules and a separate set of egress rules.</p> <p>We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules.</p> <p>After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one.</p> <p>For more information about network ACLs, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_ACLs.html">Network ACLs</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p> | +| `network_acl_entry_Delete` | `DELETE` | `Egress, NetworkAclId, RuleNumber, region` | Deletes the specified ingress or egress entry (rule) from the specified network ACL. | +| `network_acl_entry_Replace` | `EXEC` | `Egress, NetworkAclId, Protocol, RuleAction, RuleNumber, region` | Replaces an entry (rule) in a network ACL. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_ACLs.html">Network ACLs</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. | diff --git a/docs/aws-docs/providers/aws/ec2_api/network_acls/index.md b/docs/aws-docs/providers/aws/ec2_api/network_acls/index.md new file mode 100644 index 0000000000..966fc074e3 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/network_acls/index.md @@ -0,0 +1,42 @@ +--- +title: network_acls +hide_title: false +hide_table_of_contents: false +keywords: + - network_acls + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namenetwork_acls
TypeResource
Idaws.ec2_api.network_acls
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `associationSet` | `array` | Any associations between the network ACL and one or more subnets | +| `default` | `boolean` | Indicates whether this is the default network ACL for the VPC. | +| `entrySet` | `array` | One or more entries (rules) in the network ACL. | +| `networkAclId` | `string` | The ID of the network ACL. | +| `ownerId` | `string` | The ID of the Amazon Web Services account that owns the network ACL. | +| `tagSet` | `array` | Any tags assigned to the network ACL. | +| `vpcId` | `string` | The ID of the VPC for the network ACL. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `network_acls_Describe` | `SELECT` | `region` | <p>Describes one or more of your network ACLs.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_ACLs.html">Network ACLs</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p> | +| `network_acl_Create` | `INSERT` | `VpcId, region` | <p>Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_ACLs.html">Network ACLs</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p> | +| `network_acl_Delete` | `DELETE` | `NetworkAclId, region` | Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. You can't delete the default network ACL. | diff --git a/docs/aws-docs/providers/aws/ec2_api/network_insights_access_scope_analyses/index.md b/docs/aws-docs/providers/aws/ec2_api/network_insights_access_scope_analyses/index.md new file mode 100644 index 0000000000..c6343e5241 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/network_insights_access_scope_analyses/index.md @@ -0,0 +1,44 @@ +--- +title: network_insights_access_scope_analyses +hide_title: false +hide_table_of_contents: false +keywords: + - network_insights_access_scope_analyses + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namenetwork_insights_access_scope_analyses
TypeResource
Idaws.ec2_api.network_insights_access_scope_analyses
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `analyzedEniCount` | `integer` | The number of network interfaces analyzed. | +| `endDate` | `string` | The analysis end date. | +| `findingsFound` | `string` | Indicates whether there are findings. | +| `networkInsightsAccessScopeAnalysisArn` | `string` | The Amazon Resource Name (ARN) of the Network Access Scope analysis. | +| `networkInsightsAccessScopeAnalysisId` | `string` | The ID of the Network Access Scope analysis. | +| `networkInsightsAccessScopeId` | `string` | The ID of the Network Access Scope. | +| `startDate` | `string` | The analysis start date. | +| `status` | `string` | The status. | +| `statusMessage` | `string` | The status message. | +| `tagSet` | `array` | The tags. | +| `warningMessage` | `string` | The warning message. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `network_insights_access_scope_analyses_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/network_insights_access_scope_analysis/index.md b/docs/aws-docs/providers/aws/ec2_api/network_insights_access_scope_analysis/index.md new file mode 100644 index 0000000000..eae859d7c5 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/network_insights_access_scope_analysis/index.md @@ -0,0 +1,33 @@ +--- +title: network_insights_access_scope_analysis +hide_title: false +hide_table_of_contents: false +keywords: + - network_insights_access_scope_analysis + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namenetwork_insights_access_scope_analysis
TypeResource
Idaws.ec2_api.network_insights_access_scope_analysis
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `network_insights_access_scope_analysis_Delete` | `DELETE` | `NetworkInsightsAccessScopeAnalysisId, region` | Deletes the specified Network Access Scope analysis. | +| `network_insights_access_scope_analysis_Start` | `EXEC` | `ClientToken, NetworkInsightsAccessScopeId, region` | Starts analyzing the specified Network Access Scope. | diff --git a/docs/aws-docs/providers/aws/ec2_api/network_insights_access_scope_analysis_findings/index.md b/docs/aws-docs/providers/aws/ec2_api/network_insights_access_scope_analysis_findings/index.md new file mode 100644 index 0000000000..cceb24cf68 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/network_insights_access_scope_analysis_findings/index.md @@ -0,0 +1,37 @@ +--- +title: network_insights_access_scope_analysis_findings +hide_title: false +hide_table_of_contents: false +keywords: + - network_insights_access_scope_analysis_findings + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namenetwork_insights_access_scope_analysis_findings
TypeResource
Idaws.ec2_api.network_insights_access_scope_analysis_findings
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `findingComponentSet` | `array` | The finding components. | +| `findingId` | `string` | The ID of the finding. | +| `networkInsightsAccessScopeAnalysisId` | `string` | The ID of the Network Access Scope analysis. | +| `networkInsightsAccessScopeId` | `string` | The ID of the Network Access Scope. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `network_insights_access_scope_analysis_findings_Get` | `SELECT` | `NetworkInsightsAccessScopeAnalysisId, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/network_insights_access_scope_content/index.md b/docs/aws-docs/providers/aws/ec2_api/network_insights_access_scope_content/index.md new file mode 100644 index 0000000000..c0b7ec9640 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/network_insights_access_scope_content/index.md @@ -0,0 +1,31 @@ +--- +title: network_insights_access_scope_content +hide_title: false +hide_table_of_contents: false +keywords: + - network_insights_access_scope_content + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namenetwork_insights_access_scope_content
TypeResource
Idaws.ec2_api.network_insights_access_scope_content
+ +## Fields +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `network_insights_access_scope_content_Get` | `SELECT` | `NetworkInsightsAccessScopeId, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/network_insights_access_scopes/index.md b/docs/aws-docs/providers/aws/ec2_api/network_insights_access_scopes/index.md new file mode 100644 index 0000000000..f499fa795f --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/network_insights_access_scopes/index.md @@ -0,0 +1,40 @@ +--- +title: network_insights_access_scopes +hide_title: false +hide_table_of_contents: false +keywords: + - network_insights_access_scopes + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namenetwork_insights_access_scopes
TypeResource
Idaws.ec2_api.network_insights_access_scopes
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `createdDate` | `string` | The creation date. | +| `networkInsightsAccessScopeArn` | `string` | The Amazon Resource Name (ARN) of the Network Access Scope. | +| `networkInsightsAccessScopeId` | `string` | The ID of the Network Access Scope. | +| `tagSet` | `array` | The tags. | +| `updatedDate` | `string` | The last updated date. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `network_insights_access_scopes_Describe` | `SELECT` | `region` | Describes the specified Network Access Scopes. | +| `network_insights_access_scope_Create` | `INSERT` | `ClientToken, region` | <p>Creates a Network Access Scope.</p> <p>Amazon Web Services Network Access Analyzer enables cloud networking and cloud operations teams to verify that their networks on Amazon Web Services conform to their network security and governance objectives. For more information, see the <a href="https://docs.aws.amazon.com/vpc/latest/network-access-analyzer/">Amazon Web Services Network Access Analyzer Guide</a>.</p> | +| `network_insights_access_scope_Delete` | `DELETE` | `NetworkInsightsAccessScopeId, region` | Deletes the specified Network Access Scope. | diff --git a/docs/aws-docs/providers/aws/ec2_api/network_insights_analyses/index.md b/docs/aws-docs/providers/aws/ec2_api/network_insights_analyses/index.md new file mode 100644 index 0000000000..d3823879ed --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/network_insights_analyses/index.md @@ -0,0 +1,47 @@ +--- +title: network_insights_analyses +hide_title: false +hide_table_of_contents: false +keywords: + - network_insights_analyses + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namenetwork_insights_analyses
TypeResource
Idaws.ec2_api.network_insights_analyses
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `alternatePathHintSet` | `array` | Potential intermediate components. | +| `explanationSet` | `array` | The explanations. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/reachability/explanation-codes.html">Reachability Analyzer explanation codes</a>. | +| `filterInArnSet` | `array` | The Amazon Resource Names (ARN) of the Amazon Web Services resources that the path must traverse. | +| `forwardPathComponentSet` | `array` | The components in the path from source to destination. | +| `networkInsightsAnalysisArn` | `string` | The Amazon Resource Name (ARN) of the network insights analysis. | +| `networkInsightsAnalysisId` | `string` | The ID of the network insights analysis. | +| `networkInsightsPathId` | `string` | The ID of the path. | +| `networkPathFound` | `boolean` | Indicates whether the destination is reachable from the source. | +| `returnPathComponentSet` | `array` | The components in the path from destination to source. | +| `startDate` | `string` | The time the analysis started. | +| `status` | `string` | The status of the network insights analysis. | +| `statusMessage` | `string` | The status message, if the status is <code>failed</code>. | +| `tagSet` | `array` | The tags. | +| `warningMessage` | `string` | The warning message. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `network_insights_analyses_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/network_insights_analysis/index.md b/docs/aws-docs/providers/aws/ec2_api/network_insights_analysis/index.md new file mode 100644 index 0000000000..be5ebbf94e --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/network_insights_analysis/index.md @@ -0,0 +1,33 @@ +--- +title: network_insights_analysis +hide_title: false +hide_table_of_contents: false +keywords: + - network_insights_analysis + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namenetwork_insights_analysis
TypeResource
Idaws.ec2_api.network_insights_analysis
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `network_insights_analysis_Delete` | `DELETE` | `NetworkInsightsAnalysisId, region` | Deletes the specified network insights analysis. | +| `network_insights_analysis_Start` | `EXEC` | `ClientToken, NetworkInsightsPathId, region` | Starts analyzing the specified path. If the path is reachable, the operation returns the shortest feasible path. | diff --git a/docs/aws-docs/providers/aws/ec2_api/network_insights_paths/index.md b/docs/aws-docs/providers/aws/ec2_api/network_insights_paths/index.md new file mode 100644 index 0000000000..67b7a40a8c --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/network_insights_paths/index.md @@ -0,0 +1,45 @@ +--- +title: network_insights_paths +hide_title: false +hide_table_of_contents: false +keywords: + - network_insights_paths + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namenetwork_insights_paths
TypeResource
Idaws.ec2_api.network_insights_paths
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `createdDate` | `string` | The time stamp when the path was created. | +| `destination` | `string` | The Amazon Web Services resource that is the destination of the path. | +| `destinationIp` | `string` | The IP address of the Amazon Web Services resource that is the destination of the path. | +| `destinationPort` | `integer` | The destination port. | +| `networkInsightsPathArn` | `string` | The Amazon Resource Name (ARN) of the path. | +| `networkInsightsPathId` | `string` | The ID of the path. | +| `protocol` | `string` | The protocol. | +| `source` | `string` | The Amazon Web Services resource that is the source of the path. | +| `sourceIp` | `string` | The IP address of the Amazon Web Services resource that is the source of the path. | +| `tagSet` | `array` | The tags associated with the path. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `network_insights_paths_Describe` | `SELECT` | `region` | Describes one or more of your paths. | +| `network_insights_path_Create` | `INSERT` | `ClientToken, Destination, Protocol, Source, region` | <p>Creates a path to analyze for reachability.</p> <p>Reachability Analyzer enables you to analyze and debug network reachability between two resources in your virtual private cloud (VPC). For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/reachability/">What is Reachability Analyzer</a>.</p> | +| `network_insights_path_Delete` | `DELETE` | `NetworkInsightsPathId, region` | Deletes the specified path. | diff --git a/docs/aws-docs/providers/aws/ec2_api/network_interface_attribute/index.md b/docs/aws-docs/providers/aws/ec2_api/network_interface_attribute/index.md new file mode 100644 index 0000000000..6fad6b163f --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/network_interface_attribute/index.md @@ -0,0 +1,40 @@ +--- +title: network_interface_attribute +hide_title: false +hide_table_of_contents: false +keywords: + - network_interface_attribute + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namenetwork_interface_attribute
TypeResource
Idaws.ec2_api.network_interface_attribute
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `description` | `object` | Describes a value for a resource attribute that is a String. | +| `attachment` | `object` | Describes a network interface attachment. | +| `groupSet` | `array` | The security groups associated with the network interface. | +| `networkInterfaceId` | `string` | The ID of the network interface. | +| `sourceDestCheck` | `object` | Describes a value for a resource attribute that is a Boolean value. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `network_interface_attribute_Describe` | `SELECT` | `NetworkInterfaceId, region` | Describes a network interface attribute. You can specify only one attribute at a time. | +| `network_interface_attribute_Modify` | `EXEC` | `NetworkInterfaceId, region` | Modifies the specified network interface attribute. You can specify only one attribute at a time. You can use this action to attach and detach security groups from an existing EC2 instance. | +| `network_interface_attribute_Reset` | `EXEC` | `NetworkInterfaceId, region` | Resets a network interface attribute. You can specify only one attribute at a time. | diff --git a/docs/aws-docs/providers/aws/ec2_api/network_interface_permissions/index.md b/docs/aws-docs/providers/aws/ec2_api/network_interface_permissions/index.md new file mode 100644 index 0000000000..b98572814e --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/network_interface_permissions/index.md @@ -0,0 +1,41 @@ +--- +title: network_interface_permissions +hide_title: false +hide_table_of_contents: false +keywords: + - network_interface_permissions + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namenetwork_interface_permissions
TypeResource
Idaws.ec2_api.network_interface_permissions
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `awsAccountId` | `string` | The Amazon Web Services account ID. | +| `awsService` | `string` | The Amazon Web Service. | +| `networkInterfaceId` | `string` | The ID of the network interface. | +| `networkInterfacePermissionId` | `string` | The ID of the network interface permission. | +| `permission` | `string` | The type of permission. | +| `permissionState` | `object` | Describes the state of a network interface permission. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `network_interface_permissions_Describe` | `SELECT` | `region` | Describes the permissions for your network interfaces. | +| `network_interface_permission_Create` | `INSERT` | `NetworkInterfaceId, Permission, region` | <p>Grants an Amazon Web Services-authorized account permission to attach the specified network interface to an instance in their account.</p> <p>You can grant permission to a single Amazon Web Services account only, and only one account at a time.</p> | +| `network_interface_permission_Delete` | `DELETE` | `NetworkInterfacePermissionId, region` | Deletes a permission for a network interface. By default, you cannot delete the permission if the account for which you're removing the permission has attached the network interface to an instance. However, you can force delete the permission, regardless of any attachment. | diff --git a/docs/aws-docs/providers/aws/ec2_api/network_interfaces/index.md b/docs/aws-docs/providers/aws/ec2_api/network_interfaces/index.md new file mode 100644 index 0000000000..8f4b3aeefc --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/network_interfaces/index.md @@ -0,0 +1,63 @@ +--- +title: network_interfaces +hide_title: false +hide_table_of_contents: false +keywords: + - network_interfaces + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namenetwork_interfaces
TypeResource
Idaws.ec2_api.network_interfaces
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `description` | `string` | A description. | +| `association` | `object` | Describes association information for an Elastic IP address (IPv4 only), or a Carrier IP address (for a network interface which resides in a subnet in a Wavelength Zone). | +| `attachment` | `object` | Describes a network interface attachment. | +| `availabilityZone` | `string` | The Availability Zone. | +| `denyAllIgwTraffic` | `boolean` | Indicates whether a network interface with an IPv6 address is unreachable from the public internet. If the value is <code>true</code>, inbound traffic from the internet is dropped and you cannot assign an elastic IP address to the network interface. The network interface is reachable from peered VPCs and resources connected through a transit gateway, including on-premises networks. | +| `groupSet` | `array` | Any security groups for the network interface. | +| `interfaceType` | `string` | The type of network interface. | +| `ipv4PrefixSet` | `array` | The IPv4 prefixes that are assigned to the network interface. | +| `ipv6Address` | `string` | The IPv6 globally unique address associated with the network interface. | +| `ipv6AddressesSet` | `array` | The IPv6 addresses associated with the network interface. | +| `ipv6Native` | `boolean` | Indicates whether this is an IPv6 only network interface. | +| `ipv6PrefixSet` | `array` | The IPv6 prefixes that are assigned to the network interface. | +| `macAddress` | `string` | The MAC address. | +| `networkInterfaceId` | `string` | The ID of the network interface. | +| `outpostArn` | `string` | The Amazon Resource Name (ARN) of the Outpost. | +| `ownerId` | `string` | The Amazon Web Services account ID of the owner of the network interface. | +| `privateDnsName` | `string` | The private DNS name. | +| `privateIpAddress` | `string` | The IPv4 address of the network interface within the subnet. | +| `privateIpAddressesSet` | `array` | The private IPv4 addresses associated with the network interface. | +| `requesterId` | `string` | The alias or Amazon Web Services account ID of the principal or service that created the network interface. | +| `requesterManaged` | `boolean` | Indicates whether the network interface is being managed by Amazon Web Services. | +| `sourceDestCheck` | `boolean` | Indicates whether source/destination checking is enabled. | +| `status` | `string` | The status of the network interface. | +| `subnetId` | `string` | The ID of the subnet. | +| `tagSet` | `array` | Any tags assigned to the network interface. | +| `vpcId` | `string` | The ID of the VPC. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `network_interfaces_Describe` | `SELECT` | `region` | Describes one or more of your network interfaces. | +| `network_interface_Create` | `INSERT` | `SubnetId, region` | <p>Creates a network interface in the specified subnet.</p> <p>For more information about network interfaces, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html">Elastic Network Interfaces</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p> | +| `network_interface_Delete` | `DELETE` | `NetworkInterfaceId, region` | Deletes the specified network interface. You must detach the network interface before you can delete it. | +| `network_interface_Attach` | `EXEC` | `DeviceIndex, InstanceId, NetworkInterfaceId, region` | Attaches a network interface to an instance. | +| `network_interface_Detach` | `EXEC` | `AttachmentId, region` | Detaches a network interface from an instance. | diff --git a/docs/aws-docs/providers/aws/ec2_api/password_data/index.md b/docs/aws-docs/providers/aws/ec2_api/password_data/index.md new file mode 100644 index 0000000000..d6a7f7e340 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/password_data/index.md @@ -0,0 +1,36 @@ +--- +title: password_data +hide_title: false +hide_table_of_contents: false +keywords: + - password_data + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namepassword_data
TypeResource
Idaws.ec2_api.password_data
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `instanceId` | `string` | The ID of the Windows instance. | +| `passwordData` | `string` | The password of the instance. Returns an empty string if the password is not available. | +| `timestamp` | `string` | The time the data was last updated. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `password_data_Get` | `SELECT` | `InstanceId, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/placement_groups/index.md b/docs/aws-docs/providers/aws/ec2_api/placement_groups/index.md new file mode 100644 index 0000000000..e5a3226cec --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/placement_groups/index.md @@ -0,0 +1,42 @@ +--- +title: placement_groups +hide_title: false +hide_table_of_contents: false +keywords: + - placement_groups + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameplacement_groups
TypeResource
Idaws.ec2_api.placement_groups
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `groupArn` | `string` | The Amazon Resource Name (ARN) of the placement group. | +| `groupId` | `string` | The ID of the placement group. | +| `groupName` | `string` | The name of the placement group. | +| `partitionCount` | `integer` | The number of partitions. Valid only if <b>strategy</b> is set to <code>partition</code>. | +| `state` | `string` | The state of the placement group. | +| `strategy` | `string` | The placement strategy. | +| `tagSet` | `array` | Any tags applied to the placement group. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `placement_groups_Describe` | `SELECT` | `region` | Describes the specified placement groups or all of your placement groups. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html">Placement groups</a> in the <i>Amazon EC2 User Guide</i>. | +| `placement_group_Create` | `INSERT` | `region` | <p>Creates a placement group in which to launch instances. The strategy of the placement group determines how the instances are organized within the group. </p> <p>A <code>cluster</code> placement group is a logical grouping of instances within a single Availability Zone that benefit from low network latency, high network throughput. A <code>spread</code> placement group places instances on distinct hardware. A <code>partition</code> placement group places groups of instances in different partitions, where instances in one partition do not share the same hardware with instances in another partition.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html">Placement groups</a> in the <i>Amazon EC2 User Guide</i>.</p> | +| `placement_group_Delete` | `DELETE` | `GroupName, region` | Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html">Placement groups</a> in the <i>Amazon EC2 User Guide</i>. | diff --git a/docs/aws-docs/providers/aws/ec2_api/prefix_lists/index.md b/docs/aws-docs/providers/aws/ec2_api/prefix_lists/index.md new file mode 100644 index 0000000000..c5abbcc9bf --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/prefix_lists/index.md @@ -0,0 +1,36 @@ +--- +title: prefix_lists +hide_title: false +hide_table_of_contents: false +keywords: + - prefix_lists + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameprefix_lists
TypeResource
Idaws.ec2_api.prefix_lists
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `cidrSet` | `array` | The IP address range of the Amazon Web Service. | +| `prefixListId` | `string` | The ID of the prefix. | +| `prefixListName` | `string` | The name of the prefix. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `prefix_lists_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/principal_id_format/index.md b/docs/aws-docs/providers/aws/ec2_api/principal_id_format/index.md new file mode 100644 index 0000000000..35e4ba7310 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/principal_id_format/index.md @@ -0,0 +1,35 @@ +--- +title: principal_id_format +hide_title: false +hide_table_of_contents: false +keywords: + - principal_id_format + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameprincipal_id_format
TypeResource
Idaws.ec2_api.principal_id_format
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `arn` | `string` | PrincipalIdFormatARN description | +| `statusSet` | `array` | PrincipalIdFormatStatuses description | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `principal_id_format_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/private_dns_name_options/index.md b/docs/aws-docs/providers/aws/ec2_api/private_dns_name_options/index.md new file mode 100644 index 0000000000..de54832431 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/private_dns_name_options/index.md @@ -0,0 +1,32 @@ +--- +title: private_dns_name_options +hide_title: false +hide_table_of_contents: false +keywords: + - private_dns_name_options + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameprivate_dns_name_options
TypeResource
Idaws.ec2_api.private_dns_name_options
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `private_dns_name_options_Modify` | `EXEC` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/private_ip_addresses/index.md b/docs/aws-docs/providers/aws/ec2_api/private_ip_addresses/index.md new file mode 100644 index 0000000000..0d491ce31b --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/private_ip_addresses/index.md @@ -0,0 +1,33 @@ +--- +title: private_ip_addresses +hide_title: false +hide_table_of_contents: false +keywords: + - private_ip_addresses + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameprivate_ip_addresses
TypeResource
Idaws.ec2_api.private_ip_addresses
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `private_ip_addresses_Assign` | `EXEC` | `NetworkInterfaceId, region` | <p>Assigns one or more secondary private IP addresses to the specified network interface.</p> <p>You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For information about instance types, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance Types</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. For more information about Elastic IP addresses, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>When you move a secondary private IP address to another network interface, any Elastic IP address that is associated with the IP address is also moved.</p> <p>Remapping an IP address is an asynchronous operation. When you move an IP address from one network interface to another, check <code>network/interfaces/macs/mac/local-ipv4s</code> in the instance metadata to confirm that the remapping is complete.</p> <p>You must specify either the IP addresses or the IP address count in the request.</p> <p>You can optionally use Prefix Delegation on the network interface. You must specify either the IPv4 Prefix Delegation prefixes, or the IPv4 Prefix Delegation count. For information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-prefix-eni.html"> Assigning prefixes to Amazon EC2 network interfaces</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | +| `private_ip_addresses_Unassign` | `EXEC` | `NetworkInterfaceId, region` | Unassigns one or more secondary private IP addresses, or IPv4 Prefix Delegation prefixes from a network interface. | diff --git a/docs/aws-docs/providers/aws/ec2_api/product_instance/index.md b/docs/aws-docs/providers/aws/ec2_api/product_instance/index.md new file mode 100644 index 0000000000..2810cccf87 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/product_instance/index.md @@ -0,0 +1,32 @@ +--- +title: product_instance +hide_title: false +hide_table_of_contents: false +keywords: + - product_instance + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameproduct_instance
TypeResource
Idaws.ec2_api.product_instance
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `product_instance_Confirm` | `EXEC` | `InstanceId, ProductCode, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/public_ipv4_pool_cidr/index.md b/docs/aws-docs/providers/aws/ec2_api/public_ipv4_pool_cidr/index.md new file mode 100644 index 0000000000..e930fedfb9 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/public_ipv4_pool_cidr/index.md @@ -0,0 +1,33 @@ +--- +title: public_ipv4_pool_cidr +hide_title: false +hide_table_of_contents: false +keywords: + - public_ipv4_pool_cidr + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namepublic_ipv4_pool_cidr
TypeResource
Idaws.ec2_api.public_ipv4_pool_cidr
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `public_ipv4_pool_cidr_Deprovision` | `EXEC` | `Cidr, PoolId, region` | Deprovision a CIDR from a public IPv4 pool. | +| `public_ipv4_pool_cidr_Provision` | `EXEC` | `IpamPoolId, NetmaskLength, PoolId, region` | <p>Provision a CIDR to a public IPv4 pool.</p> <p>For more information about IPAM, see <a href="/vpc/latest/ipam/what-is-it-ipam.html">What is IPAM?</a> in the <i>Amazon VPC IPAM User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/public_ipv4_pools/index.md b/docs/aws-docs/providers/aws/ec2_api/public_ipv4_pools/index.md new file mode 100644 index 0000000000..8da6cef681 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/public_ipv4_pools/index.md @@ -0,0 +1,42 @@ +--- +title: public_ipv4_pools +hide_title: false +hide_table_of_contents: false +keywords: + - public_ipv4_pools + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namepublic_ipv4_pools
TypeResource
Idaws.ec2_api.public_ipv4_pools
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `description` | `string` | A description of the address pool. | +| `networkBorderGroup` | `string` | The name of the location from which the address pool is advertised. A network border group is a unique set of Availability Zones or Local Zones from where Amazon Web Services advertises public IP addresses. | +| `poolAddressRangeSet` | `array` | The address ranges. | +| `poolId` | `string` | The ID of the address pool. | +| `tagSet` | `array` | Any tags for the address pool. | +| `totalAddressCount` | `integer` | The total number of addresses. | +| `totalAvailableAddressCount` | `integer` | The total number of available addresses. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `public_ipv4_pools_Describe` | `SELECT` | `region` | Describes the specified IPv4 address pools. | +| `public_ipv4_pool_Create` | `INSERT` | `region` | Creates a public IPv4 address pool. A public IPv4 pool is an EC2 IP address pool required for the public IPv4 CIDRs that you own and bring to Amazon Web Services to manage with IPAM. IPv6 addresses you bring to Amazon Web Services, however, use IPAM pools only. To monitor the status of pool creation, use <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribePublicIpv4Pools.html">DescribePublicIpv4Pools</a>. | +| `public_ipv4_pool_Delete` | `DELETE` | `PoolId, region` | Delete a public IPv4 pool. A public IPv4 pool is an EC2 IP address pool required for the public IPv4 CIDRs that you own and bring to Amazon Web Services to manage with IPAM. IPv6 addresses you bring to Amazon Web Services, however, use IPAM pools only. | diff --git a/docs/aws-docs/providers/aws/ec2_api/queued_reserved_instances/index.md b/docs/aws-docs/providers/aws/ec2_api/queued_reserved_instances/index.md new file mode 100644 index 0000000000..4d1380bc6c --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/queued_reserved_instances/index.md @@ -0,0 +1,32 @@ +--- +title: queued_reserved_instances +hide_title: false +hide_table_of_contents: false +keywords: + - queued_reserved_instances + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namequeued_reserved_instances
TypeResource
Idaws.ec2_api.queued_reserved_instances
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `queued_reserved_instances_Delete` | `DELETE` | `ReservedInstancesId, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/regions/index.md b/docs/aws-docs/providers/aws/ec2_api/regions/index.md new file mode 100644 index 0000000000..a0f0639e7a --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/regions/index.md @@ -0,0 +1,36 @@ +--- +title: regions +hide_title: false +hide_table_of_contents: false +keywords: + - regions + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameregions
TypeResource
Idaws.ec2_api.regions
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `optInStatus` | `string` | The Region opt-in status. The possible values are <code>opt-in-not-required</code>, <code>opted-in</code>, and <code>not-opted-in</code>. | +| `regionEndpoint` | `string` | The Region service endpoint. | +| `regionName` | `string` | The name of the Region. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `regions_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/replace_root_volume_tasks/index.md b/docs/aws-docs/providers/aws/ec2_api/replace_root_volume_tasks/index.md new file mode 100644 index 0000000000..01b8441920 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/replace_root_volume_tasks/index.md @@ -0,0 +1,40 @@ +--- +title: replace_root_volume_tasks +hide_title: false +hide_table_of_contents: false +keywords: + - replace_root_volume_tasks + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namereplace_root_volume_tasks
TypeResource
Idaws.ec2_api.replace_root_volume_tasks
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `completeTime` | `string` | The time the task completed. | +| `instanceId` | `string` | The ID of the instance for which the root volume replacement task was created. | +| `replaceRootVolumeTaskId` | `string` | The ID of the root volume replacement task. | +| `startTime` | `string` | The time the task was started. | +| `tagSet` | `array` | The tags assigned to the task. | +| `taskState` | `string` | <p>The state of the task. The task can be in one of the following states:</p> <ul> <li> <p> <code>pending</code> - the replacement volume is being created.</p> </li> <li> <p> <code>in-progress</code> - the original volume is being detached and the replacement volume is being attached.</p> </li> <li> <p> <code>succeeded</code> - the replacement volume has been successfully attached to the instance and the instance is available.</p> </li> <li> <p> <code>failing</code> - the replacement task is in the process of failing.</p> </li> <li> <p> <code>failed</code> - the replacement task has failed but the original root volume is still attached.</p> </li> <li> <p> <code>failing-detached</code> - the replacement task is in the process of failing. The instance might have no root volume attached.</p> </li> <li> <p> <code>failed-detached</code> - the replacement task has failed and the instance has no root volume attached.</p> </li> </ul> | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `replace_root_volume_tasks_Describe` | `SELECT` | `region` | Describes a root volume replacement task. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-restoring-volume.html#replace-root">Replace a root volume</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. | +| `replace_root_volume_task_Create` | `INSERT` | `InstanceId, region` | <p>Creates a root volume replacement task for an Amazon EC2 instance. The root volume can either be restored to its initial launch state, or it can be restored using a specific snapshot.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-restoring-volume.html#replace-root">Replace a root volume</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/reserved_instances/index.md b/docs/aws-docs/providers/aws/ec2_api/reserved_instances/index.md new file mode 100644 index 0000000000..6194c5fab1 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/reserved_instances/index.md @@ -0,0 +1,52 @@ +--- +title: reserved_instances +hide_title: false +hide_table_of_contents: false +keywords: + - reserved_instances + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namereserved_instances
TypeResource
Idaws.ec2_api.reserved_instances
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `availabilityZone` | `string` | The Availability Zone in which the Reserved Instance can be used. | +| `currencyCode` | `string` | The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is <code>USD</code>. | +| `duration` | `integer` | The duration of the Reserved Instance, in seconds. | +| `end` | `string` | The time when the Reserved Instance expires. | +| `fixedPrice` | `number` | The purchase price of the Reserved Instance. | +| `instanceCount` | `integer` | The number of reservations purchased. | +| `instanceTenancy` | `string` | The tenancy of the instance. | +| `instanceType` | `string` | The instance type on which the Reserved Instance can be used. | +| `offeringClass` | `string` | The offering class of the Reserved Instance. | +| `offeringType` | `string` | The Reserved Instance offering type. | +| `productDescription` | `string` | The Reserved Instance product platform description. | +| `recurringCharges` | `array` | The recurring charge tag assigned to the resource. | +| `reservedInstancesId` | `string` | The ID of the Reserved Instance. | +| `scope` | `string` | The scope of the Reserved Instance. | +| `start` | `string` | The date and time the Reserved Instance started. | +| `state` | `string` | The state of the Reserved Instance purchase. | +| `tagSet` | `array` | Any tags assigned to the resource. | +| `usagePrice` | `number` | The usage price of the Reserved Instance, per hour. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `reserved_instances_Describe` | `SELECT` | `region` | <p>Describes one or more of the Reserved Instances that you purchased.</p> <p>For more information about Reserved Instances, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts-on-demand-reserved-instances.html">Reserved Instances</a> in the <i>Amazon EC2 User Guide</i>.</p> | +| `reserved_instances_Modify` | `EXEC` | `ReservedInstancesConfigurationSetItemType, ReservedInstancesId, region` | <p>Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Reserved Instances. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-modifying.html">Modifying Reserved Instances</a> in the <i>Amazon EC2 User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/reserved_instances_exchange_quote/index.md b/docs/aws-docs/providers/aws/ec2_api/reserved_instances_exchange_quote/index.md new file mode 100644 index 0000000000..43e8e198a9 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/reserved_instances_exchange_quote/index.md @@ -0,0 +1,43 @@ +--- +title: reserved_instances_exchange_quote +hide_title: false +hide_table_of_contents: false +keywords: + - reserved_instances_exchange_quote + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namereserved_instances_exchange_quote
TypeResource
Idaws.ec2_api.reserved_instances_exchange_quote
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `currencyCode` | `string` | The currency of the transaction. | +| `isValidExchange` | `boolean` | If <code>true</code>, the exchange is valid. If <code>false</code>, the exchange cannot be completed. | +| `outputReservedInstancesWillExpireAt` | `string` | The new end date of the reservation term. | +| `paymentDue` | `string` | The total true upfront charge for the exchange. | +| `reservedInstanceValueRollup` | `object` | The cost associated with the Reserved Instance. | +| `reservedInstanceValueSet` | `array` | The configuration of your Convertible Reserved Instances. | +| `targetConfigurationValueRollup` | `object` | The cost associated with the Reserved Instance. | +| `targetConfigurationValueSet` | `array` | The values of the target Convertible Reserved Instances. | +| `validationFailureReason` | `string` | Describes the reason why the exchange cannot be completed. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `reserved_instances_exchange_quote_Get` | `SELECT` | `ReservedInstanceId, region` | Returns a quote and exchange information for exchanging one or more specified Convertible Reserved Instances for a new Convertible Reserved Instance. If the exchange cannot be performed, the reason is returned in the response. Use <a>AcceptReservedInstancesExchangeQuote</a> to perform the exchange. | +| `reserved_instances_exchange_quote_Accept` | `EXEC` | `ReservedInstanceId, region` | Accepts the Convertible Reserved Instance exchange quote described in the <a>GetReservedInstancesExchangeQuote</a> call. | diff --git a/docs/aws-docs/providers/aws/ec2_api/reserved_instances_listings/index.md b/docs/aws-docs/providers/aws/ec2_api/reserved_instances_listings/index.md new file mode 100644 index 0000000000..791e180d0b --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/reserved_instances_listings/index.md @@ -0,0 +1,45 @@ +--- +title: reserved_instances_listings +hide_title: false +hide_table_of_contents: false +keywords: + - reserved_instances_listings + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namereserved_instances_listings
TypeResource
Idaws.ec2_api.reserved_instances_listings
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `clientToken` | `string` | A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring Idempotency</a>. | +| `createDate` | `string` | The time the listing was created. | +| `instanceCounts` | `array` | The number of instances in this state. | +| `priceSchedules` | `array` | The price of the Reserved Instance listing. | +| `reservedInstancesId` | `string` | The ID of the Reserved Instance. | +| `reservedInstancesListingId` | `string` | The ID of the Reserved Instance listing. | +| `status` | `string` | The status of the Reserved Instance listing. | +| `statusMessage` | `string` | The reason for the current status of the Reserved Instance listing. The response can be blank. | +| `tagSet` | `array` | Any tags assigned to the resource. | +| `updateDate` | `string` | The last modified timestamp of the listing. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `reserved_instances_listings_Describe` | `SELECT` | `region` | <p>Describes your account's Reserved Instance listings in the Reserved Instance Marketplace.</p> <p>The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.</p> <p>As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase.</p> <p>As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a> in the <i>Amazon EC2 User Guide</i>.</p> | +| `reserved_instances_listing_Create` | `INSERT` | `ClientToken, InstanceCount, PriceSchedules, ReservedInstancesId, region` | <p>Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Standard Reserved Instance listing at a time. To get a list of your Standard Reserved Instances, you can use the <a>DescribeReservedInstances</a> operation.</p> <note> <p>Only Standard Reserved Instances can be sold in the Reserved Instance Marketplace. Convertible Reserved Instances cannot be sold.</p> </note> <p>The Reserved Instance Marketplace matches sellers who want to resell Standard Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.</p> <p>To sell your Standard Reserved Instances, you must first register as a seller in the Reserved Instance Marketplace. After completing the registration process, you can create a Reserved Instance Marketplace listing of some or all of your Standard Reserved Instances, and specify the upfront price to receive for them. Your Standard Reserved Instance listings then become available for purchase. To view the details of your Standard Reserved Instance listing, you can use the <a>DescribeReservedInstancesListings</a> operation.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a> in the <i>Amazon EC2 User Guide</i>.</p> | +| `reserved_instances_listing_Cancel` | `EXEC` | `ReservedInstancesListingId, region` | <p>Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a> in the <i>Amazon EC2 User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/reserved_instances_modifications/index.md b/docs/aws-docs/providers/aws/ec2_api/reserved_instances_modifications/index.md new file mode 100644 index 0000000000..a1b2089ed0 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/reserved_instances_modifications/index.md @@ -0,0 +1,42 @@ +--- +title: reserved_instances_modifications +hide_title: false +hide_table_of_contents: false +keywords: + - reserved_instances_modifications + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namereserved_instances_modifications
TypeResource
Idaws.ec2_api.reserved_instances_modifications
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `clientToken` | `string` | A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring Idempotency</a>. | +| `createDate` | `string` | The time when the modification request was created. | +| `effectiveDate` | `string` | The time for the modification to become effective. | +| `modificationResultSet` | `array` | Contains target configurations along with their corresponding new Reserved Instance IDs. | +| `reservedInstancesModificationId` | `string` | A unique ID for the Reserved Instance modification. | +| `reservedInstancesSet` | `array` | The IDs of one or more Reserved Instances. | +| `status` | `string` | The status of the Reserved Instances modification request. | +| `statusMessage` | `string` | The reason for the status. | +| `updateDate` | `string` | The time when the modification request was last updated. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `reserved_instances_modifications_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/reserved_instances_offerings/index.md b/docs/aws-docs/providers/aws/ec2_api/reserved_instances_offerings/index.md new file mode 100644 index 0000000000..ae359d3c52 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/reserved_instances_offerings/index.md @@ -0,0 +1,49 @@ +--- +title: reserved_instances_offerings +hide_title: false +hide_table_of_contents: false +keywords: + - reserved_instances_offerings + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namereserved_instances_offerings
TypeResource
Idaws.ec2_api.reserved_instances_offerings
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `availabilityZone` | `string` | The Availability Zone in which the Reserved Instance can be used. | +| `currencyCode` | `string` | The currency of the Reserved Instance offering you are purchasing. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is <code>USD</code>. | +| `duration` | `integer` | The duration of the Reserved Instance, in seconds. | +| `fixedPrice` | `number` | The purchase price of the Reserved Instance. | +| `instanceTenancy` | `string` | The tenancy of the instance. | +| `instanceType` | `string` | The instance type on which the Reserved Instance can be used. | +| `marketplace` | `boolean` | Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or Amazon Web Services. If it's a Reserved Instance Marketplace offering, this is <code>true</code>. | +| `offeringClass` | `string` | If <code>convertible</code> it can be exchanged for Reserved Instances of the same or higher monetary value, with different configurations. If <code>standard</code>, it is not possible to perform an exchange. | +| `offeringType` | `string` | The Reserved Instance offering type. | +| `pricingDetailsSet` | `array` | The pricing details of the Reserved Instance offering. | +| `productDescription` | `string` | The Reserved Instance product platform description. | +| `recurringCharges` | `array` | The recurring charge tag assigned to the resource. | +| `reservedInstancesOfferingId` | `string` | The ID of the Reserved Instance offering. This is the offering ID used in <a>GetReservedInstancesExchangeQuote</a> to confirm that an exchange can be made. | +| `scope` | `string` | Whether the Reserved Instance is applied to instances in a Region or an Availability Zone. | +| `usagePrice` | `number` | The usage price of the Reserved Instance, per hour. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `reserved_instances_offerings_Describe` | `SELECT` | `region` | <p>Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.</p> <p>If you have listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will be excluded from these results. This is to ensure that you do not purchase your own Reserved Instances.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a> in the <i>Amazon EC2 User Guide</i>.</p> | +| `reserved_instances_offering_Purchase` | `EXEC` | `InstanceCount, ReservedInstancesOfferingId, region` | <p>Purchases a Reserved Instance for use with your account. With Reserved Instances, you pay a lower hourly rate compared to On-Demand instance pricing.</p> <p>Use <a>DescribeReservedInstancesOfferings</a> to get a list of Reserved Instance offerings that match your specifications. After you've purchased a Reserved Instance, you can check for your new Reserved Instance with <a>DescribeReservedInstances</a>.</p> <p>To queue a purchase for a future date and time, specify a purchase time. If you do not specify a purchase time, the default is the current time.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts-on-demand-reserved-instances.html">Reserved Instances</a> and <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a> in the <i>Amazon EC2 User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/restore_image_task/index.md b/docs/aws-docs/providers/aws/ec2_api/restore_image_task/index.md new file mode 100644 index 0000000000..2a662b52c7 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/restore_image_task/index.md @@ -0,0 +1,32 @@ +--- +title: restore_image_task +hide_title: false +hide_table_of_contents: false +keywords: + - restore_image_task + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namerestore_image_task
TypeResource
Idaws.ec2_api.restore_image_task
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `restore_image_task_Create` | `INSERT` | `Bucket, ObjectKey, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/route/index.md b/docs/aws-docs/providers/aws/ec2_api/route/index.md new file mode 100644 index 0000000000..c92a396dc1 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/route/index.md @@ -0,0 +1,34 @@ +--- +title: route +hide_title: false +hide_table_of_contents: false +keywords: + - route + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameroute
TypeResource
Idaws.ec2_api.route
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `route_Create` | `INSERT` | `RouteTableId, region` | <p>Creates a route in a route table within a VPC.</p> <p>You must specify one of the following targets: internet gateway or virtual private gateway, NAT instance, NAT gateway, VPC peering connection, network interface, egress-only internet gateway, or transit gateway.</p> <p>When determining how to route traffic, we use the route with the most specific match. For example, traffic is destined for the IPv4 address <code>192.0.2.3</code>, and the route table includes the following two IPv4 routes:</p> <ul> <li> <p> <code>192.0.2.0/24</code> (goes to some target A)</p> </li> <li> <p> <code>192.0.2.0/28</code> (goes to some target B)</p> </li> </ul> <p>Both routes apply to the traffic destined for <code>192.0.2.3</code>. However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic.</p> <p>For more information about route tables, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html">Route tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p> | +| `route_Delete` | `DELETE` | `RouteTableId, region` | Deletes the specified route from the specified route table. | +| `route_Replace` | `EXEC` | `RouteTableId, region` | <p>Replaces an existing route within a route table in a VPC. You must provide only one of the following: internet gateway, virtual private gateway, NAT instance, NAT gateway, VPC peering connection, network interface, egress-only internet gateway, or transit gateway.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html">Route tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/route_table_association/index.md b/docs/aws-docs/providers/aws/ec2_api/route_table_association/index.md new file mode 100644 index 0000000000..54d6e4d345 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/route_table_association/index.md @@ -0,0 +1,32 @@ +--- +title: route_table_association +hide_title: false +hide_table_of_contents: false +keywords: + - route_table_association + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameroute_table_association
TypeResource
Idaws.ec2_api.route_table_association
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `route_table_association_Replace` | `EXEC` | `AssociationId, RouteTableId, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/route_tables/index.md b/docs/aws-docs/providers/aws/ec2_api/route_tables/index.md new file mode 100644 index 0000000000..fd94a1190b --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/route_tables/index.md @@ -0,0 +1,44 @@ +--- +title: route_tables +hide_title: false +hide_table_of_contents: false +keywords: + - route_tables + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameroute_tables
TypeResource
Idaws.ec2_api.route_tables
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `associationSet` | `array` | The associations between the route table and one or more subnets or a gateway. | +| `ownerId` | `string` | The ID of the Amazon Web Services account that owns the route table. | +| `propagatingVgwSet` | `array` | Any virtual private gateway (VGW) propagating routes. | +| `routeSet` | `array` | The routes in the route table. | +| `routeTableId` | `string` | The ID of the route table. | +| `tagSet` | `array` | Any tags assigned to the route table. | +| `vpcId` | `string` | The ID of the VPC. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `route_tables_Describe` | `SELECT` | `region` | <p>Describes one or more of your route tables.</p> <p>Each subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html">Route tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p> | +| `route_table_Create` | `INSERT` | `VpcId, region` | <p>Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html">Route tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p> | +| `route_table_Delete` | `DELETE` | `RouteTableId, region` | Deletes the specified route table. You must disassociate the route table from any subnets before you can delete it. You can't delete the main route table. | +| `route_table_Associate` | `EXEC` | `RouteTableId, region` | <p>Associates a subnet in your VPC or an internet gateway or virtual private gateway attached to your VPC with a route table in your VPC. This association causes traffic from the subnet or gateway to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table later. A route table can be associated with multiple subnets.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html">Route tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p> | +| `route_table_Disassociate` | `EXEC` | `AssociationId, region` | <p>Disassociates a subnet or gateway from a route table.</p> <p>After you perform this action, the subnet no longer uses the routes in the route table. Instead, it uses the routes in the VPC's main route table. For more information about route tables, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html">Route tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/scheduled_instance_availability/index.md b/docs/aws-docs/providers/aws/ec2_api/scheduled_instance_availability/index.md new file mode 100644 index 0000000000..1e06f3d922 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/scheduled_instance_availability/index.md @@ -0,0 +1,46 @@ +--- +title: scheduled_instance_availability +hide_title: false +hide_table_of_contents: false +keywords: + - scheduled_instance_availability + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namescheduled_instance_availability
TypeResource
Idaws.ec2_api.scheduled_instance_availability
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `availabilityZone` | `string` | The Availability Zone. | +| `availableInstanceCount` | `integer` | The number of available instances. | +| `firstSlotStartTime` | `string` | The time period for the first schedule to start. | +| `hourlyPrice` | `string` | The hourly price for a single instance. | +| `instanceType` | `string` | The instance type. You can specify one of the C3, C4, M4, or R3 instance types. | +| `maxTermDurationInDays` | `integer` | The maximum term. The only possible value is 365 days. | +| `minTermDurationInDays` | `integer` | The minimum term. The only possible value is 365 days. | +| `networkPlatform` | `string` | The network platform (<code>EC2-Classic</code> or <code>EC2-VPC</code>). | +| `platform` | `string` | The platform (<code>Linux/UNIX</code> or <code>Windows</code>). | +| `purchaseToken` | `string` | The purchase token. This token expires in two hours. | +| `recurrence` | `object` | Describes the recurring schedule for a Scheduled Instance. | +| `slotDurationInHours` | `integer` | The number of hours in the schedule. | +| `totalScheduledInstanceHours` | `integer` | The total number of hours for a single instance for the entire term. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `scheduled_instance_availability_Describe` | `SELECT` | `FirstSlotStartTimeRange, Recurrence, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/scheduled_instances/index.md b/docs/aws-docs/providers/aws/ec2_api/scheduled_instances/index.md new file mode 100644 index 0000000000..734894f12a --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/scheduled_instances/index.md @@ -0,0 +1,50 @@ +--- +title: scheduled_instances +hide_title: false +hide_table_of_contents: false +keywords: + - scheduled_instances + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namescheduled_instances
TypeResource
Idaws.ec2_api.scheduled_instances
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `availabilityZone` | `string` | The Availability Zone. | +| `createDate` | `string` | The date when the Scheduled Instance was purchased. | +| `hourlyPrice` | `string` | The hourly price for a single instance. | +| `instanceCount` | `integer` | The number of instances. | +| `instanceType` | `string` | The instance type. | +| `networkPlatform` | `string` | The network platform (<code>EC2-Classic</code> or <code>EC2-VPC</code>). | +| `nextSlotStartTime` | `string` | The time for the next schedule to start. | +| `platform` | `string` | The platform (<code>Linux/UNIX</code> or <code>Windows</code>). | +| `previousSlotEndTime` | `string` | The time that the previous schedule ended or will end. | +| `recurrence` | `object` | Describes the recurring schedule for a Scheduled Instance. | +| `scheduledInstanceId` | `string` | The Scheduled Instance ID. | +| `slotDurationInHours` | `integer` | The number of hours in the schedule. | +| `termEndDate` | `string` | The end date for the Scheduled Instance. | +| `termStartDate` | `string` | The start date for the Scheduled Instance. | +| `totalScheduledInstanceHours` | `integer` | The total number of hours for a single instance for the entire term. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `scheduled_instances_Describe` | `SELECT` | `region` | Describes the specified Scheduled Instances or all your Scheduled Instances. | +| `scheduled_instances_Purchase` | `EXEC` | `PurchaseRequest, region` | <p>Purchases the Scheduled Instances with the specified schedule.</p> <p>Scheduled Instances enable you to purchase Amazon EC2 compute capacity by the hour for a one-year term. Before you can purchase a Scheduled Instance, you must call <a>DescribeScheduledInstanceAvailability</a> to check for available schedules and obtain a purchase token. After you purchase a Scheduled Instance, you must call <a>RunScheduledInstances</a> during each scheduled time period.</p> <p>After you purchase a Scheduled Instance, you can't cancel, modify, or resell your purchase.</p> | +| `scheduled_instances_Run` | `EXEC` | `LaunchSpecification, ScheduledInstanceId, region` | <p>Launches the specified Scheduled Instances.</p> <p>Before you can launch a Scheduled Instance, you must purchase it and obtain an identifier using <a>PurchaseScheduledInstances</a>.</p> <p>You must launch a Scheduled Instance during its scheduled time period. You can't stop or reboot a Scheduled Instance, but you can terminate it as needed. If you terminate a Scheduled Instance before the current scheduled time period ends, you can launch it again after a few minutes. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-scheduled-instances.html">Scheduled Instances</a> in the <i>Amazon EC2 User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/security_group_egress/index.md b/docs/aws-docs/providers/aws/ec2_api/security_group_egress/index.md new file mode 100644 index 0000000000..9c84f70b33 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/security_group_egress/index.md @@ -0,0 +1,33 @@ +--- +title: security_group_egress +hide_title: false +hide_table_of_contents: false +keywords: + - security_group_egress + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namesecurity_group_egress
TypeResource
Idaws.ec2_api.security_group_egress
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `security_group_egress_Authorize` | `EXEC` | `GroupId, region` | <p>[VPC only] Adds the specified outbound (egress) rules to a security group for use with a VPC.</p> <p>An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 CIDR address ranges, or to the instances that are associated with the specified source security groups.</p> <p>You specify a protocol for each rule (for example, TCP). For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes.</p> <p>Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.</p> <p>For information about VPC security group quotas, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html">Amazon VPC quotas</a>.</p> | +| `security_group_egress_Revoke` | `EXEC` | `GroupId, region` | <p>[VPC only] Removes the specified outbound (egress) rules from a security group for EC2-VPC. This action does not apply to security groups for use in EC2-Classic.</p> <p>You can specify rules using either rule IDs or security group rule properties. If you use rule properties, the values that you specify (for example, ports) must match the existing rule's values exactly. Each rule has a protocol, from and to ports, and destination (CIDR range, security group, or prefix list). For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not need to specify the description to revoke the rule.</p> <p>[Default VPC] If the values you specify do not match the existing rule's values, no error is returned, and the output describes the security group rules that were not revoked.</p> <p>Amazon Web Services recommends that you describe the security group to verify that the rules were removed.</p> <p>Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/security_group_ingress/index.md b/docs/aws-docs/providers/aws/ec2_api/security_group_ingress/index.md new file mode 100644 index 0000000000..8ed070cda7 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/security_group_ingress/index.md @@ -0,0 +1,33 @@ +--- +title: security_group_ingress +hide_title: false +hide_table_of_contents: false +keywords: + - security_group_ingress + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namesecurity_group_ingress
TypeResource
Idaws.ec2_api.security_group_ingress
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `security_group_ingress_Authorize` | `EXEC` | `region` | <p>Adds the specified inbound (ingress) rules to a security group.</p> <p>An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 CIDR address range, or from the instances that are associated with the specified destination security groups.</p> <p>You specify a protocol for each rule (for example, TCP). For TCP and UDP, you must also specify the destination port or port range. For ICMP/ICMPv6, you must also specify the ICMP/ICMPv6 type and code. You can use -1 to mean all types or all codes.</p> <p>Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.</p> <p>For more information about VPC security group quotas, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html">Amazon VPC quotas</a>.</p> | +| `security_group_ingress_Revoke` | `EXEC` | `region` | <p>Removes the specified inbound (ingress) rules from a security group.</p> <p>You can specify rules using either rule IDs or security group rule properties. If you use rule properties, the values that you specify (for example, ports) must match the existing rule's values exactly. Each rule has a protocol, from and to ports, and source (CIDR range, security group, or prefix list). For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not need to specify the description to revoke the rule.</p> <p>[EC2-Classic, default VPC] If the values you specify do not match the existing rule's values, no error is returned, and the output describes the security group rules that were not revoked.</p> <p>Amazon Web Services recommends that you describe the security group to verify that the rules were removed.</p> <p>Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/security_group_references/index.md b/docs/aws-docs/providers/aws/ec2_api/security_group_references/index.md new file mode 100644 index 0000000000..077fdd1b60 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/security_group_references/index.md @@ -0,0 +1,36 @@ +--- +title: security_group_references +hide_title: false +hide_table_of_contents: false +keywords: + - security_group_references + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namesecurity_group_references
TypeResource
Idaws.ec2_api.security_group_references
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `groupId` | `string` | The ID of your security group. | +| `referencingVpcId` | `string` | The ID of the VPC with the referencing security group. | +| `vpcPeeringConnectionId` | `string` | The ID of the VPC peering connection. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `security_group_references_Describe` | `SELECT` | `GroupId, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/security_group_rule_descriptions_egress/index.md b/docs/aws-docs/providers/aws/ec2_api/security_group_rule_descriptions_egress/index.md new file mode 100644 index 0000000000..d7b05778ca --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/security_group_rule_descriptions_egress/index.md @@ -0,0 +1,32 @@ +--- +title: security_group_rule_descriptions_egress +hide_title: false +hide_table_of_contents: false +keywords: + - security_group_rule_descriptions_egress + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namesecurity_group_rule_descriptions_egress
TypeResource
Idaws.ec2_api.security_group_rule_descriptions_egress
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `security_group_rule_descriptions_egress_Update` | `EXEC` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/security_group_rule_descriptions_ingress/index.md b/docs/aws-docs/providers/aws/ec2_api/security_group_rule_descriptions_ingress/index.md new file mode 100644 index 0000000000..8501e26bac --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/security_group_rule_descriptions_ingress/index.md @@ -0,0 +1,32 @@ +--- +title: security_group_rule_descriptions_ingress +hide_title: false +hide_table_of_contents: false +keywords: + - security_group_rule_descriptions_ingress + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namesecurity_group_rule_descriptions_ingress
TypeResource
Idaws.ec2_api.security_group_rule_descriptions_ingress
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `security_group_rule_descriptions_ingress_Update` | `EXEC` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/security_group_rules/index.md b/docs/aws-docs/providers/aws/ec2_api/security_group_rules/index.md new file mode 100644 index 0000000000..a4ee637220 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/security_group_rules/index.md @@ -0,0 +1,47 @@ +--- +title: security_group_rules +hide_title: false +hide_table_of_contents: false +keywords: + - security_group_rules + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namesecurity_group_rules
TypeResource
Idaws.ec2_api.security_group_rules
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `description` | `string` | The security group rule description. | +| `cidrIpv4` | `string` | The IPv4 CIDR range. | +| `cidrIpv6` | `string` | The IPv6 CIDR range. | +| `fromPort` | `integer` | The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes. | +| `groupId` | `string` | The ID of the security group. | +| `groupOwnerId` | `string` | The ID of the Amazon Web Services account that owns the security group. | +| `ipProtocol` | `string` | <p>The IP protocol name (<code>tcp</code>, <code>udp</code>, <code>icmp</code>, <code>icmpv6</code>) or number (see <a href="http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml">Protocol Numbers</a>). </p> <p>Use <code>-1</code> to specify all protocols.</p> | +| `isEgress` | `boolean` | Indicates whether the security group rule is an outbound rule. | +| `prefixListId` | `string` | The ID of the prefix list. | +| `referencedGroupInfo` | `object` | Describes the security group that is referenced in the security group rule. | +| `securityGroupRuleId` | `string` | The ID of the security group rule. | +| `tagSet` | `array` | The tags applied to the security group rule. | +| `toPort` | `integer` | The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of <code>-1</code> indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `security_group_rules_Describe` | `SELECT` | `region` | Describes one or more of your security group rules. | +| `security_group_rules_Modify` | `EXEC` | `GroupId, SecurityGroupRule, region` | Modifies the rules of a security group. | diff --git a/docs/aws-docs/providers/aws/ec2_api/security_groups/index.md b/docs/aws-docs/providers/aws/ec2_api/security_groups/index.md new file mode 100644 index 0000000000..5ff59d57c2 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/security_groups/index.md @@ -0,0 +1,43 @@ +--- +title: security_groups +hide_title: false +hide_table_of_contents: false +keywords: + - security_groups + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namesecurity_groups
TypeResource
Idaws.ec2_api.security_groups
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `groupDescription` | `string` | A description of the security group. | +| `groupId` | `string` | The ID of the security group. | +| `groupName` | `string` | The name of the security group. | +| `ipPermissions` | `array` | The inbound rules associated with the security group. | +| `ipPermissionsEgress` | `array` | [VPC only] The outbound rules associated with the security group. | +| `ownerId` | `string` | The Amazon Web Services account ID of the owner of the security group. | +| `tagSet` | `array` | Any tags assigned to the security group. | +| `vpcId` | `string` | [VPC only] The ID of the VPC for the security group. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `security_groups_Describe` | `SELECT` | `region` | <p>Describes the specified security groups or all of your security groups.</p> <p>A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html">Amazon EC2 security groups</a> in the <i>Amazon Elastic Compute Cloud User Guide</i> and <a href="https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html">Security groups for your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p> | +| `security_group_Create` | `INSERT` | `GroupDescription, GroupName, region` | <p>Creates a security group.</p> <p>A security group acts as a virtual firewall for your instance to control inbound and outbound traffic. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html">Amazon EC2 security groups</a> in the <i>Amazon Elastic Compute Cloud User Guide</i> and <a href="https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html">Security groups for your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p> <p>When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.</p> <p>You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other.</p> <p>You can add or remove rules from your security groups using <a>AuthorizeSecurityGroupIngress</a>, <a>AuthorizeSecurityGroupEgress</a>, <a>RevokeSecurityGroupIngress</a>, and <a>RevokeSecurityGroupEgress</a>.</p> <p>For more information about VPC security group limits, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html">Amazon VPC Limits</a>.</p> | +| `security_group_Delete` | `DELETE` | `region` | <p>Deletes a security group.</p> <p>If you attempt to delete a security group that is associated with an instance, or is referenced by another security group, the operation fails with <code>InvalidGroup.InUse</code> in EC2-Classic or <code>DependencyViolation</code> in EC2-VPC.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/security_groups_to_client_vpn_target_network/index.md b/docs/aws-docs/providers/aws/ec2_api/security_groups_to_client_vpn_target_network/index.md new file mode 100644 index 0000000000..a731c5947c --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/security_groups_to_client_vpn_target_network/index.md @@ -0,0 +1,32 @@ +--- +title: security_groups_to_client_vpn_target_network +hide_title: false +hide_table_of_contents: false +keywords: + - security_groups_to_client_vpn_target_network + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namesecurity_groups_to_client_vpn_target_network
TypeResource
Idaws.ec2_api.security_groups_to_client_vpn_target_network
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `security_groups_to_client_vpn_target_network_Apply` | `EXEC` | `ClientVpnEndpointId, SecurityGroupId, VpcId, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/serial_console_access/index.md b/docs/aws-docs/providers/aws/ec2_api/serial_console_access/index.md new file mode 100644 index 0000000000..648963808b --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/serial_console_access/index.md @@ -0,0 +1,33 @@ +--- +title: serial_console_access +hide_title: false +hide_table_of_contents: false +keywords: + - serial_console_access + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameserial_console_access
TypeResource
Idaws.ec2_api.serial_console_access
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `serial_console_access_Disable` | `EXEC` | `region` | Disables access to the EC2 serial console of all instances for your account. By default, access to the EC2 serial console is disabled for your account. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configure-access-to-serial-console.html#serial-console-account-access">Manage account access to the EC2 serial console</a> in the <i>Amazon EC2 User Guide</i>. | +| `serial_console_access_Enable` | `EXEC` | `region` | Enables access to the EC2 serial console of all instances for your account. By default, access to the EC2 serial console is disabled for your account. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configure-access-to-serial-console.html#serial-console-account-access">Manage account access to the EC2 serial console</a> in the <i>Amazon EC2 User Guide</i>. | diff --git a/docs/aws-docs/providers/aws/ec2_api/serial_console_access_status/index.md b/docs/aws-docs/providers/aws/ec2_api/serial_console_access_status/index.md new file mode 100644 index 0000000000..2e685e5e5c --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/serial_console_access_status/index.md @@ -0,0 +1,31 @@ +--- +title: serial_console_access_status +hide_title: false +hide_table_of_contents: false +keywords: + - serial_console_access_status + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameserial_console_access_status
TypeResource
Idaws.ec2_api.serial_console_access_status
+ +## Fields +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `serial_console_access_status_Get` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/snapshot_attribute/index.md b/docs/aws-docs/providers/aws/ec2_api/snapshot_attribute/index.md new file mode 100644 index 0000000000..b448f1b65b --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/snapshot_attribute/index.md @@ -0,0 +1,38 @@ +--- +title: snapshot_attribute +hide_title: false +hide_table_of_contents: false +keywords: + - snapshot_attribute + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namesnapshot_attribute
TypeResource
Idaws.ec2_api.snapshot_attribute
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `createVolumePermission` | `array` | The users and groups that have the permissions for creating volumes from the snapshot. | +| `productCodes` | `array` | The product codes. | +| `snapshotId` | `string` | The ID of the EBS snapshot. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `snapshot_attribute_Describe` | `SELECT` | `Attribute, SnapshotId, region` | <p>Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time.</p> <p>For more information about EBS snapshots, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSSnapshots.html">Amazon EBS snapshots</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | +| `snapshot_attribute_Modify` | `EXEC` | `SnapshotId, region` | <p>Adds or removes permission settings for the specified snapshot. You may add or remove specified Amazon Web Services account IDs from a snapshot's list of create volume permissions, but you cannot do both in a single operation. If you need to both add and remove account IDs for a snapshot, you must use multiple operations. You can make up to 500 modifications to a snapshot in a single operation.</p> <p>Encrypted snapshots and snapshots with Amazon Web Services Marketplace product codes cannot be made public. Snapshots encrypted with your default KMS key cannot be shared with other accounts.</p> <p>For more information about modifying snapshot permissions, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-modifying-snapshot-permissions.html">Share a snapshot</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | +| `snapshot_attribute_Reset` | `EXEC` | `Attribute, SnapshotId, region` | <p>Resets permission settings for the specified snapshot.</p> <p>For more information about modifying snapshot permissions, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-modifying-snapshot-permissions.html">Share a snapshot</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/snapshot_from_recycle_bin/index.md b/docs/aws-docs/providers/aws/ec2_api/snapshot_from_recycle_bin/index.md new file mode 100644 index 0000000000..cf29e62fd2 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/snapshot_from_recycle_bin/index.md @@ -0,0 +1,32 @@ +--- +title: snapshot_from_recycle_bin +hide_title: false +hide_table_of_contents: false +keywords: + - snapshot_from_recycle_bin + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namesnapshot_from_recycle_bin
TypeResource
Idaws.ec2_api.snapshot_from_recycle_bin
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `snapshot_from_recycle_bin_Restore` | `EXEC` | `SnapshotId, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/snapshot_tier/index.md b/docs/aws-docs/providers/aws/ec2_api/snapshot_tier/index.md new file mode 100644 index 0000000000..1ef15572f7 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/snapshot_tier/index.md @@ -0,0 +1,33 @@ +--- +title: snapshot_tier +hide_title: false +hide_table_of_contents: false +keywords: + - snapshot_tier + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namesnapshot_tier
TypeResource
Idaws.ec2_api.snapshot_tier
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `snapshot_tier_Modify` | `EXEC` | `SnapshotId, region` | Archives an Amazon EBS snapshot. When you archive a snapshot, it is converted to a full snapshot that includes all of the blocks of data that were written to the volume at the time the snapshot was created, and moved from the standard tier to the archive tier. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshot-archive.html">Archive Amazon EBS snapshots</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. | +| `snapshot_tier_Restore` | `EXEC` | `SnapshotId, region` | <p>Restores an archived Amazon EBS snapshot for use temporarily or permanently, or modifies the restore period or restore type for a snapshot that was previously temporarily restored.</p> <p>For more information see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/working-with-snapshot-archiving.html#restore-archived-snapshot"> Restore an archived snapshot</a> and <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/working-with-snapshot-archiving.html#modify-temp-restore-period"> modify the restore period or restore type for a temporarily restored snapshot</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/snapshot_tier_status/index.md b/docs/aws-docs/providers/aws/ec2_api/snapshot_tier_status/index.md new file mode 100644 index 0000000000..de1d2d2aea --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/snapshot_tier_status/index.md @@ -0,0 +1,45 @@ +--- +title: snapshot_tier_status +hide_title: false +hide_table_of_contents: false +keywords: + - snapshot_tier_status + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namesnapshot_tier_status
TypeResource
Idaws.ec2_api.snapshot_tier_status
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `archivalCompleteTime` | `string` | The date and time when the last archive process was completed. | +| `lastTieringOperationStatus` | `string` | The status of the last archive or restore process. | +| `lastTieringOperationStatusDetail` | `string` | A message describing the status of the last archive or restore process. | +| `lastTieringProgress` | `integer` | The progress of the last archive or restore process, as a percentage. | +| `lastTieringStartTime` | `string` | The date and time when the last archive or restore process was started. | +| `ownerId` | `string` | The ID of the Amazon Web Services account that owns the snapshot. | +| `restoreExpiryTime` | `string` | Only for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived. | +| `snapshotId` | `string` | The ID of the snapshot. | +| `status` | `string` | The state of the snapshot. | +| `storageTier` | `string` | The storage tier in which the snapshot is stored. <code>standard</code> indicates that the snapshot is stored in the standard snapshot storage tier and that it is ready for use. <code>archive</code> indicates that the snapshot is currently archived and that it must be restored before it can be used. | +| `tagSet` | `array` | The tags that are assigned to the snapshot. | +| `volumeId` | `string` | The ID of the volume from which the snapshot was created. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `snapshot_tier_status_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/snapshots/index.md b/docs/aws-docs/providers/aws/ec2_api/snapshots/index.md new file mode 100644 index 0000000000..335d7cd164 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/snapshots/index.md @@ -0,0 +1,55 @@ +--- +title: snapshots +hide_title: false +hide_table_of_contents: false +keywords: + - snapshots + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namesnapshots
TypeResource
Idaws.ec2_api.snapshots
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `description` | `string` | The description for the snapshot. | +| `dataEncryptionKeyId` | `string` | The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by <a>DescribeSnapshots</a>. | +| `encrypted` | `boolean` | Indicates whether the snapshot is encrypted. | +| `kmsKeyId` | `string` | The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the parent volume. | +| `outpostArn` | `string` | The ARN of the Outpost on which the snapshot is stored. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshots-outposts.html">Amazon EBS local snapshots on Outposts</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. | +| `ownerAlias` | `string` | The Amazon Web Services owner alias, from an Amazon-maintained list (<code>amazon</code>). This is not the user-configured Amazon Web Services account alias set using the IAM console. | +| `ownerId` | `string` | The ID of the Amazon Web Services account that owns the EBS snapshot. | +| `progress` | `string` | The progress of the snapshot, as a percentage. | +| `restoreExpiryTime` | `string` | Only for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived. | +| `snapshotId` | `string` | The ID of the snapshot. Each snapshot receives a unique identifier when it is created. | +| `startTime` | `string` | The time stamp when the snapshot was initiated. | +| `status` | `string` | The snapshot state. | +| `statusMessage` | `string` | Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper Key Management Service (KMS) permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by <a>DescribeSnapshots</a>. | +| `storageTier` | `string` | The storage tier in which the snapshot is stored. <code>standard</code> indicates that the snapshot is stored in the standard snapshot storage tier and that it is ready for use. <code>archive</code> indicates that the snapshot is currently archived and that it must be restored before it can be used. | +| `tagSet` | `array` | Any tags assigned to the snapshot. | +| `volumeId` | `string` | The ID of the volume that was used to create the snapshot. Snapshots created by the <a>CopySnapshot</a> action have an arbitrary volume ID that should not be used for any purpose. | +| `volumeSize` | `integer` | The size of the volume, in GiB. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `snapshots_Describe` | `SELECT` | `region` | <p>Describes the specified EBS snapshots available to you or all of the EBS snapshots available to you.</p> <p>The snapshots available to you include public snapshots, private snapshots that you own, and private snapshots owned by other Amazon Web Services accounts for which you have explicit create volume permissions.</p> <p>The create volume permissions fall into the following categories:</p> <ul> <li> <p> <i>public</i>: The owner of the snapshot granted create volume permissions for the snapshot to the <code>all</code> group. All Amazon Web Services accounts have create volume permissions for these snapshots.</p> </li> <li> <p> <i>explicit</i>: The owner of the snapshot granted create volume permissions to a specific Amazon Web Services account.</p> </li> <li> <p> <i>implicit</i>: An Amazon Web Services account has implicit create volume permissions for all snapshots it owns.</p> </li> </ul> <p>The list of snapshots returned can be filtered by specifying snapshot IDs, snapshot owners, or Amazon Web Services accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions.</p> <p>If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results.</p> <p>If you specify one or more snapshot owners using the <code>OwnerIds</code> option, only snapshots from the specified owners and for which you have access are returned. The results can include the Amazon Web Services account IDs of the specified owners, <code>amazon</code> for snapshots owned by Amazon, or <code>self</code> for snapshots that you own.</p> <p>If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify Amazon Web Services account IDs (if you own the snapshots), <code>self</code> for snapshots for which you own or have explicit permissions, or <code>all</code> for public snapshots.</p> <p>If you are describing a long list of snapshots, we recommend that you paginate the output to make the list more manageable. The <code>MaxResults</code> parameter sets the maximum number of results returned in a single page. If the list of results exceeds your <code>MaxResults</code> value, then that number of results is returned along with a <code>NextToken</code> value that can be passed to a subsequent <code>DescribeSnapshots</code> request to retrieve the remaining results.</p> <p>To get the state of fast snapshot restores for a snapshot, use <a>DescribeFastSnapshotRestores</a>.</p> <p>For more information about EBS snapshots, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSSnapshots.html">Amazon EBS snapshots</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | +| `snapshot_Create` | `INSERT` | `VolumeId, region` | <p>Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance.</p> <p>You can create snapshots of volumes in a Region and volumes on an Outpost. If you create a snapshot of a volume in a Region, the snapshot must be stored in the same Region as the volume. If you create a snapshot of a volume on an Outpost, the snapshot can be stored on the same Outpost as the volume, or in the Region for that Outpost.</p> <p>When a snapshot is created, any Amazon Web Services Marketplace product codes that are associated with the source volume are propagated to the snapshot.</p> <p>You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your Amazon EBS volume at the time the snapshot command is issued; this might exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is <code>pending</code>.</p> <p>To create a snapshot for Amazon EBS volumes that serve as root devices, you should stop the instance before taking the snapshot.</p> <p>Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected.</p> <p>You can tag your snapshots during creation. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html">Tag your Amazon EC2 resources</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AmazonEBS.html">Amazon Elastic Block Store</a> and <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html">Amazon EBS encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | +| `snapshots_Create` | `INSERT` | `InstanceSpecification, region` | <p>Creates crash-consistent snapshots of multiple EBS volumes and stores the data in S3. Volumes are chosen by specifying an instance. Any attached volumes will produce one snapshot each that is crash-consistent across the instance. Boot volumes can be excluded by changing the parameters. </p> <p>You can create multi-volume snapshots of instances in a Region and instances on an Outpost. If you create snapshots from an instance in a Region, the snapshots must be stored in the same Region as the instance. If you create snapshots from an instance on an Outpost, the snapshots can be stored on the same Outpost as the instance, or in the Region for that Outpost.</p> | +| `snapshot_Delete` | `DELETE` | `SnapshotId, region` | <p>Deletes the specified snapshot.</p> <p>When you make periodic snapshots of a volume, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the volume.</p> <p>You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI. You must first de-register the AMI before you can delete the snapshot.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-deleting-snapshot.html">Delete an Amazon EBS snapshot</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | +| `snapshot_Copy` | `EXEC` | `SourceRegion, SourceSnapshotId, region` | <p>Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy a snapshot within the same Region, from one Region to another, or from a Region to an Outpost. You can't copy a snapshot from an Outpost to a Region, from one Outpost to another, or within the same Outpost.</p> <p>You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs).</p> <p>When copying snapshots to a Region, copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless you enable encryption for the snapshot copy operation. By default, encrypted snapshot copies use the default Key Management Service (KMS) KMS key; however, you can specify a different KMS key. To copy an encrypted snapshot that has been shared from another account, you must have permissions for the KMS key used to encrypt the snapshot.</p> <p>Snapshots copied to an Outpost are encrypted by default using the default encryption key for the Region, or a different key that you specify in the request using <b>KmsKeyId</b>. Outposts do not support unencrypted snapshots. For more information, <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshots-outposts.html#ami"> Amazon EBS local snapshots on Outposts</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>Snapshots created by copying another snapshot have an arbitrary volume ID that should not be used for any purpose.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-copy-snapshot.html">Copy an Amazon EBS snapshot</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | +| `snapshot_Import` | `EXEC` | `region` | <p>Imports a disk into an EBS snapshot.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/vm-import/latest/userguide/vmimport-import-snapshot.html">Importing a disk as a snapshot using VM Import/Export</a> in the <i>VM Import/Export User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/snapshots_in_recycle_bin/index.md b/docs/aws-docs/providers/aws/ec2_api/snapshots_in_recycle_bin/index.md new file mode 100644 index 0000000000..0cee5842dd --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/snapshots_in_recycle_bin/index.md @@ -0,0 +1,38 @@ +--- +title: snapshots_in_recycle_bin +hide_title: false +hide_table_of_contents: false +keywords: + - snapshots_in_recycle_bin + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namesnapshots_in_recycle_bin
TypeResource
Idaws.ec2_api.snapshots_in_recycle_bin
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `description` | `string` | The description for the snapshot. | +| `recycleBinEnterTime` | `string` | The date and time when the snaphsot entered the Recycle Bin. | +| `recycleBinExitTime` | `string` | The date and time when the snapshot is to be permanently deleted from the Recycle Bin. | +| `snapshotId` | `string` | The ID of the snapshot. | +| `volumeId` | `string` | The ID of the volume from which the snapshot was created. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `snapshots_in_recycle_bin_List` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/spot_datafeed_subscription/index.md b/docs/aws-docs/providers/aws/ec2_api/spot_datafeed_subscription/index.md new file mode 100644 index 0000000000..64c0a28683 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/spot_datafeed_subscription/index.md @@ -0,0 +1,40 @@ +--- +title: spot_datafeed_subscription +hide_title: false +hide_table_of_contents: false +keywords: + - spot_datafeed_subscription + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namespot_datafeed_subscription
TypeResource
Idaws.ec2_api.spot_datafeed_subscription
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `bucket` | `string` | The name of the Amazon S3 bucket where the Spot Instance data feed is located. | +| `fault` | `object` | Describes a Spot Instance state change. | +| `ownerId` | `string` | The Amazon Web Services account ID of the account. | +| `prefix` | `string` | The prefix for the data feed files. | +| `state` | `string` | The state of the Spot Instance data feed subscription. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `spot_datafeed_subscription_Describe` | `SELECT` | `region` | Describes the data feed for Spot Instances. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-data-feeds.html">Spot Instance data feed</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>. | +| `spot_datafeed_subscription_Create` | `INSERT` | `Bucket, region` | Creates a data feed for Spot Instances, enabling you to view Spot Instance usage logs. You can create one data feed per Amazon Web Services account. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-data-feeds.html">Spot Instance data feed</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>. | +| `spot_datafeed_subscription_Delete` | `DELETE` | `region` | Deletes the data feed for Spot Instances. | diff --git a/docs/aws-docs/providers/aws/ec2_api/spot_fleet/index.md b/docs/aws-docs/providers/aws/ec2_api/spot_fleet/index.md new file mode 100644 index 0000000000..39ddf275cb --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/spot_fleet/index.md @@ -0,0 +1,32 @@ +--- +title: spot_fleet +hide_title: false +hide_table_of_contents: false +keywords: + - spot_fleet + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namespot_fleet
TypeResource
Idaws.ec2_api.spot_fleet
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `spot_fleet_Request` | `EXEC` | `SpotFleetRequestConfig, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/spot_fleet_instances/index.md b/docs/aws-docs/providers/aws/ec2_api/spot_fleet_instances/index.md new file mode 100644 index 0000000000..9405edc185 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/spot_fleet_instances/index.md @@ -0,0 +1,37 @@ +--- +title: spot_fleet_instances +hide_title: false +hide_table_of_contents: false +keywords: + - spot_fleet_instances + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namespot_fleet_instances
TypeResource
Idaws.ec2_api.spot_fleet_instances
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `instanceHealth` | `string` | The health status of the instance. If the status of either the instance status check or the system status check is <code>impaired</code>, the health status of the instance is <code>unhealthy</code>. Otherwise, the health status is <code>healthy</code>. | +| `instanceId` | `string` | The ID of the instance. | +| `instanceType` | `string` | The instance type. | +| `spotInstanceRequestId` | `string` | The ID of the Spot Instance request. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `spot_fleet_instances_Describe` | `SELECT` | `SpotFleetRequestId, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/spot_fleet_request_history/index.md b/docs/aws-docs/providers/aws/ec2_api/spot_fleet_request_history/index.md new file mode 100644 index 0000000000..a1f19025de --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/spot_fleet_request_history/index.md @@ -0,0 +1,36 @@ +--- +title: spot_fleet_request_history +hide_title: false +hide_table_of_contents: false +keywords: + - spot_fleet_request_history + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namespot_fleet_request_history
TypeResource
Idaws.ec2_api.spot_fleet_request_history
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `eventInformation` | `object` | Describes an EC2 Fleet or Spot Fleet event. | +| `eventType` | `string` | <p>The event type.</p> <ul> <li> <p> <code>error</code> - An error with the Spot Fleet request.</p> </li> <li> <p> <code>fleetRequestChange</code> - A change in the status or configuration of the Spot Fleet request.</p> </li> <li> <p> <code>instanceChange</code> - An instance was launched or terminated.</p> </li> <li> <p> <code>Information</code> - An informational event.</p> </li> </ul> | +| `timestamp` | `string` | The date and time of the event, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z). | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `spot_fleet_request_history_Describe` | `SELECT` | `SpotFleetRequestId, StartTime, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/spot_fleet_requests/index.md b/docs/aws-docs/providers/aws/ec2_api/spot_fleet_requests/index.md new file mode 100644 index 0000000000..3d10bceeef --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/spot_fleet_requests/index.md @@ -0,0 +1,41 @@ +--- +title: spot_fleet_requests +hide_title: false +hide_table_of_contents: false +keywords: + - spot_fleet_requests + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namespot_fleet_requests
TypeResource
Idaws.ec2_api.spot_fleet_requests
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `activityStatus` | `string` | The progress of the Spot Fleet request. If there is an error, the status is <code>error</code>. After all requests are placed, the status is <code>pending_fulfillment</code>. If the size of the fleet is equal to or greater than its target capacity, the status is <code>fulfilled</code>. If the size of the fleet is decreased, the status is <code>pending_termination</code> while Spot Instances are terminating. | +| `createTime` | `string` | The creation date and time of the request. | +| `spotFleetRequestConfig` | `object` | Describes the configuration of a Spot Fleet request. | +| `spotFleetRequestId` | `string` | The ID of the Spot Fleet request. | +| `spotFleetRequestState` | `string` | The state of the Spot Fleet request. | +| `tagSet` | `array` | The tags for a Spot Fleet resource. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `spot_fleet_requests_Describe` | `SELECT` | `region` | <p>Describes your Spot Fleet requests.</p> <p>Spot Fleet requests are deleted 48 hours after they are canceled and their instances are terminated.</p> | +| `spot_fleet_request_Modify` | `EXEC` | `SpotFleetRequestId, region` | <p>Modifies the specified Spot Fleet request.</p> <p>You can only modify a Spot Fleet request of type <code>maintain</code>.</p> <p>While the Spot Fleet request is being modified, it is in the <code>modifying</code> state.</p> <p>To scale up your Spot Fleet, increase its target capacity. The Spot Fleet launches the additional Spot Instances according to the allocation strategy for the Spot Fleet request. If the allocation strategy is <code>lowestPrice</code>, the Spot Fleet launches instances using the Spot Instance pool with the lowest price. If the allocation strategy is <code>diversified</code>, the Spot Fleet distributes the instances across the Spot Instance pools. If the allocation strategy is <code>capacityOptimized</code>, Spot Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.</p> <p>To scale down your Spot Fleet, decrease its target capacity. First, the Spot Fleet cancels any open requests that exceed the new target capacity. You can request that the Spot Fleet terminate Spot Instances until the size of the fleet no longer exceeds the new target capacity. If the allocation strategy is <code>lowestPrice</code>, the Spot Fleet terminates the instances with the highest price per unit. If the allocation strategy is <code>capacityOptimized</code>, the Spot Fleet terminates the instances in the Spot Instance pools that have the least available Spot Instance capacity. If the allocation strategy is <code>diversified</code>, the Spot Fleet terminates instances across the Spot Instance pools. Alternatively, you can request that the Spot Fleet keep the fleet at its current size, but not replace any Spot Instances that are interrupted or that you terminate manually.</p> <p>If you are finished with your Spot Fleet for now, but will use it again later, you can set the target capacity to 0.</p> | +| `spot_fleet_requests_Cancel` | `EXEC` | `SpotFleetRequestId, TerminateInstances, region` | <p>Cancels the specified Spot Fleet requests.</p> <p>After you cancel a Spot Fleet request, the Spot Fleet launches no new Spot Instances. You must specify whether the Spot Fleet should also terminate its Spot Instances. If you terminate the instances, the Spot Fleet request enters the <code>cancelled_terminating</code> state. Otherwise, the Spot Fleet request enters the <code>cancelled_running</code> state and the instances continue to run until they are interrupted or you terminate them manually.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/spot_instance_requests/index.md b/docs/aws-docs/providers/aws/ec2_api/spot_instance_requests/index.md new file mode 100644 index 0000000000..81334d2656 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/spot_instance_requests/index.md @@ -0,0 +1,53 @@ +--- +title: spot_instance_requests +hide_title: false +hide_table_of_contents: false +keywords: + - spot_instance_requests + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namespot_instance_requests
TypeResource
Idaws.ec2_api.spot_instance_requests
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `actualBlockHourlyPrice` | `string` | Deprecated. | +| `availabilityZoneGroup` | `string` | The Availability Zone group. If you specify the same Availability Zone group for all Spot Instance requests, all Spot Instances are launched in the same Availability Zone. | +| `blockDurationMinutes` | `integer` | Deprecated. | +| `createTime` | `string` | The date and time when the Spot Instance request was created, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z). | +| `fault` | `object` | Describes a Spot Instance state change. | +| `instanceId` | `string` | The instance ID, if an instance has been launched to fulfill the Spot Instance request. | +| `instanceInterruptionBehavior` | `string` | The behavior when a Spot Instance is interrupted. | +| `launchGroup` | `string` | The instance launch group. Launch groups are Spot Instances that launch together and terminate together. | +| `launchSpecification` | `object` | Describes the launch specification for an instance. | +| `launchedAvailabilityZone` | `string` | The Availability Zone in which the request is launched. | +| `productDescription` | `string` | The product description associated with the Spot Instance. | +| `spotInstanceRequestId` | `string` | The ID of the Spot Instance request. | +| `spotPrice` | `string` | The maximum price per hour that you are willing to pay for a Spot Instance. | +| `state` | `string` | The state of the Spot Instance request. Spot request status information helps track your Spot Instance requests. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-request-status.html">Spot request status</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>. | +| `status` | `object` | Describes the status of a Spot Instance request. | +| `tagSet` | `array` | Any tags assigned to the resource. | +| `type` | `string` | The Spot Instance request type. | +| `validFrom` | `string` | The start date of the request, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z). The request becomes active at this date and time. | +| `validUntil` | `string` | <p>The end date of the request, in UTC format (<i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z).</p> <ul> <li> <p>For a persistent request, the request remains active until the <code>validUntil</code> date and time is reached. Otherwise, the request remains active until you cancel it. </p> </li> <li> <p>For a one-time request, the request remains active until all instances launch, the request is canceled, or the <code>validUntil</code> date and time is reached. By default, the request is valid for 7 days from the date the request was created.</p> </li> </ul> | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `spot_instance_requests_Describe` | `SELECT` | `region` | <p>Describes the specified Spot Instance requests.</p> <p>You can use <code>DescribeSpotInstanceRequests</code> to find a running Spot Instance by examining the response. If the status of the Spot Instance is <code>fulfilled</code>, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances">DescribeInstances</a> with a filter to look for instances where the instance lifecycle is <code>spot</code>.</p> <p>We recommend that you set <code>MaxResults</code> to a value between 5 and 1000 to limit the number of results returned. This paginates the output, which makes the list more manageable and returns the results faster. If the list of results exceeds your <code>MaxResults</code> value, then that number of results is returned along with a <code>NextToken</code> value that can be passed to a subsequent <code>DescribeSpotInstanceRequests</code> request to retrieve the remaining results.</p> <p>Spot Instance requests are deleted four hours after they are canceled and their instances are terminated.</p> | +| `spot_instance_requests_Cancel` | `EXEC` | `SpotInstanceRequestId, region` | <p>Cancels one or more Spot Instance requests.</p> <important> <p>Canceling a Spot Instance request does not terminate running Spot Instances associated with the request.</p> </important> | diff --git a/docs/aws-docs/providers/aws/ec2_api/spot_instances/index.md b/docs/aws-docs/providers/aws/ec2_api/spot_instances/index.md new file mode 100644 index 0000000000..39b8ef528d --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/spot_instances/index.md @@ -0,0 +1,32 @@ +--- +title: spot_instances +hide_title: false +hide_table_of_contents: false +keywords: + - spot_instances + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namespot_instances
TypeResource
Idaws.ec2_api.spot_instances
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `spot_instances_Request` | `EXEC` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/spot_placement_scores/index.md b/docs/aws-docs/providers/aws/ec2_api/spot_placement_scores/index.md new file mode 100644 index 0000000000..3b89f3df0e --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/spot_placement_scores/index.md @@ -0,0 +1,36 @@ +--- +title: spot_placement_scores +hide_title: false +hide_table_of_contents: false +keywords: + - spot_placement_scores + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namespot_placement_scores
TypeResource
Idaws.ec2_api.spot_placement_scores
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `availabilityZoneId` | `string` | The Availability Zone. | +| `region` | `string` | The Region. | +| `score` | `integer` | The placement score, on a scale from <code>1</code> to <code>10</code>. A score of <code>10</code> indicates that your Spot request is highly likely to succeed in this Region or Availability Zone. A score of <code>1</code> indicates that your Spot request is not likely to succeed. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `spot_placement_scores_Get` | `SELECT` | `TargetCapacity, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/spot_price_history/index.md b/docs/aws-docs/providers/aws/ec2_api/spot_price_history/index.md new file mode 100644 index 0000000000..47b69a529f --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/spot_price_history/index.md @@ -0,0 +1,38 @@ +--- +title: spot_price_history +hide_title: false +hide_table_of_contents: false +keywords: + - spot_price_history + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namespot_price_history
TypeResource
Idaws.ec2_api.spot_price_history
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `availabilityZone` | `string` | The Availability Zone. | +| `instanceType` | `string` | The instance type. | +| `productDescription` | `string` | A general description of the AMI. | +| `spotPrice` | `string` | The maximum price per hour that you are willing to pay for a Spot Instance. | +| `timestamp` | `string` | The date and time the request was created, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z). | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `spot_price_history_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/stale_security_groups/index.md b/docs/aws-docs/providers/aws/ec2_api/stale_security_groups/index.md new file mode 100644 index 0000000000..8474bdbe83 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/stale_security_groups/index.md @@ -0,0 +1,39 @@ +--- +title: stale_security_groups +hide_title: false +hide_table_of_contents: false +keywords: + - stale_security_groups + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namestale_security_groups
TypeResource
Idaws.ec2_api.stale_security_groups
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `description` | `string` | The description of the security group. | +| `groupId` | `string` | The ID of the security group. | +| `groupName` | `string` | The name of the security group. | +| `staleIpPermissions` | `array` | Information about the stale inbound rules in the security group. | +| `staleIpPermissionsEgress` | `array` | Information about the stale outbound rules in the security group. | +| `vpcId` | `string` | The ID of the VPC for the security group. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `stale_security_groups_Describe` | `SELECT` | `VpcId, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/store_image_tasks/index.md b/docs/aws-docs/providers/aws/ec2_api/store_image_tasks/index.md new file mode 100644 index 0000000000..f8bc1a7573 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/store_image_tasks/index.md @@ -0,0 +1,41 @@ +--- +title: store_image_tasks +hide_title: false +hide_table_of_contents: false +keywords: + - store_image_tasks + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namestore_image_tasks
TypeResource
Idaws.ec2_api.store_image_tasks
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `amiId` | `string` | The ID of the AMI that is being stored. | +| `bucket` | `string` | The name of the Amazon S3 bucket that contains the stored AMI object. | +| `progressPercentage` | `integer` | The progress of the task as a percentage. | +| `s3objectKey` | `string` | The name of the stored AMI object in the bucket. | +| `storeTaskFailureReason` | `string` | If the tasks fails, the reason for the failure is returned. If the task succeeds, <code>null</code> is returned. | +| `storeTaskState` | `string` | The state of the store task (<code>InProgress</code>, <code>Completed</code>, or <code>Failed</code>). | +| `taskStartTime` | `string` | The time the task started. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `store_image_tasks_Describe` | `SELECT` | `region` | <p>Describes the progress of the AMI store tasks. You can describe the store tasks for specified AMIs. If you don't specify the AMIs, you get a paginated list of store tasks from the last 31 days.</p> <p>For each AMI task, the response indicates if the task is <code>InProgress</code>, <code>Completed</code>, or <code>Failed</code>. For tasks <code>InProgress</code>, the response shows the estimated progress as a percentage.</p> <p>Tasks are listed in reverse chronological order. Currently, only tasks from the past 31 days can be viewed.</p> <p>To use this API, you must have the required permissions. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html#ami-s3-permissions">Permissions for storing and restoring AMIs using Amazon S3</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html">Store and restore an AMI using Amazon S3</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | +| `store_image_task_Create` | `INSERT` | `Bucket, ImageId, region` | <p>Stores an AMI as a single object in an Amazon S3 bucket.</p> <p>To use this API, you must have the required permissions. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html#ami-s3-permissions">Permissions for storing and restoring AMIs using Amazon S3</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html">Store and restore an AMI using Amazon S3</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/subnet_attribute/index.md b/docs/aws-docs/providers/aws/ec2_api/subnet_attribute/index.md new file mode 100644 index 0000000000..2a2442749f --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/subnet_attribute/index.md @@ -0,0 +1,32 @@ +--- +title: subnet_attribute +hide_title: false +hide_table_of_contents: false +keywords: + - subnet_attribute + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namesubnet_attribute
TypeResource
Idaws.ec2_api.subnet_attribute
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `subnet_attribute_Modify` | `EXEC` | `SubnetId, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/subnet_cidr_block/index.md b/docs/aws-docs/providers/aws/ec2_api/subnet_cidr_block/index.md new file mode 100644 index 0000000000..9a6d8e22a0 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/subnet_cidr_block/index.md @@ -0,0 +1,33 @@ +--- +title: subnet_cidr_block +hide_title: false +hide_table_of_contents: false +keywords: + - subnet_cidr_block + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namesubnet_cidr_block
TypeResource
Idaws.ec2_api.subnet_cidr_block
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `subnet_cidr_block_Associate` | `EXEC` | `Ipv6CidrBlock, SubnetId, region` | Associates a CIDR block with your subnet. You can only associate a single IPv6 CIDR block with your subnet. An IPv6 CIDR block must have a prefix length of /64. | +| `subnet_cidr_block_Disassociate` | `EXEC` | `AssociationId, region` | Disassociates a CIDR block from a subnet. Currently, you can disassociate an IPv6 CIDR block only. You must detach or delete all gateways and resources that are associated with the CIDR block before you can disassociate it. | diff --git a/docs/aws-docs/providers/aws/ec2_api/subnet_cidr_reservations/index.md b/docs/aws-docs/providers/aws/ec2_api/subnet_cidr_reservations/index.md new file mode 100644 index 0000000000..49ec391560 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/subnet_cidr_reservations/index.md @@ -0,0 +1,38 @@ +--- +title: subnet_cidr_reservations +hide_title: false +hide_table_of_contents: false +keywords: + - subnet_cidr_reservations + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namesubnet_cidr_reservations
TypeResource
Idaws.ec2_api.subnet_cidr_reservations
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `nextToken` | `string` | The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return. | +| `subnetIpv4CidrReservationSet` | `array` | Information about the IPv4 subnet CIDR reservations. | +| `subnetIpv6CidrReservationSet` | `array` | Information about the IPv6 subnet CIDR reservations. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `subnet_cidr_reservations_Get` | `SELECT` | `SubnetId, region` | Gets information about the subnet CIDR reservations. | +| `subnet_cidr_reservation_Create` | `INSERT` | `Cidr, ReservationType, SubnetId, region` | Creates a subnet CIDR reservation. For information about subnet CIDR reservations, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/subnet-cidr-reservation.html">Subnet CIDR reservations</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. | +| `subnet_cidr_reservation_Delete` | `DELETE` | `SubnetCidrReservationId, region` | Deletes a subnet CIDR reservation. | diff --git a/docs/aws-docs/providers/aws/ec2_api/subnets/index.md b/docs/aws-docs/providers/aws/ec2_api/subnets/index.md new file mode 100644 index 0000000000..d9b0888c94 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/subnets/index.md @@ -0,0 +1,56 @@ +--- +title: subnets +hide_title: false +hide_table_of_contents: false +keywords: + - subnets + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namesubnets
TypeResource
Idaws.ec2_api.subnets
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `assignIpv6AddressOnCreation` | `boolean` | Indicates whether a network interface created in this subnet (including a network interface created by <a>RunInstances</a>) receives an IPv6 address. | +| `availabilityZone` | `string` | The Availability Zone of the subnet. | +| `availabilityZoneId` | `string` | The AZ ID of the subnet. | +| `availableIpAddressCount` | `integer` | The number of unused private IPv4 addresses in the subnet. The IPv4 addresses for any stopped instances are considered unavailable. | +| `cidrBlock` | `string` | The IPv4 CIDR block assigned to the subnet. | +| `customerOwnedIpv4Pool` | `string` | The customer-owned IPv4 address pool associated with the subnet. | +| `defaultForAz` | `boolean` | Indicates whether this is the default subnet for the Availability Zone. | +| `enableDns64` | `boolean` | Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations. | +| `enableLniAtDeviceIndex` | `integer` | Indicates the device position for local network interfaces in this subnet. For example, <code>1</code> indicates local network interfaces in this subnet are the secondary network interface (eth1). | +| `ipv6CidrBlockAssociationSet` | `array` | Information about the IPv6 CIDR blocks associated with the subnet. | +| `ipv6Native` | `boolean` | Indicates whether this is an IPv6 only subnet. | +| `mapCustomerOwnedIpOnLaunch` | `boolean` | Indicates whether a network interface created in this subnet (including a network interface created by <a>RunInstances</a>) receives a customer-owned IPv4 address. | +| `mapPublicIpOnLaunch` | `boolean` | Indicates whether instances launched in this subnet receive a public IPv4 address. | +| `outpostArn` | `string` | The Amazon Resource Name (ARN) of the Outpost. | +| `ownerId` | `string` | The ID of the Amazon Web Services account that owns the subnet. | +| `privateDnsNameOptionsOnLaunch` | `object` | Describes the options for instance hostnames. | +| `state` | `string` | The current state of the subnet. | +| `subnetArn` | `string` | The Amazon Resource Name (ARN) of the subnet. | +| `subnetId` | `string` | The ID of the subnet. | +| `tagSet` | `array` | Any tags assigned to the subnet. | +| `vpcId` | `string` | The ID of the VPC the subnet is in. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `subnets_Describe` | `SELECT` | `region` | <p>Describes one or more of your subnets.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html">Your VPC and subnets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p> | +| `subnet_Create` | `INSERT` | `VpcId, region` | <p>Creates a subnet in a specified VPC.</p> <p>You must specify an IPv4 CIDR block for the subnet. After you create a subnet, you can't change its CIDR block. The allowed block size is between a /16 netmask (65,536 IP addresses) and /28 netmask (16 IP addresses). The CIDR block must not overlap with the CIDR block of an existing subnet in the VPC.</p> <p>If you've associated an IPv6 CIDR block with your VPC, you can create a subnet with an IPv6 CIDR block that uses a /64 prefix length. </p> <important> <p>Amazon Web Services reserves both the first four and the last IPv4 address in each subnet's CIDR block. They're not available for use.</p> </important> <p>If you add more than one subnet to a VPC, they're set up in a star topology with a logical router in the middle.</p> <p>When you stop an instance in a subnet, it retains its private IPv4 address. It's therefore possible to have a subnet with no running instances (they're all stopped), but no remaining IP addresses available.</p> <p>For more information about subnets, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html">Your VPC and subnets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p> | +| `subnet_Delete` | `DELETE` | `SubnetId, region` | Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet. | diff --git a/docs/aws-docs/providers/aws/ec2_api/tags/index.md b/docs/aws-docs/providers/aws/ec2_api/tags/index.md new file mode 100644 index 0000000000..e0bcb97e95 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/tags/index.md @@ -0,0 +1,39 @@ +--- +title: tags +hide_title: false +hide_table_of_contents: false +keywords: + - tags + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nametags
TypeResource
Idaws.ec2_api.tags
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `key` | `string` | The tag key. | +| `resourceId` | `string` | The ID of the resource. | +| `resourceType` | `string` | The resource type. | +| `value` | `string` | The tag value. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `tags_Describe` | `SELECT` | `region` | <p>Describes the specified tags for your EC2 resources.</p> <p>For more information about tags, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html">Tagging Your Resources</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | +| `tags_Create` | `INSERT` | `ResourceId, Tag, region` | <p>Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.</p> <p>For more information about tags, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html">Tagging Your Resources</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. For more information about creating IAM policies that control users' access to resources based on tags, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-iam-actions-resources.html">Supported Resource-Level Permissions for Amazon EC2 API Actions</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | +| `tags_Delete` | `DELETE` | `ResourceId, region` | <p>Deletes the specified set of tags from the specified set of resources.</p> <p>To list the current tags, use <a>DescribeTags</a>. For more information about tags, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html">Tagging Your Resources</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/traffic_mirror_filter_network_services/index.md b/docs/aws-docs/providers/aws/ec2_api/traffic_mirror_filter_network_services/index.md new file mode 100644 index 0000000000..60ab9a97c8 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/traffic_mirror_filter_network_services/index.md @@ -0,0 +1,32 @@ +--- +title: traffic_mirror_filter_network_services +hide_title: false +hide_table_of_contents: false +keywords: + - traffic_mirror_filter_network_services + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nametraffic_mirror_filter_network_services
TypeResource
Idaws.ec2_api.traffic_mirror_filter_network_services
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `traffic_mirror_filter_network_services_Modify` | `EXEC` | `TrafficMirrorFilterId, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/traffic_mirror_filter_rule/index.md b/docs/aws-docs/providers/aws/ec2_api/traffic_mirror_filter_rule/index.md new file mode 100644 index 0000000000..4396fcab14 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/traffic_mirror_filter_rule/index.md @@ -0,0 +1,34 @@ +--- +title: traffic_mirror_filter_rule +hide_title: false +hide_table_of_contents: false +keywords: + - traffic_mirror_filter_rule + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nametraffic_mirror_filter_rule
TypeResource
Idaws.ec2_api.traffic_mirror_filter_rule
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `traffic_mirror_filter_rule_Create` | `INSERT` | `DestinationCidrBlock, RuleAction, RuleNumber, SourceCidrBlock, TrafficDirection, TrafficMirrorFilterId, region` | <p>Creates a Traffic Mirror filter rule.</p> <p>A Traffic Mirror rule defines the Traffic Mirror source traffic to mirror.</p> <p>You need the Traffic Mirror filter ID when you create the rule.</p> | +| `traffic_mirror_filter_rule_Delete` | `DELETE` | `TrafficMirrorFilterRuleId, region` | Deletes the specified Traffic Mirror rule. | +| `traffic_mirror_filter_rule_Modify` | `EXEC` | `TrafficMirrorFilterRuleId, region` | <p>Modifies the specified Traffic Mirror rule.</p> <p> <code>DestinationCidrBlock</code> and <code>SourceCidrBlock</code> must both be an IPv4 range or an IPv6 range.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/traffic_mirror_filters/index.md b/docs/aws-docs/providers/aws/ec2_api/traffic_mirror_filters/index.md new file mode 100644 index 0000000000..e9d57312a6 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/traffic_mirror_filters/index.md @@ -0,0 +1,41 @@ +--- +title: traffic_mirror_filters +hide_title: false +hide_table_of_contents: false +keywords: + - traffic_mirror_filters + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nametraffic_mirror_filters
TypeResource
Idaws.ec2_api.traffic_mirror_filters
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `description` | `string` | The description of the Traffic Mirror filter. | +| `egressFilterRuleSet` | `array` | Information about the egress rules that are associated with the Traffic Mirror filter. | +| `ingressFilterRuleSet` | `array` | Information about the ingress rules that are associated with the Traffic Mirror filter. | +| `networkServiceSet` | `array` | The network service traffic that is associated with the Traffic Mirror filter. | +| `tagSet` | `array` | The tags assigned to the Traffic Mirror filter. | +| `trafficMirrorFilterId` | `string` | The ID of the Traffic Mirror filter. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `traffic_mirror_filters_Describe` | `SELECT` | `region` | Describes one or more Traffic Mirror filters. | +| `traffic_mirror_filter_Create` | `INSERT` | `region` | <p>Creates a Traffic Mirror filter.</p> <p>A Traffic Mirror filter is a set of rules that defines the traffic to mirror.</p> <p>By default, no traffic is mirrored. To mirror traffic, use <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTrafficMirrorFilterRule.htm">CreateTrafficMirrorFilterRule</a> to add Traffic Mirror rules to the filter. The rules you add define what traffic gets mirrored. You can also use <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyTrafficMirrorFilterNetworkServices.html">ModifyTrafficMirrorFilterNetworkServices</a> to mirror supported network services.</p> | +| `traffic_mirror_filter_Delete` | `DELETE` | `TrafficMirrorFilterId, region` | <p>Deletes the specified Traffic Mirror filter.</p> <p>You cannot delete a Traffic Mirror filter that is in use by a Traffic Mirror session.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/traffic_mirror_sessions/index.md b/docs/aws-docs/providers/aws/ec2_api/traffic_mirror_sessions/index.md new file mode 100644 index 0000000000..d661891f6e --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/traffic_mirror_sessions/index.md @@ -0,0 +1,46 @@ +--- +title: traffic_mirror_sessions +hide_title: false +hide_table_of_contents: false +keywords: + - traffic_mirror_sessions + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nametraffic_mirror_sessions
TypeResource
Idaws.ec2_api.traffic_mirror_sessions
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `description` | `string` | The description of the Traffic Mirror session. | +| `networkInterfaceId` | `string` | The ID of the Traffic Mirror session's network interface. | +| `ownerId` | `string` | The ID of the account that owns the Traffic Mirror session. | +| `packetLength` | `integer` | The number of bytes in each packet to mirror. These are the bytes after the VXLAN header. To mirror a subset, set this to the length (in bytes) to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target. Do not specify this parameter when you want to mirror the entire packet | +| `sessionNumber` | `integer` | <p>The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.</p> <p>Valid values are 1-32766.</p> | +| `tagSet` | `array` | The tags assigned to the Traffic Mirror session. | +| `trafficMirrorFilterId` | `string` | The ID of the Traffic Mirror filter. | +| `trafficMirrorSessionId` | `string` | The ID for the Traffic Mirror session. | +| `trafficMirrorTargetId` | `string` | The ID of the Traffic Mirror target. | +| `virtualNetworkId` | `integer` | The virtual network ID associated with the Traffic Mirror session. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `traffic_mirror_sessions_Describe` | `SELECT` | `region` | Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results. | +| `traffic_mirror_session_Create` | `INSERT` | `NetworkInterfaceId, SessionNumber, TrafficMirrorFilterId, TrafficMirrorTargetId, region` | <p>Creates a Traffic Mirror session.</p> <p>A Traffic Mirror session actively copies packets from a Traffic Mirror source to a Traffic Mirror target. Create a filter, and then assign it to the session to define a subset of the traffic to mirror, for example all TCP traffic.</p> <p>The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in a different VPC connected via VPC peering or a transit gateway. </p> <p>By default, no traffic is mirrored. Use <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTrafficMirrorFilter.htm">CreateTrafficMirrorFilter</a> to create filter rules that specify the traffic to mirror.</p> | +| `traffic_mirror_session_Delete` | `DELETE` | `TrafficMirrorSessionId, region` | Deletes the specified Traffic Mirror session. | +| `traffic_mirror_session_Modify` | `EXEC` | `TrafficMirrorSessionId, region` | Modifies a Traffic Mirror session. | diff --git a/docs/aws-docs/providers/aws/ec2_api/traffic_mirror_targets/index.md b/docs/aws-docs/providers/aws/ec2_api/traffic_mirror_targets/index.md new file mode 100644 index 0000000000..1cfd399783 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/traffic_mirror_targets/index.md @@ -0,0 +1,43 @@ +--- +title: traffic_mirror_targets +hide_title: false +hide_table_of_contents: false +keywords: + - traffic_mirror_targets + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nametraffic_mirror_targets
TypeResource
Idaws.ec2_api.traffic_mirror_targets
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `description` | `string` | Information about the Traffic Mirror target. | +| `gatewayLoadBalancerEndpointId` | `string` | The ID of the Gateway Load Balancer endpoint. | +| `networkInterfaceId` | `string` | The network interface ID that is attached to the target. | +| `networkLoadBalancerArn` | `string` | The Amazon Resource Name (ARN) of the Network Load Balancer. | +| `ownerId` | `string` | The ID of the account that owns the Traffic Mirror target. | +| `tagSet` | `array` | The tags assigned to the Traffic Mirror target. | +| `trafficMirrorTargetId` | `string` | The ID of the Traffic Mirror target. | +| `type` | `string` | The type of Traffic Mirror target. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `traffic_mirror_targets_Describe` | `SELECT` | `region` | Information about one or more Traffic Mirror targets. | +| `traffic_mirror_target_Create` | `INSERT` | `region` | <p>Creates a target for your Traffic Mirror session.</p> <p>A Traffic Mirror target is the destination for mirrored traffic. The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in different VPCs connected via VPC peering or a transit gateway.</p> <p>A Traffic Mirror target can be a network interface, a Network Load Balancer, or a Gateway Load Balancer endpoint.</p> <p>To use the target in a Traffic Mirror session, use <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTrafficMirrorSession.htm">CreateTrafficMirrorSession</a>.</p> | +| `traffic_mirror_target_Delete` | `DELETE` | `TrafficMirrorTargetId, region` | <p>Deletes the specified Traffic Mirror target.</p> <p>You cannot delete a Traffic Mirror target that is in use by a Traffic Mirror session.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/transit_gateway_attachment_propagations/index.md b/docs/aws-docs/providers/aws/ec2_api/transit_gateway_attachment_propagations/index.md new file mode 100644 index 0000000000..bd44f74e43 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/transit_gateway_attachment_propagations/index.md @@ -0,0 +1,35 @@ +--- +title: transit_gateway_attachment_propagations +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_attachment_propagations + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nametransit_gateway_attachment_propagations
TypeResource
Idaws.ec2_api.transit_gateway_attachment_propagations
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `state` | `string` | The state of the propagation route table. | +| `transitGatewayRouteTableId` | `string` | The ID of the propagation route table. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `transit_gateway_attachment_propagations_Get` | `SELECT` | `TransitGatewayAttachmentId, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/transit_gateway_attachments/index.md b/docs/aws-docs/providers/aws/ec2_api/transit_gateway_attachments/index.md new file mode 100644 index 0000000000..c5f3d798af --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/transit_gateway_attachments/index.md @@ -0,0 +1,43 @@ +--- +title: transit_gateway_attachments +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_attachments + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nametransit_gateway_attachments
TypeResource
Idaws.ec2_api.transit_gateway_attachments
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `association` | `object` | Describes an association. | +| `creationTime` | `string` | The creation time. | +| `resourceId` | `string` | The ID of the resource. | +| `resourceOwnerId` | `string` | The ID of the Amazon Web Services account that owns the resource. | +| `resourceType` | `string` | The resource type. Note that the <code>tgw-peering</code> resource type has been deprecated. | +| `state` | `string` | The attachment state. Note that the <code>initiating</code> state has been deprecated. | +| `tagSet` | `array` | The tags for the attachment. | +| `transitGatewayAttachmentId` | `string` | The ID of the attachment. | +| `transitGatewayId` | `string` | The ID of the transit gateway. | +| `transitGatewayOwnerId` | `string` | The ID of the Amazon Web Services account that owns the transit gateway. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `transit_gateway_attachments_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/transit_gateway_connect_peers/index.md b/docs/aws-docs/providers/aws/ec2_api/transit_gateway_connect_peers/index.md new file mode 100644 index 0000000000..d5382458b8 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/transit_gateway_connect_peers/index.md @@ -0,0 +1,41 @@ +--- +title: transit_gateway_connect_peers +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_connect_peers + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nametransit_gateway_connect_peers
TypeResource
Idaws.ec2_api.transit_gateway_connect_peers
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `connectPeerConfiguration` | `object` | Describes the Connect peer details. | +| `creationTime` | `string` | The creation time. | +| `state` | `string` | The state of the Connect peer. | +| `tagSet` | `array` | The tags for the Connect peer. | +| `transitGatewayAttachmentId` | `string` | The ID of the Connect attachment. | +| `transitGatewayConnectPeerId` | `string` | The ID of the Connect peer. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `transit_gateway_connect_peers_Describe` | `SELECT` | `region` | Describes one or more Connect peers. | +| `transit_gateway_connect_peer_Create` | `INSERT` | `InsideCidrBlocks, PeerAddress, TransitGatewayAttachmentId, region` | <p>Creates a Connect peer for a specified transit gateway Connect attachment between a transit gateway and an appliance.</p> <p>The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).</p> <p>For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/tgw/tgw-connect.html#tgw-connect-peer">Connect peers</a> in the <i>Transit Gateways Guide</i>.</p> | +| `transit_gateway_connect_peer_Delete` | `DELETE` | `TransitGatewayConnectPeerId, region` | Deletes the specified Connect peer. | diff --git a/docs/aws-docs/providers/aws/ec2_api/transit_gateway_connects/index.md b/docs/aws-docs/providers/aws/ec2_api/transit_gateway_connects/index.md new file mode 100644 index 0000000000..48d71f1987 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/transit_gateway_connects/index.md @@ -0,0 +1,42 @@ +--- +title: transit_gateway_connects +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_connects + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nametransit_gateway_connects
TypeResource
Idaws.ec2_api.transit_gateway_connects
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `creationTime` | `string` | The creation time. | +| `options` | `object` | Describes the Connect attachment options. | +| `state` | `string` | The state of the attachment. | +| `tagSet` | `array` | The tags for the attachment. | +| `transitGatewayAttachmentId` | `string` | The ID of the Connect attachment. | +| `transitGatewayId` | `string` | The ID of the transit gateway. | +| `transportTransitGatewayAttachmentId` | `string` | The ID of the attachment from which the Connect attachment was created. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `transit_gateway_connects_Describe` | `SELECT` | `region` | Describes one or more Connect attachments. | +| `transit_gateway_connect_Create` | `INSERT` | `Options, TransportTransitGatewayAttachmentId, region` | <p>Creates a Connect attachment from a specified transit gateway attachment. A Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a transit gateway and an appliance.</p> <p>A Connect attachment uses an existing VPC or Amazon Web Services Direct Connect attachment as the underlying transport mechanism.</p> | +| `transit_gateway_connect_Delete` | `DELETE` | `TransitGatewayAttachmentId, region` | Deletes the specified Connect attachment. You must first delete any Connect peers for the attachment. | diff --git a/docs/aws-docs/providers/aws/ec2_api/transit_gateway_multicast_domain_associations/index.md b/docs/aws-docs/providers/aws/ec2_api/transit_gateway_multicast_domain_associations/index.md new file mode 100644 index 0000000000..2a52ea4923 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/transit_gateway_multicast_domain_associations/index.md @@ -0,0 +1,40 @@ +--- +title: transit_gateway_multicast_domain_associations +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_multicast_domain_associations + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nametransit_gateway_multicast_domain_associations
TypeResource
Idaws.ec2_api.transit_gateway_multicast_domain_associations
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `resourceId` | `string` | The ID of the resource. | +| `resourceOwnerId` | `string` | The ID of the Amazon Web Services account that owns the transit gateway multicast domain association resource. | +| `resourceType` | `string` | The type of resource, for example a VPC attachment. | +| `subnet` | `object` | Describes the subnet association with the transit gateway multicast domain. | +| `transitGatewayAttachmentId` | `string` | The ID of the transit gateway attachment. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `transit_gateway_multicast_domain_associations_Get` | `SELECT` | `region` | Gets information about the associations for the transit gateway multicast domain. | +| `transit_gateway_multicast_domain_associations_Accept` | `EXEC` | `region` | Accepts a request to associate subnets with a transit gateway multicast domain. | +| `transit_gateway_multicast_domain_associations_Reject` | `EXEC` | `region` | Rejects a request to associate cross-account subnets with a transit gateway multicast domain. | diff --git a/docs/aws-docs/providers/aws/ec2_api/transit_gateway_multicast_domains/index.md b/docs/aws-docs/providers/aws/ec2_api/transit_gateway_multicast_domains/index.md new file mode 100644 index 0000000000..58ed03ddbc --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/transit_gateway_multicast_domains/index.md @@ -0,0 +1,45 @@ +--- +title: transit_gateway_multicast_domains +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_multicast_domains + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nametransit_gateway_multicast_domains
TypeResource
Idaws.ec2_api.transit_gateway_multicast_domains
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `creationTime` | `string` | The time the transit gateway multicast domain was created. | +| `options` | `object` | Describes the options for a transit gateway multicast domain. | +| `ownerId` | `string` | The ID of the Amazon Web Services account that owns the transit gateway multicast domain. | +| `state` | `string` | The state of the transit gateway multicast domain. | +| `tagSet` | `array` | The tags for the transit gateway multicast domain. | +| `transitGatewayId` | `string` | The ID of the transit gateway. | +| `transitGatewayMulticastDomainArn` | `string` | The Amazon Resource Name (ARN) of the transit gateway multicast domain. | +| `transitGatewayMulticastDomainId` | `string` | The ID of the transit gateway multicast domain. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `transit_gateway_multicast_domains_Describe` | `SELECT` | `region` | Describes one or more transit gateway multicast domains. | +| `transit_gateway_multicast_domain_Create` | `INSERT` | `TransitGatewayId, region` | <p>Creates a multicast domain using the specified transit gateway.</p> <p>The transit gateway must be in the available state before you create a domain. Use <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeTransitGateways.html">DescribeTransitGateways</a> to see the state of transit gateway.</p> | +| `transit_gateway_multicast_domain_Delete` | `DELETE` | `TransitGatewayMulticastDomainId, region` | Deletes the specified transit gateway multicast domain. | +| `transit_gateway_multicast_domain_Associate` | `EXEC` | `region` | <p>Associates the specified subnets and transit gateway attachments with the specified transit gateway multicast domain.</p> <p>The transit gateway attachment must be in the available state before you can add a resource. Use <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeTransitGatewayAttachments.html">DescribeTransitGatewayAttachments</a> to see the state of the attachment.</p> | +| `transit_gateway_multicast_domain_Disassociate` | `EXEC` | `region` | Disassociates the specified subnets from the transit gateway multicast domain. | diff --git a/docs/aws-docs/providers/aws/ec2_api/transit_gateway_multicast_group_members/index.md b/docs/aws-docs/providers/aws/ec2_api/transit_gateway_multicast_group_members/index.md new file mode 100644 index 0000000000..e3e4e87546 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/transit_gateway_multicast_group_members/index.md @@ -0,0 +1,33 @@ +--- +title: transit_gateway_multicast_group_members +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_multicast_group_members + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nametransit_gateway_multicast_group_members
TypeResource
Idaws.ec2_api.transit_gateway_multicast_group_members
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `transit_gateway_multicast_group_members_Deregister` | `EXEC` | `region` | Deregisters the specified members (network interfaces) from the transit gateway multicast group. | +| `transit_gateway_multicast_group_members_Register` | `EXEC` | `region` | <p>Registers members (network interfaces) with the transit gateway multicast group. A member is a network interface associated with a supported EC2 instance that receives multicast traffic. For information about supported instances, see <a href="https://docs.aws.amazon.com/vpc/latest/tgw/transit-gateway-limits.html#multicast-limits">Multicast Consideration</a> in <i>Amazon VPC Transit Gateways</i>.</p> <p>After you add the members, use <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SearchTransitGatewayMulticastGroups.html">SearchTransitGatewayMulticastGroups</a> to verify that the members were added to the transit gateway multicast group.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/transit_gateway_multicast_group_sources/index.md b/docs/aws-docs/providers/aws/ec2_api/transit_gateway_multicast_group_sources/index.md new file mode 100644 index 0000000000..e35299f7a0 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/transit_gateway_multicast_group_sources/index.md @@ -0,0 +1,33 @@ +--- +title: transit_gateway_multicast_group_sources +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_multicast_group_sources + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nametransit_gateway_multicast_group_sources
TypeResource
Idaws.ec2_api.transit_gateway_multicast_group_sources
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `transit_gateway_multicast_group_sources_Deregister` | `EXEC` | `region` | Deregisters the specified sources (network interfaces) from the transit gateway multicast group. | +| `transit_gateway_multicast_group_sources_Register` | `EXEC` | `region` | <p>Registers sources (network interfaces) with the specified transit gateway multicast group.</p> <p>A multicast source is a network interface attached to a supported instance that sends multicast traffic. For information about supported instances, see <a href="https://docs.aws.amazon.com/vpc/latest/tgw/transit-gateway-limits.html#multicast-limits">Multicast Considerations</a> in <i>Amazon VPC Transit Gateways</i>.</p> <p>After you add the source, use <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SearchTransitGatewayMulticastGroups.html">SearchTransitGatewayMulticastGroups</a> to verify that the source was added to the multicast group.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/transit_gateway_multicast_groups/index.md b/docs/aws-docs/providers/aws/ec2_api/transit_gateway_multicast_groups/index.md new file mode 100644 index 0000000000..2488e59e08 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/transit_gateway_multicast_groups/index.md @@ -0,0 +1,32 @@ +--- +title: transit_gateway_multicast_groups +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_multicast_groups + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nametransit_gateway_multicast_groups
TypeResource
Idaws.ec2_api.transit_gateway_multicast_groups
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `transit_gateway_multicast_groups_Search` | `EXEC` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/transit_gateway_peering_attachments/index.md b/docs/aws-docs/providers/aws/ec2_api/transit_gateway_peering_attachments/index.md new file mode 100644 index 0000000000..17805ca1cf --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/transit_gateway_peering_attachments/index.md @@ -0,0 +1,44 @@ +--- +title: transit_gateway_peering_attachments +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_peering_attachments + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nametransit_gateway_peering_attachments
TypeResource
Idaws.ec2_api.transit_gateway_peering_attachments
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `accepterTgwInfo` | `object` | Information about the transit gateway in the peering attachment. | +| `creationTime` | `string` | The time the transit gateway peering attachment was created. | +| `requesterTgwInfo` | `object` | Information about the transit gateway in the peering attachment. | +| `state` | `string` | The state of the transit gateway peering attachment. Note that the <code>initiating</code> state has been deprecated. | +| `status` | `object` | The status of the transit gateway peering attachment. | +| `tagSet` | `array` | The tags for the transit gateway peering attachment. | +| `transitGatewayAttachmentId` | `string` | The ID of the transit gateway peering attachment. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `transit_gateway_peering_attachments_Describe` | `SELECT` | `region` | Describes your transit gateway peering attachments. | +| `transit_gateway_peering_attachment_Create` | `INSERT` | `PeerAccountId, PeerRegion, PeerTransitGatewayId, TransitGatewayId, region` | <p>Requests a transit gateway peering attachment between the specified transit gateway (requester) and a peer transit gateway (accepter). The transit gateways must be in different Regions. The peer transit gateway can be in your account or a different Amazon Web Services account.</p> <p>After you create the peering attachment, the owner of the accepter transit gateway must accept the attachment request.</p> | +| `transit_gateway_peering_attachment_Delete` | `DELETE` | `TransitGatewayAttachmentId, region` | Deletes a transit gateway peering attachment. | +| `transit_gateway_peering_attachment_Accept` | `EXEC` | `TransitGatewayAttachmentId, region` | Accepts a transit gateway peering attachment request. The peering attachment must be in the <code>pendingAcceptance</code> state. | +| `transit_gateway_peering_attachment_Reject` | `EXEC` | `TransitGatewayAttachmentId, region` | Rejects a transit gateway peering attachment request. | diff --git a/docs/aws-docs/providers/aws/ec2_api/transit_gateway_prefix_list_references/index.md b/docs/aws-docs/providers/aws/ec2_api/transit_gateway_prefix_list_references/index.md new file mode 100644 index 0000000000..72ee1d73b8 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/transit_gateway_prefix_list_references/index.md @@ -0,0 +1,42 @@ +--- +title: transit_gateway_prefix_list_references +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_prefix_list_references + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nametransit_gateway_prefix_list_references
TypeResource
Idaws.ec2_api.transit_gateway_prefix_list_references
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `blackhole` | `boolean` | Indicates whether traffic that matches this route is dropped. | +| `prefixListId` | `string` | The ID of the prefix list. | +| `prefixListOwnerId` | `string` | The ID of the prefix list owner. | +| `state` | `string` | The state of the prefix list reference. | +| `transitGatewayAttachment` | `object` | Describes a transit gateway prefix list attachment. | +| `transitGatewayRouteTableId` | `string` | The ID of the transit gateway route table. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `transit_gateway_prefix_list_references_Get` | `SELECT` | `TransitGatewayRouteTableId, region` | Gets information about the prefix list references in a specified transit gateway route table. | +| `transit_gateway_prefix_list_reference_Create` | `INSERT` | `PrefixListId, TransitGatewayRouteTableId, region` | Creates a reference (route) to a prefix list in a specified transit gateway route table. | +| `transit_gateway_prefix_list_reference_Delete` | `DELETE` | `PrefixListId, TransitGatewayRouteTableId, region` | Deletes a reference (route) to a prefix list in a specified transit gateway route table. | +| `transit_gateway_prefix_list_reference_Modify` | `EXEC` | `PrefixListId, TransitGatewayRouteTableId, region` | Modifies a reference (route) to a prefix list in a specified transit gateway route table. | diff --git a/docs/aws-docs/providers/aws/ec2_api/transit_gateway_route_table_associations/index.md b/docs/aws-docs/providers/aws/ec2_api/transit_gateway_route_table_associations/index.md new file mode 100644 index 0000000000..bc722b4d15 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/transit_gateway_route_table_associations/index.md @@ -0,0 +1,37 @@ +--- +title: transit_gateway_route_table_associations +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_route_table_associations + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nametransit_gateway_route_table_associations
TypeResource
Idaws.ec2_api.transit_gateway_route_table_associations
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `resourceId` | `string` | The ID of the resource. | +| `resourceType` | `string` | The resource type. Note that the <code>tgw-peering</code> resource type has been deprecated. | +| `state` | `string` | The state of the association. | +| `transitGatewayAttachmentId` | `string` | The ID of the attachment. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `transit_gateway_route_table_associations_Get` | `SELECT` | `TransitGatewayRouteTableId, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/transit_gateway_route_table_propagations/index.md b/docs/aws-docs/providers/aws/ec2_api/transit_gateway_route_table_propagations/index.md new file mode 100644 index 0000000000..39abd44efa --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/transit_gateway_route_table_propagations/index.md @@ -0,0 +1,39 @@ +--- +title: transit_gateway_route_table_propagations +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_route_table_propagations + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nametransit_gateway_route_table_propagations
TypeResource
Idaws.ec2_api.transit_gateway_route_table_propagations
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `resourceId` | `string` | The ID of the resource. | +| `resourceType` | `string` | The type of resource. Note that the <code>tgw-peering</code> resource type has been deprecated. | +| `state` | `string` | The state of the resource. | +| `transitGatewayAttachmentId` | `string` | The ID of the attachment. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `transit_gateway_route_table_propagations_Get` | `SELECT` | `TransitGatewayRouteTableId, region` | Gets information about the route table propagations for the specified transit gateway route table. | +| `transit_gateway_route_table_propagation_Disable` | `EXEC` | `TransitGatewayAttachmentId, TransitGatewayRouteTableId, region` | Disables the specified resource attachment from propagating routes to the specified propagation route table. | +| `transit_gateway_route_table_propagation_Enable` | `EXEC` | `TransitGatewayAttachmentId, TransitGatewayRouteTableId, region` | Enables the specified attachment to propagate routes to the specified propagation route table. | diff --git a/docs/aws-docs/providers/aws/ec2_api/transit_gateway_route_tables/index.md b/docs/aws-docs/providers/aws/ec2_api/transit_gateway_route_tables/index.md new file mode 100644 index 0000000000..ec030bb1ee --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/transit_gateway_route_tables/index.md @@ -0,0 +1,44 @@ +--- +title: transit_gateway_route_tables +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_route_tables + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nametransit_gateway_route_tables
TypeResource
Idaws.ec2_api.transit_gateway_route_tables
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `creationTime` | `string` | The creation time. | +| `defaultAssociationRouteTable` | `boolean` | Indicates whether this is the default association route table for the transit gateway. | +| `defaultPropagationRouteTable` | `boolean` | Indicates whether this is the default propagation route table for the transit gateway. | +| `state` | `string` | The state of the transit gateway route table. | +| `tagSet` | `array` | Any tags assigned to the route table. | +| `transitGatewayId` | `string` | The ID of the transit gateway. | +| `transitGatewayRouteTableId` | `string` | The ID of the transit gateway route table. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `transit_gateway_route_tables_Describe` | `SELECT` | `region` | Describes one or more transit gateway route tables. By default, all transit gateway route tables are described. Alternatively, you can filter the results. | +| `transit_gateway_route_table_Create` | `INSERT` | `TransitGatewayId, region` | Creates a route table for the specified transit gateway. | +| `transit_gateway_route_table_Delete` | `DELETE` | `TransitGatewayRouteTableId, region` | Deletes the specified transit gateway route table. You must disassociate the route table from any transit gateway route tables before you can delete it. | +| `transit_gateway_route_table_Associate` | `EXEC` | `TransitGatewayAttachmentId, TransitGatewayRouteTableId, region` | Associates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment. | +| `transit_gateway_route_table_Disassociate` | `EXEC` | `TransitGatewayAttachmentId, TransitGatewayRouteTableId, region` | Disassociates a resource attachment from a transit gateway route table. | diff --git a/docs/aws-docs/providers/aws/ec2_api/transit_gateway_routes/index.md b/docs/aws-docs/providers/aws/ec2_api/transit_gateway_routes/index.md new file mode 100644 index 0000000000..9f7f6bd966 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/transit_gateway_routes/index.md @@ -0,0 +1,36 @@ +--- +title: transit_gateway_routes +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_routes + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nametransit_gateway_routes
TypeResource
Idaws.ec2_api.transit_gateway_routes
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `transit_gateway_route_Create` | `INSERT` | `DestinationCidrBlock, TransitGatewayRouteTableId, region` | Creates a static route for the specified transit gateway route table. | +| `transit_gateway_route_Delete` | `DELETE` | `DestinationCidrBlock, TransitGatewayRouteTableId, region` | Deletes the specified route from the specified transit gateway route table. | +| `transit_gateway_route_Replace` | `EXEC` | `DestinationCidrBlock, TransitGatewayRouteTableId, region` | Replaces the specified route in the specified transit gateway route table. | +| `transit_gateway_routes_Export` | `EXEC` | `S3Bucket, TransitGatewayRouteTableId, region` | <p>Exports routes from the specified transit gateway route table to the specified S3 bucket. By default, all routes are exported. Alternatively, you can filter by CIDR range.</p> <p>The routes are saved to the specified bucket in a JSON file. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/tgw/tgw-route-tables.html#tgw-export-route-tables">Export Route Tables to Amazon S3</a> in <i>Transit Gateways</i>.</p> | +| `transit_gateway_routes_Search` | `EXEC` | `Filter, TransitGatewayRouteTableId, region` | Searches for routes in the specified transit gateway route table. | diff --git a/docs/aws-docs/providers/aws/ec2_api/transit_gateway_vpc_attachments/index.md b/docs/aws-docs/providers/aws/ec2_api/transit_gateway_vpc_attachments/index.md new file mode 100644 index 0000000000..21f20ae6f7 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/transit_gateway_vpc_attachments/index.md @@ -0,0 +1,47 @@ +--- +title: transit_gateway_vpc_attachments +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateway_vpc_attachments + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nametransit_gateway_vpc_attachments
TypeResource
Idaws.ec2_api.transit_gateway_vpc_attachments
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `creationTime` | `string` | The creation time. | +| `options` | `object` | Describes the VPC attachment options. | +| `state` | `string` | The state of the VPC attachment. Note that the <code>initiating</code> state has been deprecated. | +| `subnetIds` | `array` | The IDs of the subnets. | +| `tagSet` | `array` | The tags for the VPC attachment. | +| `transitGatewayAttachmentId` | `string` | The ID of the attachment. | +| `transitGatewayId` | `string` | The ID of the transit gateway. | +| `vpcId` | `string` | The ID of the VPC. | +| `vpcOwnerId` | `string` | The ID of the Amazon Web Services account that owns the VPC. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `transit_gateway_vpc_attachments_Describe` | `SELECT` | `region` | Describes one or more VPC attachments. By default, all VPC attachments are described. Alternatively, you can filter the results. | +| `transit_gateway_vpc_attachment_Create` | `INSERT` | `SubnetIds, TransitGatewayId, VpcId, region` | <p>Attaches the specified VPC to the specified transit gateway.</p> <p>If you attach a VPC with a CIDR range that overlaps the CIDR range of a VPC that is already attached, the new VPC CIDR range is not propagated to the default propagation route table.</p> <p>To send VPC traffic to an attached transit gateway, add a route to the VPC route table using <a>CreateRoute</a>.</p> | +| `transit_gateway_vpc_attachment_Delete` | `DELETE` | `TransitGatewayAttachmentId, region` | Deletes the specified VPC attachment. | +| `transit_gateway_vpc_attachment_Accept` | `EXEC` | `TransitGatewayAttachmentId, region` | <p>Accepts a request to attach a VPC to a transit gateway.</p> <p>The VPC attachment must be in the <code>pendingAcceptance</code> state. Use <a>DescribeTransitGatewayVpcAttachments</a> to view your pending VPC attachment requests. Use <a>RejectTransitGatewayVpcAttachment</a> to reject a VPC attachment request.</p> | +| `transit_gateway_vpc_attachment_Modify` | `EXEC` | `TransitGatewayAttachmentId, region` | Modifies the specified VPC attachment. | +| `transit_gateway_vpc_attachment_Reject` | `EXEC` | `TransitGatewayAttachmentId, region` | <p>Rejects a request to attach a VPC to a transit gateway.</p> <p>The VPC attachment must be in the <code>pendingAcceptance</code> state. Use <a>DescribeTransitGatewayVpcAttachments</a> to view your pending VPC attachment requests. Use <a>AcceptTransitGatewayVpcAttachment</a> to accept a VPC attachment request.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/transit_gateways/index.md b/docs/aws-docs/providers/aws/ec2_api/transit_gateways/index.md new file mode 100644 index 0000000000..3e6d2f286e --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/transit_gateways/index.md @@ -0,0 +1,44 @@ +--- +title: transit_gateways +hide_title: false +hide_table_of_contents: false +keywords: + - transit_gateways + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nametransit_gateways
TypeResource
Idaws.ec2_api.transit_gateways
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `description` | `string` | The description of the transit gateway. | +| `creationTime` | `string` | The creation time. | +| `options` | `object` | Describes the options for a transit gateway. | +| `ownerId` | `string` | The ID of the Amazon Web Services account that owns the transit gateway. | +| `state` | `string` | The state of the transit gateway. | +| `tagSet` | `array` | The tags for the transit gateway. | +| `transitGatewayArn` | `string` | The Amazon Resource Name (ARN) of the transit gateway. | +| `transitGatewayId` | `string` | The ID of the transit gateway. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `transit_gateways_Describe` | `SELECT` | `region` | Describes one or more transit gateways. By default, all transit gateways are described. Alternatively, you can filter the results. | +| `transit_gateway_Create` | `INSERT` | `region` | <p>Creates a transit gateway.</p> <p>You can use a transit gateway to interconnect your virtual private clouds (VPC) and on-premises networks. After the transit gateway enters the <code>available</code> state, you can attach your VPCs and VPN connections to the transit gateway.</p> <p>To attach your VPCs, use <a>CreateTransitGatewayVpcAttachment</a>.</p> <p>To attach a VPN connection, use <a>CreateCustomerGateway</a> to create a customer gateway and specify the ID of the customer gateway and the ID of the transit gateway in a call to <a>CreateVpnConnection</a>.</p> <p>When you create a transit gateway, we create a default transit gateway route table and use it as the default association route table and the default propagation route table. You can use <a>CreateTransitGatewayRouteTable</a> to create additional transit gateway route tables. If you disable automatic route propagation, we do not create a default transit gateway route table. You can use <a>EnableTransitGatewayRouteTablePropagation</a> to propagate routes from a resource attachment to a transit gateway route table. If you disable automatic associations, you can use <a>AssociateTransitGatewayRouteTable</a> to associate a resource attachment with a transit gateway route table.</p> | +| `transit_gateway_Delete` | `DELETE` | `TransitGatewayId, region` | Deletes the specified transit gateway. | +| `transit_gateway_Modify` | `EXEC` | `TransitGatewayId, region` | Modifies the specified transit gateway. When you modify a transit gateway, the modified options are applied to new transit gateway attachments only. Your existing transit gateway attachments are not modified. | diff --git a/docs/aws-docs/providers/aws/ec2_api/trunk_interface/index.md b/docs/aws-docs/providers/aws/ec2_api/trunk_interface/index.md new file mode 100644 index 0000000000..8a7d0245a1 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/trunk_interface/index.md @@ -0,0 +1,33 @@ +--- +title: trunk_interface +hide_title: false +hide_table_of_contents: false +keywords: + - trunk_interface + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nametrunk_interface
TypeResource
Idaws.ec2_api.trunk_interface
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `trunk_interface_Associate` | `EXEC` | `BranchInterfaceId, TrunkInterfaceId, region` | <note> <p>This API action is currently in <b>limited preview only</b>. If you are interested in using this feature, contact your account manager.</p> </note> <p>Associates a branch network interface with a trunk network interface.</p> <p>Before you create the association, run the <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateNetworkInterface.html">create-network-interface</a> command and set <code>--interface-type</code> to <code>trunk</code>. You must also create a network interface for each branch network interface that you want to associate with the trunk network interface.</p> | +| `trunk_interface_Disassociate` | `EXEC` | `AssociationId, region` | <note> <p>This API action is currently in <b>limited preview only</b>. If you are interested in using this feature, contact your account manager.</p> </note> <p>Removes an association between a branch network interface with a trunk network interface.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/trunk_interface_associations/index.md b/docs/aws-docs/providers/aws/ec2_api/trunk_interface_associations/index.md new file mode 100644 index 0000000000..eec16e9f76 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/trunk_interface_associations/index.md @@ -0,0 +1,40 @@ +--- +title: trunk_interface_associations +hide_title: false +hide_table_of_contents: false +keywords: + - trunk_interface_associations + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nametrunk_interface_associations
TypeResource
Idaws.ec2_api.trunk_interface_associations
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `associationId` | `string` | The ID of the association. | +| `branchInterfaceId` | `string` | The ID of the branch network interface. | +| `greKey` | `integer` | The application key when you use the GRE protocol. | +| `interfaceProtocol` | `string` | The interface protocol. Valid values are <code>VLAN</code> and <code>GRE</code>. | +| `tagSet` | `array` | The tags for the trunk interface association. | +| `trunkInterfaceId` | `string` | The ID of the trunk network interface. | +| `vlanId` | `integer` | The ID of the VLAN when you use the VLAN protocol. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `trunk_interface_associations_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/vgw_route_propagation/index.md b/docs/aws-docs/providers/aws/ec2_api/vgw_route_propagation/index.md new file mode 100644 index 0000000000..f293805c51 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/vgw_route_propagation/index.md @@ -0,0 +1,33 @@ +--- +title: vgw_route_propagation +hide_title: false +hide_table_of_contents: false +keywords: + - vgw_route_propagation + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namevgw_route_propagation
TypeResource
Idaws.ec2_api.vgw_route_propagation
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `vgw_route_propagation_Disable` | `EXEC` | `GatewayId, RouteTableId, region` | Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC. | +| `vgw_route_propagation_Enable` | `EXEC` | `GatewayId, RouteTableId, region` | Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC. | diff --git a/docs/aws-docs/providers/aws/ec2_api/volume_attribute/index.md b/docs/aws-docs/providers/aws/ec2_api/volume_attribute/index.md new file mode 100644 index 0000000000..a84841835d --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/volume_attribute/index.md @@ -0,0 +1,37 @@ +--- +title: volume_attribute +hide_title: false +hide_table_of_contents: false +keywords: + - volume_attribute + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namevolume_attribute
TypeResource
Idaws.ec2_api.volume_attribute
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `autoEnableIO` | `object` | Describes a value for a resource attribute that is a Boolean value. | +| `productCodes` | `array` | A list of product codes. | +| `volumeId` | `string` | The ID of the volume. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `volume_attribute_Describe` | `SELECT` | `Attribute, VolumeId, region` | <p>Describes the specified attribute of the specified volume. You can specify only one attribute at a time.</p> <p>For more information about EBS volumes, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumes.html">Amazon EBS volumes</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | +| `volume_attribute_Modify` | `EXEC` | `VolumeId, region` | <p>Modifies a volume attribute.</p> <p>By default, all I/O operations for the volume are suspended when the data on the volume is determined to be potentially inconsistent, to prevent undetectable, latent data corruption. The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume.</p> <p>You can change the default behavior to resume I/O operations. We recommend that you change this only for boot volumes or for volumes that are stateless or disposable.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/volume_i_o/index.md b/docs/aws-docs/providers/aws/ec2_api/volume_i_o/index.md new file mode 100644 index 0000000000..c094f16672 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/volume_i_o/index.md @@ -0,0 +1,32 @@ +--- +title: volume_i_o +hide_title: false +hide_table_of_contents: false +keywords: + - volume_i_o + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namevolume_i_o
TypeResource
Idaws.ec2_api.volume_i_o
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `volume_i_o_Enable` | `EXEC` | `VolumeId, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/volume_status/index.md b/docs/aws-docs/providers/aws/ec2_api/volume_status/index.md new file mode 100644 index 0000000000..ba7428f262 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/volume_status/index.md @@ -0,0 +1,40 @@ +--- +title: volume_status +hide_title: false +hide_table_of_contents: false +keywords: + - volume_status + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namevolume_status
TypeResource
Idaws.ec2_api.volume_status
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `actionsSet` | `array` | The details of the operation. | +| `attachmentStatuses` | `array` | Information about the instances to which the volume is attached. | +| `availabilityZone` | `string` | The Availability Zone of the volume. | +| `eventsSet` | `array` | A list of events associated with the volume. | +| `outpostArn` | `string` | The Amazon Resource Name (ARN) of the Outpost. | +| `volumeId` | `string` | The volume ID. | +| `volumeStatus` | `object` | Describes the status of a volume. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `volume_status_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/volumes/index.md b/docs/aws-docs/providers/aws/ec2_api/volumes/index.md new file mode 100644 index 0000000000..8ff8c7a954 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/volumes/index.md @@ -0,0 +1,55 @@ +--- +title: volumes +hide_title: false +hide_table_of_contents: false +keywords: + - volumes + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namevolumes
TypeResource
Idaws.ec2_api.volumes
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `AvailabilityZone` | `string` | The Availability Zone for the volume. | +| `attachmentSet` | `array` | Information about the volume attachments. | +| `createTime` | `string` | The time stamp when volume creation was initiated. | +| `encrypted` | `boolean` | Indicates whether the volume is encrypted. | +| `fastRestored` | `boolean` | Indicates whether the volume was created using fast snapshot restore. | +| `iops` | `integer` | The number of I/O operations per second (IOPS). For <code>gp3</code>, <code>io1</code>, and <code>io2</code> volumes, this represents the number of IOPS that are provisioned for the volume. For <code>gp2</code> volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. | +| `kmsKeyId` | `string` | The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the volume. | +| `multiAttachEnabled` | `boolean` | Indicates whether Amazon EBS Multi-Attach is enabled. | +| `outpostArn` | `string` | The Amazon Resource Name (ARN) of the Outpost. | +| `size` | `integer` | The size of the volume, in GiBs. | +| `snapshotId` | `string` | The snapshot from which the volume was created, if applicable. | +| `status` | `string` | The volume state. | +| `tagSet` | `array` | Any tags assigned to the volume. | +| `throughput` | `integer` | The throughput that the volume supports, in MiB/s. | +| `volumeId` | `string` | The ID of the volume. | +| `volumeType` | `string` | The volume type. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `volumes_Describe` | `SELECT` | `region` | <p>Describes the specified EBS volumes or all of your EBS volumes.</p> <p>If you are describing a long list of volumes, we recommend that you paginate the output to make the list more manageable. The <code>MaxResults</code> parameter sets the maximum number of results returned in a single page. If the list of results exceeds your <code>MaxResults</code> value, then that number of results is returned along with a <code>NextToken</code> value that can be passed to a subsequent <code>DescribeVolumes</code> request to retrieve the remaining results.</p> <p>For more information about EBS volumes, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumes.html">Amazon EBS volumes</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | +| `volume_Create` | `INSERT` | `AvailabilityZone, region` | <p>Creates an EBS volume that can be attached to an instance in the same Availability Zone.</p> <p>You can create a new empty volume or restore a volume from an EBS snapshot. Any Amazon Web Services Marketplace product codes from the snapshot are propagated to the volume.</p> <p>You can create encrypted volumes. Encrypted volumes must be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html">Amazon EBS encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>You can tag your volumes during creation. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html">Tag your Amazon EC2 resources</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-creating-volume.html">Create an Amazon EBS volume</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | +| `volume_Delete` | `DELETE` | `VolumeId, region` | <p>Deletes the specified EBS volume. The volume must be in the <code>available</code> state (not attached to an instance).</p> <p>The volume can remain in the <code>deleting</code> state for several minutes.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-deleting-volume.html">Delete an Amazon EBS volume</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | +| `volume_Modify` | `UPDATE` | `VolumeId, region` | <p>You can modify several parameters of an existing EBS volume, including volume size, volume type, and IOPS capacity. If your EBS volume is attached to a current-generation EC2 instance type, you might be able to apply these changes without stopping the instance or detaching the volume from it. For more information about modifying EBS volumes, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-modify-volume.html">Amazon EBS Elastic Volumes</a> (Linux instances) or <a href="https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ebs-modify-volume.html">Amazon EBS Elastic Volumes</a> (Windows instances).</p> <p>When you complete a resize operation on your volume, you need to extend the volume's file-system size to take advantage of the new storage capacity. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-expand-volume.html#recognize-expanded-volume-linux">Extend a Linux file system</a> or <a href="https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ebs-expand-volume.html#recognize-expanded-volume-windows">Extend a Windows file system</a>.</p> <p> You can use CloudWatch Events to check the status of a modification to an EBS volume. For information about CloudWatch Events, see the <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/">Amazon CloudWatch Events User Guide</a>. You can also track the status of a modification using <a>DescribeVolumesModifications</a>. For information about tracking status changes using either method, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-volume-modifications.html">Monitor the progress of volume modifications</a>.</p> <p>With previous-generation instance types, resizing an EBS volume might require detaching and reattaching the volume or stopping and restarting the instance.</p> <p>After modifying a volume, you must wait at least six hours and ensure that the volume is in the <code>in-use</code> or <code>available</code> state before you can modify the same volume. This is sometimes referred to as a cooldown period.</p> | +| `volume_Attach` | `EXEC` | `Device, InstanceId, VolumeId, region` | <p>Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.</p> <p>Encrypted EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html">Amazon EBS encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>After you attach an EBS volume, you must make it available. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-using-volumes.html">Make an EBS volume available for use</a>.</p> <p>If a volume has an Amazon Web Services Marketplace product code:</p> <ul> <li> <p>The volume can be attached only to a stopped instance.</p> </li> <li> <p>Amazon Web Services Marketplace product codes are copied from the volume to the instance.</p> </li> <li> <p>You must be subscribed to the product.</p> </li> <li> <p>The instance type and operating system of the instance must support the product. For example, you can't detach a volume from a Windows instance and attach it to a Linux instance.</p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-attaching-volume.html">Attach an Amazon EBS volume to an instance</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | +| `volume_Detach` | `EXEC` | `VolumeId, region` | <p>Detaches an EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so can result in the volume becoming stuck in the <code>busy</code> state while detaching. If this happens, detachment can be delayed indefinitely until you unmount the volume, force detachment, reboot the instance, or all three. If an EBS volume is the root device of an instance, it can't be detached while the instance is running. To detach the root volume, stop the instance first.</p> <p>When a volume with an Amazon Web Services Marketplace product code is detached from an instance, the product code is no longer associated with the instance.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-detaching-volume.html">Detach an Amazon EBS volume</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | +| `volume_Import` | `EXEC` | `AvailabilityZone, Image, Volume, region` | <p>Creates an import volume task using metadata from the specified disk image.</p> <p>This API action supports only single-volume VMs. To import multi-volume VMs, use <a>ImportImage</a> instead. To import a disk to a snapshot, use <a>ImportSnapshot</a> instead.</p> <p>This API action is not supported by the Command Line Interface (CLI). For information about using the Amazon EC2 CLI, which is deprecated, see <a href="https://awsdocs.s3.amazonaws.com/EC2/ec2-clt.pdf#importing-your-volumes-into-amazon-ebs">Importing Disks to Amazon EBS</a> in the <i>Amazon EC2 CLI Reference</i> PDF file.</p> <p>For information about the import manifest referenced by this API action, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/manifest.html">VM Import Manifest</a>.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/volumes_modifications/index.md b/docs/aws-docs/providers/aws/ec2_api/volumes_modifications/index.md new file mode 100644 index 0000000000..c0412e44d5 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/volumes_modifications/index.md @@ -0,0 +1,49 @@ +--- +title: volumes_modifications +hide_title: false +hide_table_of_contents: false +keywords: + - volumes_modifications + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namevolumes_modifications
TypeResource
Idaws.ec2_api.volumes_modifications
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `endTime` | `string` | The modification completion or failure time. | +| `modificationState` | `string` | The current modification state. The modification state is null for unmodified volumes. | +| `originalIops` | `integer` | The original IOPS rate of the volume. | +| `originalMultiAttachEnabled` | `boolean` | The original setting for Amazon EBS Multi-Attach. | +| `originalSize` | `integer` | The original size of the volume, in GiB. | +| `originalThroughput` | `integer` | The original throughput of the volume, in MiB/s. | +| `originalVolumeType` | `string` | The original EBS volume type of the volume. | +| `progress` | `integer` | The modification progress, from 0 to 100 percent complete. | +| `startTime` | `string` | The modification start time. | +| `statusMessage` | `string` | A status message about the modification progress or failure. | +| `targetIops` | `integer` | The target IOPS rate of the volume. | +| `targetMultiAttachEnabled` | `boolean` | The target setting for Amazon EBS Multi-Attach. | +| `targetSize` | `integer` | The target size of the volume, in GiB. | +| `targetThroughput` | `integer` | The target throughput of the volume, in MiB/s. | +| `targetVolumeType` | `string` | The target EBS volume type of the volume. | +| `volumeId` | `string` | The ID of the volume. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `volumes_modifications_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/vpc_attribute/index.md b/docs/aws-docs/providers/aws/ec2_api/vpc_attribute/index.md new file mode 100644 index 0000000000..26eef0ae70 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/vpc_attribute/index.md @@ -0,0 +1,37 @@ +--- +title: vpc_attribute +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_attribute + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namevpc_attribute
TypeResource
Idaws.ec2_api.vpc_attribute
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `enableDnsHostnames` | `object` | Describes a value for a resource attribute that is a Boolean value. | +| `enableDnsSupport` | `object` | Describes a value for a resource attribute that is a Boolean value. | +| `vpcId` | `string` | The ID of the VPC. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `vpc_attribute_Describe` | `SELECT` | `Attribute, VpcId, region` | Describes the specified attribute of the specified VPC. You can specify only one attribute at a time. | +| `vpc_attribute_Modify` | `EXEC` | `VpcId, region` | Modifies the specified attribute of the specified VPC. | diff --git a/docs/aws-docs/providers/aws/ec2_api/vpc_cidr_block/index.md b/docs/aws-docs/providers/aws/ec2_api/vpc_cidr_block/index.md new file mode 100644 index 0000000000..85f1fd1332 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/vpc_cidr_block/index.md @@ -0,0 +1,33 @@ +--- +title: vpc_cidr_block +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_cidr_block + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namevpc_cidr_block
TypeResource
Idaws.ec2_api.vpc_cidr_block
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `vpc_cidr_block_Associate` | `EXEC` | `VpcId, region` | <p>Associates a CIDR block with your VPC. You can associate a secondary IPv4 CIDR block, an Amazon-provided IPv6 CIDR block, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (<a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html">BYOIP</a>). The IPv6 CIDR block size is fixed at /56.</p> <p>You must specify one of the following in the request: an IPv4 CIDR block, an IPv6 pool, or an Amazon-provided IPv6 CIDR block.</p> <p>For more information about associating CIDR blocks with your VPC and applicable restrictions, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html#VPC_Sizing">VPC and subnet sizing</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p> | +| `vpc_cidr_block_Disassociate` | `EXEC` | `AssociationId, region` | <p>Disassociates a CIDR block from a VPC. To disassociate the CIDR block, you must specify its association ID. You can get the association ID by using <a>DescribeVpcs</a>. You must detach or delete all gateways and resources that are associated with the CIDR block before you can disassociate it. </p> <p>You cannot disassociate the CIDR block with which you originally created the VPC (the primary CIDR block).</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/vpc_classic_link/index.md b/docs/aws-docs/providers/aws/ec2_api/vpc_classic_link/index.md new file mode 100644 index 0000000000..8ff315f8de --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/vpc_classic_link/index.md @@ -0,0 +1,38 @@ +--- +title: vpc_classic_link +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_classic_link + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namevpc_classic_link
TypeResource
Idaws.ec2_api.vpc_classic_link
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `classicLinkEnabled` | `boolean` | Indicates whether the VPC is enabled for ClassicLink. | +| `tagSet` | `array` | Any tags assigned to the VPC. | +| `vpcId` | `string` | The ID of the VPC. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `vpc_classic_link_Describe` | `SELECT` | `region` | Describes the ClassicLink status of one or more VPCs. | +| `vpc_classic_link_Disable` | `EXEC` | `VpcId, region` | Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it. | +| `vpc_classic_link_Enable` | `EXEC` | `VpcId, region` | Enables a VPC for ClassicLink. You can then link EC2-Classic instances to your ClassicLink-enabled VPC to allow communication over private IP addresses. You cannot enable your VPC for ClassicLink if any of your VPC route tables have existing routes for address ranges within the <code>10.0.0.0/8</code> IP address range, excluding local routes for VPCs in the <code>10.0.0.0/16</code> and <code>10.1.0.0/16</code> IP address ranges. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html">ClassicLink</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. | diff --git a/docs/aws-docs/providers/aws/ec2_api/vpc_classic_link_dns_support/index.md b/docs/aws-docs/providers/aws/ec2_api/vpc_classic_link_dns_support/index.md new file mode 100644 index 0000000000..eca9aa0165 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/vpc_classic_link_dns_support/index.md @@ -0,0 +1,37 @@ +--- +title: vpc_classic_link_dns_support +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_classic_link_dns_support + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namevpc_classic_link_dns_support
TypeResource
Idaws.ec2_api.vpc_classic_link_dns_support
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `classicLinkDnsSupported` | `boolean` | Indicates whether ClassicLink DNS support is enabled for the VPC. | +| `vpcId` | `string` | The ID of the VPC. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `vpc_classic_link_dns_support_Describe` | `SELECT` | `region` | Describes the ClassicLink DNS support status of one or more VPCs. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html">ClassicLink</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. | +| `vpc_classic_link_dns_support_Disable` | `EXEC` | `region` | <p>Disables ClassicLink DNS support for a VPC. If disabled, DNS hostnames resolve to public IP addresses when addressed between a linked EC2-Classic instance and instances in the VPC to which it's linked. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html">ClassicLink</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>You must specify a VPC ID in the request.</p> | +| `vpc_classic_link_dns_support_Enable` | `EXEC` | `region` | <p>Enables a VPC to support DNS hostname resolution for ClassicLink. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html">ClassicLink</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>You must specify a VPC ID in the request.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/vpc_endpoint_connection_notifications/index.md b/docs/aws-docs/providers/aws/ec2_api/vpc_endpoint_connection_notifications/index.md new file mode 100644 index 0000000000..224207ad44 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/vpc_endpoint_connection_notifications/index.md @@ -0,0 +1,43 @@ +--- +title: vpc_endpoint_connection_notifications +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_endpoint_connection_notifications + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namevpc_endpoint_connection_notifications
TypeResource
Idaws.ec2_api.vpc_endpoint_connection_notifications
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `connectionEvents` | `array` | The events for the notification. Valid values are <code>Accept</code>, <code>Connect</code>, <code>Delete</code>, and <code>Reject</code>. | +| `connectionNotificationArn` | `string` | The ARN of the SNS topic for the notification. | +| `connectionNotificationId` | `string` | The ID of the notification. | +| `connectionNotificationState` | `string` | The state of the notification. | +| `connectionNotificationType` | `string` | The type of notification. | +| `serviceId` | `string` | The ID of the endpoint service. | +| `vpcEndpointId` | `string` | The ID of the VPC endpoint. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `vpc_endpoint_connection_notifications_Describe` | `SELECT` | `region` | Describes the connection notifications for VPC endpoints and VPC endpoint services. | +| `vpc_endpoint_connection_notification_Create` | `INSERT` | `ConnectionEvents, ConnectionNotificationArn, region` | <p>Creates a connection notification for a specified VPC endpoint or VPC endpoint service. A connection notification notifies you of specific endpoint events. You must create an SNS topic to receive notifications. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html">Create a Topic</a> in the <i>Amazon Simple Notification Service Developer Guide</i>.</p> <p>You can create a connection notification for interface endpoints only.</p> | +| `vpc_endpoint_connection_notifications_Delete` | `DELETE` | `ConnectionNotificationId, region` | Deletes one or more VPC endpoint connection notifications. | +| `vpc_endpoint_connection_notification_Modify` | `EXEC` | `ConnectionNotificationId, region` | Modifies a connection notification for VPC endpoint or VPC endpoint service. You can change the SNS topic for the notification, or the events for which to be notified. | diff --git a/docs/aws-docs/providers/aws/ec2_api/vpc_endpoint_connections/index.md b/docs/aws-docs/providers/aws/ec2_api/vpc_endpoint_connections/index.md new file mode 100644 index 0000000000..0f7034723e --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/vpc_endpoint_connections/index.md @@ -0,0 +1,44 @@ +--- +title: vpc_endpoint_connections +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_endpoint_connections + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namevpc_endpoint_connections
TypeResource
Idaws.ec2_api.vpc_endpoint_connections
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `creationTimestamp` | `string` | The date and time that the VPC endpoint was created. | +| `dnsEntrySet` | `array` | The DNS entries for the VPC endpoint. | +| `gatewayLoadBalancerArnSet` | `array` | The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service. | +| `ipAddressType` | `string` | The IP address type for the endpoint. | +| `networkLoadBalancerArnSet` | `array` | The Amazon Resource Names (ARNs) of the network load balancers for the service. | +| `serviceId` | `string` | The ID of the service to which the endpoint is connected. | +| `vpcEndpointId` | `string` | The ID of the VPC endpoint. | +| `vpcEndpointOwner` | `string` | The ID of the Amazon Web Services account that owns the VPC endpoint. | +| `vpcEndpointState` | `string` | The state of the VPC endpoint. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `vpc_endpoint_connections_Describe` | `SELECT` | `region` | Describes the VPC endpoint connections to your VPC endpoint services, including any endpoints that are pending your acceptance. | +| `vpc_endpoint_connections_Accept` | `EXEC` | `ServiceId, VpcEndpointId, region` | Accepts one or more interface VPC endpoint connection requests to your VPC endpoint service. | +| `vpc_endpoint_connections_Reject` | `EXEC` | `ServiceId, VpcEndpointId, region` | Rejects one or more VPC endpoint connection requests to your VPC endpoint service. | diff --git a/docs/aws-docs/providers/aws/ec2_api/vpc_endpoint_service_configurations/index.md b/docs/aws-docs/providers/aws/ec2_api/vpc_endpoint_service_configurations/index.md new file mode 100644 index 0000000000..63c41474c8 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/vpc_endpoint_service_configurations/index.md @@ -0,0 +1,51 @@ +--- +title: vpc_endpoint_service_configurations +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_endpoint_service_configurations + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namevpc_endpoint_service_configurations
TypeResource
Idaws.ec2_api.vpc_endpoint_service_configurations
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `acceptanceRequired` | `boolean` | Indicates whether requests from other Amazon Web Services accounts to create an endpoint to the service must first be accepted. | +| `availabilityZoneSet` | `array` | The Availability Zones in which the service is available. | +| `baseEndpointDnsNameSet` | `array` | The DNS names for the service. | +| `gatewayLoadBalancerArnSet` | `array` | The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service. | +| `managesVpcEndpoints` | `boolean` | Indicates whether the service manages its VPC endpoints. Management of the service VPC endpoints using the VPC endpoint API is restricted. | +| `networkLoadBalancerArnSet` | `array` | The Amazon Resource Names (ARNs) of the Network Load Balancers for the service. | +| `payerResponsibility` | `string` | The payer responsibility. | +| `privateDnsName` | `string` | The private DNS name for the service. | +| `privateDnsNameConfiguration` | `object` | Information about the private DNS name for the service endpoint. | +| `serviceId` | `string` | The ID of the service. | +| `serviceName` | `string` | The name of the service. | +| `serviceState` | `string` | The service state. | +| `serviceType` | `array` | The type of service. | +| `supportedIpAddressTypeSet` | `array` | The supported IP address types. | +| `tagSet` | `array` | Any tags assigned to the service. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `vpc_endpoint_service_configurations_Describe` | `SELECT` | `region` | Describes the VPC endpoint service configurations in your account (your services). | +| `vpc_endpoint_service_configuration_Create` | `INSERT` | `region` | <p>Creates a VPC endpoint service to which service consumers (Amazon Web Services accounts, IAM users, and IAM roles) can connect.</p> <p>Before you create an endpoint service, you must create one of the following for your service:</p> <ul> <li> <p>A <a href="https://docs.aws.amazon.com/elasticloadbalancing/latest/network/">Network Load Balancer</a>. Service consumers connect to your service using an interface endpoint.</p> </li> <li> <p>A <a href="https://docs.aws.amazon.com/elasticloadbalancing/latest/gateway/">Gateway Load Balancer</a>. Service consumers connect to your service using a Gateway Load Balancer endpoint.</p> </li> </ul> <p>If you set the private DNS name, you must prove that you own the private DNS domain name.</p> <p>For more information, see the <a href="https://docs.aws.amazon.com/vpc/latest/privatelink/">Amazon Web Services PrivateLink Guide</a>.</p> | +| `vpc_endpoint_service_configurations_Delete` | `DELETE` | `ServiceId, region` | Deletes one or more VPC endpoint service configurations in your account. Before you delete the endpoint service configuration, you must reject any <code>Available</code> or <code>PendingAcceptance</code> interface endpoint connections that are attached to the service. | +| `vpc_endpoint_service_configuration_Modify` | `EXEC` | `ServiceId, region` | <p>Modifies the attributes of your VPC endpoint service configuration. You can change the Network Load Balancers or Gateway Load Balancers for your service, and you can specify whether acceptance is required for requests to connect to your endpoint service through an interface VPC endpoint.</p> <p>If you set or modify the private DNS name, you must prove that you own the private DNS domain name.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/vpc_endpoint_service_payer_responsibility/index.md b/docs/aws-docs/providers/aws/ec2_api/vpc_endpoint_service_payer_responsibility/index.md new file mode 100644 index 0000000000..c827740aab --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/vpc_endpoint_service_payer_responsibility/index.md @@ -0,0 +1,32 @@ +--- +title: vpc_endpoint_service_payer_responsibility +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_endpoint_service_payer_responsibility + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namevpc_endpoint_service_payer_responsibility
TypeResource
Idaws.ec2_api.vpc_endpoint_service_payer_responsibility
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `vpc_endpoint_service_payer_responsibility_Modify` | `EXEC` | `PayerResponsibility, ServiceId, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/vpc_endpoint_service_permissions/index.md b/docs/aws-docs/providers/aws/ec2_api/vpc_endpoint_service_permissions/index.md new file mode 100644 index 0000000000..1ff37c7870 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/vpc_endpoint_service_permissions/index.md @@ -0,0 +1,36 @@ +--- +title: vpc_endpoint_service_permissions +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_endpoint_service_permissions + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namevpc_endpoint_service_permissions
TypeResource
Idaws.ec2_api.vpc_endpoint_service_permissions
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `principal` | `string` | The Amazon Resource Name (ARN) of the principal. | +| `principalType` | `string` | The type of principal. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `vpc_endpoint_service_permissions_Describe` | `SELECT` | `ServiceId, region` | Describes the principals (service consumers) that are permitted to discover your VPC endpoint service. | +| `vpc_endpoint_service_permissions_Modify` | `EXEC` | `ServiceId, region` | <p>Modifies the permissions for your VPC endpoint service. You can add or remove permissions for service consumers (IAM users, IAM roles, and Amazon Web Services accounts) to connect to your endpoint service.</p> <p>If you grant permissions to all principals, the service is public. Any users who know the name of a public service can send a request to attach an endpoint. If the service does not require manual approval, attachments are automatically approved.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/vpc_endpoint_service_private_dns_verification/index.md b/docs/aws-docs/providers/aws/ec2_api/vpc_endpoint_service_private_dns_verification/index.md new file mode 100644 index 0000000000..022180ae3a --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/vpc_endpoint_service_private_dns_verification/index.md @@ -0,0 +1,32 @@ +--- +title: vpc_endpoint_service_private_dns_verification +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_endpoint_service_private_dns_verification + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namevpc_endpoint_service_private_dns_verification
TypeResource
Idaws.ec2_api.vpc_endpoint_service_private_dns_verification
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `vpc_endpoint_service_private_dns_verification_Start` | `EXEC` | `ServiceId, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/vpc_endpoint_services/index.md b/docs/aws-docs/providers/aws/ec2_api/vpc_endpoint_services/index.md new file mode 100644 index 0000000000..caee6b0827 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/vpc_endpoint_services/index.md @@ -0,0 +1,48 @@ +--- +title: vpc_endpoint_services +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_endpoint_services + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namevpc_endpoint_services
TypeResource
Idaws.ec2_api.vpc_endpoint_services
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `acceptanceRequired` | `boolean` | Indicates whether VPC endpoint connection requests to the service must be accepted by the service owner. | +| `availabilityZoneSet` | `array` | The Availability Zones in which the service is available. | +| `baseEndpointDnsNameSet` | `array` | The DNS names for the service. | +| `managesVpcEndpoints` | `boolean` | Indicates whether the service manages its VPC endpoints. Management of the service VPC endpoints using the VPC endpoint API is restricted. | +| `owner` | `string` | The Amazon Web Services account ID of the service owner. | +| `payerResponsibility` | `string` | The payer responsibility. | +| `privateDnsName` | `string` | The private DNS name for the service. | +| `privateDnsNameSet` | `array` | The private DNS names assigned to the VPC endpoint service. | +| `privateDnsNameVerificationState` | `string` | <p>The verification state of the VPC endpoint service.</p> <p>Consumers of the endpoint service cannot use the private name when the state is not <code>verified</code>.</p> | +| `serviceId` | `string` | The ID of the endpoint service. | +| `serviceName` | `string` | The Amazon Resource Name (ARN) of the service. | +| `serviceType` | `array` | The type of service. | +| `supportedIpAddressTypeSet` | `array` | The supported IP address types. | +| `tagSet` | `array` | Any tags assigned to the service. | +| `vpcEndpointPolicySupported` | `boolean` | Indicates whether the service supports endpoint policies. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `vpc_endpoint_services_Describe` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/vpc_endpoints/index.md b/docs/aws-docs/providers/aws/ec2_api/vpc_endpoints/index.md new file mode 100644 index 0000000000..b642706766 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/vpc_endpoints/index.md @@ -0,0 +1,55 @@ +--- +title: vpc_endpoints +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_endpoints + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namevpc_endpoints
TypeResource
Idaws.ec2_api.vpc_endpoints
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `creationTimestamp` | `string` | The date and time that the endpoint was created. | +| `dnsEntrySet` | `array` | (Interface endpoint) The DNS entries for the endpoint. | +| `dnsOptions` | `object` | Describes the DNS options for an endpoint. | +| `groupSet` | `array` | (Interface endpoint) Information about the security groups that are associated with the network interface. | +| `ipAddressType` | `string` | The IP address type for the endpoint. | +| `lastError` | `object` | The last error that occurred for a VPC endpoint. | +| `networkInterfaceIdSet` | `array` | (Interface endpoint) One or more network interfaces for the endpoint. | +| `ownerId` | `string` | The ID of the Amazon Web Services account that owns the endpoint. | +| `policyDocument` | `string` | The policy document associated with the endpoint, if applicable. | +| `privateDnsEnabled` | `boolean` | (Interface endpoint) Indicates whether the VPC is associated with a private hosted zone. | +| `requesterManaged` | `boolean` | Indicates whether the endpoint is being managed by its service. | +| `routeTableIdSet` | `array` | (Gateway endpoint) One or more route tables associated with the endpoint. | +| `serviceName` | `string` | The name of the service to which the endpoint is associated. | +| `state` | `string` | The state of the endpoint. | +| `subnetIdSet` | `array` | (Interface endpoint) The subnets for the endpoint. | +| `tagSet` | `array` | Any tags assigned to the endpoint. | +| `vpcEndpointId` | `string` | The ID of the endpoint. | +| `vpcEndpointType` | `string` | The type of endpoint. | +| `vpcId` | `string` | The ID of the VPC to which the endpoint is associated. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `vpc_endpoints_Describe` | `SELECT` | `region` | Describes one or more of your VPC endpoints. | +| `vpc_endpoint_Create` | `INSERT` | `ServiceName, VpcId, region` | Creates a VPC endpoint for a specified service. An endpoint enables you to create a private connection between your VPC and the service. The service may be provided by Amazon Web Services, an Amazon Web Services Marketplace Partner, or another Amazon Web Services account. For more information, see the <a href="https://docs.aws.amazon.com/vpc/latest/privatelink/">Amazon Web Services PrivateLink Guide</a>. | +| `vpc_endpoints_Delete` | `DELETE` | `VpcEndpointId, region` | <p>Deletes one or more specified VPC endpoints. You can delete any of the following types of VPC endpoints. </p> <ul> <li> <p>Gateway endpoint,</p> </li> <li> <p>Gateway Load Balancer endpoint,</p> </li> <li> <p>Interface endpoint</p> </li> </ul> <p>The following rules apply when you delete a VPC endpoint:</p> <ul> <li> <p>When you delete a gateway endpoint, we delete the endpoint routes in the route tables that are associated with the endpoint.</p> </li> <li> <p>When you delete a Gateway Load Balancer endpoint, we delete the endpoint network interfaces. </p> <p>You can only delete Gateway Load Balancer endpoints when the routes that are associated with the endpoint are deleted.</p> </li> <li> <p>When you delete an interface endpoint, we delete the endpoint network interfaces.</p> </li> </ul> | +| `vpc_endpoint_Modify` | `EXEC` | `VpcEndpointId, region` | Modifies attributes of a specified VPC endpoint. The attributes that you can modify depend on the type of VPC endpoint (interface, gateway, or Gateway Load Balancer). For more information, see the <a href="https://docs.aws.amazon.com/vpc/latest/privatelink/">Amazon Web Services PrivateLink Guide</a>. | diff --git a/docs/aws-docs/providers/aws/ec2_api/vpc_peering_connection_options/index.md b/docs/aws-docs/providers/aws/ec2_api/vpc_peering_connection_options/index.md new file mode 100644 index 0000000000..ab908d58cd --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/vpc_peering_connection_options/index.md @@ -0,0 +1,32 @@ +--- +title: vpc_peering_connection_options +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_peering_connection_options + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namevpc_peering_connection_options
TypeResource
Idaws.ec2_api.vpc_peering_connection_options
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `vpc_peering_connection_options_Modify` | `EXEC` | `VpcPeeringConnectionId, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/vpc_peering_connections/index.md b/docs/aws-docs/providers/aws/ec2_api/vpc_peering_connections/index.md new file mode 100644 index 0000000000..8af881a634 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/vpc_peering_connections/index.md @@ -0,0 +1,43 @@ +--- +title: vpc_peering_connections +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_peering_connections + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namevpc_peering_connections
TypeResource
Idaws.ec2_api.vpc_peering_connections
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `accepterVpcInfo` | `object` | Describes a VPC in a VPC peering connection. | +| `expirationTime` | `string` | The time that an unaccepted VPC peering connection will expire. | +| `requesterVpcInfo` | `object` | Describes a VPC in a VPC peering connection. | +| `status` | `object` | Describes the status of a VPC peering connection. | +| `tagSet` | `array` | Any tags assigned to the resource. | +| `vpcPeeringConnectionId` | `string` | The ID of the VPC peering connection. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `vpc_peering_connections_Describe` | `SELECT` | `region` | Describes one or more of your VPC peering connections. | +| `vpc_peering_connection_Create` | `INSERT` | `region` | <p>Requests a VPC peering connection between two VPCs: a requester VPC that you own and an accepter VPC with which to create the connection. The accepter VPC can belong to another Amazon Web Services account and can be in a different Region to the requester VPC. The requester VPC and accepter VPC cannot have overlapping CIDR blocks.</p> <note> <p>Limitations and rules apply to a VPC peering connection. For more information, see the <a href="https://docs.aws.amazon.com/vpc/latest/peering/vpc-peering-basics.html#vpc-peering-limitations">limitations</a> section in the <i>VPC Peering Guide</i>.</p> </note> <p>The owner of the accepter VPC must accept the peering request to activate the peering connection. The VPC peering connection request expires after 7 days, after which it cannot be accepted or rejected.</p> <p>If you create a VPC peering connection request between VPCs with overlapping CIDR blocks, the VPC peering connection has a status of <code>failed</code>.</p> | +| `vpc_peering_connection_Delete` | `DELETE` | `VpcPeeringConnectionId, region` | Deletes a VPC peering connection. Either the owner of the requester VPC or the owner of the accepter VPC can delete the VPC peering connection if it's in the <code>active</code> state. The owner of the requester VPC can delete a VPC peering connection in the <code>pending-acceptance</code> state. You cannot delete a VPC peering connection that's in the <code>failed</code> state. | +| `vpc_peering_connection_Accept` | `EXEC` | `region` | <p>Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the <code>pending-acceptance</code> state, and you must be the owner of the peer VPC. Use <a>DescribeVpcPeeringConnections</a> to view your outstanding VPC peering connection requests.</p> <p>For an inter-Region VPC peering connection request, you must accept the VPC peering connection in the Region of the accepter VPC.</p> | +| `vpc_peering_connection_Reject` | `EXEC` | `VpcPeeringConnectionId, region` | Rejects a VPC peering connection request. The VPC peering connection must be in the <code>pending-acceptance</code> state. Use the <a>DescribeVpcPeeringConnections</a> request to view your outstanding VPC peering connection requests. To delete an active VPC peering connection, or to delete a VPC peering connection request that you initiated, use <a>DeleteVpcPeeringConnection</a>. | diff --git a/docs/aws-docs/providers/aws/ec2_api/vpc_tenancy/index.md b/docs/aws-docs/providers/aws/ec2_api/vpc_tenancy/index.md new file mode 100644 index 0000000000..0df5c18180 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/vpc_tenancy/index.md @@ -0,0 +1,32 @@ +--- +title: vpc_tenancy +hide_title: false +hide_table_of_contents: false +keywords: + - vpc_tenancy + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namevpc_tenancy
TypeResource
Idaws.ec2_api.vpc_tenancy
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `vpc_tenancy_Modify` | `EXEC` | `InstanceTenancy, VpcId, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/vpcs/index.md b/docs/aws-docs/providers/aws/ec2_api/vpcs/index.md new file mode 100644 index 0000000000..8966258faf --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/vpcs/index.md @@ -0,0 +1,45 @@ +--- +title: vpcs +hide_title: false +hide_table_of_contents: false +keywords: + - vpcs + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namevpcs
TypeResource
Idaws.ec2_api.vpcs
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `cidrBlock` | `string` | The primary IPv4 CIDR block for the VPC. | +| `cidrBlockAssociationSet` | `array` | Information about the IPv4 CIDR blocks associated with the VPC. | +| `dhcpOptionsId` | `string` | The ID of the set of DHCP options you've associated with the VPC. | +| `instanceTenancy` | `string` | The allowed tenancy of instances launched into the VPC. | +| `ipv6CidrBlockAssociationSet` | `array` | Information about the IPv6 CIDR blocks associated with the VPC. | +| `isDefault` | `boolean` | Indicates whether the VPC is the default VPC. | +| `ownerId` | `string` | The ID of the Amazon Web Services account that owns the VPC. | +| `state` | `string` | The current state of the VPC. | +| `tagSet` | `array` | Any tags assigned to the VPC. | +| `vpcId` | `string` | The ID of the VPC. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `vpcs_Describe` | `SELECT` | `region` | Describes one or more of your VPCs. | +| `vpc_Create` | `INSERT` | `region` | <p>Creates a VPC with the specified IPv4 CIDR block. The smallest VPC you can create uses a /28 netmask (16 IPv4 addresses), and the largest uses a /16 netmask (65,536 IPv4 addresses). For more information about how large to make your VPC, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html">Your VPC and subnets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p> <p>You can optionally request an IPv6 CIDR block for the VPC. You can request an Amazon-provided IPv6 CIDR block from Amazon's pool of IPv6 addresses, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (<a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html">BYOIP</a>).</p> <p>By default, each instance you launch in the VPC has the default DHCP options, which include only a default DNS server that we provide (AmazonProvidedDNS). For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_DHCP_Options.html">DHCP options sets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p> <p>You can specify the instance tenancy value for the VPC when you create it. You can't change this value for the VPC after you create it. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-instance.html">Dedicated Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> | +| `vpc_Delete` | `DELETE` | `VpcId, region` | Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on. | diff --git a/docs/aws-docs/providers/aws/ec2_api/vpn_connection_device_sample_configuration/index.md b/docs/aws-docs/providers/aws/ec2_api/vpn_connection_device_sample_configuration/index.md new file mode 100644 index 0000000000..13414622ad --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/vpn_connection_device_sample_configuration/index.md @@ -0,0 +1,31 @@ +--- +title: vpn_connection_device_sample_configuration +hide_title: false +hide_table_of_contents: false +keywords: + - vpn_connection_device_sample_configuration + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namevpn_connection_device_sample_configuration
TypeResource
Idaws.ec2_api.vpn_connection_device_sample_configuration
+ +## Fields +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `vpn_connection_device_sample_configuration_Get` | `SELECT` | `VpnConnectionDeviceTypeId, VpnConnectionId, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/vpn_connection_device_types/index.md b/docs/aws-docs/providers/aws/ec2_api/vpn_connection_device_types/index.md new file mode 100644 index 0000000000..371c731b80 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/vpn_connection_device_types/index.md @@ -0,0 +1,37 @@ +--- +title: vpn_connection_device_types +hide_title: false +hide_table_of_contents: false +keywords: + - vpn_connection_device_types + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namevpn_connection_device_types
TypeResource
Idaws.ec2_api.vpn_connection_device_types
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `platform` | `string` | Customer gateway device platform. | +| `software` | `string` | Customer gateway device software version. | +| `vendor` | `string` | Customer gateway device vendor. | +| `vpnConnectionDeviceTypeId` | `string` | Customer gateway device identifier. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `vpn_connection_device_types_Get` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/vpn_connection_options/index.md b/docs/aws-docs/providers/aws/ec2_api/vpn_connection_options/index.md new file mode 100644 index 0000000000..1086a7c4e2 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/vpn_connection_options/index.md @@ -0,0 +1,32 @@ +--- +title: vpn_connection_options +hide_title: false +hide_table_of_contents: false +keywords: + - vpn_connection_options + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namevpn_connection_options
TypeResource
Idaws.ec2_api.vpn_connection_options
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `vpn_connection_options_Modify` | `EXEC` | `VpnConnectionId, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/vpn_connection_route/index.md b/docs/aws-docs/providers/aws/ec2_api/vpn_connection_route/index.md new file mode 100644 index 0000000000..3f3cdb1da5 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/vpn_connection_route/index.md @@ -0,0 +1,33 @@ +--- +title: vpn_connection_route +hide_title: false +hide_table_of_contents: false +keywords: + - vpn_connection_route + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namevpn_connection_route
TypeResource
Idaws.ec2_api.vpn_connection_route
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `vpn_connection_route_Create` | `INSERT` | `DestinationCidrBlock, VpnConnectionId, region` | <p>Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html">Amazon Web Services Site-to-Site VPN</a> in the <i>Amazon Web Services Site-to-Site VPN User Guide</i>.</p> | +| `vpn_connection_route_Delete` | `DELETE` | `DestinationCidrBlock, VpnConnectionId, region` | Deletes the specified static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway. | diff --git a/docs/aws-docs/providers/aws/ec2_api/vpn_connections/index.md b/docs/aws-docs/providers/aws/ec2_api/vpn_connections/index.md new file mode 100644 index 0000000000..d4bb6b3591 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/vpn_connections/index.md @@ -0,0 +1,51 @@ +--- +title: vpn_connections +hide_title: false +hide_table_of_contents: false +keywords: + - vpn_connections + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namevpn_connections
TypeResource
Idaws.ec2_api.vpn_connections
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `category` | `string` | The category of the VPN connection. A value of <code>VPN</code> indicates an Amazon Web Services VPN connection. A value of <code>VPN-Classic</code> indicates an Amazon Web Services Classic VPN connection. | +| `coreNetworkArn` | `string` | The ARN of the core network. | +| `coreNetworkAttachmentArn` | `string` | The ARN of the core network attachment. | +| `customerGatewayConfiguration` | `string` | The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the <a>CreateVpnConnection</a> response; however, it's present in the <a>DescribeVpnConnections</a> response only if the VPN connection is in the <code>pending</code> or <code>available</code> state. | +| `customerGatewayId` | `string` | The ID of the customer gateway at your end of the VPN connection. | +| `gatewayAssociationState` | `string` | The current state of the gateway association. | +| `options` | `object` | Describes VPN connection options. | +| `routes` | `array` | The static routes associated with the VPN connection. | +| `state` | `string` | The current state of the VPN connection. | +| `tagSet` | `array` | Any tags assigned to the VPN connection. | +| `transitGatewayId` | `string` | The ID of the transit gateway associated with the VPN connection. | +| `type` | `string` | The type of VPN connection. | +| `vgwTelemetry` | `array` | Information about the VPN tunnel. | +| `vpnConnectionId` | `string` | The ID of the VPN connection. | +| `vpnGatewayId` | `string` | The ID of the virtual private gateway at the Amazon Web Services side of the VPN connection. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `vpn_connections_Describe` | `SELECT` | `region` | <p>Describes one or more of your VPN connections.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html">Amazon Web Services Site-to-Site VPN</a> in the <i>Amazon Web Services Site-to-Site VPN User Guide</i>.</p> | +| `vpn_connection_Create` | `INSERT` | `CustomerGatewayId, Type, region` | <p>Creates a VPN connection between an existing virtual private gateway or transit gateway and a customer gateway. The supported connection type is <code>ipsec.1</code>.</p> <p>The response includes information that you need to give to your network administrator to configure your customer gateway.</p> <important> <p>We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway device.</p> </important> <p>If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call.</p> <p>This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html">Amazon Web Services Site-to-Site VPN</a> in the <i>Amazon Web Services Site-to-Site VPN User Guide</i>.</p> | +| `vpn_connection_Delete` | `DELETE` | `VpnConnectionId, region` | <p>Deletes the specified VPN connection.</p> <p>If you're deleting the VPC and its associated components, we recommend that you detach the virtual private gateway from the VPC and delete the VPC before deleting the VPN connection. If you believe that the tunnel credentials for your VPN connection have been compromised, you can delete the VPN connection and create a new one that has new keys, without needing to delete the VPC or virtual private gateway. If you create a new VPN connection, you must reconfigure the customer gateway device using the new configuration information returned with the new VPN connection ID.</p> <p>For certificate-based authentication, delete all Certificate Manager (ACM) private certificates used for the Amazon Web Services-side tunnel endpoints for the VPN connection before deleting the VPN connection.</p> | +| `vpn_connection_Modify` | `EXEC` | `VpnConnectionId, region` | <p>Modifies the customer gateway or the target gateway of an Amazon Web Services Site-to-Site VPN connection. To modify the target gateway, the following migration options are available:</p> <ul> <li> <p>An existing virtual private gateway to a new virtual private gateway</p> </li> <li> <p>An existing virtual private gateway to a transit gateway</p> </li> <li> <p>An existing transit gateway to a new transit gateway</p> </li> <li> <p>An existing transit gateway to a virtual private gateway</p> </li> </ul> <p>Before you perform the migration to the new gateway, you must configure the new gateway. Use <a>CreateVpnGateway</a> to create a virtual private gateway, or <a>CreateTransitGateway</a> to create a transit gateway.</p> <p>This step is required when you migrate from a virtual private gateway with static routes to a transit gateway. </p> <p>You must delete the static routes before you migrate to the new gateway.</p> <p>Keep a copy of the static route before you delete it. You will need to add back these routes to the transit gateway after the VPN connection migration is complete.</p> <p>After you migrate to the new gateway, you might need to modify your VPC route table. Use <a>CreateRoute</a> and <a>DeleteRoute</a> to make the changes described in <a href="https://docs.aws.amazon.com/vpn/latest/s2svpn/modify-vpn-target.html#step-update-routing">Update VPC route tables</a> in the <i>Amazon Web Services Site-to-Site VPN User Guide</i>.</p> <p>When the new gateway is a transit gateway, modify the transit gateway route table to allow traffic between the VPC and the Amazon Web Services Site-to-Site VPN connection. Use <a>CreateTransitGatewayRoute</a> to add the routes.</p> <p> If you deleted VPN static routes, you must add the static routes to the transit gateway route table.</p> <p>After you perform this operation, the VPN endpoint's IP addresses on the Amazon Web Services side and the tunnel options remain intact. Your Amazon Web Services Site-to-Site VPN connection will be temporarily unavailable for a brief period while we provision the new endpoints.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/vpn_gateways/index.md b/docs/aws-docs/providers/aws/ec2_api/vpn_gateways/index.md new file mode 100644 index 0000000000..988f6ace20 --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/vpn_gateways/index.md @@ -0,0 +1,44 @@ +--- +title: vpn_gateways +hide_title: false +hide_table_of_contents: false +keywords: + - vpn_gateways + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namevpn_gateways
TypeResource
Idaws.ec2_api.vpn_gateways
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `amazonSideAsn` | `integer` | The private Autonomous System Number (ASN) for the Amazon side of a BGP session. | +| `attachments` | `array` | Any VPCs attached to the virtual private gateway. | +| `availabilityZone` | `string` | The Availability Zone where the virtual private gateway was created, if applicable. This field may be empty or not returned. | +| `state` | `string` | The current state of the virtual private gateway. | +| `tagSet` | `array` | Any tags assigned to the virtual private gateway. | +| `type` | `string` | The type of VPN connection the virtual private gateway supports. | +| `vpnGatewayId` | `string` | The ID of the virtual private gateway. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `vpn_gateways_Describe` | `SELECT` | `region` | <p>Describes one or more of your virtual private gateways.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html">Amazon Web Services Site-to-Site VPN</a> in the <i>Amazon Web Services Site-to-Site VPN User Guide</i>.</p> | +| `vpn_gateway_Create` | `INSERT` | `Type, region` | <p>Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html">Amazon Web Services Site-to-Site VPN</a> in the <i>Amazon Web Services Site-to-Site VPN User Guide</i>.</p> | +| `vpn_gateway_Delete` | `DELETE` | `VpnGatewayId, region` | Deletes the specified virtual private gateway. You must first detach the virtual private gateway from the VPC. Note that you don't need to delete the virtual private gateway if you plan to delete and recreate the VPN connection between your VPC and your network. | +| `vpn_gateway_Attach` | `EXEC` | `VpcId, VpnGatewayId, region` | <p>Attaches a virtual private gateway to a VPC. You can attach one virtual private gateway to one VPC at a time.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html">Amazon Web Services Site-to-Site VPN</a> in the <i>Amazon Web Services Site-to-Site VPN User Guide</i>.</p> | +| `vpn_gateway_Detach` | `EXEC` | `VpcId, VpnGatewayId, region` | <p>Detaches a virtual private gateway from a VPC. You do this if you're planning to turn off the VPC and not use it anymore. You can confirm a virtual private gateway has been completely detached from a VPC by describing the virtual private gateway (any attachments to the virtual private gateway are also described).</p> <p>You must wait for the attachment's state to switch to <code>detached</code> before you can delete the VPC or attach a different VPC to the virtual private gateway.</p> | diff --git a/docs/aws-docs/providers/aws/ec2_api/vpn_tunnel_certificate/index.md b/docs/aws-docs/providers/aws/ec2_api/vpn_tunnel_certificate/index.md new file mode 100644 index 0000000000..fa68d1155b --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/vpn_tunnel_certificate/index.md @@ -0,0 +1,32 @@ +--- +title: vpn_tunnel_certificate +hide_title: false +hide_table_of_contents: false +keywords: + - vpn_tunnel_certificate + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namevpn_tunnel_certificate
TypeResource
Idaws.ec2_api.vpn_tunnel_certificate
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `vpn_tunnel_certificate_Modify` | `EXEC` | `VpnConnectionId, VpnTunnelOutsideIpAddress, region` | diff --git a/docs/aws-docs/providers/aws/ec2_api/vpn_tunnel_options/index.md b/docs/aws-docs/providers/aws/ec2_api/vpn_tunnel_options/index.md new file mode 100644 index 0000000000..16e0eeefaa --- /dev/null +++ b/docs/aws-docs/providers/aws/ec2_api/vpn_tunnel_options/index.md @@ -0,0 +1,32 @@ +--- +title: vpn_tunnel_options +hide_title: false +hide_table_of_contents: false +keywords: + - vpn_tunnel_options + - ec2_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namevpn_tunnel_options
TypeResource
Idaws.ec2_api.vpn_tunnel_options
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `vpn_tunnel_options_Modify` | `EXEC` | `TunnelOptions, VpnConnectionId, VpnTunnelOutsideIpAddress, region` | diff --git a/docs/aws-docs/providers/aws/ecr/index.md b/docs/aws-docs/providers/aws/ecr/index.md new file mode 100644 index 0000000000..ce557b11d1 --- /dev/null +++ b/docs/aws-docs/providers/aws/ecr/index.md @@ -0,0 +1,49 @@ +--- +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: 12
+total selectable resources: 12
+total methods: 12
+
+
+ +::: + +## Resources +
+
+public_repositories
+public_repository
+pull_through_cache_rule
+pull_through_cache_rules
+registry_policies
+registry_policy +
+
+replication_configuration
+replication_configurations
+repositories
+repository
+repository_creation_template
+repository_creation_templates +
+
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/ecr/public_repositories/index.md b/docs/aws-docs/providers/aws/ecr/public_repositories/index.md new file mode 100644 index 0000000000..39bc4c10f5 --- /dev/null +++ b/docs/aws-docs/providers/aws/ecr/public_repositories/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionThe AWS::ECR::PublicRepository resource specifies an Amazon Elastic Container Public Registry (Amazon Public ECR) repository, where users can push and pull Docker images. For more information, see https://docs.aws.amazon.com/AmazonECR
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +repository_name +FROM aws.ecr.public_repositories +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the public_repositories resource, the following permissions are required: + +### Create +```json +ecr-public:CreateRepository, +ecr-public:SetRepositoryPolicy, +ecr-public:PutRepositoryCatalogData, +ecr-public:TagResource +``` + +### List +```json +ecr-public:DescribeRepositories +``` + diff --git a/docs/aws-docs/providers/aws/ecr/public_repository/index.md b/docs/aws-docs/providers/aws/ecr/public_repository/index.md new file mode 100644 index 0000000000..e5a7777955 --- /dev/null +++ b/docs/aws-docs/providers/aws/ecr/public_repository/index.md @@ -0,0 +1,102 @@ +--- +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
DescriptionThe AWS::ECR::PublicRepository resource specifies an Amazon Elastic Container Public Registry (Amazon Public ECR) repository, where users can push and pull Docker images. For more information, see https://docs.aws.amazon.com/AmazonECR
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +repository_name, +repository_policy_text, +arn, +repository_catalog_data, +tags +FROM aws.ecr.public_repository +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the public_repository resource, the following permissions are required: + +### Read +```json +ecr-public:DescribeRepositories, +ecr-public:GetRepositoryPolicy, +ecr-public:GetRepositoryCatalogData, +ecr-public:ListTagsForResource +``` + +### Update +```json +ecr-public:SetRepositoryPolicy, +ecr-public:DeleteRepositoryPolicy, +ecr-public:PutRepositoryCatalogData, +ecr-public:TagResource, +ecr-public:UntagResource +``` + +### Delete +```json +ecr-public:DeleteRepository +``` + diff --git a/docs/aws-docs/providers/aws/ecr/pull_through_cache_rule/index.md b/docs/aws-docs/providers/aws/ecr/pull_through_cache_rule/index.md new file mode 100644 index 0000000000..796c9e9457 --- /dev/null +++ b/docs/aws-docs/providers/aws/ecr/pull_through_cache_rule/index.md @@ -0,0 +1,98 @@ +--- +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
DescriptionThe AWS::ECR::PullThroughCacheRule resource configures the upstream registry configuration details for an Amazon Elastic Container Registry (Amazon Private ECR) pull-through cache.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +ecr_repository_prefix, +upstream_registry_url, +credential_arn, +upstream_registry +FROM aws.ecr.pull_through_cache_rule +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the pull_through_cache_rule resource, the following permissions are required: + +### Read +```json +ecr:DescribePullThroughCacheRules +``` + +### Update +```json +ecr:DescribePullThroughCacheRules, +ecr:CreatePullThroughCacheRule, +ecr:DeletePullThroughCacheRule, +iam:CreateServiceLinkedRole, +secretsmanager:GetSecretValue +``` + +### Delete +```json +ecr:DescribePullThroughCacheRules, +ecr:DeletePullThroughCacheRule +``` + diff --git a/docs/aws-docs/providers/aws/ecr/pull_through_cache_rules/index.md b/docs/aws-docs/providers/aws/ecr/pull_through_cache_rules/index.md new file mode 100644 index 0000000000..74fb14b788 --- /dev/null +++ b/docs/aws-docs/providers/aws/ecr/pull_through_cache_rules/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionThe AWS::ECR::PullThroughCacheRule resource configures the upstream registry configuration details for an Amazon Elastic Container Registry (Amazon Private ECR) pull-through cache.
Idaws.ecr.pull_through_cache_rules
+ +## Fields + + + + + +
NameDatatypeDescription
ecr_repository_prefixstringThe ECRRepositoryPrefix is a custom alias for upstream registry url.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +ecr_repository_prefix +FROM aws.ecr.pull_through_cache_rules +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the pull_through_cache_rules resource, the following permissions are required: + +### Create +```json +ecr:DescribePullThroughCacheRules, +ecr:CreatePullThroughCacheRule, +ecr:DeletePullThroughCacheRule, +iam:CreateServiceLinkedRole, +secretsmanager:GetSecretValue +``` + +### List +```json +ecr:DescribePullThroughCacheRules +``` + diff --git a/docs/aws-docs/providers/aws/ecr/registry_policies/index.md b/docs/aws-docs/providers/aws/ecr/registry_policies/index.md new file mode 100644 index 0000000000..e91147a02b --- /dev/null +++ b/docs/aws-docs/providers/aws/ecr/registry_policies/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionThe ``AWS::ECR::RegistryPolicy`` resource creates or updates the permissions policy for a private registry.<br/> A private registry policy is used to specify permissions for another AWS-account and is used when configuring cross-account replication. For more information, see [Registry permissions](https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry-permissions.html) in the *Amazon Elastic Container Registry User Guide*.
Idaws.ecr.registry_policies
+ +## Fields + + + + + +
NameDatatypeDescription
registry_idundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +registry_id +FROM aws.ecr.registry_policies +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the registry_policies resource, the following permissions are required: + +### Create +```json +ecr:GetRegistryPolicy, +ecr:PutRegistryPolicy +``` + +### List +```json +ecr:GetRegistryPolicy +``` + diff --git a/docs/aws-docs/providers/aws/ecr/registry_policy/index.md b/docs/aws-docs/providers/aws/ecr/registry_policy/index.md new file mode 100644 index 0000000000..ff9b4399fd --- /dev/null +++ b/docs/aws-docs/providers/aws/ecr/registry_policy/index.md @@ -0,0 +1,90 @@ +--- +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
DescriptionThe ``AWS::ECR::RegistryPolicy`` resource creates or updates the permissions policy for a private registry.<br/> A private registry policy is used to specify permissions for another AWS-account and is used when configuring cross-account replication. For more information, see [Registry permissions](https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry-permissions.html) in the *Amazon Elastic Container Registry User Guide*.
Idaws.ecr.registry_policy
+ +## Fields + + + + + + +
NameDatatypeDescription
registry_idstring
policy_textobjectThe JSON policy text for your registry.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +registry_id, +policy_text +FROM aws.ecr.registry_policy +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the registry_policy resource, the following permissions are required: + +### Read +```json +ecr:GetRegistryPolicy +``` + +### Update +```json +ecr:GetRegistryPolicy, +ecr:PutRegistryPolicy +``` + +### Delete +```json +ecr:DeleteRegistryPolicy +``` + diff --git a/docs/aws-docs/providers/aws/ecr/replication_configuration/index.md b/docs/aws-docs/providers/aws/ecr/replication_configuration/index.md new file mode 100644 index 0000000000..f0d562247e --- /dev/null +++ b/docs/aws-docs/providers/aws/ecr/replication_configuration/index.md @@ -0,0 +1,93 @@ +--- +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
DescriptionThe AWS::ECR::ReplicationConfiguration resource configures the replication destinations for an Amazon Elastic Container Registry (Amazon Private ECR). For more information, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/replication.html
Idaws.ecr.replication_configuration
+ +## Fields + + + + + + +
NameDatatypeDescription
replication_configurationobject
registry_idstringThe RegistryId associated with the aws account.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +replication_configuration, +registry_id +FROM aws.ecr.replication_configuration +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the replication_configuration resource, the following permissions are required: + +### Read +```json +ecr:DescribeRegistry +``` + +### Update +```json +ecr:DescribeRegistry, +ecr:PutReplicationConfiguration, +iam:CreateServiceLinkedRole +``` + +### Delete +```json +ecr:DescribeRegistry, +ecr:PutReplicationConfiguration, +iam:CreateServiceLinkedRole +``` + diff --git a/docs/aws-docs/providers/aws/ecr/replication_configurations/index.md b/docs/aws-docs/providers/aws/ecr/replication_configurations/index.md new file mode 100644 index 0000000000..2e083a79d9 --- /dev/null +++ b/docs/aws-docs/providers/aws/ecr/replication_configurations/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionThe AWS::ECR::ReplicationConfiguration resource configures the replication destinations for an Amazon Elastic Container Registry (Amazon Private ECR). For more information, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/replication.html
Idaws.ecr.replication_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
registry_idstringThe RegistryId associated with the aws account.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +registry_id +FROM aws.ecr.replication_configurations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the replication_configurations resource, the following permissions are required: + +### Create +```json +ecr:DescribeRegistry, +ecr:PutReplicationConfiguration, +iam:CreateServiceLinkedRole +``` + +### List +```json +ecr:DescribeRegistry +``` + diff --git a/docs/aws-docs/providers/aws/ecr/repositories/index.md b/docs/aws-docs/providers/aws/ecr/repositories/index.md new file mode 100644 index 0000000000..7d6fe18b1f --- /dev/null +++ b/docs/aws-docs/providers/aws/ecr/repositories/index.md @@ -0,0 +1,83 @@ +--- +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
DescriptionThe ``AWS::ECR::Repository`` resource specifies an Amazon Elastic Container Registry (Amazon ECR) repository, where users can push and pull Docker images, Open Container Initiative (OCI) images, and OCI compatible artifacts. For more information, see [Amazon ECR private repositories](https://docs.aws.amazon.com/AmazonECR/latest/userguide/Repositories.html) in the *Amazon ECR User Guide*.
Idaws.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, CFNlong generates a unique physical ID and uses that ID for the repository name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).<br/> The repository name must start with a letter and can only contain lowercase letters, numbers, hyphens, underscores, and forward slashes.<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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +repository_name +FROM aws.ecr.repositories +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the repositories resource, the following permissions are required: + +### Create +```json +ecr:CreateRepository, +ecr:PutLifecyclePolicy, +ecr:SetRepositoryPolicy, +ecr:TagResource, +kms:DescribeKey, +kms:CreateGrant, +kms:RetireGrant +``` + +### List +```json +ecr:DescribeRepositories +``` + diff --git a/docs/aws-docs/providers/aws/ecr/repository/index.md b/docs/aws-docs/providers/aws/ecr/repository/index.md new file mode 100644 index 0000000000..773d8beb9d --- /dev/null +++ b/docs/aws-docs/providers/aws/ecr/repository/index.md @@ -0,0 +1,121 @@ +--- +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
DescriptionThe ``AWS::ECR::Repository`` resource specifies an Amazon Elastic Container Registry (Amazon ECR) repository, where users can push and pull Docker images, Open Container Initiative (OCI) images, and OCI compatible artifacts. For more information, see [Amazon ECR private repositories](https://docs.aws.amazon.com/AmazonECR/latest/userguide/Repositories.html) in the *Amazon ECR User Guide*.
Idaws.ecr.repository
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
empty_on_deletebooleanIf true, deleting the repository force deletes the contents of the repository. If false, the repository must be empty before attempting to delete it.
lifecycle_policyobjectCreates or updates a lifecycle policy. For information about lifecycle policy syntax, see [Lifecycle policy template](https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html).
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, CFNlong generates a unique physical ID and uses that ID for the repository name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).<br/> The repository name must start with a letter and can only contain lowercase letters, numbers, hyphens, underscores, and forward slashes.<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.
repository_policy_textobjectThe JSON repository policy text to apply to the repository. For more information, see [Amazon ECR repository policies](https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policy-examples.html) in the *Amazon Elastic Container Registry User Guide*.
tagsarrayAn array of key-value pairs to apply to this resource.
arnstring
repository_uristring
image_tag_mutabilitystringThe tag mutability setting for the repository. If this parameter is omitted, the default setting of ``MUTABLE`` will be used which will allow image tags to be overwritten. If ``IMMUTABLE`` is specified, all image tags within the repository will be immutable which will prevent them from being overwritten.
image_scanning_configurationobjectThe image scanning configuration for the repository. This determines whether images are scanned for known vulnerabilities after being pushed to the repository.
encryption_configurationobjectThe encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.ecr.repository +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the repository resource, the following permissions are required: + +### Read +```json +ecr:DescribeRepositories, +ecr:GetLifecyclePolicy, +ecr:GetRepositoryPolicy, +ecr:ListTagsForResource +``` + +### Update +```json +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 +```json +ecr:DeleteRepository, +kms:RetireGrant +``` + diff --git a/docs/aws-docs/providers/aws/ecr/repository_creation_template/index.md b/docs/aws-docs/providers/aws/ecr/repository_creation_template/index.md new file mode 100644 index 0000000000..df9232b51d --- /dev/null +++ b/docs/aws-docs/providers/aws/ecr/repository_creation_template/index.md @@ -0,0 +1,108 @@ +--- +title: repository_creation_template +hide_title: false +hide_table_of_contents: false +keywords: + - repository_creation_template + - 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_creation_template resource + +## Overview + + + + + +
Namerepository_creation_template
TypeResource
DescriptionAWS::ECR::RepositoryCreationTemplate is used to create repository with configuration from a pre-defined template.
Idaws.ecr.repository_creation_template
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
prefixstringThe prefix use to match the repository name and apply the template.
descriptionstringThe description of the template.
image_tag_mutabilitystringThe image tag mutability setting for the repository.
repository_policystringThe JSON repository policy text to apply to the repository. For more information, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/RepositoryPolicyExamples.html
lifecycle_policystringThe JSON lifecycle policy text to apply to the repository. For information about lifecycle policy syntax, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html
encryption_configurationobject
resource_tagsarrayAn array of key-value pairs to apply to this resource.
applied_forarrayA list of enumerable Strings representing the repository creation scenarios that the template will apply towards.
created_atstringCreate timestamp of the template.
updated_atstringUpdate timestamp of the template.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +prefix, +description, +image_tag_mutability, +repository_policy, +lifecycle_policy, +encryption_configuration, +resource_tags, +applied_for, +created_at, +updated_at +FROM aws.ecr.repository_creation_template +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the repository_creation_template resource, the following permissions are required: + +### Read +```json +ecr:DescribeRepositoryCreationTemplates +``` + +### Update +```json +ecr:DescribeRepositoryCreationTemplates, +ecr:UpdateRepositoryCreationTemplate, +ecr:PutLifecyclePolicy, +ecr:SetRepositoryPolicy +``` + +### Delete +```json +ecr:DeleteRepositoryCreationTemplate +``` + diff --git a/docs/aws-docs/providers/aws/ecr/repository_creation_templates/index.md b/docs/aws-docs/providers/aws/ecr/repository_creation_templates/index.md new file mode 100644 index 0000000000..064c42ac81 --- /dev/null +++ b/docs/aws-docs/providers/aws/ecr/repository_creation_templates/index.md @@ -0,0 +1,79 @@ +--- +title: repository_creation_templates +hide_title: false +hide_table_of_contents: false +keywords: + - repository_creation_templates + - 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 repository_creation_templates in a region + +## Overview + + + + + +
Namerepository_creation_templates
TypeResource
DescriptionAWS::ECR::RepositoryCreationTemplate is used to create repository with configuration from a pre-defined template.
Idaws.ecr.repository_creation_templates
+ +## Fields + + + + + +
NameDatatypeDescription
prefixstringThe prefix use to match the repository name and apply the template.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +prefix +FROM aws.ecr.repository_creation_templates +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the repository_creation_templates resource, the following permissions are required: + +### Create +```json +ecr:CreateRepositoryCreationTemplate, +ecr:PutLifecyclePolicy, +ecr:SetRepositoryPolicy +``` + +### List +```json +ecr:DescribeRepositoryCreationTemplates +``` + diff --git a/docs/aws-docs/providers/aws/ecs/cluster_capacity_provider_associations/index.md b/docs/aws-docs/providers/aws/ecs/cluster_capacity_provider_associations/index.md new file mode 100644 index 0000000000..b8fbf93e79 --- /dev/null +++ b/docs/aws-docs/providers/aws/ecs/cluster_capacity_provider_associations/index.md @@ -0,0 +1,93 @@ +--- +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
DescriptionAssociate a set of ECS Capacity Providers with a specified ECS Cluster
Idaws.ecs.cluster_capacity_provider_associations
+ +## Fields + + + + + + + +
NameDatatypeDescription
capacity_providersarray
clusterstring
default_capacity_provider_strategyarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +capacity_providers, +cluster, +default_capacity_provider_strategy +FROM aws.ecs.cluster_capacity_provider_associations +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the cluster_capacity_provider_associations resource, the following permissions are required: + +### Read +```json +ecs:DescribeClusters +``` + +### Update +```json +ecs:DescribeClusters, +ecs:PutClusterCapacityProviders +``` + +### Delete +```json +ecs:PutClusterCapacityProviders, +ecs:DescribeClusters +``` + diff --git a/docs/aws-docs/providers/aws/ecs/index.md b/docs/aws-docs/providers/aws/ecs/index.md new file mode 100644 index 0000000000..7cf121b3f3 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/ecs/primary_task_set/index.md b/docs/aws-docs/providers/aws/ecs/primary_task_set/index.md new file mode 100644 index 0000000000..427d5ac28e --- /dev/null +++ b/docs/aws-docs/providers/aws/ecs/primary_task_set/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionA pseudo-resource that manages which of your ECS task sets is primary.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +cluster, +task_set_id, +service +FROM aws.ecs.primary_task_set +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the primary_task_set resource, the following permissions are required: + +### Update +```json +ecs:DescribeTaskSets, +ecs:UpdateServicePrimaryTaskSet +``` + diff --git a/docs/aws-docs/providers/aws/ecs/primary_task_sets/index.md b/docs/aws-docs/providers/aws/ecs/primary_task_sets/index.md new file mode 100644 index 0000000000..7d72025d64 --- /dev/null +++ b/docs/aws-docs/providers/aws/ecs/primary_task_sets/index.md @@ -0,0 +1,70 @@ +--- +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
DescriptionA pseudo-resource that manages which of your ECS task sets is primary.
Idaws.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 + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +cluster, +service +FROM aws.ecs.primary_task_sets +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the primary_task_sets resource, the following permissions are required: + +### Create +```json +ecs:DescribeTaskSets, +ecs:UpdateServicePrimaryTaskSet +``` + diff --git a/docs/aws-docs/providers/aws/ecs/service/index.md b/docs/aws-docs/providers/aws/ecs/service/index.md new file mode 100644 index 0000000000..610ccbe65c --- /dev/null +++ b/docs/aws-docs/providers/aws/ecs/service/index.md @@ -0,0 +1,140 @@ +--- +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
DescriptionThe ``AWS::ECS::Service`` resource creates an Amazon Elastic Container Service (Amazon ECS) service that runs and maintains the requested number of tasks and associated load balancers.<br/> The stack update fails if you change any properties that require replacement and at least one Amazon ECS Service Connect ``ServiceConnectService`` is configured. This is because AWS CloudFormation creates the replacement service first, but each ``ServiceConnectService`` must have a name that is unique in the namespace.<br/> Starting April 15, 2023, AWS; will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, ECS, or EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
Idaws.ecs.service
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
service_arnstring
capacity_provider_strategyarrayThe capacity provider strategy to use for the service.<br/> If a ``capacityProviderStrategy`` is specified, the ``launchType`` parameter must be omitted. If no ``capacityProviderStrategy`` or ``launchType`` is specified, the ``defaultCapacityProviderStrategy`` for the cluster is used.<br/> A capacity provider strategy may contain a maximum of 6 capacity providers.
clusterstringThe short name or full Amazon Resource Name (ARN) of the cluster that you run your service on. If you do not specify a cluster, the default cluster is assumed.
deployment_configurationobjectOptional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
deployment_controllerobjectThe deployment controller to use for the service. If no deployment controller is specified, the default value of ``ECS`` is used.
desired_countintegerThe number of instantiations of the specified task definition to place and keep running in your service.<br/> For new services, if a desired count is not specified, a default value of ``1`` is used. When using the ``DAEMON`` scheduling strategy, the desired count is not required.<br/> For existing services, if a desired count is not specified, it is omitted from the operation.
enable_ecs_managed_tagsbooleanSpecifies whether to turn on Amazon ECS managed tags for the tasks within the service. For more information, see [Tagging your Amazon ECS resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) in the *Amazon Elastic Container Service Developer Guide*.<br/> When you use Amazon ECS managed tags, you need to set the ``propagateTags`` request parameter.
enable_execute_commandbooleanDetermines whether the execute command functionality is turned on for the service. If ``true``, the execute command functionality is turned on for all containers in tasks as part of the service.
health_check_grace_period_secondsintegerThe period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started. This is only used when your service is configured to use a load balancer. If your service has a load balancer defined and you don't specify a health check grace period value, the default value of ``0`` is used.<br/> If you do not use an Elastic Load Balancing, we recommend that you use the ``startPeriod`` in the task definition health check parameters. For more information, see [Health check](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_HealthCheck.html).<br/> If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.
launch_typestringThe launch type on which to run your service. For more information, see [Amazon ECS Launch Types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*.
load_balancersarrayA list of load balancer objects to associate with the service. If you specify the ``Role`` property, ``LoadBalancers`` must be specified as well. For information about the number of load balancers that you can specify per service, see [Service Load Balancing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html) in the *Amazon Elastic Container Service Developer Guide*.
namestring
network_configurationobjectThe network configuration for the service. This parameter is required for task definitions that use the ``awsvpc`` network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*.
placement_constraintsarrayAn array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime.
placement_strategiesarrayThe placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules for each service.
platform_versionstringThe platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the ``LATEST`` platform version is used. For more information, see [platform versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) in the *Amazon Elastic Container Service Developer Guide*.
propagate_tagsstringSpecifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the [TagResource](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html) API action.<br/> The default is ``NONE``.
rolestringThe name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition doesn't use the ``awsvpc`` network mode. If you specify the ``role`` parameter, you must also specify a load balancer object with the ``loadBalancers`` parameter.<br/> If your account has already created the Amazon ECS service-linked role, that role is used for your service unless you specify a role here. The service-linked role is required if your task definition uses the ``awsvpc`` network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you don't specify a role here. For more information, see [Using service-linked roles for Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) in the *Amazon Elastic Container Service Developer Guide*.<br/> If your specified role has a path other than ``/``, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name ``bar`` has a path of ``/foo/`` then you would specify ``/foo/bar`` as the role name. For more information, see [Friendly names and paths](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names) in the *IAM User Guide*.
scheduling_strategystringThe scheduling strategy to use for the service. For more information, see [Services](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html).<br/> There are two service scheduler strategies available:<br/> + ``REPLICA``-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. This scheduler strategy is required if the service uses the ``CODE_DEPLOY`` or ``EXTERNAL`` deployment controller types.<br/> + ``DAEMON``-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that don't meet the placement constraints. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies.<br/> Tasks using the Fargate launch type or the ``CODE_DEPLOY`` or ``EXTERNAL`` deployment controller types don't support the ``DAEMON`` scheduling strategy.
service_connect_configurationobjectThe configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.<br/> Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*.
service_namestringThe name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.<br/> The stack update fails if you change any properties that require replacement and the ``ServiceName`` is configured. This is because AWS CloudFormation creates the replacement service first, but each ``ServiceName`` must be unique in the cluster.
service_registriesarrayThe details of the service discovery registry to associate with this service. For more information, see [Service discovery](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html).<br/> Each service may be associated with one service registry. Multiple service registries for each service isn't supported.
tagsarrayThe metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well.<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 with this prefix. Tags with this prefix do not count against your tags per resource limit.
task_definitionstringThe ``family`` and ``revision`` (``family:revision``) or full ARN of the task definition to run in your service. If a ``revision`` isn't specified, the latest ``ACTIVE`` revision is used.<br/> A task definition must be specified if the service uses either the ``ECS`` or ``CODE_DEPLOY`` deployment controllers.<br/> For more information about deployment types, see [Amazon ECS deployment types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html).
volume_configurationsarrayThe configuration for a volume specified in the task definition as a volume that is configured at launch time. Currently, the only supported volume type is an Amazon EBS volume.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +service_arn, +capacity_provider_strategy, +cluster, +deployment_configuration, +deployment_controller, +desired_count, +enable_ecs_managed_tags, +enable_execute_command, +health_check_grace_period_seconds, +launch_type, +load_balancers, +name, +network_configuration, +placement_constraints, +placement_strategies, +platform_version, +propagate_tags, +role, +scheduling_strategy, +service_connect_configuration, +service_name, +service_registries, +tags, +task_definition, +volume_configurations +FROM aws.ecs.service +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the service resource, the following permissions are required: + +### Read +```json +ecs:DescribeServices +``` + +### Update +```json +ecs:DescribeServices, +ecs:ListTagsForResource, +ecs:TagResource, +ecs:UntagResource, +ecs:UpdateService +``` + +### Delete +```json +ecs:DeleteService, +ecs:DescribeServices +``` + diff --git a/docs/aws-docs/providers/aws/ecs/services/index.md b/docs/aws-docs/providers/aws/ecs/services/index.md new file mode 100644 index 0000000000..06051d0103 --- /dev/null +++ b/docs/aws-docs/providers/aws/ecs/services/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionThe ``AWS::ECS::Service`` resource creates an Amazon Elastic Container Service (Amazon ECS) service that runs and maintains the requested number of tasks and associated load balancers.<br/> The stack update fails if you change any properties that require replacement and at least one Amazon ECS Service Connect ``ServiceConnectService`` is configured. This is because AWS CloudFormation creates the replacement service first, but each ``ServiceConnectService`` must have a name that is unique in the namespace.<br/> Starting April 15, 2023, AWS; will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, ECS, or EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
Idaws.ecs.services
+ +## Fields + + + + + + +
NameDatatypeDescription
service_arnstring
clusterstringThe short name or full Amazon Resource Name (ARN) of the cluster that you run your service on. If you do not specify a cluster, the default cluster is assumed.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +service_arn, +cluster +FROM aws.ecs.services +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the services resource, the following permissions are required: + +### Create +```json +ecs:CreateService, +ecs:DescribeServices, +iam:PassRole, +ecs:TagResource +``` + +### List +```json +ecs:DescribeServices, +ecs:ListClusters, +ecs:ListServices +``` + diff --git a/docs/aws-docs/providers/aws/ecs/task_definition/index.md b/docs/aws-docs/providers/aws/ecs/task_definition/index.md new file mode 100644 index 0000000000..e0fd7c081c --- /dev/null +++ b/docs/aws-docs/providers/aws/ecs/task_definition/index.md @@ -0,0 +1,129 @@ +--- +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
DescriptionRegisters a new task definition from the supplied ``family`` and ``containerDefinitions``. Optionally, you can add data volumes to your containers with the ``volumes`` parameter. For more information about task definition parameters and defaults, see [Amazon ECS Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide*.<br/> You can specify a role for your task with the ``taskRoleArn`` parameter. When you specify a role for a task, its containers can then use the latest versions of the CLI or SDKs to make API requests to the AWS services that are specified in the policy that's associated with the role. For more information, see [IAM Roles for Tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the *Amazon Elastic Container Service Developer Guide*.<br/> You can specify a Docker networking mode for the containers in your task definition with the ``networkMode`` parameter. The available network modes correspond to those described in [Network settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#/network-settings) in the Docker run reference. If you specify the ``awsvpc`` network mode, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration when you create a service or run a task with the task definition. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*.<br/> In the following example or examples, the Authorization header contents (``AUTHPARAMS``) must be replaced with an AWS Signature Version 4 signature. For more information, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *General Reference*.<br/> You only need to learn how to sign HTTP requests if you intend to create them manually. When you use the [](https://docs.aws.amazon.com/cli/) or one of the [SDKs](https://docs.aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you, with the access key that you specify when you configure the tools. When you use these tools, you don't have to sign requests yourself.
Idaws.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`` values: 16 GB and 60 GB in 4 GB increments<br/> This option requires Linux platform ``1.4.0`` or later.<br/> + 16384 (16vCPU) - Available ``memory`` values: 32GB and 120 GB in 8 GB increments<br/> This option requires Linux platform ``1.4.0`` or later.
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`` values: 1024 (1 vCPU)<br/> + Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available ``cpu`` values: 2048 (2 vCPU)<br/> + Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available ``cpu`` values: 4096 (4 vCPU)<br/> + Between 16 GB and 60 GB in 4 GB increments - Available ``cpu`` values: 8192 (8 vCPU)<br/> This option requires Linux platform ``1.4.0`` or later.<br/> + Between 32GB and 120 GB in 8 GB increments - Available ``cpu`` values: 16384 (16 vCPU)<br/> This option requires Linux platform ``1.4.0`` or later.
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 elastic network interface port (for the ``awsvpc`` network mode), so you cannot take advantage of dynamic host port mappings. <br/> When using the ``host`` network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.<br/> If the network mode is ``awsvpc``, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*.<br/> If the network mode is ``host``, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.<br/> For more information, see [Network settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#network-settings) in the *Docker run reference*.
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://docs.aws.amazon.com/https://docs.docker.com/engine/security/security/).<br/> This parameter is not supported for Windows containers.<br/> This parameter is only supported for tasks that are hosted on FARGATElong if the tasks are using platform version ``1.4.0`` or later (Linux). This isn't supported for Windows containers on Fargate.
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 information, see [Docker security](https://docs.aws.amazon.com/https://docs.docker.com/engine/security/security/).<br/> If you are setting namespaced kernel parameters using ``systemControls`` for the containers in the task, the following will apply to your IPC resource namespace. For more information, see [System Controls](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html) in the *Amazon Elastic Container Service Developer Guide*.<br/> + For tasks that use the ``host`` IPC mode, IPC namespace related ``systemControls`` are not supported.<br/> + For tasks that use the ``task`` IPC mode, IPC namespace related ``systemControls`` will apply to all containers within a task.<br/> <br/> This parameter is not supported for Windows containers or tasks run on FARGATElong.
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 with this prefix. Tags with this prefix do not count against your tags per resource limit.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.ecs.task_definition +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the task_definition resource, the following permissions are required: + +### Read +```json +ecs:DescribeTaskDefinition +``` + +### Update +```json +ecs:TagResource, +ecs:UntagResource, +ecs:ListTagsForResource, +ecs:DescribeTaskDefinition, +iam:GetRole, +iam:PassRole +``` + +### Delete +```json +ecs:DeregisterTaskDefinition, +ecs:DescribeTaskDefinition, +iam:GetRole, +iam:PassRole +``` + diff --git a/docs/aws-docs/providers/aws/ecs/task_definitions/index.md b/docs/aws-docs/providers/aws/ecs/task_definitions/index.md new file mode 100644 index 0000000000..79bbb4f7bd --- /dev/null +++ b/docs/aws-docs/providers/aws/ecs/task_definitions/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionRegisters a new task definition from the supplied ``family`` and ``containerDefinitions``. Optionally, you can add data volumes to your containers with the ``volumes`` parameter. For more information about task definition parameters and defaults, see [Amazon ECS Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide*.<br/> You can specify a role for your task with the ``taskRoleArn`` parameter. When you specify a role for a task, its containers can then use the latest versions of the CLI or SDKs to make API requests to the AWS services that are specified in the policy that's associated with the role. For more information, see [IAM Roles for Tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the *Amazon Elastic Container Service Developer Guide*.<br/> You can specify a Docker networking mode for the containers in your task definition with the ``networkMode`` parameter. The available network modes correspond to those described in [Network settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#/network-settings) in the Docker run reference. If you specify the ``awsvpc`` network mode, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration when you create a service or run a task with the task definition. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*.<br/> In the following example or examples, the Authorization header contents (``AUTHPARAMS``) must be replaced with an AWS Signature Version 4 signature. For more information, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *General Reference*.<br/> You only need to learn how to sign HTTP requests if you intend to create them manually. When you use the [](https://docs.aws.amazon.com/cli/) or one of the [SDKs](https://docs.aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you, with the access key that you specify when you configure the tools. When you use these tools, you don't have to sign requests yourself.
Idaws.ecs.task_definitions
+ +## Fields + + + + + +
NameDatatypeDescription
task_definition_arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +task_definition_arn +FROM aws.ecs.task_definitions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the task_definitions resource, the following permissions are required: + +### Create +```json +ecs:RegisterTaskDefinition, +ecs:DescribeTaskDefinition, +ecs:TagResource, +iam:GetRole, +iam:PassRole +``` + +### List +```json +ecs:ListTaskDefinitions, +ecs:DescribeTaskDefinition +``` + diff --git a/docs/aws-docs/providers/aws/ecs/task_set/index.md b/docs/aws-docs/providers/aws/ecs/task_set/index.md new file mode 100644 index 0000000000..29938d3288 --- /dev/null +++ b/docs/aws-docs/providers/aws/ecs/task_set/index.md @@ -0,0 +1,113 @@ +--- +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
DescriptionCreate a task set in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.htmlin the Amazon Elastic Container Service Developer Guide.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +cluster, +external_id, +id, +launch_type, +load_balancers, +network_configuration, +platform_version, +scale, +service, +service_registries, +tags, +task_definition +FROM aws.ecs.task_set +WHERE data__Identifier = '||'; +``` + +## Permissions + +To operate on the task_set resource, the following permissions are required: + +### Read +```json +ecs:DescribeTaskSets +``` + +### Update +```json +ecs:DescribeTaskSets, +ecs:TagResource, +ecs:UntagResource, +ecs:UpdateTaskSet +``` + +### Delete +```json +ecs:DeleteTaskSet, +ecs:DescribeTaskSets +``` + diff --git a/docs/aws-docs/providers/aws/ecs/task_sets/index.md b/docs/aws-docs/providers/aws/ecs/task_sets/index.md new file mode 100644 index 0000000000..3c0ec70bd0 --- /dev/null +++ b/docs/aws-docs/providers/aws/ecs/task_sets/index.md @@ -0,0 +1,73 @@ +--- +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
DescriptionCreate a task set in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.htmlin the Amazon Elastic Container Service Developer Guide.
Idaws.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 + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +cluster, +service, +id +FROM aws.ecs.task_sets +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the task_sets resource, the following permissions are required: + +### Create +```json +ecs:CreateTaskSet, +ecs:DescribeTaskSets, +ecs:TagResource +``` + diff --git a/docs/aws-docs/providers/aws/efs/access_point/index.md b/docs/aws-docs/providers/aws/efs/access_point/index.md new file mode 100644 index 0000000000..da2c56d278 --- /dev/null +++ b/docs/aws-docs/providers/aws/efs/access_point/index.md @@ -0,0 +1,103 @@ +--- +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
DescriptionThe ``AWS::EFS::AccessPoint`` resource creates an EFS access point. An access point is an application-specific view into an EFS file system that applies an operating system user and group, and a file system path, to any file system request made through the access point. The operating system user and group override any identity information provided by the NFS client. The file system path is exposed as the access point's root directory. Applications using the access point can only access data in its own directory and below. To learn more, see [Mounting a file system using EFS access points](https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html).<br/> This operation requires permissions for the ``elasticfilesystem:CreateAccessPoint`` action.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +access_point_id, +arn, +client_token, +access_point_tags, +file_system_id, +posix_user, +root_directory +FROM aws.efs.access_point +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the access_point resource, the following permissions are required: + +### Read +```json +elasticfilesystem:DescribeAccessPoints +``` + +### Delete +```json +elasticfilesystem:DeleteAccessPoint, +elasticfilesystem:DescribeAccessPoints +``` + +### Update +```json +elasticfilesystem:DescribeAccessPoints, +elasticfilesystem:ListTagsForResource, +elasticfilesystem:TagResource, +elasticfilesystem:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/efs/access_points/index.md b/docs/aws-docs/providers/aws/efs/access_points/index.md new file mode 100644 index 0000000000..d854942af4 --- /dev/null +++ b/docs/aws-docs/providers/aws/efs/access_points/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionThe ``AWS::EFS::AccessPoint`` resource creates an EFS access point. An access point is an application-specific view into an EFS file system that applies an operating system user and group, and a file system path, to any file system request made through the access point. The operating system user and group override any identity information provided by the NFS client. The file system path is exposed as the access point's root directory. Applications using the access point can only access data in its own directory and below. To learn more, see [Mounting a file system using EFS access points](https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html).<br/> This operation requires permissions for the ``elasticfilesystem:CreateAccessPoint`` action.
Idaws.efs.access_points
+ +## Fields + + + + + +
NameDatatypeDescription
access_point_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +access_point_id +FROM aws.efs.access_points +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the access_points resource, the following permissions are required: + +### Create +```json +elasticfilesystem:CreateAccessPoint, +elasticfilesystem:TagResource, +elasticfilesystem:DescribeAccessPoints +``` + +### List +```json +elasticfilesystem:DescribeAccessPoints +``` + diff --git a/docs/aws-docs/providers/aws/efs/file_system/index.md b/docs/aws-docs/providers/aws/efs/file_system/index.md new file mode 100644 index 0000000000..6ca7eaeb63 --- /dev/null +++ b/docs/aws-docs/providers/aws/efs/file_system/index.md @@ -0,0 +1,141 @@ +--- +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
DescriptionThe ``AWS::EFS::FileSystem`` resource creates a new, empty file system in EFSlong (EFS). You must create a mount target ([AWS::EFS::MountTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html)) to mount your EFS file system on an EC2 or other AWS cloud compute resource.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.efs.file_system +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the file_system resource, the following permissions are required: + +### Read +```json +elasticfilesystem:DescribeBackupPolicy, +elasticfilesystem:DescribeFileSystemPolicy, +elasticfilesystem:DescribeFileSystems, +elasticfilesystem:DescribeLifecycleConfiguration, +elasticfilesystem:DescribeReplicationConfigurations +``` + +### Update +```json +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 +```json +elasticfilesystem:DescribeFileSystems, +elasticfilesystem:DeleteFileSystem, +elasticfilesystem:DeleteReplicationConfiguration, +elasticfilesystem:DescribeReplicationConfigurations +``` + diff --git a/docs/aws-docs/providers/aws/efs/file_systems/index.md b/docs/aws-docs/providers/aws/efs/file_systems/index.md new file mode 100644 index 0000000000..f35e24b19a --- /dev/null +++ b/docs/aws-docs/providers/aws/efs/file_systems/index.md @@ -0,0 +1,92 @@ +--- +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
DescriptionThe ``AWS::EFS::FileSystem`` resource creates a new, empty file system in EFSlong (EFS). You must create a mount target ([AWS::EFS::MountTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html)) to mount your EFS file system on an EC2 or other AWS cloud compute resource.
Idaws.efs.file_systems
+ +## Fields + + + + + +
NameDatatypeDescription
file_system_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +file_system_id +FROM aws.efs.file_systems +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the file_systems resource, the following permissions are required: + +### Create +```json +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 +```json +elasticfilesystem:DescribeBackupPolicy, +elasticfilesystem:DescribeFileSystemPolicy, +elasticfilesystem:DescribeFileSystems, +elasticfilesystem:DescribeLifecycleConfiguration, +elasticfilesystem:DescribeReplicationConfigurations +``` + diff --git a/docs/aws-docs/providers/aws/efs/index.md b/docs/aws-docs/providers/aws/efs/index.md new file mode 100644 index 0000000000..2d89091af5 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/efs/mount_target/index.md b/docs/aws-docs/providers/aws/efs/mount_target/index.md new file mode 100644 index 0000000000..e0f5500ba2 --- /dev/null +++ b/docs/aws-docs/providers/aws/efs/mount_target/index.md @@ -0,0 +1,99 @@ +--- +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
DescriptionThe ``AWS::EFS::MountTarget`` resource is an Amazon EFS resource that creates a mount target for an EFS file system. You can then mount the file system on Amazon EC2 instances or other resources by using the mount target.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +ip_address, +file_system_id, +security_groups, +subnet_id +FROM aws.efs.mount_target +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the mount_target resource, the following permissions are required: + +### Read +```json +elasticfilesystem:DescribeMountTargets, +elasticfilesystem:DescribeMountTargetSecurityGroups +``` + +### Update +```json +elasticfilesystem:DescribeMountTargets, +elasticfilesystem:DescribeMountTargetSecurityGroups, +elasticfilesystem:ModifyMountTargetSecurityGroups +``` + +### Delete +```json +elasticfilesystem:DescribeMountTargets, +elasticfilesystem:DeleteMountTarget +``` + diff --git a/docs/aws-docs/providers/aws/efs/mount_targets/index.md b/docs/aws-docs/providers/aws/efs/mount_targets/index.md new file mode 100644 index 0000000000..e737c5c85b --- /dev/null +++ b/docs/aws-docs/providers/aws/efs/mount_targets/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionThe ``AWS::EFS::MountTarget`` resource is an Amazon EFS resource that creates a mount target for an EFS file system. You can then mount the file system on Amazon EC2 instances or other resources by using the mount target.
Idaws.efs.mount_targets
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.efs.mount_targets +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the mount_targets resource, the following permissions are required: + +### Create +```json +elasticfilesystem:CreateMountTarget, +elasticfilesystem:DescribeMountTargets +``` + +### List +```json +elasticfilesystem:DescribeMountTargets, +elasticfilesystem:DescribeMountTargetSecurityGroups +``` + diff --git a/docs/aws-docs/providers/aws/eks/access_entries/index.md b/docs/aws-docs/providers/aws/eks/access_entries/index.md new file mode 100644 index 0000000000..4e41534647 --- /dev/null +++ b/docs/aws-docs/providers/aws/eks/access_entries/index.md @@ -0,0 +1,83 @@ +--- +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
DescriptionAn object representing an Amazon EKS AccessEntry.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +principal_arn, +cluster_name +FROM aws.eks.access_entries +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the access_entries resource, the following permissions are required: + +### Create +```json +eks:CreateAccessEntry, +eks:DescribeAccessEntry, +eks:AssociateAccessPolicy, +eks:TagResource, +eks:ListAssociatedAccessPolicies +``` + +### List +```json +eks:ListAccessEntries +``` + diff --git a/docs/aws-docs/providers/aws/eks/access_entry/index.md b/docs/aws-docs/providers/aws/eks/access_entry/index.md new file mode 100644 index 0000000000..2998364e95 --- /dev/null +++ b/docs/aws-docs/providers/aws/eks/access_entry/index.md @@ -0,0 +1,109 @@ +--- +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
DescriptionAn object representing an Amazon EKS AccessEntry.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +cluster_name, +principal_arn, +username, +tags, +access_entry_arn, +kubernetes_groups, +access_policies, +type +FROM aws.eks.access_entry +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the access_entry resource, the following permissions are required: + +### Read +```json +eks:DescribeAccessEntry, +eks:ListAssociatedAccessPolicies +``` + +### Update +```json +eks:DescribeAccessEntry, +eks:ListAssociatedAccessPolicies, +eks:UpdateAccessEntry, +eks:AssociateAccessPolicy, +eks:DisassociateAccessPolicy, +eks:TagResource, +eks:UntagResource +``` + +### Delete +```json +eks:DeleteAccessEntry, +eks:DescribeAccessEntry +``` + diff --git a/docs/aws-docs/providers/aws/eks/addon/index.md b/docs/aws-docs/providers/aws/eks/addon/index.md new file mode 100644 index 0000000000..cf3279d5f4 --- /dev/null +++ b/docs/aws-docs/providers/aws/eks/addon/index.md @@ -0,0 +1,110 @@ +--- +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
DescriptionResource Schema for AWS::EKS::Addon
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +cluster_name, +addon_name, +addon_version, +preserve_on_delete, +resolve_conflicts, +service_account_role_arn, +configuration_values, +arn, +tags +FROM aws.eks.addon +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the addon resource, the following permissions are required: + +### Read +```json +eks:DescribeAddon +``` + +### Delete +```json +eks:DeleteAddon, +eks:DescribeAddon +``` + +### Update +```json +iam:PassRole, +eks:UpdateAddon, +eks:DescribeAddon, +eks:DescribeUpdate, +eks:ListTagsForResource, +eks:TagResource, +eks:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/eks/addons/index.md b/docs/aws-docs/providers/aws/eks/addons/index.md new file mode 100644 index 0000000000..0dff59f6b6 --- /dev/null +++ b/docs/aws-docs/providers/aws/eks/addons/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionResource Schema for AWS::EKS::Addon
Idaws.eks.addons
+ +## Fields + + + + + + +
NameDatatypeDescription
cluster_namestringName of Cluster
addon_namestringName of Addon
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +cluster_name, +addon_name +FROM aws.eks.addons +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the addons resource, the following permissions are required: + +### Create +```json +eks:CreateAddon, +eks:DescribeAddon, +eks:TagResource, +iam:PassRole +``` + +### List +```json +eks:ListAddons +``` + diff --git a/docs/aws-docs/providers/aws/eks/cluster/index.md b/docs/aws-docs/providers/aws/eks/cluster/index.md new file mode 100644 index 0000000000..32b4dc7a28 --- /dev/null +++ b/docs/aws-docs/providers/aws/eks/cluster/index.md @@ -0,0 +1,126 @@ +--- +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
DescriptionAn object representing an Amazon EKS cluster.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.eks.cluster +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the cluster resource, the following permissions are required: + +### Read +```json +eks:DescribeCluster +``` + +### Update +```json +iam:PassRole, +eks:UpdateClusterConfig, +eks:UpdateClusterVersion, +eks:DescribeCluster, +eks:DescribeUpdate, +eks:TagResource, +eks:UntagResource +``` + +### Delete +```json +eks:DeleteCluster, +eks:DescribeCluster +``` + diff --git a/docs/aws-docs/providers/aws/eks/clusters/index.md b/docs/aws-docs/providers/aws/eks/clusters/index.md new file mode 100644 index 0000000000..21a825ad09 --- /dev/null +++ b/docs/aws-docs/providers/aws/eks/clusters/index.md @@ -0,0 +1,93 @@ +--- +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
DescriptionAn object representing an Amazon EKS cluster.
Idaws.eks.clusters
+ +## Fields + + + + + +
NameDatatypeDescription
namestringThe unique name to give to your cluster.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.eks.clusters +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the clusters resource, the following permissions are required: + +### Create +```json +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 +```json +eks:ListClusters +``` + diff --git a/docs/aws-docs/providers/aws/eks/fargate_profile/index.md b/docs/aws-docs/providers/aws/eks/fargate_profile/index.md new file mode 100644 index 0000000000..f4f09b6858 --- /dev/null +++ b/docs/aws-docs/providers/aws/eks/fargate_profile/index.md @@ -0,0 +1,103 @@ +--- +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
DescriptionResource Schema for AWS::EKS::FargateProfile
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +cluster_name, +fargate_profile_name, +pod_execution_role_arn, +arn, +subnets, +selectors, +tags +FROM aws.eks.fargate_profile +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the fargate_profile resource, the following permissions are required: + +### Read +```json +eks:DescribeFargateProfile +``` + +### Delete +```json +eks:DeleteFargateProfile, +eks:DescribeFargateProfile +``` + +### Update +```json +eks:DescribeFargateProfile, +eks:ListTagsForResource, +eks:TagResource, +eks:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/eks/fargate_profiles/index.md b/docs/aws-docs/providers/aws/eks/fargate_profiles/index.md new file mode 100644 index 0000000000..c1ebefd83c --- /dev/null +++ b/docs/aws-docs/providers/aws/eks/fargate_profiles/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionResource Schema for AWS::EKS::FargateProfile
Idaws.eks.fargate_profiles
+ +## Fields + + + + + + +
NameDatatypeDescription
cluster_namestringName of the Cluster
fargate_profile_namestringName of FargateProfile
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +cluster_name, +fargate_profile_name +FROM aws.eks.fargate_profiles +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the fargate_profiles resource, the following permissions are required: + +### Create +```json +eks:CreateFargateProfile, +eks:DescribeFargateProfile, +iam:GetRole, +iam:PassRole, +iam:CreateServiceLinkedRole, +eks:TagResource +``` + +### List +```json +eks:ListFargateProfiles +``` + diff --git a/docs/aws-docs/providers/aws/eks/identity_provider_config/index.md b/docs/aws-docs/providers/aws/eks/identity_provider_config/index.md new file mode 100644 index 0000000000..8190d432ff --- /dev/null +++ b/docs/aws-docs/providers/aws/eks/identity_provider_config/index.md @@ -0,0 +1,100 @@ +--- +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
DescriptionAn object representing an Amazon EKS IdentityProviderConfig.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +cluster_name, +type, +identity_provider_config_name, +oidc, +tags, +identity_provider_config_arn +FROM aws.eks.identity_provider_config +WHERE data__Identifier = '||'; +``` + +## Permissions + +To operate on the identity_provider_config resource, the following permissions are required: + +### Read +```json +eks:DescribeIdentityProviderConfig +``` + +### Update +```json +eks:DescribeIdentityProviderConfig, +eks:TagResource, +eks:UntagResource +``` + +### Delete +```json +eks:DisassociateIdentityProviderConfig, +eks:DescribeIdentityProviderConfig +``` + diff --git a/docs/aws-docs/providers/aws/eks/identity_provider_configs/index.md b/docs/aws-docs/providers/aws/eks/identity_provider_configs/index.md new file mode 100644 index 0000000000..b60a92380a --- /dev/null +++ b/docs/aws-docs/providers/aws/eks/identity_provider_configs/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionAn object representing an Amazon EKS IdentityProviderConfig.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +identity_provider_config_name, +cluster_name, +type +FROM aws.eks.identity_provider_configs +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the identity_provider_configs resource, the following permissions are required: + +### Create +```json +eks:DescribeUpdate, +eks:AssociateIdentityProviderConfig, +eks:DescribeIdentityProviderConfig, +eks:TagResource +``` + +### List +```json +eks:ListIdentityProviderConfigs +``` + diff --git a/docs/aws-docs/providers/aws/eks/index.md b/docs/aws-docs/providers/aws/eks/index.md new file mode 100644 index 0000000000..bc9dfa2fb8 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/eks/nodegroup/index.md b/docs/aws-docs/providers/aws/eks/nodegroup/index.md new file mode 100644 index 0000000000..205cb551cf --- /dev/null +++ b/docs/aws-docs/providers/aws/eks/nodegroup/index.md @@ -0,0 +1,134 @@ +--- +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
DescriptionResource schema for AWS::EKS::Nodegroup
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.eks.nodegroup +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the nodegroup resource, the following permissions are required: + +### Read +```json +eks:DescribeNodegroup +``` + +### Delete +```json +eks:DeleteNodegroup, +eks:DescribeNodegroup +``` + +### Update +```json +iam:GetRole, +iam:PassRole, +eks:DescribeNodegroup, +eks:DescribeUpdate, +eks:ListUpdates, +eks:TagResource, +eks:UntagResource, +eks:UpdateNodegroupConfig, +eks:UpdateNodegroupVersion +``` + diff --git a/docs/aws-docs/providers/aws/eks/nodegroups/index.md b/docs/aws-docs/providers/aws/eks/nodegroups/index.md new file mode 100644 index 0000000000..508188a141 --- /dev/null +++ b/docs/aws-docs/providers/aws/eks/nodegroups/index.md @@ -0,0 +1,93 @@ +--- +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
DescriptionResource schema for AWS::EKS::Nodegroup
Idaws.eks.nodegroups
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.eks.nodegroups +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the nodegroups resource, the following permissions are required: + +### Create +```json +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 +```json +eks:ListNodegroups +``` + diff --git a/docs/aws-docs/providers/aws/eks/pod_identity_association/index.md b/docs/aws-docs/providers/aws/eks/pod_identity_association/index.md new file mode 100644 index 0000000000..ccdb6f866a --- /dev/null +++ b/docs/aws-docs/providers/aws/eks/pod_identity_association/index.md @@ -0,0 +1,105 @@ +--- +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
DescriptionAn object representing an Amazon EKS PodIdentityAssociation.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +cluster_name, +role_arn, +namespace, +service_account, +association_arn, +association_id, +tags +FROM aws.eks.pod_identity_association +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the pod_identity_association resource, the following permissions are required: + +### Read +```json +eks:DescribePodIdentityAssociation +``` + +### Update +```json +eks:DescribePodIdentityAssociation, +eks:UpdatePodIdentityAssociation, +eks:TagResource, +eks:UntagResource, +iam:PassRole, +iam:GetRole +``` + +### Delete +```json +eks:DeletePodIdentityAssociation, +eks:DescribePodIdentityAssociation +``` + diff --git a/docs/aws-docs/providers/aws/eks/pod_identity_associations/index.md b/docs/aws-docs/providers/aws/eks/pod_identity_associations/index.md new file mode 100644 index 0000000000..2bc0c4c951 --- /dev/null +++ b/docs/aws-docs/providers/aws/eks/pod_identity_associations/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionAn object representing an Amazon EKS PodIdentityAssociation.
Idaws.eks.pod_identity_associations
+ +## Fields + + + + + +
NameDatatypeDescription
association_arnstringThe ARN of the pod identity association.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +association_arn +FROM aws.eks.pod_identity_associations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the pod_identity_associations resource, the following permissions are required: + +### Create +```json +eks:CreatePodIdentityAssociation, +eks:DescribePodIdentityAssociation, +eks:TagResource, +iam:PassRole, +iam:GetRole +``` + +### List +```json +eks:ListPodIdentityAssociations +``` + diff --git a/docs/aws-docs/providers/aws/elasticache/global_replication_group/index.md b/docs/aws-docs/providers/aws/elasticache/global_replication_group/index.md new file mode 100644 index 0000000000..0d95d914f3 --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticache/global_replication_group/index.md @@ -0,0 +1,115 @@ +--- +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
DescriptionThe AWS::ElastiCache::GlobalReplicationGroup resource creates an Amazon ElastiCache Global Replication Group.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.elasticache.global_replication_group +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the global_replication_group resource, the following permissions are required: + +### Read +```json +elasticache:DescribeGlobalReplicationGroups +``` + +### Update +```json +elasticache:ModifyGlobalReplicationGroup, +elasticache:FailoverGlobalReplicationGroup, +elasticache:DescribeGlobalReplicationGroups, +elasticache:IncreaseNodeGroupsInGlobalReplicationGroup, +elasticache:DecreaseNodeGroupsInGlobalReplicationGroup, +elasticache:DisassociateGlobalReplicationGroup, +elasticache:RebalanceSlotsInGlobalReplicationGroup +``` + +### Delete +```json +elasticache:DeleteGlobalReplicationGroup, +elasticache:DisassociateGlobalReplicationGroup, +elasticache:DescribeGlobalReplicationGroups +``` + diff --git a/docs/aws-docs/providers/aws/elasticache/global_replication_groups/index.md b/docs/aws-docs/providers/aws/elasticache/global_replication_groups/index.md new file mode 100644 index 0000000000..f0c4dc8c23 --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticache/global_replication_groups/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionThe AWS::ElastiCache::GlobalReplicationGroup resource creates an Amazon ElastiCache Global Replication Group.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +global_replication_group_id +FROM aws.elasticache.global_replication_groups +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the global_replication_groups resource, the following permissions are required: + +### Create +```json +elasticache:CreateGlobalReplicationGroup, +elasticache:DescribeGlobalReplicationGroups +``` + +### List +```json +elasticache:DescribeGlobalReplicationGroups +``` + diff --git a/docs/aws-docs/providers/aws/elasticache/index.md b/docs/aws-docs/providers/aws/elasticache/index.md new file mode 100644 index 0000000000..81db55690c --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/elasticache/serverless_cache/index.md b/docs/aws-docs/providers/aws/elasticache/serverless_cache/index.md new file mode 100644 index 0000000000..af5c5139c7 --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticache/serverless_cache/index.md @@ -0,0 +1,132 @@ +--- +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
DescriptionThe AWS::ElastiCache::ServerlessCache resource creates an Amazon ElastiCache Serverless Cache.
Idaws.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
arnstringThe ARN of the Serverless Cache.
final_snapshot_namestringThe final snapshot name which is taken before Serverless Cache is deleted.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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, +arn, +final_snapshot_name +FROM aws.elasticache.serverless_cache +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the serverless_cache resource, the following permissions are required: + +### Read +```json +elasticache:DescribeServerlessCaches, +elasticache:ListTagsForResource +``` + +### Update +```json +elasticache:ModifyServerlessCache, +elasticache:DescribeServerlessCaches, +elasticache:AddTagsToResource, +elasticache:ListTagsForResource, +elasticache:RemoveTagsFromResource +``` + +### Delete +```json +elasticache:DeleteServerlessCache, +elasticache:DescribeServerlessCaches, +elasticache:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/elasticache/serverless_caches/index.md b/docs/aws-docs/providers/aws/elasticache/serverless_caches/index.md new file mode 100644 index 0000000000..9fc2c99d3d --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticache/serverless_caches/index.md @@ -0,0 +1,85 @@ +--- +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
DescriptionThe AWS::ElastiCache::ServerlessCache resource creates an Amazon ElastiCache Serverless Cache.
Idaws.elasticache.serverless_caches
+ +## Fields + + + + + +
NameDatatypeDescription
serverless_cache_namestringThe name of the Serverless Cache. This value must be unique.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +serverless_cache_name +FROM aws.elasticache.serverless_caches +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the serverless_caches resource, the following permissions are required: + +### Create +```json +elasticache:CreateServerlessCache, +elasticache:DescribeServerlessCaches, +elasticache:AddTagsToResource, +elasticache:ListTagsForResource, +ec2:CreateTags, +ec2:CreateVpcEndpoint, +kms:CreateGrant, +kms:DescribeKey +``` + +### List +```json +elasticache:DescribeServerlessCaches, +elasticache:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/elasticache/subnet_group/index.md b/docs/aws-docs/providers/aws/elasticache/subnet_group/index.md new file mode 100644 index 0000000000..28e60e52e4 --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticache/subnet_group/index.md @@ -0,0 +1,99 @@ +--- +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
DescriptionResource Type definition for AWS::ElastiCache::SubnetGroup
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +description, +subnet_ids, +cache_subnet_group_name, +tags +FROM aws.elasticache.subnet_group +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the subnet_group resource, the following permissions are required: + +### Read +```json +elasticache:DescribeCacheSubnetGroups, +elasticache:ListTagsForResource +``` + +### Delete +```json +elasticache:DeleteCacheSubnetGroup, +elasticache:DescribeCacheSubnetGroups, +elasticache:ListTagsForResource +``` + +### Update +```json +elasticache:ModifyCacheSubnetGroup, +elasticache:DescribeCacheSubnetGroups, +elasticache:AddTagsToResource, +elasticache:RemoveTagsFromResource +``` + diff --git a/docs/aws-docs/providers/aws/elasticache/subnet_groups/index.md b/docs/aws-docs/providers/aws/elasticache/subnet_groups/index.md new file mode 100644 index 0000000000..1779b04aad --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticache/subnet_groups/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionResource Type definition for AWS::ElastiCache::SubnetGroup
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +cache_subnet_group_name +FROM aws.elasticache.subnet_groups +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the subnet_groups resource, the following permissions are required: + +### Create +```json +elasticache:CreateCacheSubnetGroup, +elasticache:AddTagsToResource, +elasticache:DescribeCacheSubnetGroups, +elasticache:ListTagsForResource +``` + +### List +```json +elasticache:DescribeCacheSubnetGroups +``` + diff --git a/docs/aws-docs/providers/aws/elasticache/user/index.md b/docs/aws-docs/providers/aws/elasticache/user/index.md new file mode 100644 index 0000000000..035da50358 --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticache/user/index.md @@ -0,0 +1,111 @@ +--- +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
DescriptionResource Type definition for AWS::ElastiCache::User
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +status, +user_id, +user_name, +engine, +access_string, +no_password_required, +passwords, +arn, +authentication_mode, +tags +FROM aws.elasticache.user +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the user resource, the following permissions are required: + +### Read +```json +elasticache:DescribeUsers, +elasticache:ListTagsForResource +``` + +### Update +```json +elasticache:ModifyUser, +elasticache:DescribeUsers, +elasticache:ListTagsForResource, +elasticache:AddTagsToResource, +elasticache:RemoveTagsFromResource +``` + +### Delete +```json +elasticache:DeleteUser, +elasticache:DescribeUsers +``` + diff --git a/docs/aws-docs/providers/aws/elasticache/user_group/index.md b/docs/aws-docs/providers/aws/elasticache/user_group/index.md new file mode 100644 index 0000000000..222eeee209 --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticache/user_group/index.md @@ -0,0 +1,105 @@ +--- +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
DescriptionResource Type definition for AWS::ElastiCache::UserGroup
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +status, +user_group_id, +engine, +user_ids, +arn, +tags +FROM aws.elasticache.user_group +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the user_group resource, the following permissions are required: + +### Read +```json +elasticache:DescribeUserGroups, +elasticache:ListTagsForResource +``` + +### Update +```json +elasticache:ModifyUserGroup, +elasticache:DescribeUserGroups, +elasticache:ListTagsForResource, +elasticache:AddTagsToResource, +elasticache:RemoveTagsFromResource +``` + +### Delete +```json +elasticache:ModifyReplicationGroup, +elasticache:DeleteUserGroup, +elasticache:DescribeUserGroups, +elasticache:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/elasticache/user_groups/index.md b/docs/aws-docs/providers/aws/elasticache/user_groups/index.md new file mode 100644 index 0000000000..ea68766f88 --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticache/user_groups/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionResource Type definition for AWS::ElastiCache::UserGroup
Idaws.elasticache.user_groups
+ +## Fields + + + + + +
NameDatatypeDescription
user_group_idstringThe ID of the user group.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +user_group_id +FROM aws.elasticache.user_groups +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the user_groups resource, the following permissions are required: + +### Create +```json +elasticache:CreateUserGroup, +elasticache:DescribeUserGroups, +elasticache:ListTagsForResource, +elasticache:AddTagsToResource +``` + +### List +```json +elasticache:DescribeUserGroups, +elasticache:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/elasticache/users/index.md b/docs/aws-docs/providers/aws/elasticache/users/index.md new file mode 100644 index 0000000000..8489feaced --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticache/users/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionResource Type definition for AWS::ElastiCache::User
Idaws.elasticache.users
+ +## Fields + + + + + +
NameDatatypeDescription
user_idstringThe ID of the user.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +user_id +FROM aws.elasticache.users +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the users resource, the following permissions are required: + +### Create +```json +elasticache:CreateUser, +elasticache:DescribeUsers, +elasticache:ListTagsForResource, +elasticache:AddTagsToResource +``` + +### List +```json +elasticache:DescribeUsers, +elasticache:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/elasticbeanstalk/application/index.md b/docs/aws-docs/providers/aws/elasticbeanstalk/application/index.md new file mode 100644 index 0000000000..3d1aa97dc2 --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticbeanstalk/application/index.md @@ -0,0 +1,92 @@ +--- +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
DescriptionThe AWS::ElasticBeanstalk::Application resource specifies an Elastic Beanstalk application.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +application_name, +description, +resource_lifecycle_config +FROM aws.elasticbeanstalk.application +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the application resource, the following permissions are required: + +### Read +```json +elasticbeanstalk:DescribeApplications +``` + +### Update +```json +elasticbeanstalk:UpdateApplication, +elasticbeanstalk:UpdateApplicationResourceLifecycle +``` + +### Delete +```json +elasticbeanstalk:DeleteApplication +``` + diff --git a/docs/aws-docs/providers/aws/elasticbeanstalk/application_version/index.md b/docs/aws-docs/providers/aws/elasticbeanstalk/application_version/index.md new file mode 100644 index 0000000000..0554f5fe45 --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticbeanstalk/application_version/index.md @@ -0,0 +1,93 @@ +--- +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
DescriptionResource Type definition for AWS::ElasticBeanstalk::ApplicationVersion
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +application_name, +description, +source_bundle +FROM aws.elasticbeanstalk.application_version +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the application_version resource, the following permissions are required: + +### Read +```json +elasticbeanstalk:DescribeApplicationVersions +``` + +### Update +```json +elasticbeanstalk:UpdateApplicationVersion +``` + +### Delete +```json +elasticbeanstalk:DeleteApplicationVersion +``` + diff --git a/docs/aws-docs/providers/aws/elasticbeanstalk/application_versions/index.md b/docs/aws-docs/providers/aws/elasticbeanstalk/application_versions/index.md new file mode 100644 index 0000000000..fa793f4e97 --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticbeanstalk/application_versions/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionResource Type definition for AWS::ElasticBeanstalk::ApplicationVersion
Idaws.elasticbeanstalk.application_versions
+ +## Fields + + + + + + +
NameDatatypeDescription
application_namestringThe name of the Elastic Beanstalk application that is associated with this application version.
idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +application_name, +id +FROM aws.elasticbeanstalk.application_versions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the application_versions resource, the following permissions are required: + +### Create +```json +elasticbeanstalk:CreateApplicationVersion, +elasticbeanstalk:DescribeApplicationVersions, +s3:GetObject, +s3:PutObject +``` + +### List +```json +elasticbeanstalk:DescribeApplicationVersions +``` + diff --git a/docs/aws-docs/providers/aws/elasticbeanstalk/applications/index.md b/docs/aws-docs/providers/aws/elasticbeanstalk/applications/index.md new file mode 100644 index 0000000000..30c812d355 --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticbeanstalk/applications/index.md @@ -0,0 +1,77 @@ +--- +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
DescriptionThe AWS::ElasticBeanstalk::Application resource specifies an Elastic Beanstalk application.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +application_name +FROM aws.elasticbeanstalk.applications +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the applications resource, the following permissions are required: + +### Create +```json +elasticbeanstalk:CreateApplication +``` + +### List +```json +elasticbeanstalk:DescribeApplications +``` + diff --git a/docs/aws-docs/providers/aws/elasticbeanstalk/configuration_template/index.md b/docs/aws-docs/providers/aws/elasticbeanstalk/configuration_template/index.md new file mode 100644 index 0000000000..254ef6bea9 --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticbeanstalk/configuration_template/index.md @@ -0,0 +1,102 @@ +--- +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
DescriptionResource Type definition for AWS::ElasticBeanstalk::ConfigurationTemplate
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +application_name, +description, +environment_id, +option_settings, +platform_arn, +solution_stack_name, +source_configuration, +template_name +FROM aws.elasticbeanstalk.configuration_template +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the configuration_template resource, the following permissions are required: + +### Read +```json +elasticbeanstalk:DescribeConfigurationSettings +``` + +### Update +```json +elasticbeanstalk:UpdateConfigurationTemplate +``` + +### Delete +```json +elasticbeanstalk:DeleteConfigurationTemplate, +elasticbeanstalk:DescribeConfigurationSettings +``` + diff --git a/docs/aws-docs/providers/aws/elasticbeanstalk/configuration_templates/index.md b/docs/aws-docs/providers/aws/elasticbeanstalk/configuration_templates/index.md new file mode 100644 index 0000000000..f9a7b737cf --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticbeanstalk/configuration_templates/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource Type definition for AWS::ElasticBeanstalk::ConfigurationTemplate
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +application_name, +template_name +FROM aws.elasticbeanstalk.configuration_templates +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the configuration_templates resource, the following permissions are required: + +### Create +```json +elasticbeanstalk:CreateConfigurationTemplate +``` + +### List +```json +elasticbeanstalk:DescribeApplications +``` + diff --git a/docs/aws-docs/providers/aws/elasticbeanstalk/environment/index.md b/docs/aws-docs/providers/aws/elasticbeanstalk/environment/index.md new file mode 100644 index 0000000000..ae3db59300 --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticbeanstalk/environment/index.md @@ -0,0 +1,119 @@ +--- +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
DescriptionResource Type definition for AWS::ElasticBeanstalk::Environment
Idaws.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_urlstring
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.
cname_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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +platform_arn, +application_name, +description, +environment_name, +operations_role, +tier, +version_label, +endpoint_url, +option_settings, +template_name, +solution_stack_name, +cname_prefix, +tags +FROM aws.elasticbeanstalk.environment +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the environment resource, the following permissions are required: + +### Read +```json +elasticbeanstalk:DescribeEnvironments, +elasticbeanstalk:DescribeConfigurationSettings, +elasticbeanstalk:ListTagsForResource +``` + +### Update +```json +elasticbeanstalk:DescribeEnvironments, +elasticbeanstalk:UpdateEnvironment, +elasticbeanstalk:UpdateTagsForResource, +elasticbeanstalk:AssociateEnvironmentOperationsRole, +elasticbeanstalk:DisassociateEnvironmentOperationsRole, +iam:PassRole +``` + +### Delete +```json +elasticbeanstalk:DescribeEnvironments, +elasticbeanstalk:TerminateEnvironment +``` + diff --git a/docs/aws-docs/providers/aws/elasticbeanstalk/environments/index.md b/docs/aws-docs/providers/aws/elasticbeanstalk/environments/index.md new file mode 100644 index 0000000000..ab87a97bb4 --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticbeanstalk/environments/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource Type definition for AWS::ElasticBeanstalk::Environment
Idaws.elasticbeanstalk.environments
+ +## Fields + + + + + +
NameDatatypeDescription
environment_namestringA unique name for the environment.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +environment_name +FROM aws.elasticbeanstalk.environments +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the environments resource, the following permissions are required: + +### Create +```json +elasticbeanstalk:DescribeEnvironments, +elasticbeanstalk:CreateEnvironment, +iam:PassRole +``` + +### List +```json +elasticbeanstalk:DescribeEnvironments +``` + diff --git a/docs/aws-docs/providers/aws/elasticbeanstalk/index.md b/docs/aws-docs/providers/aws/elasticbeanstalk/index.md new file mode 100644 index 0000000000..50a5fc1f12 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/elasticloadbalancingv2/index.md b/docs/aws-docs/providers/aws/elasticloadbalancingv2/index.md new file mode 100644 index 0000000000..7a425be4b9 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/elasticloadbalancingv2/listener/index.md b/docs/aws-docs/providers/aws/elasticloadbalancingv2/listener/index.md new file mode 100644 index 0000000000..c4116f4596 --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticloadbalancingv2/listener/index.md @@ -0,0 +1,106 @@ +--- +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
DescriptionSpecifies a listener for an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.
Idaws.elasticloadbalancingv2.listener
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
ssl_policystring[HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported.<br/> Updating the security policy can result in interruptions if the load balancer is handling a high volume of traffic.<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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +ssl_policy, +load_balancer_arn, +default_actions, +port, +certificates, +protocol, +listener_arn, +alpn_policy, +mutual_authentication +FROM aws.elasticloadbalancingv2.listener +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the listener resource, the following permissions are required: + +### Delete +```json +elasticloadbalancing:DeleteListener, +elasticloadbalancing:DescribeListeners +``` + +### Read +```json +elasticloadbalancing:DescribeListeners +``` + +### Update +```json +elasticloadbalancing:ModifyListener, +elasticloadbalancing:DescribeListeners, +cognito-idp:DescribeUserPoolClient +``` + diff --git a/docs/aws-docs/providers/aws/elasticloadbalancingv2/listener_rule/index.md b/docs/aws-docs/providers/aws/elasticloadbalancingv2/listener_rule/index.md new file mode 100644 index 0000000000..03ca66be45 --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticloadbalancingv2/listener_rule/index.md @@ -0,0 +1,100 @@ +--- +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
DescriptionSpecifies a listener rule. The listener must be associated with an Application Load Balancer. Each rule consists of a priority, one or more actions, and one or more conditions.<br/> For more information, see [Quotas for your Application Load Balancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-limits.html) in the *User Guide for Application Load Balancers*.
Idaws.elasticloadbalancingv2.listener_rule
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
listener_arnstringThe Amazon Resource Name (ARN) of the listener.
rule_arnstring
actionsarrayThe actions.<br/> The rule must include exactly one of the following types of actions: ``forward``, ``fixed-response``, or ``redirect``, and it must be the last action to be performed. If the rule is for an HTTPS listener, it can also optionally include an authentication action.
priorityintegerThe rule priority. A listener can't have multiple rules with the same priority.<br/> If you try to reorder rules by updating their priorities, do not specify a new priority if an existing rule already uses this priority, as this can cause an error. If you need to reuse a priority with a different rule, you must remove it as a priority first, and then specify it in a subsequent update.
conditionsarrayThe conditions.<br/> The rule can optionally include up to one of each of the following conditions: ``http-request-method``, ``host-header``, ``path-pattern``, and ``source-ip``. A rule can also optionally include one or more of each of the following conditions: ``http-header`` and ``query-string``.
is_defaultboolean
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +listener_arn, +rule_arn, +actions, +priority, +conditions, +is_default +FROM aws.elasticloadbalancingv2.listener_rule +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the listener_rule resource, the following permissions are required: + +### Delete +```json +elasticloadbalancing:DeleteRule, +elasticloadbalancing:DescribeRules +``` + +### Read +```json +elasticloadbalancing:DescribeRules +``` + +### Update +```json +elasticloadbalancing:ModifyRule, +elasticloadbalancing:SetRulePriorities, +elasticloadbalancing:DescribeRules +``` + diff --git a/docs/aws-docs/providers/aws/elasticloadbalancingv2/listener_rules/index.md b/docs/aws-docs/providers/aws/elasticloadbalancingv2/listener_rules/index.md new file mode 100644 index 0000000000..09e24f178d --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticloadbalancingv2/listener_rules/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionSpecifies a listener rule. The listener must be associated with an Application Load Balancer. Each rule consists of a priority, one or more actions, and one or more conditions.<br/> For more information, see [Quotas for your Application Load Balancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-limits.html) in the *User Guide for Application Load Balancers*.
Idaws.elasticloadbalancingv2.listener_rules
+ +## Fields + + + + + +
NameDatatypeDescription
rule_arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +rule_arn +FROM aws.elasticloadbalancingv2.listener_rules +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the listener_rules resource, the following permissions are required: + +### Create +```json +elasticloadbalancing:CreateRule, +elasticloadbalancing:DescribeRules, +cognito-idp:DescribeUserPoolClient +``` + +### List +```json +elasticloadbalancing:DescribeRules +``` + diff --git a/docs/aws-docs/providers/aws/elasticloadbalancingv2/listeners/index.md b/docs/aws-docs/providers/aws/elasticloadbalancingv2/listeners/index.md new file mode 100644 index 0000000000..a0adebaa31 --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticloadbalancingv2/listeners/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionSpecifies a listener for an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.
Idaws.elasticloadbalancingv2.listeners
+ +## Fields + + + + + +
NameDatatypeDescription
listener_arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +listener_arn +FROM aws.elasticloadbalancingv2.listeners +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the listeners resource, the following permissions are required: + +### Create +```json +elasticloadbalancing:CreateListener, +elasticloadbalancing:DescribeListeners, +cognito-idp:DescribeUserPoolClient +``` + +### List +```json +elasticloadbalancing:DescribeListeners +``` + diff --git a/docs/aws-docs/providers/aws/elasticloadbalancingv2/load_balancer/index.md b/docs/aws-docs/providers/aws/elasticloadbalancingv2/load_balancer/index.md new file mode 100644 index 0000000000..7f6476699e --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticloadbalancingv2/load_balancer/index.md @@ -0,0 +1,123 @@ +--- +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
DescriptionSpecifies an Application Load Balancer, a Network Load Balancer, or a Gateway Load Balancer.
Idaws.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.
dns_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 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 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 addresses for your subnets.
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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +ip_address_type, +security_groups, +load_balancer_attributes, +scheme, +dns_name, +name, +load_balancer_name, +load_balancer_full_name, +subnets, +type, +canonical_hosted_zone_id, +tags, +load_balancer_arn, +subnet_mappings, +enforce_security_group_inbound_rules_on_private_link_traffic +FROM aws.elasticloadbalancingv2.load_balancer +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the load_balancer resource, the following permissions are required: + +### Delete +```json +elasticloadbalancing:DescribeLoadBalancers, +elasticloadbalancing:DeleteLoadBalancer +``` + +### Read +```json +elasticloadbalancing:DescribeLoadBalancers, +elasticloadbalancing:DescribeLoadBalancerAttributes, +elasticloadbalancing:DescribeTags +``` + +### Update +```json +elasticloadbalancing:ModifyLoadBalancerAttributes, +elasticloadbalancing:SetSubnets, +elasticloadbalancing:SetIpAddressType, +elasticloadbalancing:SetSecurityGroups, +elasticloadbalancing:AddTags, +elasticloadbalancing:RemoveTags +``` + diff --git a/docs/aws-docs/providers/aws/elasticloadbalancingv2/load_balancers/index.md b/docs/aws-docs/providers/aws/elasticloadbalancingv2/load_balancers/index.md new file mode 100644 index 0000000000..a08a474a47 --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticloadbalancingv2/load_balancers/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionSpecifies an Application Load Balancer, a Network Load Balancer, or a Gateway Load Balancer.
Idaws.elasticloadbalancingv2.load_balancers
+ +## Fields + + + + + +
NameDatatypeDescription
load_balancer_arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +load_balancer_arn +FROM aws.elasticloadbalancingv2.load_balancers +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the load_balancers resource, the following permissions are required: + +### Create +```json +elasticloadbalancing:CreateLoadBalancer, +elasticloadbalancing:DescribeLoadBalancers, +elasticloadbalancing:ModifyLoadBalancerAttributes, +elasticloadbalancing:AddTags +``` + +### List +```json +elasticloadbalancing:DescribeLoadBalancers +``` + diff --git a/docs/aws-docs/providers/aws/elasticloadbalancingv2/target_group/index.md b/docs/aws-docs/providers/aws/elasticloadbalancingv2/target_group/index.md new file mode 100644 index 0000000000..aa20b51ad0 --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticloadbalancingv2/target_group/index.md @@ -0,0 +1,142 @@ +--- +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
DescriptionResource Type definition for AWS::ElasticLoadBalancingV2::TargetGroup
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.elasticloadbalancingv2.target_group +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the target_group resource, the following permissions are required: + +### Delete +```json +elasticloadbalancing:DeleteTargetGroup, +elasticloadbalancing:DescribeTargetGroups +``` + +### Read +```json +elasticloadbalancing:DescribeTargetGroups, +elasticloadbalancing:DescribeTargetGroupAttributes, +elasticloadbalancing:DescribeTargetHealth, +elasticloadbalancing:DescribeTags +``` + +### Update +```json +elasticloadbalancing:DescribeTargetGroups, +elasticloadbalancing:ModifyTargetGroup, +elasticloadbalancing:ModifyTargetGroupAttributes, +elasticloadbalancing:RegisterTargets, +elasticloadbalancing:DescribeTargetHealth, +elasticloadbalancing:DeregisterTargets, +elasticloadbalancing:AddTags, +elasticloadbalancing:RemoveTags +``` + diff --git a/docs/aws-docs/providers/aws/elasticloadbalancingv2/target_groups/index.md b/docs/aws-docs/providers/aws/elasticloadbalancingv2/target_groups/index.md new file mode 100644 index 0000000000..78f0d72840 --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticloadbalancingv2/target_groups/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionResource Type definition for AWS::ElasticLoadBalancingV2::TargetGroup
Idaws.elasticloadbalancingv2.target_groups
+ +## Fields + + + + + +
NameDatatypeDescription
target_group_arnstringThe ARN of the Target Group
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +target_group_arn +FROM aws.elasticloadbalancingv2.target_groups +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the target_groups resource, the following permissions are required: + +### Create +```json +elasticloadbalancing:CreateTargetGroup, +elasticloadbalancing:DescribeTargetGroups, +elasticloadbalancing:RegisterTargets, +elasticloadbalancing:ModifyTargetGroupAttributes, +elasticloadbalancing:DescribeTargetHealth, +elasticloadbalancing:AddTags +``` + +### List +```json +elasticloadbalancing:DescribeTargetGroups +``` + diff --git a/docs/aws-docs/providers/aws/elasticloadbalancingv2/trust_store/index.md b/docs/aws-docs/providers/aws/elasticloadbalancingv2/trust_store/index.md new file mode 100644 index 0000000000..62761e1e2f --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticloadbalancingv2/trust_store/index.md @@ -0,0 +1,107 @@ +--- +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
DescriptionResource Type definition for AWS::ElasticLoadBalancingV2::TrustStore
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.elasticloadbalancingv2.trust_store +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the trust_store resource, the following permissions are required: + +### Delete +```json +elasticloadbalancing:DescribeTrustStores, +elasticloadbalancing:DeleteTrustStore +``` + +### Read +```json +elasticloadbalancing:DescribeTrustStores, +elasticloadbalancing:DescribeTags +``` + +### Update +```json +elasticloadbalancing:ModifyTrustStore, +elasticloadbalancing:AddTags, +elasticloadbalancing:RemoveTags, +s3:GetObject, +s3:GetObjectVersion +``` + diff --git a/docs/aws-docs/providers/aws/elasticloadbalancingv2/trust_store_revocation/index.md b/docs/aws-docs/providers/aws/elasticloadbalancingv2/trust_store_revocation/index.md new file mode 100644 index 0000000000..95fb983160 --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticloadbalancingv2/trust_store_revocation/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionResource Type definition for AWS::ElasticLoadBalancingV2::TrustStoreRevocation
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +revocation_contents, +trust_store_arn, +revocation_id, +trust_store_revocations +FROM aws.elasticloadbalancingv2.trust_store_revocation +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the trust_store_revocation resource, the following permissions are required: + +### Delete +```json +elasticloadbalancing:DescribeTrustStoreRevocations, +elasticloadbalancing:RemoveTrustStoreRevocations +``` + +### Read +```json +elasticloadbalancing:DescribeTrustStoreRevocations +``` + diff --git a/docs/aws-docs/providers/aws/elasticloadbalancingv2/trust_store_revocations/index.md b/docs/aws-docs/providers/aws/elasticloadbalancingv2/trust_store_revocations/index.md new file mode 100644 index 0000000000..7e25632268 --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticloadbalancingv2/trust_store_revocations/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionResource Type definition for AWS::ElasticLoadBalancingV2::TrustStoreRevocation
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +revocation_id, +trust_store_arn +FROM aws.elasticloadbalancingv2.trust_store_revocations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the trust_store_revocations resource, the following permissions are required: + +### Create +```json +elasticloadbalancing:AddTrustStoreRevocations, +elasticloadbalancing:DescribeTrustStoreRevocations, +s3:GetObject, +s3:GetObjectVersion +``` + +### List +```json +elasticloadbalancing:DescribeTrustStoreRevocations +``` + diff --git a/docs/aws-docs/providers/aws/elasticloadbalancingv2/trust_stores/index.md b/docs/aws-docs/providers/aws/elasticloadbalancingv2/trust_stores/index.md new file mode 100644 index 0000000000..ef990dc46c --- /dev/null +++ b/docs/aws-docs/providers/aws/elasticloadbalancingv2/trust_stores/index.md @@ -0,0 +1,83 @@ +--- +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
DescriptionResource Type definition for AWS::ElasticLoadBalancingV2::TrustStore
Idaws.elasticloadbalancingv2.trust_stores
+ +## Fields + + + + + +
NameDatatypeDescription
trust_store_arnstringThe Amazon Resource Name (ARN) of the trust store.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +trust_store_arn +FROM aws.elasticloadbalancingv2.trust_stores +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the trust_stores resource, the following permissions are required: + +### Create +```json +elasticloadbalancing:CreateTrustStore, +elasticloadbalancing:DescribeTrustStores, +elasticloadbalancing:AddTags, +s3:GetObject, +s3:GetObjectVersion +``` + +### List +```json +elasticloadbalancing:DescribeTrustStores, +s3:GetObject, +s3:GetObjectVersion +``` + diff --git a/docs/aws-docs/providers/aws/emr/index.md b/docs/aws-docs/providers/aws/emr/index.md new file mode 100644 index 0000000000..f7bbc28489 --- /dev/null +++ b/docs/aws-docs/providers/aws/emr/index.md @@ -0,0 +1,45 @@ +--- +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: 8
+total selectable resources: 8
+total methods: 8
+
+
+ +::: + +## Resources +
+
+security_configuration
+security_configurations
+studio
+studio_session_mapping +
+
+studio_session_mappings
+studios
+wal_workspace
+wal_workspaces +
+
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/emr/security_configuration/index.md b/docs/aws-docs/providers/aws/emr/security_configuration/index.md new file mode 100644 index 0000000000..9985e26d56 --- /dev/null +++ b/docs/aws-docs/providers/aws/emr/security_configuration/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionUse a SecurityConfiguration resource to configure data encryption, Kerberos authentication, and Amazon S3 authorization for EMRFS.
Idaws.emr.security_configuration
+ +## Fields + + + + + + +
NameDatatypeDescription
namestringThe name of the security configuration.
security_configurationobjectThe security configuration details in JSON format.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +security_configuration +FROM aws.emr.security_configuration +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the security_configuration resource, the following permissions are required: + +### Read +```json +elasticmapreduce:DescribeSecurityConfiguration +``` + +### Delete +```json +elasticmapreduce:DeleteSecurityConfiguration +``` + diff --git a/docs/aws-docs/providers/aws/emr/security_configurations/index.md b/docs/aws-docs/providers/aws/emr/security_configurations/index.md new file mode 100644 index 0000000000..f8a7450278 --- /dev/null +++ b/docs/aws-docs/providers/aws/emr/security_configurations/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionUse a SecurityConfiguration resource to configure data encryption, Kerberos authentication, and Amazon S3 authorization for EMRFS.
Idaws.emr.security_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
namestringThe name of the security configuration.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.emr.security_configurations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the security_configurations resource, the following permissions are required: + +### Create +```json +elasticmapreduce:CreateSecurityConfiguration, +elasticmapreduce:DescribeSecurityConfiguration +``` + +### List +```json +elasticmapreduce:ListSecurityConfigurations +``` + diff --git a/docs/aws-docs/providers/aws/emr/studio/index.md b/docs/aws-docs/providers/aws/emr/studio/index.md new file mode 100644 index 0000000000..543a2e8813 --- /dev/null +++ b/docs/aws-docs/providers/aws/emr/studio/index.md @@ -0,0 +1,131 @@ +--- +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
DescriptionResource schema for AWS::EMR::Studio
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.emr.studio +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the studio resource, the following permissions are required: + +### Read +```json +elasticmapreduce:DescribeStudio, +sso:GetManagedApplicationInstance +``` + +### Update +```json +elasticmapreduce:UpdateStudio, +elasticmapreduce:DescribeStudio, +elasticmapreduce:AddTags, +elasticmapreduce:RemoveTags +``` + +### Delete +```json +elasticmapreduce:DeleteStudio, +elasticmapreduce:DescribeStudio, +sso:DeleteManagedApplicationInstance +``` + diff --git a/docs/aws-docs/providers/aws/emr/studio_session_mapping/index.md b/docs/aws-docs/providers/aws/emr/studio_session_mapping/index.md new file mode 100644 index 0000000000..4246a30df6 --- /dev/null +++ b/docs/aws-docs/providers/aws/emr/studio_session_mapping/index.md @@ -0,0 +1,117 @@ +--- +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
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +identity_name, +identity_type, +session_policy_arn, +studio_id +FROM aws.emr.studio_session_mapping +WHERE data__Identifier = '||'; +``` + +## Permissions + +To operate on the studio_session_mapping resource, the following permissions are required: + +### Read +```json +elasticmapreduce:GetStudioSessionMapping, +sso-directory:SearchUsers, +sso-directory:SearchGroups, +sso-directory:DescribeUser, +sso-directory:DescribeGroup, +sso:GetManagedApplicationInstance, +sso:DescribeInstance +``` + +### Update +```json +elasticmapreduce:GetStudioSessionMapping, +elasticmapreduce:UpdateStudioSessionMapping, +sso-directory:SearchUsers, +sso-directory:SearchGroups, +sso-directory:DescribeUser, +sso-directory:DescribeGroup, +sso:GetManagedApplicationInstance, +sso:DescribeInstance +``` + +### Delete +```json +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 +``` + diff --git a/docs/aws-docs/providers/aws/emr/studio_session_mappings/index.md b/docs/aws-docs/providers/aws/emr/studio_session_mappings/index.md new file mode 100644 index 0000000000..4d8b7c4557 --- /dev/null +++ b/docs/aws-docs/providers/aws/emr/studio_session_mappings/index.md @@ -0,0 +1,90 @@ +--- +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
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +studio_id, +identity_type, +identity_name +FROM aws.emr.studio_session_mappings +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the studio_session_mappings resource, the following permissions are required: + +### Create +```json +elasticmapreduce:CreateStudioSessionMapping, +sso-directory:SearchUsers, +sso-directory:SearchGroups, +sso-directory:DescribeUser, +sso-directory:DescribeGroup, +sso:GetManagedApplicationInstance, +sso:ListDirectoryAssociations, +sso:GetProfile, +sso:ListProfiles, +sso:AssociateProfile +``` + +### List +```json +elasticmapreduce:ListStudioSessionMappings +``` + diff --git a/docs/aws-docs/providers/aws/emr/studios/index.md b/docs/aws-docs/providers/aws/emr/studios/index.md new file mode 100644 index 0000000000..8c3e5d5f66 --- /dev/null +++ b/docs/aws-docs/providers/aws/emr/studios/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionResource schema for AWS::EMR::Studio
Idaws.emr.studios
+ +## Fields + + + + + +
NameDatatypeDescription
studio_idstringThe ID of the EMR Studio.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +studio_id +FROM aws.emr.studios +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the studios resource, the following permissions are required: + +### Create +```json +elasticmapreduce:CreateStudio, +elasticmapreduce:DescribeStudio, +elasticmapreduce:AddTags, +sso:CreateManagedApplicationInstance, +sso:DeleteManagedApplicationInstance, +iam:PassRole +``` + +### List +```json +elasticmapreduce:ListStudios +``` + diff --git a/docs/aws-docs/providers/aws/emr/wal_workspace/index.md b/docs/aws-docs/providers/aws/emr/wal_workspace/index.md new file mode 100644 index 0000000000..26c45029fd --- /dev/null +++ b/docs/aws-docs/providers/aws/emr/wal_workspace/index.md @@ -0,0 +1,91 @@ +--- +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
DescriptionResource schema for AWS::EMR::WALWorkspace Type
Idaws.emr.wal_workspace
+ +## Fields + + + + + + +
NameDatatypeDescription
wal_workspace_namestringThe name of the emrwal container
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +wal_workspace_name, +tags +FROM aws.emr.wal_workspace +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the wal_workspace resource, the following permissions are required: + +### Read +```json +emrwal:ListTagsForResource +``` + +### Delete +```json +emrwal:DeleteWorkspace +``` + +### Update +```json +emrwal:TagResource, +emrwal:UntagResource, +emrwal:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/emr/wal_workspaces/index.md b/docs/aws-docs/providers/aws/emr/wal_workspaces/index.md new file mode 100644 index 0000000000..eb915a2594 --- /dev/null +++ b/docs/aws-docs/providers/aws/emr/wal_workspaces/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource schema for AWS::EMR::WALWorkspace Type
Idaws.emr.wal_workspaces
+ +## Fields + + + + + +
NameDatatypeDescription
wal_workspace_namestringThe name of the emrwal container
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +wal_workspace_name +FROM aws.emr.wal_workspaces +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the wal_workspaces resource, the following permissions are required: + +### Create +```json +emrwal:CreateWorkspace, +emrwal:TagResource, +iam:CreateServiceLinkedRole +``` + +### List +```json +emrwal:ListWorkspaces +``` + diff --git a/docs/aws-docs/providers/aws/emrcontainers/index.md b/docs/aws-docs/providers/aws/emrcontainers/index.md new file mode 100644 index 0000000000..7bf580ce14 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/emrcontainers/virtual_cluster/index.md b/docs/aws-docs/providers/aws/emrcontainers/virtual_cluster/index.md new file mode 100644 index 0000000000..ef585b917a --- /dev/null +++ b/docs/aws-docs/providers/aws/emrcontainers/virtual_cluster/index.md @@ -0,0 +1,98 @@ +--- +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
DescriptionResource Schema of AWS::EMRContainers::VirtualCluster Type
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +container_provider, +id, +name, +tags +FROM aws.emrcontainers.virtual_cluster +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the virtual_cluster resource, the following permissions are required: + +### Read +```json +emr-containers:DescribeVirtualCluster +``` + +### Delete +```json +emr-containers:DeleteVirtualCluster +``` + +### Update +```json +emr-containers:DescribeVirtualCluster, +emr-containers:ListTagsForResource, +emr-containers:TagResource, +emr-containers:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/emrcontainers/virtual_clusters/index.md b/docs/aws-docs/providers/aws/emrcontainers/virtual_clusters/index.md new file mode 100644 index 0000000000..6b26f089b2 --- /dev/null +++ b/docs/aws-docs/providers/aws/emrcontainers/virtual_clusters/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource Schema of AWS::EMRContainers::VirtualCluster Type
Idaws.emrcontainers.virtual_clusters
+ +## Fields + + + + + +
NameDatatypeDescription
idstringId of the virtual cluster.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.emrcontainers.virtual_clusters +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the virtual_clusters resource, the following permissions are required: + +### Create +```json +emr-containers:CreateVirtualCluster, +emr-containers:TagResource, +iam:CreateServiceLinkedRole +``` + +### List +```json +emr-containers:ListVirtualClusters +``` + diff --git a/docs/aws-docs/providers/aws/emrserverless/application/index.md b/docs/aws-docs/providers/aws/emrserverless/application/index.md new file mode 100644 index 0000000000..44b5663c3d --- /dev/null +++ b/docs/aws-docs/providers/aws/emrserverless/application/index.md @@ -0,0 +1,141 @@ +--- +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
DescriptionResource schema for AWS::EMRServerless::Application Type
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.emrserverless.application +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the application resource, the following permissions are required: + +### Read +```json +emr-serverless:GetApplication +``` + +### Update +```json +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 +```json +emr-serverless:DeleteApplication, +emr-serverless:GetApplication +``` + diff --git a/docs/aws-docs/providers/aws/emrserverless/applications/index.md b/docs/aws-docs/providers/aws/emrserverless/applications/index.md new file mode 100644 index 0000000000..cce81da014 --- /dev/null +++ b/docs/aws-docs/providers/aws/emrserverless/applications/index.md @@ -0,0 +1,100 @@ +--- +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
DescriptionResource schema for AWS::EMRServerless::Application Type
Idaws.emrserverless.applications
+ +## Fields + + + + + +
NameDatatypeDescription
application_idstringThe ID of the EMR Serverless Application.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +application_id +FROM aws.emrserverless.applications +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the applications resource, the following permissions are required: + +### Create +```json +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 +```json +emr-serverless:ListApplications +``` + diff --git a/docs/aws-docs/providers/aws/emrserverless/index.md b/docs/aws-docs/providers/aws/emrserverless/index.md new file mode 100644 index 0000000000..06583d2058 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/entityresolution/id_mapping_workflow/index.md b/docs/aws-docs/providers/aws/entityresolution/id_mapping_workflow/index.md new file mode 100644 index 0000000000..e3f9a1634d --- /dev/null +++ b/docs/aws-docs/providers/aws/entityresolution/id_mapping_workflow/index.md @@ -0,0 +1,115 @@ +--- +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
DescriptionIdMappingWorkflow defined in AWS Entity Resolution service
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.entityresolution.id_mapping_workflow +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the id_mapping_workflow resource, the following permissions are required: + +### Update +```json +entityresolution:GetIdMappingWorkflow, +entityresolution:UpdateIdMappingWorkflow, +entityresolution:ListTagsForResource, +entityresolution:TagResource, +entityresolution:UntagResource, +iam:PassRole, +kms:CreateGrant, +kms:DescribeKey +``` + +### Read +```json +entityresolution:GetIdMappingWorkflow, +entityresolution:ListTagsForResource +``` + +### Delete +```json +entityresolution:DeleteIdMappingWorkflow, +entityresolution:GetIdMappingWorkflow, +entityresolution:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/entityresolution/id_mapping_workflows/index.md b/docs/aws-docs/providers/aws/entityresolution/id_mapping_workflows/index.md new file mode 100644 index 0000000000..5e48ca3d0d --- /dev/null +++ b/docs/aws-docs/providers/aws/entityresolution/id_mapping_workflows/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionIdMappingWorkflow defined in AWS Entity Resolution service
Idaws.entityresolution.id_mapping_workflows
+ +## Fields + + + + + +
NameDatatypeDescription
workflow_nameundefinedThe name of the IdMappingWorkflow
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +workflow_name +FROM aws.entityresolution.id_mapping_workflows +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the id_mapping_workflows resource, the following permissions are required: + +### Create +```json +entityresolution:CreateIdMappingWorkflow, +entityresolution:GetIdMappingWorkflow, +entityresolution:TagResource, +kms:CreateGrant, +kms:DescribeKey, +iam:PassRole +``` + +### List +```json +entityresolution:ListIdMappingWorkflows +``` + diff --git a/docs/aws-docs/providers/aws/entityresolution/id_namespace/index.md b/docs/aws-docs/providers/aws/entityresolution/id_namespace/index.md new file mode 100644 index 0000000000..a792fb64d9 --- /dev/null +++ b/docs/aws-docs/providers/aws/entityresolution/id_namespace/index.md @@ -0,0 +1,112 @@ +--- +title: id_namespace +hide_title: false +hide_table_of_contents: false +keywords: + - id_namespace + - 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_namespace resource + +## Overview + + + + + +
Nameid_namespace
TypeResource
DescriptionIdNamespace defined in AWS Entity Resolution service
Idaws.entityresolution.id_namespace
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
id_namespace_namestring
descriptionstring
input_source_configarray
id_mapping_workflow_propertiesarray
typestring
role_arnstring
id_namespace_arnstringThe arn associated with the IdNamespace
created_atstringThe date and time when the IdNamespace was created
updated_atstringThe date and time when the IdNamespace was updated
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id_namespace_name, +description, +input_source_config, +id_mapping_workflow_properties, +type, +role_arn, +id_namespace_arn, +created_at, +updated_at, +tags +FROM aws.entityresolution.id_namespace +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the id_namespace resource, the following permissions are required: + +### Read +```json +entityresolution:GetIdNamespace, +entityresolution:ListTagsForResource +``` + +### Update +```json +entityresolution:UpdateIdNamespace, +entityresolution:ListTagsForResource, +entityresolution:TagResource, +entityresolution:UntagResource, +iam:PassRole +``` + +### Delete +```json +entityresolution:DeleteIdNamespace, +entityresolution:GetIdNamespace, +entityresolution:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/entityresolution/id_namespaces/index.md b/docs/aws-docs/providers/aws/entityresolution/id_namespaces/index.md new file mode 100644 index 0000000000..67636f7f16 --- /dev/null +++ b/docs/aws-docs/providers/aws/entityresolution/id_namespaces/index.md @@ -0,0 +1,79 @@ +--- +title: id_namespaces +hide_title: false +hide_table_of_contents: false +keywords: + - id_namespaces + - 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_namespaces in a region + +## Overview + + + + + +
Nameid_namespaces
TypeResource
DescriptionIdNamespace defined in AWS Entity Resolution service
Idaws.entityresolution.id_namespaces
+ +## Fields + + + + + +
NameDatatypeDescription
id_namespace_nameundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id_namespace_name +FROM aws.entityresolution.id_namespaces +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the id_namespaces resource, the following permissions are required: + +### Create +```json +entityresolution:CreateIdNamespace, +entityresolution:TagResource, +iam:PassRole +``` + +### List +```json +entityresolution:ListIdNamespaces +``` + diff --git a/docs/aws-docs/providers/aws/entityresolution/index.md b/docs/aws-docs/providers/aws/entityresolution/index.md new file mode 100644 index 0000000000..6db7395151 --- /dev/null +++ b/docs/aws-docs/providers/aws/entityresolution/index.md @@ -0,0 +1,47 @@ +--- +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: 10
+total selectable resources: 10
+total methods: 10
+
+
+ +::: + +## Resources +
+
+id_mapping_workflow
+id_mapping_workflows
+id_namespace
+id_namespaces
+matching_workflow +
+
+matching_workflows
+policy_statement
+policy_statements
+schema_mapping
+schema_mappings +
+
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/entityresolution/matching_workflow/index.md b/docs/aws-docs/providers/aws/entityresolution/matching_workflow/index.md new file mode 100644 index 0000000000..0e7b40d771 --- /dev/null +++ b/docs/aws-docs/providers/aws/entityresolution/matching_workflow/index.md @@ -0,0 +1,115 @@ +--- +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
DescriptionMatchingWorkflow defined in AWS Entity Resolution service
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.entityresolution.matching_workflow +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the matching_workflow resource, the following permissions are required: + +### Read +```json +entityresolution:GetMatchingWorkflow, +entityresolution:ListTagsForResource +``` + +### Delete +```json +entityresolution:DeleteMatchingWorkflow, +entityresolution:GetMatchingWorkflow, +entityresolution:UntagResource +``` + +### Update +```json +entityresolution:GetMatchingWorkflow, +entityresolution:UpdateMatchingWorkflow, +entityresolution:ListTagsForResource, +entityresolution:TagResource, +entityresolution:UntagResource, +iam:PassRole, +kms:CreateGrant, +kms:DescribeKey +``` + diff --git a/docs/aws-docs/providers/aws/entityresolution/matching_workflows/index.md b/docs/aws-docs/providers/aws/entityresolution/matching_workflows/index.md new file mode 100644 index 0000000000..1ec329b5ad --- /dev/null +++ b/docs/aws-docs/providers/aws/entityresolution/matching_workflows/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionMatchingWorkflow defined in AWS Entity Resolution service
Idaws.entityresolution.matching_workflows
+ +## Fields + + + + + +
NameDatatypeDescription
workflow_nameundefinedThe name of the MatchingWorkflow
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +workflow_name +FROM aws.entityresolution.matching_workflows +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the matching_workflows resource, the following permissions are required: + +### Create +```json +entityresolution:CreateMatchingWorkflow, +entityresolution:GetMatchingWorkflow, +entityresolution:TagResource, +kms:CreateGrant, +kms:DescribeKey, +iam:PassRole +``` + +### List +```json +entityresolution:ListMatchingWorkflows +``` + diff --git a/docs/aws-docs/providers/aws/entityresolution/policy_statement/index.md b/docs/aws-docs/providers/aws/entityresolution/policy_statement/index.md new file mode 100644 index 0000000000..179e137dc3 --- /dev/null +++ b/docs/aws-docs/providers/aws/entityresolution/policy_statement/index.md @@ -0,0 +1,99 @@ +--- +title: policy_statement +hide_title: false +hide_table_of_contents: false +keywords: + - policy_statement + - 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 policy_statement resource + +## Overview + + + + + +
Namepolicy_statement
TypeResource
DescriptionPolicy Statement defined in AWS Entity Resolution Service
Idaws.entityresolution.policy_statement
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
arnstring
statement_idstring
effectstring
actionarray
principalarray
conditionstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +statement_id, +effect, +action, +principal, +condition +FROM aws.entityresolution.policy_statement +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the policy_statement resource, the following permissions are required: + +### Read +```json +entityresolution:GetPolicy +``` + +### Update +```json +entityresolution:AddPolicyStatement, +entityresolution:DeletePolicyStatement +``` + +### Delete +```json +entityresolution:DeletePolicyStatement, +entityresolution:GetPolicy +``` + diff --git a/docs/aws-docs/providers/aws/entityresolution/policy_statements/index.md b/docs/aws-docs/providers/aws/entityresolution/policy_statements/index.md new file mode 100644 index 0000000000..dbe4316f00 --- /dev/null +++ b/docs/aws-docs/providers/aws/entityresolution/policy_statements/index.md @@ -0,0 +1,79 @@ +--- +title: policy_statements +hide_title: false +hide_table_of_contents: false +keywords: + - policy_statements + - 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 policy_statements in a region + +## Overview + + + + + +
Namepolicy_statements
TypeResource
DescriptionPolicy Statement defined in AWS Entity Resolution Service
Idaws.entityresolution.policy_statements
+ +## Fields + + + + + + +
NameDatatypeDescription
arnundefined
statement_idundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +statement_id +FROM aws.entityresolution.policy_statements +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the policy_statements resource, the following permissions are required: + +### Create +```json +entityresolution:AddPolicyStatement +``` + +### List +```json +entityresolution:GetPolicy +``` + diff --git a/docs/aws-docs/providers/aws/entityresolution/schema_mapping/index.md b/docs/aws-docs/providers/aws/entityresolution/schema_mapping/index.md new file mode 100644 index 0000000000..4a688454fb --- /dev/null +++ b/docs/aws-docs/providers/aws/entityresolution/schema_mapping/index.md @@ -0,0 +1,107 @@ +--- +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
DescriptionSchemaMapping defined in AWS Entity Resolution service
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +schema_name, +description, +mapped_input_fields, +tags, +schema_arn, +created_at, +updated_at, +has_workflows +FROM aws.entityresolution.schema_mapping +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the schema_mapping resource, the following permissions are required: + +### Read +```json +entityresolution:GetSchemaMapping, +entityresolution:ListTagsForResource +``` + +### Delete +```json +entityresolution:DeleteSchemaMapping, +entityresolution:GetSchemaMapping +``` + +### Update +```json +entityresolution:GetSchemaMapping, +entityresolution:UpdateSchemaMapping, +entityresolution:ListTagsForResource, +entityresolution:TagResource, +entityresolution:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/entityresolution/schema_mappings/index.md b/docs/aws-docs/providers/aws/entityresolution/schema_mappings/index.md new file mode 100644 index 0000000000..5631896ffd --- /dev/null +++ b/docs/aws-docs/providers/aws/entityresolution/schema_mappings/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionSchemaMapping defined in AWS Entity Resolution service
Idaws.entityresolution.schema_mappings
+ +## Fields + + + + + +
NameDatatypeDescription
schema_nameundefinedThe name of the SchemaMapping
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +schema_name +FROM aws.entityresolution.schema_mappings +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the schema_mappings resource, the following permissions are required: + +### Create +```json +entityresolution:CreateSchemaMapping, +entityresolution:GetSchemaMapping, +entityresolution:TagResource +``` + +### List +```json +entityresolution:ListSchemaMappings +``` + diff --git a/docs/aws-docs/providers/aws/events/api_destination/index.md b/docs/aws-docs/providers/aws/events/api_destination/index.md new file mode 100644 index 0000000000..dcad21bbe1 --- /dev/null +++ b/docs/aws-docs/providers/aws/events/api_destination/index.md @@ -0,0 +1,101 @@ +--- +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
DescriptionResource Type definition for AWS::Events::ApiDestination.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +description, +connection_arn, +arn, +invocation_rate_limit_per_second, +invocation_endpoint, +http_method +FROM aws.events.api_destination +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the api_destination resource, the following permissions are required: + +### Read +```json +events:DescribeApiDestination +``` + +### Update +```json +events:UpdateApiDestination, +events:DescribeApiDestination +``` + +### Delete +```json +events:DeleteApiDestination, +events:DescribeApiDestination +``` + diff --git a/docs/aws-docs/providers/aws/events/api_destinations/index.md b/docs/aws-docs/providers/aws/events/api_destinations/index.md new file mode 100644 index 0000000000..950bf3dcaa --- /dev/null +++ b/docs/aws-docs/providers/aws/events/api_destinations/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionResource Type definition for AWS::Events::ApiDestination.
Idaws.events.api_destinations
+ +## Fields + + + + + +
NameDatatypeDescription
namestringName of the apiDestination.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.events.api_destinations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the api_destinations resource, the following permissions are required: + +### Create +```json +events:CreateApiDestination, +events:DescribeApiDestination +``` + +### List +```json +events:ListApiDestinations +``` + diff --git a/docs/aws-docs/providers/aws/events/archive/index.md b/docs/aws-docs/providers/aws/events/archive/index.md new file mode 100644 index 0000000000..78dd4ca0a4 --- /dev/null +++ b/docs/aws-docs/providers/aws/events/archive/index.md @@ -0,0 +1,99 @@ +--- +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
DescriptionResource Type definition for AWS::Events::Archive
Idaws.events.archive
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
archive_namestring
source_arnstring
descriptionstring
event_patternobject
arnstring
retention_daysinteger
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +archive_name, +source_arn, +description, +event_pattern, +arn, +retention_days +FROM aws.events.archive +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the archive resource, the following permissions are required: + +### Delete +```json +events:DescribeArchive, +events:DeleteArchive +``` + +### Update +```json +events:DescribeArchive, +events:UpdateArchive +``` + +### Read +```json +events:DescribeArchive +``` + diff --git a/docs/aws-docs/providers/aws/events/archives/index.md b/docs/aws-docs/providers/aws/events/archives/index.md new file mode 100644 index 0000000000..a61b4d4e5a --- /dev/null +++ b/docs/aws-docs/providers/aws/events/archives/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionResource Type definition for AWS::Events::Archive
Idaws.events.archives
+ +## Fields + + + + + +
NameDatatypeDescription
archive_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +archive_name +FROM aws.events.archives +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the archives resource, the following permissions are required: + +### Create +```json +events:DescribeArchive, +events:CreateArchive +``` + +### List +```json +events:ListArchives +``` + diff --git a/docs/aws-docs/providers/aws/events/connection/index.md b/docs/aws-docs/providers/aws/events/connection/index.md new file mode 100644 index 0000000000..e1e1986a00 --- /dev/null +++ b/docs/aws-docs/providers/aws/events/connection/index.md @@ -0,0 +1,103 @@ +--- +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
DescriptionResource Type definition for AWS::Events::Connection.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +arn, +secret_arn, +description, +authorization_type, +auth_parameters +FROM aws.events.connection +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the connection resource, the following permissions are required: + +### Read +```json +events:DescribeConnection +``` + +### Update +```json +events:UpdateConnection, +events:DescribeConnection, +secretsmanager:CreateSecret, +secretsmanager:UpdateSecret, +secretsmanager:GetSecretValue, +secretsmanager:PutSecretValue +``` + +### Delete +```json +events:DeleteConnection, +events:DescribeConnection +``` + diff --git a/docs/aws-docs/providers/aws/events/connections/index.md b/docs/aws-docs/providers/aws/events/connections/index.md new file mode 100644 index 0000000000..262a3a0620 --- /dev/null +++ b/docs/aws-docs/providers/aws/events/connections/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionResource Type definition for AWS::Events::Connection.
Idaws.events.connections
+ +## Fields + + + + + +
NameDatatypeDescription
namestringName of the connection.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.events.connections +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the connections resource, the following permissions are required: + +### Create +```json +events:CreateConnection, +events:DescribeConnection, +secretsmanager:CreateSecret, +secretsmanager:GetSecretValue, +secretsmanager:PutSecretValue, +iam:CreateServiceLinkedRole +``` + +### List +```json +events:ListConnections +``` + diff --git a/docs/aws-docs/providers/aws/events/endpoint/index.md b/docs/aws-docs/providers/aws/events/endpoint/index.md new file mode 100644 index 0000000000..e1a28715b8 --- /dev/null +++ b/docs/aws-docs/providers/aws/events/endpoint/index.md @@ -0,0 +1,111 @@ +--- +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
DescriptionResource Type definition for AWS::Events::Endpoint.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +arn, +role_arn, +description, +routing_config, +replication_config, +event_buses, +endpoint_id, +endpoint_url, +state, +state_reason +FROM aws.events.endpoint +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the endpoint resource, the following permissions are required: + +### Read +```json +events:DescribeEndpoint +``` + +### Update +```json +events:DescribeEndpoint, +events:UpdateEndpoint, +route53:GetHealthCheck, +iam:PassRole +``` + +### Delete +```json +events:DeleteEndpoint, +events:DescribeEndpoint +``` + diff --git a/docs/aws-docs/providers/aws/events/endpoints/index.md b/docs/aws-docs/providers/aws/events/endpoints/index.md new file mode 100644 index 0000000000..1e6f308c72 --- /dev/null +++ b/docs/aws-docs/providers/aws/events/endpoints/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionResource Type definition for AWS::Events::Endpoint.
Idaws.events.endpoints
+ +## Fields + + + + + +
NameDatatypeDescription
namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.events.endpoints +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the endpoints resource, the following permissions are required: + +### Create +```json +events:CreateEndpoint, +events:DescribeEndpoint, +route53:GetHealthCheck, +iam:PassRole +``` + +### List +```json +events:ListEndpoints +``` + diff --git a/docs/aws-docs/providers/aws/events/event_bus/index.md b/docs/aws-docs/providers/aws/events/event_bus/index.md new file mode 100644 index 0000000000..25aa42a32c --- /dev/null +++ b/docs/aws-docs/providers/aws/events/event_bus/index.md @@ -0,0 +1,100 @@ +--- +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
DescriptionResource type definition for AWS::Events::EventBus
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +event_source_name, +name, +tags, +policy, +arn +FROM aws.events.event_bus +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the event_bus resource, the following permissions are required: + +### Read +```json +events:DescribeEventBus, +events:ListTagsForResource +``` + +### Update +```json +events:TagResource, +events:UntagResource, +events:PutPermission, +events:DescribeEventBus +``` + +### Delete +```json +events:DescribeEventBus, +events:DeleteEventBus +``` + diff --git a/docs/aws-docs/providers/aws/events/event_buses/index.md b/docs/aws-docs/providers/aws/events/event_buses/index.md new file mode 100644 index 0000000000..b3b9835956 --- /dev/null +++ b/docs/aws-docs/providers/aws/events/event_buses/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionResource type definition for AWS::Events::EventBus
Idaws.events.event_buses
+ +## Fields + + + + + +
NameDatatypeDescription
namestringThe name of the event bus.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.events.event_buses +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the event_buses resource, the following permissions are required: + +### Create +```json +events:CreateEventBus, +events:DescribeEventBus, +events:PutPermission, +events:ListTagsForResource, +events:TagResource +``` + +### List +```json +events:ListEventBuses, +events:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/events/index.md b/docs/aws-docs/providers/aws/events/index.md new file mode 100644 index 0000000000..210385c99c --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/events/rule/index.md b/docs/aws-docs/providers/aws/events/rule/index.md new file mode 100644 index 0000000000..bff5c07c63 --- /dev/null +++ b/docs/aws-docs/providers/aws/events/rule/index.md @@ -0,0 +1,113 @@ +--- +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
DescriptionResource Type definition for AWS::Events::Rule
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +event_bus_name, +event_pattern, +schedule_expression, +description, +state, +targets, +arn, +role_arn, +name +FROM aws.events.rule +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the rule resource, the following permissions are required: + +### Read +```json +iam:PassRole, +events:DescribeRule, +events:ListTargetsByRule +``` + +### Update +```json +iam:PassRole, +events:DescribeRule, +events:PutRule, +events:RemoveTargets, +events:PutTargets +``` + +### Delete +```json +iam:PassRole, +events:DescribeRule, +events:DeleteRule, +events:RemoveTargets, +events:ListTargetsByRule +``` + diff --git a/docs/aws-docs/providers/aws/events/rules/index.md b/docs/aws-docs/providers/aws/events/rules/index.md new file mode 100644 index 0000000000..9ffc850fb6 --- /dev/null +++ b/docs/aws-docs/providers/aws/events/rules/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionResource Type definition for AWS::Events::Rule
Idaws.events.rules
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe ARN of the rule, such as arn:aws:events:us-east-2:123456789012:rule/example.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.events.rules +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the rules resource, the following permissions are required: + +### Create +```json +iam:PassRole, +events:DescribeRule, +events:PutRule, +events:PutTargets +``` + +### List +```json +events:ListRules +``` + diff --git a/docs/aws-docs/providers/aws/eventschemas/discoverer/index.md b/docs/aws-docs/providers/aws/eventschemas/discoverer/index.md new file mode 100644 index 0000000000..e1aa9dd1c5 --- /dev/null +++ b/docs/aws-docs/providers/aws/eventschemas/discoverer/index.md @@ -0,0 +1,109 @@ +--- +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
DescriptionResource Type definition for AWS::EventSchemas::Discoverer
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +discoverer_arn, +discoverer_id, +description, +source_arn, +cross_account, +state, +tags +FROM aws.eventschemas.discoverer +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the discoverer resource, the following permissions are required: + +### Read +```json +schemas:DescribeDiscoverer +``` + +### Update +```json +schemas:DescribeDiscoverer, +schemas:UpdateDiscoverer, +schemas:TagResource, +schemas:UntagResource, +schemas:ListTagsForResource, +events:PutTargets, +events:PutRule +``` + +### Delete +```json +schemas:DescribeDiscoverer, +schemas:DeleteDiscoverer, +events:DeleteRule, +events:DisableRule, +events:RemoveTargets +``` + diff --git a/docs/aws-docs/providers/aws/eventschemas/discoverers/index.md b/docs/aws-docs/providers/aws/eventschemas/discoverers/index.md new file mode 100644 index 0000000000..86d276afe4 --- /dev/null +++ b/docs/aws-docs/providers/aws/eventschemas/discoverers/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionResource Type definition for AWS::EventSchemas::Discoverer
Idaws.eventschemas.discoverers
+ +## Fields + + + + + +
NameDatatypeDescription
discoverer_arnstringThe ARN of the discoverer.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +discoverer_arn +FROM aws.eventschemas.discoverers +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the discoverers resource, the following permissions are required: + +### Create +```json +schemas:CreateDiscoverer, +schemas:DescribeDiscoverer, +schemas:TagResource, +events:PutRule, +events:PutTargets, +events:EnableRule, +events:ListTargetsByRule, +iam:CreateServiceLinkedRole +``` + +### List +```json +schemas:ListDiscoverers +``` + diff --git a/docs/aws-docs/providers/aws/eventschemas/eventschemas_registry/index.md b/docs/aws-docs/providers/aws/eventschemas/eventschemas_registry/index.md new file mode 100644 index 0000000000..b90f6fbb82 --- /dev/null +++ b/docs/aws-docs/providers/aws/eventschemas/eventschemas_registry/index.md @@ -0,0 +1,98 @@ +--- +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
DescriptionResource Type definition for AWS::EventSchemas::Registry
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +registry_name, +description, +registry_arn, +tags +FROM aws.eventschemas.eventschemas_registry +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the eventschemas_registry resource, the following permissions are required: + +### Read +```json +schemas:DescribeRegistry +``` + +### Update +```json +schemas:DescribeRegistry, +schemas:UpdateRegistry, +schemas:TagResource, +schemas:UntagResource, +schemas:ListTagsForResource +``` + +### Delete +```json +schemas:DescribeRegistry, +schemas:DeleteRegistry +``` + diff --git a/docs/aws-docs/providers/aws/eventschemas/index.md b/docs/aws-docs/providers/aws/eventschemas/index.md new file mode 100644 index 0000000000..b80ea8b8c9 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/eventschemas/registries/index.md b/docs/aws-docs/providers/aws/eventschemas/registries/index.md new file mode 100644 index 0000000000..4e08e982bf --- /dev/null +++ b/docs/aws-docs/providers/aws/eventschemas/registries/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource Type definition for AWS::EventSchemas::Registry
Idaws.eventschemas.registries
+ +## Fields + + + + + +
NameDatatypeDescription
registry_arnstringThe ARN of the registry.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +registry_arn +FROM aws.eventschemas.registries +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the registries resource, the following permissions are required: + +### Create +```json +schemas:DescribeRegistry, +schemas:CreateRegistry, +schemas:TagResource +``` + +### List +```json +schemas:ListRegistries +``` + diff --git a/docs/aws-docs/providers/aws/eventschemas/registry_policies/index.md b/docs/aws-docs/providers/aws/eventschemas/registry_policies/index.md new file mode 100644 index 0000000000..eaf47e2f33 --- /dev/null +++ b/docs/aws-docs/providers/aws/eventschemas/registry_policies/index.md @@ -0,0 +1,69 @@ +--- +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
DescriptionResource Type definition for AWS::EventSchemas::RegistryPolicy
Idaws.eventschemas.registry_policies
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.eventschemas.registry_policies +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the registry_policies resource, the following permissions are required: + +### Create +```json +schemas:PutResourcePolicy, +schemas:GetResourcePolicy, +schemas:DescribeRegistry +``` + diff --git a/docs/aws-docs/providers/aws/eventschemas/registry_policy/index.md b/docs/aws-docs/providers/aws/eventschemas/registry_policy/index.md new file mode 100644 index 0000000000..8d3a56e920 --- /dev/null +++ b/docs/aws-docs/providers/aws/eventschemas/registry_policy/index.md @@ -0,0 +1,95 @@ +--- +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
DescriptionResource Type definition for AWS::EventSchemas::RegistryPolicy
Idaws.eventschemas.registry_policy
+ +## Fields + + + + + + + + +
NameDatatypeDescription
idstring
policyobject
registry_namestring
revision_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +policy, +registry_name, +revision_id +FROM aws.eventschemas.registry_policy +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the registry_policy resource, the following permissions are required: + +### Delete +```json +schemas:DeleteResourcePolicy, +schemas:GetResourcePolicy +``` + +### Update +```json +schemas:PutResourcePolicy, +schemas:GetResourcePolicy +``` + +### Read +```json +schemas:GetResourcePolicy +``` + diff --git a/docs/aws-docs/providers/aws/eventschemas/schema/index.md b/docs/aws-docs/providers/aws/eventschemas/schema/index.md new file mode 100644 index 0000000000..b44b29e57f --- /dev/null +++ b/docs/aws-docs/providers/aws/eventschemas/schema/index.md @@ -0,0 +1,111 @@ +--- +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
DescriptionResource Type definition for AWS::EventSchemas::Schema
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +type, +description, +schema_version, +content, +registry_name, +schema_arn, +schema_name, +last_modified, +version_created_date, +tags +FROM aws.eventschemas.schema +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the schema resource, the following permissions are required: + +### Read +```json +schemas:DescribeSchema +``` + +### Update +```json +schemas:DescribeSchema, +schemas:UpdateSchema, +schemas:TagResource, +schemas:UntagResource, +schemas:ListTagsForResource +``` + +### Delete +```json +schemas:DescribeSchema, +schemas:DeleteSchema, +schemas:DeleteSchemaVersion +``` + diff --git a/docs/aws-docs/providers/aws/eventschemas/schemata/index.md b/docs/aws-docs/providers/aws/eventschemas/schemata/index.md new file mode 100644 index 0000000000..317c1ad563 --- /dev/null +++ b/docs/aws-docs/providers/aws/eventschemas/schemata/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionResource Type definition for AWS::EventSchemas::Schema
Idaws.eventschemas.schemata
+ +## Fields + + + + + +
NameDatatypeDescription
schema_arnstringThe ARN of the schema.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +schema_arn +FROM aws.eventschemas.schemata +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the schemata resource, the following permissions are required: + +### Create +```json +schemas:DescribeSchema, +schemas:CreateSchema, +schemas:TagResource +``` + +### List +```json +schemas:ListSchemas, +schemas:ListSchemaVersions +``` + diff --git a/docs/aws-docs/providers/aws/evidently/experiment/index.md b/docs/aws-docs/providers/aws/evidently/experiment/index.md new file mode 100644 index 0000000000..4b5fcf1bf0 --- /dev/null +++ b/docs/aws-docs/providers/aws/evidently/experiment/index.md @@ -0,0 +1,119 @@ +--- +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
DescriptionResource Type definition for AWS::Evidently::Experiment.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.evidently.experiment +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the experiment resource, the following permissions are required: + +### Read +```json +evidently:GetExperiment, +evidently:ListTagsForResource +``` + +### Update +```json +evidently:UpdateExperiment, +evidently:TagResource, +evidently:UntagResource, +evidently:GetExperiment, +evidently:StartExperiment, +evidently:StopExperiment +``` + +### Delete +```json +evidently:DeleteExperiment, +evidently:UntagResource, +evidently:GetExperiment +``` + diff --git a/docs/aws-docs/providers/aws/evidently/experiments/index.md b/docs/aws-docs/providers/aws/evidently/experiments/index.md new file mode 100644 index 0000000000..301548259e --- /dev/null +++ b/docs/aws-docs/providers/aws/evidently/experiments/index.md @@ -0,0 +1,70 @@ +--- +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
DescriptionResource Type definition for AWS::Evidently::Experiment.
Idaws.evidently.experiments
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.evidently.experiments +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the experiments resource, the following permissions are required: + +### Create +```json +evidently:CreateExperiment, +evidently:TagResource, +evidently:GetExperiment, +evidently:StartExperiment +``` + diff --git a/docs/aws-docs/providers/aws/evidently/feature/index.md b/docs/aws-docs/providers/aws/evidently/feature/index.md new file mode 100644 index 0000000000..ac60aab692 --- /dev/null +++ b/docs/aws-docs/providers/aws/evidently/feature/index.md @@ -0,0 +1,110 @@ +--- +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
DescriptionResource Type definition for AWS::Evidently::Feature.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +project, +name, +description, +evaluation_strategy, +variations, +default_variation, +entity_overrides, +tags +FROM aws.evidently.feature +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the feature resource, the following permissions are required: + +### Read +```json +evidently:GetFeature, +evidently:ListTagsForResource +``` + +### Update +```json +evidently:UpdateFeature, +evidently:ListTagsForResource, +evidently:TagResource, +evidently:UntagResource, +evidently:GetFeature +``` + +### Delete +```json +evidently:DeleteFeature, +evidently:UntagResource, +evidently:GetFeature +``` + diff --git a/docs/aws-docs/providers/aws/evidently/features/index.md b/docs/aws-docs/providers/aws/evidently/features/index.md new file mode 100644 index 0000000000..3c41bed166 --- /dev/null +++ b/docs/aws-docs/providers/aws/evidently/features/index.md @@ -0,0 +1,69 @@ +--- +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
DescriptionResource Type definition for AWS::Evidently::Feature.
Idaws.evidently.features
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.evidently.features +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the features resource, the following permissions are required: + +### Create +```json +evidently:CreateFeature, +evidently:TagResource, +evidently:GetFeature +``` + diff --git a/docs/aws-docs/providers/aws/evidently/index.md b/docs/aws-docs/providers/aws/evidently/index.md new file mode 100644 index 0000000000..64b7fa8448 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/evidently/launch/index.md b/docs/aws-docs/providers/aws/evidently/launch/index.md new file mode 100644 index 0000000000..2911b21342 --- /dev/null +++ b/docs/aws-docs/providers/aws/evidently/launch/index.md @@ -0,0 +1,114 @@ +--- +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
DescriptionResource Type definition for AWS::Evidently::Launch.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +name, +project, +description, +randomization_salt, +scheduled_splits_config, +groups, +metric_monitors, +tags, +execution_status +FROM aws.evidently.launch +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the launch resource, the following permissions are required: + +### Read +```json +evidently:GetLaunch, +evidently:ListTagsForResource +``` + +### Update +```json +evidently:UpdateLaunch, +evidently:ListTagsForResource, +evidently:TagResource, +evidently:UntagResource, +evidently:GetLaunch, +evidently:StartLaunch, +evidently:StopLaunch +``` + +### Delete +```json +evidently:DeleteLaunch, +evidently:UntagResource, +evidently:GetLaunch +``` + diff --git a/docs/aws-docs/providers/aws/evidently/launches/index.md b/docs/aws-docs/providers/aws/evidently/launches/index.md new file mode 100644 index 0000000000..185321c485 --- /dev/null +++ b/docs/aws-docs/providers/aws/evidently/launches/index.md @@ -0,0 +1,70 @@ +--- +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
DescriptionResource Type definition for AWS::Evidently::Launch.
Idaws.evidently.launches
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.evidently.launches +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the launches resource, the following permissions are required: + +### Create +```json +evidently:CreateLaunch, +evidently:TagResource, +evidently:GetLaunch, +evidently:StartLaunch +``` + diff --git a/docs/aws-docs/providers/aws/evidently/project/index.md b/docs/aws-docs/providers/aws/evidently/project/index.md new file mode 100644 index 0000000000..842ffe9ec5 --- /dev/null +++ b/docs/aws-docs/providers/aws/evidently/project/index.md @@ -0,0 +1,136 @@ +--- +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
DescriptionResource Type definition for AWS::Evidently::Project
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +name, +description, +data_delivery, +app_config_resource, +tags +FROM aws.evidently.project +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the project resource, the following permissions are required: + +### Read +```json +evidently:GetProject, +logs:GetLogDelivery, +logs:ListLogDeliveries, +s3:GetBucketPolicy, +logs:DescribeResourcePolicies, +logs:DescribeLogGroups, +evidently:ListTagsForResource +``` + +### Update +```json +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 +```json +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 +``` + diff --git a/docs/aws-docs/providers/aws/evidently/projects/index.md b/docs/aws-docs/providers/aws/evidently/projects/index.md new file mode 100644 index 0000000000..e0819f4d96 --- /dev/null +++ b/docs/aws-docs/providers/aws/evidently/projects/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionResource Type definition for AWS::Evidently::Project
Idaws.evidently.projects
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.evidently.projects +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the projects resource, the following permissions are required: + +### Create +```json +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 +``` + diff --git a/docs/aws-docs/providers/aws/evidently/segment/index.md b/docs/aws-docs/providers/aws/evidently/segment/index.md new file mode 100644 index 0000000000..3334440610 --- /dev/null +++ b/docs/aws-docs/providers/aws/evidently/segment/index.md @@ -0,0 +1,88 @@ +--- +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
DescriptionResource Type definition for AWS::Evidently::Segment
Idaws.evidently.segment
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
arnstring
namestring
descriptionstring
patternstring
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +name, +description, +pattern, +tags +FROM aws.evidently.segment +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the segment resource, the following permissions are required: + +### Read +```json +evidently:GetSegment, +evidently:ListTagsForResource +``` + +### Delete +```json +evidently:DeleteSegment, +evidently:GetSegment, +evidently:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/evidently/segments/index.md b/docs/aws-docs/providers/aws/evidently/segments/index.md new file mode 100644 index 0000000000..536b90ba70 --- /dev/null +++ b/docs/aws-docs/providers/aws/evidently/segments/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionResource Type definition for AWS::Evidently::Segment
Idaws.evidently.segments
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.evidently.segments +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the segments resource, the following permissions are required: + +### Create +```json +evidently:CreateSegment, +evidently:GetSegment, +evidently:TagResource +``` + +### List +```json +evidently:ListSegment, +evidently:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/finspace/environment/index.md b/docs/aws-docs/providers/aws/finspace/environment/index.md new file mode 100644 index 0000000000..159b860d78 --- /dev/null +++ b/docs/aws-docs/providers/aws/finspace/environment/index.md @@ -0,0 +1,116 @@ +--- +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
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.finspace.environment +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the environment resource, the following permissions are required: + +### Read +```json +finspace:GetEnvironment +``` + +### Update +```json +finspace:UpdateEnvironment +``` + +### Delete +```json +finspace:DeleteEnvironment, +finspace:GetEnvironment +``` + diff --git a/docs/aws-docs/providers/aws/finspace/environments/index.md b/docs/aws-docs/providers/aws/finspace/environments/index.md new file mode 100644 index 0000000000..7665c8d73c --- /dev/null +++ b/docs/aws-docs/providers/aws/finspace/environments/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Idaws.finspace.environments
+ +## Fields + + + + + +
NameDatatypeDescription
environment_idstringUnique identifier for representing FinSpace Environment
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +environment_id +FROM aws.finspace.environments +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the environments resource, the following permissions are required: + +### Create +```json +finspace:CreateEnvironment, +finspace:GetEnvironment, +finspace:ListEnvironments, +sts:AssumeRole +``` + +### List +```json +finspace:ListEnvironments +``` + diff --git a/docs/aws-docs/providers/aws/finspace/index.md b/docs/aws-docs/providers/aws/finspace/index.md new file mode 100644 index 0000000000..5c900702e4 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/fis/experiment_template/index.md b/docs/aws-docs/providers/aws/fis/experiment_template/index.md new file mode 100644 index 0000000000..91b5a40b43 --- /dev/null +++ b/docs/aws-docs/providers/aws/fis/experiment_template/index.md @@ -0,0 +1,107 @@ +--- +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
DescriptionResource schema for AWS::FIS::ExperimentTemplate
Idaws.fis.experiment_template
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
idstring
descriptionstring
targetsobject
actionsobject
stop_conditionsarray
log_configurationobject
role_arnstring
tagsobject
experiment_optionsobject
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +description, +targets, +actions, +stop_conditions, +log_configuration, +role_arn, +tags, +experiment_options +FROM aws.fis.experiment_template +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the experiment_template resource, the following permissions are required: + +### Read +```json +fis:GetExperimentTemplate, +fis:ListTagsForResource +``` + +### Update +```json +fis:UpdateExperimentTemplate, +fis:TagResource, +fis:UntagResource, +iam:PassRole +``` + +### Delete +```json +fis:DeleteExperimentTemplate +``` + diff --git a/docs/aws-docs/providers/aws/fis/experiment_templates/index.md b/docs/aws-docs/providers/aws/fis/experiment_templates/index.md new file mode 100644 index 0000000000..3ae22d9a15 --- /dev/null +++ b/docs/aws-docs/providers/aws/fis/experiment_templates/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionResource schema for AWS::FIS::ExperimentTemplate
Idaws.fis.experiment_templates
+ +## Fields + + + + + +
NameDatatypeDescription
idundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.fis.experiment_templates +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the experiment_templates resource, the following permissions are required: + +### Create +```json +fis:CreateExperimentTemplate, +fis:TagResource, +iam:PassRole +``` + +### List +```json +fis:ListExperimentTemplates, +fis:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/fis/index.md b/docs/aws-docs/providers/aws/fis/index.md new file mode 100644 index 0000000000..30d00193a4 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/fis/target_account_configuration/index.md b/docs/aws-docs/providers/aws/fis/target_account_configuration/index.md new file mode 100644 index 0000000000..8755193e67 --- /dev/null +++ b/docs/aws-docs/providers/aws/fis/target_account_configuration/index.md @@ -0,0 +1,93 @@ +--- +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
DescriptionResource schema for AWS::FIS::TargetAccountConfiguration
Idaws.fis.target_account_configuration
+ +## Fields + + + + + + + + +
NameDatatypeDescription
experiment_template_idstring
account_idstring
role_arnstring
descriptionstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +experiment_template_id, +account_id, +role_arn, +description +FROM aws.fis.target_account_configuration +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the target_account_configuration resource, the following permissions are required: + +### Read +```json +fis:GetTargetAccountConfiguration +``` + +### Update +```json +fis:UpdateTargetAccountConfiguration +``` + +### Delete +```json +fis:DeleteTargetAccountConfiguration +``` + diff --git a/docs/aws-docs/providers/aws/fis/target_account_configurations/index.md b/docs/aws-docs/providers/aws/fis/target_account_configurations/index.md new file mode 100644 index 0000000000..597bf1ae0c --- /dev/null +++ b/docs/aws-docs/providers/aws/fis/target_account_configurations/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource schema for AWS::FIS::TargetAccountConfiguration
Idaws.fis.target_account_configurations
+ +## Fields + + + + + + +
NameDatatypeDescription
experiment_template_idundefined
account_idundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +experiment_template_id, +account_id +FROM aws.fis.target_account_configurations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the target_account_configurations resource, the following permissions are required: + +### Create +```json +fis:CreateTargetAccountConfiguration +``` + +### List +```json +fis:ListTargetAccountConfigurations +``` + diff --git a/docs/aws-docs/providers/aws/fms/index.md b/docs/aws-docs/providers/aws/fms/index.md new file mode 100644 index 0000000000..a196af9059 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/fms/notification_channel/index.md b/docs/aws-docs/providers/aws/fms/notification_channel/index.md new file mode 100644 index 0000000000..4dc8a29919 --- /dev/null +++ b/docs/aws-docs/providers/aws/fms/notification_channel/index.md @@ -0,0 +1,90 @@ +--- +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
DescriptionDesignates the IAM role and Amazon Simple Notification Service (SNS) topic that AWS Firewall Manager uses to record SNS logs.
Idaws.fms.notification_channel
+ +## Fields + + + + + + +
NameDatatypeDescription
sns_role_namestring
sns_topic_arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +sns_role_name, +sns_topic_arn +FROM aws.fms.notification_channel +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the notification_channel resource, the following permissions are required: + +### Update +```json +fms:PutNotificationChannel, +iam:PassRole +``` + +### Read +```json +fms:GetNotificationChannel +``` + +### Delete +```json +fms:DeleteNotificationChannel +``` + diff --git a/docs/aws-docs/providers/aws/fms/notification_channels/index.md b/docs/aws-docs/providers/aws/fms/notification_channels/index.md new file mode 100644 index 0000000000..a14162deae --- /dev/null +++ b/docs/aws-docs/providers/aws/fms/notification_channels/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionDesignates the IAM role and Amazon Simple Notification Service (SNS) topic that AWS Firewall Manager uses to record SNS logs.
Idaws.fms.notification_channels
+ +## Fields + + + + + +
NameDatatypeDescription
sns_topic_arnundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +sns_topic_arn +FROM aws.fms.notification_channels +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the notification_channels resource, the following permissions are required: + +### Create +```json +fms:PutNotificationChannel, +iam:PassRole +``` + +### List +```json +fms:GetNotificationChannel +``` + diff --git a/docs/aws-docs/providers/aws/fms/policies/index.md b/docs/aws-docs/providers/aws/fms/policies/index.md new file mode 100644 index 0000000000..df312083be --- /dev/null +++ b/docs/aws-docs/providers/aws/fms/policies/index.md @@ -0,0 +1,90 @@ +--- +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
DescriptionCreates an AWS Firewall Manager policy.
Idaws.fms.policies
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.fms.policies +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the policies resource, the following permissions are required: + +### Create +```json +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 +```json +fms:ListPolicies, +fms:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/fms/policy/index.md b/docs/aws-docs/providers/aws/fms/policy/index.md new file mode 100644 index 0000000000..a299b68ab3 --- /dev/null +++ b/docs/aws-docs/providers/aws/fms/policy/index.md @@ -0,0 +1,133 @@ +--- +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
DescriptionCreates an AWS Firewall Manager policy.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.fms.policy +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the policy resource, the following permissions are required: + +### Update +```json +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 +```json +fms:GetPolicy, +fms:ListTagsForResource +``` + +### Delete +```json +fms:DeletePolicy +``` + diff --git a/docs/aws-docs/providers/aws/fms/resource_set/index.md b/docs/aws-docs/providers/aws/fms/resource_set/index.md new file mode 100644 index 0000000000..0e30c74ca2 --- /dev/null +++ b/docs/aws-docs/providers/aws/fms/resource_set/index.md @@ -0,0 +1,106 @@ +--- +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
DescriptionCreates an AWS Firewall Manager resource set.
Idaws.fms.resource_set
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
idstring
namestring
descriptionstring
resource_type_listarray
resourcesarray
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +name, +description, +resource_type_list, +resources, +tags +FROM aws.fms.resource_set +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the resource_set resource, the following permissions are required: + +### Update +```json +fms:PutResourceSet, +fms:BatchAssociateResource, +fms:BatchDisassociateResource, +fms:GetResourceSet, +fms:ListResourceSetResources, +fms:TagResource, +fms:UntagResource, +fms:ListTagsForResource +``` + +### Read +```json +fms:GetResourceSet, +fms:ListResourceSetResources, +fms:ListTagsForResource +``` + +### Delete +```json +fms:DeleteResourceSet +``` + diff --git a/docs/aws-docs/providers/aws/fms/resource_sets/index.md b/docs/aws-docs/providers/aws/fms/resource_sets/index.md new file mode 100644 index 0000000000..6237fdf0cc --- /dev/null +++ b/docs/aws-docs/providers/aws/fms/resource_sets/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionCreates an AWS Firewall Manager resource set.
Idaws.fms.resource_sets
+ +## Fields + + + + + +
NameDatatypeDescription
idundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.fms.resource_sets +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the resource_sets resource, the following permissions are required: + +### Create +```json +fms:PutResourceSet, +fms:BatchAssociateResource, +fms:ListResourceSetResources, +fms:TagResource +``` + +### List +```json +fms:ListResourceSets +``` + diff --git a/docs/aws-docs/providers/aws/forecast/dataset/index.md b/docs/aws-docs/providers/aws/forecast/dataset/index.md new file mode 100644 index 0000000000..e3f1e7f4c7 --- /dev/null +++ b/docs/aws-docs/providers/aws/forecast/dataset/index.md @@ -0,0 +1,91 @@ +--- +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
DescriptionResource Type Definition for AWS::Forecast::Dataset
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +dataset_name, +dataset_type, +data_frequency, +domain, +encryption_config, +schema, +tags +FROM aws.forecast.dataset +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the dataset resource, the following permissions are required: + +### Read +```json +forecast:DescribeDataset +``` + +### Delete +```json +forecast:DeleteDataset +``` + diff --git a/docs/aws-docs/providers/aws/forecast/dataset_group/index.md b/docs/aws-docs/providers/aws/forecast/dataset_group/index.md new file mode 100644 index 0000000000..f1308b9c77 --- /dev/null +++ b/docs/aws-docs/providers/aws/forecast/dataset_group/index.md @@ -0,0 +1,95 @@ +--- +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
DescriptionRepresents a dataset group that holds a collection of related datasets
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +dataset_arns, +dataset_group_name, +domain, +tags, +dataset_group_arn +FROM aws.forecast.dataset_group +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the dataset_group resource, the following permissions are required: + +### Read +```json +forecast:DescribeDatasetGroup +``` + +### Update +```json +forecast:UpdateDatasetGroup +``` + +### Delete +```json +forecast:DeleteDatasetGroup +``` + diff --git a/docs/aws-docs/providers/aws/forecast/dataset_groups/index.md b/docs/aws-docs/providers/aws/forecast/dataset_groups/index.md new file mode 100644 index 0000000000..c8e8d4e73b --- /dev/null +++ b/docs/aws-docs/providers/aws/forecast/dataset_groups/index.md @@ -0,0 +1,77 @@ +--- +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
DescriptionRepresents a dataset group that holds a collection of related datasets
Idaws.forecast.dataset_groups
+ +## Fields + + + + + +
NameDatatypeDescription
dataset_group_arnstringThe Amazon Resource Name (ARN) of the dataset group to delete.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +dataset_group_arn +FROM aws.forecast.dataset_groups +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the dataset_groups resource, the following permissions are required: + +### Create +```json +forecast:CreateDatasetGroup +``` + +### List +```json +forecast:ListDatasetGroups +``` + diff --git a/docs/aws-docs/providers/aws/forecast/datasets/index.md b/docs/aws-docs/providers/aws/forecast/datasets/index.md new file mode 100644 index 0000000000..d3db779107 --- /dev/null +++ b/docs/aws-docs/providers/aws/forecast/datasets/index.md @@ -0,0 +1,77 @@ +--- +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
DescriptionResource Type Definition for AWS::Forecast::Dataset
Idaws.forecast.datasets
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.forecast.datasets +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the datasets resource, the following permissions are required: + +### Create +```json +forecast:CreateDataset +``` + +### List +```json +forecast:ListDatasets +``` + diff --git a/docs/aws-docs/providers/aws/forecast/index.md b/docs/aws-docs/providers/aws/forecast/index.md new file mode 100644 index 0000000000..8a8b4ee5c3 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/frauddetector/detector/index.md b/docs/aws-docs/providers/aws/frauddetector/detector/index.md new file mode 100644 index 0000000000..33d8e31e03 --- /dev/null +++ b/docs/aws-docs/providers/aws/frauddetector/detector/index.md @@ -0,0 +1,166 @@ +--- +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
DescriptionA resource schema for a Detector in Amazon Fraud Detector.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.frauddetector.detector +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the detector resource, the following permissions are required: + +### Update +```json +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 +```json +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 +```json +frauddetector:GetDetectors, +frauddetector:GetDetectorVersion, +frauddetector:DescribeDetector, +frauddetector:GetRules, +frauddetector:GetVariables, +frauddetector:GetEventTypes, +frauddetector:GetExternalModels, +frauddetector:GetModelVersion, +frauddetector:GetLabels, +frauddetector:GetOutcomes, +frauddetector:GetEntityTypes, +frauddetector:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/frauddetector/detectors/index.md b/docs/aws-docs/providers/aws/frauddetector/detectors/index.md new file mode 100644 index 0000000000..5606810b86 --- /dev/null +++ b/docs/aws-docs/providers/aws/frauddetector/detectors/index.md @@ -0,0 +1,108 @@ +--- +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
DescriptionA resource schema for a Detector in Amazon Fraud Detector.
Idaws.frauddetector.detectors
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe ARN of the detector.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.frauddetector.detectors +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the detectors resource, the following permissions are required: + +### Create +```json +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 +```json +frauddetector:GetDetectors, +frauddetector:GetDetectorVersion, +frauddetector:DescribeDetector, +frauddetector:GetRules, +frauddetector:GetVariables, +frauddetector:GetEventTypes, +frauddetector:GetExternalModels, +frauddetector:GetModelVersion, +frauddetector:GetLabels, +frauddetector:GetOutcomes, +frauddetector:GetEntityTypes, +frauddetector:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/frauddetector/event_type/index.md b/docs/aws-docs/providers/aws/frauddetector/event_type/index.md new file mode 100644 index 0000000000..b31823f025 --- /dev/null +++ b/docs/aws-docs/providers/aws/frauddetector/event_type/index.md @@ -0,0 +1,134 @@ +--- +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
DescriptionA resource schema for an EventType in Amazon Fraud Detector.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +tags, +description, +event_variables, +labels, +entity_types, +arn, +created_time, +last_updated_time +FROM aws.frauddetector.event_type +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the event_type resource, the following permissions are required: + +### Update +```json +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 +```json +frauddetector:BatchGetVariable, +frauddetector:GetVariables, +frauddetector:GetEventTypes, +frauddetector:GetLabels, +frauddetector:GetEntityTypes, +frauddetector:DeleteEventType, +frauddetector:DeleteVariable, +frauddetector:DeleteLabel, +frauddetector:DeleteEntityType, +frauddetector:ListTagsForResource +``` + +### Read +```json +frauddetector:BatchGetVariable, +frauddetector:GetVariables, +frauddetector:GetEventTypes, +frauddetector:GetLabels, +frauddetector:GetEntityTypes, +frauddetector:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/frauddetector/event_types/index.md b/docs/aws-docs/providers/aws/frauddetector/event_types/index.md new file mode 100644 index 0000000000..314a7f4c3e --- /dev/null +++ b/docs/aws-docs/providers/aws/frauddetector/event_types/index.md @@ -0,0 +1,93 @@ +--- +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
DescriptionA resource schema for an EventType in Amazon Fraud Detector.
Idaws.frauddetector.event_types
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe ARN of the event type.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.frauddetector.event_types +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the event_types resource, the following permissions are required: + +### Create +```json +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 +```json +frauddetector:BatchGetVariable, +frauddetector:GetVariables, +frauddetector:GetEventTypes, +frauddetector:GetLabels, +frauddetector:GetEntityTypes, +frauddetector:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/frauddetector/frauddetector_list/index.md b/docs/aws-docs/providers/aws/frauddetector/frauddetector_list/index.md new file mode 100644 index 0000000000..f668aa89fb --- /dev/null +++ b/docs/aws-docs/providers/aws/frauddetector/frauddetector_list/index.md @@ -0,0 +1,109 @@ +--- +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
DescriptionA resource schema for a List in Amazon Fraud Detector.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +name, +description, +variable_type, +created_time, +last_updated_time, +tags, +elements +FROM aws.frauddetector.frauddetector_list +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the frauddetector_list resource, the following permissions are required: + +### Read +```json +frauddetector:GetListElements, +frauddetector:GetListsMetadata, +frauddetector:ListTagsForResource +``` + +### Update +```json +frauddetector:GetListElements, +frauddetector:GetListsMetadata, +frauddetector:ListTagsForResource, +frauddetector:UntagResource, +frauddetector:UpdateList, +frauddetector:TagResource +``` + +### Delete +```json +frauddetector:DeleteList, +frauddetector:GetListsMetadata +``` + diff --git a/docs/aws-docs/providers/aws/frauddetector/index.md b/docs/aws-docs/providers/aws/frauddetector/index.md new file mode 100644 index 0000000000..d8412752c2 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/frauddetector/label/index.md b/docs/aws-docs/providers/aws/frauddetector/label/index.md new file mode 100644 index 0000000000..15ae9b4e3f --- /dev/null +++ b/docs/aws-docs/providers/aws/frauddetector/label/index.md @@ -0,0 +1,103 @@ +--- +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
DescriptionAn label for fraud detector.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +tags, +description, +arn, +created_time, +last_updated_time +FROM aws.frauddetector.label +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the label resource, the following permissions are required: + +### Read +```json +frauddetector:GetLabels, +frauddetector:ListTagsForResource +``` + +### Update +```json +frauddetector:GetLabels, +frauddetector:PutLabel, +frauddetector:ListTagsForResource, +frauddetector:TagResource, +frauddetector:UntagResource +``` + +### Delete +```json +frauddetector:GetLabels, +frauddetector:DeleteLabel +``` + diff --git a/docs/aws-docs/providers/aws/frauddetector/labels/index.md b/docs/aws-docs/providers/aws/frauddetector/labels/index.md new file mode 100644 index 0000000000..06cd449d81 --- /dev/null +++ b/docs/aws-docs/providers/aws/frauddetector/labels/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionAn label for fraud detector.
Idaws.frauddetector.labels
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe label ARN.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.frauddetector.labels +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the labels resource, the following permissions are required: + +### Create +```json +frauddetector:GetLabels, +frauddetector:PutLabel, +frauddetector:ListTagsForResource, +frauddetector:TagResource +``` + +### List +```json +frauddetector:GetLabels, +frauddetector:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/frauddetector/lists/index.md b/docs/aws-docs/providers/aws/frauddetector/lists/index.md new file mode 100644 index 0000000000..ea3043915e --- /dev/null +++ b/docs/aws-docs/providers/aws/frauddetector/lists/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionA resource schema for a List in Amazon Fraud Detector.
Idaws.frauddetector.lists
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe list ARN.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.frauddetector.lists +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the lists resource, the following permissions are required: + +### Create +```json +frauddetector:CreateList, +frauddetector:GetListElements, +frauddetector:GetListsMetadata, +frauddetector:ListTagsForResource, +frauddetector:TagResource, +frauddetector:UpdateList +``` + +### List +```json +frauddetector:GetListElements, +frauddetector:GetListsMetadata, +frauddetector:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/frauddetector/outcome/index.md b/docs/aws-docs/providers/aws/frauddetector/outcome/index.md new file mode 100644 index 0000000000..ef6feed488 --- /dev/null +++ b/docs/aws-docs/providers/aws/frauddetector/outcome/index.md @@ -0,0 +1,103 @@ +--- +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
DescriptionAn outcome for rule evaluation.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +tags, +description, +arn, +created_time, +last_updated_time +FROM aws.frauddetector.outcome +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the outcome resource, the following permissions are required: + +### Read +```json +frauddetector:GetOutcomes, +frauddetector:ListTagsForResource +``` + +### Update +```json +frauddetector:GetOutcomes, +frauddetector:PutOutcome, +frauddetector:ListTagsForResource, +frauddetector:TagResource, +frauddetector:UntagResource +``` + +### Delete +```json +frauddetector:GetOutcomes, +frauddetector:DeleteOutcome +``` + diff --git a/docs/aws-docs/providers/aws/frauddetector/outcomes/index.md b/docs/aws-docs/providers/aws/frauddetector/outcomes/index.md new file mode 100644 index 0000000000..c107e67441 --- /dev/null +++ b/docs/aws-docs/providers/aws/frauddetector/outcomes/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionAn outcome for rule evaluation.
Idaws.frauddetector.outcomes
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe outcome ARN.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.frauddetector.outcomes +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the outcomes resource, the following permissions are required: + +### Create +```json +frauddetector:GetOutcomes, +frauddetector:PutOutcome, +frauddetector:ListTagsForResource, +frauddetector:TagResource +``` + +### List +```json +frauddetector:GetOutcomes, +frauddetector:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/frauddetector/variable/index.md b/docs/aws-docs/providers/aws/frauddetector/variable/index.md new file mode 100644 index 0000000000..9f54e14722 --- /dev/null +++ b/docs/aws-docs/providers/aws/frauddetector/variable/index.md @@ -0,0 +1,111 @@ +--- +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
DescriptionA resource schema for a Variable in Amazon Fraud Detector.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +data_source, +data_type, +default_value, +description, +tags, +variable_type, +arn, +created_time, +last_updated_time +FROM aws.frauddetector.variable +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the variable resource, the following permissions are required: + +### Read +```json +frauddetector:GetVariables, +frauddetector:ListTagsForResource +``` + +### Update +```json +frauddetector:GetVariables, +frauddetector:UpdateVariable, +frauddetector:ListTagsForResource, +frauddetector:TagResource, +frauddetector:UntagResource +``` + +### Delete +```json +frauddetector:GetVariables, +frauddetector:DeleteVariable +``` + diff --git a/docs/aws-docs/providers/aws/frauddetector/variables/index.md b/docs/aws-docs/providers/aws/frauddetector/variables/index.md new file mode 100644 index 0000000000..6c3e0f279b --- /dev/null +++ b/docs/aws-docs/providers/aws/frauddetector/variables/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionA resource schema for a Variable in Amazon Fraud Detector.
Idaws.frauddetector.variables
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe ARN of the variable.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.frauddetector.variables +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the variables resource, the following permissions are required: + +### Create +```json +frauddetector:GetVariables, +frauddetector:CreateVariable, +frauddetector:ListTagsForResource, +frauddetector:TagResource +``` + +### List +```json +frauddetector:GetVariables, +frauddetector:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/fsx/data_repository_association/index.md b/docs/aws-docs/providers/aws/fsx/data_repository_association/index.md new file mode 100644 index 0000000000..d1d87d8658 --- /dev/null +++ b/docs/aws-docs/providers/aws/fsx/data_repository_association/index.md @@ -0,0 +1,112 @@ +--- +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
DescriptionCreates an Amazon FSx for Lustre data repository association (DRA). A data repository association is a link between a directory on the file system and an Amazon S3 bucket or prefix. You can have a maximum of 8 data repository associations on a file system. Data repository associations are supported on all FSx for Lustre 2.12 and newer file systems, excluding ``scratch_1`` deployment type. <br/> Each data repository association must have a unique Amazon FSx file system directory and a unique S3 bucket or prefix associated with it. You can configure a data repository association for automatic import only, for automatic export only, or for both. To learn more about linking a data repository to your file system, see [Linking your file system to an S3 bucket](https://docs.aws.amazon.com/fsx/latest/LustreGuide/create-dra-linked-data-repo.html).
Idaws.fsx.data_repository_association
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
association_idstring
resource_arnstring
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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +association_id, +resource_arn, +file_system_id, +file_system_path, +data_repository_path, +batch_import_meta_data_on_create, +imported_file_chunk_size, +s3, +tags +FROM aws.fsx.data_repository_association +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the data_repository_association resource, the following permissions are required: + +### Read +```json +fsx:DescribeDataRepositoryAssociations +``` + +### Update +```json +fsx:DescribeDataRepositoryAssociations, +fsx:UpdateDataRepositoryAssociation, +fsx:TagResource, +fsx:UntagResource, +s3:ListBucket, +s3:GetBucketPolicy, +s3:PutBucketPolicy, +iam:CreateServiceLinkedRole, +iam:PutRolePolicy +``` + +### Delete +```json +fsx:DescribeDataRepositoryAssociations, +fsx:DeleteDataRepositoryAssociation +``` + diff --git a/docs/aws-docs/providers/aws/fsx/data_repository_associations/index.md b/docs/aws-docs/providers/aws/fsx/data_repository_associations/index.md new file mode 100644 index 0000000000..da30f8c664 --- /dev/null +++ b/docs/aws-docs/providers/aws/fsx/data_repository_associations/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionCreates an Amazon FSx for Lustre data repository association (DRA). A data repository association is a link between a directory on the file system and an Amazon S3 bucket or prefix. You can have a maximum of 8 data repository associations on a file system. Data repository associations are supported on all FSx for Lustre 2.12 and newer file systems, excluding ``scratch_1`` deployment type. <br/> Each data repository association must have a unique Amazon FSx file system directory and a unique S3 bucket or prefix associated with it. You can configure a data repository association for automatic import only, for automatic export only, or for both. To learn more about linking a data repository to your file system, see [Linking your file system to an S3 bucket](https://docs.aws.amazon.com/fsx/latest/LustreGuide/create-dra-linked-data-repo.html).
Idaws.fsx.data_repository_associations
+ +## Fields + + + + + +
NameDatatypeDescription
association_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +association_id +FROM aws.fsx.data_repository_associations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the data_repository_associations resource, the following permissions are required: + +### Create +```json +fsx:CreateDataRepositoryAssociation, +fsx:DescribeDataRepositoryAssociations, +fsx:TagResource, +s3:ListBucket, +s3:GetBucketPolicy, +s3:PutBucketPolicy, +iam:CreateServiceLinkedRole, +iam:PutRolePolicy +``` + +### List +```json +fsx:DescribeDataRepositoryAssociations +``` + diff --git a/docs/aws-docs/providers/aws/fsx/index.md b/docs/aws-docs/providers/aws/fsx/index.md new file mode 100644 index 0000000000..466fedecd8 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/gamelift/alias/index.md b/docs/aws-docs/providers/aws/gamelift/alias/index.md new file mode 100644 index 0000000000..b2b1da276f --- /dev/null +++ b/docs/aws-docs/providers/aws/gamelift/alias/index.md @@ -0,0 +1,93 @@ +--- +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
DescriptionThe AWS::GameLift::Alias resource creates an alias for an Amazon GameLift (GameLift) fleet destination.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +description, +name, +routing_strategy, +alias_id +FROM aws.gamelift.alias +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the alias resource, the following permissions are required: + +### Read +```json +gamelift:DescribeAlias +``` + +### Update +```json +gamelift:UpdateAlias +``` + +### Delete +```json +gamelift:DeleteAlias +``` + diff --git a/docs/aws-docs/providers/aws/gamelift/aliases/index.md b/docs/aws-docs/providers/aws/gamelift/aliases/index.md new file mode 100644 index 0000000000..987d0b4f61 --- /dev/null +++ b/docs/aws-docs/providers/aws/gamelift/aliases/index.md @@ -0,0 +1,77 @@ +--- +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
DescriptionThe AWS::GameLift::Alias resource creates an alias for an Amazon GameLift (GameLift) fleet destination.
Idaws.gamelift.aliases
+ +## Fields + + + + + +
NameDatatypeDescription
alias_idstringUnique alias ID
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +alias_id +FROM aws.gamelift.aliases +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the aliases resource, the following permissions are required: + +### Create +```json +gamelift:CreateAlias +``` + +### List +```json +gamelift:ListAliases +``` + diff --git a/docs/aws-docs/providers/aws/gamelift/build/index.md b/docs/aws-docs/providers/aws/gamelift/build/index.md new file mode 100644 index 0000000000..7e5966a244 --- /dev/null +++ b/docs/aws-docs/providers/aws/gamelift/build/index.md @@ -0,0 +1,98 @@ +--- +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
DescriptionResource Type definition for AWS::GameLift::Build
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +build_id, +name, +operating_system, +storage_location, +version, +server_sdk_version +FROM aws.gamelift.build +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the build resource, the following permissions are required: + +### Read +```json +gamelift:DescribeBuild +``` + +### Update +```json +gamelift:UpdateBuild +``` + +### Delete +```json +gamelift:DescribeBuild, +gamelift:DeleteBuild +``` + diff --git a/docs/aws-docs/providers/aws/gamelift/builds/index.md b/docs/aws-docs/providers/aws/gamelift/builds/index.md new file mode 100644 index 0000000000..bc7050a806 --- /dev/null +++ b/docs/aws-docs/providers/aws/gamelift/builds/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionResource Type definition for AWS::GameLift::Build
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +build_id +FROM aws.gamelift.builds +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the builds resource, the following permissions are required: + +### Create +```json +gamelift:DescribeBuild, +gamelift:CreateBuild +``` + +### List +```json +gamelift:ListBuilds +``` + diff --git a/docs/aws-docs/providers/aws/gamelift/fleet/index.md b/docs/aws-docs/providers/aws/gamelift/fleet/index.md new file mode 100644 index 0000000000..43c9d70d6c --- /dev/null +++ b/docs/aws-docs/providers/aws/gamelift/fleet/index.md @@ -0,0 +1,163 @@ +--- +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
DescriptionThe AWS::GameLift::Fleet resource creates an Amazon GameLift (GameLift) fleet to host game servers. A fleet is a set of EC2 or Anywhere instances, each of which can host multiple game sessions.
Idaws.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_arnstringA 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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +scaling_policies, +description, +peer_vpc_id, +apply_capacity, +e_c2_inbound_permissions, +compute_type, +name, +anywhere_configuration, +instance_role_arn, +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 aws.gamelift.fleet +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the fleet resource, the following permissions are required: + +### Read +```json +gamelift:DescribeFleetAttributes, +gamelift:DescribeFleetLocationAttributes, +gamelift:DescribeFleetCapacity, +gamelift:DescribeFleetPortSettings, +gamelift:DescribeFleetUtilization, +gamelift:DescribeRuntimeConfiguration, +gamelift:DescribeEC2InstanceLimits, +gamelift:DescribeFleetEvents, +gamelift:DescribeScalingPolicies +``` + +### Update +```json +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 +```json +gamelift:DeleteFleet, +gamelift:DescribeFleetLocationCapacity, +gamelift:DescribeScalingPolicies, +gamelift:DeleteScalingPolicy +``` + diff --git a/docs/aws-docs/providers/aws/gamelift/fleets/index.md b/docs/aws-docs/providers/aws/gamelift/fleets/index.md new file mode 100644 index 0000000000..2ad3fabaa3 --- /dev/null +++ b/docs/aws-docs/providers/aws/gamelift/fleets/index.md @@ -0,0 +1,83 @@ +--- +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
DescriptionThe AWS::GameLift::Fleet resource creates an Amazon GameLift (GameLift) fleet to host game servers. A fleet is a set of EC2 or Anywhere instances, each of which can host multiple game sessions.
Idaws.gamelift.fleets
+ +## Fields + + + + + +
NameDatatypeDescription
fleet_idstringUnique fleet ID
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +fleet_id +FROM aws.gamelift.fleets +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the fleets resource, the following permissions are required: + +### Create +```json +gamelift:CreateFleet, +gamelift:DescribeFleetAttributes, +gamelift:DescribeFleetLocationAttributes, +gamelift:UpdateFleetCapacity, +gamelift:DescribeFleetLocationCapacity, +gamelift:PutScalingPolicy, +gamelift:DescribeScalingPolicies +``` + +### List +```json +gamelift:ListFleets +``` + diff --git a/docs/aws-docs/providers/aws/gamelift/game_server_group/index.md b/docs/aws-docs/providers/aws/gamelift/game_server_group/index.md new file mode 100644 index 0000000000..5eb01155b4 --- /dev/null +++ b/docs/aws-docs/providers/aws/gamelift/game_server_group/index.md @@ -0,0 +1,138 @@ +--- +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
DescriptionThe AWS::GameLift::GameServerGroup resource creates an Amazon GameLift (GameLift) GameServerGroup.
Idaws.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. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource.
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. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource.
max_sizenumberThe maximum number of instances allowed in the EC2 Auto Scaling group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource.
min_sizenumberThe minimum number of instances allowed in the EC2 Auto Scaling group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource.
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. Updating game server group tags with CloudFormation will not take effect. Please update this property using AWS GameLift APIs instead.
vpc_subnetsarrayA list of virtual private cloud (VPC) subnets to use with instances in the game server group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.gamelift.game_server_group +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the game_server_group resource, the following permissions are required: + +### Read +```json +gamelift:DescribeGameServerGroup +``` + +### Update +```json +gamelift:UpdateGameServerGroup, +iam:assumeRole, +iam:PassRole, +autoscaling:DescribeAutoScalingGroups, +autoscaling:UpdateAutoScalingGroup, +autoscaling:SetInstanceProtection +``` + +### Delete +```json +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 +``` + diff --git a/docs/aws-docs/providers/aws/gamelift/game_server_groups/index.md b/docs/aws-docs/providers/aws/gamelift/game_server_groups/index.md new file mode 100644 index 0000000000..2dfc8c71b7 --- /dev/null +++ b/docs/aws-docs/providers/aws/gamelift/game_server_groups/index.md @@ -0,0 +1,101 @@ +--- +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
DescriptionThe AWS::GameLift::GameServerGroup resource creates an Amazon GameLift (GameLift) GameServerGroup.
Idaws.gamelift.game_server_groups
+ +## Fields + + + + + +
NameDatatypeDescription
game_server_group_arnundefinedA generated unique ID for the game server group.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +game_server_group_arn +FROM aws.gamelift.game_server_groups +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the game_server_groups resource, the following permissions are required: + +### Create +```json +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 +```json +gamelift:ListGameServerGroups +``` + diff --git a/docs/aws-docs/providers/aws/gamelift/game_session_queue/index.md b/docs/aws-docs/providers/aws/gamelift/game_session_queue/index.md new file mode 100644 index 0000000000..954f4e7bdd --- /dev/null +++ b/docs/aws-docs/providers/aws/gamelift/game_session_queue/index.md @@ -0,0 +1,110 @@ +--- +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
DescriptionThe AWS::GameLift::GameSessionQueue resource creates an Amazon GameLift (GameLift) game session queue.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +timeout_in_seconds, +destinations, +player_latency_policies, +custom_event_data, +notification_target, +filter_configuration, +priority_configuration, +arn, +tags +FROM aws.gamelift.game_session_queue +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the game_session_queue resource, the following permissions are required: + +### Read +```json +gamelift:DescribeGameSessionQueues, +gamelift:ListTagsForResource +``` + +### Delete +```json +gamelift:DescribeGameSessionQueues, +gamelift:DeleteGameSessionQueue +``` + +### Update +```json +gamelift:UpdateGameSessionQueue, +gamelift:ListTagsForResource, +gamelift:TagResource, +gamelift:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/gamelift/game_session_queues/index.md b/docs/aws-docs/providers/aws/gamelift/game_session_queues/index.md new file mode 100644 index 0000000000..a3ade3bd27 --- /dev/null +++ b/docs/aws-docs/providers/aws/gamelift/game_session_queues/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionThe AWS::GameLift::GameSessionQueue resource creates an Amazon GameLift (GameLift) game session queue.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.gamelift.game_session_queues +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the game_session_queues resource, the following permissions are required: + +### Create +```json +gamelift:CreateGameSessionQueue, +gamelift:ListTagsForResource, +gamelift:TagResource +``` + +### List +```json +gamelift:DescribeGameSessionQueues +``` + diff --git a/docs/aws-docs/providers/aws/gamelift/index.md b/docs/aws-docs/providers/aws/gamelift/index.md new file mode 100644 index 0000000000..a0fd50a5f3 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/gamelift/location/index.md b/docs/aws-docs/providers/aws/gamelift/location/index.md new file mode 100644 index 0000000000..7b4cc55ed5 --- /dev/null +++ b/docs/aws-docs/providers/aws/gamelift/location/index.md @@ -0,0 +1,95 @@ +--- +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
DescriptionThe AWS::GameLift::Location resource creates an Amazon GameLift (GameLift) custom location.
Idaws.gamelift.location
+ +## Fields + + + + + + + +
NameDatatypeDescription
location_namestring
location_arnstring
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +location_name, +location_arn, +tags +FROM aws.gamelift.location +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the location resource, the following permissions are required: + +### Read +```json +gamelift:ListLocations, +gamelift:ListTagsForResource +``` + +### Delete +```json +gamelift:DeleteLocation +``` + +### Update +```json +gamelift:ListLocations, +gamelift:ListTagsForResource, +gamelift:TagResource, +gamelift:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/gamelift/locations/index.md b/docs/aws-docs/providers/aws/gamelift/locations/index.md new file mode 100644 index 0000000000..0c1661a698 --- /dev/null +++ b/docs/aws-docs/providers/aws/gamelift/locations/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionThe AWS::GameLift::Location resource creates an Amazon GameLift (GameLift) custom location.
Idaws.gamelift.locations
+ +## Fields + + + + + +
NameDatatypeDescription
location_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +location_name +FROM aws.gamelift.locations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the locations resource, the following permissions are required: + +### Create +```json +gamelift:CreateLocation, +gamelift:ListLocations, +gamelift:ListTagsForResource, +gamelift:TagResource +``` + +### List +```json +gamelift:ListLocations +``` + diff --git a/docs/aws-docs/providers/aws/gamelift/matchmaking_configuration/index.md b/docs/aws-docs/providers/aws/gamelift/matchmaking_configuration/index.md new file mode 100644 index 0000000000..83bbe99982 --- /dev/null +++ b/docs/aws-docs/providers/aws/gamelift/matchmaking_configuration/index.md @@ -0,0 +1,127 @@ +--- +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
DescriptionThe AWS::GameLift::MatchmakingConfiguration resource creates an Amazon GameLift (GameLift) matchmaking configuration.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.gamelift.matchmaking_configuration +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the matchmaking_configuration resource, the following permissions are required: + +### Read +```json +gamelift:DescribeMatchmakingConfigurations, +gamelift:ListTagsForResource +``` + +### Delete +```json +gamelift:DescribeMatchmakingConfigurations, +gamelift:DeleteMatchmakingConfiguration +``` + +### Update +```json +gamelift:DescribeMatchmakingConfigurations, +gamelift:UpdateMatchmakingConfiguration, +gamelift:ListTagsForResource, +gamelift:TagResource, +gamelift:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/gamelift/matchmaking_configurations/index.md b/docs/aws-docs/providers/aws/gamelift/matchmaking_configurations/index.md new file mode 100644 index 0000000000..378aa8ec54 --- /dev/null +++ b/docs/aws-docs/providers/aws/gamelift/matchmaking_configurations/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionThe AWS::GameLift::MatchmakingConfiguration resource creates an Amazon GameLift (GameLift) matchmaking configuration.
Idaws.gamelift.matchmaking_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
namestringA unique identifier for the matchmaking configuration.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.gamelift.matchmaking_configurations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the matchmaking_configurations resource, the following permissions are required: + +### Create +```json +gamelift:CreateMatchmakingConfiguration, +gamelift:ListTagsForResource, +gamelift:TagResource, +gamelift:DescribeMatchmakingConfigurations +``` + +### List +```json +gamelift:DescribeMatchmakingConfigurations +``` + diff --git a/docs/aws-docs/providers/aws/gamelift/matchmaking_rule_set/index.md b/docs/aws-docs/providers/aws/gamelift/matchmaking_rule_set/index.md new file mode 100644 index 0000000000..d72039f402 --- /dev/null +++ b/docs/aws-docs/providers/aws/gamelift/matchmaking_rule_set/index.md @@ -0,0 +1,100 @@ +--- +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
DescriptionThe AWS::GameLift::MatchmakingRuleSet resource creates an Amazon GameLift (GameLift) matchmaking rule set.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +rule_set_body, +creation_time, +arn, +tags +FROM aws.gamelift.matchmaking_rule_set +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the matchmaking_rule_set resource, the following permissions are required: + +### Read +```json +gamelift:DescribeMatchmakingRuleSets, +gamelift:ValidateMatchmakingRuleSet, +gamelift:ListTagsForResource +``` + +### Delete +```json +gamelift:DeleteMatchmakingRuleSet +``` + +### Update +```json +gamelift:DescribeMatchmakingRuleSets, +gamelift:ListTagsForResource, +gamelift:TagResource, +gamelift:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/gamelift/matchmaking_rule_sets/index.md b/docs/aws-docs/providers/aws/gamelift/matchmaking_rule_sets/index.md new file mode 100644 index 0000000000..f180cc4627 --- /dev/null +++ b/docs/aws-docs/providers/aws/gamelift/matchmaking_rule_sets/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionThe AWS::GameLift::MatchmakingRuleSet resource creates an Amazon GameLift (GameLift) matchmaking rule set.
Idaws.gamelift.matchmaking_rule_sets
+ +## Fields + + + + + +
NameDatatypeDescription
namestringA unique identifier for the matchmaking rule set.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.gamelift.matchmaking_rule_sets +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the matchmaking_rule_sets resource, the following permissions are required: + +### Create +```json +gamelift:CreateMatchmakingRuleSet, +gamelift:DescribeMatchmakingRuleSets, +gamelift:ValidateMatchmakingRuleSet, +gamelift:ListTagsForResource, +gamelift:TagResource +``` + +### List +```json +gamelift:DescribeMatchmakingRuleSets +``` + diff --git a/docs/aws-docs/providers/aws/gamelift/script/index.md b/docs/aws-docs/providers/aws/gamelift/script/index.md new file mode 100644 index 0000000000..cb0f26c9f5 --- /dev/null +++ b/docs/aws-docs/providers/aws/gamelift/script/index.md @@ -0,0 +1,108 @@ +--- +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
DescriptionThe AWS::GameLift::Script resource creates a new script record for your Realtime Servers script. Realtime scripts are JavaScript that provide configuration settings and optional custom game logic for your game. The script is deployed when you create a Realtime Servers fleet to host your game sessions. Script logic is executed during an active game session.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +storage_location, +version, +tags, +creation_time, +arn, +id, +size_on_disk +FROM aws.gamelift.script +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the script resource, the following permissions are required: + +### Read +```json +gamelift:DescribeScript, +gamelift:ListScripts, +gamelift:ListTagsForResource +``` + +### Delete +```json +gamelift:DeleteScript +``` + +### Update +```json +gamelift:DescribeScript, +gamelift:UpdateScript, +gamelift:ListTagsForResource, +gamelift:TagResource, +gamelift:UntagResource, +iam:PassRole +``` + diff --git a/docs/aws-docs/providers/aws/gamelift/scripts/index.md b/docs/aws-docs/providers/aws/gamelift/scripts/index.md new file mode 100644 index 0000000000..74966122fe --- /dev/null +++ b/docs/aws-docs/providers/aws/gamelift/scripts/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionThe AWS::GameLift::Script resource creates a new script record for your Realtime Servers script. Realtime scripts are JavaScript that provide configuration settings and optional custom game logic for your game. The script is deployed when you create a Realtime Servers fleet to host your game sessions. Script logic is executed during an active game session.
Idaws.gamelift.scripts
+ +## Fields + + + + + +
NameDatatypeDescription
idstringA unique identifier for the Realtime script
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.gamelift.scripts +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the scripts resource, the following permissions are required: + +### Create +```json +gamelift:CreateScript, +gamelift:ListTagsForResource, +gamelift:TagResource, +gamelift:DescribeScript, +iam:PassRole +``` + +### List +```json +gamelift:ListScripts, +gamelift:DescribeScript +``` + diff --git a/docs/aws-docs/providers/aws/globalaccelerator/accelerator/index.md b/docs/aws-docs/providers/aws/globalaccelerator/accelerator/index.md new file mode 100644 index 0000000000..ad98dcfd5f --- /dev/null +++ b/docs/aws-docs/providers/aws/globalaccelerator/accelerator/index.md @@ -0,0 +1,110 @@ +--- +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
DescriptionResource Type definition for AWS::GlobalAccelerator::Accelerator
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.globalaccelerator.accelerator +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the accelerator resource, the following permissions are required: + +### Read +```json +globalaccelerator:DescribeAccelerator +``` + +### Update +```json +globalaccelerator:UpdateAccelerator, +globalaccelerator:TagResource, +globalaccelerator:UntagResource, +globalaccelerator:DescribeAccelerator +``` + +### Delete +```json +globalaccelerator:UpdateAccelerator, +globalaccelerator:DeleteAccelerator, +globalaccelerator:DescribeAccelerator +``` + diff --git a/docs/aws-docs/providers/aws/globalaccelerator/accelerators/index.md b/docs/aws-docs/providers/aws/globalaccelerator/accelerators/index.md new file mode 100644 index 0000000000..820d5a0e43 --- /dev/null +++ b/docs/aws-docs/providers/aws/globalaccelerator/accelerators/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource Type definition for AWS::GlobalAccelerator::Accelerator
Idaws.globalaccelerator.accelerators
+ +## Fields + + + + + +
NameDatatypeDescription
accelerator_arnstringThe Amazon Resource Name (ARN) of the accelerator.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +accelerator_arn +FROM aws.globalaccelerator.accelerators + +``` + +## Permissions + +To operate on the accelerators resource, the following permissions are required: + +### Create +```json +globalaccelerator:CreateAccelerator, +globalaccelerator:DescribeAccelerator, +globalaccelerator:TagResource +``` + +### List +```json +globalaccelerator:ListAccelerators +``` + diff --git a/docs/aws-docs/providers/aws/globalaccelerator/cross_account_attachment/index.md b/docs/aws-docs/providers/aws/globalaccelerator/cross_account_attachment/index.md new file mode 100644 index 0000000000..f3b3481d09 --- /dev/null +++ b/docs/aws-docs/providers/aws/globalaccelerator/cross_account_attachment/index.md @@ -0,0 +1,99 @@ +--- +title: cross_account_attachment +hide_title: false +hide_table_of_contents: false +keywords: + - cross_account_attachment + - 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 cross_account_attachment resource + +## Overview + + + + + +
Namecross_account_attachment
TypeResource
DescriptionResource Type definition for AWS::GlobalAccelerator::CrossAccountAttachment
Idaws.globalaccelerator.cross_account_attachment
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
namestringThe Friendly identifier of the attachment.
attachment_arnstringThe Amazon Resource Name (ARN) of the attachment.
principalsarrayPrincipals to share the resources with.
resourcesarrayResources shared using the attachment.
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +attachment_arn, +principals, +resources, +tags +FROM aws.globalaccelerator.cross_account_attachment +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the cross_account_attachment resource, the following permissions are required: + +### Read +```json +globalaccelerator:DescribeCrossAccountAttachment +``` + +### Update +```json +globalaccelerator:UpdateCrossAccountAttachment, +globalaccelerator:DescribeCrossAccountAttachment, +globalaccelerator:TagResource, +globalaccelerator:UntagResource +``` + +### Delete +```json +globalaccelerator:DescribeCrossAccountAttachment, +globalaccelerator:DeleteCrossAccountAttachment +``` + diff --git a/docs/aws-docs/providers/aws/globalaccelerator/cross_account_attachments/index.md b/docs/aws-docs/providers/aws/globalaccelerator/cross_account_attachments/index.md new file mode 100644 index 0000000000..15163e70a7 --- /dev/null +++ b/docs/aws-docs/providers/aws/globalaccelerator/cross_account_attachments/index.md @@ -0,0 +1,79 @@ +--- +title: cross_account_attachments +hide_title: false +hide_table_of_contents: false +keywords: + - cross_account_attachments + - 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 cross_account_attachments in a region + +## Overview + + + + + +
Namecross_account_attachments
TypeResource
DescriptionResource Type definition for AWS::GlobalAccelerator::CrossAccountAttachment
Idaws.globalaccelerator.cross_account_attachments
+ +## Fields + + + + + +
NameDatatypeDescription
attachment_arnstringThe Amazon Resource Name (ARN) of the attachment.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +attachment_arn +FROM aws.globalaccelerator.cross_account_attachments + +``` + +## Permissions + +To operate on the cross_account_attachments resource, the following permissions are required: + +### Create +```json +globalaccelerator:DescribeCrossAccountAttachment, +globalaccelerator:CreateCrossAccountAttachment, +globalaccelerator:TagResource +``` + +### List +```json +globalaccelerator:ListCrossAccountAttachments +``` + diff --git a/docs/aws-docs/providers/aws/globalaccelerator/endpoint_group/index.md b/docs/aws-docs/providers/aws/globalaccelerator/endpoint_group/index.md new file mode 100644 index 0000000000..807125eff6 --- /dev/null +++ b/docs/aws-docs/providers/aws/globalaccelerator/endpoint_group/index.md @@ -0,0 +1,112 @@ +--- +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
DescriptionResource Type definition for AWS::GlobalAccelerator::EndpointGroup
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.globalaccelerator.endpoint_group +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the endpoint_group resource, the following permissions are required: + +### Read +```json +globalaccelerator:DescribeEndpointGroup +``` + +### Update +```json +globalaccelerator:UpdateEndpointGroup, +globalaccelerator:DescribeEndpointGroup, +globalaccelerator:DescribeListener, +globalaccelerator:DescribeAccelerator +``` + +### Delete +```json +globalaccelerator:DeleteEndpointGroup, +globalaccelerator:DescribeEndpointGroup, +globalaccelerator:DescribeAccelerator +``` + diff --git a/docs/aws-docs/providers/aws/globalaccelerator/endpoint_groups/index.md b/docs/aws-docs/providers/aws/globalaccelerator/endpoint_groups/index.md new file mode 100644 index 0000000000..82254d63fd --- /dev/null +++ b/docs/aws-docs/providers/aws/globalaccelerator/endpoint_groups/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionResource Type definition for AWS::GlobalAccelerator::EndpointGroup
Idaws.globalaccelerator.endpoint_groups
+ +## Fields + + + + + +
NameDatatypeDescription
endpoint_group_arnstringThe Amazon Resource Name (ARN) of the endpoint group
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +endpoint_group_arn +FROM aws.globalaccelerator.endpoint_groups + +``` + +## Permissions + +To operate on the endpoint_groups resource, the following permissions are required: + +### Create +```json +globalaccelerator:CreateEndpointGroup, +globalaccelerator:DescribeEndpointGroup, +globalaccelerator:DescribeAccelerator, +globalaccelerator:DescribeListener, +globalaccelerator:ListAccelerators, +globalaccelerator:ListListeners +``` + +### List +```json +globalaccelerator:ListEndpointGroups +``` + diff --git a/docs/aws-docs/providers/aws/globalaccelerator/index.md b/docs/aws-docs/providers/aws/globalaccelerator/index.md new file mode 100644 index 0000000000..7bc720b1f8 --- /dev/null +++ b/docs/aws-docs/providers/aws/globalaccelerator/index.md @@ -0,0 +1,45 @@ +--- +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: 8
+total selectable resources: 8
+total methods: 8
+
+
+ +::: + +## Resources +
+
+accelerator
+accelerators
+cross_account_attachment
+cross_account_attachments +
+
+endpoint_group
+endpoint_groups
+listener
+listeners +
+
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/globalaccelerator/listener/index.md b/docs/aws-docs/providers/aws/globalaccelerator/listener/index.md new file mode 100644 index 0000000000..bf51f57c0d --- /dev/null +++ b/docs/aws-docs/providers/aws/globalaccelerator/listener/index.md @@ -0,0 +1,99 @@ +--- +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
DescriptionResource Type definition for AWS::GlobalAccelerator::Listener
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +listener_arn, +accelerator_arn, +port_ranges, +protocol, +client_affinity +FROM aws.globalaccelerator.listener +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the listener resource, the following permissions are required: + +### Read +```json +globalaccelerator:DescribeListener +``` + +### Update +```json +globalaccelerator:UpdateListener, +globalaccelerator:DescribeListener, +globalaccelerator:DescribeAccelerator +``` + +### Delete +```json +globalaccelerator:DescribeListener, +globalaccelerator:DeleteListener, +globalaccelerator:DescribeAccelerator +``` + diff --git a/docs/aws-docs/providers/aws/globalaccelerator/listeners/index.md b/docs/aws-docs/providers/aws/globalaccelerator/listeners/index.md new file mode 100644 index 0000000000..4276bc9ed9 --- /dev/null +++ b/docs/aws-docs/providers/aws/globalaccelerator/listeners/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource Type definition for AWS::GlobalAccelerator::Listener
Idaws.globalaccelerator.listeners
+ +## Fields + + + + + +
NameDatatypeDescription
listener_arnstringThe Amazon Resource Name (ARN) of the listener.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +listener_arn +FROM aws.globalaccelerator.listeners + +``` + +## Permissions + +To operate on the listeners resource, the following permissions are required: + +### Create +```json +globalaccelerator:CreateListener, +globalaccelerator:DescribeListener, +globalaccelerator:DescribeAccelerator +``` + +### List +```json +globalaccelerator:ListListeners +``` + diff --git a/docs/aws-docs/providers/aws/glue/index.md b/docs/aws-docs/providers/aws/glue/index.md new file mode 100644 index 0000000000..ee70705fcc --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/glue/schema_version/index.md b/docs/aws-docs/providers/aws/glue/schema_version/index.md new file mode 100644 index 0000000000..1228df311e --- /dev/null +++ b/docs/aws-docs/providers/aws/glue/schema_version/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionThis resource represents an individual schema version of a schema defined in Glue Schema Registry.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +schema, +schema_definition, +version_id +FROM aws.glue.schema_version +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the schema_version resource, the following permissions are required: + +### Read +```json +glue:GetSchemaVersion +``` + +### Delete +```json +glue:DeleteSchemaVersions, +glue:GetSchemaVersion +``` + diff --git a/docs/aws-docs/providers/aws/glue/schema_version_metadata/index.md b/docs/aws-docs/providers/aws/glue/schema_version_metadata/index.md new file mode 100644 index 0000000000..dcaecda53d --- /dev/null +++ b/docs/aws-docs/providers/aws/glue/schema_version_metadata/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionThis resource adds Key-Value metadata to a Schema version of Glue Schema Registry.
Idaws.glue.schema_version_metadata
+ +## Fields + + + + + + + +
NameDatatypeDescription
schema_version_idstringRepresents the version ID associated with the schema version.
keystringMetadata key
valuestringMetadata value
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +schema_version_id, +key, +value +FROM aws.glue.schema_version_metadata +WHERE data__Identifier = '||'; +``` + +## Permissions + +To operate on the schema_version_metadata resource, the following permissions are required: + +### Read +```json +glue:querySchemaVersionMetadata +``` + +### Delete +```json +glue:removeSchemaVersionMetadata +``` + diff --git a/docs/aws-docs/providers/aws/glue/schema_versions/index.md b/docs/aws-docs/providers/aws/glue/schema_versions/index.md new file mode 100644 index 0000000000..d4476d627d --- /dev/null +++ b/docs/aws-docs/providers/aws/glue/schema_versions/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionThis resource represents an individual schema version of a schema defined in Glue Schema Registry.
Idaws.glue.schema_versions
+ +## Fields + + + + + +
NameDatatypeDescription
version_idstringRepresents the version ID associated with the schema version.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +version_id +FROM aws.glue.schema_versions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the schema_versions resource, the following permissions are required: + +### Create +```json +glue:RegisterSchemaVersion, +glue:GetSchemaVersion, +glue:GetSchemaByDefinition +``` + +### List +```json +glue:ListSchemaVersions +``` + diff --git a/docs/aws-docs/providers/aws/grafana/index.md b/docs/aws-docs/providers/aws/grafana/index.md new file mode 100644 index 0000000000..1879b4dcef --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/grafana/workspace/index.md b/docs/aws-docs/providers/aws/grafana/workspace/index.md new file mode 100644 index 0000000000..5b221dc845 --- /dev/null +++ b/docs/aws-docs/providers/aws/grafana/workspace/index.md @@ -0,0 +1,155 @@ +--- +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
DescriptionDefinition of AWS::Grafana::Workspace Resource Type
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.grafana.workspace +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the workspace resource, the following permissions are required: + +### Read +```json +grafana:DescribeWorkspace, +grafana:DescribeWorkspaceAuthentication, +grafana:DescribeWorkspaceConfiguration +``` + +### Update +```json +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 +```json +grafana:DeleteWorkspace, +grafana:DescribeWorkspace, +grafana:DescribeWorkspaceAuthentication, +grafana:DescribeWorkspaceConfiguration, +sso:DeleteManagedApplicationInstance, +sso:DescribeRegisteredRegions +``` + diff --git a/docs/aws-docs/providers/aws/grafana/workspaces/index.md b/docs/aws-docs/providers/aws/grafana/workspaces/index.md new file mode 100644 index 0000000000..777c9f4613 --- /dev/null +++ b/docs/aws-docs/providers/aws/grafana/workspaces/index.md @@ -0,0 +1,95 @@ +--- +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
DescriptionDefinition of AWS::Grafana::Workspace Resource Type
Idaws.grafana.workspaces
+ +## Fields + + + + + +
NameDatatypeDescription
idstringThe id that uniquely identifies a Grafana workspace.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.grafana.workspaces +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the workspaces resource, the following permissions are required: + +### Create +```json +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 +```json +grafana:ListWorkspaces, +grafana:DescribeWorkspaceAuthentication, +grafana:DescribeWorkspaceConfiguration +``` + diff --git a/docs/aws-docs/providers/aws/greengrassv2/component_version/index.md b/docs/aws-docs/providers/aws/greengrassv2/component_version/index.md new file mode 100644 index 0000000000..ea94d68dc9 --- /dev/null +++ b/docs/aws-docs/providers/aws/greengrassv2/component_version/index.md @@ -0,0 +1,101 @@ +--- +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
DescriptionResource for Greengrass component version.
Idaws.greengrassv2.component_version
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
arnstring
component_namestring
component_versionstring
inline_recipestring
lambda_functionobject
tagsobject
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +component_name, +component_version, +inline_recipe, +lambda_function, +tags +FROM aws.greengrassv2.component_version +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the component_version resource, the following permissions are required: + +### Read +```json +greengrass:DescribeComponent, +greengrass:ListTagsForResource +``` + +### Update +```json +greengrass:DescribeComponent, +greengrass:ListTagsForResource, +greengrass:TagResource, +greengrass:UntagResource +``` + +### Delete +```json +greengrass:DeleteComponent +``` + diff --git a/docs/aws-docs/providers/aws/greengrassv2/component_versions/index.md b/docs/aws-docs/providers/aws/greengrassv2/component_versions/index.md new file mode 100644 index 0000000000..6dff451419 --- /dev/null +++ b/docs/aws-docs/providers/aws/greengrassv2/component_versions/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionResource for Greengrass component version.
Idaws.greengrassv2.component_versions
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.greengrassv2.component_versions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the component_versions resource, the following permissions are required: + +### Create +```json +greengrass:CreateComponentVersion, +greengrass:DescribeComponent, +greengrass:ListTagsForResource, +greengrass:TagResource, +lambda:GetFunction, +s3:GetObject +``` + +### List +```json +greengrass:ListComponentVersions +``` + diff --git a/docs/aws-docs/providers/aws/greengrassv2/deployment/index.md b/docs/aws-docs/providers/aws/greengrassv2/deployment/index.md new file mode 100644 index 0000000000..d8ab44d34f --- /dev/null +++ b/docs/aws-docs/providers/aws/greengrassv2/deployment/index.md @@ -0,0 +1,112 @@ +--- +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
DescriptionResource for Greengrass V2 deployment.
Idaws.greengrassv2.deployment
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
target_arnstring
parent_target_arnstring
deployment_idstring
deployment_namestring
componentsobject
iot_job_configurationobject
deployment_policiesobject
tagsobject
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +target_arn, +parent_target_arn, +deployment_id, +deployment_name, +components, +iot_job_configuration, +deployment_policies, +tags +FROM aws.greengrassv2.deployment +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the deployment resource, the following permissions are required: + +### Read +```json +greengrass:GetDeployment, +iot:DescribeJob, +iot:DescribeThing, +iot:DescribeThingGroup, +iot:GetThingShadow +``` + +### Update +```json +greengrass:GetDeployment, +greengrass:TagResource, +greengrass:UntagResource, +iot:DescribeJob +``` + +### Delete +```json +greengrass:DeleteDeployment, +greengrass:CancelDeployment, +iot:CancelJob, +iot:DeleteJob, +iot:DescribeJob +``` + diff --git a/docs/aws-docs/providers/aws/greengrassv2/deployments/index.md b/docs/aws-docs/providers/aws/greengrassv2/deployments/index.md new file mode 100644 index 0000000000..8a964187ee --- /dev/null +++ b/docs/aws-docs/providers/aws/greengrassv2/deployments/index.md @@ -0,0 +1,92 @@ +--- +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
DescriptionResource for Greengrass V2 deployment.
Idaws.greengrassv2.deployments
+ +## Fields + + + + + +
NameDatatypeDescription
deployment_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +deployment_id +FROM aws.greengrassv2.deployments +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the deployments resource, the following permissions are required: + +### Create +```json +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 +```json +greengrass:ListDeployments, +iot:DescribeJob, +iot:DescribeThing, +iot:DescribeThingGroup, +iot:GetThingShadow +``` + diff --git a/docs/aws-docs/providers/aws/greengrassv2/index.md b/docs/aws-docs/providers/aws/greengrassv2/index.md new file mode 100644 index 0000000000..5eae1af446 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/groundstation/config/index.md b/docs/aws-docs/providers/aws/groundstation/config/index.md new file mode 100644 index 0000000000..9ab5514eef --- /dev/null +++ b/docs/aws-docs/providers/aws/groundstation/config/index.md @@ -0,0 +1,102 @@ +--- +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
DescriptionAWS Ground Station config resource type for CloudFormation.
Idaws.groundstation.config
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
namestring
tagsarray
typestring
config_dataobject
arnstring
idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +tags, +type, +config_data, +arn, +id +FROM aws.groundstation.config +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the config resource, the following permissions are required: + +### Read +```json +groundstation:GetConfig, +groundstation:ListTagsForResource +``` + +### Update +```json +groundstation:UpdateConfig, +groundstation:ListTagsForResource, +groundstation:TagResource, +groundstation:UntagResource, +iam:PassRole +``` + +### Delete +```json +groundstation:DeleteConfig +``` + diff --git a/docs/aws-docs/providers/aws/groundstation/configs/index.md b/docs/aws-docs/providers/aws/groundstation/configs/index.md new file mode 100644 index 0000000000..6c9a413a0b --- /dev/null +++ b/docs/aws-docs/providers/aws/groundstation/configs/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionAWS Ground Station config resource type for CloudFormation.
Idaws.groundstation.configs
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.groundstation.configs +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the configs resource, the following permissions are required: + +### Create +```json +groundstation:CreateConfig, +groundstation:TagResource, +iam:PassRole +``` + +### List +```json +groundstation:ListConfigs +``` + diff --git a/docs/aws-docs/providers/aws/groundstation/dataflow_endpoint_group/index.md b/docs/aws-docs/providers/aws/groundstation/dataflow_endpoint_group/index.md new file mode 100644 index 0000000000..1310b928ae --- /dev/null +++ b/docs/aws-docs/providers/aws/groundstation/dataflow_endpoint_group/index.md @@ -0,0 +1,89 @@ +--- +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
DescriptionAWS Ground Station DataflowEndpointGroup schema for CloudFormation
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +arn, +endpoint_details, +contact_pre_pass_duration_seconds, +contact_post_pass_duration_seconds, +tags +FROM aws.groundstation.dataflow_endpoint_group +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the dataflow_endpoint_group resource, the following permissions are required: + +### Read +```json +groundstation:GetDataflowEndpointGroup, +groundstation:ListTagsForResource +``` + +### Delete +```json +groundstation:DeleteDataflowEndpointGroup, +groundstation:GetDataflowEndpointGroup +``` + diff --git a/docs/aws-docs/providers/aws/groundstation/dataflow_endpoint_groups/index.md b/docs/aws-docs/providers/aws/groundstation/dataflow_endpoint_groups/index.md new file mode 100644 index 0000000000..c8ad9b4e17 --- /dev/null +++ b/docs/aws-docs/providers/aws/groundstation/dataflow_endpoint_groups/index.md @@ -0,0 +1,83 @@ +--- +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
DescriptionAWS Ground Station DataflowEndpointGroup schema for CloudFormation
Idaws.groundstation.dataflow_endpoint_groups
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.groundstation.dataflow_endpoint_groups +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the dataflow_endpoint_groups resource, the following permissions are required: + +### Create +```json +groundstation:CreateDataflowEndpointGroup, +groundstation:GetDataflowEndpointGroup, +groundstation:TagResource, +iam:PassRole, +ec2:describeAddresses, +ec2:describeNetworkInterfaces, +iam:createServiceLinkedRole +``` + +### List +```json +groundstation:ListDataflowEndpointGroups +``` + diff --git a/docs/aws-docs/providers/aws/groundstation/index.md b/docs/aws-docs/providers/aws/groundstation/index.md new file mode 100644 index 0000000000..7b2058872c --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/groundstation/mission_profile/index.md b/docs/aws-docs/providers/aws/groundstation/mission_profile/index.md new file mode 100644 index 0000000000..5c32a96f17 --- /dev/null +++ b/docs/aws-docs/providers/aws/groundstation/mission_profile/index.md @@ -0,0 +1,120 @@ +--- +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
DescriptionAWS Ground Station Mission Profile resource type for CloudFormation.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.groundstation.mission_profile +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the mission_profile resource, the following permissions are required: + +### Read +```json +groundstation:GetMissionProfile, +groundstation:ListTagsForResource, +kms:DescribeKey, +kms:CreateGrant +``` + +### Update +```json +groundstation:UpdateMissionProfile, +groundstation:GetMissionProfile, +groundstation:ListTagsForResource, +groundstation:TagResource, +groundstation:UntagResource, +iam:PassRole, +kms:DescribeKey, +kms:CreateGrant +``` + +### Delete +```json +groundstation:DeleteMissionProfile, +groundstation:GetMissionProfile +``` + diff --git a/docs/aws-docs/providers/aws/groundstation/mission_profiles/index.md b/docs/aws-docs/providers/aws/groundstation/mission_profiles/index.md new file mode 100644 index 0000000000..ecbc4ed522 --- /dev/null +++ b/docs/aws-docs/providers/aws/groundstation/mission_profiles/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionAWS Ground Station Mission Profile resource type for CloudFormation.
Idaws.groundstation.mission_profiles
+ +## Fields + + + + + + +
NameDatatypeDescription
idstring
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id, +arn +FROM aws.groundstation.mission_profiles +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the mission_profiles resource, the following permissions are required: + +### Create +```json +groundstation:CreateMissionProfile, +groundstation:GetMissionProfile, +groundstation:TagResource, +iam:PassRole, +kms:DescribeKey, +kms:CreateGrant +``` + +### List +```json +groundstation:ListMissionProfiles +``` + diff --git a/docs/aws-docs/providers/aws/guardduty/detector/index.md b/docs/aws-docs/providers/aws/guardduty/detector/index.md new file mode 100644 index 0000000000..0625725b35 --- /dev/null +++ b/docs/aws-docs/providers/aws/guardduty/detector/index.md @@ -0,0 +1,103 @@ +--- +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
DescriptionResource Type definition for AWS::GuardDuty::Detector
Idaws.guardduty.detector
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
finding_publishing_frequencystring
enableboolean
data_sourcesobject
featuresarray
idstring
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +finding_publishing_frequency, +enable, +data_sources, +features, +id, +tags +FROM aws.guardduty.detector +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the detector resource, the following permissions are required: + +### Read +```json +guardduty:GetDetector +``` + +### Delete +```json +guardduty:ListDetectors, +guardduty:DeleteDetector, +guardduty:GetDetector +``` + +### Update +```json +guardduty:UpdateDetector, +guardduty:GetDetector, +guardduty:ListDetectors, +iam:CreateServiceLinkedRole, +iam:GetRole +``` + diff --git a/docs/aws-docs/providers/aws/guardduty/detectors/index.md b/docs/aws-docs/providers/aws/guardduty/detectors/index.md new file mode 100644 index 0000000000..637e50c44e --- /dev/null +++ b/docs/aws-docs/providers/aws/guardduty/detectors/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionResource Type definition for AWS::GuardDuty::Detector
Idaws.guardduty.detectors
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.guardduty.detectors +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the detectors resource, the following permissions are required: + +### Create +```json +guardduty:CreateDetector, +guardduty:GetDetector, +guardduty:TagResource, +iam:CreateServiceLinkedRole, +iam:GetRole +``` + +### List +```json +guardduty:ListDetectors +``` + diff --git a/docs/aws-docs/providers/aws/guardduty/filter/index.md b/docs/aws-docs/providers/aws/guardduty/filter/index.md new file mode 100644 index 0000000000..27b53360b9 --- /dev/null +++ b/docs/aws-docs/providers/aws/guardduty/filter/index.md @@ -0,0 +1,104 @@ +--- +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
DescriptionResource Type definition for AWS::GuardDuty::Filter
Idaws.guardduty.filter
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
actionstring
descriptionstring
detector_idstring
finding_criteriaobject
rankinteger
namestring
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +action, +description, +detector_id, +finding_criteria, +rank, +name, +tags +FROM aws.guardduty.filter +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the filter resource, the following permissions are required: + +### Read +```json +guardduty:GetFilter +``` + +### Delete +```json +guardduty:ListDetectors, +guardduty:ListFilters, +guardduty:GetFilter, +guardduty:DeleteFilter +``` + +### Update +```json +guardduty:UpdateFilter, +guardduty:GetFilter, +guardduty:ListFilters +``` + diff --git a/docs/aws-docs/providers/aws/guardduty/filters/index.md b/docs/aws-docs/providers/aws/guardduty/filters/index.md new file mode 100644 index 0000000000..d35fa4075d --- /dev/null +++ b/docs/aws-docs/providers/aws/guardduty/filters/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionResource Type definition for AWS::GuardDuty::Filter
Idaws.guardduty.filters
+ +## Fields + + + + + + +
NameDatatypeDescription
detector_idstring
namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +detector_id, +name +FROM aws.guardduty.filters +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the filters resource, the following permissions are required: + +### Create +```json +guardduty:CreateFilter, +guardduty:GetFilter, +guardduty:TagResource +``` + +### List +```json +guardduty:ListFilters +``` + diff --git a/docs/aws-docs/providers/aws/guardduty/index.md b/docs/aws-docs/providers/aws/guardduty/index.md new file mode 100644 index 0000000000..1af7865eb7 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/guardduty/ip_set/index.md b/docs/aws-docs/providers/aws/guardduty/ip_set/index.md new file mode 100644 index 0000000000..7982c0ce82 --- /dev/null +++ b/docs/aws-docs/providers/aws/guardduty/ip_set/index.md @@ -0,0 +1,107 @@ +--- +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
DescriptionResource Type definition for AWS::GuardDuty::IPSet
Idaws.guardduty.ip_set
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
idstring
formatstring
activateboolean
detector_idstring
namestring
locationstring
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +format, +activate, +detector_id, +name, +location, +tags +FROM aws.guardduty.ip_set +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the ip_set resource, the following permissions are required: + +### Read +```json +guardduty:GetIPSet +``` + +### Delete +```json +guardduty:GetDetector, +guardduty:ListDetectors, +guardduty:ListIPSets, +guardduty:GetIPSet, +guardduty:DeleteIPSet, +iam:DeleteRolePolicy +``` + +### Update +```json +guardduty:UpdateIPSet, +guardduty:GetIPSet, +guardduty:ListIPSets, +iam:PutRolePolicy +``` + diff --git a/docs/aws-docs/providers/aws/guardduty/ip_sets/index.md b/docs/aws-docs/providers/aws/guardduty/ip_sets/index.md new file mode 100644 index 0000000000..3a88118771 --- /dev/null +++ b/docs/aws-docs/providers/aws/guardduty/ip_sets/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionResource Type definition for AWS::GuardDuty::IPSet
Idaws.guardduty.ip_sets
+ +## Fields + + + + + + +
NameDatatypeDescription
idstring
detector_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id, +detector_id +FROM aws.guardduty.ip_sets +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the ip_sets resource, the following permissions are required: + +### Create +```json +guardduty:CreateIPSet, +guardduty:GetIPSet, +guardduty:TagResource, +iam:PutRolePolicy +``` + +### List +```json +guardduty:ListIPSets +``` + diff --git a/docs/aws-docs/providers/aws/guardduty/master/index.md b/docs/aws-docs/providers/aws/guardduty/master/index.md new file mode 100644 index 0000000000..8bfad0aa6f --- /dev/null +++ b/docs/aws-docs/providers/aws/guardduty/master/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionGuardDuty Master resource schema
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +master_id, +invitation_id, +detector_id +FROM aws.guardduty.master +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the master resource, the following permissions are required: + +### Read +```json +guardduty:GetMasterAccount +``` + +### Delete +```json +guardduty:DisassociateFromMasterAccount +``` + diff --git a/docs/aws-docs/providers/aws/guardduty/masters/index.md b/docs/aws-docs/providers/aws/guardduty/masters/index.md new file mode 100644 index 0000000000..412a524abe --- /dev/null +++ b/docs/aws-docs/providers/aws/guardduty/masters/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionGuardDuty Master resource schema
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +detector_id, +master_id +FROM aws.guardduty.masters +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the masters resource, the following permissions are required: + +### Create +```json +guardduty:ListInvitations, +guardduty:AcceptInvitation, +guardduty:GetMasterAccount +``` + +### List +```json +guardduty:GetMasterAccount +``` + diff --git a/docs/aws-docs/providers/aws/guardduty/member/index.md b/docs/aws-docs/providers/aws/guardduty/member/index.md new file mode 100644 index 0000000000..62c38e0ea7 --- /dev/null +++ b/docs/aws-docs/providers/aws/guardduty/member/index.md @@ -0,0 +1,104 @@ +--- +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
DescriptionResource Type definition for AWS::GuardDuty::Member
Idaws.guardduty.member
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
statusstring
member_idstring
emailstring
messagestring
disable_email_notificationboolean
detector_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +status, +member_id, +email, +message, +disable_email_notification, +detector_id +FROM aws.guardduty.member +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the member resource, the following permissions are required: + +### Read +```json +guardduty:GetMembers +``` + +### Delete +```json +guardduty:GetMembers, +guardduty:DisassociateMembers, +guardduty:DeleteMembers +``` + +### Update +```json +guardduty:GetMembers, +guardduty:CreateMembers, +guardduty:DisassociateMembers, +guardduty:StartMonitoringMembers, +guardduty:StopMonitoringMembers, +guardduty:InviteMembers +``` + diff --git a/docs/aws-docs/providers/aws/guardduty/members/index.md b/docs/aws-docs/providers/aws/guardduty/members/index.md new file mode 100644 index 0000000000..6faf05cef9 --- /dev/null +++ b/docs/aws-docs/providers/aws/guardduty/members/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionResource Type definition for AWS::GuardDuty::Member
Idaws.guardduty.members
+ +## Fields + + + + + + +
NameDatatypeDescription
detector_idstring
member_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +detector_id, +member_id +FROM aws.guardduty.members +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the members resource, the following permissions are required: + +### Create +```json +guardduty:CreateMembers, +guardduty:GetMembers +``` + +### List +```json +guardduty:ListMembers +``` + diff --git a/docs/aws-docs/providers/aws/guardduty/threat_intel_set/index.md b/docs/aws-docs/providers/aws/guardduty/threat_intel_set/index.md new file mode 100644 index 0000000000..702db6ea45 --- /dev/null +++ b/docs/aws-docs/providers/aws/guardduty/threat_intel_set/index.md @@ -0,0 +1,106 @@ +--- +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
DescriptionResource Type definition for AWS::GuardDuty::ThreatIntelSet
Idaws.guardduty.threat_intel_set
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
idstring
formatstring
activateboolean
detector_idstring
namestring
locationstring
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +format, +activate, +detector_id, +name, +location, +tags +FROM aws.guardduty.threat_intel_set +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the threat_intel_set resource, the following permissions are required: + +### Read +```json +guardduty:GetThreatIntelSet +``` + +### Delete +```json +guardduty:ListDetectors, +guardduty:ListThreatIntelSets, +guardduty:DeleteThreatIntelSet, +guardduty:GetThreatIntelSet, +iam:DeleteRolePolicy +``` + +### Update +```json +guardduty:UpdateThreatIntelSet, +guardduty:GetThreatIntelSet, +guardduty:ListThreatIntelSets, +iam:PutRolePolicy +``` + diff --git a/docs/aws-docs/providers/aws/guardduty/threat_intel_sets/index.md b/docs/aws-docs/providers/aws/guardduty/threat_intel_sets/index.md new file mode 100644 index 0000000000..8ec5965068 --- /dev/null +++ b/docs/aws-docs/providers/aws/guardduty/threat_intel_sets/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionResource Type definition for AWS::GuardDuty::ThreatIntelSet
Idaws.guardduty.threat_intel_sets
+ +## Fields + + + + + + +
NameDatatypeDescription
idstring
detector_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id, +detector_id +FROM aws.guardduty.threat_intel_sets +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the threat_intel_sets resource, the following permissions are required: + +### Create +```json +guardduty:CreateThreatIntelSet, +guardduty:GetThreatIntelSet, +guardduty:TagResource, +iam:PutRolePolicy +``` + +### List +```json +guardduty:ListThreatIntelSets +``` + diff --git a/docs/aws-docs/providers/aws/healthimaging/datastore/index.md b/docs/aws-docs/providers/aws/healthimaging/datastore/index.md new file mode 100644 index 0000000000..fea846be76 --- /dev/null +++ b/docs/aws-docs/providers/aws/healthimaging/datastore/index.md @@ -0,0 +1,98 @@ +--- +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
DescriptionDefinition of AWS::HealthImaging::Datastore Resource Type
Idaws.healthimaging.datastore
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
datastore_arnstring
datastore_namestring
datastore_idstring
datastore_statusstring
kms_key_arnstring
created_atstring
updated_atstring
tagsobject
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +datastore_arn, +datastore_name, +datastore_id, +datastore_status, +kms_key_arn, +created_at, +updated_at, +tags +FROM aws.healthimaging.datastore +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the datastore resource, the following permissions are required: + +### Read +```json +medical-imaging:GetDatastore, +medical-imaging:ListTagsForResource +``` + +### Delete +```json +medical-imaging:DeleteDatastore, +medical-imaging:GetDatastore, +medical-imaging:UntagResource, +kms:DescribeKey, +kms:RetireGrant, +kms:GenerateDataKey, +kms:Decrypt +``` + diff --git a/docs/aws-docs/providers/aws/healthimaging/datastores/index.md b/docs/aws-docs/providers/aws/healthimaging/datastores/index.md new file mode 100644 index 0000000000..178f64ef2a --- /dev/null +++ b/docs/aws-docs/providers/aws/healthimaging/datastores/index.md @@ -0,0 +1,87 @@ +--- +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
DescriptionDefinition of AWS::HealthImaging::Datastore Resource Type
Idaws.healthimaging.datastores
+ +## Fields + + + + + +
NameDatatypeDescription
datastore_idundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +datastore_id +FROM aws.healthimaging.datastores +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the datastores resource, the following permissions are required: + +### Create +```json +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 +```json +medical-imaging:ListDatastores +``` + diff --git a/docs/aws-docs/providers/aws/healthimaging/index.md b/docs/aws-docs/providers/aws/healthimaging/index.md new file mode 100644 index 0000000000..d144ca2770 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/healthlake/fhir_datastore/index.md b/docs/aws-docs/providers/aws/healthlake/fhir_datastore/index.md new file mode 100644 index 0000000000..1b2de78760 --- /dev/null +++ b/docs/aws-docs/providers/aws/healthlake/fhir_datastore/index.md @@ -0,0 +1,122 @@ +--- +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
DescriptionHealthLake FHIR Datastore
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.healthlake.fhir_datastore +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the fhir_datastore resource, the following permissions are required: + +### Read +```json +healthlake:DescribeFHIRDatastore, +healthlake:ListTagsForResource +``` + +### Update +```json +healthlake:TagResource, +healthlake:UntagResource, +healthlake:ListTagsForResource, +healthlake:DescribeFHIRDatastore, +iam:PassRole, +iam:GetRole, +iam:CreateServiceLinkedRole +``` + +### Delete +```json +healthlake:DeleteFHIRDatastore, +healthlake:DescribeFHIRDatastore, +iam:PassRole, +iam:GetRole, +iam:CreateServiceLinkedRole, +ram:GetResourceShareInvitations, +ram:AcceptResourceShareInvitation, +glue:CreateDatabase, +glue:DeleteDatabase +``` + diff --git a/docs/aws-docs/providers/aws/healthlake/fhir_datastores/index.md b/docs/aws-docs/providers/aws/healthlake/fhir_datastores/index.md new file mode 100644 index 0000000000..8160f2aca2 --- /dev/null +++ b/docs/aws-docs/providers/aws/healthlake/fhir_datastores/index.md @@ -0,0 +1,93 @@ +--- +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
DescriptionHealthLake FHIR Datastore
Idaws.healthlake.fhir_datastores
+ +## Fields + + + + + +
NameDatatypeDescription
datastore_idundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +datastore_id +FROM aws.healthlake.fhir_datastores +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the fhir_datastores resource, the following permissions are required: + +### Create +```json +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 +```json +healthlake:ListFHIRDatastores +``` + diff --git a/docs/aws-docs/providers/aws/healthlake/index.md b/docs/aws-docs/providers/aws/healthlake/index.md new file mode 100644 index 0000000000..182aca7f76 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/iam/access_key_last_useds/index.md b/docs/aws-docs/providers/aws/iam/access_key_last_useds/index.md deleted file mode 100644 index 5043f5ea31..0000000000 --- a/docs/aws-docs/providers/aws/iam/access_key_last_useds/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: access_key_last_useds -hide_title: false -hide_table_of_contents: false -keywords: - - access_key_last_useds - - 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 ---- - - - -## Overview - - - - -
Nameaccess_key_last_useds
TypeResource
Idaws.iam.access_key_last_useds
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `AccessKeyLastUsed` | `object` | <p>Contains information about the last time an Amazon Web Services access key was used since IAM began tracking this information on April 22, 2015.</p> <p>This data type is used as a response element in the <a>GetAccessKeyLastUsed</a> operation.</p> | -| `UserName` | `string` | <p>The name of the IAM user that owns this access key.</p> <p/> | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `access_key_last_useds_Get` | `SELECT` | `AccessKeyId, region` | diff --git a/docs/aws-docs/providers/aws/iam/access_keys/index.md b/docs/aws-docs/providers/aws/iam/access_keys/index.md deleted file mode 100644 index e9c63f86f7..0000000000 --- a/docs/aws-docs/providers/aws/iam/access_keys/index.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: access_keys -hide_title: false -hide_table_of_contents: false -keywords: - - access_keys - - 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 ---- - - - -## Overview - - - - -
Nameaccess_keys
TypeResource
Idaws.iam.access_keys
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `AccessKeyId` | `string` | The ID for this access key. | -| `CreateDate` | `string` | The date when the access key was created. | -| `Status` | `string` | The status of the access key. <code>Active</code> means that the key is valid for API calls; <code>Inactive</code> means it is not. | -| `UserName` | `string` | The name of the IAM user that the key is associated with. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `access_keys_List` | `SELECT` | `region` | <p>Returns information about the access key IDs associated with the specified IAM user. If there is none, the operation returns an empty list.</p> <p>Although each user is limited to a small number of keys, you can still paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters.</p> <p>If the <code>UserName</code> field is not specified, the user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.</p> <note> <p>To ensure the security of your Amazon Web Services account, the secret access key is accessible only during key and user creation.</p> </note> | -| `access_keys_Create` | `INSERT` | `region` | <p> Creates a new Amazon Web Services secret access key and corresponding Amazon Web Services access key ID for the specified user. The default status for new keys is <code>Active</code>.</p> <p>If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID signing the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials. This is true even if the Amazon Web Services account has no associated users.</p> <p> For information about quotas on the number of keys you can create, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html">IAM and STS quotas</a> in the <i>IAM User Guide</i>.</p> <important> <p>To ensure the security of your Amazon Web Services account, the secret access key is accessible only during key and user creation. You must save the key (for example, in a text file) if you want to be able to access it again. If a secret key is lost, you can delete the access keys for the associated user and then create new keys.</p> </important> | -| `access_keys_Delete` | `DELETE` | `AccessKeyId, region` | <p>Deletes the access key pair associated with the specified IAM user.</p> <p>If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID signing the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.</p> | -| `access_keys_Update` | `EXEC` | `AccessKeyId, Status, region` | <p>Changes the status of the specified access key from Active to Inactive, or vice versa. This operation can be used to disable a user's key as part of a key rotation workflow.</p> <p>If the <code>UserName</code> is not specified, the user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.</p> <p>For information about rotating keys, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/ManagingCredentials.html">Managing keys and certificates</a> in the <i>IAM User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/iam/account_alias/index.md b/docs/aws-docs/providers/aws/iam/account_alias/index.md deleted file mode 100644 index 24e1cb1521..0000000000 --- a/docs/aws-docs/providers/aws/iam/account_alias/index.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: account_alias -hide_title: false -hide_table_of_contents: false -keywords: - - account_alias - - 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 ---- - - - -## Overview - - - - -
Nameaccount_alias
TypeResource
Idaws.iam.account_alias
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `account_alias_Create` | `INSERT` | `AccountAlias, region` | Creates an alias for your Amazon Web Services account. For information about using an Amazon Web Services account alias, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/AccountAlias.html">Using an alias for your Amazon Web Services account ID</a> in the <i>IAM User Guide</i>. | -| `account_alias_Delete` | `DELETE` | `AccountAlias, region` | Deletes the specified Amazon Web Services account alias. For information about using an Amazon Web Services account alias, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/AccountAlias.html">Using an alias for your Amazon Web Services account ID</a> in the <i>IAM User Guide</i>. | diff --git a/docs/aws-docs/providers/aws/iam/account_aliases/index.md b/docs/aws-docs/providers/aws/iam/account_aliases/index.md deleted file mode 100644 index 327b767782..0000000000 --- a/docs/aws-docs/providers/aws/iam/account_aliases/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: account_aliases -hide_title: false -hide_table_of_contents: false -keywords: - - account_aliases - - 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 ---- - - - -## Overview - - - - -
Nameaccount_aliases
TypeResource
Idaws.iam.account_aliases
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `account_aliases_List` | `EXEC` | `region` | diff --git a/docs/aws-docs/providers/aws/iam/account_authorization_details/index.md b/docs/aws-docs/providers/aws/iam/account_authorization_details/index.md deleted file mode 100644 index d80af30995..0000000000 --- a/docs/aws-docs/providers/aws/iam/account_authorization_details/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: account_authorization_details -hide_title: false -hide_table_of_contents: false -keywords: - - account_authorization_details - - 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 ---- - - - -## Overview - - - - -
Nameaccount_authorization_details
TypeResource
Idaws.iam.account_authorization_details
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `GroupDetailList` | `array` | A list containing information about IAM groups. | -| `IsTruncated` | `boolean` | A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items. Note that IAM might return fewer than the <code>MaxItems</code> number of results even when there are more results available. We recommend that you check <code>IsTruncated</code> after every call to ensure that you receive all your results. | -| `Marker` | `string` | When <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value to use for the <code>Marker</code> parameter in a subsequent pagination request. | -| `Policies` | `array` | A list containing information about managed policies. | -| `RoleDetailList` | `array` | A list containing information about IAM roles. | -| `UserDetailList` | `array` | A list containing information about IAM users. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `account_authorization_details_Get` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/iam/account_password_policies/index.md b/docs/aws-docs/providers/aws/iam/account_password_policies/index.md deleted file mode 100644 index 36477a474e..0000000000 --- a/docs/aws-docs/providers/aws/iam/account_password_policies/index.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: account_password_policies -hide_title: false -hide_table_of_contents: false -keywords: - - account_password_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 ---- - - - -## Overview - - - - -
Nameaccount_password_policies
TypeResource
Idaws.iam.account_password_policies
- -## Fields -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `account_password_policies_Get` | `SELECT` | `region` | Retrieves the password policy for the Amazon Web Services account. This tells you the complexity requirements and mandatory rotation periods for the IAM user passwords in your account. For more information about using a password policy, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingPasswordPolicies.html">Managing an IAM password policy</a>. | -| `account_password_policies_Delete` | `DELETE` | `region` | Deletes the password policy for the Amazon Web Services account. There are no parameters. | -| `account_password_policies_Update` | `EXEC` | `region` | <p>Updates the password policy settings for the Amazon Web Services account.</p> <note> <p>This operation does not support partial updates. No parameters are required, but if you do not specify a parameter, that parameter's value reverts to its default value. See the <b>Request Parameters</b> section for each parameter's default value. Also note that some parameters do not allow the default parameter to be explicitly set. Instead, to invoke the default value, do not include that parameter when you invoke the operation.</p> </note> <p> For more information about using a password policy, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingPasswordPolicies.html">Managing an IAM password policy</a> in the <i>IAM User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/iam/account_summaries/index.md b/docs/aws-docs/providers/aws/iam/account_summaries/index.md deleted file mode 100644 index 01955c9e81..0000000000 --- a/docs/aws-docs/providers/aws/iam/account_summaries/index.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: account_summaries -hide_title: false -hide_table_of_contents: false -keywords: - - account_summaries - - 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 ---- - - - -## Overview - - - - -
Nameaccount_summaries
TypeResource
Idaws.iam.account_summaries
- -## Fields -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `account_summaries_Get` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/iam/assume_role_policies/index.md b/docs/aws-docs/providers/aws/iam/assume_role_policies/index.md deleted file mode 100644 index 0146724567..0000000000 --- a/docs/aws-docs/providers/aws/iam/assume_role_policies/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: assume_role_policies -hide_title: false -hide_table_of_contents: false -keywords: - - assume_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 ---- - - - -## Overview - - - - -
Nameassume_role_policies
TypeResource
Idaws.iam.assume_role_policies
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `assume_role_policies_Update` | `EXEC` | `PolicyDocument, RoleName, region` | diff --git a/docs/aws-docs/providers/aws/iam/attached_group_policies/index.md b/docs/aws-docs/providers/aws/iam/attached_group_policies/index.md deleted file mode 100644 index d63ff6dc95..0000000000 --- a/docs/aws-docs/providers/aws/iam/attached_group_policies/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: attached_group_policies -hide_title: false -hide_table_of_contents: false -keywords: - - attached_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 ---- - - - -## Overview - - - - -
Nameattached_group_policies
TypeResource
Idaws.iam.attached_group_policies
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `PolicyArn` | `string` | <p>The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.</p> <p>For more information about ARNs, go to <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>. </p> | -| `PolicyName` | `string` | The friendly name of the attached policy. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `attached_group_policies_List` | `SELECT` | `GroupName, region` | diff --git a/docs/aws-docs/providers/aws/iam/attached_role_policies/index.md b/docs/aws-docs/providers/aws/iam/attached_role_policies/index.md deleted file mode 100644 index a3257694c9..0000000000 --- a/docs/aws-docs/providers/aws/iam/attached_role_policies/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: attached_role_policies -hide_title: false -hide_table_of_contents: false -keywords: - - attached_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 ---- - - - -## Overview - - - - -
Nameattached_role_policies
TypeResource
Idaws.iam.attached_role_policies
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `PolicyArn` | `string` | <p>The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.</p> <p>For more information about ARNs, go to <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>. </p> | -| `PolicyName` | `string` | The friendly name of the attached policy. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `attached_role_policies_List` | `SELECT` | `RoleName, region` | diff --git a/docs/aws-docs/providers/aws/iam/attached_user_policies/index.md b/docs/aws-docs/providers/aws/iam/attached_user_policies/index.md deleted file mode 100644 index 01eb7833ea..0000000000 --- a/docs/aws-docs/providers/aws/iam/attached_user_policies/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: attached_user_policies -hide_title: false -hide_table_of_contents: false -keywords: - - attached_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 ---- - - - -## Overview - - - - -
Nameattached_user_policies
TypeResource
Idaws.iam.attached_user_policies
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `PolicyArn` | `string` | <p>The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.</p> <p>For more information about ARNs, go to <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>. </p> | -| `PolicyName` | `string` | The friendly name of the attached policy. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `attached_user_policies_List` | `SELECT` | `UserName, region` | diff --git a/docs/aws-docs/providers/aws/iam/client_id_from_open_id_connect_providers/index.md b/docs/aws-docs/providers/aws/iam/client_id_from_open_id_connect_providers/index.md deleted file mode 100644 index 9776bae712..0000000000 --- a/docs/aws-docs/providers/aws/iam/client_id_from_open_id_connect_providers/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: client_id_from_open_id_connect_providers -hide_title: false -hide_table_of_contents: false -keywords: - - client_id_from_open_id_connect_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 ---- - - - -## Overview - - - - -
Nameclient_id_from_open_id_connect_providers
TypeResource
Idaws.iam.client_id_from_open_id_connect_providers
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `client_id_from_open_id_connect_providers_Remove` | `EXEC` | `ClientID, OpenIDConnectProviderArn, region` | diff --git a/docs/aws-docs/providers/aws/iam/context_keys_for_custom_policies/index.md b/docs/aws-docs/providers/aws/iam/context_keys_for_custom_policies/index.md deleted file mode 100644 index 338400ac08..0000000000 --- a/docs/aws-docs/providers/aws/iam/context_keys_for_custom_policies/index.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: context_keys_for_custom_policies -hide_title: false -hide_table_of_contents: false -keywords: - - context_keys_for_custom_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 ---- - - - -## Overview - - - - -
Namecontext_keys_for_custom_policies
TypeResource
Idaws.iam.context_keys_for_custom_policies
- -## Fields -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `context_keys_for_custom_policies_Get` | `SELECT` | `PolicyInputList, region` | diff --git a/docs/aws-docs/providers/aws/iam/context_keys_for_principal_policies/index.md b/docs/aws-docs/providers/aws/iam/context_keys_for_principal_policies/index.md deleted file mode 100644 index b043c65338..0000000000 --- a/docs/aws-docs/providers/aws/iam/context_keys_for_principal_policies/index.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: context_keys_for_principal_policies -hide_title: false -hide_table_of_contents: false -keywords: - - context_keys_for_principal_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 ---- - - - -## Overview - - - - -
Namecontext_keys_for_principal_policies
TypeResource
Idaws.iam.context_keys_for_principal_policies
- -## Fields -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `context_keys_for_principal_policies_Get` | `SELECT` | `PolicySourceArn, region` | diff --git a/docs/aws-docs/providers/aws/iam/credential_reports/index.md b/docs/aws-docs/providers/aws/iam/credential_reports/index.md deleted file mode 100644 index 65fe3452a8..0000000000 --- a/docs/aws-docs/providers/aws/iam/credential_reports/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: credential_reports -hide_title: false -hide_table_of_contents: false -keywords: - - credential_reports - - 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 ---- - - - -## Overview - - - - -
Namecredential_reports
TypeResource
Idaws.iam.credential_reports
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `Content` | `string` | Contains the credential report. The report is Base64-encoded. | -| `GeneratedTime` | `string` | The date and time when the credential report was created, in <a href="http://www.iso.org/iso/iso8601">ISO 8601 date-time format</a>. | -| `ReportFormat` | `string` | The format (MIME type) of the credential report. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `credential_reports_Get` | `SELECT` | `region` | Retrieves a credential report for the Amazon Web Services account. For more information about the credential report, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html">Getting credential reports</a> in the <i>IAM User Guide</i>. | -| `credential_reports_Generate` | `EXEC` | `region` | Generates a credential report for the Amazon Web Services account. For more information about the credential report, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html">Getting credential reports</a> in the <i>IAM User Guide</i>. | diff --git a/docs/aws-docs/providers/aws/iam/custom_policies/index.md b/docs/aws-docs/providers/aws/iam/custom_policies/index.md deleted file mode 100644 index bf20867c47..0000000000 --- a/docs/aws-docs/providers/aws/iam/custom_policies/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: custom_policies -hide_title: false -hide_table_of_contents: false -keywords: - - custom_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 ---- - - - -## Overview - - - - -
Namecustom_policies
TypeResource
Idaws.iam.custom_policies
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `custom_policies_Simulate` | `EXEC` | `ActionNames, PolicyInputList, region` | diff --git a/docs/aws-docs/providers/aws/iam/default_policy_versions/index.md b/docs/aws-docs/providers/aws/iam/default_policy_versions/index.md deleted file mode 100644 index 5ae0994605..0000000000 --- a/docs/aws-docs/providers/aws/iam/default_policy_versions/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: default_policy_versions -hide_title: false -hide_table_of_contents: false -keywords: - - default_policy_versions - - 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 ---- - - - -## Overview - - - - -
Namedefault_policy_versions
TypeResource
Idaws.iam.default_policy_versions
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `default_policy_versions_Set` | `EXEC` | `PolicyArn, VersionId, region` | diff --git a/docs/aws-docs/providers/aws/iam/entities_for_policies/index.md b/docs/aws-docs/providers/aws/iam/entities_for_policies/index.md deleted file mode 100644 index d2bdc14538..0000000000 --- a/docs/aws-docs/providers/aws/iam/entities_for_policies/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: entities_for_policies -hide_title: false -hide_table_of_contents: false -keywords: - - entities_for_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 ---- - - - -## Overview - - - - -
Nameentities_for_policies
TypeResource
Idaws.iam.entities_for_policies
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `GroupId` | `string` | The stable and unique string identifying the group. For more information about IDs, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html">IAM identifiers</a> in the <i>IAM User Guide</i>. | -| `GroupName` | `string` | The name (friendly name, not ARN) identifying the group. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `entities_for_policies_List` | `SELECT` | `PolicyArn, region` | diff --git a/docs/aws-docs/providers/aws/iam/group/index.md b/docs/aws-docs/providers/aws/iam/group/index.md new file mode 100644 index 0000000000..60ef9f3589 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam/group/index.md @@ -0,0 +1,110 @@ +--- +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
DescriptionCreates a new group.<br/> For information about the number of groups you can create, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*.
Idaws.iam.group
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
arnstring
group_namestringThe name of the group to create. Do not include the path in this value.<br/> The group name must be unique within the account. Group names are not distinguished by case. For example, you cannot create groups named both "ADMINS" and "admins". If you don't specify a name, CFN generates a unique physical ID and uses that ID for the group name.<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.<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"}]]}``.
managed_policy_arnsarrayThe Amazon Resource Name (ARN) of the IAM policy you want to attach.<br/> For more information about ARNs, see [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*.
pathstringThe path to the group. For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*.<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.
policiesarrayAdds or updates an inline policy document that is embedded in the specified IAM group. To view AWS::IAM::Group snippets, see [Declaring an Group Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-iam-group).<br/> The name of each inline policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail. <br/> For information about limits on the number of inline policies that you can embed in a group, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +group_name, +managed_policy_arns, +path, +policies +FROM aws.iam.group +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the group resource, the following permissions are required: + +### Read +```json +iam:GetGroup, +iam:ListGroupPolicies, +iam:GetGroupPolicy, +iam:ListAttachedGroupPolicies +``` + +### Update +```json +iam:GetGroup, +iam:UpdateGroup, +iam:DetachGroupPolicy, +iam:AttachGroupPolicy, +iam:DeleteGroupPolicy, +iam:PutGroupPolicy, +iam:GetGroupPolicy +``` + +### Delete +```json +iam:GetGroup, +iam:DeleteGroup, +iam:ListAttachedGroupPolicies, +iam:ListGroupPolicies, +iam:DetachGroupPolicy, +iam:DeleteGroupPolicy, +iam:GetGroupPolicy +``` + diff --git a/docs/aws-docs/providers/aws/iam/group_policies/index.md b/docs/aws-docs/providers/aws/iam/group_policies/index.md index 80660eea6f..ea82b15d32 100644 --- a/docs/aws-docs/providers/aws/iam/group_policies/index.md +++ b/docs/aws-docs/providers/aws/iam/group_policies/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - group_policies - iam - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,28 +14,54 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- - - +List of group policies by GroupName (requires `aws` provider to be installed) ## Overview +
Namegroup_policies
TypeResource
DescriptionList of group policies by GroupName (requires `aws` provider to be installed)
Idaws.iam.group_policies
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `GroupName` | `string` | The group the policy is associated with. | -| `PolicyDocument` | `string` | <p>The policy document.</p> <p>IAM stores policies in JSON format. However, resources that were created using CloudFormation templates can be formatted in YAML. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.</p> | -| `PolicyName` | `string` | The name of the policy. | + + + + + + + + +
NameDatatypeDescription
group_namestringThe IAM group name
policy_namestringThe group policy name
policy_documentstringThe group policy document
regionstring
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `group_policies_Get` | `SELECT` | `GroupName, PolicyName, region` | <p>Retrieves the specified inline policy document that is embedded in the specified IAM group.</p> <note> <p>Policies returned by this operation are URL-encoded compliant with <a href="https://tools.ietf.org/html/rfc3986">RFC 3986</a>. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the <code>decode</code> method of the <code>java.net.URLDecoder</code> utility class in the Java SDK. Other languages and SDKs provide similar functionality.</p> </note> <p>An IAM group can also have managed policies attached to it. To retrieve a managed policy document that is attached to a group, use <a>GetPolicy</a> to determine the policy's default version, then use <a>GetPolicyVersion</a> to retrieve the policy document.</p> <p>For more information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p> | -| `group_policies_List` | `SELECT` | `GroupName, region` | <p>Lists the names of the inline policies that are embedded in the specified IAM group.</p> <p>An IAM group can also have managed policies attached to it. To list the managed policies that are attached to a group, use <a>ListAttachedGroupPolicies</a>. For more information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p> <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. If there are no inline policies embedded with the specified group, the operation returns an empty list.</p> | -| `group_policies_Delete` | `DELETE` | `GroupName, PolicyName, region` | <p>Deletes the specified inline policy that is embedded in the specified IAM group.</p> <p>A group can also have managed policies attached to it. To detach a managed policy from a group, use <a>DetachGroupPolicy</a>. For more information about policies, refer to <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p> | -| `group_policies_Attach` | `EXEC` | `GroupName, PolicyArn, region` | <p>Attaches the specified managed policy to the specified IAM group.</p> <p>You use this operation to attach a managed policy to a group. To embed an inline policy in a group, use <a>PutGroupPolicy</a>.</p> <p>As a best practice, you can validate your IAM policies. To learn more, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html">Validating IAM policies</a> in the <i>IAM User Guide</i>.</p> <p>For more information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p> | -| `group_policies_Detach` | `EXEC` | `GroupName, PolicyArn, region` | <p>Removes the specified managed policy from the specified IAM group.</p> <p>A group can also have inline policies embedded with it. To delete an inline policy, use <a>DeleteGroupPolicy</a>. For information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p> | -| `group_policies_Put` | `EXEC` | `GroupName, PolicyDocument, PolicyName, region` | <p>Adds or updates an inline policy document that is embedded in the specified IAM group.</p> <p>A user can also have managed policies attached to it. To attach a managed policy to a group, use <a>AttachGroupPolicy</a>. To create a new managed policy, use <a>CreatePolicy</a>. For information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p> <p>For information about the maximum number of inline policies that you can embed in a group, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html">IAM and STS quotas</a> in the <i>IAM User Guide</i>.</p> <note> <p>Because policy documents can be large, you should use POST rather than GET when calling <code>PutGroupPolicy</code>. For general information about using the Query API with IAM, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html">Making query requests</a> in the <i>IAM User Guide</i>.</p> </note> | + + + + + + + + + + + + +
NameAccessible byRequired Params
viewSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +group_name, +policy_name, +policy_document, +region +FROM aws.iam.group_policies +WHERE GroupName = ''; +``` + + + + diff --git a/docs/aws-docs/providers/aws/iam/group_policy/index.md b/docs/aws-docs/providers/aws/iam/group_policy/index.md new file mode 100644 index 0000000000..32e0c0fcf5 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam/group_policy/index.md @@ -0,0 +1,93 @@ +--- +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
DescriptionAdds or updates an inline policy document that is embedded in the specified IAM group.<br/> A group can also have managed policies attached to it. To attach a managed policy to a group, use [AWS::IAM::Group](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html). To create a new managed policy, use [AWS::IAM::ManagedPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html). 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 *IAM User Guide*.<br/> For information about the maximum number of inline policies that you can embed in a group, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +policy_document, +policy_name, +group_name +FROM aws.iam.group_policy +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the group_policy resource, the following permissions are required: + +### Read +```json +iam:GetGroupPolicy +``` + +### Update +```json +iam:PutGroupPolicy, +iam:GetGroupPolicy +``` + +### Delete +```json +iam:DeleteGroupPolicy, +iam:GetGroupPolicy +``` + diff --git a/docs/aws-docs/providers/aws/iam/groups/index.md b/docs/aws-docs/providers/aws/iam/groups/index.md index 1296513cd3..cfbb495bb4 100644 --- a/docs/aws-docs/providers/aws/iam/groups/index.md +++ b/docs/aws-docs/providers/aws/iam/groups/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - groups - iam - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,29 +14,68 @@ description: Query, deploy 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
DescriptionCreates a new group.<br/> For information about the number of groups you can create, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*.
Idaws.iam.groups
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `Arn` | `string` | <p>The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.</p> <p>For more information about ARNs, go to <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>. </p> | -| `CreateDate` | `string` | The date and time, in <a href="http://www.iso.org/iso/iso8601">ISO 8601 date-time format</a>, when the group was created. | -| `GroupId` | `string` | The stable and unique string identifying the group. For more information about IDs, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">IAM identifiers</a> in the <i>IAM User Guide</i>. | -| `GroupName` | `string` | The friendly name that identifies the group. | -| `Path` | `string` | The path to the group. For more information about paths, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">IAM identifiers</a> in the <i>IAM User Guide</i>. | + + + + + +
NameDatatypeDescription
group_namestringThe name of the group to create. Do not include the path in this value.<br/> The group name must be unique within the account. Group names are not distinguished by case. For example, you cannot create groups named both "ADMINS" and "admins". If you don't specify a name, CFN generates a unique physical ID and uses that ID for the group name.<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.<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 -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `groups_Get` | `SELECT` | `GroupName, region` | Returns a list of IAM users that are in the specified IAM group. You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. | -| `groups_List` | `SELECT` | `region` | <p>Lists the IAM groups that have the specified path prefix.</p> <p> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters.</p> | -| `groups_Create` | `INSERT` | `GroupName, region` | <p>Creates a new group.</p> <p> For information about the number of groups you can create, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html">IAM and STS quotas</a> in the <i>IAM User Guide</i>.</p> | -| `groups_Delete` | `DELETE` | `GroupName, region` | Deletes the specified IAM group. The group must not contain any users or have any attached policies. | -| `groups_Update` | `EXEC` | `GroupName, region` | <p>Updates the name and/or the path of the specified IAM group.</p> <important> <p> You should understand the implications of changing a group's path or name. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_WorkingWithGroupsAndUsers.html">Renaming users and groups</a> in the <i>IAM User Guide</i>.</p> </important> <note> <p>The person making the request (the principal), must have permission to change the role group with the old name and the new name. For example, to change the group named <code>Managers</code> to <code>MGRs</code>, the principal must have a policy that allows them to update both groups. If the principal has permission to update the <code>Managers</code> group, but not the <code>MGRs</code> group, then the update fails. For more information about permissions, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html">Access management</a>. </p> </note> | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +group_name +FROM aws.iam.groups + +``` + +## Permissions + +To operate on the groups resource, the following permissions are required: + +### Create +```json +iam:CreateGroup, +iam:PutGroupPolicy, +iam:AttachGroupPolicy, +iam:GetGroupPolicy, +iam:GetGroup +``` + +### List +```json +iam:ListGroups +``` + diff --git a/docs/aws-docs/providers/aws/iam/groups_for_users/index.md b/docs/aws-docs/providers/aws/iam/groups_for_users/index.md deleted file mode 100644 index c8a4775526..0000000000 --- a/docs/aws-docs/providers/aws/iam/groups_for_users/index.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: groups_for_users -hide_title: false -hide_table_of_contents: false -keywords: - - groups_for_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 ---- - - - -## Overview - - - - -
Namegroups_for_users
TypeResource
Idaws.iam.groups_for_users
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `Arn` | `string` | <p>The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.</p> <p>For more information about ARNs, go to <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>. </p> | -| `CreateDate` | `string` | The date and time, in <a href="http://www.iso.org/iso/iso8601">ISO 8601 date-time format</a>, when the group was created. | -| `GroupId` | `string` | The stable and unique string identifying the group. For more information about IDs, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">IAM identifiers</a> in the <i>IAM User Guide</i>. | -| `GroupName` | `string` | The friendly name that identifies the group. | -| `Path` | `string` | The path to the group. For more information about paths, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">IAM identifiers</a> in the <i>IAM User Guide</i>. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `groups_for_users_List` | `SELECT` | `UserName, region` | diff --git a/docs/aws-docs/providers/aws/iam/index.md b/docs/aws-docs/providers/aws/iam/index.md index fa75b7c5be..d10eec0532 100644 --- a/docs/aws-docs/providers/aws/iam/index.md +++ b/docs/aws-docs/providers/aws/iam/index.md @@ -13,95 +13,52 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- -iam - + +The iam service documentation. + :::info Service Summary
-total resources: 62
-total selectable resources: 44
-total methods: 156
+total resources: 27
+total selectable resources: 27
+total methods: 27
::: -## Overview - - - - - - -
Nameaws.iam
TypeService
Titleiam
Descriptioniam
Idiam:v24.03.00220
- ## Resources
-access_key_last_useds
-access_keys
-account_alias
-account_aliases
-account_authorization_details
-account_password_policies
-account_summaries
-assume_role_policies
-attached_group_policies
-attached_role_policies
-attached_user_policies
-client_id_from_open_id_connect_providers
-context_keys_for_custom_policies
-context_keys_for_principal_policies
-credential_reports
-custom_policies
-default_policy_versions
-entities_for_policies
+group
group_policies
+group_policy
groups
-groups_for_users
-instance_profile_tags
+instance_profile
instance_profiles
-instance_profiles_for_roles
-login_profiles
-mfa_device_tags
-mfa_devices
-open_id_connect_provider_tags
-open_id_connect_provider_thumbprints
-open_id_connect_providers
-organizations_access_reports
-
-
-passwords
+managed_policies
+managed_policy
+oidc_provider
+oidc_providers
policies
-policy_tags
-policy_versions
-principal_policies
-role_descriptions
-role_from_instance_profiles
-role_permissions_boundaries
+role
role_policies
-role_tags
-role_to_instance_profiles
+role_policy +
+
roles
-saml_provider_tags
+saml_provider
saml_providers
-security_token_service_preferences
-server_certificate_tags
+server_certificate
server_certificates
-service_last_accessed_details
-service_last_accessed_details_with_entities
-service_linked_role_deletion_status
+service_linked_role
service_linked_roles
-service_specific_credentials
-signing_certificates
-ssh_public_keys
-user_from_groups
-user_permissions_boundaries
+user
user_policies
-user_tags
-user_to_groups
+user_policy
users
-virtual_mfa_devices
-
+virtualmfa_device
+virtualmfa_devices
+ \ No newline at end of file diff --git a/docs/aws-docs/providers/aws/iam/instance_profile/index.md b/docs/aws-docs/providers/aws/iam/instance_profile/index.md new file mode 100644 index 0000000000..0fc41e0e20 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam/instance_profile/index.md @@ -0,0 +1,98 @@ +--- +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
DescriptionCreates a new instance profile. For information about instance profiles, see [Using instance profiles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html).<br/> For information about the number of instance profiles you can create, see [object quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *User Guide*.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +path, +roles, +instance_profile_name, +arn +FROM aws.iam.instance_profile +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the instance_profile resource, the following permissions are required: + +### Read +```json +iam:GetInstanceProfile +``` + +### Update +```json +iam:PassRole, +iam:RemoveRoleFromInstanceProfile, +iam:AddRoleToInstanceProfile, +iam:GetInstanceProfile +``` + +### Delete +```json +iam:GetInstanceProfile, +iam:RemoveRoleFromInstanceProfile, +iam:DeleteInstanceProfile +``` + diff --git a/docs/aws-docs/providers/aws/iam/instance_profile_tags/index.md b/docs/aws-docs/providers/aws/iam/instance_profile_tags/index.md deleted file mode 100644 index 95ba50218e..0000000000 --- a/docs/aws-docs/providers/aws/iam/instance_profile_tags/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: instance_profile_tags -hide_title: false -hide_table_of_contents: false -keywords: - - instance_profile_tags - - iam - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameinstance_profile_tags
TypeResource
Idaws.iam.instance_profile_tags
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `Key` | `string` | The key name that can be used to look up or retrieve the associated value. For example, <code>Department</code> or <code>Cost Center</code> are common choices. | -| `Value` | `string` | <p>The value associated with this tag. For example, tags with a key name of <code>Department</code> could have values such as <code>Human Resources</code>, <code>Accounting</code>, and <code>Support</code>. Tags with a key name of <code>Cost Center</code> might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values.</p> <note> <p>Amazon Web Services always interprets the tag <code>Value</code> as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.</p> </note> | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `instance_profile_tags_List` | `SELECT` | `InstanceProfileName, region` | diff --git a/docs/aws-docs/providers/aws/iam/instance_profiles/index.md b/docs/aws-docs/providers/aws/iam/instance_profiles/index.md index 648e9b4a03..61f86b3ab2 100644 --- a/docs/aws-docs/providers/aws/iam/instance_profiles/index.md +++ b/docs/aws-docs/providers/aws/iam/instance_profiles/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - instance_profiles - iam - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,23 +14,67 @@ description: Query, deploy 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
DescriptionCreates a new instance profile. For information about instance profiles, see [Using instance profiles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html).<br/> For information about the number of instance profiles you can create, see [object quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *User Guide*.
Idaws.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 -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `instance_profiles_Get` | `SELECT` | `InstanceProfileName, region` | Retrieves information about the specified instance profile, including the instance profile's path, GUID, ARN, and role. For more information about instance profiles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html">About instance profiles</a> in the <i>IAM User Guide</i>. | -| `instance_profiles_List` | `SELECT` | `region` | <p>Lists the instance profiles that have the specified path prefix. If there are none, the operation returns an empty list. For more information about instance profiles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html">About instance profiles</a>.</p> <note> <p>IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for an instance profile, see <a>GetInstanceProfile</a>.</p> </note> <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters.</p> | -| `instance_profiles_Create` | `INSERT` | `InstanceProfileName, region` | <p> Creates a new instance profile. For information about instance profiles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2.html">Using roles for applications on Amazon EC2</a> in the <i>IAM User Guide</i>, and <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html#ec2-instance-profile">Instance profiles</a> in the <i>Amazon EC2 User Guide</i>.</p> <p> For information about the number of instance profiles you can create, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html">IAM object quotas</a> in the <i>IAM User Guide</i>.</p> | -| `instance_profiles_Delete` | `DELETE` | `InstanceProfileName, region` | <p>Deletes the specified instance profile. The instance profile must not have an associated role.</p> <important> <p>Make sure that you do not have any Amazon EC2 instances running with the instance profile you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance.</p> </important> <p>For more information about instance profiles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html">About instance profiles</a>.</p> | -| `instance_profiles_Tag` | `EXEC` | `InstanceProfileName, Tags, region` | <p>Adds one or more tags to an IAM instance profile. If a tag with the same key name already exists, then that tag is overwritten with the new value.</p> <p>Each tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:</p> <ul> <li> <p> <b>Administrative grouping and discovery</b> - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name <i>Project</i> and the value <i>MyImportantProject</i>. Or search for all resources with the key name <i>Cost Center</i> and the value <i>41200</i>. </p> </li> <li> <p> <b>Access control</b> - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM instance profile that has a specified tag attached. For examples of policies that show how to use tags to control access, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Control access using IAM tags</a> in the <i>IAM User Guide</i>.</p> </li> </ul> <note> <ul> <li> <p>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. For more information about tagging, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM resources</a> in the <i>IAM User Guide</i>.</p> </li> <li> <p>Amazon Web Services always interprets the tag <code>Value</code> as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.</p> </li> </ul> </note> | -| `instance_profiles_Untag` | `EXEC` | `InstanceProfileName, TagKeys, region` | Removes the specified tags from the IAM instance profile. For more information about tagging, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM resources</a> in the <i>IAM User Guide</i>. | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +instance_profile_name +FROM aws.iam.instance_profiles + +``` + +## Permissions + +To operate on the instance_profiles resource, the following permissions are required: + +### Create +```json +iam:CreateInstanceProfile, +iam:PassRole, +iam:AddRoleToInstanceProfile, +iam:GetInstanceProfile +``` + +### List +```json +iam:ListInstanceProfiles +``` + diff --git a/docs/aws-docs/providers/aws/iam/instance_profiles_for_roles/index.md b/docs/aws-docs/providers/aws/iam/instance_profiles_for_roles/index.md deleted file mode 100644 index 586c0813d9..0000000000 --- a/docs/aws-docs/providers/aws/iam/instance_profiles_for_roles/index.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: instance_profiles_for_roles -hide_title: false -hide_table_of_contents: false -keywords: - - instance_profiles_for_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 ---- - - - -## Overview - - - - -
Nameinstance_profiles_for_roles
TypeResource
Idaws.iam.instance_profiles_for_roles
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `Arn` | `string` | <p>The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.</p> <p>For more information about ARNs, go to <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>. </p> | -| `CreateDate` | `string` | The date when the instance profile was created. | -| `InstanceProfileId` | `string` | The stable and unique string identifying the instance profile. For more information about IDs, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">IAM identifiers</a> in the <i>IAM User Guide</i>. | -| `InstanceProfileName` | `string` | The name identifying the instance profile. | -| `Path` | `string` | The path to the instance profile. For more information about paths, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">IAM identifiers</a> in the <i>IAM User Guide</i>. | -| `Roles` | `array` | <p>Contains a list of IAM roles.</p> <p>This data type is used as a response element in the <a>ListRoles</a> operation.</p> | -| `Tags` | `array` | A list of tags that are attached to the instance profile. For more information about tagging, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM resources</a> in the <i>IAM User Guide</i>. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `instance_profiles_for_roles_List` | `SELECT` | `RoleName, region` | diff --git a/docs/aws-docs/providers/aws/iam/login_profiles/index.md b/docs/aws-docs/providers/aws/iam/login_profiles/index.md deleted file mode 100644 index cf2ab6f270..0000000000 --- a/docs/aws-docs/providers/aws/iam/login_profiles/index.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: login_profiles -hide_title: false -hide_table_of_contents: false -keywords: - - login_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 ---- - - - -## Overview - - - - -
Namelogin_profiles
TypeResource
Idaws.iam.login_profiles
- -## Fields -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `login_profiles_Get` | `SELECT` | `UserName, region` | <p>Retrieves the user name for the specified IAM user. A login profile is created when you create a password for the user to access the Amazon Web Services Management Console. If the user does not exist or does not have a password, the operation returns a 404 (<code>NoSuchEntity</code>) error.</p> <p>If you create an IAM user with access to the console, the <code>CreateDate</code> reflects the date you created the initial password for the user.</p> <p>If you create an IAM user with programmatic access, and then later add a password for the user to access the Amazon Web Services Management Console, the <code>CreateDate</code> reflects the initial password creation date. A user with programmatic access does not have a login profile unless you create a password for the user to access the Amazon Web Services Management Console.</p> | -| `login_profiles_Create` | `INSERT` | `Password, UserName, region` | <p>Creates a password for the specified IAM user. A password allows an IAM user to access Amazon Web Services services through the Amazon Web Services Management Console.</p> <p>You can use the CLI, the Amazon Web Services API, or the <b>Users</b> page in the IAM console to create a password for any IAM user. Use <a>ChangePassword</a> to update your own existing password in the <b>My Security Credentials</b> page in the Amazon Web Services Management Console.</p> <p>For more information about managing passwords, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html">Managing passwords</a> in the <i>IAM User Guide</i>.</p> | -| `login_profiles_Delete` | `DELETE` | `UserName, region` | <p>Deletes the password for the specified IAM user, which terminates the user's ability to access Amazon Web Services services through the Amazon Web Services Management Console.</p> <p>You can use the CLI, the Amazon Web Services API, or the <b>Users</b> page in the IAM console to delete a password for any IAM user. You can use <a>ChangePassword</a> to update, but not delete, your own password in the <b>My Security Credentials</b> page in the Amazon Web Services Management Console.</p> <important> <p> Deleting a user's password does not prevent a user from accessing Amazon Web Services through the command line interface or the API. To prevent all user access, you must also either make any access keys inactive or delete them. For more information about making keys inactive or deleting them, see <a>UpdateAccessKey</a> and <a>DeleteAccessKey</a>. </p> </important> | -| `login_profiles_Update` | `EXEC` | `UserName, region` | <p>Changes the password for the specified IAM user. You can use the CLI, the Amazon Web Services API, or the <b>Users</b> page in the IAM console to change the password for any IAM user. Use <a>ChangePassword</a> to change your own password in the <b>My Security Credentials</b> page in the Amazon Web Services Management Console.</p> <p>For more information about modifying passwords, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html">Managing passwords</a> in the <i>IAM User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/iam/managed_policies/index.md b/docs/aws-docs/providers/aws/iam/managed_policies/index.md new file mode 100644 index 0000000000..a73afe9dbb --- /dev/null +++ b/docs/aws-docs/providers/aws/iam/managed_policies/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionCreates a new managed policy for your AWS-account.<br/> This operation creates a policy version with a version identifier of ``v1`` and sets v1 as the policy's default version. For more information about policy versions, see [Versioning for managed policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html) in the *IAM User Guide*.<br/> As a best practice, you can validate your IAM policies. To learn more, see [Validating IAM policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html) in the *IAM User Guide*.<br/> For more information about managed policies in general, see [Managed policies and inline policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*.
Idaws.iam.managed_policies
+ +## Fields + + + + + +
NameDatatypeDescription
policy_arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +policy_arn +FROM aws.iam.managed_policies + +``` + +## Permissions + +To operate on the managed_policies resource, the following permissions are required: + +### Create +```json +iam:CreatePolicy, +iam:AttachGroupPolicy, +iam:AttachUserPolicy, +iam:AttachRolePolicy +``` + +### List +```json +iam:ListPolicies +``` + diff --git a/docs/aws-docs/providers/aws/iam/managed_policy/index.md b/docs/aws-docs/providers/aws/iam/managed_policy/index.md new file mode 100644 index 0000000000..3eba0c7bd7 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam/managed_policy/index.md @@ -0,0 +1,133 @@ +--- +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
DescriptionCreates a new managed policy for your AWS-account.<br/> This operation creates a policy version with a version identifier of ``v1`` and sets v1 as the policy's default version. For more information about policy versions, see [Versioning for managed policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html) in the *IAM User Guide*.<br/> As a best practice, you can validate your IAM policies. To learn more, see [Validating IAM policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html) in the *IAM User Guide*.<br/> For more information about managed policies in general, see [Managed policies and inline policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*.
Idaws.iam.managed_policy
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
descriptionstringA friendly description of the policy.<br/> Typically used to store information about the permissions defined in the policy. For example, "Grants access to production DynamoDB tables."<br/> The policy description is immutable. After a value is assigned, it cannot be changed.
groupsarrayThe name (friendly name, not ARN) of the group to attach the policy to.<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: _+=,.@-
managed_policy_namestringThe friendly name of the policy.<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.<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"}]]}``.
pathstringThe path for the policy.<br/> 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.<br/> You cannot use an asterisk (*) in the path name.
policy_documentobjectThe JSON policy document that you want to use as the content for the new policy.<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 maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see [IAM and character quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length).<br/> To learn more about JSON policy grammar, see [Grammar of the IAM JSON policy language](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_grammar.html) in the *IAM User Guide*. <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``)
rolesarrayThe name (friendly name, not ARN) of the role to attach the policy to.<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: _+=,.@-<br/> If an external policy (such as ``AWS::IAM::Policy`` or ``AWS::IAM::ManagedPolicy``) has a ``Ref`` to a role and if a resource (such as ``AWS::ECS::Service``) also has a ``Ref`` to the same role, add a ``DependsOn`` attribute to the resource to make the resource depend on the external policy. This dependency ensures that the role's policy is available throughout the resource's lifecycle. For example, when you delete a stack with an ``AWS::ECS::Service`` resource, the ``DependsOn`` attribute ensures that CFN deletes the ``AWS::ECS::Service`` resource before deleting its role's policy.
usersarrayThe name (friendly name, not ARN) of the IAM user to attach the policy to.<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: _+=,.@-
policy_arnstring
attachment_countinteger
create_datestring
update_datestring
default_version_idstring
is_attachableboolean
permissions_boundary_usage_countinteger
policy_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.iam.managed_policy +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the managed_policy resource, the following permissions are required: + +### Read +```json +iam:GetPolicy, +iam:ListEntitiesForPolicy, +iam:GetPolicyVersion +``` + +### Update +```json +iam:DetachRolePolicy, +iam:GetPolicy, +iam:ListPolicyVersions, +iam:DetachGroupPolicy, +iam:DetachUserPolicy, +iam:CreatePolicyVersion, +iam:DeletePolicyVersion, +iam:AttachGroupPolicy, +iam:AttachUserPolicy, +iam:AttachRolePolicy +``` + +### Delete +```json +iam:DetachRolePolicy, +iam:GetPolicy, +iam:ListPolicyVersions, +iam:DetachGroupPolicy, +iam:DetachUserPolicy, +iam:DeletePolicyVersion, +iam:DeletePolicy, +iam:ListEntitiesForPolicy +``` + diff --git a/docs/aws-docs/providers/aws/iam/mfa_device_tags/index.md b/docs/aws-docs/providers/aws/iam/mfa_device_tags/index.md deleted file mode 100644 index 0928384bb6..0000000000 --- a/docs/aws-docs/providers/aws/iam/mfa_device_tags/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: mfa_device_tags -hide_title: false -hide_table_of_contents: false -keywords: - - mfa_device_tags - - iam - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namemfa_device_tags
TypeResource
Idaws.iam.mfa_device_tags
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `Key` | `string` | The key name that can be used to look up or retrieve the associated value. For example, <code>Department</code> or <code>Cost Center</code> are common choices. | -| `Value` | `string` | <p>The value associated with this tag. For example, tags with a key name of <code>Department</code> could have values such as <code>Human Resources</code>, <code>Accounting</code>, and <code>Support</code>. Tags with a key name of <code>Cost Center</code> might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values.</p> <note> <p>Amazon Web Services always interprets the tag <code>Value</code> as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.</p> </note> | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `mfa_device_tags_List` | `SELECT` | `SerialNumber, region` | diff --git a/docs/aws-docs/providers/aws/iam/mfa_devices/index.md b/docs/aws-docs/providers/aws/iam/mfa_devices/index.md deleted file mode 100644 index 492fe8f5fd..0000000000 --- a/docs/aws-docs/providers/aws/iam/mfa_devices/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: mfa_devices -hide_title: false -hide_table_of_contents: false -keywords: - - mfa_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 ---- - - - -## Overview - - - - -
Namemfa_devices
TypeResource
Idaws.iam.mfa_devices
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `EnableDate` | `string` | The date when the MFA device was enabled for the user. | -| `SerialNumber` | `string` | The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN. | -| `UserName` | `string` | The user with whom the MFA device is associated. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `mfa_devices_List` | `SELECT` | `region` | <p>Lists the MFA devices for an IAM user. If the request includes a IAM user name, then this operation lists all the MFA devices associated with the specified user. If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID signing the request for this operation.</p> <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters.</p> | -| `mfa_devices_Deactivate` | `EXEC` | `SerialNumber, UserName, region` | <p>Deactivates the specified MFA device and removes it from association with the user name for which it was originally enabled.</p> <p>For more information about creating and working with virtual MFA devices, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_VirtualMFA.html">Enabling a virtual multi-factor authentication (MFA) device</a> in the <i>IAM User Guide</i>.</p> | -| `mfa_devices_Enable` | `EXEC` | `AuthenticationCode1, AuthenticationCode2, SerialNumber, UserName, region` | Enables the specified MFA device and associates it with the specified IAM user. When enabled, the MFA device is required for every subsequent login by the IAM user associated with the device. | -| `mfa_devices_Resync` | `EXEC` | `AuthenticationCode1, AuthenticationCode2, SerialNumber, UserName, region` | <p>Synchronizes the specified MFA device with its IAM resource object on the Amazon Web Services servers.</p> <p>For more information about creating and working with virtual MFA devices, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_VirtualMFA.html">Using a virtual MFA device</a> in the <i>IAM User Guide</i>.</p> | -| `mfa_devices_Tag` | `EXEC` | `SerialNumber, Tags, region` | <p>Adds one or more tags to an IAM virtual multi-factor authentication (MFA) device. If a tag with the same key name already exists, then that tag is overwritten with the new value.</p> <p>A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:</p> <ul> <li> <p> <b>Administrative grouping and discovery</b> - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name <i>Project</i> and the value <i>MyImportantProject</i>. Or search for all resources with the key name <i>Cost Center</i> and the value <i>41200</i>. </p> </li> <li> <p> <b>Access control</b> - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM virtual MFA device that has a specified tag attached. For examples of policies that show how to use tags to control access, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Control access using IAM tags</a> in the <i>IAM User Guide</i>.</p> </li> </ul> <note> <ul> <li> <p>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. For more information about tagging, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM resources</a> in the <i>IAM User Guide</i>.</p> </li> <li> <p>Amazon Web Services always interprets the tag <code>Value</code> as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.</p> </li> </ul> </note> | -| `mfa_devices_Untag` | `EXEC` | `SerialNumber, TagKeys, region` | Removes the specified tags from the IAM virtual multi-factor authentication (MFA) device. For more information about tagging, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM resources</a> in the <i>IAM User Guide</i>. | diff --git a/docs/aws-docs/providers/aws/iam/oidc_provider/index.md b/docs/aws-docs/providers/aws/iam/oidc_provider/index.md new file mode 100644 index 0000000000..1d9c60bf22 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam/oidc_provider/index.md @@ -0,0 +1,101 @@ +--- +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
DescriptionResource Type definition for AWS::IAM::OIDCProvider
Idaws.iam.oidc_provider
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
client_id_listarray
urlstring
thumbprint_listarray
arnstringAmazon Resource Name (ARN) of the OIDC provider
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +client_id_list, +url, +thumbprint_list, +arn, +tags +FROM aws.iam.oidc_provider +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the oidc_provider resource, the following permissions are required: + +### Read +```json +iam:GetOpenIDConnectProvider +``` + +### Update +```json +iam:UpdateOpenIDConnectProviderThumbprint, +iam:RemoveClientIDFromOpenIDConnectProvider, +iam:AddClientIDToOpenIDConnectProvider, +iam:GetOpenIDConnectProvider, +iam:TagOpenIDConnectProvider, +iam:UntagOpenIDConnectProvider, +iam:ListOpenIDConnectProviderTags +``` + +### Delete +```json +iam:DeleteOpenIDConnectProvider +``` + diff --git a/docs/aws-docs/providers/aws/iam/oidc_providers/index.md b/docs/aws-docs/providers/aws/iam/oidc_providers/index.md new file mode 100644 index 0000000000..78f0e65edd --- /dev/null +++ b/docs/aws-docs/providers/aws/iam/oidc_providers/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionResource Type definition for AWS::IAM::OIDCProvider
Idaws.iam.oidc_providers
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringAmazon Resource Name (ARN) of the OIDC provider
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.iam.oidc_providers + +``` + +## Permissions + +To operate on the oidc_providers resource, the following permissions are required: + +### Create +```json +iam:CreateOpenIDConnectProvider, +iam:TagOpenIDConnectProvider, +iam:GetOpenIDConnectProvider +``` + +### List +```json +iam:ListOpenIDConnectProvider, +iam:GetOpenIDConnectProvider +``` + diff --git a/docs/aws-docs/providers/aws/iam/open_id_connect_provider_tags/index.md b/docs/aws-docs/providers/aws/iam/open_id_connect_provider_tags/index.md deleted file mode 100644 index 77884d95f9..0000000000 --- a/docs/aws-docs/providers/aws/iam/open_id_connect_provider_tags/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: open_id_connect_provider_tags -hide_title: false -hide_table_of_contents: false -keywords: - - open_id_connect_provider_tags - - iam - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameopen_id_connect_provider_tags
TypeResource
Idaws.iam.open_id_connect_provider_tags
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `Key` | `string` | The key name that can be used to look up or retrieve the associated value. For example, <code>Department</code> or <code>Cost Center</code> are common choices. | -| `Value` | `string` | <p>The value associated with this tag. For example, tags with a key name of <code>Department</code> could have values such as <code>Human Resources</code>, <code>Accounting</code>, and <code>Support</code>. Tags with a key name of <code>Cost Center</code> might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values.</p> <note> <p>Amazon Web Services always interprets the tag <code>Value</code> as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.</p> </note> | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `open_id_connect_provider_tags_List` | `SELECT` | `OpenIDConnectProviderArn, region` | diff --git a/docs/aws-docs/providers/aws/iam/open_id_connect_provider_thumbprints/index.md b/docs/aws-docs/providers/aws/iam/open_id_connect_provider_thumbprints/index.md deleted file mode 100644 index 0d5e4e6271..0000000000 --- a/docs/aws-docs/providers/aws/iam/open_id_connect_provider_thumbprints/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: open_id_connect_provider_thumbprints -hide_title: false -hide_table_of_contents: false -keywords: - - open_id_connect_provider_thumbprints - - 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 ---- - - - -## Overview - - - - -
Nameopen_id_connect_provider_thumbprints
TypeResource
Idaws.iam.open_id_connect_provider_thumbprints
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `open_id_connect_provider_thumbprints_Update` | `EXEC` | `OpenIDConnectProviderArn, ThumbprintList, region` | diff --git a/docs/aws-docs/providers/aws/iam/open_id_connect_providers/index.md b/docs/aws-docs/providers/aws/iam/open_id_connect_providers/index.md deleted file mode 100644 index 25df4b2e72..0000000000 --- a/docs/aws-docs/providers/aws/iam/open_id_connect_providers/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: open_id_connect_providers -hide_title: false -hide_table_of_contents: false -keywords: - - open_id_connect_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 ---- - - - -## Overview - - - - -
Nameopen_id_connect_providers
TypeResource
Idaws.iam.open_id_connect_providers
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `ClientIDList` | `array` | A list of client IDs (also known as audiences) that are associated with the specified IAM OIDC provider resource object. For more information, see <a>CreateOpenIDConnectProvider</a>. | -| `CreateDate` | `string` | The date and time when the IAM OIDC provider resource object was created in the Amazon Web Services account. | -| `Tags` | `array` | A list of tags that are attached to the specified IAM OIDC provider. The returned list of tags is sorted by tag key. For more information about tagging, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM resources</a> in the <i>IAM User Guide</i>. | -| `ThumbprintList` | `array` | Contains a list of thumbprints of identity provider server certificates. | -| `Url` | `string` | Contains a URL that specifies the endpoint for an OpenID Connect provider. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `open_id_connect_providers_Get` | `SELECT` | `OpenIDConnectProviderArn, region` | Returns information about the specified OpenID Connect (OIDC) provider resource object in IAM. | -| `open_id_connect_providers_List` | `SELECT` | `region` | <p>Lists information about the IAM OpenID Connect (OIDC) provider resource objects defined in the Amazon Web Services account.</p> <note> <p>IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for an OIDC provider, see <a>GetOpenIDConnectProvider</a>.</p> </note> | -| `open_id_connect_providers_Create` | `INSERT` | `ThumbprintList, Url, region` | <p>Creates an IAM entity to describe an identity provider (IdP) that supports <a href="http://openid.net/connect/">OpenID Connect (OIDC)</a>.</p> <p>The OIDC provider that you create with this operation can be used as a principal in a role's trust policy. Such a policy establishes a trust relationship between Amazon Web Services and the OIDC provider.</p> <p>If you are using an OIDC identity provider from Google, Facebook, or Amazon Cognito, you don't need to create a separate IAM identity provider. These OIDC identity providers are already built-in to Amazon Web Services and are available for your use. Instead, you can move directly to creating new roles using your identity provider. To learn more, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-idp_oidc.html">Creating a role for web identity or OpenID connect federation</a> in the <i>IAM User Guide</i>.</p> <p>When you create the IAM OIDC provider, you specify the following:</p> <ul> <li> <p>The URL of the OIDC identity provider (IdP) to trust</p> </li> <li> <p>A list of client IDs (also known as audiences) that identify the application or applications allowed to authenticate using the OIDC provider</p> </li> <li> <p>A list of thumbprints of one or more server certificates that the IdP uses</p> </li> </ul> <p>You get all of this information from the OIDC IdP you want to use to access Amazon Web Services.</p> <note> <p>Amazon Web Services secures communication with some OIDC identity providers (IdPs) through our library of trusted certificate authorities (CAs) instead of using a certificate thumbprint to verify your IdP server certificate. These OIDC IdPs include Google, and those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS) endpoint. In these cases, your legacy thumbprint remains in your configuration, but is no longer used for validation.</p> </note> <note> <p>The trust for the OIDC provider is derived from the IAM provider that this operation creates. Therefore, it is best to limit access to the <a>CreateOpenIDConnectProvider</a> operation to highly privileged users.</p> </note> | -| `open_id_connect_providers_Delete` | `DELETE` | `OpenIDConnectProviderArn, region` | <p>Deletes an OpenID Connect identity provider (IdP) resource object in IAM.</p> <p>Deleting an IAM OIDC provider resource does not update any roles that reference the provider as a principal in their trust policies. Any attempt to assume a role that references a deleted provider fails.</p> <p>This operation is idempotent; it does not fail or return an error if you call the operation for a provider that does not exist.</p> | -| `open_id_connect_providers_Tag` | `EXEC` | `OpenIDConnectProviderArn, Tags, region` | <p>Adds one or more tags to an OpenID Connect (OIDC)-compatible identity provider. For more information about these providers, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc.html">About web identity federation</a>. If a tag with the same key name already exists, then that tag is overwritten with the new value.</p> <p>A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:</p> <ul> <li> <p> <b>Administrative grouping and discovery</b> - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name <i>Project</i> and the value <i>MyImportantProject</i>. Or search for all resources with the key name <i>Cost Center</i> and the value <i>41200</i>. </p> </li> <li> <p> <b>Access control</b> - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an OIDC provider that has a specified tag attached. For examples of policies that show how to use tags to control access, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Control access using IAM tags</a> in the <i>IAM User Guide</i>.</p> </li> </ul> <note> <ul> <li> <p>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. For more information about tagging, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM resources</a> in the <i>IAM User Guide</i>.</p> </li> <li> <p>Amazon Web Services always interprets the tag <code>Value</code> as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.</p> </li> </ul> </note> | -| `open_id_connect_providers_Untag` | `EXEC` | `OpenIDConnectProviderArn, TagKeys, region` | Removes the specified tags from the specified OpenID Connect (OIDC)-compatible identity provider in IAM. For more information about OIDC providers, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc.html">About web identity federation</a>. For more information about tagging, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM resources</a> in the <i>IAM User Guide</i>. | diff --git a/docs/aws-docs/providers/aws/iam/organizations_access_reports/index.md b/docs/aws-docs/providers/aws/iam/organizations_access_reports/index.md deleted file mode 100644 index 274c3bacbe..0000000000 --- a/docs/aws-docs/providers/aws/iam/organizations_access_reports/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: organizations_access_reports -hide_title: false -hide_table_of_contents: false -keywords: - - organizations_access_reports - - 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 ---- - - - -## Overview - - - - -
Nameorganizations_access_reports
TypeResource
Idaws.iam.organizations_access_reports
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `AccessDetails` | `array` | An object that contains details about the most recent attempt to access the service. | -| `ErrorDetails` | `object` | <p>Contains information about the reason that the operation failed.</p> <p>This data type is used as a response element in the <a>GetOrganizationsAccessReport</a>, <a>GetServiceLastAccessedDetails</a>, and <a>GetServiceLastAccessedDetailsWithEntities</a> operations.</p> | -| `IsTruncated` | `boolean` | A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items. Note that IAM might return fewer than the <code>MaxItems</code> number of results even when there are more results available. We recommend that you check <code>IsTruncated</code> after every call to ensure that you receive all your results. | -| `JobCompletionDate` | `string` | <p>The date and time, in <a href="http://www.iso.org/iso/iso8601">ISO 8601 date-time format</a>, when the generated report job was completed or failed.</p> <p>This field is null if the job is still in progress, as indicated by a job status value of <code>IN_PROGRESS</code>.</p> | -| `JobCreationDate` | `string` | The date and time, in <a href="http://www.iso.org/iso/iso8601">ISO 8601 date-time format</a>, when the report job was created. | -| `JobStatus` | `string` | The status of the job. | -| `Marker` | `string` | When <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value to use for the <code>Marker</code> parameter in a subsequent pagination request. | -| `NumberOfServicesAccessible` | `integer` | The number of services that the applicable SCPs allow account principals to access. | -| `NumberOfServicesNotAccessed` | `integer` | The number of services that account principals are allowed but did not attempt to access. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `organizations_access_reports_Get` | `SELECT` | `JobId, region` | <p>Retrieves the service last accessed data report for Organizations that was previously generated using the <code> <a>GenerateOrganizationsAccessReport</a> </code> operation. This operation retrieves the status of your report job and the report contents.</p> <p>Depending on the parameters that you passed when you generated the report, the data returned could include different information. For details, see <a>GenerateOrganizationsAccessReport</a>.</p> <p>To call this operation, you must be signed in to the management account in your organization. SCPs must be enabled for your organization root. You must have permissions to perform this operation. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html">Refining permissions using service last accessed data</a> in the <i>IAM User Guide</i>.</p> <p>For each service that principals in an account (root users, IAM users, or IAM roles) could access using SCPs, the operation returns details about the most recent access attempt. If there was no attempt, the service is listed without details about the most recent attempt to access the service. If the operation fails, it returns the reason that it failed.</p> <p>By default, the list is sorted by service namespace.</p> | -| `organizations_access_reports_Generate` | `EXEC` | `EntityPath, region` | <p>Generates a report for service last accessed data for Organizations. You can generate a report for any entities (organization root, organizational unit, or account) or policies in your organization.</p> <p>To call this operation, you must be signed in using your Organizations management account credentials. You can use your long-term IAM user or root user credentials, or temporary credentials from assuming an IAM role. SCPs must be enabled for your organization root. You must have the required IAM and Organizations permissions. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html">Refining permissions using service last accessed data</a> in the <i>IAM User Guide</i>.</p> <p>You can generate a service last accessed data report for entities by specifying only the entity's path. This data includes a list of services that are allowed by any service control policies (SCPs) that apply to the entity.</p> <p>You can generate a service last accessed data report for a policy by specifying an entity's path and an optional Organizations policy ID. This data includes a list of services that are allowed by the specified SCP.</p> <p>For each service in both report types, the data includes the most recent account activity that the policy allows to account principals in the entity or the entity's children. For important information about the data, reporting period, permissions required, troubleshooting, and supported Regions see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html">Reducing permissions using service last accessed data</a> in the <i>IAM User Guide</i>.</p> <important> <p>The data includes all attempts to access Amazon Web Services, not just the successful ones. This includes all attempts that were made using the Amazon Web Services Management Console, the Amazon Web Services API through any of the SDKs, or any of the command line tools. An unexpected entry in the service last accessed data does not mean that an account has been compromised, because the request might have been denied. Refer to your CloudTrail logs as the authoritative source for information about all API calls and whether they were successful or denied access. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/cloudtrail-integration.html">Logging IAM events with CloudTrail</a> in the <i>IAM User Guide</i>.</p> </important> <p>This operation returns a <code>JobId</code>. Use this parameter in the <code> <a>GetOrganizationsAccessReport</a> </code> operation to check the status of the report generation. To check the status of this request, use the <code>JobId</code> parameter in the <code> <a>GetOrganizationsAccessReport</a> </code> operation and test the <code>JobStatus</code> response parameter. When the job is complete, you can retrieve the report.</p> <p>To generate a service last accessed data report for entities, specify an entity path without specifying the optional Organizations policy ID. The type of entity that you specify determines the data returned in the report.</p> <ul> <li> <p> <b>Root</b> – When you specify the organizations root as the entity, the resulting report lists all of the services allowed by SCPs that are attached to your root. For each service, the report includes data for all accounts in your organization except the management account, because the management account is not limited by SCPs.</p> </li> <li> <p> <b>OU</b> – When you specify an organizational unit (OU) as the entity, the resulting report lists all of the services allowed by SCPs that are attached to the OU and its parents. For each service, the report includes data for all accounts in the OU or its children. This data excludes the management account, because the management account is not limited by SCPs.</p> </li> <li> <p> <b>management account</b> – When you specify the management account, the resulting report lists all Amazon Web Services services, because the management account is not limited by SCPs. For each service, the report includes data for only the management account.</p> </li> <li> <p> <b>Account</b> – When you specify another account as the entity, the resulting report lists all of the services allowed by SCPs that are attached to the account and its parents. For each service, the report includes data for only the specified account.</p> </li> </ul> <p>To generate a service last accessed data report for policies, specify an entity path and the optional Organizations policy ID. The type of entity that you specify determines the data returned for each service.</p> <ul> <li> <p> <b>Root</b> – When you specify the root entity and a policy ID, the resulting report lists all of the services that are allowed by the specified SCP. For each service, the report includes data for all accounts in your organization to which the SCP applies. This data excludes the management account, because the management account is not limited by SCPs. If the SCP is not attached to any entities in the organization, then the report will return a list of services with no data.</p> </li> <li> <p> <b>OU</b> – When you specify an OU entity and a policy ID, the resulting report lists all of the services that are allowed by the specified SCP. For each service, the report includes data for all accounts in the OU or its children to which the SCP applies. This means that other accounts outside the OU that are affected by the SCP might not be included in the data. This data excludes the management account, because the management account is not limited by SCPs. If the SCP is not attached to the OU or one of its children, the report will return a list of services with no data.</p> </li> <li> <p> <b>management account</b> – When you specify the management account, the resulting report lists all Amazon Web Services services, because the management account is not limited by SCPs. If you specify a policy ID in the CLI or API, the policy is ignored. For each service, the report includes data for only the management account.</p> </li> <li> <p> <b>Account</b> – When you specify another account entity and a policy ID, the resulting report lists all of the services that are allowed by the specified SCP. For each service, the report includes data for only the specified account. This means that other accounts in the organization that are affected by the SCP might not be included in the data. If the SCP is not attached to the account, the report will return a list of services with no data.</p> </li> </ul> <note> <p>Service last accessed data does not use other policy types when determining whether a principal could access a service. These other policy types include identity-based policies, resource-based policies, access control lists, IAM permissions boundaries, and STS assume role policies. It only applies SCP logic. For more about the evaluation of policy types, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html#policy-eval-basics">Evaluating policies</a> in the <i>IAM User Guide</i>.</p> </note> <p>For more information about service last accessed data, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html">Reducing policy scope by viewing user activity</a> in the <i>IAM User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/iam/passwords/index.md b/docs/aws-docs/providers/aws/iam/passwords/index.md deleted file mode 100644 index d6e2d31c0a..0000000000 --- a/docs/aws-docs/providers/aws/iam/passwords/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: passwords -hide_title: false -hide_table_of_contents: false -keywords: - - passwords - - 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 ---- - - - -## Overview - - - - -
Namepasswords
TypeResource
Idaws.iam.passwords
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `passwords_Change` | `EXEC` | `NewPassword, OldPassword, region` | diff --git a/docs/aws-docs/providers/aws/iam/policies/index.md b/docs/aws-docs/providers/aws/iam/policies/index.md index 02d32d552a..5e23fc3956 100644 --- a/docs/aws-docs/providers/aws/iam/policies/index.md +++ b/docs/aws-docs/providers/aws/iam/policies/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - policies - iam - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,23 +14,72 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- - - +List of policies (requires `aws` provider to be installed) ## Overview +
Namepolicies
TypeResource
DescriptionList of policies (requires `aws` provider to be installed)
Idaws.iam.policies
## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
policy_namestringThe name for the policy
arnstringThe ARN
attachment_countnumberThe attachment count for the policy
create_datestringThe creation date for the policy
default_version_idstringThe default version id for the policy
descriptionstringThe description for the policy
is_attachablebooleanIs the policy attachable?
pathstringThe path for the policy
permissions_boundary_usage_countnumberThe permissions boundary usage count for the policy
policy_idstringThe id for the policy
tagsarrayTags for the policy
update_datestringThe update date for the policy
regionstring
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `policies_Get` | `SELECT` | `PolicyArn, region` | <p>Retrieves information about the specified managed policy, including the policy's default version and the total number of IAM users, groups, and roles to which the policy is attached. To retrieve the list of the specific users, groups, and roles that the policy is attached to, use <a>ListEntitiesForPolicy</a>. This operation returns metadata about the policy. To retrieve the actual policy document for a specific version of the policy, use <a>GetPolicyVersion</a>.</p> <p>This operation retrieves information about managed policies. To retrieve information about an inline policy that is embedded with an IAM user, group, or role, use <a>GetUserPolicy</a>, <a>GetGroupPolicy</a>, or <a>GetRolePolicy</a>.</p> <p>For more information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p> | -| `policies_List` | `SELECT` | `region` | <p>Lists all the managed policies that are available in your Amazon Web Services account, including your own customer-defined managed policies and all Amazon Web Services managed policies.</p> <p>You can filter the list of policies that is returned using the optional <code>OnlyAttached</code>, <code>Scope</code>, and <code>PathPrefix</code> parameters. For example, to list only the customer managed policies in your Amazon Web Services account, set <code>Scope</code> to <code>Local</code>. To list only Amazon Web Services managed policies, set <code>Scope</code> to <code>AWS</code>.</p> <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters.</p> <p>For more information about managed policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p> <note> <p>IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a customer manged policy, see <a>GetPolicy</a>.</p> </note> | -| `policies_Create` | `INSERT` | `PolicyDocument, PolicyName, region` | <p>Creates a new managed policy for your Amazon Web Services account.</p> <p>This operation creates a policy version with a version identifier of <code>v1</code> and sets v1 as the policy's default version. For more information about policy versions, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html">Versioning for managed policies</a> in the <i>IAM User Guide</i>.</p> <p>As a best practice, you can validate your IAM policies. To learn more, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html">Validating IAM policies</a> in the <i>IAM User Guide</i>.</p> <p>For more information about managed policies in general, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p> | -| `policies_Delete` | `DELETE` | `PolicyArn, region` | <p>Deletes the specified managed policy.</p> <p>Before you can delete a managed policy, you must first detach the policy from all users, groups, and roles that it is attached to. In addition, you must delete all the policy's versions. The following steps describe the process for deleting a managed policy:</p> <ul> <li> <p>Detach the policy from all users, groups, and roles that the policy is attached to, using <a>DetachUserPolicy</a>, <a>DetachGroupPolicy</a>, or <a>DetachRolePolicy</a>. To list all the users, groups, and roles that a policy is attached to, use <a>ListEntitiesForPolicy</a>.</p> </li> <li> <p>Delete all versions of the policy using <a>DeletePolicyVersion</a>. To list the policy's versions, use <a>ListPolicyVersions</a>. You cannot use <a>DeletePolicyVersion</a> to delete the version that is marked as the default version. You delete the policy's default version in the next step of the process.</p> </li> <li> <p>Delete the policy (this automatically deletes the policy's default version) using this operation.</p> </li> </ul> <p>For information about managed policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p> | -| `policies_Tag` | `EXEC` | `PolicyArn, Tags, region` | <p>Adds one or more tags to an IAM customer managed policy. If a tag with the same key name already exists, then that tag is overwritten with the new value.</p> <p>A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:</p> <ul> <li> <p> <b>Administrative grouping and discovery</b> - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name <i>Project</i> and the value <i>MyImportantProject</i>. Or search for all resources with the key name <i>Cost Center</i> and the value <i>41200</i>. </p> </li> <li> <p> <b>Access control</b> - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM customer managed policy that has a specified tag attached. For examples of policies that show how to use tags to control access, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Control access using IAM tags</a> in the <i>IAM User Guide</i>.</p> </li> </ul> <note> <ul> <li> <p>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. For more information about tagging, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM resources</a> in the <i>IAM User Guide</i>.</p> </li> <li> <p>Amazon Web Services always interprets the tag <code>Value</code> as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.</p> </li> </ul> </note> | -| `policies_Untag` | `EXEC` | `PolicyArn, TagKeys, region` | Removes the specified tags from the customer managed policy. For more information about tagging, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM resources</a> in the <i>IAM User Guide</i>. | + + + + + + + + + + + + +
NameAccessible byRequired Params
viewSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +policy_name, +arn, +attachment_count, +create_date, +default_version_id, +description, +is_attachable, +path, +permissions_boundary_usage_count, +policy_id, +tags, +update_date, +region +FROM aws.iam.policies + +``` + + + + diff --git a/docs/aws-docs/providers/aws/iam/policy_tags/index.md b/docs/aws-docs/providers/aws/iam/policy_tags/index.md deleted file mode 100644 index 101e2ab53c..0000000000 --- a/docs/aws-docs/providers/aws/iam/policy_tags/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: policy_tags -hide_title: false -hide_table_of_contents: false -keywords: - - policy_tags - - iam - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namepolicy_tags
TypeResource
Idaws.iam.policy_tags
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `Key` | `string` | The key name that can be used to look up or retrieve the associated value. For example, <code>Department</code> or <code>Cost Center</code> are common choices. | -| `Value` | `string` | <p>The value associated with this tag. For example, tags with a key name of <code>Department</code> could have values such as <code>Human Resources</code>, <code>Accounting</code>, and <code>Support</code>. Tags with a key name of <code>Cost Center</code> might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values.</p> <note> <p>Amazon Web Services always interprets the tag <code>Value</code> as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.</p> </note> | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `policy_tags_List` | `SELECT` | `PolicyArn, region` | diff --git a/docs/aws-docs/providers/aws/iam/policy_versions/index.md b/docs/aws-docs/providers/aws/iam/policy_versions/index.md deleted file mode 100644 index 946e90127d..0000000000 --- a/docs/aws-docs/providers/aws/iam/policy_versions/index.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: policy_versions -hide_title: false -hide_table_of_contents: false -keywords: - - policy_versions - - 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 ---- - - - -## Overview - - - - -
Namepolicy_versions
TypeResource
Idaws.iam.policy_versions
- -## Fields -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `policy_versions_Get` | `SELECT` | `PolicyArn, VersionId, region` | <p>Retrieves information about the specified version of the specified managed policy, including the policy document.</p> <note> <p>Policies returned by this operation are URL-encoded compliant with <a href="https://tools.ietf.org/html/rfc3986">RFC 3986</a>. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the <code>decode</code> method of the <code>java.net.URLDecoder</code> utility class in the Java SDK. Other languages and SDKs provide similar functionality.</p> </note> <p>To list the available versions for a policy, use <a>ListPolicyVersions</a>.</p> <p>This operation retrieves information about managed policies. To retrieve information about an inline policy that is embedded in a user, group, or role, use <a>GetUserPolicy</a>, <a>GetGroupPolicy</a>, or <a>GetRolePolicy</a>.</p> <p>For more information about the types of policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p> <p>For more information about managed policy versions, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html">Versioning for managed policies</a> in the <i>IAM User Guide</i>.</p> | -| `policy_versions_List` | `SELECT` | `PolicyArn, region` | <p>Lists information about the versions of the specified managed policy, including the version that is currently set as the policy's default version.</p> <p>For more information about managed policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p> | -| `policy_versions_Create` | `INSERT` | `PolicyArn, PolicyDocument, region` | <p>Creates a new version of the specified managed policy. To update a managed policy, you create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must delete an existing version using <a>DeletePolicyVersion</a> before you create a new version.</p> <p>Optionally, you can set the new version as the policy's default version. The default version is the version that is in effect for the IAM users, groups, and roles to which the policy is attached.</p> <p>For more information about managed policy versions, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html">Versioning for managed policies</a> in the <i>IAM User Guide</i>.</p> | -| `policy_versions_Delete` | `DELETE` | `PolicyArn, VersionId, region` | <p>Deletes the specified version from the specified managed policy.</p> <p>You cannot delete the default version from a policy using this operation. To delete the default version from a policy, use <a>DeletePolicy</a>. To find out which version of a policy is marked as the default version, use <a>ListPolicyVersions</a>.</p> <p>For information about versions for managed policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html">Versioning for managed policies</a> in the <i>IAM User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/iam/principal_policies/index.md b/docs/aws-docs/providers/aws/iam/principal_policies/index.md deleted file mode 100644 index 484ed0c505..0000000000 --- a/docs/aws-docs/providers/aws/iam/principal_policies/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: principal_policies -hide_title: false -hide_table_of_contents: false -keywords: - - principal_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 ---- - - - -## Overview - - - - -
Nameprincipal_policies
TypeResource
Idaws.iam.principal_policies
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `principal_policies_Simulate` | `EXEC` | `ActionNames, PolicySourceArn, region` | diff --git a/docs/aws-docs/providers/aws/iam/role/index.md b/docs/aws-docs/providers/aws/iam/role/index.md new file mode 100644 index 0000000000..3a642ac0c4 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam/role/index.md @@ -0,0 +1,127 @@ +--- +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
DescriptionCreates a new role for your AWS-account.<br/> For more information about roles, see [IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) in the *IAM User Guide*. For information about quotas for role names and the number of roles you can create, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.iam.role +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the role resource, the following permissions are required: + +### Read +```json +iam:GetRole, +iam:ListAttachedRolePolicies, +iam:ListRolePolicies, +iam:GetRolePolicy +``` + +### Update +```json +iam:UpdateRole, +iam:UpdateRoleDescription, +iam:UpdateAssumeRolePolicy, +iam:DetachRolePolicy, +iam:AttachRolePolicy, +iam:DeleteRolePermissionsBoundary, +iam:PutRolePermissionsBoundary, +iam:DeleteRolePolicy, +iam:PutRolePolicy, +iam:TagRole, +iam:UntagRole +``` + +### Delete +```json +iam:DeleteRole, +iam:DetachRolePolicy, +iam:DeleteRolePolicy, +iam:GetRole, +iam:ListAttachedRolePolicies, +iam:ListRolePolicies, +iam:TagRole, +iam:UntagRole +``` + diff --git a/docs/aws-docs/providers/aws/iam/role_descriptions/index.md b/docs/aws-docs/providers/aws/iam/role_descriptions/index.md deleted file mode 100644 index 2c9b249836..0000000000 --- a/docs/aws-docs/providers/aws/iam/role_descriptions/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: role_descriptions -hide_title: false -hide_table_of_contents: false -keywords: - - role_descriptions - - 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 ---- - - - -## Overview - - - - -
Namerole_descriptions
TypeResource
Idaws.iam.role_descriptions
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `role_descriptions_Update` | `EXEC` | `Description, RoleName, region` | diff --git a/docs/aws-docs/providers/aws/iam/role_from_instance_profiles/index.md b/docs/aws-docs/providers/aws/iam/role_from_instance_profiles/index.md deleted file mode 100644 index c68b81be23..0000000000 --- a/docs/aws-docs/providers/aws/iam/role_from_instance_profiles/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: role_from_instance_profiles -hide_title: false -hide_table_of_contents: false -keywords: - - role_from_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 ---- - - - -## Overview - - - - -
Namerole_from_instance_profiles
TypeResource
Idaws.iam.role_from_instance_profiles
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `role_from_instance_profiles_Remove` | `EXEC` | `InstanceProfileName, RoleName, region` | diff --git a/docs/aws-docs/providers/aws/iam/role_permissions_boundaries/index.md b/docs/aws-docs/providers/aws/iam/role_permissions_boundaries/index.md deleted file mode 100644 index 1b7181d06e..0000000000 --- a/docs/aws-docs/providers/aws/iam/role_permissions_boundaries/index.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: role_permissions_boundaries -hide_title: false -hide_table_of_contents: false -keywords: - - role_permissions_boundaries - - 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 ---- - - - -## Overview - - - - -
Namerole_permissions_boundaries
TypeResource
Idaws.iam.role_permissions_boundaries
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `role_permissions_boundaries_Delete` | `DELETE` | `RoleName, region` | <p>Deletes the permissions boundary for the specified IAM role. </p> <important> <p>Deleting the permissions boundary for a role might increase its permissions. For example, it might allow anyone who assumes the role to perform all the actions granted in its permissions policies. </p> </important> | -| `role_permissions_boundaries_Put` | `EXEC` | `PermissionsBoundary, RoleName, region` | <p>Adds or updates the policy that is specified as the IAM role's permissions boundary. You can use an Amazon Web Services managed policy or a customer managed policy to set the boundary for a role. Use the boundary to control the maximum permissions that the role can have. Setting a permissions boundary is an advanced feature that can affect the permissions for the role.</p> <p>You cannot set the boundary for a service-linked role. </p> <important> <p>Policies used as permissions boundaries do not provide permissions. You must also attach a permissions policy to the role. To learn how the effective permissions for a role are evaluated, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html">IAM JSON policy evaluation logic</a> in the IAM User Guide. </p> </important> | diff --git a/docs/aws-docs/providers/aws/iam/role_policies/index.md b/docs/aws-docs/providers/aws/iam/role_policies/index.md index 608c3b8de3..8948802938 100644 --- a/docs/aws-docs/providers/aws/iam/role_policies/index.md +++ b/docs/aws-docs/providers/aws/iam/role_policies/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - role_policies - iam - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,28 +14,54 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- - - +List of policies by RoleName (requires `aws` provider to be installed) ## Overview +
Namerole_policies
TypeResource
DescriptionList of policies by RoleName (requires `aws` provider to be installed)
Idaws.iam.role_policies
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `PolicyDocument` | `string` | <p>The policy document.</p> <p>IAM stores policies in JSON format. However, resources that were created using CloudFormation templates can be formatted in YAML. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.</p> | -| `PolicyName` | `string` | The name of the policy. | -| `RoleName` | `string` | The role the policy is associated with. | + + + + + + + + +
NameDatatypeDescription
role_namestringThe IAM role name
policy_namestringThe role policy name
policy_documentstringThe role policy document
regionstring
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `role_policies_Get` | `SELECT` | `PolicyName, RoleName, region` | <p>Retrieves the specified inline policy document that is embedded with the specified IAM role.</p> <note> <p>Policies returned by this operation are URL-encoded compliant with <a href="https://tools.ietf.org/html/rfc3986">RFC 3986</a>. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the <code>decode</code> method of the <code>java.net.URLDecoder</code> utility class in the Java SDK. Other languages and SDKs provide similar functionality.</p> </note> <p>An IAM role can also have managed policies attached to it. To retrieve a managed policy document that is attached to a role, use <a>GetPolicy</a> to determine the policy's default version, then use <a>GetPolicyVersion</a> to retrieve the policy document.</p> <p>For more information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p> <p>For more information about roles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html">Using roles to delegate permissions and federate identities</a>.</p> | -| `role_policies_List` | `SELECT` | `RoleName, region` | <p>Lists the names of the inline policies that are embedded in the specified IAM role.</p> <p>An IAM role can also have managed policies attached to it. To list the managed policies that are attached to a role, use <a>ListAttachedRolePolicies</a>. For more information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p> <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. If there are no inline policies embedded with the specified role, the operation returns an empty list.</p> | -| `role_policies_Delete` | `DELETE` | `PolicyName, RoleName, region` | <p>Deletes the specified inline policy that is embedded in the specified IAM role.</p> <p>A role can also have managed policies attached to it. To detach a managed policy from a role, use <a>DetachRolePolicy</a>. For more information about policies, refer to <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p> | -| `role_policies_Attach` | `EXEC` | `PolicyArn, RoleName, region` | <p>Attaches the specified managed policy to the specified IAM role. When you attach a managed policy to a role, the managed policy becomes part of the role's permission (access) policy.</p> <note> <p>You cannot use a managed policy as the role's trust policy. The role's trust policy is created at the same time as the role, using <a>CreateRole</a>. You can update a role's trust policy using <a>UpdateAssumeRolePolicy</a>.</p> </note> <p>Use this operation to attach a <i>managed</i> policy to a role. To embed an inline policy in a role, use <a>PutRolePolicy</a>. For more information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p> <p>As a best practice, you can validate your IAM policies. To learn more, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html">Validating IAM policies</a> in the <i>IAM User Guide</i>.</p> | -| `role_policies_Detach` | `EXEC` | `PolicyArn, RoleName, region` | <p>Removes the specified managed policy from the specified role.</p> <p>A role can also have inline policies embedded with it. To delete an inline policy, use <a>DeleteRolePolicy</a>. For information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p> | -| `role_policies_Put` | `EXEC` | `PolicyDocument, PolicyName, RoleName, region` | <p>Adds or updates an inline policy document that is embedded in the specified IAM role.</p> <p>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, using <a>CreateRole</a>. You can update a role's trust policy using <a>UpdateAssumeRolePolicy</a>. For more information about IAM roles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html">Using roles to delegate permissions and federate identities</a>.</p> <p>A role can also have a managed policy attached to it. To attach a managed policy to a role, use <a>AttachRolePolicy</a>. To create a new managed policy, use <a>CreatePolicy</a>. For information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p> <p>For information about the maximum number of inline policies that you can embed with a role, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html">IAM and STS quotas</a> in the <i>IAM User Guide</i>.</p> <note> <p>Because policy documents can be large, you should use POST rather than GET when calling <code>PutRolePolicy</code>. For general information about using the Query API with IAM, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html">Making query requests</a> in the <i>IAM User Guide</i>.</p> </note> | + + + + + + + + + + + + +
NameAccessible byRequired Params
viewSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +role_name, +policy_name, +policy_document, +region +FROM aws.iam.role_policies +WHERE RoleName = ''; +``` + + + + diff --git a/docs/aws-docs/providers/aws/iam/role_policy/index.md b/docs/aws-docs/providers/aws/iam/role_policy/index.md new file mode 100644 index 0000000000..d0b521a140 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam/role_policy/index.md @@ -0,0 +1,93 @@ +--- +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
DescriptionAdds 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, using [CreateRole](https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html). You can update a role's trust policy using [UpdateAssumeRolePolicy](https://docs.aws.amazon.com/IAM/latest/APIReference/API_UpdateAssumeRolePolicy.html). For information about roles, see [roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html) in the *IAM User Guide*.<br/> A role can also have a managed policy attached to it. To attach a managed policy to a role, use [AWS::IAM::Role](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html). To create a new managed policy, use [AWS::IAM::ManagedPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html). 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 *IAM User Guide*.<br/> For information about the maximum number of inline policies that you can embed with a role, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +policy_document, +policy_name, +role_name +FROM aws.iam.role_policy +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the role_policy resource, the following permissions are required: + +### Read +```json +iam:GetRolePolicy +``` + +### Update +```json +iam:PutRolePolicy, +iam:GetRolePolicy +``` + +### Delete +```json +iam:DeleteRolePolicy, +iam:GetRolePolicy +``` + diff --git a/docs/aws-docs/providers/aws/iam/role_tags/index.md b/docs/aws-docs/providers/aws/iam/role_tags/index.md deleted file mode 100644 index 1951dc4046..0000000000 --- a/docs/aws-docs/providers/aws/iam/role_tags/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: role_tags -hide_title: false -hide_table_of_contents: false -keywords: - - role_tags - - iam - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namerole_tags
TypeResource
Idaws.iam.role_tags
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `Key` | `string` | The key name that can be used to look up or retrieve the associated value. For example, <code>Department</code> or <code>Cost Center</code> are common choices. | -| `Value` | `string` | <p>The value associated with this tag. For example, tags with a key name of <code>Department</code> could have values such as <code>Human Resources</code>, <code>Accounting</code>, and <code>Support</code>. Tags with a key name of <code>Cost Center</code> might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values.</p> <note> <p>Amazon Web Services always interprets the tag <code>Value</code> as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.</p> </note> | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `role_tags_List` | `SELECT` | `RoleName, region` | diff --git a/docs/aws-docs/providers/aws/iam/role_to_instance_profiles/index.md b/docs/aws-docs/providers/aws/iam/role_to_instance_profiles/index.md deleted file mode 100644 index aefcf0ac31..0000000000 --- a/docs/aws-docs/providers/aws/iam/role_to_instance_profiles/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: role_to_instance_profiles -hide_title: false -hide_table_of_contents: false -keywords: - - role_to_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 ---- - - - -## Overview - - - - -
Namerole_to_instance_profiles
TypeResource
Idaws.iam.role_to_instance_profiles
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `role_to_instance_profiles_Add` | `EXEC` | `InstanceProfileName, RoleName, region` | diff --git a/docs/aws-docs/providers/aws/iam/roles/index.md b/docs/aws-docs/providers/aws/iam/roles/index.md index aa2f932167..3347b353e9 100644 --- a/docs/aws-docs/providers/aws/iam/roles/index.md +++ b/docs/aws-docs/providers/aws/iam/roles/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - roles - iam - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,37 +14,70 @@ description: Query, deploy 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
DescriptionCreates a new role for your AWS-account.<br/> For more information about roles, see [IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) in the *IAM User Guide*. For information about quotas for role names and the number of roles you can create, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*.
Idaws.iam.roles
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `Arn` | `string` | <p>The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.</p> <p>For more information about ARNs, go to <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>. </p> | -| `AssumeRolePolicyDocument` | `string` | The policy that grants an entity permission to assume the role. | -| `CreateDate` | `string` | The date and time, in <a href="http://www.iso.org/iso/iso8601">ISO 8601 date-time format</a>, when the role was created. | -| `Description` | `string` | A description of the role that you provide. | -| `MaxSessionDuration` | `integer` | The maximum session duration (in seconds) for the specified role. Anyone who uses the CLI, or API to assume the role can specify the duration using the optional <code>DurationSeconds</code> API parameter or <code>duration-seconds</code> CLI parameter. | -| `Path` | `string` | The path to the role. For more information about paths, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">IAM identifiers</a> in the <i>IAM User Guide</i>. | -| `PermissionsBoundary` | `object` | <p>Contains information about an attached permissions boundary.</p> <p>An attached permissions boundary is a managed policy that has been attached to a user or role to set the permissions boundary.</p> <p>For more information about permissions boundaries, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html">Permissions boundaries for IAM identities </a> in the <i>IAM User Guide</i>.</p> | -| `RoleId` | `string` | The stable and unique string identifying the role. For more information about IDs, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">IAM identifiers</a> in the <i>IAM User Guide</i>. | -| `RoleLastUsed` | `object` | <p>Contains information about the last time that an IAM role was used. This includes the date and time and the Region in which the role was last used. Activity is only reported for the trailing 400 days. This period can be shorter if your Region began supporting these features within the last year. The role might have been used more than 400 days ago. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#access-advisor_tracking-period">Regions where data is tracked</a> in the <i>IAM User Guide</i>.</p> <p>This data type is returned as a response element in the <a>GetRole</a> and <a>GetAccountAuthorizationDetails</a> operations.</p> | -| `RoleName` | `string` | The friendly name that identifies the role. | -| `Tags` | `array` | A list of tags that are attached to the role. For more information about tagging, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM resources</a> in the <i>IAM User Guide</i>. | + + + + + +
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 -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `roles_Get` | `SELECT` | `RoleName, region` | <p>Retrieves information about the specified role, including the role's path, GUID, ARN, and the role's trust policy that grants permission to assume the role. For more information about roles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html">Working with roles</a>.</p> <note> <p>Policies returned by this operation are URL-encoded compliant with <a href="https://tools.ietf.org/html/rfc3986">RFC 3986</a>. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the <code>decode</code> method of the <code>java.net.URLDecoder</code> utility class in the Java SDK. Other languages and SDKs provide similar functionality.</p> </note> | -| `roles_List` | `SELECT` | `region` | <p>Lists the IAM roles that have the specified path prefix. If there are none, the operation returns an empty list. For more information about roles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html">Working with roles</a>.</p> <note> <p>IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a role, see <a>GetRole</a>.</p> </note> <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters.</p> | -| `roles_Create` | `INSERT` | `AssumeRolePolicyDocument, RoleName, region` | Creates a new role for your Amazon Web Services account. For more information about roles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html">IAM roles</a>. For information about quotas for role names and the number of roles you can create, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html">IAM and STS quotas</a> in the <i>IAM User Guide</i>. | -| `roles_Delete` | `DELETE` | `RoleName, region` | <p>Deletes the specified role. The role must not have any policies attached. For more information about roles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html">Working with roles</a>.</p> <important> <p>Make sure that you do not have any Amazon EC2 instances running with the role you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance.</p> </important> | -| `roles_Tag` | `EXEC` | `RoleName, Tags, region` | <p>Adds one or more tags to an IAM role. The role can be a regular role or a service-linked role. If a tag with the same key name already exists, then that tag is overwritten with the new value.</p> <p>A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:</p> <ul> <li> <p> <b>Administrative grouping and discovery</b> - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name <i>Project</i> and the value <i>MyImportantProject</i>. Or search for all resources with the key name <i>Cost Center</i> and the value <i>41200</i>. </p> </li> <li> <p> <b>Access control</b> - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM role that has a specified tag attached. You can also restrict access to only those resources that have a certain tag attached. For examples of policies that show how to use tags to control access, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Control access using IAM tags</a> in the <i>IAM User Guide</i>.</p> </li> <li> <p> <b>Cost allocation</b> - Use tags to help track which individuals and teams are using which Amazon Web Services resources.</p> </li> </ul> <note> <ul> <li> <p>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. For more information about tagging, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM resources</a> in the <i>IAM User Guide</i>.</p> </li> <li> <p>Amazon Web Services always interprets the tag <code>Value</code> as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.</p> </li> </ul> </note> <p>For more information about tagging, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM identities</a> in the <i>IAM User Guide</i>.</p> | -| `roles_Untag` | `EXEC` | `RoleName, TagKeys, region` | Removes the specified tags from the role. For more information about tagging, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM resources</a> in the <i>IAM User Guide</i>. | -| `roles_Update` | `EXEC` | `RoleName, region` | Updates the description or maximum session duration setting of a role. | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +role_name +FROM aws.iam.roles + +``` + +## Permissions + +To operate on the roles resource, the following permissions are required: + +### Create +```json +iam:CreateRole, +iam:PutRolePolicy, +iam:AttachRolePolicy, +iam:GetRolePolicy, +iam:TagRole, +iam:UntagRole, +iam:GetRole +``` + +### List +```json +iam:ListRoles +``` + diff --git a/docs/aws-docs/providers/aws/iam/saml_provider/index.md b/docs/aws-docs/providers/aws/iam/saml_provider/index.md new file mode 100644 index 0000000000..3cc60b150a --- /dev/null +++ b/docs/aws-docs/providers/aws/iam/saml_provider/index.md @@ -0,0 +1,97 @@ +--- +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
DescriptionResource Type definition for AWS::IAM::SAMLProvider
Idaws.iam.saml_provider
+ +## Fields + + + + + + + + +
NameDatatypeDescription
namestring
saml_metadata_documentstring
arnstringAmazon Resource Name (ARN) of the SAML provider
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +saml_metadata_document, +arn, +tags +FROM aws.iam.saml_provider +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the saml_provider resource, the following permissions are required: + +### Read +```json +iam:GetSAMLProvider +``` + +### Update +```json +iam:UpdateSAMLProvider, +iam:GetSAMLProvider, +iam:TagSAMLProvider, +iam:ListSAMLProviderTags, +iam:UntagSAMLProvider +``` + +### Delete +```json +iam:DeleteSAMLProvider +``` + diff --git a/docs/aws-docs/providers/aws/iam/saml_provider_tags/index.md b/docs/aws-docs/providers/aws/iam/saml_provider_tags/index.md deleted file mode 100644 index de3a9d06ba..0000000000 --- a/docs/aws-docs/providers/aws/iam/saml_provider_tags/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: saml_provider_tags -hide_title: false -hide_table_of_contents: false -keywords: - - saml_provider_tags - - iam - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Namesaml_provider_tags
TypeResource
Idaws.iam.saml_provider_tags
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `Key` | `string` | The key name that can be used to look up or retrieve the associated value. For example, <code>Department</code> or <code>Cost Center</code> are common choices. | -| `Value` | `string` | <p>The value associated with this tag. For example, tags with a key name of <code>Department</code> could have values such as <code>Human Resources</code>, <code>Accounting</code>, and <code>Support</code>. Tags with a key name of <code>Cost Center</code> might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values.</p> <note> <p>Amazon Web Services always interprets the tag <code>Value</code> as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.</p> </note> | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `saml_provider_tags_List` | `SELECT` | `SAMLProviderArn, region` | diff --git a/docs/aws-docs/providers/aws/iam/saml_providers/index.md b/docs/aws-docs/providers/aws/iam/saml_providers/index.md index 32e687de22..49e61c0ae6 100644 --- a/docs/aws-docs/providers/aws/iam/saml_providers/index.md +++ b/docs/aws-docs/providers/aws/iam/saml_providers/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - saml_providers - iam - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,30 +14,67 @@ description: Query, deploy 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
DescriptionResource Type definition for AWS::IAM::SAMLProvider
Idaws.iam.saml_providers
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `CreateDate` | `string` | The date and time when the SAML provider was created. | -| `SAMLMetadataDocument` | `string` | The XML metadata document that includes information about an identity provider. | -| `Tags` | `array` | A list of tags that are attached to the specified IAM SAML provider. The returned list of tags is sorted by tag key. For more information about tagging, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM resources</a> in the <i>IAM User Guide</i>. | -| `ValidUntil` | `string` | The expiration date and time for the SAML provider. | + + + + + +
NameDatatypeDescription
arnstringAmazon Resource Name (ARN) of the SAML provider
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `saml_providers_Get` | `SELECT` | `SAMLProviderArn, region` | <p>Returns the SAML provider metadocument that was uploaded when the IAM SAML provider resource object was created or updated.</p> <note> <p>This operation requires <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4</a>.</p> </note> | -| `saml_providers_List` | `SELECT` | `region` | <p>Lists the SAML provider resource objects defined in IAM in the account. IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a SAML provider, see <a>GetSAMLProvider</a>.</p> <important> <p> This operation requires <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4</a>.</p> </important> | -| `saml_providers_Create` | `INSERT` | `Name, SAMLMetadataDocument, region` | <p>Creates an IAM resource that describes an identity provider (IdP) that supports SAML 2.0.</p> <p>The SAML provider resource that you create with this operation can be used as a principal in an IAM role's trust policy. Such a policy can enable federated users who sign in using the SAML IdP to assume the role. You can create an IAM role that supports Web-based single sign-on (SSO) to the Amazon Web Services Management Console or one that supports API access to Amazon Web Services.</p> <p>When you create the SAML provider resource, you upload a SAML metadata document that you get from your IdP. That document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that the IdP sends. You must generate the metadata document using the identity management software that is used as your organization's IdP.</p> <note> <p> This operation requires <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4</a>.</p> </note> <p> For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-saml.html">Enabling SAML 2.0 federated users to access the Amazon Web Services Management Console</a> and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html">About SAML 2.0-based federation</a> in the <i>IAM User Guide</i>.</p> | -| `saml_providers_Delete` | `DELETE` | `SAMLProviderArn, region` | <p>Deletes a SAML provider resource in IAM.</p> <p>Deleting the provider resource from IAM does not update any roles that reference the SAML provider resource's ARN as a principal in their trust policies. Any attempt to assume a role that references a non-existent provider resource ARN fails.</p> <note> <p> This operation requires <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4</a>.</p> </note> | -| `saml_providers_Tag` | `EXEC` | `SAMLProviderArn, Tags, region` | <p>Adds one or more tags to a Security Assertion Markup Language (SAML) identity provider. For more information about these providers, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html">About SAML 2.0-based federation </a>. If a tag with the same key name already exists, then that tag is overwritten with the new value.</p> <p>A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:</p> <ul> <li> <p> <b>Administrative grouping and discovery</b> - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name <i>Project</i> and the value <i>MyImportantProject</i>. Or search for all resources with the key name <i>Cost Center</i> and the value <i>41200</i>. </p> </li> <li> <p> <b>Access control</b> - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only a SAML identity provider that has a specified tag attached. For examples of policies that show how to use tags to control access, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Control access using IAM tags</a> in the <i>IAM User Guide</i>.</p> </li> </ul> <note> <ul> <li> <p>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. For more information about tagging, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM resources</a> in the <i>IAM User Guide</i>.</p> </li> <li> <p>Amazon Web Services always interprets the tag <code>Value</code> as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.</p> </li> </ul> </note> | -| `saml_providers_Untag` | `EXEC` | `SAMLProviderArn, TagKeys, region` | Removes the specified tags from the specified Security Assertion Markup Language (SAML) identity provider in IAM. For more information about these providers, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc.html">About web identity federation</a>. For more information about tagging, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM resources</a> in the <i>IAM User Guide</i>. | -| `saml_providers_Update` | `EXEC` | `SAMLMetadataDocument, SAMLProviderArn, region` | <p>Updates the metadata document for an existing SAML provider resource object.</p> <note> <p>This operation requires <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4</a>.</p> </note> | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.iam.saml_providers + +``` + +## Permissions + +To operate on the saml_providers resource, the following permissions are required: + +### Create +```json +iam:CreateSAMLProvider, +iam:GetSAMLProvider, +iam:TagSAMLProvider +``` + +### List +```json +iam:ListSAMLProviders, +iam:GetSAMLProvider +``` + diff --git a/docs/aws-docs/providers/aws/iam/security_token_service_preferences/index.md b/docs/aws-docs/providers/aws/iam/security_token_service_preferences/index.md deleted file mode 100644 index d41fc278cb..0000000000 --- a/docs/aws-docs/providers/aws/iam/security_token_service_preferences/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: security_token_service_preferences -hide_title: false -hide_table_of_contents: false -keywords: - - security_token_service_preferences - - 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 ---- - - - -## Overview - - - - -
Namesecurity_token_service_preferences
TypeResource
Idaws.iam.security_token_service_preferences
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `security_token_service_preferences_Set` | `EXEC` | `GlobalEndpointTokenVersion, region` | diff --git a/docs/aws-docs/providers/aws/iam/server_certificate/index.md b/docs/aws-docs/providers/aws/iam/server_certificate/index.md new file mode 100644 index 0000000000..c789232519 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam/server_certificate/index.md @@ -0,0 +1,102 @@ +--- +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
DescriptionResource Type definition for AWS::IAM::ServerCertificate
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +certificate_body, +certificate_chain, +server_certificate_name, +path, +private_key, +arn, +tags +FROM aws.iam.server_certificate +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the server_certificate resource, the following permissions are required: + +### Read +```json +iam:GetServerCertificate +``` + +### Update +```json +iam:TagServerCertificate, +iam:UntagServerCertificate, +iam:ListServerCertificateTags, +iam:GetServerCertificate +``` + +### Delete +```json +iam:DeleteServerCertificate +``` + diff --git a/docs/aws-docs/providers/aws/iam/server_certificate_tags/index.md b/docs/aws-docs/providers/aws/iam/server_certificate_tags/index.md deleted file mode 100644 index 616bded278..0000000000 --- a/docs/aws-docs/providers/aws/iam/server_certificate_tags/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: server_certificate_tags -hide_title: false -hide_table_of_contents: false -keywords: - - server_certificate_tags - - iam - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameserver_certificate_tags
TypeResource
Idaws.iam.server_certificate_tags
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `Key` | `string` | The key name that can be used to look up or retrieve the associated value. For example, <code>Department</code> or <code>Cost Center</code> are common choices. | -| `Value` | `string` | <p>The value associated with this tag. For example, tags with a key name of <code>Department</code> could have values such as <code>Human Resources</code>, <code>Accounting</code>, and <code>Support</code>. Tags with a key name of <code>Cost Center</code> might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values.</p> <note> <p>Amazon Web Services always interprets the tag <code>Value</code> as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.</p> </note> | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `server_certificate_tags_List` | `SELECT` | `ServerCertificateName, region` | diff --git a/docs/aws-docs/providers/aws/iam/server_certificates/index.md b/docs/aws-docs/providers/aws/iam/server_certificates/index.md index 2dbb9727e5..7e06e616d8 100644 --- a/docs/aws-docs/providers/aws/iam/server_certificates/index.md +++ b/docs/aws-docs/providers/aws/iam/server_certificates/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - server_certificates - iam - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,24 +14,67 @@ description: Query, deploy 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
DescriptionResource Type definition for AWS::IAM::ServerCertificate
Idaws.iam.server_certificates
## Fields + + + + + +
NameDatatypeDescription
server_certificate_namestring
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `server_certificates_Get` | `SELECT` | `ServerCertificateName, region` | <p>Retrieves information about the specified server certificate stored in IAM.</p> <p>For more information about working with server certificates, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html">Working with server certificates</a> in the <i>IAM User Guide</i>. This topic includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.</p> | -| `server_certificates_List` | `SELECT` | `region` | <p>Lists the server certificates stored in IAM that have the specified path prefix. If none exist, the operation returns an empty list.</p> <p> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters.</p> <p>For more information about working with server certificates, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html">Working with server certificates</a> in the <i>IAM User Guide</i>. This topic also includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.</p> <note> <p>IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a servercertificate, see <a>GetServerCertificate</a>.</p> </note> | -| `server_certificates_Delete` | `DELETE` | `ServerCertificateName, region` | <p>Deletes the specified server certificate.</p> <p>For more information about working with server certificates, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html">Working with server certificates</a> in the <i>IAM User Guide</i>. This topic also includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.</p> <important> <p> If you are using a server certificate with Elastic Load Balancing, deleting the certificate could have implications for your application. If Elastic Load Balancing doesn't detect the deletion of bound certificates, it may continue to use the certificates. This could cause Elastic Load Balancing to stop accepting traffic. We recommend that you remove the reference to the certificate from Elastic Load Balancing before using this command to delete the certificate. For more information, see <a href="https://docs.aws.amazon.com/ElasticLoadBalancing/latest/APIReference/API_DeleteLoadBalancerListeners.html">DeleteLoadBalancerListeners</a> in the <i>Elastic Load Balancing API Reference</i>.</p> </important> | -| `server_certificates_Tag` | `EXEC` | `ServerCertificateName, Tags, region` | <p>Adds one or more tags to an IAM server certificate. If a tag with the same key name already exists, then that tag is overwritten with the new value.</p> <note> <p>For certificates in a Region supported by Certificate Manager (ACM), we recommend that you don't use IAM server certificates. Instead, use ACM to provision, manage, and deploy your server certificates. For more information about IAM server certificates, <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html">Working with server certificates</a> in the <i>IAM User Guide</i>.</p> </note> <p>A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:</p> <ul> <li> <p> <b>Administrative grouping and discovery</b> - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name <i>Project</i> and the value <i>MyImportantProject</i>. Or search for all resources with the key name <i>Cost Center</i> and the value <i>41200</i>. </p> </li> <li> <p> <b>Access control</b> - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only a server certificate that has a specified tag attached. For examples of policies that show how to use tags to control access, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Control access using IAM tags</a> in the <i>IAM User Guide</i>.</p> </li> <li> <p> <b>Cost allocation</b> - Use tags to help track which individuals and teams are using which Amazon Web Services resources.</p> </li> </ul> <note> <ul> <li> <p>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. For more information about tagging, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM resources</a> in the <i>IAM User Guide</i>.</p> </li> <li> <p>Amazon Web Services always interprets the tag <code>Value</code> as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.</p> </li> </ul> </note> | -| `server_certificates_Untag` | `EXEC` | `ServerCertificateName, TagKeys, region` | <p>Removes the specified tags from the IAM server certificate. For more information about tagging, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM resources</a> in the <i>IAM User Guide</i>.</p> <note> <p>For certificates in a Region supported by Certificate Manager (ACM), we recommend that you don't use IAM server certificates. Instead, use ACM to provision, manage, and deploy your server certificates. For more information about IAM server certificates, <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html">Working with server certificates</a> in the <i>IAM User Guide</i>.</p> </note> | -| `server_certificates_Update` | `EXEC` | `ServerCertificateName, region` | <p>Updates the name and/or the path of the specified server certificate stored in IAM.</p> <p>For more information about working with server certificates, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html">Working with server certificates</a> in the <i>IAM User Guide</i>. This topic also includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.</p> <important> <p>You should understand the implications of changing a server certificate's path or name. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs_manage.html#RenamingServerCerts">Renaming a server certificate</a> in the <i>IAM User Guide</i>.</p> </important> <note> <p>The person making the request (the principal), must have permission to change the server certificate with the old name and the new name. For example, to change the certificate named <code>ProductionCert</code> to <code>ProdCert</code>, the principal must have a policy that allows them to update both certificates. If the principal has permission to update the <code>ProductionCert</code> group, but not the <code>ProdCert</code> certificate, then the update fails. For more information about permissions, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html">Access management</a> in the <i>IAM User Guide</i>.</p> </note> | -| `server_certificates_Upload` | `EXEC` | `CertificateBody, PrivateKey, ServerCertificateName, region` | <p>Uploads a server certificate entity for the Amazon Web Services account. The server certificate entity includes a public key certificate, a private key, and an optional certificate chain, which should all be PEM-encoded.</p> <p>We recommend that you use <a href="https://docs.aws.amazon.com/acm/">Certificate Manager</a> to provision, manage, and deploy your server certificates. With ACM you can request a certificate, deploy it to Amazon Web Services resources, and let ACM handle certificate renewals for you. Certificates provided by ACM are free. For more information about using ACM, see the <a href="https://docs.aws.amazon.com/acm/latest/userguide/">Certificate Manager User Guide</a>.</p> <p>For more information about working with server certificates, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html">Working with server certificates</a> in the <i>IAM User Guide</i>. This topic includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.</p> <p>For information about the number of server certificates you can upload, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html">IAM and STS quotas</a> in the <i>IAM User Guide</i>.</p> <note> <p>Because the body of the public key certificate, private key, and the certificate chain can be large, you should use POST rather than GET when calling <code>UploadServerCertificate</code>. For information about setting up signatures and authorization through the API, see <a href="https://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html">Signing Amazon Web Services API requests</a> in the <i>Amazon Web Services General Reference</i>. For general information about using the Query API with IAM, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/programming.html">Calling the API by making HTTP query requests</a> in the <i>IAM User Guide</i>.</p> </note> | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +server_certificate_name +FROM aws.iam.server_certificates + +``` + +## Permissions + +To operate on the server_certificates resource, the following permissions are required: + +### Create +```json +iam:UploadServerCertificate, +iam:TagServerCertificate, +iam:GetServerCertificate +``` + +### List +```json +iam:ListServerCertificates, +iam:GetServerCertificate +``` + diff --git a/docs/aws-docs/providers/aws/iam/service_last_accessed_details/index.md b/docs/aws-docs/providers/aws/iam/service_last_accessed_details/index.md deleted file mode 100644 index a9cdead7c4..0000000000 --- a/docs/aws-docs/providers/aws/iam/service_last_accessed_details/index.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: service_last_accessed_details -hide_title: false -hide_table_of_contents: false -keywords: - - service_last_accessed_details - - 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 ---- - - - -## Overview - - - - -
Nameservice_last_accessed_details
TypeResource
Idaws.iam.service_last_accessed_details
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `Error` | `object` | <p>Contains information about the reason that the operation failed.</p> <p>This data type is used as a response element in the <a>GetOrganizationsAccessReport</a>, <a>GetServiceLastAccessedDetails</a>, and <a>GetServiceLastAccessedDetailsWithEntities</a> operations.</p> | -| `IsTruncated` | `boolean` | A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items. Note that IAM might return fewer than the <code>MaxItems</code> number of results even when there are more results available. We recommend that you check <code>IsTruncated</code> after every call to ensure that you receive all your results. | -| `JobCompletionDate` | `string` | <p>The date and time, in <a href="http://www.iso.org/iso/iso8601">ISO 8601 date-time format</a>, when the generated report job was completed or failed.</p> <p>This field is null if the job is still in progress, as indicated by a job status value of <code>IN_PROGRESS</code>.</p> | -| `JobCreationDate` | `string` | The date and time, in <a href="http://www.iso.org/iso/iso8601">ISO 8601 date-time format</a>, when the report job was created. | -| `JobStatus` | `string` | The status of the job. | -| `JobType` | `string` | The type of job. Service jobs return information about when each service was last accessed. Action jobs also include information about when tracked actions within the service were last accessed. | -| `Marker` | `string` | When <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value to use for the <code>Marker</code> parameter in a subsequent pagination request. | -| `ServicesLastAccessed` | `array` | A <code>ServiceLastAccessed</code> object that contains details about the most recent attempt to access the service. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `service_last_accessed_details_Get` | `SELECT` | `JobId, region` | <p>Retrieves a service last accessed report that was created using the <code>GenerateServiceLastAccessedDetails</code> operation. You can use the <code>JobId</code> parameter in <code>GetServiceLastAccessedDetails</code> to retrieve the status of your report job. When the report is complete, you can retrieve the generated report. The report includes a list of Amazon Web Services services that the resource (user, group, role, or managed policy) can access.</p> <note> <p>Service last accessed data does not use other policy types when determining whether a resource could access a service. These other policy types include resource-based policies, access control lists, Organizations policies, IAM permissions boundaries, and STS assume role policies. It only applies permissions policy logic. For more about the evaluation of policy types, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html#policy-eval-basics">Evaluating policies</a> in the <i>IAM User Guide</i>.</p> </note> <p>For each service that the resource could access using permissions policies, the operation returns details about the most recent access attempt. If there was no attempt, the service is listed without details about the most recent attempt to access the service. If the operation fails, the <code>GetServiceLastAccessedDetails</code> operation returns the reason that it failed.</p> <p>The <code>GetServiceLastAccessedDetails</code> operation returns a list of services. This list includes the number of entities that have attempted to access the service and the date and time of the last attempt. It also returns the ARN of the following entity, depending on the resource ARN that you used to generate the report:</p> <ul> <li> <p> <b>User</b> – Returns the user ARN that you used to generate the report</p> </li> <li> <p> <b>Group</b> – Returns the ARN of the group member (user) that last attempted to access the service</p> </li> <li> <p> <b>Role</b> – Returns the role ARN that you used to generate the report</p> </li> <li> <p> <b>Policy</b> – Returns the ARN of the user or role that last used the policy to attempt to access the service</p> </li> </ul> <p>By default, the list is sorted by service namespace.</p> <p>If you specified <code>ACTION_LEVEL</code> granularity when you generated the report, this operation returns service and action last accessed data. This includes the most recent access attempt for each tracked action within a service. Otherwise, this operation returns only service data.</p> <p>For more information about service and action last accessed data, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html">Reducing permissions using service last accessed data</a> in the <i>IAM User Guide</i>.</p> | -| `service_last_accessed_details_Generate` | `EXEC` | `Arn, region` | <p>Generates a report that includes details about when an IAM resource (user, group, role, or policy) was last used in an attempt to access Amazon Web Services services. Recent activity usually appears within four hours. IAM reports activity for at least the last 400 days, or less if your Region began supporting this feature within the last year. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#access-advisor_tracking-period">Regions where data is tracked</a>.</p> <important> <p>The service last accessed data includes all attempts to access an Amazon Web Services API, not just the successful ones. This includes all attempts that were made using the Amazon Web Services Management Console, the Amazon Web Services API through any of the SDKs, or any of the command line tools. An unexpected entry in the service last accessed data does not mean that your account has been compromised, because the request might have been denied. Refer to your CloudTrail logs as the authoritative source for information about all API calls and whether they were successful or denied access. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/cloudtrail-integration.html">Logging IAM events with CloudTrail</a> in the <i>IAM User Guide</i>.</p> </important> <p>The <code>GenerateServiceLastAccessedDetails</code> operation returns a <code>JobId</code>. Use this parameter in the following operations to retrieve the following details from your report: </p> <ul> <li> <p> <a>GetServiceLastAccessedDetails</a> – Use this operation for users, groups, roles, or policies to list every Amazon Web Services service that the resource could access using permissions policies. For each service, the response includes information about the most recent access attempt.</p> <p>The <code>JobId</code> returned by <code>GenerateServiceLastAccessedDetail</code> must be used by the same role within a session, or by the same user when used to call <code>GetServiceLastAccessedDetail</code>.</p> </li> <li> <p> <a>GetServiceLastAccessedDetailsWithEntities</a> – Use this operation for groups and policies to list information about the associated entities (users or roles) that attempted to access a specific Amazon Web Services service. </p> </li> </ul> <p>To check the status of the <code>GenerateServiceLastAccessedDetails</code> request, use the <code>JobId</code> parameter in the same operations and test the <code>JobStatus</code> response parameter.</p> <p>For additional information about the permissions policies that allow an identity (user, group, or role) to access specific services, use the <a>ListPoliciesGrantingServiceAccess</a> operation.</p> <note> <p>Service last accessed data does not use other policy types when determining whether a resource could access a service. These other policy types include resource-based policies, access control lists, Organizations policies, IAM permissions boundaries, and STS assume role policies. It only applies permissions policy logic. For more about the evaluation of policy types, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html#policy-eval-basics">Evaluating policies</a> in the <i>IAM User Guide</i>.</p> </note> <p>For more information about service and action last accessed data, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html">Reducing permissions using service last accessed data</a> in the <i>IAM User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/iam/service_last_accessed_details_with_entities/index.md b/docs/aws-docs/providers/aws/iam/service_last_accessed_details_with_entities/index.md deleted file mode 100644 index 6eb85005fd..0000000000 --- a/docs/aws-docs/providers/aws/iam/service_last_accessed_details_with_entities/index.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: service_last_accessed_details_with_entities -hide_title: false -hide_table_of_contents: false -keywords: - - service_last_accessed_details_with_entities - - 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 ---- - - - -## Overview - - - - -
Nameservice_last_accessed_details_with_entities
TypeResource
Idaws.iam.service_last_accessed_details_with_entities
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `EntityDetailsList` | `array` | An <code>EntityDetailsList</code> object that contains details about when an IAM entity (user or role) used group or policy permissions in an attempt to access the specified Amazon Web Services service. | -| `Error` | `object` | <p>Contains information about the reason that the operation failed.</p> <p>This data type is used as a response element in the <a>GetOrganizationsAccessReport</a>, <a>GetServiceLastAccessedDetails</a>, and <a>GetServiceLastAccessedDetailsWithEntities</a> operations.</p> | -| `IsTruncated` | `boolean` | A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items. Note that IAM might return fewer than the <code>MaxItems</code> number of results even when there are more results available. We recommend that you check <code>IsTruncated</code> after every call to ensure that you receive all your results. | -| `JobCompletionDate` | `string` | <p>The date and time, in <a href="http://www.iso.org/iso/iso8601">ISO 8601 date-time format</a>, when the generated report job was completed or failed.</p> <p>This field is null if the job is still in progress, as indicated by a job status value of <code>IN_PROGRESS</code>.</p> | -| `JobCreationDate` | `string` | The date and time, in <a href="http://www.iso.org/iso/iso8601">ISO 8601 date-time format</a>, when the report job was created. | -| `JobStatus` | `string` | The status of the job. | -| `Marker` | `string` | When <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value to use for the <code>Marker</code> parameter in a subsequent pagination request. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `service_last_accessed_details_with_entities_Get` | `SELECT` | `JobId, ServiceNamespace, region` | diff --git a/docs/aws-docs/providers/aws/iam/service_linked_role/index.md b/docs/aws-docs/providers/aws/iam/service_linked_role/index.md new file mode 100644 index 0000000000..e2bf40b1bf --- /dev/null +++ b/docs/aws-docs/providers/aws/iam/service_linked_role/index.md @@ -0,0 +1,96 @@ +--- +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
DescriptionResource Type definition for AWS::IAM::ServiceLinkedRole
Idaws.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.
aws_service_namestringThe service principal for the AWS service to which this role is attached.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +role_name, +custom_suffix, +description, +aws_service_name +FROM aws.iam.service_linked_role +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the service_linked_role resource, the following permissions are required: + +### Read +```json +iam:GetRole +``` + +### Update +```json +iam:UpdateRole, +iam:GetRole +``` + +### Delete +```json +iam:DeleteServiceLinkedRole, +iam:GetServiceLinkedRoleDeletionStatus, +iam:GetRole +``` + diff --git a/docs/aws-docs/providers/aws/iam/service_linked_role_deletion_status/index.md b/docs/aws-docs/providers/aws/iam/service_linked_role_deletion_status/index.md deleted file mode 100644 index 99b41eb20f..0000000000 --- a/docs/aws-docs/providers/aws/iam/service_linked_role_deletion_status/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: service_linked_role_deletion_status -hide_title: false -hide_table_of_contents: false -keywords: - - service_linked_role_deletion_status - - 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 ---- - - - -## Overview - - - - -
Nameservice_linked_role_deletion_status
TypeResource
Idaws.iam.service_linked_role_deletion_status
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `Reason` | `object` | <p>The reason that the service-linked role deletion failed.</p> <p>This data type is used as a response element in the <a>GetServiceLinkedRoleDeletionStatus</a> operation.</p> | -| `Status` | `string` | The status of the deletion. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `service_linked_role_deletion_status_Get` | `SELECT` | `DeletionTaskId, region` | diff --git a/docs/aws-docs/providers/aws/iam/service_linked_roles/index.md b/docs/aws-docs/providers/aws/iam/service_linked_roles/index.md index 362e2ff498..3b9b45d191 100644 --- a/docs/aws-docs/providers/aws/iam/service_linked_roles/index.md +++ b/docs/aws-docs/providers/aws/iam/service_linked_roles/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - service_linked_roles - iam - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,20 +14,55 @@ description: Query, deploy 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
DescriptionResource Type definition for AWS::IAM::ServiceLinkedRole
Idaws.iam.service_linked_roles
## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command + + + + + +
NameDatatypeDescription
role_namestringThe name of the role.
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `service_linked_roles_Create` | `INSERT` | `AWSServiceName, region` | <p>Creates an IAM role that is linked to a specific Amazon Web Services service. The service controls the attached policies and when the role can be deleted. This helps ensure that the service is not broken by an unexpectedly changed or deleted role, which could put your Amazon Web Services resources into an unknown state. Allowing the service to control the role helps improve service stability and proper cleanup when a service and its role are no longer needed. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html">Using service-linked roles</a> in the <i>IAM User Guide</i>. </p> <p>To attach a policy to this service-linked role, you must make the request using the Amazon Web Services service that depends on this role.</p> | -| `service_linked_roles_Delete` | `DELETE` | `RoleName, region` | <p>Submits a service-linked role deletion request and returns a <code>DeletionTaskId</code>, which you can use to check the status of the deletion. Before you call this operation, confirm that the role has no active sessions and that any resources used by the role in the linked service are deleted. If you call this operation more than once for the same service-linked role and an earlier deletion task is not complete, then the <code>DeletionTaskId</code> of the earlier request is returned.</p> <p>If you submit a deletion request for a service-linked role whose linked service is still accessing a resource, then the deletion task fails. If it fails, the <a>GetServiceLinkedRoleDeletionStatus</a> operation returns the reason for the failure, usually including the resources that must be deleted. To delete the service-linked role, you must first remove those resources from the linked service and then submit the deletion request again. Resources are specific to the service that is linked to the role. For more information about removing resources from a service, see the <a href="http://docs.aws.amazon.com/">Amazon Web Services documentation</a> for your service.</p> <p>For more information about service-linked roles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html#iam-term-service-linked-role">Roles terms and concepts: Amazon Web Services service-linked role</a> in the <i>IAM User Guide</i>.</p> | + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +role_name +FROM aws.iam.service_linked_roles + +``` + +## Permissions + +To operate on the service_linked_roles resource, the following permissions are required: + +### Create +```json +iam:CreateServiceLinkedRole, +iam:GetRole +``` + diff --git a/docs/aws-docs/providers/aws/iam/service_specific_credentials/index.md b/docs/aws-docs/providers/aws/iam/service_specific_credentials/index.md deleted file mode 100644 index 36f543e18f..0000000000 --- a/docs/aws-docs/providers/aws/iam/service_specific_credentials/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: service_specific_credentials -hide_title: false -hide_table_of_contents: false -keywords: - - service_specific_credentials - - 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 ---- - - - -## Overview - - - - -
Nameservice_specific_credentials
TypeResource
Idaws.iam.service_specific_credentials
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `CreateDate` | `string` | The date and time, in <a href="http://www.iso.org/iso/iso8601">ISO 8601 date-time format</a>, when the service-specific credential were created. | -| `ServiceName` | `string` | The name of the service associated with the service-specific credential. | -| `ServiceSpecificCredentialId` | `string` | The unique identifier for the service-specific credential. | -| `ServiceUserName` | `string` | The generated user name for the service-specific credential. | -| `Status` | `string` | The status of the service-specific credential. <code>Active</code> means that the key is valid for API calls, while <code>Inactive</code> means it is not. | -| `UserName` | `string` | The name of the IAM user associated with the service-specific credential. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `service_specific_credentials_List` | `SELECT` | `region` | Returns information about the service-specific credentials associated with the specified IAM user. If none exists, the operation returns an empty list. The service-specific credentials returned by this operation are used only for authenticating the IAM user to a specific service. For more information about using service-specific credentials to authenticate to an Amazon Web Services service, see <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-gc.html">Set up service-specific credentials</a> in the CodeCommit User Guide. | -| `service_specific_credentials_Create` | `INSERT` | `ServiceName, UserName, region` | <p>Generates a set of credentials consisting of a user name and password that can be used to access the service specified in the request. These credentials are generated by IAM, and can be used only for the specified service. </p> <p>You can have a maximum of two sets of service-specific credentials for each supported service per user.</p> <p>You can create service-specific credentials for CodeCommit and Amazon Keyspaces (for Apache Cassandra).</p> <p>You can reset the password to a new service-generated value by calling <a>ResetServiceSpecificCredential</a>.</p> <p>For more information about service-specific credentials, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_ssh-keys.html">Using IAM with CodeCommit: Git credentials, SSH keys, and Amazon Web Services access keys</a> in the <i>IAM User Guide</i>.</p> | -| `service_specific_credentials_Delete` | `DELETE` | `ServiceSpecificCredentialId, region` | Deletes the specified service-specific credential. | -| `service_specific_credentials_Reset` | `EXEC` | `ServiceSpecificCredentialId, region` | Resets the password for a service-specific credential. The new password is Amazon Web Services generated and cryptographically strong. It cannot be configured by the user. Resetting the password immediately invalidates the previous password associated with this user. | -| `service_specific_credentials_Update` | `EXEC` | `ServiceSpecificCredentialId, Status, region` | Sets the status of a service-specific credential to <code>Active</code> or <code>Inactive</code>. Service-specific credentials that are inactive cannot be used for authentication to the service. This operation can be used to disable a user's service-specific credential as part of a credential rotation work flow. | diff --git a/docs/aws-docs/providers/aws/iam/signing_certificates/index.md b/docs/aws-docs/providers/aws/iam/signing_certificates/index.md deleted file mode 100644 index eb3712fbe3..0000000000 --- a/docs/aws-docs/providers/aws/iam/signing_certificates/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: signing_certificates -hide_title: false -hide_table_of_contents: false -keywords: - - signing_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 ---- - - - -## Overview - - - - -
Namesigning_certificates
TypeResource
Idaws.iam.signing_certificates
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `CertificateBody` | `string` | The contents of the signing certificate. | -| `CertificateId` | `string` | The ID for the signing certificate. | -| `Status` | `string` | The status of the signing certificate. <code>Active</code> means that the key is valid for API calls, while <code>Inactive</code> means it is not. | -| `UploadDate` | `string` | The date when the signing certificate was uploaded. | -| `UserName` | `string` | The name of the user the signing certificate is associated with. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `signing_certificates_List` | `SELECT` | `region` | <p>Returns information about the signing certificates associated with the specified IAM user. If none exists, the operation returns an empty list.</p> <p>Although each user is limited to a small number of signing certificates, you can still paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters.</p> <p>If the <code>UserName</code> field is not specified, the user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request for this operation. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.</p> | -| `signing_certificates_Delete` | `DELETE` | `CertificateId, region` | <p>Deletes a signing certificate associated with the specified IAM user.</p> <p>If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID signing the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated IAM users.</p> | -| `signing_certificates_Update` | `EXEC` | `CertificateId, Status, region` | <p>Changes the status of the specified user signing certificate from active to disabled, or vice versa. This operation can be used to disable an IAM user's signing certificate as part of a certificate rotation work flow.</p> <p>If the <code>UserName</code> field is not specified, the user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.</p> | -| `signing_certificates_Upload` | `EXEC` | `CertificateBody, region` | <p>Uploads an X.509 signing certificate and associates it with the specified IAM user. Some Amazon Web Services services require you to use certificates to validate requests that are signed with a corresponding private key. When you upload the certificate, its default status is <code>Active</code>.</p> <p>For information about when you would use an X.509 signing certificate, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html">Managing server certificates in IAM</a> in the <i>IAM User Guide</i>.</p> <p>If the <code>UserName</code> is not specified, the IAM user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.</p> <note> <p>Because the body of an X.509 certificate can be large, you should use POST rather than GET when calling <code>UploadSigningCertificate</code>. For information about setting up signatures and authorization through the API, see <a href="https://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html">Signing Amazon Web Services API requests</a> in the <i>Amazon Web Services General Reference</i>. For general information about using the Query API with IAM, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html">Making query requests</a> in the <i>IAM User Guide</i>.</p> </note> | diff --git a/docs/aws-docs/providers/aws/iam/ssh_public_keys/index.md b/docs/aws-docs/providers/aws/iam/ssh_public_keys/index.md deleted file mode 100644 index 34823a40c9..0000000000 --- a/docs/aws-docs/providers/aws/iam/ssh_public_keys/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ssh_public_keys -hide_title: false -hide_table_of_contents: false -keywords: - - ssh_public_keys - - 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 ---- - - - -## Overview - - - - -
Namessh_public_keys
TypeResource
Idaws.iam.ssh_public_keys
- -## Fields -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `ssh_public_keys_Get` | `SELECT` | `Encoding, SSHPublicKeyId, UserName, region` | <p>Retrieves the specified SSH public key, including metadata about the key.</p> <p>The SSH public key retrieved by this operation is used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html">Set up CodeCommit for SSH connections</a> in the <i>CodeCommit User Guide</i>.</p> | -| `ssh_public_keys_List` | `SELECT` | `region` | <p>Returns information about the SSH public keys associated with the specified IAM user. If none exists, the operation returns an empty list.</p> <p>The SSH public keys returned by this operation are used only for authenticating the IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html">Set up CodeCommit for SSH connections</a> in the <i>CodeCommit User Guide</i>.</p> <p>Although each user is limited to a small number of keys, you can still paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters.</p> | -| `ssh_public_keys_Delete` | `DELETE` | `SSHPublicKeyId, UserName, region` | <p>Deletes the specified SSH public key.</p> <p>The SSH public key deleted by this operation is used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html">Set up CodeCommit for SSH connections</a> in the <i>CodeCommit User Guide</i>.</p> | -| `ssh_public_keys_Update` | `EXEC` | `SSHPublicKeyId, Status, UserName, region` | <p>Sets the status of an IAM user's SSH public key to active or inactive. SSH public keys that are inactive cannot be used for authentication. This operation can be used to disable a user's SSH public key as part of a key rotation work flow.</p> <p>The SSH public key affected by this operation is used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html">Set up CodeCommit for SSH connections</a> in the <i>CodeCommit User Guide</i>.</p> | -| `ssh_public_keys_Upload` | `EXEC` | `SSHPublicKeyBody, UserName, region` | <p>Uploads an SSH public key and associates it with the specified IAM user.</p> <p>The SSH public key uploaded by this operation can be used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html">Set up CodeCommit for SSH connections</a> in the <i>CodeCommit User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/iam/user/index.md b/docs/aws-docs/providers/aws/iam/user/index.md new file mode 100644 index 0000000000..858ad12444 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam/user/index.md @@ -0,0 +1,136 @@ +--- +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
DescriptionCreates a new IAM user for your AWS-account.<br/> For information about quotas for the number of IAM users you can create, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +path, +managed_policy_arns, +policies, +user_name, +groups, +arn, +login_profile, +tags, +permissions_boundary +FROM aws.iam.user +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the user resource, the following permissions are required: + +### Read +```json +iam:GetUserPolicy, +iam:ListGroupsForUser, +iam:ListAttachedUserPolicies, +iam:ListUserPolicies, +iam:GetUser, +iam:GetLoginProfile +``` + +### Update +```json +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 +```json +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 +``` + diff --git a/docs/aws-docs/providers/aws/iam/user_from_groups/index.md b/docs/aws-docs/providers/aws/iam/user_from_groups/index.md deleted file mode 100644 index 11dffb84da..0000000000 --- a/docs/aws-docs/providers/aws/iam/user_from_groups/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: user_from_groups -hide_title: false -hide_table_of_contents: false -keywords: - - user_from_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 ---- - - - -## Overview - - - - -
Nameuser_from_groups
TypeResource
Idaws.iam.user_from_groups
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `user_from_groups_Remove` | `EXEC` | `GroupName, UserName, region` | diff --git a/docs/aws-docs/providers/aws/iam/user_permissions_boundaries/index.md b/docs/aws-docs/providers/aws/iam/user_permissions_boundaries/index.md deleted file mode 100644 index f8eb8b11fb..0000000000 --- a/docs/aws-docs/providers/aws/iam/user_permissions_boundaries/index.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: user_permissions_boundaries -hide_title: false -hide_table_of_contents: false -keywords: - - user_permissions_boundaries - - 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 ---- - - - -## Overview - - - - -
Nameuser_permissions_boundaries
TypeResource
Idaws.iam.user_permissions_boundaries
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `user_permissions_boundaries_Delete` | `DELETE` | `UserName, region` | <p>Deletes the permissions boundary for the specified IAM user.</p> <important> <p>Deleting the permissions boundary for a user might increase its permissions by allowing the user to perform all the actions granted in its permissions policies. </p> </important> | -| `user_permissions_boundaries_Put` | `EXEC` | `PermissionsBoundary, UserName, region` | <p>Adds or updates the policy that is specified as the IAM user's permissions boundary. You can use an Amazon Web Services managed policy or a customer managed policy to set the boundary for a user. Use the boundary to control the maximum permissions that the user can have. Setting a permissions boundary is an advanced feature that can affect the permissions for the user.</p> <important> <p>Policies that are used as permissions boundaries do not provide permissions. You must also attach a permissions policy to the user. To learn how the effective permissions for a user are evaluated, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html">IAM JSON policy evaluation logic</a> in the IAM User Guide. </p> </important> | diff --git a/docs/aws-docs/providers/aws/iam/user_policies/index.md b/docs/aws-docs/providers/aws/iam/user_policies/index.md index 68242e155d..d6c5a106d9 100644 --- a/docs/aws-docs/providers/aws/iam/user_policies/index.md +++ b/docs/aws-docs/providers/aws/iam/user_policies/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - user_policies - iam - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,28 +14,52 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- - - +List of user policies by UserName (requires `aws` provider to be installed) ## Overview +
Nameuser_policies
TypeResource
DescriptionList of user policies by UserName (requires `aws` provider to be installed)
Idaws.iam.user_policies
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `PolicyDocument` | `string` | <p>The policy document.</p> <p>IAM stores policies in JSON format. However, resources that were created using CloudFormation templates can be formatted in YAML. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.</p> | -| `PolicyName` | `string` | The name of the policy. | -| `UserName` | `string` | The user the policy is associated with. | + + + + + + + +
NameDatatypeDescription
user_namestringThe IAM user name
memberstringThe user policy name
regionstring
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `user_policies_Get` | `SELECT` | `PolicyName, UserName, region` | <p>Retrieves the specified inline policy document that is embedded in the specified IAM user.</p> <note> <p>Policies returned by this operation are URL-encoded compliant with <a href="https://tools.ietf.org/html/rfc3986">RFC 3986</a>. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the <code>decode</code> method of the <code>java.net.URLDecoder</code> utility class in the Java SDK. Other languages and SDKs provide similar functionality.</p> </note> <p>An IAM user can also have managed policies attached to it. To retrieve a managed policy document that is attached to a user, use <a>GetPolicy</a> to determine the policy's default version. Then use <a>GetPolicyVersion</a> to retrieve the policy document.</p> <p>For more information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p> | -| `user_policies_List` | `SELECT` | `UserName, region` | <p>Lists the names of the inline policies embedded in the specified IAM user.</p> <p>An IAM user can also have managed policies attached to it. To list the managed policies that are attached to a user, use <a>ListAttachedUserPolicies</a>. For more information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p> <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. If there are no inline policies embedded with the specified user, the operation returns an empty list.</p> | -| `user_policies_Delete` | `DELETE` | `PolicyName, UserName, region` | <p>Deletes the specified inline policy that is embedded in the specified IAM user.</p> <p>A user can also have managed policies attached to it. To detach a managed policy from a user, use <a>DetachUserPolicy</a>. For more information about policies, refer to <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p> | -| `user_policies_Attach` | `EXEC` | `PolicyArn, UserName, region` | <p>Attaches the specified managed policy to the specified user.</p> <p>You use this operation to attach a <i>managed</i> policy to a user. To embed an inline policy in a user, use <a>PutUserPolicy</a>.</p> <p>As a best practice, you can validate your IAM policies. To learn more, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html">Validating IAM policies</a> in the <i>IAM User Guide</i>.</p> <p>For more information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p> | -| `user_policies_Detach` | `EXEC` | `PolicyArn, UserName, region` | <p>Removes the specified managed policy from the specified user.</p> <p>A user can also have inline policies embedded with it. To delete an inline policy, use <a>DeleteUserPolicy</a>. For information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p> | -| `user_policies_Put` | `EXEC` | `PolicyDocument, PolicyName, UserName, region` | <p>Adds or updates an inline policy document that is embedded in the specified IAM user.</p> <p>An IAM user can also have a managed policy attached to it. To attach a managed policy to a user, use <a>AttachUserPolicy</a>. To create a new managed policy, use <a>CreatePolicy</a>. For information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p> <p>For information about the maximum number of inline policies that you can embed in a user, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html">IAM and STS quotas</a> in the <i>IAM User Guide</i>.</p> <note> <p>Because policy documents can be large, you should use POST rather than GET when calling <code>PutUserPolicy</code>. For general information about using the Query API with IAM, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html">Making query requests</a> in the <i>IAM User Guide</i>.</p> </note> | + + + + + + + + + + + + +
NameAccessible byRequired Params
viewSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +user_name, +member, +region +FROM aws.iam.user_policies +WHERE UserName = ''; +``` + + + + diff --git a/docs/aws-docs/providers/aws/iam/user_policy/index.md b/docs/aws-docs/providers/aws/iam/user_policy/index.md new file mode 100644 index 0000000000..71c2db893a --- /dev/null +++ b/docs/aws-docs/providers/aws/iam/user_policy/index.md @@ -0,0 +1,93 @@ +--- +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
DescriptionAdds or updates an inline policy document that is embedded in the specified IAM user.<br/> An IAM user can also have a managed policy attached to it. To attach a managed policy to a user, use [AWS::IAM::User](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html). To create a new managed policy, use [AWS::IAM::ManagedPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html). 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 *IAM User Guide*.<br/> For information about the maximum number of inline policies that you can embed in a user, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*.
Idaws.iam.user_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: _+=,.@-
user_namestringThe name of the user 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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +policy_document, +policy_name, +user_name +FROM aws.iam.user_policy +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the user_policy resource, the following permissions are required: + +### Read +```json +iam:GetUserPolicy +``` + +### Update +```json +iam:PutUserPolicy, +iam:GetUserPolicy +``` + +### Delete +```json +iam:DeleteUserPolicy, +iam:GetUserPolicy +``` + diff --git a/docs/aws-docs/providers/aws/iam/user_tags/index.md b/docs/aws-docs/providers/aws/iam/user_tags/index.md deleted file mode 100644 index 51b0775434..0000000000 --- a/docs/aws-docs/providers/aws/iam/user_tags/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: user_tags -hide_title: false -hide_table_of_contents: false -keywords: - - user_tags - - iam - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - - - -## Overview - - - - -
Nameuser_tags
TypeResource
Idaws.iam.user_tags
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `Key` | `string` | The key name that can be used to look up or retrieve the associated value. For example, <code>Department</code> or <code>Cost Center</code> are common choices. | -| `Value` | `string` | <p>The value associated with this tag. For example, tags with a key name of <code>Department</code> could have values such as <code>Human Resources</code>, <code>Accounting</code>, and <code>Support</code>. Tags with a key name of <code>Cost Center</code> might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values.</p> <note> <p>Amazon Web Services always interprets the tag <code>Value</code> as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.</p> </note> | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `user_tags_List` | `SELECT` | `UserName, region` | diff --git a/docs/aws-docs/providers/aws/iam/user_to_groups/index.md b/docs/aws-docs/providers/aws/iam/user_to_groups/index.md deleted file mode 100644 index 43a9a57399..0000000000 --- a/docs/aws-docs/providers/aws/iam/user_to_groups/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: user_to_groups -hide_title: false -hide_table_of_contents: false -keywords: - - user_to_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 ---- - - - -## Overview - - - - -
Nameuser_to_groups
TypeResource
Idaws.iam.user_to_groups
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `user_to_groups_Add` | `EXEC` | `GroupName, UserName, region` | diff --git a/docs/aws-docs/providers/aws/iam/users/index.md b/docs/aws-docs/providers/aws/iam/users/index.md index f10d174385..7c72e51b8b 100644 --- a/docs/aws-docs/providers/aws/iam/users/index.md +++ b/docs/aws-docs/providers/aws/iam/users/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - users - iam - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,34 +14,70 @@ description: Query, deploy 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
DescriptionCreates a new IAM user for your AWS-account.<br/> For information about quotas for the number of IAM users you can create, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*.
Idaws.iam.users
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `Arn` | `string` | <p>The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.</p> <p>For more information about ARNs, go to <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>. </p> | -| `CreateDate` | `string` | The date and time, in <a href="http://www.iso.org/iso/iso8601">ISO 8601 date-time format</a>, when the user was created. | -| `PasswordLastUsed` | `string` | <p>The date and time, in <a href="http://www.iso.org/iso/iso8601">ISO 8601 date-time format</a>, when the user's password was last used to sign in to an Amazon Web Services website. For a list of Amazon Web Services websites that capture a user's last sign-in time, see the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html">Credential reports</a> topic in the <i>IAM User Guide</i>. If a password is used more than once in a five-minute span, only the first use is returned in this field. If the field is null (no value), then it indicates that they never signed in with a password. This can be because:</p> <ul> <li> <p>The user never had a password.</p> </li> <li> <p>A password exists but has not been used since IAM started tracking this information on October 20, 2014.</p> </li> </ul> <p>A null value does not mean that the user <i>never</i> had a password. Also, if the user does not currently have a password but had one in the past, then this field contains the date and time the most recent password was used.</p> <p>This value is returned only in the <a>GetUser</a> and <a>ListUsers</a> operations. </p> | -| `Path` | `string` | <p>The path to the user. For more information about paths, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">IAM identifiers</a> in the <i>IAM User Guide</i>.</p> <p>The ARN of the policy used to set the permissions boundary for the user.</p> | -| `PermissionsBoundary` | `object` | <p>Contains information about an attached permissions boundary.</p> <p>An attached permissions boundary is a managed policy that has been attached to a user or role to set the permissions boundary.</p> <p>For more information about permissions boundaries, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html">Permissions boundaries for IAM identities </a> in the <i>IAM User Guide</i>.</p> | -| `Tags` | `array` | A list of tags that are associated with the user. For more information about tagging, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM resources</a> in the <i>IAM User Guide</i>. | -| `UserId` | `string` | The stable and unique string identifying the user. For more information about IDs, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">IAM identifiers</a> in the <i>IAM User Guide</i>. | -| `UserName` | `string` | The friendly name identifying the user. | + + + + + +
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 -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `users_List` | `SELECT` | `region` | <p>Lists the IAM users that have the specified path prefix. If no path prefix is specified, the operation returns all users in the Amazon Web Services account. If there are none, the operation returns an empty list.</p> <note> <p>IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a user, see <a>GetUser</a>.</p> </note> <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters.</p> | -| `users_Create` | `INSERT` | `UserName, region` | <p>Creates a new IAM user for your Amazon Web Services account.</p> <p> For information about quotas for the number of IAM users you can create, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html">IAM and STS quotas</a> in the <i>IAM User Guide</i>.</p> | -| `users_Delete` | `DELETE` | `UserName, region` | <p>Deletes the specified IAM user. Unlike the Amazon Web Services Management Console, when you delete a user programmatically, you must delete the items attached to the user manually, or the deletion fails. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_manage.html#id_users_deleting_cli">Deleting an IAM user</a>. Before attempting to delete a user, remove the following items:</p> <ul> <li> <p>Password (<a>DeleteLoginProfile</a>)</p> </li> <li> <p>Access keys (<a>DeleteAccessKey</a>)</p> </li> <li> <p>Signing certificate (<a>DeleteSigningCertificate</a>)</p> </li> <li> <p>SSH public key (<a>DeleteSSHPublicKey</a>)</p> </li> <li> <p>Git credentials (<a>DeleteServiceSpecificCredential</a>)</p> </li> <li> <p>Multi-factor authentication (MFA) device (<a>DeactivateMFADevice</a>, <a>DeleteVirtualMFADevice</a>)</p> </li> <li> <p>Inline policies (<a>DeleteUserPolicy</a>)</p> </li> <li> <p>Attached managed policies (<a>DetachUserPolicy</a>)</p> </li> <li> <p>Group memberships (<a>RemoveUserFromGroup</a>)</p> </li> </ul> | -| `users_Get` | `EXEC` | `region` | <p>Retrieves information about the specified IAM user, including the user's creation date, path, unique ID, and ARN.</p> <p>If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID used to sign the request to this operation.</p> | -| `users_Tag` | `EXEC` | `Tags, UserName, region` | <p>Adds one or more tags to an IAM user. If a tag with the same key name already exists, then that tag is overwritten with the new value.</p> <p>A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:</p> <ul> <li> <p> <b>Administrative grouping and discovery</b> - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name <i>Project</i> and the value <i>MyImportantProject</i>. Or search for all resources with the key name <i>Cost Center</i> and the value <i>41200</i>. </p> </li> <li> <p> <b>Access control</b> - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM requesting user that has a specified tag attached. You can also restrict access to only those resources that have a certain tag attached. For examples of policies that show how to use tags to control access, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Control access using IAM tags</a> in the <i>IAM User Guide</i>.</p> </li> <li> <p> <b>Cost allocation</b> - Use tags to help track which individuals and teams are using which Amazon Web Services resources.</p> </li> </ul> <note> <ul> <li> <p>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. For more information about tagging, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM resources</a> in the <i>IAM User Guide</i>.</p> </li> <li> <p>Amazon Web Services always interprets the tag <code>Value</code> as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.</p> </li> </ul> </note> <p>For more information about tagging, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM identities</a> in the <i>IAM User Guide</i>.</p> | -| `users_Untag` | `EXEC` | `TagKeys, UserName, region` | Removes the specified tags from the user. For more information about tagging, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM resources</a> in the <i>IAM User Guide</i>. | -| `users_Update` | `EXEC` | `UserName, region` | <p>Updates the name and/or the path of the specified IAM user.</p> <important> <p> You should understand the implications of changing an IAM user's path or name. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_manage.html#id_users_renaming">Renaming an IAM user</a> and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_groups_manage_rename.html">Renaming an IAM group</a> in the <i>IAM User Guide</i>.</p> </important> <note> <p> To change a user name, the requester must have appropriate permissions on both the source object and the target object. For example, to change Bob to Robert, the entity making the request must have permission on Bob and Robert, or must have permission on all (*). For more information about permissions, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/PermissionsAndPolicies.html">Permissions and policies</a>. </p> </note> | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +user_name +FROM aws.iam.users + +``` + +## Permissions + +To operate on the users resource, the following permissions are required: + +### Create +```json +iam:CreateLoginProfile, +iam:AddUserToGroup, +iam:PutUserPolicy, +iam:AttachUserPolicy, +iam:CreateUser, +iam:GetUser, +iam:TagUser +``` + +### List +```json +iam:listUsers +``` + diff --git a/docs/aws-docs/providers/aws/iam/virtual_mfa_devices/index.md b/docs/aws-docs/providers/aws/iam/virtual_mfa_devices/index.md deleted file mode 100644 index 7212b69e87..0000000000 --- a/docs/aws-docs/providers/aws/iam/virtual_mfa_devices/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: virtual_mfa_devices -hide_title: false -hide_table_of_contents: false -keywords: - - virtual_mfa_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 ---- - - - -## Overview - - - - -
Namevirtual_mfa_devices
TypeResource
Idaws.iam.virtual_mfa_devices
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `Base32StringSeed` | `string` | The base32 seed defined as specified in <a href="https://tools.ietf.org/html/rfc3548.txt">RFC3548</a>. The <code>Base32StringSeed</code> is base64-encoded. | -| `EnableDate` | `string` | The date and time on which the virtual MFA device was enabled. | -| `QRCodePNG` | `string` | A QR code PNG image that encodes <code>otpauth://totp/$virtualMFADeviceName@$AccountName?secret=$Base32String</code> where <code>$virtualMFADeviceName</code> is one of the create call arguments. <code>AccountName</code> is the user name if set (otherwise, the account ID otherwise), and <code>Base32String</code> is the seed in base32 format. The <code>Base32String</code> value is base64-encoded. | -| `SerialNumber` | `string` | The serial number associated with <code>VirtualMFADevice</code>. | -| `Tags` | `array` | A list of tags that are attached to the virtual MFA device. For more information about tagging, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM resources</a> in the <i>IAM User Guide</i>. | -| `User` | `object` | <p>Contains information about an IAM user entity.</p> <p>This data type is used as a response element in the following operations:</p> <ul> <li> <p> <a>CreateUser</a> </p> </li> <li> <p> <a>GetUser</a> </p> </li> <li> <p> <a>ListUsers</a> </p> </li> </ul> | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `virtual_mfa_devices_List` | `SELECT` | `region` | <p>Lists the virtual MFA devices defined in the Amazon Web Services account by assignment status. If you do not specify an assignment status, the operation returns a list of all virtual MFA devices. Assignment status can be <code>Assigned</code>, <code>Unassigned</code>, or <code>Any</code>.</p> <note> <p>IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view tag information for a virtual MFA device, see <a>ListMFADeviceTags</a>.</p> </note> <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters.</p> | -| `virtual_mfa_devices_Create` | `INSERT` | `VirtualMFADeviceName, region` | <p>Creates a new virtual MFA device for the Amazon Web Services account. After creating the virtual MFA, use <a>EnableMFADevice</a> to attach the MFA device to an IAM user. For more information about creating and working with virtual MFA devices, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_VirtualMFA.html">Using a virtual MFA device</a> in the <i>IAM User Guide</i>.</p> <p>For information about the maximum number of MFA devices you can create, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html">IAM and STS quotas</a> in the <i>IAM User Guide</i>.</p> <important> <p>The seed information contained in the QR code and the Base32 string should be treated like any other secret access information. In other words, protect the seed information as you would your Amazon Web Services access keys or your passwords. After you provision your virtual device, you should ensure that the information is destroyed following secure procedures.</p> </important> | -| `virtual_mfa_devices_Delete` | `DELETE` | `SerialNumber, region` | <p>Deletes a virtual MFA device.</p> <note> <p> You must deactivate a user's virtual MFA device before you can delete it. For information about deactivating MFA devices, see <a>DeactivateMFADevice</a>. </p> </note> | diff --git a/docs/aws-docs/providers/aws/iam/virtualmfa_device/index.md b/docs/aws-docs/providers/aws/iam/virtualmfa_device/index.md new file mode 100644 index 0000000000..867eba8942 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam/virtualmfa_device/index.md @@ -0,0 +1,97 @@ +--- +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
DescriptionResource Type definition for AWS::IAM::VirtualMFADevice
Idaws.iam.virtualmfa_device
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
virtual_mfa_device_namestring
pathstring
serial_numberstring
usersarray
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +virtual_mfa_device_name, +path, +serial_number, +users, +tags +FROM aws.iam.virtualmfa_device +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the virtualmfa_device resource, the following permissions are required: + +### Read +```json +iam:ListVirtualMFADevices +``` + +### Update +```json +iam:TagMFADevice, +iam:UntagMFADevice +``` + +### Delete +```json +iam:DeleteVirtualMFADevice, +iam:DeactivateMFADevice +``` + diff --git a/docs/aws-docs/providers/aws/iam/virtualmfa_devices/index.md b/docs/aws-docs/providers/aws/iam/virtualmfa_devices/index.md new file mode 100644 index 0000000000..d384a6d908 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam/virtualmfa_devices/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource Type definition for AWS::IAM::VirtualMFADevice
Idaws.iam.virtualmfa_devices
+ +## Fields + + + + + +
NameDatatypeDescription
serial_numberstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +serial_number +FROM aws.iam.virtualmfa_devices + +``` + +## Permissions + +To operate on the virtualmfa_devices resource, the following permissions are required: + +### Create +```json +iam:CreateVirtualMFADevice, +iam:EnableMFADevice, +iam:ListVirtualMFADevices +``` + +### List +```json +iam:ListVirtualMFADevices +``` + diff --git a/docs/aws-docs/providers/aws/iam_api/access_key_last_useds/index.md b/docs/aws-docs/providers/aws/iam_api/access_key_last_useds/index.md new file mode 100644 index 0000000000..ea3dad0e84 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/access_key_last_useds/index.md @@ -0,0 +1,35 @@ +--- +title: access_key_last_useds +hide_title: false +hide_table_of_contents: false +keywords: + - access_key_last_useds + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameaccess_key_last_useds
TypeResource
Idaws.iam_api.access_key_last_useds
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `AccessKeyLastUsed` | `object` | <p>Contains information about the last time an Amazon Web Services access key was used since IAM began tracking this information on April 22, 2015.</p> <p>This data type is used as a response element in the <a>GetAccessKeyLastUsed</a> operation.</p> | +| `UserName` | `string` | <p>The name of the IAM user that owns this access key.</p> <p/> | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `access_key_last_useds_Get` | `SELECT` | `AccessKeyId, region` | diff --git a/docs/aws-docs/providers/aws/iam_api/access_keys/index.md b/docs/aws-docs/providers/aws/iam_api/access_keys/index.md new file mode 100644 index 0000000000..9e8b910eeb --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/access_keys/index.md @@ -0,0 +1,40 @@ +--- +title: access_keys +hide_title: false +hide_table_of_contents: false +keywords: + - access_keys + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameaccess_keys
TypeResource
Idaws.iam_api.access_keys
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `AccessKeyId` | `string` | The ID for this access key. | +| `CreateDate` | `string` | The date when the access key was created. | +| `Status` | `string` | The status of the access key. <code>Active</code> means that the key is valid for API calls; <code>Inactive</code> means it is not. | +| `UserName` | `string` | The name of the IAM user that the key is associated with. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `access_keys_List` | `SELECT` | `region` | <p>Returns information about the access key IDs associated with the specified IAM user. If there is none, the operation returns an empty list.</p> <p>Although each user is limited to a small number of keys, you can still paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters.</p> <p>If the <code>UserName</code> field is not specified, the user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.</p> <note> <p>To ensure the security of your Amazon Web Services account, the secret access key is accessible only during key and user creation.</p> </note> | +| `access_keys_Create` | `INSERT` | `region` | <p> Creates a new Amazon Web Services secret access key and corresponding Amazon Web Services access key ID for the specified user. The default status for new keys is <code>Active</code>.</p> <p>If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID signing the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials. This is true even if the Amazon Web Services account has no associated users.</p> <p> For information about quotas on the number of keys you can create, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html">IAM and STS quotas</a> in the <i>IAM User Guide</i>.</p> <important> <p>To ensure the security of your Amazon Web Services account, the secret access key is accessible only during key and user creation. You must save the key (for example, in a text file) if you want to be able to access it again. If a secret key is lost, you can delete the access keys for the associated user and then create new keys.</p> </important> | +| `access_keys_Delete` | `DELETE` | `AccessKeyId, region` | <p>Deletes the access key pair associated with the specified IAM user.</p> <p>If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID signing the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.</p> | +| `access_keys_Update` | `EXEC` | `AccessKeyId, Status, region` | <p>Changes the status of the specified access key from Active to Inactive, or vice versa. This operation can be used to disable a user's key as part of a key rotation workflow.</p> <p>If the <code>UserName</code> is not specified, the user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.</p> <p>For information about rotating keys, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/ManagingCredentials.html">Managing keys and certificates</a> in the <i>IAM User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/iam_api/account_alias/index.md b/docs/aws-docs/providers/aws/iam_api/account_alias/index.md new file mode 100644 index 0000000000..454076a35f --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/account_alias/index.md @@ -0,0 +1,33 @@ +--- +title: account_alias +hide_title: false +hide_table_of_contents: false +keywords: + - account_alias + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameaccount_alias
TypeResource
Idaws.iam_api.account_alias
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `account_alias_Create` | `INSERT` | `AccountAlias, region` | Creates an alias for your Amazon Web Services account. For information about using an Amazon Web Services account alias, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/AccountAlias.html">Using an alias for your Amazon Web Services account ID</a> in the <i>IAM User Guide</i>. | +| `account_alias_Delete` | `DELETE` | `AccountAlias, region` | Deletes the specified Amazon Web Services account alias. For information about using an Amazon Web Services account alias, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/AccountAlias.html">Using an alias for your Amazon Web Services account ID</a> in the <i>IAM User Guide</i>. | diff --git a/docs/aws-docs/providers/aws/iam_api/account_aliases/index.md b/docs/aws-docs/providers/aws/iam_api/account_aliases/index.md new file mode 100644 index 0000000000..64ac506a6c --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/account_aliases/index.md @@ -0,0 +1,32 @@ +--- +title: account_aliases +hide_title: false +hide_table_of_contents: false +keywords: + - account_aliases + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameaccount_aliases
TypeResource
Idaws.iam_api.account_aliases
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `account_aliases_List` | `EXEC` | `region` | diff --git a/docs/aws-docs/providers/aws/iam_api/account_authorization_details/index.md b/docs/aws-docs/providers/aws/iam_api/account_authorization_details/index.md new file mode 100644 index 0000000000..f9fe5298d0 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/account_authorization_details/index.md @@ -0,0 +1,39 @@ +--- +title: account_authorization_details +hide_title: false +hide_table_of_contents: false +keywords: + - account_authorization_details + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameaccount_authorization_details
TypeResource
Idaws.iam_api.account_authorization_details
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `GroupDetailList` | `array` | A list containing information about IAM groups. | +| `IsTruncated` | `boolean` | A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items. Note that IAM might return fewer than the <code>MaxItems</code> number of results even when there are more results available. We recommend that you check <code>IsTruncated</code> after every call to ensure that you receive all your results. | +| `Marker` | `string` | When <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value to use for the <code>Marker</code> parameter in a subsequent pagination request. | +| `Policies` | `array` | A list containing information about managed policies. | +| `RoleDetailList` | `array` | A list containing information about IAM roles. | +| `UserDetailList` | `array` | A list containing information about IAM users. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `account_authorization_details_Get` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/iam_api/account_password_policies/index.md b/docs/aws-docs/providers/aws/iam_api/account_password_policies/index.md new file mode 100644 index 0000000000..07bf0f5ed8 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/account_password_policies/index.md @@ -0,0 +1,33 @@ +--- +title: account_password_policies +hide_title: false +hide_table_of_contents: false +keywords: + - account_password_policies + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameaccount_password_policies
TypeResource
Idaws.iam_api.account_password_policies
+ +## Fields +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `account_password_policies_Get` | `SELECT` | `region` | Retrieves the password policy for the Amazon Web Services account. This tells you the complexity requirements and mandatory rotation periods for the IAM user passwords in your account. For more information about using a password policy, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingPasswordPolicies.html">Managing an IAM password policy</a>. | +| `account_password_policies_Delete` | `DELETE` | `region` | Deletes the password policy for the Amazon Web Services account. There are no parameters. | +| `account_password_policies_Update` | `EXEC` | `region` | <p>Updates the password policy settings for the Amazon Web Services account.</p> <note> <p>This operation does not support partial updates. No parameters are required, but if you do not specify a parameter, that parameter's value reverts to its default value. See the <b>Request Parameters</b> section for each parameter's default value. Also note that some parameters do not allow the default parameter to be explicitly set. Instead, to invoke the default value, do not include that parameter when you invoke the operation.</p> </note> <p> For more information about using a password policy, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingPasswordPolicies.html">Managing an IAM password policy</a> in the <i>IAM User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/iam_api/account_summaries/index.md b/docs/aws-docs/providers/aws/iam_api/account_summaries/index.md new file mode 100644 index 0000000000..9e8ea3767c --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/account_summaries/index.md @@ -0,0 +1,31 @@ +--- +title: account_summaries +hide_title: false +hide_table_of_contents: false +keywords: + - account_summaries + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameaccount_summaries
TypeResource
Idaws.iam_api.account_summaries
+ +## Fields +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `account_summaries_Get` | `SELECT` | `region` | diff --git a/docs/aws-docs/providers/aws/iam_api/assume_role_policies/index.md b/docs/aws-docs/providers/aws/iam_api/assume_role_policies/index.md new file mode 100644 index 0000000000..e3ac20729d --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/assume_role_policies/index.md @@ -0,0 +1,32 @@ +--- +title: assume_role_policies +hide_title: false +hide_table_of_contents: false +keywords: + - assume_role_policies + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameassume_role_policies
TypeResource
Idaws.iam_api.assume_role_policies
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `assume_role_policies_Update` | `EXEC` | `PolicyDocument, RoleName, region` | diff --git a/docs/aws-docs/providers/aws/iam_api/attached_group_policies/index.md b/docs/aws-docs/providers/aws/iam_api/attached_group_policies/index.md new file mode 100644 index 0000000000..900252c505 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/attached_group_policies/index.md @@ -0,0 +1,35 @@ +--- +title: attached_group_policies +hide_title: false +hide_table_of_contents: false +keywords: + - attached_group_policies + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameattached_group_policies
TypeResource
Idaws.iam_api.attached_group_policies
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `PolicyArn` | `string` | <p>The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.</p> <p>For more information about ARNs, go to <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>. </p> | +| `PolicyName` | `string` | The friendly name of the attached policy. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `attached_group_policies_List` | `SELECT` | `GroupName, region` | diff --git a/docs/aws-docs/providers/aws/iam_api/attached_role_policies/index.md b/docs/aws-docs/providers/aws/iam_api/attached_role_policies/index.md new file mode 100644 index 0000000000..e7ec7b503d --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/attached_role_policies/index.md @@ -0,0 +1,35 @@ +--- +title: attached_role_policies +hide_title: false +hide_table_of_contents: false +keywords: + - attached_role_policies + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameattached_role_policies
TypeResource
Idaws.iam_api.attached_role_policies
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `PolicyArn` | `string` | <p>The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.</p> <p>For more information about ARNs, go to <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>. </p> | +| `PolicyName` | `string` | The friendly name of the attached policy. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `attached_role_policies_List` | `SELECT` | `RoleName, region` | diff --git a/docs/aws-docs/providers/aws/iam_api/attached_user_policies/index.md b/docs/aws-docs/providers/aws/iam_api/attached_user_policies/index.md new file mode 100644 index 0000000000..c454884d4c --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/attached_user_policies/index.md @@ -0,0 +1,35 @@ +--- +title: attached_user_policies +hide_title: false +hide_table_of_contents: false +keywords: + - attached_user_policies + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameattached_user_policies
TypeResource
Idaws.iam_api.attached_user_policies
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `PolicyArn` | `string` | <p>The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.</p> <p>For more information about ARNs, go to <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>. </p> | +| `PolicyName` | `string` | The friendly name of the attached policy. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `attached_user_policies_List` | `SELECT` | `UserName, region` | diff --git a/docs/aws-docs/providers/aws/iam_api/client_id_from_open_id_connect_providers/index.md b/docs/aws-docs/providers/aws/iam_api/client_id_from_open_id_connect_providers/index.md new file mode 100644 index 0000000000..c42df4ba8b --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/client_id_from_open_id_connect_providers/index.md @@ -0,0 +1,32 @@ +--- +title: client_id_from_open_id_connect_providers +hide_title: false +hide_table_of_contents: false +keywords: + - client_id_from_open_id_connect_providers + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameclient_id_from_open_id_connect_providers
TypeResource
Idaws.iam_api.client_id_from_open_id_connect_providers
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `client_id_from_open_id_connect_providers_Remove` | `EXEC` | `ClientID, OpenIDConnectProviderArn, region` | diff --git a/docs/aws-docs/providers/aws/iam_api/context_keys_for_custom_policies/index.md b/docs/aws-docs/providers/aws/iam_api/context_keys_for_custom_policies/index.md new file mode 100644 index 0000000000..6fbe5bd505 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/context_keys_for_custom_policies/index.md @@ -0,0 +1,31 @@ +--- +title: context_keys_for_custom_policies +hide_title: false +hide_table_of_contents: false +keywords: + - context_keys_for_custom_policies + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namecontext_keys_for_custom_policies
TypeResource
Idaws.iam_api.context_keys_for_custom_policies
+ +## Fields +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `context_keys_for_custom_policies_Get` | `SELECT` | `PolicyInputList, region` | diff --git a/docs/aws-docs/providers/aws/iam_api/context_keys_for_principal_policies/index.md b/docs/aws-docs/providers/aws/iam_api/context_keys_for_principal_policies/index.md new file mode 100644 index 0000000000..b920f759f2 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/context_keys_for_principal_policies/index.md @@ -0,0 +1,31 @@ +--- +title: context_keys_for_principal_policies +hide_title: false +hide_table_of_contents: false +keywords: + - context_keys_for_principal_policies + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namecontext_keys_for_principal_policies
TypeResource
Idaws.iam_api.context_keys_for_principal_policies
+ +## Fields +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `context_keys_for_principal_policies_Get` | `SELECT` | `PolicySourceArn, region` | diff --git a/docs/aws-docs/providers/aws/iam_api/credential_reports/index.md b/docs/aws-docs/providers/aws/iam_api/credential_reports/index.md new file mode 100644 index 0000000000..34e9257e38 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/credential_reports/index.md @@ -0,0 +1,37 @@ +--- +title: credential_reports +hide_title: false +hide_table_of_contents: false +keywords: + - credential_reports + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namecredential_reports
TypeResource
Idaws.iam_api.credential_reports
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `Content` | `string` | Contains the credential report. The report is Base64-encoded. | +| `GeneratedTime` | `string` | The date and time when the credential report was created, in <a href="http://www.iso.org/iso/iso8601">ISO 8601 date-time format</a>. | +| `ReportFormat` | `string` | The format (MIME type) of the credential report. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `credential_reports_Get` | `SELECT` | `region` | Retrieves a credential report for the Amazon Web Services account. For more information about the credential report, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html">Getting credential reports</a> in the <i>IAM User Guide</i>. | +| `credential_reports_Generate` | `EXEC` | `region` | Generates a credential report for the Amazon Web Services account. For more information about the credential report, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html">Getting credential reports</a> in the <i>IAM User Guide</i>. | diff --git a/docs/aws-docs/providers/aws/iam_api/custom_policies/index.md b/docs/aws-docs/providers/aws/iam_api/custom_policies/index.md new file mode 100644 index 0000000000..0902596f59 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/custom_policies/index.md @@ -0,0 +1,32 @@ +--- +title: custom_policies +hide_title: false +hide_table_of_contents: false +keywords: + - custom_policies + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namecustom_policies
TypeResource
Idaws.iam_api.custom_policies
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `custom_policies_Simulate` | `EXEC` | `ActionNames, PolicyInputList, region` | diff --git a/docs/aws-docs/providers/aws/iam_api/default_policy_versions/index.md b/docs/aws-docs/providers/aws/iam_api/default_policy_versions/index.md new file mode 100644 index 0000000000..cc28d49e3a --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/default_policy_versions/index.md @@ -0,0 +1,32 @@ +--- +title: default_policy_versions +hide_title: false +hide_table_of_contents: false +keywords: + - default_policy_versions + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namedefault_policy_versions
TypeResource
Idaws.iam_api.default_policy_versions
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `default_policy_versions_Set` | `EXEC` | `PolicyArn, VersionId, region` | diff --git a/docs/aws-docs/providers/aws/iam_api/entities_for_policies/index.md b/docs/aws-docs/providers/aws/iam_api/entities_for_policies/index.md new file mode 100644 index 0000000000..7b57f46f95 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/entities_for_policies/index.md @@ -0,0 +1,35 @@ +--- +title: entities_for_policies +hide_title: false +hide_table_of_contents: false +keywords: + - entities_for_policies + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameentities_for_policies
TypeResource
Idaws.iam_api.entities_for_policies
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `GroupId` | `string` | The stable and unique string identifying the group. For more information about IDs, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html">IAM identifiers</a> in the <i>IAM User Guide</i>. | +| `GroupName` | `string` | The name (friendly name, not ARN) identifying the group. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `entities_for_policies_List` | `SELECT` | `PolicyArn, region` | diff --git a/docs/aws-docs/providers/aws/iam_api/group_policies/index.md b/docs/aws-docs/providers/aws/iam_api/group_policies/index.md new file mode 100644 index 0000000000..90abb6d4d4 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/group_policies/index.md @@ -0,0 +1,41 @@ +--- +title: group_policies +hide_title: false +hide_table_of_contents: false +keywords: + - group_policies + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namegroup_policies
TypeResource
Idaws.iam_api.group_policies
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `GroupName` | `string` | The group the policy is associated with. | +| `PolicyDocument` | `string` | <p>The policy document.</p> <p>IAM stores policies in JSON format. However, resources that were created using CloudFormation templates can be formatted in YAML. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.</p> | +| `PolicyName` | `string` | The name of the policy. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `group_policies_Get` | `SELECT` | `GroupName, PolicyName, region` | <p>Retrieves the specified inline policy document that is embedded in the specified IAM group.</p> <note> <p>Policies returned by this operation are URL-encoded compliant with <a href="https://tools.ietf.org/html/rfc3986">RFC 3986</a>. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the <code>decode</code> method of the <code>java.net.URLDecoder</code> utility class in the Java SDK. Other languages and SDKs provide similar functionality.</p> </note> <p>An IAM group can also have managed policies attached to it. To retrieve a managed policy document that is attached to a group, use <a>GetPolicy</a> to determine the policy's default version, then use <a>GetPolicyVersion</a> to retrieve the policy document.</p> <p>For more information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p> | +| `group_policies_List` | `SELECT` | `GroupName, region` | <p>Lists the names of the inline policies that are embedded in the specified IAM group.</p> <p>An IAM group can also have managed policies attached to it. To list the managed policies that are attached to a group, use <a>ListAttachedGroupPolicies</a>. For more information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p> <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. If there are no inline policies embedded with the specified group, the operation returns an empty list.</p> | +| `group_policies_Delete` | `DELETE` | `GroupName, PolicyName, region` | <p>Deletes the specified inline policy that is embedded in the specified IAM group.</p> <p>A group can also have managed policies attached to it. To detach a managed policy from a group, use <a>DetachGroupPolicy</a>. For more information about policies, refer to <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p> | +| `group_policies_Attach` | `EXEC` | `GroupName, PolicyArn, region` | <p>Attaches the specified managed policy to the specified IAM group.</p> <p>You use this operation to attach a managed policy to a group. To embed an inline policy in a group, use <a>PutGroupPolicy</a>.</p> <p>As a best practice, you can validate your IAM policies. To learn more, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html">Validating IAM policies</a> in the <i>IAM User Guide</i>.</p> <p>For more information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p> | +| `group_policies_Detach` | `EXEC` | `GroupName, PolicyArn, region` | <p>Removes the specified managed policy from the specified IAM group.</p> <p>A group can also have inline policies embedded with it. To delete an inline policy, use <a>DeleteGroupPolicy</a>. For information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p> | +| `group_policies_Put` | `EXEC` | `GroupName, PolicyDocument, PolicyName, region` | <p>Adds or updates an inline policy document that is embedded in the specified IAM group.</p> <p>A user can also have managed policies attached to it. To attach a managed policy to a group, use <a>AttachGroupPolicy</a>. To create a new managed policy, use <a>CreatePolicy</a>. For information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p> <p>For information about the maximum number of inline policies that you can embed in a group, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html">IAM and STS quotas</a> in the <i>IAM User Guide</i>.</p> <note> <p>Because policy documents can be large, you should use POST rather than GET when calling <code>PutGroupPolicy</code>. For general information about using the Query API with IAM, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html">Making query requests</a> in the <i>IAM User Guide</i>.</p> </note> | diff --git a/docs/aws-docs/providers/aws/iam_api/groups/index.md b/docs/aws-docs/providers/aws/iam_api/groups/index.md new file mode 100644 index 0000000000..ab0037051a --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/groups/index.md @@ -0,0 +1,42 @@ +--- +title: groups +hide_title: false +hide_table_of_contents: false +keywords: + - groups + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namegroups
TypeResource
Idaws.iam_api.groups
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `Arn` | `string` | <p>The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.</p> <p>For more information about ARNs, go to <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>. </p> | +| `CreateDate` | `string` | The date and time, in <a href="http://www.iso.org/iso/iso8601">ISO 8601 date-time format</a>, when the group was created. | +| `GroupId` | `string` | The stable and unique string identifying the group. For more information about IDs, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">IAM identifiers</a> in the <i>IAM User Guide</i>. | +| `GroupName` | `string` | The friendly name that identifies the group. | +| `Path` | `string` | The path to the group. For more information about paths, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">IAM identifiers</a> in the <i>IAM User Guide</i>. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `groups_Get` | `SELECT` | `GroupName, region` | Returns a list of IAM users that are in the specified IAM group. You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. | +| `groups_List` | `SELECT` | `region` | <p>Lists the IAM groups that have the specified path prefix.</p> <p> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters.</p> | +| `groups_Create` | `INSERT` | `GroupName, region` | <p>Creates a new group.</p> <p> For information about the number of groups you can create, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html">IAM and STS quotas</a> in the <i>IAM User Guide</i>.</p> | +| `groups_Delete` | `DELETE` | `GroupName, region` | Deletes the specified IAM group. The group must not contain any users or have any attached policies. | +| `groups_Update` | `EXEC` | `GroupName, region` | <p>Updates the name and/or the path of the specified IAM group.</p> <important> <p> You should understand the implications of changing a group's path or name. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_WorkingWithGroupsAndUsers.html">Renaming users and groups</a> in the <i>IAM User Guide</i>.</p> </important> <note> <p>The person making the request (the principal), must have permission to change the role group with the old name and the new name. For example, to change the group named <code>Managers</code> to <code>MGRs</code>, the principal must have a policy that allows them to update both groups. If the principal has permission to update the <code>Managers</code> group, but not the <code>MGRs</code> group, then the update fails. For more information about permissions, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html">Access management</a>. </p> </note> | diff --git a/docs/aws-docs/providers/aws/iam_api/groups_for_users/index.md b/docs/aws-docs/providers/aws/iam_api/groups_for_users/index.md new file mode 100644 index 0000000000..15c3abe5b1 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/groups_for_users/index.md @@ -0,0 +1,38 @@ +--- +title: groups_for_users +hide_title: false +hide_table_of_contents: false +keywords: + - groups_for_users + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namegroups_for_users
TypeResource
Idaws.iam_api.groups_for_users
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `Arn` | `string` | <p>The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.</p> <p>For more information about ARNs, go to <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>. </p> | +| `CreateDate` | `string` | The date and time, in <a href="http://www.iso.org/iso/iso8601">ISO 8601 date-time format</a>, when the group was created. | +| `GroupId` | `string` | The stable and unique string identifying the group. For more information about IDs, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">IAM identifiers</a> in the <i>IAM User Guide</i>. | +| `GroupName` | `string` | The friendly name that identifies the group. | +| `Path` | `string` | The path to the group. For more information about paths, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">IAM identifiers</a> in the <i>IAM User Guide</i>. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `groups_for_users_List` | `SELECT` | `UserName, region` | diff --git a/docs/aws-docs/providers/aws/iam_api/index.md b/docs/aws-docs/providers/aws/iam_api/index.md new file mode 100644 index 0000000000..1af61d78e1 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/index.md @@ -0,0 +1,107 @@ +--- +title: iam_api +hide_title: false +hide_table_of_contents: false +keywords: + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +iam_api + +:::info Service Summary + +
+
+total resources: 62
+total selectable resources: 44
+total methods: 156
+
+
+ +::: + +## Overview + + + + + + +
Nameaws.iam_api
TypeService
Titleiam_api
Descriptioniam_api
Idiam_api:v00.00.00000
+ +## Resources +
+
+access_key_last_useds
+access_keys
+account_alias
+account_aliases
+account_authorization_details
+account_password_policies
+account_summaries
+assume_role_policies
+attached_group_policies
+attached_role_policies
+attached_user_policies
+client_id_from_open_id_connect_providers
+context_keys_for_custom_policies
+context_keys_for_principal_policies
+credential_reports
+custom_policies
+default_policy_versions
+entities_for_policies
+group_policies
+groups
+groups_for_users
+instance_profile_tags
+instance_profiles
+instance_profiles_for_roles
+login_profiles
+mfa_device_tags
+mfa_devices
+open_id_connect_provider_tags
+open_id_connect_provider_thumbprints
+open_id_connect_providers
+organizations_access_reports
+
+
+passwords
+policies
+policy_tags
+policy_versions
+principal_policies
+role_descriptions
+role_from_instance_profiles
+role_permissions_boundaries
+role_policies
+role_tags
+role_to_instance_profiles
+roles
+saml_provider_tags
+saml_providers
+security_token_service_preferences
+server_certificate_tags
+server_certificates
+service_last_accessed_details
+service_last_accessed_details_with_entities
+service_linked_role_deletion_status
+service_linked_roles
+service_specific_credentials
+signing_certificates
+ssh_public_keys
+user_from_groups
+user_permissions_boundaries
+user_policies
+user_tags
+user_to_groups
+users
+virtual_mfa_devices
+
+
diff --git a/docs/aws-docs/providers/aws/iam_api/instance_profile_tags/index.md b/docs/aws-docs/providers/aws/iam_api/instance_profile_tags/index.md new file mode 100644 index 0000000000..03dacff71a --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/instance_profile_tags/index.md @@ -0,0 +1,35 @@ +--- +title: instance_profile_tags +hide_title: false +hide_table_of_contents: false +keywords: + - instance_profile_tags + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameinstance_profile_tags
TypeResource
Idaws.iam_api.instance_profile_tags
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `Key` | `string` | The key name that can be used to look up or retrieve the associated value. For example, <code>Department</code> or <code>Cost Center</code> are common choices. | +| `Value` | `string` | <p>The value associated with this tag. For example, tags with a key name of <code>Department</code> could have values such as <code>Human Resources</code>, <code>Accounting</code>, and <code>Support</code>. Tags with a key name of <code>Cost Center</code> might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values.</p> <note> <p>Amazon Web Services always interprets the tag <code>Value</code> as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.</p> </note> | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `instance_profile_tags_List` | `SELECT` | `InstanceProfileName, region` | diff --git a/docs/aws-docs/providers/aws/iam_api/instance_profiles/index.md b/docs/aws-docs/providers/aws/iam_api/instance_profiles/index.md new file mode 100644 index 0000000000..3631974016 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/instance_profiles/index.md @@ -0,0 +1,36 @@ +--- +title: instance_profiles +hide_title: false +hide_table_of_contents: false +keywords: + - instance_profiles + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameinstance_profiles
TypeResource
Idaws.iam_api.instance_profiles
+ +## Fields +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `instance_profiles_Get` | `SELECT` | `InstanceProfileName, region` | Retrieves information about the specified instance profile, including the instance profile's path, GUID, ARN, and role. For more information about instance profiles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html">About instance profiles</a> in the <i>IAM User Guide</i>. | +| `instance_profiles_List` | `SELECT` | `region` | <p>Lists the instance profiles that have the specified path prefix. If there are none, the operation returns an empty list. For more information about instance profiles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html">About instance profiles</a>.</p> <note> <p>IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for an instance profile, see <a>GetInstanceProfile</a>.</p> </note> <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters.</p> | +| `instance_profiles_Create` | `INSERT` | `InstanceProfileName, region` | <p> Creates a new instance profile. For information about instance profiles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2.html">Using roles for applications on Amazon EC2</a> in the <i>IAM User Guide</i>, and <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html#ec2-instance-profile">Instance profiles</a> in the <i>Amazon EC2 User Guide</i>.</p> <p> For information about the number of instance profiles you can create, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html">IAM object quotas</a> in the <i>IAM User Guide</i>.</p> | +| `instance_profiles_Delete` | `DELETE` | `InstanceProfileName, region` | <p>Deletes the specified instance profile. The instance profile must not have an associated role.</p> <important> <p>Make sure that you do not have any Amazon EC2 instances running with the instance profile you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance.</p> </important> <p>For more information about instance profiles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html">About instance profiles</a>.</p> | +| `instance_profiles_Tag` | `EXEC` | `InstanceProfileName, Tags, region` | <p>Adds one or more tags to an IAM instance profile. If a tag with the same key name already exists, then that tag is overwritten with the new value.</p> <p>Each tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:</p> <ul> <li> <p> <b>Administrative grouping and discovery</b> - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name <i>Project</i> and the value <i>MyImportantProject</i>. Or search for all resources with the key name <i>Cost Center</i> and the value <i>41200</i>. </p> </li> <li> <p> <b>Access control</b> - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM instance profile that has a specified tag attached. For examples of policies that show how to use tags to control access, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Control access using IAM tags</a> in the <i>IAM User Guide</i>.</p> </li> </ul> <note> <ul> <li> <p>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. For more information about tagging, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM resources</a> in the <i>IAM User Guide</i>.</p> </li> <li> <p>Amazon Web Services always interprets the tag <code>Value</code> as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.</p> </li> </ul> </note> | +| `instance_profiles_Untag` | `EXEC` | `InstanceProfileName, TagKeys, region` | Removes the specified tags from the IAM instance profile. For more information about tagging, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM resources</a> in the <i>IAM User Guide</i>. | diff --git a/docs/aws-docs/providers/aws/iam_api/instance_profiles_for_roles/index.md b/docs/aws-docs/providers/aws/iam_api/instance_profiles_for_roles/index.md new file mode 100644 index 0000000000..f84a7831be --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/instance_profiles_for_roles/index.md @@ -0,0 +1,40 @@ +--- +title: instance_profiles_for_roles +hide_title: false +hide_table_of_contents: false +keywords: + - instance_profiles_for_roles + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameinstance_profiles_for_roles
TypeResource
Idaws.iam_api.instance_profiles_for_roles
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `Arn` | `string` | <p>The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.</p> <p>For more information about ARNs, go to <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>. </p> | +| `CreateDate` | `string` | The date when the instance profile was created. | +| `InstanceProfileId` | `string` | The stable and unique string identifying the instance profile. For more information about IDs, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">IAM identifiers</a> in the <i>IAM User Guide</i>. | +| `InstanceProfileName` | `string` | The name identifying the instance profile. | +| `Path` | `string` | The path to the instance profile. For more information about paths, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">IAM identifiers</a> in the <i>IAM User Guide</i>. | +| `Roles` | `array` | <p>Contains a list of IAM roles.</p> <p>This data type is used as a response element in the <a>ListRoles</a> operation.</p> | +| `Tags` | `array` | A list of tags that are attached to the instance profile. For more information about tagging, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM resources</a> in the <i>IAM User Guide</i>. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `instance_profiles_for_roles_List` | `SELECT` | `RoleName, region` | diff --git a/docs/aws-docs/providers/aws/iam_api/login_profiles/index.md b/docs/aws-docs/providers/aws/iam_api/login_profiles/index.md new file mode 100644 index 0000000000..19c1148a4a --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/login_profiles/index.md @@ -0,0 +1,34 @@ +--- +title: login_profiles +hide_title: false +hide_table_of_contents: false +keywords: + - login_profiles + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namelogin_profiles
TypeResource
Idaws.iam_api.login_profiles
+ +## Fields +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `login_profiles_Get` | `SELECT` | `UserName, region` | <p>Retrieves the user name for the specified IAM user. A login profile is created when you create a password for the user to access the Amazon Web Services Management Console. If the user does not exist or does not have a password, the operation returns a 404 (<code>NoSuchEntity</code>) error.</p> <p>If you create an IAM user with access to the console, the <code>CreateDate</code> reflects the date you created the initial password for the user.</p> <p>If you create an IAM user with programmatic access, and then later add a password for the user to access the Amazon Web Services Management Console, the <code>CreateDate</code> reflects the initial password creation date. A user with programmatic access does not have a login profile unless you create a password for the user to access the Amazon Web Services Management Console.</p> | +| `login_profiles_Create` | `INSERT` | `Password, UserName, region` | <p>Creates a password for the specified IAM user. A password allows an IAM user to access Amazon Web Services services through the Amazon Web Services Management Console.</p> <p>You can use the CLI, the Amazon Web Services API, or the <b>Users</b> page in the IAM console to create a password for any IAM user. Use <a>ChangePassword</a> to update your own existing password in the <b>My Security Credentials</b> page in the Amazon Web Services Management Console.</p> <p>For more information about managing passwords, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html">Managing passwords</a> in the <i>IAM User Guide</i>.</p> | +| `login_profiles_Delete` | `DELETE` | `UserName, region` | <p>Deletes the password for the specified IAM user, which terminates the user's ability to access Amazon Web Services services through the Amazon Web Services Management Console.</p> <p>You can use the CLI, the Amazon Web Services API, or the <b>Users</b> page in the IAM console to delete a password for any IAM user. You can use <a>ChangePassword</a> to update, but not delete, your own password in the <b>My Security Credentials</b> page in the Amazon Web Services Management Console.</p> <important> <p> Deleting a user's password does not prevent a user from accessing Amazon Web Services through the command line interface or the API. To prevent all user access, you must also either make any access keys inactive or delete them. For more information about making keys inactive or deleting them, see <a>UpdateAccessKey</a> and <a>DeleteAccessKey</a>. </p> </important> | +| `login_profiles_Update` | `EXEC` | `UserName, region` | <p>Changes the password for the specified IAM user. You can use the CLI, the Amazon Web Services API, or the <b>Users</b> page in the IAM console to change the password for any IAM user. Use <a>ChangePassword</a> to change your own password in the <b>My Security Credentials</b> page in the Amazon Web Services Management Console.</p> <p>For more information about modifying passwords, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html">Managing passwords</a> in the <i>IAM User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/iam_api/mfa_device_tags/index.md b/docs/aws-docs/providers/aws/iam_api/mfa_device_tags/index.md new file mode 100644 index 0000000000..5d650abdbe --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/mfa_device_tags/index.md @@ -0,0 +1,35 @@ +--- +title: mfa_device_tags +hide_title: false +hide_table_of_contents: false +keywords: + - mfa_device_tags + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namemfa_device_tags
TypeResource
Idaws.iam_api.mfa_device_tags
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `Key` | `string` | The key name that can be used to look up or retrieve the associated value. For example, <code>Department</code> or <code>Cost Center</code> are common choices. | +| `Value` | `string` | <p>The value associated with this tag. For example, tags with a key name of <code>Department</code> could have values such as <code>Human Resources</code>, <code>Accounting</code>, and <code>Support</code>. Tags with a key name of <code>Cost Center</code> might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values.</p> <note> <p>Amazon Web Services always interprets the tag <code>Value</code> as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.</p> </note> | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `mfa_device_tags_List` | `SELECT` | `SerialNumber, region` | diff --git a/docs/aws-docs/providers/aws/iam_api/mfa_devices/index.md b/docs/aws-docs/providers/aws/iam_api/mfa_devices/index.md new file mode 100644 index 0000000000..614b2a5c83 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/mfa_devices/index.md @@ -0,0 +1,41 @@ +--- +title: mfa_devices +hide_title: false +hide_table_of_contents: false +keywords: + - mfa_devices + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namemfa_devices
TypeResource
Idaws.iam_api.mfa_devices
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `EnableDate` | `string` | The date when the MFA device was enabled for the user. | +| `SerialNumber` | `string` | The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN. | +| `UserName` | `string` | The user with whom the MFA device is associated. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `mfa_devices_List` | `SELECT` | `region` | <p>Lists the MFA devices for an IAM user. If the request includes a IAM user name, then this operation lists all the MFA devices associated with the specified user. If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID signing the request for this operation.</p> <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters.</p> | +| `mfa_devices_Deactivate` | `EXEC` | `SerialNumber, UserName, region` | <p>Deactivates the specified MFA device and removes it from association with the user name for which it was originally enabled.</p> <p>For more information about creating and working with virtual MFA devices, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_VirtualMFA.html">Enabling a virtual multi-factor authentication (MFA) device</a> in the <i>IAM User Guide</i>.</p> | +| `mfa_devices_Enable` | `EXEC` | `AuthenticationCode1, AuthenticationCode2, SerialNumber, UserName, region` | Enables the specified MFA device and associates it with the specified IAM user. When enabled, the MFA device is required for every subsequent login by the IAM user associated with the device. | +| `mfa_devices_Resync` | `EXEC` | `AuthenticationCode1, AuthenticationCode2, SerialNumber, UserName, region` | <p>Synchronizes the specified MFA device with its IAM resource object on the Amazon Web Services servers.</p> <p>For more information about creating and working with virtual MFA devices, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_VirtualMFA.html">Using a virtual MFA device</a> in the <i>IAM User Guide</i>.</p> | +| `mfa_devices_Tag` | `EXEC` | `SerialNumber, Tags, region` | <p>Adds one or more tags to an IAM virtual multi-factor authentication (MFA) device. If a tag with the same key name already exists, then that tag is overwritten with the new value.</p> <p>A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:</p> <ul> <li> <p> <b>Administrative grouping and discovery</b> - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name <i>Project</i> and the value <i>MyImportantProject</i>. Or search for all resources with the key name <i>Cost Center</i> and the value <i>41200</i>. </p> </li> <li> <p> <b>Access control</b> - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM virtual MFA device that has a specified tag attached. For examples of policies that show how to use tags to control access, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Control access using IAM tags</a> in the <i>IAM User Guide</i>.</p> </li> </ul> <note> <ul> <li> <p>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. For more information about tagging, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM resources</a> in the <i>IAM User Guide</i>.</p> </li> <li> <p>Amazon Web Services always interprets the tag <code>Value</code> as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.</p> </li> </ul> </note> | +| `mfa_devices_Untag` | `EXEC` | `SerialNumber, TagKeys, region` | Removes the specified tags from the IAM virtual multi-factor authentication (MFA) device. For more information about tagging, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM resources</a> in the <i>IAM User Guide</i>. | diff --git a/docs/aws-docs/providers/aws/iam_api/open_id_connect_provider_tags/index.md b/docs/aws-docs/providers/aws/iam_api/open_id_connect_provider_tags/index.md new file mode 100644 index 0000000000..a17948ff5d --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/open_id_connect_provider_tags/index.md @@ -0,0 +1,35 @@ +--- +title: open_id_connect_provider_tags +hide_title: false +hide_table_of_contents: false +keywords: + - open_id_connect_provider_tags + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameopen_id_connect_provider_tags
TypeResource
Idaws.iam_api.open_id_connect_provider_tags
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `Key` | `string` | The key name that can be used to look up or retrieve the associated value. For example, <code>Department</code> or <code>Cost Center</code> are common choices. | +| `Value` | `string` | <p>The value associated with this tag. For example, tags with a key name of <code>Department</code> could have values such as <code>Human Resources</code>, <code>Accounting</code>, and <code>Support</code>. Tags with a key name of <code>Cost Center</code> might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values.</p> <note> <p>Amazon Web Services always interprets the tag <code>Value</code> as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.</p> </note> | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `open_id_connect_provider_tags_List` | `SELECT` | `OpenIDConnectProviderArn, region` | diff --git a/docs/aws-docs/providers/aws/iam_api/open_id_connect_provider_thumbprints/index.md b/docs/aws-docs/providers/aws/iam_api/open_id_connect_provider_thumbprints/index.md new file mode 100644 index 0000000000..0a5119f83e --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/open_id_connect_provider_thumbprints/index.md @@ -0,0 +1,32 @@ +--- +title: open_id_connect_provider_thumbprints +hide_title: false +hide_table_of_contents: false +keywords: + - open_id_connect_provider_thumbprints + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameopen_id_connect_provider_thumbprints
TypeResource
Idaws.iam_api.open_id_connect_provider_thumbprints
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `open_id_connect_provider_thumbprints_Update` | `EXEC` | `OpenIDConnectProviderArn, ThumbprintList, region` | diff --git a/docs/aws-docs/providers/aws/iam_api/open_id_connect_providers/index.md b/docs/aws-docs/providers/aws/iam_api/open_id_connect_providers/index.md new file mode 100644 index 0000000000..48ec97e122 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/open_id_connect_providers/index.md @@ -0,0 +1,43 @@ +--- +title: open_id_connect_providers +hide_title: false +hide_table_of_contents: false +keywords: + - open_id_connect_providers + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameopen_id_connect_providers
TypeResource
Idaws.iam_api.open_id_connect_providers
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `ClientIDList` | `array` | A list of client IDs (also known as audiences) that are associated with the specified IAM OIDC provider resource object. For more information, see <a>CreateOpenIDConnectProvider</a>. | +| `CreateDate` | `string` | The date and time when the IAM OIDC provider resource object was created in the Amazon Web Services account. | +| `Tags` | `array` | A list of tags that are attached to the specified IAM OIDC provider. The returned list of tags is sorted by tag key. For more information about tagging, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM resources</a> in the <i>IAM User Guide</i>. | +| `ThumbprintList` | `array` | Contains a list of thumbprints of identity provider server certificates. | +| `Url` | `string` | Contains a URL that specifies the endpoint for an OpenID Connect provider. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `open_id_connect_providers_Get` | `SELECT` | `OpenIDConnectProviderArn, region` | Returns information about the specified OpenID Connect (OIDC) provider resource object in IAM. | +| `open_id_connect_providers_List` | `SELECT` | `region` | <p>Lists information about the IAM OpenID Connect (OIDC) provider resource objects defined in the Amazon Web Services account.</p> <note> <p>IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for an OIDC provider, see <a>GetOpenIDConnectProvider</a>.</p> </note> | +| `open_id_connect_providers_Create` | `INSERT` | `ThumbprintList, Url, region` | <p>Creates an IAM entity to describe an identity provider (IdP) that supports <a href="http://openid.net/connect/">OpenID Connect (OIDC)</a>.</p> <p>The OIDC provider that you create with this operation can be used as a principal in a role's trust policy. Such a policy establishes a trust relationship between Amazon Web Services and the OIDC provider.</p> <p>If you are using an OIDC identity provider from Google, Facebook, or Amazon Cognito, you don't need to create a separate IAM identity provider. These OIDC identity providers are already built-in to Amazon Web Services and are available for your use. Instead, you can move directly to creating new roles using your identity provider. To learn more, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-idp_oidc.html">Creating a role for web identity or OpenID connect federation</a> in the <i>IAM User Guide</i>.</p> <p>When you create the IAM OIDC provider, you specify the following:</p> <ul> <li> <p>The URL of the OIDC identity provider (IdP) to trust</p> </li> <li> <p>A list of client IDs (also known as audiences) that identify the application or applications allowed to authenticate using the OIDC provider</p> </li> <li> <p>A list of thumbprints of one or more server certificates that the IdP uses</p> </li> </ul> <p>You get all of this information from the OIDC IdP you want to use to access Amazon Web Services.</p> <note> <p>Amazon Web Services secures communication with some OIDC identity providers (IdPs) through our library of trusted certificate authorities (CAs) instead of using a certificate thumbprint to verify your IdP server certificate. These OIDC IdPs include Google, and those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS) endpoint. In these cases, your legacy thumbprint remains in your configuration, but is no longer used for validation.</p> </note> <note> <p>The trust for the OIDC provider is derived from the IAM provider that this operation creates. Therefore, it is best to limit access to the <a>CreateOpenIDConnectProvider</a> operation to highly privileged users.</p> </note> | +| `open_id_connect_providers_Delete` | `DELETE` | `OpenIDConnectProviderArn, region` | <p>Deletes an OpenID Connect identity provider (IdP) resource object in IAM.</p> <p>Deleting an IAM OIDC provider resource does not update any roles that reference the provider as a principal in their trust policies. Any attempt to assume a role that references a deleted provider fails.</p> <p>This operation is idempotent; it does not fail or return an error if you call the operation for a provider that does not exist.</p> | +| `open_id_connect_providers_Tag` | `EXEC` | `OpenIDConnectProviderArn, Tags, region` | <p>Adds one or more tags to an OpenID Connect (OIDC)-compatible identity provider. For more information about these providers, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc.html">About web identity federation</a>. If a tag with the same key name already exists, then that tag is overwritten with the new value.</p> <p>A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:</p> <ul> <li> <p> <b>Administrative grouping and discovery</b> - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name <i>Project</i> and the value <i>MyImportantProject</i>. Or search for all resources with the key name <i>Cost Center</i> and the value <i>41200</i>. </p> </li> <li> <p> <b>Access control</b> - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an OIDC provider that has a specified tag attached. For examples of policies that show how to use tags to control access, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Control access using IAM tags</a> in the <i>IAM User Guide</i>.</p> </li> </ul> <note> <ul> <li> <p>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. For more information about tagging, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM resources</a> in the <i>IAM User Guide</i>.</p> </li> <li> <p>Amazon Web Services always interprets the tag <code>Value</code> as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.</p> </li> </ul> </note> | +| `open_id_connect_providers_Untag` | `EXEC` | `OpenIDConnectProviderArn, TagKeys, region` | Removes the specified tags from the specified OpenID Connect (OIDC)-compatible identity provider in IAM. For more information about OIDC providers, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc.html">About web identity federation</a>. For more information about tagging, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM resources</a> in the <i>IAM User Guide</i>. | diff --git a/docs/aws-docs/providers/aws/iam_api/organizations_access_reports/index.md b/docs/aws-docs/providers/aws/iam_api/organizations_access_reports/index.md new file mode 100644 index 0000000000..9ccad00e4c --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/organizations_access_reports/index.md @@ -0,0 +1,43 @@ +--- +title: organizations_access_reports +hide_title: false +hide_table_of_contents: false +keywords: + - organizations_access_reports + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameorganizations_access_reports
TypeResource
Idaws.iam_api.organizations_access_reports
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `AccessDetails` | `array` | An object that contains details about the most recent attempt to access the service. | +| `ErrorDetails` | `object` | <p>Contains information about the reason that the operation failed.</p> <p>This data type is used as a response element in the <a>GetOrganizationsAccessReport</a>, <a>GetServiceLastAccessedDetails</a>, and <a>GetServiceLastAccessedDetailsWithEntities</a> operations.</p> | +| `IsTruncated` | `boolean` | A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items. Note that IAM might return fewer than the <code>MaxItems</code> number of results even when there are more results available. We recommend that you check <code>IsTruncated</code> after every call to ensure that you receive all your results. | +| `JobCompletionDate` | `string` | <p>The date and time, in <a href="http://www.iso.org/iso/iso8601">ISO 8601 date-time format</a>, when the generated report job was completed or failed.</p> <p>This field is null if the job is still in progress, as indicated by a job status value of <code>IN_PROGRESS</code>.</p> | +| `JobCreationDate` | `string` | The date and time, in <a href="http://www.iso.org/iso/iso8601">ISO 8601 date-time format</a>, when the report job was created. | +| `JobStatus` | `string` | The status of the job. | +| `Marker` | `string` | When <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value to use for the <code>Marker</code> parameter in a subsequent pagination request. | +| `NumberOfServicesAccessible` | `integer` | The number of services that the applicable SCPs allow account principals to access. | +| `NumberOfServicesNotAccessed` | `integer` | The number of services that account principals are allowed but did not attempt to access. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `organizations_access_reports_Get` | `SELECT` | `JobId, region` | <p>Retrieves the service last accessed data report for Organizations that was previously generated using the <code> <a>GenerateOrganizationsAccessReport</a> </code> operation. This operation retrieves the status of your report job and the report contents.</p> <p>Depending on the parameters that you passed when you generated the report, the data returned could include different information. For details, see <a>GenerateOrganizationsAccessReport</a>.</p> <p>To call this operation, you must be signed in to the management account in your organization. SCPs must be enabled for your organization root. You must have permissions to perform this operation. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html">Refining permissions using service last accessed data</a> in the <i>IAM User Guide</i>.</p> <p>For each service that principals in an account (root users, IAM users, or IAM roles) could access using SCPs, the operation returns details about the most recent access attempt. If there was no attempt, the service is listed without details about the most recent attempt to access the service. If the operation fails, it returns the reason that it failed.</p> <p>By default, the list is sorted by service namespace.</p> | +| `organizations_access_reports_Generate` | `EXEC` | `EntityPath, region` | <p>Generates a report for service last accessed data for Organizations. You can generate a report for any entities (organization root, organizational unit, or account) or policies in your organization.</p> <p>To call this operation, you must be signed in using your Organizations management account credentials. You can use your long-term IAM user or root user credentials, or temporary credentials from assuming an IAM role. SCPs must be enabled for your organization root. You must have the required IAM and Organizations permissions. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html">Refining permissions using service last accessed data</a> in the <i>IAM User Guide</i>.</p> <p>You can generate a service last accessed data report for entities by specifying only the entity's path. This data includes a list of services that are allowed by any service control policies (SCPs) that apply to the entity.</p> <p>You can generate a service last accessed data report for a policy by specifying an entity's path and an optional Organizations policy ID. This data includes a list of services that are allowed by the specified SCP.</p> <p>For each service in both report types, the data includes the most recent account activity that the policy allows to account principals in the entity or the entity's children. For important information about the data, reporting period, permissions required, troubleshooting, and supported Regions see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html">Reducing permissions using service last accessed data</a> in the <i>IAM User Guide</i>.</p> <important> <p>The data includes all attempts to access Amazon Web Services, not just the successful ones. This includes all attempts that were made using the Amazon Web Services Management Console, the Amazon Web Services API through any of the SDKs, or any of the command line tools. An unexpected entry in the service last accessed data does not mean that an account has been compromised, because the request might have been denied. Refer to your CloudTrail logs as the authoritative source for information about all API calls and whether they were successful or denied access. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/cloudtrail-integration.html">Logging IAM events with CloudTrail</a> in the <i>IAM User Guide</i>.</p> </important> <p>This operation returns a <code>JobId</code>. Use this parameter in the <code> <a>GetOrganizationsAccessReport</a> </code> operation to check the status of the report generation. To check the status of this request, use the <code>JobId</code> parameter in the <code> <a>GetOrganizationsAccessReport</a> </code> operation and test the <code>JobStatus</code> response parameter. When the job is complete, you can retrieve the report.</p> <p>To generate a service last accessed data report for entities, specify an entity path without specifying the optional Organizations policy ID. The type of entity that you specify determines the data returned in the report.</p> <ul> <li> <p> <b>Root</b> – When you specify the organizations root as the entity, the resulting report lists all of the services allowed by SCPs that are attached to your root. For each service, the report includes data for all accounts in your organization except the management account, because the management account is not limited by SCPs.</p> </li> <li> <p> <b>OU</b> – When you specify an organizational unit (OU) as the entity, the resulting report lists all of the services allowed by SCPs that are attached to the OU and its parents. For each service, the report includes data for all accounts in the OU or its children. This data excludes the management account, because the management account is not limited by SCPs.</p> </li> <li> <p> <b>management account</b> – When you specify the management account, the resulting report lists all Amazon Web Services services, because the management account is not limited by SCPs. For each service, the report includes data for only the management account.</p> </li> <li> <p> <b>Account</b> – When you specify another account as the entity, the resulting report lists all of the services allowed by SCPs that are attached to the account and its parents. For each service, the report includes data for only the specified account.</p> </li> </ul> <p>To generate a service last accessed data report for policies, specify an entity path and the optional Organizations policy ID. The type of entity that you specify determines the data returned for each service.</p> <ul> <li> <p> <b>Root</b> – When you specify the root entity and a policy ID, the resulting report lists all of the services that are allowed by the specified SCP. For each service, the report includes data for all accounts in your organization to which the SCP applies. This data excludes the management account, because the management account is not limited by SCPs. If the SCP is not attached to any entities in the organization, then the report will return a list of services with no data.</p> </li> <li> <p> <b>OU</b> – When you specify an OU entity and a policy ID, the resulting report lists all of the services that are allowed by the specified SCP. For each service, the report includes data for all accounts in the OU or its children to which the SCP applies. This means that other accounts outside the OU that are affected by the SCP might not be included in the data. This data excludes the management account, because the management account is not limited by SCPs. If the SCP is not attached to the OU or one of its children, the report will return a list of services with no data.</p> </li> <li> <p> <b>management account</b> – When you specify the management account, the resulting report lists all Amazon Web Services services, because the management account is not limited by SCPs. If you specify a policy ID in the CLI or API, the policy is ignored. For each service, the report includes data for only the management account.</p> </li> <li> <p> <b>Account</b> – When you specify another account entity and a policy ID, the resulting report lists all of the services that are allowed by the specified SCP. For each service, the report includes data for only the specified account. This means that other accounts in the organization that are affected by the SCP might not be included in the data. If the SCP is not attached to the account, the report will return a list of services with no data.</p> </li> </ul> <note> <p>Service last accessed data does not use other policy types when determining whether a principal could access a service. These other policy types include identity-based policies, resource-based policies, access control lists, IAM permissions boundaries, and STS assume role policies. It only applies SCP logic. For more about the evaluation of policy types, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html#policy-eval-basics">Evaluating policies</a> in the <i>IAM User Guide</i>.</p> </note> <p>For more information about service last accessed data, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html">Reducing policy scope by viewing user activity</a> in the <i>IAM User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/iam_api/passwords/index.md b/docs/aws-docs/providers/aws/iam_api/passwords/index.md new file mode 100644 index 0000000000..ad70a0dd6d --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/passwords/index.md @@ -0,0 +1,32 @@ +--- +title: passwords +hide_title: false +hide_table_of_contents: false +keywords: + - passwords + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namepasswords
TypeResource
Idaws.iam_api.passwords
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `passwords_Change` | `EXEC` | `NewPassword, OldPassword, region` | diff --git a/docs/aws-docs/providers/aws/iam_api/policies/index.md b/docs/aws-docs/providers/aws/iam_api/policies/index.md new file mode 100644 index 0000000000..f634c38b4f --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/policies/index.md @@ -0,0 +1,36 @@ +--- +title: policies +hide_title: false +hide_table_of_contents: false +keywords: + - policies + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namepolicies
TypeResource
Idaws.iam_api.policies
+ +## Fields +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `policies_Get` | `SELECT` | `PolicyArn, region` | <p>Retrieves information about the specified managed policy, including the policy's default version and the total number of IAM users, groups, and roles to which the policy is attached. To retrieve the list of the specific users, groups, and roles that the policy is attached to, use <a>ListEntitiesForPolicy</a>. This operation returns metadata about the policy. To retrieve the actual policy document for a specific version of the policy, use <a>GetPolicyVersion</a>.</p> <p>This operation retrieves information about managed policies. To retrieve information about an inline policy that is embedded with an IAM user, group, or role, use <a>GetUserPolicy</a>, <a>GetGroupPolicy</a>, or <a>GetRolePolicy</a>.</p> <p>For more information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p> | +| `policies_List` | `SELECT` | `region` | <p>Lists all the managed policies that are available in your Amazon Web Services account, including your own customer-defined managed policies and all Amazon Web Services managed policies.</p> <p>You can filter the list of policies that is returned using the optional <code>OnlyAttached</code>, <code>Scope</code>, and <code>PathPrefix</code> parameters. For example, to list only the customer managed policies in your Amazon Web Services account, set <code>Scope</code> to <code>Local</code>. To list only Amazon Web Services managed policies, set <code>Scope</code> to <code>AWS</code>.</p> <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters.</p> <p>For more information about managed policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p> <note> <p>IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a customer manged policy, see <a>GetPolicy</a>.</p> </note> | +| `policies_Create` | `INSERT` | `PolicyDocument, PolicyName, region` | <p>Creates a new managed policy for your Amazon Web Services account.</p> <p>This operation creates a policy version with a version identifier of <code>v1</code> and sets v1 as the policy's default version. For more information about policy versions, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html">Versioning for managed policies</a> in the <i>IAM User Guide</i>.</p> <p>As a best practice, you can validate your IAM policies. To learn more, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html">Validating IAM policies</a> in the <i>IAM User Guide</i>.</p> <p>For more information about managed policies in general, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p> | +| `policies_Delete` | `DELETE` | `PolicyArn, region` | <p>Deletes the specified managed policy.</p> <p>Before you can delete a managed policy, you must first detach the policy from all users, groups, and roles that it is attached to. In addition, you must delete all the policy's versions. The following steps describe the process for deleting a managed policy:</p> <ul> <li> <p>Detach the policy from all users, groups, and roles that the policy is attached to, using <a>DetachUserPolicy</a>, <a>DetachGroupPolicy</a>, or <a>DetachRolePolicy</a>. To list all the users, groups, and roles that a policy is attached to, use <a>ListEntitiesForPolicy</a>.</p> </li> <li> <p>Delete all versions of the policy using <a>DeletePolicyVersion</a>. To list the policy's versions, use <a>ListPolicyVersions</a>. You cannot use <a>DeletePolicyVersion</a> to delete the version that is marked as the default version. You delete the policy's default version in the next step of the process.</p> </li> <li> <p>Delete the policy (this automatically deletes the policy's default version) using this operation.</p> </li> </ul> <p>For information about managed policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p> | +| `policies_Tag` | `EXEC` | `PolicyArn, Tags, region` | <p>Adds one or more tags to an IAM customer managed policy. If a tag with the same key name already exists, then that tag is overwritten with the new value.</p> <p>A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:</p> <ul> <li> <p> <b>Administrative grouping and discovery</b> - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name <i>Project</i> and the value <i>MyImportantProject</i>. Or search for all resources with the key name <i>Cost Center</i> and the value <i>41200</i>. </p> </li> <li> <p> <b>Access control</b> - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM customer managed policy that has a specified tag attached. For examples of policies that show how to use tags to control access, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Control access using IAM tags</a> in the <i>IAM User Guide</i>.</p> </li> </ul> <note> <ul> <li> <p>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. For more information about tagging, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM resources</a> in the <i>IAM User Guide</i>.</p> </li> <li> <p>Amazon Web Services always interprets the tag <code>Value</code> as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.</p> </li> </ul> </note> | +| `policies_Untag` | `EXEC` | `PolicyArn, TagKeys, region` | Removes the specified tags from the customer managed policy. For more information about tagging, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM resources</a> in the <i>IAM User Guide</i>. | diff --git a/docs/aws-docs/providers/aws/iam_api/policy_tags/index.md b/docs/aws-docs/providers/aws/iam_api/policy_tags/index.md new file mode 100644 index 0000000000..82da2b6b57 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/policy_tags/index.md @@ -0,0 +1,35 @@ +--- +title: policy_tags +hide_title: false +hide_table_of_contents: false +keywords: + - policy_tags + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namepolicy_tags
TypeResource
Idaws.iam_api.policy_tags
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `Key` | `string` | The key name that can be used to look up or retrieve the associated value. For example, <code>Department</code> or <code>Cost Center</code> are common choices. | +| `Value` | `string` | <p>The value associated with this tag. For example, tags with a key name of <code>Department</code> could have values such as <code>Human Resources</code>, <code>Accounting</code>, and <code>Support</code>. Tags with a key name of <code>Cost Center</code> might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values.</p> <note> <p>Amazon Web Services always interprets the tag <code>Value</code> as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.</p> </note> | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `policy_tags_List` | `SELECT` | `PolicyArn, region` | diff --git a/docs/aws-docs/providers/aws/iam_api/policy_versions/index.md b/docs/aws-docs/providers/aws/iam_api/policy_versions/index.md new file mode 100644 index 0000000000..e7874be002 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/policy_versions/index.md @@ -0,0 +1,34 @@ +--- +title: policy_versions +hide_title: false +hide_table_of_contents: false +keywords: + - policy_versions + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namepolicy_versions
TypeResource
Idaws.iam_api.policy_versions
+ +## Fields +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `policy_versions_Get` | `SELECT` | `PolicyArn, VersionId, region` | <p>Retrieves information about the specified version of the specified managed policy, including the policy document.</p> <note> <p>Policies returned by this operation are URL-encoded compliant with <a href="https://tools.ietf.org/html/rfc3986">RFC 3986</a>. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the <code>decode</code> method of the <code>java.net.URLDecoder</code> utility class in the Java SDK. Other languages and SDKs provide similar functionality.</p> </note> <p>To list the available versions for a policy, use <a>ListPolicyVersions</a>.</p> <p>This operation retrieves information about managed policies. To retrieve information about an inline policy that is embedded in a user, group, or role, use <a>GetUserPolicy</a>, <a>GetGroupPolicy</a>, or <a>GetRolePolicy</a>.</p> <p>For more information about the types of policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p> <p>For more information about managed policy versions, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html">Versioning for managed policies</a> in the <i>IAM User Guide</i>.</p> | +| `policy_versions_List` | `SELECT` | `PolicyArn, region` | <p>Lists information about the versions of the specified managed policy, including the version that is currently set as the policy's default version.</p> <p>For more information about managed policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p> | +| `policy_versions_Create` | `INSERT` | `PolicyArn, PolicyDocument, region` | <p>Creates a new version of the specified managed policy. To update a managed policy, you create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must delete an existing version using <a>DeletePolicyVersion</a> before you create a new version.</p> <p>Optionally, you can set the new version as the policy's default version. The default version is the version that is in effect for the IAM users, groups, and roles to which the policy is attached.</p> <p>For more information about managed policy versions, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html">Versioning for managed policies</a> in the <i>IAM User Guide</i>.</p> | +| `policy_versions_Delete` | `DELETE` | `PolicyArn, VersionId, region` | <p>Deletes the specified version from the specified managed policy.</p> <p>You cannot delete the default version from a policy using this operation. To delete the default version from a policy, use <a>DeletePolicy</a>. To find out which version of a policy is marked as the default version, use <a>ListPolicyVersions</a>.</p> <p>For information about versions for managed policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html">Versioning for managed policies</a> in the <i>IAM User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/iam_api/principal_policies/index.md b/docs/aws-docs/providers/aws/iam_api/principal_policies/index.md new file mode 100644 index 0000000000..0284a79779 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/principal_policies/index.md @@ -0,0 +1,32 @@ +--- +title: principal_policies +hide_title: false +hide_table_of_contents: false +keywords: + - principal_policies + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameprincipal_policies
TypeResource
Idaws.iam_api.principal_policies
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `principal_policies_Simulate` | `EXEC` | `ActionNames, PolicySourceArn, region` | diff --git a/docs/aws-docs/providers/aws/iam_api/role_descriptions/index.md b/docs/aws-docs/providers/aws/iam_api/role_descriptions/index.md new file mode 100644 index 0000000000..86214fc66e --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/role_descriptions/index.md @@ -0,0 +1,32 @@ +--- +title: role_descriptions +hide_title: false +hide_table_of_contents: false +keywords: + - role_descriptions + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namerole_descriptions
TypeResource
Idaws.iam_api.role_descriptions
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `role_descriptions_Update` | `EXEC` | `Description, RoleName, region` | diff --git a/docs/aws-docs/providers/aws/iam_api/role_from_instance_profiles/index.md b/docs/aws-docs/providers/aws/iam_api/role_from_instance_profiles/index.md new file mode 100644 index 0000000000..8b7903aab0 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/role_from_instance_profiles/index.md @@ -0,0 +1,32 @@ +--- +title: role_from_instance_profiles +hide_title: false +hide_table_of_contents: false +keywords: + - role_from_instance_profiles + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namerole_from_instance_profiles
TypeResource
Idaws.iam_api.role_from_instance_profiles
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `role_from_instance_profiles_Remove` | `EXEC` | `InstanceProfileName, RoleName, region` | diff --git a/docs/aws-docs/providers/aws/iam_api/role_permissions_boundaries/index.md b/docs/aws-docs/providers/aws/iam_api/role_permissions_boundaries/index.md new file mode 100644 index 0000000000..c16e1d839f --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/role_permissions_boundaries/index.md @@ -0,0 +1,33 @@ +--- +title: role_permissions_boundaries +hide_title: false +hide_table_of_contents: false +keywords: + - role_permissions_boundaries + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namerole_permissions_boundaries
TypeResource
Idaws.iam_api.role_permissions_boundaries
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `role_permissions_boundaries_Delete` | `DELETE` | `RoleName, region` | <p>Deletes the permissions boundary for the specified IAM role. </p> <important> <p>Deleting the permissions boundary for a role might increase its permissions. For example, it might allow anyone who assumes the role to perform all the actions granted in its permissions policies. </p> </important> | +| `role_permissions_boundaries_Put` | `EXEC` | `PermissionsBoundary, RoleName, region` | <p>Adds or updates the policy that is specified as the IAM role's permissions boundary. You can use an Amazon Web Services managed policy or a customer managed policy to set the boundary for a role. Use the boundary to control the maximum permissions that the role can have. Setting a permissions boundary is an advanced feature that can affect the permissions for the role.</p> <p>You cannot set the boundary for a service-linked role. </p> <important> <p>Policies used as permissions boundaries do not provide permissions. You must also attach a permissions policy to the role. To learn how the effective permissions for a role are evaluated, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html">IAM JSON policy evaluation logic</a> in the IAM User Guide. </p> </important> | diff --git a/docs/aws-docs/providers/aws/iam_api/role_policies/index.md b/docs/aws-docs/providers/aws/iam_api/role_policies/index.md new file mode 100644 index 0000000000..d86ee6861b --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/role_policies/index.md @@ -0,0 +1,41 @@ +--- +title: role_policies +hide_title: false +hide_table_of_contents: false +keywords: + - role_policies + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namerole_policies
TypeResource
Idaws.iam_api.role_policies
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `PolicyDocument` | `string` | <p>The policy document.</p> <p>IAM stores policies in JSON format. However, resources that were created using CloudFormation templates can be formatted in YAML. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.</p> | +| `PolicyName` | `string` | The name of the policy. | +| `RoleName` | `string` | The role the policy is associated with. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `role_policies_Get` | `SELECT` | `PolicyName, RoleName, region` | <p>Retrieves the specified inline policy document that is embedded with the specified IAM role.</p> <note> <p>Policies returned by this operation are URL-encoded compliant with <a href="https://tools.ietf.org/html/rfc3986">RFC 3986</a>. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the <code>decode</code> method of the <code>java.net.URLDecoder</code> utility class in the Java SDK. Other languages and SDKs provide similar functionality.</p> </note> <p>An IAM role can also have managed policies attached to it. To retrieve a managed policy document that is attached to a role, use <a>GetPolicy</a> to determine the policy's default version, then use <a>GetPolicyVersion</a> to retrieve the policy document.</p> <p>For more information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p> <p>For more information about roles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html">Using roles to delegate permissions and federate identities</a>.</p> | +| `role_policies_List` | `SELECT` | `RoleName, region` | <p>Lists the names of the inline policies that are embedded in the specified IAM role.</p> <p>An IAM role can also have managed policies attached to it. To list the managed policies that are attached to a role, use <a>ListAttachedRolePolicies</a>. For more information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p> <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. If there are no inline policies embedded with the specified role, the operation returns an empty list.</p> | +| `role_policies_Delete` | `DELETE` | `PolicyName, RoleName, region` | <p>Deletes the specified inline policy that is embedded in the specified IAM role.</p> <p>A role can also have managed policies attached to it. To detach a managed policy from a role, use <a>DetachRolePolicy</a>. For more information about policies, refer to <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p> | +| `role_policies_Attach` | `EXEC` | `PolicyArn, RoleName, region` | <p>Attaches the specified managed policy to the specified IAM role. When you attach a managed policy to a role, the managed policy becomes part of the role's permission (access) policy.</p> <note> <p>You cannot use a managed policy as the role's trust policy. The role's trust policy is created at the same time as the role, using <a>CreateRole</a>. You can update a role's trust policy using <a>UpdateAssumeRolePolicy</a>.</p> </note> <p>Use this operation to attach a <i>managed</i> policy to a role. To embed an inline policy in a role, use <a>PutRolePolicy</a>. For more information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p> <p>As a best practice, you can validate your IAM policies. To learn more, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html">Validating IAM policies</a> in the <i>IAM User Guide</i>.</p> | +| `role_policies_Detach` | `EXEC` | `PolicyArn, RoleName, region` | <p>Removes the specified managed policy from the specified role.</p> <p>A role can also have inline policies embedded with it. To delete an inline policy, use <a>DeleteRolePolicy</a>. For information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p> | +| `role_policies_Put` | `EXEC` | `PolicyDocument, PolicyName, RoleName, region` | <p>Adds or updates an inline policy document that is embedded in the specified IAM role.</p> <p>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, using <a>CreateRole</a>. You can update a role's trust policy using <a>UpdateAssumeRolePolicy</a>. For more information about IAM roles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html">Using roles to delegate permissions and federate identities</a>.</p> <p>A role can also have a managed policy attached to it. To attach a managed policy to a role, use <a>AttachRolePolicy</a>. To create a new managed policy, use <a>CreatePolicy</a>. For information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p> <p>For information about the maximum number of inline policies that you can embed with a role, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html">IAM and STS quotas</a> in the <i>IAM User Guide</i>.</p> <note> <p>Because policy documents can be large, you should use POST rather than GET when calling <code>PutRolePolicy</code>. For general information about using the Query API with IAM, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html">Making query requests</a> in the <i>IAM User Guide</i>.</p> </note> | diff --git a/docs/aws-docs/providers/aws/iam_api/role_tags/index.md b/docs/aws-docs/providers/aws/iam_api/role_tags/index.md new file mode 100644 index 0000000000..e06eb0104e --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/role_tags/index.md @@ -0,0 +1,35 @@ +--- +title: role_tags +hide_title: false +hide_table_of_contents: false +keywords: + - role_tags + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namerole_tags
TypeResource
Idaws.iam_api.role_tags
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `Key` | `string` | The key name that can be used to look up or retrieve the associated value. For example, <code>Department</code> or <code>Cost Center</code> are common choices. | +| `Value` | `string` | <p>The value associated with this tag. For example, tags with a key name of <code>Department</code> could have values such as <code>Human Resources</code>, <code>Accounting</code>, and <code>Support</code>. Tags with a key name of <code>Cost Center</code> might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values.</p> <note> <p>Amazon Web Services always interprets the tag <code>Value</code> as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.</p> </note> | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `role_tags_List` | `SELECT` | `RoleName, region` | diff --git a/docs/aws-docs/providers/aws/iam_api/role_to_instance_profiles/index.md b/docs/aws-docs/providers/aws/iam_api/role_to_instance_profiles/index.md new file mode 100644 index 0000000000..b8d67d15f5 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/role_to_instance_profiles/index.md @@ -0,0 +1,32 @@ +--- +title: role_to_instance_profiles +hide_title: false +hide_table_of_contents: false +keywords: + - role_to_instance_profiles + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namerole_to_instance_profiles
TypeResource
Idaws.iam_api.role_to_instance_profiles
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `role_to_instance_profiles_Add` | `EXEC` | `InstanceProfileName, RoleName, region` | diff --git a/docs/aws-docs/providers/aws/iam_api/roles/index.md b/docs/aws-docs/providers/aws/iam_api/roles/index.md new file mode 100644 index 0000000000..7fb76eb739 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/roles/index.md @@ -0,0 +1,50 @@ +--- +title: roles +hide_title: false +hide_table_of_contents: false +keywords: + - roles + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameroles
TypeResource
Idaws.iam_api.roles
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `Arn` | `string` | <p>The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.</p> <p>For more information about ARNs, go to <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>. </p> | +| `AssumeRolePolicyDocument` | `string` | The policy that grants an entity permission to assume the role. | +| `CreateDate` | `string` | The date and time, in <a href="http://www.iso.org/iso/iso8601">ISO 8601 date-time format</a>, when the role was created. | +| `Description` | `string` | A description of the role that you provide. | +| `MaxSessionDuration` | `integer` | The maximum session duration (in seconds) for the specified role. Anyone who uses the CLI, or API to assume the role can specify the duration using the optional <code>DurationSeconds</code> API parameter or <code>duration-seconds</code> CLI parameter. | +| `Path` | `string` | The path to the role. For more information about paths, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">IAM identifiers</a> in the <i>IAM User Guide</i>. | +| `PermissionsBoundary` | `object` | <p>Contains information about an attached permissions boundary.</p> <p>An attached permissions boundary is a managed policy that has been attached to a user or role to set the permissions boundary.</p> <p>For more information about permissions boundaries, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html">Permissions boundaries for IAM identities </a> in the <i>IAM User Guide</i>.</p> | +| `RoleId` | `string` | The stable and unique string identifying the role. For more information about IDs, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">IAM identifiers</a> in the <i>IAM User Guide</i>. | +| `RoleLastUsed` | `object` | <p>Contains information about the last time that an IAM role was used. This includes the date and time and the Region in which the role was last used. Activity is only reported for the trailing 400 days. This period can be shorter if your Region began supporting these features within the last year. The role might have been used more than 400 days ago. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#access-advisor_tracking-period">Regions where data is tracked</a> in the <i>IAM User Guide</i>.</p> <p>This data type is returned as a response element in the <a>GetRole</a> and <a>GetAccountAuthorizationDetails</a> operations.</p> | +| `RoleName` | `string` | The friendly name that identifies the role. | +| `Tags` | `array` | A list of tags that are attached to the role. For more information about tagging, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM resources</a> in the <i>IAM User Guide</i>. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `roles_Get` | `SELECT` | `RoleName, region` | <p>Retrieves information about the specified role, including the role's path, GUID, ARN, and the role's trust policy that grants permission to assume the role. For more information about roles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html">Working with roles</a>.</p> <note> <p>Policies returned by this operation are URL-encoded compliant with <a href="https://tools.ietf.org/html/rfc3986">RFC 3986</a>. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the <code>decode</code> method of the <code>java.net.URLDecoder</code> utility class in the Java SDK. Other languages and SDKs provide similar functionality.</p> </note> | +| `roles_List` | `SELECT` | `region` | <p>Lists the IAM roles that have the specified path prefix. If there are none, the operation returns an empty list. For more information about roles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html">Working with roles</a>.</p> <note> <p>IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a role, see <a>GetRole</a>.</p> </note> <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters.</p> | +| `roles_Create` | `INSERT` | `AssumeRolePolicyDocument, RoleName, region` | Creates a new role for your Amazon Web Services account. For more information about roles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html">IAM roles</a>. For information about quotas for role names and the number of roles you can create, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html">IAM and STS quotas</a> in the <i>IAM User Guide</i>. | +| `roles_Delete` | `DELETE` | `RoleName, region` | <p>Deletes the specified role. The role must not have any policies attached. For more information about roles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html">Working with roles</a>.</p> <important> <p>Make sure that you do not have any Amazon EC2 instances running with the role you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance.</p> </important> | +| `roles_Tag` | `EXEC` | `RoleName, Tags, region` | <p>Adds one or more tags to an IAM role. The role can be a regular role or a service-linked role. If a tag with the same key name already exists, then that tag is overwritten with the new value.</p> <p>A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:</p> <ul> <li> <p> <b>Administrative grouping and discovery</b> - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name <i>Project</i> and the value <i>MyImportantProject</i>. Or search for all resources with the key name <i>Cost Center</i> and the value <i>41200</i>. </p> </li> <li> <p> <b>Access control</b> - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM role that has a specified tag attached. You can also restrict access to only those resources that have a certain tag attached. For examples of policies that show how to use tags to control access, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Control access using IAM tags</a> in the <i>IAM User Guide</i>.</p> </li> <li> <p> <b>Cost allocation</b> - Use tags to help track which individuals and teams are using which Amazon Web Services resources.</p> </li> </ul> <note> <ul> <li> <p>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. For more information about tagging, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM resources</a> in the <i>IAM User Guide</i>.</p> </li> <li> <p>Amazon Web Services always interprets the tag <code>Value</code> as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.</p> </li> </ul> </note> <p>For more information about tagging, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM identities</a> in the <i>IAM User Guide</i>.</p> | +| `roles_Untag` | `EXEC` | `RoleName, TagKeys, region` | Removes the specified tags from the role. For more information about tagging, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM resources</a> in the <i>IAM User Guide</i>. | +| `roles_Update` | `EXEC` | `RoleName, region` | Updates the description or maximum session duration setting of a role. | diff --git a/docs/aws-docs/providers/aws/iam_api/saml_provider_tags/index.md b/docs/aws-docs/providers/aws/iam_api/saml_provider_tags/index.md new file mode 100644 index 0000000000..f4cf3f6adf --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/saml_provider_tags/index.md @@ -0,0 +1,35 @@ +--- +title: saml_provider_tags +hide_title: false +hide_table_of_contents: false +keywords: + - saml_provider_tags + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namesaml_provider_tags
TypeResource
Idaws.iam_api.saml_provider_tags
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `Key` | `string` | The key name that can be used to look up or retrieve the associated value. For example, <code>Department</code> or <code>Cost Center</code> are common choices. | +| `Value` | `string` | <p>The value associated with this tag. For example, tags with a key name of <code>Department</code> could have values such as <code>Human Resources</code>, <code>Accounting</code>, and <code>Support</code>. Tags with a key name of <code>Cost Center</code> might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values.</p> <note> <p>Amazon Web Services always interprets the tag <code>Value</code> as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.</p> </note> | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `saml_provider_tags_List` | `SELECT` | `SAMLProviderArn, region` | diff --git a/docs/aws-docs/providers/aws/iam_api/saml_providers/index.md b/docs/aws-docs/providers/aws/iam_api/saml_providers/index.md new file mode 100644 index 0000000000..79e878bfcf --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/saml_providers/index.md @@ -0,0 +1,43 @@ +--- +title: saml_providers +hide_title: false +hide_table_of_contents: false +keywords: + - saml_providers + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namesaml_providers
TypeResource
Idaws.iam_api.saml_providers
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `CreateDate` | `string` | The date and time when the SAML provider was created. | +| `SAMLMetadataDocument` | `string` | The XML metadata document that includes information about an identity provider. | +| `Tags` | `array` | A list of tags that are attached to the specified IAM SAML provider. The returned list of tags is sorted by tag key. For more information about tagging, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM resources</a> in the <i>IAM User Guide</i>. | +| `ValidUntil` | `string` | The expiration date and time for the SAML provider. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `saml_providers_Get` | `SELECT` | `SAMLProviderArn, region` | <p>Returns the SAML provider metadocument that was uploaded when the IAM SAML provider resource object was created or updated.</p> <note> <p>This operation requires <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4</a>.</p> </note> | +| `saml_providers_List` | `SELECT` | `region` | <p>Lists the SAML provider resource objects defined in IAM in the account. IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a SAML provider, see <a>GetSAMLProvider</a>.</p> <important> <p> This operation requires <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4</a>.</p> </important> | +| `saml_providers_Create` | `INSERT` | `Name, SAMLMetadataDocument, region` | <p>Creates an IAM resource that describes an identity provider (IdP) that supports SAML 2.0.</p> <p>The SAML provider resource that you create with this operation can be used as a principal in an IAM role's trust policy. Such a policy can enable federated users who sign in using the SAML IdP to assume the role. You can create an IAM role that supports Web-based single sign-on (SSO) to the Amazon Web Services Management Console or one that supports API access to Amazon Web Services.</p> <p>When you create the SAML provider resource, you upload a SAML metadata document that you get from your IdP. That document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that the IdP sends. You must generate the metadata document using the identity management software that is used as your organization's IdP.</p> <note> <p> This operation requires <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4</a>.</p> </note> <p> For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-saml.html">Enabling SAML 2.0 federated users to access the Amazon Web Services Management Console</a> and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html">About SAML 2.0-based federation</a> in the <i>IAM User Guide</i>.</p> | +| `saml_providers_Delete` | `DELETE` | `SAMLProviderArn, region` | <p>Deletes a SAML provider resource in IAM.</p> <p>Deleting the provider resource from IAM does not update any roles that reference the SAML provider resource's ARN as a principal in their trust policies. Any attempt to assume a role that references a non-existent provider resource ARN fails.</p> <note> <p> This operation requires <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4</a>.</p> </note> | +| `saml_providers_Tag` | `EXEC` | `SAMLProviderArn, Tags, region` | <p>Adds one or more tags to a Security Assertion Markup Language (SAML) identity provider. For more information about these providers, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html">About SAML 2.0-based federation </a>. If a tag with the same key name already exists, then that tag is overwritten with the new value.</p> <p>A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:</p> <ul> <li> <p> <b>Administrative grouping and discovery</b> - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name <i>Project</i> and the value <i>MyImportantProject</i>. Or search for all resources with the key name <i>Cost Center</i> and the value <i>41200</i>. </p> </li> <li> <p> <b>Access control</b> - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only a SAML identity provider that has a specified tag attached. For examples of policies that show how to use tags to control access, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Control access using IAM tags</a> in the <i>IAM User Guide</i>.</p> </li> </ul> <note> <ul> <li> <p>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. For more information about tagging, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM resources</a> in the <i>IAM User Guide</i>.</p> </li> <li> <p>Amazon Web Services always interprets the tag <code>Value</code> as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.</p> </li> </ul> </note> | +| `saml_providers_Untag` | `EXEC` | `SAMLProviderArn, TagKeys, region` | Removes the specified tags from the specified Security Assertion Markup Language (SAML) identity provider in IAM. For more information about these providers, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc.html">About web identity federation</a>. For more information about tagging, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM resources</a> in the <i>IAM User Guide</i>. | +| `saml_providers_Update` | `EXEC` | `SAMLMetadataDocument, SAMLProviderArn, region` | <p>Updates the metadata document for an existing SAML provider resource object.</p> <note> <p>This operation requires <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4</a>.</p> </note> | diff --git a/docs/aws-docs/providers/aws/iam_api/security_token_service_preferences/index.md b/docs/aws-docs/providers/aws/iam_api/security_token_service_preferences/index.md new file mode 100644 index 0000000000..1eff5bf60a --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/security_token_service_preferences/index.md @@ -0,0 +1,32 @@ +--- +title: security_token_service_preferences +hide_title: false +hide_table_of_contents: false +keywords: + - security_token_service_preferences + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namesecurity_token_service_preferences
TypeResource
Idaws.iam_api.security_token_service_preferences
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `security_token_service_preferences_Set` | `EXEC` | `GlobalEndpointTokenVersion, region` | diff --git a/docs/aws-docs/providers/aws/iam_api/server_certificate_tags/index.md b/docs/aws-docs/providers/aws/iam_api/server_certificate_tags/index.md new file mode 100644 index 0000000000..7d37f570e7 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/server_certificate_tags/index.md @@ -0,0 +1,35 @@ +--- +title: server_certificate_tags +hide_title: false +hide_table_of_contents: false +keywords: + - server_certificate_tags + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameserver_certificate_tags
TypeResource
Idaws.iam_api.server_certificate_tags
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `Key` | `string` | The key name that can be used to look up or retrieve the associated value. For example, <code>Department</code> or <code>Cost Center</code> are common choices. | +| `Value` | `string` | <p>The value associated with this tag. For example, tags with a key name of <code>Department</code> could have values such as <code>Human Resources</code>, <code>Accounting</code>, and <code>Support</code>. Tags with a key name of <code>Cost Center</code> might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values.</p> <note> <p>Amazon Web Services always interprets the tag <code>Value</code> as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.</p> </note> | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `server_certificate_tags_List` | `SELECT` | `ServerCertificateName, region` | diff --git a/docs/aws-docs/providers/aws/iam_api/server_certificates/index.md b/docs/aws-docs/providers/aws/iam_api/server_certificates/index.md new file mode 100644 index 0000000000..958647295a --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/server_certificates/index.md @@ -0,0 +1,37 @@ +--- +title: server_certificates +hide_title: false +hide_table_of_contents: false +keywords: + - server_certificates + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameserver_certificates
TypeResource
Idaws.iam_api.server_certificates
+ +## Fields +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `server_certificates_Get` | `SELECT` | `ServerCertificateName, region` | <p>Retrieves information about the specified server certificate stored in IAM.</p> <p>For more information about working with server certificates, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html">Working with server certificates</a> in the <i>IAM User Guide</i>. This topic includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.</p> | +| `server_certificates_List` | `SELECT` | `region` | <p>Lists the server certificates stored in IAM that have the specified path prefix. If none exist, the operation returns an empty list.</p> <p> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters.</p> <p>For more information about working with server certificates, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html">Working with server certificates</a> in the <i>IAM User Guide</i>. This topic also includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.</p> <note> <p>IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a servercertificate, see <a>GetServerCertificate</a>.</p> </note> | +| `server_certificates_Delete` | `DELETE` | `ServerCertificateName, region` | <p>Deletes the specified server certificate.</p> <p>For more information about working with server certificates, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html">Working with server certificates</a> in the <i>IAM User Guide</i>. This topic also includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.</p> <important> <p> If you are using a server certificate with Elastic Load Balancing, deleting the certificate could have implications for your application. If Elastic Load Balancing doesn't detect the deletion of bound certificates, it may continue to use the certificates. This could cause Elastic Load Balancing to stop accepting traffic. We recommend that you remove the reference to the certificate from Elastic Load Balancing before using this command to delete the certificate. For more information, see <a href="https://docs.aws.amazon.com/ElasticLoadBalancing/latest/APIReference/API_DeleteLoadBalancerListeners.html">DeleteLoadBalancerListeners</a> in the <i>Elastic Load Balancing API Reference</i>.</p> </important> | +| `server_certificates_Tag` | `EXEC` | `ServerCertificateName, Tags, region` | <p>Adds one or more tags to an IAM server certificate. If a tag with the same key name already exists, then that tag is overwritten with the new value.</p> <note> <p>For certificates in a Region supported by Certificate Manager (ACM), we recommend that you don't use IAM server certificates. Instead, use ACM to provision, manage, and deploy your server certificates. For more information about IAM server certificates, <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html">Working with server certificates</a> in the <i>IAM User Guide</i>.</p> </note> <p>A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:</p> <ul> <li> <p> <b>Administrative grouping and discovery</b> - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name <i>Project</i> and the value <i>MyImportantProject</i>. Or search for all resources with the key name <i>Cost Center</i> and the value <i>41200</i>. </p> </li> <li> <p> <b>Access control</b> - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only a server certificate that has a specified tag attached. For examples of policies that show how to use tags to control access, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Control access using IAM tags</a> in the <i>IAM User Guide</i>.</p> </li> <li> <p> <b>Cost allocation</b> - Use tags to help track which individuals and teams are using which Amazon Web Services resources.</p> </li> </ul> <note> <ul> <li> <p>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. For more information about tagging, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM resources</a> in the <i>IAM User Guide</i>.</p> </li> <li> <p>Amazon Web Services always interprets the tag <code>Value</code> as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.</p> </li> </ul> </note> | +| `server_certificates_Untag` | `EXEC` | `ServerCertificateName, TagKeys, region` | <p>Removes the specified tags from the IAM server certificate. For more information about tagging, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM resources</a> in the <i>IAM User Guide</i>.</p> <note> <p>For certificates in a Region supported by Certificate Manager (ACM), we recommend that you don't use IAM server certificates. Instead, use ACM to provision, manage, and deploy your server certificates. For more information about IAM server certificates, <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html">Working with server certificates</a> in the <i>IAM User Guide</i>.</p> </note> | +| `server_certificates_Update` | `EXEC` | `ServerCertificateName, region` | <p>Updates the name and/or the path of the specified server certificate stored in IAM.</p> <p>For more information about working with server certificates, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html">Working with server certificates</a> in the <i>IAM User Guide</i>. This topic also includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.</p> <important> <p>You should understand the implications of changing a server certificate's path or name. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs_manage.html#RenamingServerCerts">Renaming a server certificate</a> in the <i>IAM User Guide</i>.</p> </important> <note> <p>The person making the request (the principal), must have permission to change the server certificate with the old name and the new name. For example, to change the certificate named <code>ProductionCert</code> to <code>ProdCert</code>, the principal must have a policy that allows them to update both certificates. If the principal has permission to update the <code>ProductionCert</code> group, but not the <code>ProdCert</code> certificate, then the update fails. For more information about permissions, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html">Access management</a> in the <i>IAM User Guide</i>.</p> </note> | +| `server_certificates_Upload` | `EXEC` | `CertificateBody, PrivateKey, ServerCertificateName, region` | <p>Uploads a server certificate entity for the Amazon Web Services account. The server certificate entity includes a public key certificate, a private key, and an optional certificate chain, which should all be PEM-encoded.</p> <p>We recommend that you use <a href="https://docs.aws.amazon.com/acm/">Certificate Manager</a> to provision, manage, and deploy your server certificates. With ACM you can request a certificate, deploy it to Amazon Web Services resources, and let ACM handle certificate renewals for you. Certificates provided by ACM are free. For more information about using ACM, see the <a href="https://docs.aws.amazon.com/acm/latest/userguide/">Certificate Manager User Guide</a>.</p> <p>For more information about working with server certificates, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html">Working with server certificates</a> in the <i>IAM User Guide</i>. This topic includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.</p> <p>For information about the number of server certificates you can upload, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html">IAM and STS quotas</a> in the <i>IAM User Guide</i>.</p> <note> <p>Because the body of the public key certificate, private key, and the certificate chain can be large, you should use POST rather than GET when calling <code>UploadServerCertificate</code>. For information about setting up signatures and authorization through the API, see <a href="https://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html">Signing Amazon Web Services API requests</a> in the <i>Amazon Web Services General Reference</i>. For general information about using the Query API with IAM, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/programming.html">Calling the API by making HTTP query requests</a> in the <i>IAM User Guide</i>.</p> </note> | diff --git a/docs/aws-docs/providers/aws/iam_api/service_last_accessed_details/index.md b/docs/aws-docs/providers/aws/iam_api/service_last_accessed_details/index.md new file mode 100644 index 0000000000..f672d486a8 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/service_last_accessed_details/index.md @@ -0,0 +1,42 @@ +--- +title: service_last_accessed_details +hide_title: false +hide_table_of_contents: false +keywords: + - service_last_accessed_details + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameservice_last_accessed_details
TypeResource
Idaws.iam_api.service_last_accessed_details
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `Error` | `object` | <p>Contains information about the reason that the operation failed.</p> <p>This data type is used as a response element in the <a>GetOrganizationsAccessReport</a>, <a>GetServiceLastAccessedDetails</a>, and <a>GetServiceLastAccessedDetailsWithEntities</a> operations.</p> | +| `IsTruncated` | `boolean` | A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items. Note that IAM might return fewer than the <code>MaxItems</code> number of results even when there are more results available. We recommend that you check <code>IsTruncated</code> after every call to ensure that you receive all your results. | +| `JobCompletionDate` | `string` | <p>The date and time, in <a href="http://www.iso.org/iso/iso8601">ISO 8601 date-time format</a>, when the generated report job was completed or failed.</p> <p>This field is null if the job is still in progress, as indicated by a job status value of <code>IN_PROGRESS</code>.</p> | +| `JobCreationDate` | `string` | The date and time, in <a href="http://www.iso.org/iso/iso8601">ISO 8601 date-time format</a>, when the report job was created. | +| `JobStatus` | `string` | The status of the job. | +| `JobType` | `string` | The type of job. Service jobs return information about when each service was last accessed. Action jobs also include information about when tracked actions within the service were last accessed. | +| `Marker` | `string` | When <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value to use for the <code>Marker</code> parameter in a subsequent pagination request. | +| `ServicesLastAccessed` | `array` | A <code>ServiceLastAccessed</code> object that contains details about the most recent attempt to access the service. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `service_last_accessed_details_Get` | `SELECT` | `JobId, region` | <p>Retrieves a service last accessed report that was created using the <code>GenerateServiceLastAccessedDetails</code> operation. You can use the <code>JobId</code> parameter in <code>GetServiceLastAccessedDetails</code> to retrieve the status of your report job. When the report is complete, you can retrieve the generated report. The report includes a list of Amazon Web Services services that the resource (user, group, role, or managed policy) can access.</p> <note> <p>Service last accessed data does not use other policy types when determining whether a resource could access a service. These other policy types include resource-based policies, access control lists, Organizations policies, IAM permissions boundaries, and STS assume role policies. It only applies permissions policy logic. For more about the evaluation of policy types, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html#policy-eval-basics">Evaluating policies</a> in the <i>IAM User Guide</i>.</p> </note> <p>For each service that the resource could access using permissions policies, the operation returns details about the most recent access attempt. If there was no attempt, the service is listed without details about the most recent attempt to access the service. If the operation fails, the <code>GetServiceLastAccessedDetails</code> operation returns the reason that it failed.</p> <p>The <code>GetServiceLastAccessedDetails</code> operation returns a list of services. This list includes the number of entities that have attempted to access the service and the date and time of the last attempt. It also returns the ARN of the following entity, depending on the resource ARN that you used to generate the report:</p> <ul> <li> <p> <b>User</b> – Returns the user ARN that you used to generate the report</p> </li> <li> <p> <b>Group</b> – Returns the ARN of the group member (user) that last attempted to access the service</p> </li> <li> <p> <b>Role</b> – Returns the role ARN that you used to generate the report</p> </li> <li> <p> <b>Policy</b> – Returns the ARN of the user or role that last used the policy to attempt to access the service</p> </li> </ul> <p>By default, the list is sorted by service namespace.</p> <p>If you specified <code>ACTION_LEVEL</code> granularity when you generated the report, this operation returns service and action last accessed data. This includes the most recent access attempt for each tracked action within a service. Otherwise, this operation returns only service data.</p> <p>For more information about service and action last accessed data, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html">Reducing permissions using service last accessed data</a> in the <i>IAM User Guide</i>.</p> | +| `service_last_accessed_details_Generate` | `EXEC` | `Arn, region` | <p>Generates a report that includes details about when an IAM resource (user, group, role, or policy) was last used in an attempt to access Amazon Web Services services. Recent activity usually appears within four hours. IAM reports activity for at least the last 400 days, or less if your Region began supporting this feature within the last year. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#access-advisor_tracking-period">Regions where data is tracked</a>.</p> <important> <p>The service last accessed data includes all attempts to access an Amazon Web Services API, not just the successful ones. This includes all attempts that were made using the Amazon Web Services Management Console, the Amazon Web Services API through any of the SDKs, or any of the command line tools. An unexpected entry in the service last accessed data does not mean that your account has been compromised, because the request might have been denied. Refer to your CloudTrail logs as the authoritative source for information about all API calls and whether they were successful or denied access. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/cloudtrail-integration.html">Logging IAM events with CloudTrail</a> in the <i>IAM User Guide</i>.</p> </important> <p>The <code>GenerateServiceLastAccessedDetails</code> operation returns a <code>JobId</code>. Use this parameter in the following operations to retrieve the following details from your report: </p> <ul> <li> <p> <a>GetServiceLastAccessedDetails</a> – Use this operation for users, groups, roles, or policies to list every Amazon Web Services service that the resource could access using permissions policies. For each service, the response includes information about the most recent access attempt.</p> <p>The <code>JobId</code> returned by <code>GenerateServiceLastAccessedDetail</code> must be used by the same role within a session, or by the same user when used to call <code>GetServiceLastAccessedDetail</code>.</p> </li> <li> <p> <a>GetServiceLastAccessedDetailsWithEntities</a> – Use this operation for groups and policies to list information about the associated entities (users or roles) that attempted to access a specific Amazon Web Services service. </p> </li> </ul> <p>To check the status of the <code>GenerateServiceLastAccessedDetails</code> request, use the <code>JobId</code> parameter in the same operations and test the <code>JobStatus</code> response parameter.</p> <p>For additional information about the permissions policies that allow an identity (user, group, or role) to access specific services, use the <a>ListPoliciesGrantingServiceAccess</a> operation.</p> <note> <p>Service last accessed data does not use other policy types when determining whether a resource could access a service. These other policy types include resource-based policies, access control lists, Organizations policies, IAM permissions boundaries, and STS assume role policies. It only applies permissions policy logic. For more about the evaluation of policy types, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html#policy-eval-basics">Evaluating policies</a> in the <i>IAM User Guide</i>.</p> </note> <p>For more information about service and action last accessed data, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html">Reducing permissions using service last accessed data</a> in the <i>IAM User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/iam_api/service_last_accessed_details_with_entities/index.md b/docs/aws-docs/providers/aws/iam_api/service_last_accessed_details_with_entities/index.md new file mode 100644 index 0000000000..42c1439143 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/service_last_accessed_details_with_entities/index.md @@ -0,0 +1,40 @@ +--- +title: service_last_accessed_details_with_entities +hide_title: false +hide_table_of_contents: false +keywords: + - service_last_accessed_details_with_entities + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameservice_last_accessed_details_with_entities
TypeResource
Idaws.iam_api.service_last_accessed_details_with_entities
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `EntityDetailsList` | `array` | An <code>EntityDetailsList</code> object that contains details about when an IAM entity (user or role) used group or policy permissions in an attempt to access the specified Amazon Web Services service. | +| `Error` | `object` | <p>Contains information about the reason that the operation failed.</p> <p>This data type is used as a response element in the <a>GetOrganizationsAccessReport</a>, <a>GetServiceLastAccessedDetails</a>, and <a>GetServiceLastAccessedDetailsWithEntities</a> operations.</p> | +| `IsTruncated` | `boolean` | A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items. Note that IAM might return fewer than the <code>MaxItems</code> number of results even when there are more results available. We recommend that you check <code>IsTruncated</code> after every call to ensure that you receive all your results. | +| `JobCompletionDate` | `string` | <p>The date and time, in <a href="http://www.iso.org/iso/iso8601">ISO 8601 date-time format</a>, when the generated report job was completed or failed.</p> <p>This field is null if the job is still in progress, as indicated by a job status value of <code>IN_PROGRESS</code>.</p> | +| `JobCreationDate` | `string` | The date and time, in <a href="http://www.iso.org/iso/iso8601">ISO 8601 date-time format</a>, when the report job was created. | +| `JobStatus` | `string` | The status of the job. | +| `Marker` | `string` | When <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value to use for the <code>Marker</code> parameter in a subsequent pagination request. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `service_last_accessed_details_with_entities_Get` | `SELECT` | `JobId, ServiceNamespace, region` | diff --git a/docs/aws-docs/providers/aws/iam_api/service_linked_role_deletion_status/index.md b/docs/aws-docs/providers/aws/iam_api/service_linked_role_deletion_status/index.md new file mode 100644 index 0000000000..e3e6abd6a9 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/service_linked_role_deletion_status/index.md @@ -0,0 +1,35 @@ +--- +title: service_linked_role_deletion_status +hide_title: false +hide_table_of_contents: false +keywords: + - service_linked_role_deletion_status + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameservice_linked_role_deletion_status
TypeResource
Idaws.iam_api.service_linked_role_deletion_status
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `Reason` | `object` | <p>The reason that the service-linked role deletion failed.</p> <p>This data type is used as a response element in the <a>GetServiceLinkedRoleDeletionStatus</a> operation.</p> | +| `Status` | `string` | The status of the deletion. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `service_linked_role_deletion_status_Get` | `SELECT` | `DeletionTaskId, region` | diff --git a/docs/aws-docs/providers/aws/iam_api/service_linked_roles/index.md b/docs/aws-docs/providers/aws/iam_api/service_linked_roles/index.md new file mode 100644 index 0000000000..b26ddf44d7 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/service_linked_roles/index.md @@ -0,0 +1,33 @@ +--- +title: service_linked_roles +hide_title: false +hide_table_of_contents: false +keywords: + - service_linked_roles + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameservice_linked_roles
TypeResource
Idaws.iam_api.service_linked_roles
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `service_linked_roles_Create` | `INSERT` | `AWSServiceName, region` | <p>Creates an IAM role that is linked to a specific Amazon Web Services service. The service controls the attached policies and when the role can be deleted. This helps ensure that the service is not broken by an unexpectedly changed or deleted role, which could put your Amazon Web Services resources into an unknown state. Allowing the service to control the role helps improve service stability and proper cleanup when a service and its role are no longer needed. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html">Using service-linked roles</a> in the <i>IAM User Guide</i>. </p> <p>To attach a policy to this service-linked role, you must make the request using the Amazon Web Services service that depends on this role.</p> | +| `service_linked_roles_Delete` | `DELETE` | `RoleName, region` | <p>Submits a service-linked role deletion request and returns a <code>DeletionTaskId</code>, which you can use to check the status of the deletion. Before you call this operation, confirm that the role has no active sessions and that any resources used by the role in the linked service are deleted. If you call this operation more than once for the same service-linked role and an earlier deletion task is not complete, then the <code>DeletionTaskId</code> of the earlier request is returned.</p> <p>If you submit a deletion request for a service-linked role whose linked service is still accessing a resource, then the deletion task fails. If it fails, the <a>GetServiceLinkedRoleDeletionStatus</a> operation returns the reason for the failure, usually including the resources that must be deleted. To delete the service-linked role, you must first remove those resources from the linked service and then submit the deletion request again. Resources are specific to the service that is linked to the role. For more information about removing resources from a service, see the <a href="http://docs.aws.amazon.com/">Amazon Web Services documentation</a> for your service.</p> <p>For more information about service-linked roles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html#iam-term-service-linked-role">Roles terms and concepts: Amazon Web Services service-linked role</a> in the <i>IAM User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/iam_api/service_specific_credentials/index.md b/docs/aws-docs/providers/aws/iam_api/service_specific_credentials/index.md new file mode 100644 index 0000000000..8ae887f1e8 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/service_specific_credentials/index.md @@ -0,0 +1,43 @@ +--- +title: service_specific_credentials +hide_title: false +hide_table_of_contents: false +keywords: + - service_specific_credentials + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameservice_specific_credentials
TypeResource
Idaws.iam_api.service_specific_credentials
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `CreateDate` | `string` | The date and time, in <a href="http://www.iso.org/iso/iso8601">ISO 8601 date-time format</a>, when the service-specific credential were created. | +| `ServiceName` | `string` | The name of the service associated with the service-specific credential. | +| `ServiceSpecificCredentialId` | `string` | The unique identifier for the service-specific credential. | +| `ServiceUserName` | `string` | The generated user name for the service-specific credential. | +| `Status` | `string` | The status of the service-specific credential. <code>Active</code> means that the key is valid for API calls, while <code>Inactive</code> means it is not. | +| `UserName` | `string` | The name of the IAM user associated with the service-specific credential. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `service_specific_credentials_List` | `SELECT` | `region` | Returns information about the service-specific credentials associated with the specified IAM user. If none exists, the operation returns an empty list. The service-specific credentials returned by this operation are used only for authenticating the IAM user to a specific service. For more information about using service-specific credentials to authenticate to an Amazon Web Services service, see <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-gc.html">Set up service-specific credentials</a> in the CodeCommit User Guide. | +| `service_specific_credentials_Create` | `INSERT` | `ServiceName, UserName, region` | <p>Generates a set of credentials consisting of a user name and password that can be used to access the service specified in the request. These credentials are generated by IAM, and can be used only for the specified service. </p> <p>You can have a maximum of two sets of service-specific credentials for each supported service per user.</p> <p>You can create service-specific credentials for CodeCommit and Amazon Keyspaces (for Apache Cassandra).</p> <p>You can reset the password to a new service-generated value by calling <a>ResetServiceSpecificCredential</a>.</p> <p>For more information about service-specific credentials, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_ssh-keys.html">Using IAM with CodeCommit: Git credentials, SSH keys, and Amazon Web Services access keys</a> in the <i>IAM User Guide</i>.</p> | +| `service_specific_credentials_Delete` | `DELETE` | `ServiceSpecificCredentialId, region` | Deletes the specified service-specific credential. | +| `service_specific_credentials_Reset` | `EXEC` | `ServiceSpecificCredentialId, region` | Resets the password for a service-specific credential. The new password is Amazon Web Services generated and cryptographically strong. It cannot be configured by the user. Resetting the password immediately invalidates the previous password associated with this user. | +| `service_specific_credentials_Update` | `EXEC` | `ServiceSpecificCredentialId, Status, region` | Sets the status of a service-specific credential to <code>Active</code> or <code>Inactive</code>. Service-specific credentials that are inactive cannot be used for authentication to the service. This operation can be used to disable a user's service-specific credential as part of a credential rotation work flow. | diff --git a/docs/aws-docs/providers/aws/iam_api/signing_certificates/index.md b/docs/aws-docs/providers/aws/iam_api/signing_certificates/index.md new file mode 100644 index 0000000000..691c710c2e --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/signing_certificates/index.md @@ -0,0 +1,41 @@ +--- +title: signing_certificates +hide_title: false +hide_table_of_contents: false +keywords: + - signing_certificates + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namesigning_certificates
TypeResource
Idaws.iam_api.signing_certificates
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `CertificateBody` | `string` | The contents of the signing certificate. | +| `CertificateId` | `string` | The ID for the signing certificate. | +| `Status` | `string` | The status of the signing certificate. <code>Active</code> means that the key is valid for API calls, while <code>Inactive</code> means it is not. | +| `UploadDate` | `string` | The date when the signing certificate was uploaded. | +| `UserName` | `string` | The name of the user the signing certificate is associated with. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `signing_certificates_List` | `SELECT` | `region` | <p>Returns information about the signing certificates associated with the specified IAM user. If none exists, the operation returns an empty list.</p> <p>Although each user is limited to a small number of signing certificates, you can still paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters.</p> <p>If the <code>UserName</code> field is not specified, the user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request for this operation. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.</p> | +| `signing_certificates_Delete` | `DELETE` | `CertificateId, region` | <p>Deletes a signing certificate associated with the specified IAM user.</p> <p>If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID signing the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated IAM users.</p> | +| `signing_certificates_Update` | `EXEC` | `CertificateId, Status, region` | <p>Changes the status of the specified user signing certificate from active to disabled, or vice versa. This operation can be used to disable an IAM user's signing certificate as part of a certificate rotation work flow.</p> <p>If the <code>UserName</code> field is not specified, the user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.</p> | +| `signing_certificates_Upload` | `EXEC` | `CertificateBody, region` | <p>Uploads an X.509 signing certificate and associates it with the specified IAM user. Some Amazon Web Services services require you to use certificates to validate requests that are signed with a corresponding private key. When you upload the certificate, its default status is <code>Active</code>.</p> <p>For information about when you would use an X.509 signing certificate, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html">Managing server certificates in IAM</a> in the <i>IAM User Guide</i>.</p> <p>If the <code>UserName</code> is not specified, the IAM user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.</p> <note> <p>Because the body of an X.509 certificate can be large, you should use POST rather than GET when calling <code>UploadSigningCertificate</code>. For information about setting up signatures and authorization through the API, see <a href="https://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html">Signing Amazon Web Services API requests</a> in the <i>Amazon Web Services General Reference</i>. For general information about using the Query API with IAM, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html">Making query requests</a> in the <i>IAM User Guide</i>.</p> </note> | diff --git a/docs/aws-docs/providers/aws/iam_api/ssh_public_keys/index.md b/docs/aws-docs/providers/aws/iam_api/ssh_public_keys/index.md new file mode 100644 index 0000000000..e421e8ec42 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/ssh_public_keys/index.md @@ -0,0 +1,35 @@ +--- +title: ssh_public_keys +hide_title: false +hide_table_of_contents: false +keywords: + - ssh_public_keys + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namessh_public_keys
TypeResource
Idaws.iam_api.ssh_public_keys
+ +## Fields +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `ssh_public_keys_Get` | `SELECT` | `Encoding, SSHPublicKeyId, UserName, region` | <p>Retrieves the specified SSH public key, including metadata about the key.</p> <p>The SSH public key retrieved by this operation is used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html">Set up CodeCommit for SSH connections</a> in the <i>CodeCommit User Guide</i>.</p> | +| `ssh_public_keys_List` | `SELECT` | `region` | <p>Returns information about the SSH public keys associated with the specified IAM user. If none exists, the operation returns an empty list.</p> <p>The SSH public keys returned by this operation are used only for authenticating the IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html">Set up CodeCommit for SSH connections</a> in the <i>CodeCommit User Guide</i>.</p> <p>Although each user is limited to a small number of keys, you can still paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters.</p> | +| `ssh_public_keys_Delete` | `DELETE` | `SSHPublicKeyId, UserName, region` | <p>Deletes the specified SSH public key.</p> <p>The SSH public key deleted by this operation is used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html">Set up CodeCommit for SSH connections</a> in the <i>CodeCommit User Guide</i>.</p> | +| `ssh_public_keys_Update` | `EXEC` | `SSHPublicKeyId, Status, UserName, region` | <p>Sets the status of an IAM user's SSH public key to active or inactive. SSH public keys that are inactive cannot be used for authentication. This operation can be used to disable a user's SSH public key as part of a key rotation work flow.</p> <p>The SSH public key affected by this operation is used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html">Set up CodeCommit for SSH connections</a> in the <i>CodeCommit User Guide</i>.</p> | +| `ssh_public_keys_Upload` | `EXEC` | `SSHPublicKeyBody, UserName, region` | <p>Uploads an SSH public key and associates it with the specified IAM user.</p> <p>The SSH public key uploaded by this operation can be used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html">Set up CodeCommit for SSH connections</a> in the <i>CodeCommit User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/iam_api/user_from_groups/index.md b/docs/aws-docs/providers/aws/iam_api/user_from_groups/index.md new file mode 100644 index 0000000000..f3453e3457 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/user_from_groups/index.md @@ -0,0 +1,32 @@ +--- +title: user_from_groups +hide_title: false +hide_table_of_contents: false +keywords: + - user_from_groups + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameuser_from_groups
TypeResource
Idaws.iam_api.user_from_groups
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `user_from_groups_Remove` | `EXEC` | `GroupName, UserName, region` | diff --git a/docs/aws-docs/providers/aws/iam_api/user_permissions_boundaries/index.md b/docs/aws-docs/providers/aws/iam_api/user_permissions_boundaries/index.md new file mode 100644 index 0000000000..cecd5afa5b --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/user_permissions_boundaries/index.md @@ -0,0 +1,33 @@ +--- +title: user_permissions_boundaries +hide_title: false +hide_table_of_contents: false +keywords: + - user_permissions_boundaries + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameuser_permissions_boundaries
TypeResource
Idaws.iam_api.user_permissions_boundaries
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `user_permissions_boundaries_Delete` | `DELETE` | `UserName, region` | <p>Deletes the permissions boundary for the specified IAM user.</p> <important> <p>Deleting the permissions boundary for a user might increase its permissions by allowing the user to perform all the actions granted in its permissions policies. </p> </important> | +| `user_permissions_boundaries_Put` | `EXEC` | `PermissionsBoundary, UserName, region` | <p>Adds or updates the policy that is specified as the IAM user's permissions boundary. You can use an Amazon Web Services managed policy or a customer managed policy to set the boundary for a user. Use the boundary to control the maximum permissions that the user can have. Setting a permissions boundary is an advanced feature that can affect the permissions for the user.</p> <important> <p>Policies that are used as permissions boundaries do not provide permissions. You must also attach a permissions policy to the user. To learn how the effective permissions for a user are evaluated, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html">IAM JSON policy evaluation logic</a> in the IAM User Guide. </p> </important> | diff --git a/docs/aws-docs/providers/aws/iam_api/user_policies/index.md b/docs/aws-docs/providers/aws/iam_api/user_policies/index.md new file mode 100644 index 0000000000..3a9a7c85fb --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/user_policies/index.md @@ -0,0 +1,41 @@ +--- +title: user_policies +hide_title: false +hide_table_of_contents: false +keywords: + - user_policies + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameuser_policies
TypeResource
Idaws.iam_api.user_policies
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `PolicyDocument` | `string` | <p>The policy document.</p> <p>IAM stores policies in JSON format. However, resources that were created using CloudFormation templates can be formatted in YAML. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.</p> | +| `PolicyName` | `string` | The name of the policy. | +| `UserName` | `string` | The user the policy is associated with. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `user_policies_Get` | `SELECT` | `PolicyName, UserName, region` | <p>Retrieves the specified inline policy document that is embedded in the specified IAM user.</p> <note> <p>Policies returned by this operation are URL-encoded compliant with <a href="https://tools.ietf.org/html/rfc3986">RFC 3986</a>. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the <code>decode</code> method of the <code>java.net.URLDecoder</code> utility class in the Java SDK. Other languages and SDKs provide similar functionality.</p> </note> <p>An IAM user can also have managed policies attached to it. To retrieve a managed policy document that is attached to a user, use <a>GetPolicy</a> to determine the policy's default version. Then use <a>GetPolicyVersion</a> to retrieve the policy document.</p> <p>For more information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p> | +| `user_policies_List` | `SELECT` | `UserName, region` | <p>Lists the names of the inline policies embedded in the specified IAM user.</p> <p>An IAM user can also have managed policies attached to it. To list the managed policies that are attached to a user, use <a>ListAttachedUserPolicies</a>. For more information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p> <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. If there are no inline policies embedded with the specified user, the operation returns an empty list.</p> | +| `user_policies_Delete` | `DELETE` | `PolicyName, UserName, region` | <p>Deletes the specified inline policy that is embedded in the specified IAM user.</p> <p>A user can also have managed policies attached to it. To detach a managed policy from a user, use <a>DetachUserPolicy</a>. For more information about policies, refer to <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p> | +| `user_policies_Attach` | `EXEC` | `PolicyArn, UserName, region` | <p>Attaches the specified managed policy to the specified user.</p> <p>You use this operation to attach a <i>managed</i> policy to a user. To embed an inline policy in a user, use <a>PutUserPolicy</a>.</p> <p>As a best practice, you can validate your IAM policies. To learn more, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html">Validating IAM policies</a> in the <i>IAM User Guide</i>.</p> <p>For more information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p> | +| `user_policies_Detach` | `EXEC` | `PolicyArn, UserName, region` | <p>Removes the specified managed policy from the specified user.</p> <p>A user can also have inline policies embedded with it. To delete an inline policy, use <a>DeleteUserPolicy</a>. For information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p> | +| `user_policies_Put` | `EXEC` | `PolicyDocument, PolicyName, UserName, region` | <p>Adds or updates an inline policy document that is embedded in the specified IAM user.</p> <p>An IAM user can also have a managed policy attached to it. To attach a managed policy to a user, use <a>AttachUserPolicy</a>. To create a new managed policy, use <a>CreatePolicy</a>. For information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p> <p>For information about the maximum number of inline policies that you can embed in a user, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html">IAM and STS quotas</a> in the <i>IAM User Guide</i>.</p> <note> <p>Because policy documents can be large, you should use POST rather than GET when calling <code>PutUserPolicy</code>. For general information about using the Query API with IAM, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html">Making query requests</a> in the <i>IAM User Guide</i>.</p> </note> | diff --git a/docs/aws-docs/providers/aws/iam_api/user_tags/index.md b/docs/aws-docs/providers/aws/iam_api/user_tags/index.md new file mode 100644 index 0000000000..7ba58a1f40 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/user_tags/index.md @@ -0,0 +1,35 @@ +--- +title: user_tags +hide_title: false +hide_table_of_contents: false +keywords: + - user_tags + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameuser_tags
TypeResource
Idaws.iam_api.user_tags
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `Key` | `string` | The key name that can be used to look up or retrieve the associated value. For example, <code>Department</code> or <code>Cost Center</code> are common choices. | +| `Value` | `string` | <p>The value associated with this tag. For example, tags with a key name of <code>Department</code> could have values such as <code>Human Resources</code>, <code>Accounting</code>, and <code>Support</code>. Tags with a key name of <code>Cost Center</code> might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values.</p> <note> <p>Amazon Web Services always interprets the tag <code>Value</code> as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.</p> </note> | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `user_tags_List` | `SELECT` | `UserName, region` | diff --git a/docs/aws-docs/providers/aws/iam_api/user_to_groups/index.md b/docs/aws-docs/providers/aws/iam_api/user_to_groups/index.md new file mode 100644 index 0000000000..42cdc4ac0d --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/user_to_groups/index.md @@ -0,0 +1,32 @@ +--- +title: user_to_groups +hide_title: false +hide_table_of_contents: false +keywords: + - user_to_groups + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameuser_to_groups
TypeResource
Idaws.iam_api.user_to_groups
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `user_to_groups_Add` | `EXEC` | `GroupName, UserName, region` | diff --git a/docs/aws-docs/providers/aws/iam_api/users/index.md b/docs/aws-docs/providers/aws/iam_api/users/index.md new file mode 100644 index 0000000000..c5e6433168 --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/users/index.md @@ -0,0 +1,47 @@ +--- +title: users +hide_title: false +hide_table_of_contents: false +keywords: + - users + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameusers
TypeResource
Idaws.iam_api.users
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `Arn` | `string` | <p>The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.</p> <p>For more information about ARNs, go to <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>. </p> | +| `CreateDate` | `string` | The date and time, in <a href="http://www.iso.org/iso/iso8601">ISO 8601 date-time format</a>, when the user was created. | +| `PasswordLastUsed` | `string` | <p>The date and time, in <a href="http://www.iso.org/iso/iso8601">ISO 8601 date-time format</a>, when the user's password was last used to sign in to an Amazon Web Services website. For a list of Amazon Web Services websites that capture a user's last sign-in time, see the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html">Credential reports</a> topic in the <i>IAM User Guide</i>. If a password is used more than once in a five-minute span, only the first use is returned in this field. If the field is null (no value), then it indicates that they never signed in with a password. This can be because:</p> <ul> <li> <p>The user never had a password.</p> </li> <li> <p>A password exists but has not been used since IAM started tracking this information on October 20, 2014.</p> </li> </ul> <p>A null value does not mean that the user <i>never</i> had a password. Also, if the user does not currently have a password but had one in the past, then this field contains the date and time the most recent password was used.</p> <p>This value is returned only in the <a>GetUser</a> and <a>ListUsers</a> operations. </p> | +| `Path` | `string` | <p>The path to the user. For more information about paths, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">IAM identifiers</a> in the <i>IAM User Guide</i>.</p> <p>The ARN of the policy used to set the permissions boundary for the user.</p> | +| `PermissionsBoundary` | `object` | <p>Contains information about an attached permissions boundary.</p> <p>An attached permissions boundary is a managed policy that has been attached to a user or role to set the permissions boundary.</p> <p>For more information about permissions boundaries, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html">Permissions boundaries for IAM identities </a> in the <i>IAM User Guide</i>.</p> | +| `Tags` | `array` | A list of tags that are associated with the user. For more information about tagging, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM resources</a> in the <i>IAM User Guide</i>. | +| `UserId` | `string` | The stable and unique string identifying the user. For more information about IDs, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">IAM identifiers</a> in the <i>IAM User Guide</i>. | +| `UserName` | `string` | The friendly name identifying the user. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `users_List` | `SELECT` | `region` | <p>Lists the IAM users that have the specified path prefix. If no path prefix is specified, the operation returns all users in the Amazon Web Services account. If there are none, the operation returns an empty list.</p> <note> <p>IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a user, see <a>GetUser</a>.</p> </note> <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters.</p> | +| `users_Create` | `INSERT` | `UserName, region` | <p>Creates a new IAM user for your Amazon Web Services account.</p> <p> For information about quotas for the number of IAM users you can create, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html">IAM and STS quotas</a> in the <i>IAM User Guide</i>.</p> | +| `users_Delete` | `DELETE` | `UserName, region` | <p>Deletes the specified IAM user. Unlike the Amazon Web Services Management Console, when you delete a user programmatically, you must delete the items attached to the user manually, or the deletion fails. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_manage.html#id_users_deleting_cli">Deleting an IAM user</a>. Before attempting to delete a user, remove the following items:</p> <ul> <li> <p>Password (<a>DeleteLoginProfile</a>)</p> </li> <li> <p>Access keys (<a>DeleteAccessKey</a>)</p> </li> <li> <p>Signing certificate (<a>DeleteSigningCertificate</a>)</p> </li> <li> <p>SSH public key (<a>DeleteSSHPublicKey</a>)</p> </li> <li> <p>Git credentials (<a>DeleteServiceSpecificCredential</a>)</p> </li> <li> <p>Multi-factor authentication (MFA) device (<a>DeactivateMFADevice</a>, <a>DeleteVirtualMFADevice</a>)</p> </li> <li> <p>Inline policies (<a>DeleteUserPolicy</a>)</p> </li> <li> <p>Attached managed policies (<a>DetachUserPolicy</a>)</p> </li> <li> <p>Group memberships (<a>RemoveUserFromGroup</a>)</p> </li> </ul> | +| `users_Get` | `EXEC` | `region` | <p>Retrieves information about the specified IAM user, including the user's creation date, path, unique ID, and ARN.</p> <p>If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID used to sign the request to this operation.</p> | +| `users_Tag` | `EXEC` | `Tags, UserName, region` | <p>Adds one or more tags to an IAM user. If a tag with the same key name already exists, then that tag is overwritten with the new value.</p> <p>A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:</p> <ul> <li> <p> <b>Administrative grouping and discovery</b> - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name <i>Project</i> and the value <i>MyImportantProject</i>. Or search for all resources with the key name <i>Cost Center</i> and the value <i>41200</i>. </p> </li> <li> <p> <b>Access control</b> - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM requesting user that has a specified tag attached. You can also restrict access to only those resources that have a certain tag attached. For examples of policies that show how to use tags to control access, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Control access using IAM tags</a> in the <i>IAM User Guide</i>.</p> </li> <li> <p> <b>Cost allocation</b> - Use tags to help track which individuals and teams are using which Amazon Web Services resources.</p> </li> </ul> <note> <ul> <li> <p>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. For more information about tagging, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM resources</a> in the <i>IAM User Guide</i>.</p> </li> <li> <p>Amazon Web Services always interprets the tag <code>Value</code> as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.</p> </li> </ul> </note> <p>For more information about tagging, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM identities</a> in the <i>IAM User Guide</i>.</p> | +| `users_Untag` | `EXEC` | `TagKeys, UserName, region` | Removes the specified tags from the user. For more information about tagging, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM resources</a> in the <i>IAM User Guide</i>. | +| `users_Update` | `EXEC` | `UserName, region` | <p>Updates the name and/or the path of the specified IAM user.</p> <important> <p> You should understand the implications of changing an IAM user's path or name. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_manage.html#id_users_renaming">Renaming an IAM user</a> and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_groups_manage_rename.html">Renaming an IAM group</a> in the <i>IAM User Guide</i>.</p> </important> <note> <p> To change a user name, the requester must have appropriate permissions on both the source object and the target object. For example, to change Bob to Robert, the entity making the request must have permission on Bob and Robert, or must have permission on all (*). For more information about permissions, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/PermissionsAndPolicies.html">Permissions and policies</a>. </p> </note> | diff --git a/docs/aws-docs/providers/aws/iam_api/virtual_mfa_devices/index.md b/docs/aws-docs/providers/aws/iam_api/virtual_mfa_devices/index.md new file mode 100644 index 0000000000..afd396da2d --- /dev/null +++ b/docs/aws-docs/providers/aws/iam_api/virtual_mfa_devices/index.md @@ -0,0 +1,41 @@ +--- +title: virtual_mfa_devices +hide_title: false +hide_table_of_contents: false +keywords: + - virtual_mfa_devices + - iam_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namevirtual_mfa_devices
TypeResource
Idaws.iam_api.virtual_mfa_devices
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `Base32StringSeed` | `string` | The base32 seed defined as specified in <a href="https://tools.ietf.org/html/rfc3548.txt">RFC3548</a>. The <code>Base32StringSeed</code> is base64-encoded. | +| `EnableDate` | `string` | The date and time on which the virtual MFA device was enabled. | +| `QRCodePNG` | `string` | A QR code PNG image that encodes <code>otpauth://totp/$virtualMFADeviceName@$AccountName?secret=$Base32String</code> where <code>$virtualMFADeviceName</code> is one of the create call arguments. <code>AccountName</code> is the user name if set (otherwise, the account ID otherwise), and <code>Base32String</code> is the seed in base32 format. The <code>Base32String</code> value is base64-encoded. | +| `SerialNumber` | `string` | The serial number associated with <code>VirtualMFADevice</code>. | +| `Tags` | `array` | A list of tags that are attached to the virtual MFA device. For more information about tagging, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM resources</a> in the <i>IAM User Guide</i>. | +| `User` | `object` | <p>Contains information about an IAM user entity.</p> <p>This data type is used as a response element in the following operations:</p> <ul> <li> <p> <a>CreateUser</a> </p> </li> <li> <p> <a>GetUser</a> </p> </li> <li> <p> <a>ListUsers</a> </p> </li> </ul> | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `virtual_mfa_devices_List` | `SELECT` | `region` | <p>Lists the virtual MFA devices defined in the Amazon Web Services account by assignment status. If you do not specify an assignment status, the operation returns a list of all virtual MFA devices. Assignment status can be <code>Assigned</code>, <code>Unassigned</code>, or <code>Any</code>.</p> <note> <p>IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view tag information for a virtual MFA device, see <a>ListMFADeviceTags</a>.</p> </note> <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters.</p> | +| `virtual_mfa_devices_Create` | `INSERT` | `VirtualMFADeviceName, region` | <p>Creates a new virtual MFA device for the Amazon Web Services account. After creating the virtual MFA, use <a>EnableMFADevice</a> to attach the MFA device to an IAM user. For more information about creating and working with virtual MFA devices, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_VirtualMFA.html">Using a virtual MFA device</a> in the <i>IAM User Guide</i>.</p> <p>For information about the maximum number of MFA devices you can create, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html">IAM and STS quotas</a> in the <i>IAM User Guide</i>.</p> <important> <p>The seed information contained in the QR code and the Base32 string should be treated like any other secret access information. In other words, protect the seed information as you would your Amazon Web Services access keys or your passwords. After you provision your virtual device, you should ensure that the information is destroyed following secure procedures.</p> </important> | +| `virtual_mfa_devices_Delete` | `DELETE` | `SerialNumber, region` | <p>Deletes a virtual MFA device.</p> <note> <p> You must deactivate a user's virtual MFA device before you can delete it. For information about deactivating MFA devices, see <a>DeactivateMFADevice</a>. </p> </note> | diff --git a/docs/aws-docs/providers/aws/identitystore/group/index.md b/docs/aws-docs/providers/aws/identitystore/group/index.md new file mode 100644 index 0000000000..81cd614786 --- /dev/null +++ b/docs/aws-docs/providers/aws/identitystore/group/index.md @@ -0,0 +1,95 @@ +--- +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
DescriptionResource Type definition for AWS::IdentityStore::Group
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +description, +display_name, +group_id, +identity_store_id +FROM aws.identitystore.group +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the group resource, the following permissions are required: + +### Read +```json +identitystore:DescribeGroup +``` + +### Update +```json +identitystore:DescribeGroup, +identitystore:UpdateGroup +``` + +### Delete +```json +identitystore:DescribeGroup, +identitystore:DeleteGroup +``` + diff --git a/docs/aws-docs/providers/aws/identitystore/group_membership/index.md b/docs/aws-docs/providers/aws/identitystore/group_membership/index.md new file mode 100644 index 0000000000..bcff16e978 --- /dev/null +++ b/docs/aws-docs/providers/aws/identitystore/group_membership/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionResource Type Definition for AWS:IdentityStore::GroupMembership
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +group_id, +identity_store_id, +member_id, +membership_id +FROM aws.identitystore.group_membership +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the group_membership resource, the following permissions are required: + +### Read +```json +identitystore:DescribeGroupMembership +``` + +### Delete +```json +identitystore:DeleteGroupMembership, +identitystore:DescribeGroupMembership +``` + diff --git a/docs/aws-docs/providers/aws/identitystore/group_memberships/index.md b/docs/aws-docs/providers/aws/identitystore/group_memberships/index.md new file mode 100644 index 0000000000..4185197619 --- /dev/null +++ b/docs/aws-docs/providers/aws/identitystore/group_memberships/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionResource Type Definition for AWS:IdentityStore::GroupMembership
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +membership_id, +identity_store_id +FROM aws.identitystore.group_memberships +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the group_memberships resource, the following permissions are required: + +### Create +```json +identitystore:CreateGroupMembership, +identitystore:DescribeGroupMembership +``` + +### List +```json +identitystore:ListGroupMemberships +``` + diff --git a/docs/aws-docs/providers/aws/identitystore/groups/index.md b/docs/aws-docs/providers/aws/identitystore/groups/index.md new file mode 100644 index 0000000000..86720808f1 --- /dev/null +++ b/docs/aws-docs/providers/aws/identitystore/groups/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionResource Type definition for AWS::IdentityStore::Group
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +group_id, +identity_store_id +FROM aws.identitystore.groups +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the groups resource, the following permissions are required: + +### Create +```json +identitystore:CreateGroup, +identitystore:DescribeGroup +``` + +### List +```json +identitystore:ListGroups +``` + diff --git a/docs/aws-docs/providers/aws/identitystore/index.md b/docs/aws-docs/providers/aws/identitystore/index.md new file mode 100644 index 0000000000..4700f55a7e --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/imagebuilder/component/index.md b/docs/aws-docs/providers/aws/imagebuilder/component/index.md new file mode 100644 index 0000000000..73ad61625e --- /dev/null +++ b/docs/aws-docs/providers/aws/imagebuilder/component/index.md @@ -0,0 +1,103 @@ +--- +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
DescriptionResource schema for AWS::ImageBuilder::Component
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +name, +version, +description, +change_description, +type, +platform, +data, +kms_key_id, +encrypted, +tags, +uri, +supported_os_versions +FROM aws.imagebuilder.component +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the component resource, the following permissions are required: + +### Read +```json +imagebuilder:GetComponent +``` + +### Delete +```json +imagebuilder:GetComponent, +imagebuilder:UnTagResource, +imagebuilder:DeleteComponent +``` + diff --git a/docs/aws-docs/providers/aws/imagebuilder/components/index.md b/docs/aws-docs/providers/aws/imagebuilder/components/index.md new file mode 100644 index 0000000000..2df3bc9769 --- /dev/null +++ b/docs/aws-docs/providers/aws/imagebuilder/components/index.md @@ -0,0 +1,87 @@ +--- +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
DescriptionResource schema for AWS::ImageBuilder::Component
Idaws.imagebuilder.components
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the component.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.imagebuilder.components +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the components resource, the following permissions are required: + +### Create +```json +iam:CreateServiceLinkedRole, +iam:GetRole, +kms:GenerateDataKey*, +kms:Encrypt, +kms:Decrypt, +s3:GetObject, +s3:HeadBucket, +s3:GetBucketLocation, +imagebuilder:TagResource, +imagebuilder:GetComponent, +imagebuilder:CreateComponent +``` + +### List +```json +imagebuilder:ListComponents +``` + diff --git a/docs/aws-docs/providers/aws/imagebuilder/container_recipe/index.md b/docs/aws-docs/providers/aws/imagebuilder/container_recipe/index.md new file mode 100644 index 0000000000..70c4e1aaed --- /dev/null +++ b/docs/aws-docs/providers/aws/imagebuilder/container_recipe/index.md @@ -0,0 +1,109 @@ +--- +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
DescriptionResource schema for AWS::ImageBuilder::ContainerRecipe
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.imagebuilder.container_recipe +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the container_recipe resource, the following permissions are required: + +### Read +```json +imagebuilder:GetContainerRecipe +``` + +### Delete +```json +imagebuilder:UnTagResource, +imagebuilder:GetContainerRecipe, +imagebuilder:DeleteContainerRecipe +``` + diff --git a/docs/aws-docs/providers/aws/imagebuilder/container_recipes/index.md b/docs/aws-docs/providers/aws/imagebuilder/container_recipes/index.md new file mode 100644 index 0000000000..07f927f8ee --- /dev/null +++ b/docs/aws-docs/providers/aws/imagebuilder/container_recipes/index.md @@ -0,0 +1,92 @@ +--- +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
DescriptionResource schema for AWS::ImageBuilder::ContainerRecipe
Idaws.imagebuilder.container_recipes
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the container recipe.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.imagebuilder.container_recipes +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the container_recipes resource, the following permissions are required: + +### Create +```json +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 +```json +imagebuilder:ListContainerRecipes +``` + diff --git a/docs/aws-docs/providers/aws/imagebuilder/distribution_configuration/index.md b/docs/aws-docs/providers/aws/imagebuilder/distribution_configuration/index.md new file mode 100644 index 0000000000..8529448782 --- /dev/null +++ b/docs/aws-docs/providers/aws/imagebuilder/distribution_configuration/index.md @@ -0,0 +1,101 @@ +--- +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
DescriptionResource schema for AWS::ImageBuilder::DistributionConfiguration
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +name, +description, +distributions, +tags +FROM aws.imagebuilder.distribution_configuration +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the distribution_configuration resource, the following permissions are required: + +### Update +```json +ec2:DescribeLaunchTemplates, +ec2:CreateLaunchTemplateVersion, +ec2:ModifyLaunchTemplate, +imagebuilder:GetDistributionConfiguration, +imagebuilder:UpdateDistributionConfiguration +``` + +### Read +```json +imagebuilder:GetDistributionConfiguration +``` + +### Delete +```json +imagebuilder:GetDistributionConfiguration, +imagebuilder:UnTagResource, +imagebuilder:DeleteDistributionConfiguration +``` + diff --git a/docs/aws-docs/providers/aws/imagebuilder/distribution_configurations/index.md b/docs/aws-docs/providers/aws/imagebuilder/distribution_configurations/index.md new file mode 100644 index 0000000000..4cf62a95ad --- /dev/null +++ b/docs/aws-docs/providers/aws/imagebuilder/distribution_configurations/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionResource schema for AWS::ImageBuilder::DistributionConfiguration
Idaws.imagebuilder.distribution_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the distribution configuration.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.imagebuilder.distribution_configurations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the distribution_configurations resource, the following permissions are required: + +### Create +```json +iam:GetRole, +iam:CreateServiceLinkedRole, +ec2:DescribeLaunchTemplates, +ec2:CreateLaunchTemplateVersion, +ec2:ModifyLaunchTemplate, +imagebuilder:TagResource, +imagebuilder:GetDistributionConfiguration, +imagebuilder:CreateDistributionConfiguration +``` + +### List +```json +imagebuilder:ListDistributionConfigurations +``` + diff --git a/docs/aws-docs/providers/aws/imagebuilder/image/index.md b/docs/aws-docs/providers/aws/imagebuilder/image/index.md new file mode 100644 index 0000000000..5a92ecc773 --- /dev/null +++ b/docs/aws-docs/providers/aws/imagebuilder/image/index.md @@ -0,0 +1,106 @@ +--- +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
DescriptionResource schema for AWS::ImageBuilder::Image
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.imagebuilder.image +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the image resource, the following permissions are required: + +### Read +```json +imagebuilder:GetImage +``` + +### Delete +```json +imagebuilder:GetImage, +imagebuilder:DeleteImage, +imagebuilder:UnTagResource, +imagebuilder:CancelImageCreation +``` + diff --git a/docs/aws-docs/providers/aws/imagebuilder/image_pipeline/index.md b/docs/aws-docs/providers/aws/imagebuilder/image_pipeline/index.md new file mode 100644 index 0000000000..1b2d5d2644 --- /dev/null +++ b/docs/aws-docs/providers/aws/imagebuilder/image_pipeline/index.md @@ -0,0 +1,120 @@ +--- +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
DescriptionResource schema for AWS::ImageBuilder::ImagePipeline
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.imagebuilder.image_pipeline +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the image_pipeline resource, the following permissions are required: + +### Update +```json +iam:PassRole, +imagebuilder:GetImagePipeline, +imagebuilder:UpdateImagePipeline, +imagebuilder:GetWorkflow +``` + +### Read +```json +imagebuilder:GetImagePipeline +``` + +### Delete +```json +imagebuilder:UnTagResource, +imagebuilder:GetImagePipeline, +imagebuilder:DeleteImagePipeline +``` + diff --git a/docs/aws-docs/providers/aws/imagebuilder/image_pipelines/index.md b/docs/aws-docs/providers/aws/imagebuilder/image_pipelines/index.md new file mode 100644 index 0000000000..7cee10547b --- /dev/null +++ b/docs/aws-docs/providers/aws/imagebuilder/image_pipelines/index.md @@ -0,0 +1,88 @@ +--- +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
DescriptionResource schema for AWS::ImageBuilder::ImagePipeline
Idaws.imagebuilder.image_pipelines
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the image pipeline.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.imagebuilder.image_pipelines +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the image_pipelines resource, the following permissions are required: + +### Create +```json +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 +```json +imagebuilder:ListImagePipelines +``` + diff --git a/docs/aws-docs/providers/aws/imagebuilder/image_recipe/index.md b/docs/aws-docs/providers/aws/imagebuilder/image_recipe/index.md new file mode 100644 index 0000000000..4f1f52e357 --- /dev/null +++ b/docs/aws-docs/providers/aws/imagebuilder/image_recipe/index.md @@ -0,0 +1,97 @@ +--- +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
DescriptionResource schema for AWS::ImageBuilder::ImageRecipe
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +name, +description, +version, +components, +block_device_mappings, +parent_image, +working_directory, +additional_instance_configuration, +tags +FROM aws.imagebuilder.image_recipe +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the image_recipe resource, the following permissions are required: + +### Read +```json +imagebuilder:GetImageRecipe +``` + +### Delete +```json +imagebuilder:UnTagResource, +imagebuilder:GetImageRecipe, +imagebuilder:DeleteImageRecipe +``` + diff --git a/docs/aws-docs/providers/aws/imagebuilder/image_recipes/index.md b/docs/aws-docs/providers/aws/imagebuilder/image_recipes/index.md new file mode 100644 index 0000000000..a6247d7b17 --- /dev/null +++ b/docs/aws-docs/providers/aws/imagebuilder/image_recipes/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionResource schema for AWS::ImageBuilder::ImageRecipe
Idaws.imagebuilder.image_recipes
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the image recipe.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.imagebuilder.image_recipes +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the image_recipes resource, the following permissions are required: + +### Create +```json +iam:GetRole, +iam:CreateServiceLinkedRole, +imagebuilder:GetComponent, +imagebuilder:GetImage, +imagebuilder:TagResource, +imagebuilder:GetImageRecipe, +imagebuilder:CreateImageRecipe, +ec2:DescribeImages +``` + +### List +```json +imagebuilder:ListImageRecipes +``` + diff --git a/docs/aws-docs/providers/aws/imagebuilder/images/index.md b/docs/aws-docs/providers/aws/imagebuilder/images/index.md new file mode 100644 index 0000000000..91310b02c5 --- /dev/null +++ b/docs/aws-docs/providers/aws/imagebuilder/images/index.md @@ -0,0 +1,88 @@ +--- +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
DescriptionResource schema for AWS::ImageBuilder::Image
Idaws.imagebuilder.images
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the image.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.imagebuilder.images +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the images resource, the following permissions are required: + +### Create +```json +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 +```json +imagebuilder:ListImages +``` + diff --git a/docs/aws-docs/providers/aws/imagebuilder/index.md b/docs/aws-docs/providers/aws/imagebuilder/index.md new file mode 100644 index 0000000000..1f70fe8d6a --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/imagebuilder/infrastructure_configuration/index.md b/docs/aws-docs/providers/aws/imagebuilder/infrastructure_configuration/index.md new file mode 100644 index 0000000000..f664d71c07 --- /dev/null +++ b/docs/aws-docs/providers/aws/imagebuilder/infrastructure_configuration/index.md @@ -0,0 +1,118 @@ +--- +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
DescriptionResource schema for AWS::ImageBuilder::InfrastructureConfiguration
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.imagebuilder.infrastructure_configuration +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the infrastructure_configuration resource, the following permissions are required: + +### Update +```json +iam:PassRole, +sns:Publish, +imagebuilder:GetInfrastructureConfiguration, +imagebuilder:UpdateInfrastructureConfiguration +``` + +### Read +```json +imagebuilder:GetInfrastructureConfiguration +``` + +### Delete +```json +imagebuilder:UnTagResource, +imagebuilder:GetInfrastructureConfiguration, +imagebuilder:DeleteInfrastructureConfiguration +``` + diff --git a/docs/aws-docs/providers/aws/imagebuilder/infrastructure_configurations/index.md b/docs/aws-docs/providers/aws/imagebuilder/infrastructure_configurations/index.md new file mode 100644 index 0000000000..c6eb5b7dde --- /dev/null +++ b/docs/aws-docs/providers/aws/imagebuilder/infrastructure_configurations/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionResource schema for AWS::ImageBuilder::InfrastructureConfiguration
Idaws.imagebuilder.infrastructure_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the infrastructure configuration.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.imagebuilder.infrastructure_configurations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the infrastructure_configurations resource, the following permissions are required: + +### Create +```json +iam:PassRole, +iam:GetRole, +iam:GetInstanceProfile, +iam:CreateServiceLinkedRole, +sns:Publish, +imagebuilder:TagResource, +imagebuilder:GetInfrastructureConfiguration, +imagebuilder:CreateInfrastructureConfiguration +``` + +### List +```json +imagebuilder:ListInfrastructureConfigurations +``` + diff --git a/docs/aws-docs/providers/aws/imagebuilder/lifecycle_policies/index.md b/docs/aws-docs/providers/aws/imagebuilder/lifecycle_policies/index.md new file mode 100644 index 0000000000..cb61332356 --- /dev/null +++ b/docs/aws-docs/providers/aws/imagebuilder/lifecycle_policies/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionResource schema for AWS::ImageBuilder::LifecyclePolicy
Idaws.imagebuilder.lifecycle_policies
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the lifecycle policy.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.imagebuilder.lifecycle_policies +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the lifecycle_policies resource, the following permissions are required: + +### Create +```json +iam:PassRole, +imagebuilder:CreateLifecyclePolicy, +imagebuilder:GetLifecyclePolicy, +imagebuilder:TagResource +``` + +### List +```json +imagebuilder:ListLifecyclePolicies +``` + diff --git a/docs/aws-docs/providers/aws/imagebuilder/lifecycle_policy/index.md b/docs/aws-docs/providers/aws/imagebuilder/lifecycle_policy/index.md new file mode 100644 index 0000000000..7963a96187 --- /dev/null +++ b/docs/aws-docs/providers/aws/imagebuilder/lifecycle_policy/index.md @@ -0,0 +1,107 @@ +--- +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
DescriptionResource schema for AWS::ImageBuilder::LifecyclePolicy
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +name, +description, +status, +execution_role, +resource_type, +policy_details, +resource_selection, +tags +FROM aws.imagebuilder.lifecycle_policy +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the lifecycle_policy resource, the following permissions are required: + +### Update +```json +iam:PassRole, +imagebuilder:GetLifecyclePolicy, +imagebuilder:UpdateLifecyclePolicy +``` + +### Read +```json +imagebuilder:GetLifecyclePolicy +``` + +### Delete +```json +imagebuilder:GetLifecyclePolicy, +imagebuilder:DeleteLifecyclePolicy, +imagebuilder:UnTagResource +``` + diff --git a/docs/aws-docs/providers/aws/imagebuilder/workflow/index.md b/docs/aws-docs/providers/aws/imagebuilder/workflow/index.md new file mode 100644 index 0000000000..536ad0627d --- /dev/null +++ b/docs/aws-docs/providers/aws/imagebuilder/workflow/index.md @@ -0,0 +1,97 @@ +--- +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
DescriptionResource schema for AWS::ImageBuilder::Workflow
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +name, +version, +description, +change_description, +type, +data, +uri, +kms_key_id, +tags +FROM aws.imagebuilder.workflow +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the workflow resource, the following permissions are required: + +### Read +```json +imagebuilder:GetWorkflow +``` + +### Delete +```json +imagebuilder:GetWorkflow, +imagebuilder:UnTagResource, +imagebuilder:DeleteWorkflow +``` + diff --git a/docs/aws-docs/providers/aws/imagebuilder/workflows/index.md b/docs/aws-docs/providers/aws/imagebuilder/workflows/index.md new file mode 100644 index 0000000000..01083221c4 --- /dev/null +++ b/docs/aws-docs/providers/aws/imagebuilder/workflows/index.md @@ -0,0 +1,86 @@ +--- +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
DescriptionResource schema for AWS::ImageBuilder::Workflow
Idaws.imagebuilder.workflows
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the workflow.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.imagebuilder.workflows +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the workflows resource, the following permissions are required: + +### Create +```json +iam:GetRole, +kms:GenerateDataKey*, +kms:Encrypt, +kms:Decrypt, +s3:GetObject, +s3:HeadBucket, +s3:GetBucketLocation, +imagebuilder:TagResource, +imagebuilder:GetWorkflow, +imagebuilder:CreateWorkflow +``` + +### List +```json +imagebuilder:ListWorkflows +``` + diff --git a/docs/aws-docs/providers/aws/inspector/assessment_target/index.md b/docs/aws-docs/providers/aws/inspector/assessment_target/index.md new file mode 100644 index 0000000000..8a29c3c518 --- /dev/null +++ b/docs/aws-docs/providers/aws/inspector/assessment_target/index.md @@ -0,0 +1,92 @@ +--- +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
DescriptionResource Type definition for AWS::Inspector::AssessmentTarget
Idaws.inspector.assessment_target
+ +## Fields + + + + + + + +
NameDatatypeDescription
arnstring
assessment_target_namestring
resource_group_arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +assessment_target_name, +resource_group_arn +FROM aws.inspector.assessment_target +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the assessment_target resource, the following permissions are required: + +### Update +```json +inspector:DescribeAssessmentTargets, +inspector:UpdateAssessmentTarget +``` + +### Read +```json +inspector:DescribeAssessmentTargets +``` + +### Delete +```json +inspector:DeleteAssessmentTarget +``` + diff --git a/docs/aws-docs/providers/aws/inspector/assessment_targets/index.md b/docs/aws-docs/providers/aws/inspector/assessment_targets/index.md new file mode 100644 index 0000000000..4a86908d4b --- /dev/null +++ b/docs/aws-docs/providers/aws/inspector/assessment_targets/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource Type definition for AWS::Inspector::AssessmentTarget
Idaws.inspector.assessment_targets
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.inspector.assessment_targets +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the assessment_targets resource, the following permissions are required: + +### Create +```json +inspector:CreateAssessmentTarget, +inspector:ListAssessmentTargets, +inspector:DescribeAssessmentTargets +``` + +### List +```json +inspector:ListAssessmentTargets +``` + diff --git a/docs/aws-docs/providers/aws/inspector/assessment_template/index.md b/docs/aws-docs/providers/aws/inspector/assessment_template/index.md new file mode 100644 index 0000000000..961d64fc88 --- /dev/null +++ b/docs/aws-docs/providers/aws/inspector/assessment_template/index.md @@ -0,0 +1,87 @@ +--- +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
DescriptionResource Type definition for AWS::Inspector::AssessmentTemplate
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +assessment_target_arn, +duration_in_seconds, +assessment_template_name, +rules_package_arns, +user_attributes_for_findings +FROM aws.inspector.assessment_template +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the assessment_template resource, the following permissions are required: + +### Read +```json +inspector:DescribeAssessmentTemplates +``` + +### Delete +```json +inspector:DeleteAssessmentTemplate +``` + diff --git a/docs/aws-docs/providers/aws/inspector/assessment_templates/index.md b/docs/aws-docs/providers/aws/inspector/assessment_templates/index.md new file mode 100644 index 0000000000..38d0acbe2d --- /dev/null +++ b/docs/aws-docs/providers/aws/inspector/assessment_templates/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource Type definition for AWS::Inspector::AssessmentTemplate
Idaws.inspector.assessment_templates
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.inspector.assessment_templates +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the assessment_templates resource, the following permissions are required: + +### Create +```json +inspector:CreateAssessmentTemplate, +inspector:ListAssessmentTemplates, +inspector:DescribeAssessmentTemplates +``` + +### List +```json +inspector:ListAssessmentTemplates +``` + diff --git a/docs/aws-docs/providers/aws/inspector/index.md b/docs/aws-docs/providers/aws/inspector/index.md new file mode 100644 index 0000000000..967a196ae1 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/inspector/resource_group/index.md b/docs/aws-docs/providers/aws/inspector/resource_group/index.md new file mode 100644 index 0000000000..424aa4f422 --- /dev/null +++ b/docs/aws-docs/providers/aws/inspector/resource_group/index.md @@ -0,0 +1,79 @@ +--- +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 Type definition for AWS::Inspector::ResourceGroup
Idaws.inspector.resource_group
+ +## Fields + + + + + + +
NameDatatypeDescription
arnstring
resource_group_tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +resource_group_tags +FROM aws.inspector.resource_group +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the resource_group resource, the following permissions are required: + +### Read +```json +inspector:CreateResourceGroup +``` + +### Delete +```json +inspector:CreateResourceGroup +``` + diff --git a/docs/aws-docs/providers/aws/inspector/resource_groups/index.md b/docs/aws-docs/providers/aws/inspector/resource_groups/index.md new file mode 100644 index 0000000000..0e350945ef --- /dev/null +++ b/docs/aws-docs/providers/aws/inspector/resource_groups/index.md @@ -0,0 +1,67 @@ +--- +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 Type definition for AWS::Inspector::ResourceGroup
Idaws.inspector.resource_groups
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.inspector.resource_groups +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the resource_groups resource, the following permissions are required: + +### Create +```json +inspector:CreateResourceGroup +``` + diff --git a/docs/aws-docs/providers/aws/inspectorv2/cis_scan_configuration/index.md b/docs/aws-docs/providers/aws/inspectorv2/cis_scan_configuration/index.md new file mode 100644 index 0000000000..abcf71b2a5 --- /dev/null +++ b/docs/aws-docs/providers/aws/inspectorv2/cis_scan_configuration/index.md @@ -0,0 +1,104 @@ +--- +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 resource schema
Idaws.inspectorv2.cis_scan_configuration
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
scan_namestringName of the scan
security_levelstring
scheduleundefined
targetsundefined
arnstringCIS Scan configuration unique identifier
tagsobject
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +scan_name, +security_level, +schedule, +targets, +arn, +tags +FROM aws.inspectorv2.cis_scan_configuration +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the cis_scan_configuration resource, the following permissions are required: + +### Read +```json +inspector2:ListCisScanConfigurations, +inspector2:ListTagsForResource +``` + +### Update +```json +inspector2:ListCisScanConfigurations, +inspector2:UpdateCisScanConfiguration, +inspector2:TagResource, +inspector2:UntagResource, +inspector2:ListTagsForResource +``` + +### Delete +```json +inspector2:ListCisScanConfigurations, +inspector2:DeleteCisScanConfiguration, +inspector2:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/inspectorv2/cis_scan_configurations/index.md b/docs/aws-docs/providers/aws/inspectorv2/cis_scan_configurations/index.md new file mode 100644 index 0000000000..4ae5102e07 --- /dev/null +++ b/docs/aws-docs/providers/aws/inspectorv2/cis_scan_configurations/index.md @@ -0,0 +1,80 @@ +--- +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 Configuration resource schema
Idaws.inspectorv2.cis_scan_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringCIS Scan configuration unique identifier
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.inspectorv2.cis_scan_configurations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the cis_scan_configurations resource, the following permissions are required: + +### Create +```json +inspector2:CreateCisScanConfiguration, +inspector2:ListCisScanConfigurations, +inspector2:TagResource +``` + +### List +```json +inspector2:ListCisScanConfigurations, +inspector2:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/inspectorv2/filter/index.md b/docs/aws-docs/providers/aws/inspectorv2/filter/index.md new file mode 100644 index 0000000000..84394d4a04 --- /dev/null +++ b/docs/aws-docs/providers/aws/inspectorv2/filter/index.md @@ -0,0 +1,97 @@ +--- +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
DescriptionInspector Filter resource schema
Idaws.inspectorv2.filter
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
namestringFindings filter name.
descriptionstringFindings filter description.
filter_criteriaobjectFindings filter criteria.
filter_actionstringFindings filter action.
arnstringFindings filter ARN.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +description, +filter_criteria, +filter_action, +arn +FROM aws.inspectorv2.filter +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the filter resource, the following permissions are required: + +### Read +```json +inspector2:ListFilters +``` + +### Update +```json +inspector2:ListFilters, +inspector2:UpdateFilter +``` + +### Delete +```json +inspector2:DeleteFilter, +inspector2:ListFilters +``` + diff --git a/docs/aws-docs/providers/aws/inspectorv2/filters/index.md b/docs/aws-docs/providers/aws/inspectorv2/filters/index.md new file mode 100644 index 0000000000..fc78150297 --- /dev/null +++ b/docs/aws-docs/providers/aws/inspectorv2/filters/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionInspector Filter resource schema
Idaws.inspectorv2.filters
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringFindings filter ARN.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.inspectorv2.filters +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the filters resource, the following permissions are required: + +### Create +```json +inspector2:CreateFilter, +inspector2:ListFilters +``` + +### List +```json +inspector2:ListFilters +``` + diff --git a/docs/aws-docs/providers/aws/inspectorv2/index.md b/docs/aws-docs/providers/aws/inspectorv2/index.md new file mode 100644 index 0000000000..e6f88a7a51 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/internetmonitor/index.md b/docs/aws-docs/providers/aws/internetmonitor/index.md new file mode 100644 index 0000000000..7b0f2d95f4 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/internetmonitor/monitor/index.md b/docs/aws-docs/providers/aws/internetmonitor/monitor/index.md new file mode 100644 index 0000000000..496d058118 --- /dev/null +++ b/docs/aws-docs/providers/aws/internetmonitor/monitor/index.md @@ -0,0 +1,137 @@ +--- +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
DescriptionRepresents a monitor, which defines the monitoring boundaries for measurements that Internet Monitor publishes information about for an application
Idaws.internetmonitor.monitor
+ +## Fields + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
created_atstring
modified_atstring
monitor_arnstring
monitor_namestring
linked_account_idstring
include_linked_accountsboolean
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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +created_at, +modified_at, +monitor_arn, +monitor_name, +linked_account_id, +include_linked_accounts, +processing_status, +processing_status_info, +resources, +resources_to_add, +resources_to_remove, +status, +tags, +max_city_networks_to_monitor, +traffic_percentage_to_monitor, +internet_measurements_log_delivery, +health_events_config +FROM aws.internetmonitor.monitor +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the monitor resource, the following permissions are required: + +### Read +```json +internetmonitor:GetMonitor, +internetmonitor:ListTagsForResource, +logs:GetLogDelivery +``` + +### Update +```json +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 +```json +internetmonitor:UpdateMonitor, +internetmonitor:DeleteMonitor, +internetmonitor:GetMonitor, +logs:DeleteLogDelivery +``` + diff --git a/docs/aws-docs/providers/aws/internetmonitor/monitors/index.md b/docs/aws-docs/providers/aws/internetmonitor/monitors/index.md new file mode 100644 index 0000000000..440a9dbf5e --- /dev/null +++ b/docs/aws-docs/providers/aws/internetmonitor/monitors/index.md @@ -0,0 +1,88 @@ +--- +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
DescriptionRepresents a monitor, which defines the monitoring boundaries for measurements that Internet Monitor publishes information about for an application
Idaws.internetmonitor.monitors
+ +## Fields + + + + + +
NameDatatypeDescription
monitor_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +monitor_name +FROM aws.internetmonitor.monitors +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the monitors resource, the following permissions are required: + +### Create +```json +internetmonitor:CreateMonitor, +internetmonitor:GetMonitor, +internetmonitor:TagResource, +internetmonitor:UntagResource, +logs:CreateLogDelivery, +logs:GetLogDelivery, +s3:GetBucketPolicy, +s3:PutBucketPolicy, +s3:ListBucket, +iam:PassRole +``` + +### List +```json +internetmonitor:ListMonitors, +internetmonitor:GetMonitor, +logs:GetLogDelivery +``` + diff --git a/docs/aws-docs/providers/aws/iot/account_audit_configuration/index.md b/docs/aws-docs/providers/aws/iot/account_audit_configuration/index.md new file mode 100644 index 0000000000..b126a07bc4 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/account_audit_configuration/index.md @@ -0,0 +1,96 @@ +--- +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
DescriptionConfigures the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +account_id, +audit_check_configurations, +audit_notification_target_configurations, +role_arn +FROM aws.iot.account_audit_configuration +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the account_audit_configuration resource, the following permissions are required: + +### Read +```json +iot:DescribeAccountAuditConfiguration +``` + +### Update +```json +iot:UpdateAccountAuditConfiguration, +iot:DescribeAccountAuditConfiguration, +iam:PassRole +``` + +### Delete +```json +iot:DescribeAccountAuditConfiguration, +iot:DeleteAccountAuditConfiguration +``` + diff --git a/docs/aws-docs/providers/aws/iot/account_audit_configurations/index.md b/docs/aws-docs/providers/aws/iot/account_audit_configurations/index.md new file mode 100644 index 0000000000..e604f0c779 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/account_audit_configurations/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionConfigures the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled.
Idaws.iot.account_audit_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
account_idstringYour 12-digit account ID (used as the primary identifier for the CloudFormation resource).
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +account_id +FROM aws.iot.account_audit_configurations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the account_audit_configurations resource, the following permissions are required: + +### Create +```json +iot:UpdateAccountAuditConfiguration, +iot:DescribeAccountAuditConfiguration, +iam:PassRole +``` + +### List +```json +iot:DescribeAccountAuditConfiguration +``` + diff --git a/docs/aws-docs/providers/aws/iot/authorizer/index.md b/docs/aws-docs/providers/aws/iot/authorizer/index.md new file mode 100644 index 0000000000..4543c05353 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/authorizer/index.md @@ -0,0 +1,110 @@ +--- +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
DescriptionCreates an authorizer.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.iot.authorizer +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the authorizer resource, the following permissions are required: + +### Read +```json +iot:DescribeAuthorizer, +iot:ListTagsForResource +``` + +### Update +```json +iot:UpdateAuthorizer, +iot:DescribeAuthorizer, +iot:TagResource, +iot:UntagResource, +iot:ListTagsForResource +``` + +### Delete +```json +iot:UpdateAuthorizer, +iot:DeleteAuthorizer, +iot:DescribeAuthorizer +``` + diff --git a/docs/aws-docs/providers/aws/iot/authorizers/index.md b/docs/aws-docs/providers/aws/iot/authorizers/index.md new file mode 100644 index 0000000000..d24047c971 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/authorizers/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionCreates an authorizer.
Idaws.iot.authorizers
+ +## Fields + + + + + +
NameDatatypeDescription
authorizer_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +authorizer_name +FROM aws.iot.authorizers +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the authorizers resource, the following permissions are required: + +### Create +```json +iot:CreateAuthorizer, +iot:DescribeAuthorizer, +iot:TagResource, +iot:ListTagsForResource +``` + +### List +```json +iot:ListAuthorizers +``` + diff --git a/docs/aws-docs/providers/aws/iot/billing_group/index.md b/docs/aws-docs/providers/aws/iot/billing_group/index.md new file mode 100644 index 0000000000..9040fcd84d --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/billing_group/index.md @@ -0,0 +1,101 @@ +--- +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
DescriptionResource Type definition for AWS::IoT::BillingGroup
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +arn, +billing_group_name, +tags, +billing_group_properties +FROM aws.iot.billing_group +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the billing_group resource, the following permissions are required: + +### Delete +```json +iot:DescribeBillingGroup, +iot:DeleteBillingGroup +``` + +### Read +```json +iot:DescribeBillingGroup, +iot:ListTagsForResource +``` + +### Update +```json +iot:DescribeBillingGroup, +iot:UpdateBillingGroup, +iot:ListTagsForResource, +iot:TagResource, +iot:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/iot/billing_groups/index.md b/docs/aws-docs/providers/aws/iot/billing_groups/index.md new file mode 100644 index 0000000000..2b946ed515 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/billing_groups/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionResource Type definition for AWS::IoT::BillingGroup
Idaws.iot.billing_groups
+ +## Fields + + + + + +
NameDatatypeDescription
billing_group_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +billing_group_name +FROM aws.iot.billing_groups +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the billing_groups resource, the following permissions are required: + +### Create +```json +iot:DescribeBillingGroup, +iot:ListTagsForResource, +iot:CreateBillingGroup, +iot:TagResource +``` + +### List +```json +iot:ListBillingGroups, +iot:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/iot/ca_certificate/index.md b/docs/aws-docs/providers/aws/iot/ca_certificate/index.md new file mode 100644 index 0000000000..e988239e79 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/ca_certificate/index.md @@ -0,0 +1,114 @@ +--- +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
DescriptionRegisters a CA Certificate in IoT.
Idaws.iot.ca_certificate
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
ca_certificate_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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +ca_certificate_pem, +verification_certificate_pem, +status, +certificate_mode, +auto_registration_status, +remove_auto_registration, +registration_config, +id, +arn, +tags +FROM aws.iot.ca_certificate +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the ca_certificate resource, the following permissions are required: + +### Read +```json +iot:DescribeCACertificate, +iot:ListTagsForResource +``` + +### Update +```json +iam:GetRole, +iam:PassRole, +iot:UpdateCACertificate, +iot:DescribeCACertificate, +iot:TagResource, +iot:UntagResource, +iot:ListTagsForResource +``` + +### Delete +```json +iot:UpdateCACertificate, +iot:DeleteCACertificate, +iot:DescribeCACertificate +``` + diff --git a/docs/aws-docs/providers/aws/iot/ca_certificates/index.md b/docs/aws-docs/providers/aws/iot/ca_certificates/index.md new file mode 100644 index 0000000000..84c3ff1473 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/ca_certificates/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionRegisters a CA Certificate in IoT.
Idaws.iot.ca_certificates
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.iot.ca_certificates +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the ca_certificates resource, the following permissions are required: + +### Create +```json +iam:GetRole, +iam:PassRole, +iot:RegisterCACertificate, +iot:DescribeCACertificate, +iot:TagResource, +iot:ListTagsForResource +``` + +### List +```json +iot:ListCACertificates +``` + diff --git a/docs/aws-docs/providers/aws/iot/certificate/index.md b/docs/aws-docs/providers/aws/iot/certificate/index.md new file mode 100644 index 0000000000..5dca70328b --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/certificate/index.md @@ -0,0 +1,102 @@ +--- +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
DescriptionUse the AWS::IoT::Certificate resource to declare an AWS IoT X.509 certificate.
Idaws.iot.certificate
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
ca_certificate_pemstring
certificate_pemstring
certificate_signing_requeststring
certificate_modestring
statusstring
idstring
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +ca_certificate_pem, +certificate_pem, +certificate_signing_request, +certificate_mode, +status, +id, +arn +FROM aws.iot.certificate +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the certificate resource, the following permissions are required: + +### Read +```json +iot:DescribeCertificate +``` + +### Update +```json +iot:UpdateCertificate, +iot:DescribeCertificate +``` + +### Delete +```json +iot:DeleteCertificate, +iot:UpdateCertificate, +iot:DescribeCertificate +``` + diff --git a/docs/aws-docs/providers/aws/iot/certificate_provider/index.md b/docs/aws-docs/providers/aws/iot/certificate_provider/index.md new file mode 100644 index 0000000000..6fb4532f04 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/certificate_provider/index.md @@ -0,0 +1,101 @@ +--- +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
DescriptionUse the AWS::IoT::CertificateProvider resource to declare an AWS IoT Certificate Provider.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +certificate_provider_name, +lambda_function_arn, +account_default_for_operations, +tags, +arn +FROM aws.iot.certificate_provider +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the certificate_provider resource, the following permissions are required: + +### Read +```json +iot:DescribeCertificateProvider, +iot:ListTagsForResource +``` + +### Update +```json +iot:UpdateCertificateProvider, +iot:DescribeCertificateProvider, +iot:TagResource, +iot:UntagResource, +iot:ListTagsForResource +``` + +### Delete +```json +iot:DeleteCertificateProvider, +iot:DescribeCertificateProvider +``` + diff --git a/docs/aws-docs/providers/aws/iot/certificate_providers/index.md b/docs/aws-docs/providers/aws/iot/certificate_providers/index.md new file mode 100644 index 0000000000..87c3f9d31d --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/certificate_providers/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionUse the AWS::IoT::CertificateProvider resource to declare an AWS IoT Certificate Provider.
Idaws.iot.certificate_providers
+ +## Fields + + + + + +
NameDatatypeDescription
certificate_provider_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +certificate_provider_name +FROM aws.iot.certificate_providers +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the certificate_providers resource, the following permissions are required: + +### Create +```json +iot:CreateCertificateProvider, +iot:DescribeCertificateProvider, +iot:TagResource, +iot:ListTagsForResource +``` + +### List +```json +iot:ListCertificateProviders +``` + diff --git a/docs/aws-docs/providers/aws/iot/certificates/index.md b/docs/aws-docs/providers/aws/iot/certificates/index.md new file mode 100644 index 0000000000..af9e95c15c --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/certificates/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionUse the AWS::IoT::Certificate resource to declare an AWS IoT X.509 certificate.
Idaws.iot.certificates
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.iot.certificates +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the certificates resource, the following permissions are required: + +### Create +```json +iot:CreateCertificateFromCsr, +iot:RegisterCertificate, +iot:RegisterCertificateWithoutCA, +iot:DescribeCertificate +``` + +### List +```json +iot:ListCertificates +``` + diff --git a/docs/aws-docs/providers/aws/iot/custom_metric/index.md b/docs/aws-docs/providers/aws/iot/custom_metric/index.md new file mode 100644 index 0000000000..eeeaebd406 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/custom_metric/index.md @@ -0,0 +1,100 @@ +--- +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
DescriptionA custom metric published by your devices to Device Defender.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +metric_name, +display_name, +metric_type, +metric_arn, +tags +FROM aws.iot.custom_metric +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the custom_metric resource, the following permissions are required: + +### Read +```json +iot:DescribeCustomMetric, +iot:ListTagsForResource +``` + +### Update +```json +iot:UpdateCustomMetric, +iot:ListTagsForResource, +iot:UntagResource, +iot:TagResource +``` + +### Delete +```json +iot:DescribeCustomMetric, +iot:DeleteCustomMetric +``` + diff --git a/docs/aws-docs/providers/aws/iot/custom_metrics/index.md b/docs/aws-docs/providers/aws/iot/custom_metrics/index.md new file mode 100644 index 0000000000..b5be494f8f --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/custom_metrics/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionA custom metric published by your devices to Device Defender.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +metric_name +FROM aws.iot.custom_metrics +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the custom_metrics resource, the following permissions are required: + +### Create +```json +iot:CreateCustomMetric, +iot:TagResource +``` + +### List +```json +iot:ListCustomMetrics +``` + diff --git a/docs/aws-docs/providers/aws/iot/dimension/index.md b/docs/aws-docs/providers/aws/iot/dimension/index.md new file mode 100644 index 0000000000..cc9a052cf1 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/dimension/index.md @@ -0,0 +1,100 @@ +--- +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
DescriptionA dimension can be used to limit the scope of a metric used in a security profile for AWS IoT Device Defender.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +type, +string_values, +tags, +arn +FROM aws.iot.dimension +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the dimension resource, the following permissions are required: + +### Read +```json +iot:DescribeDimension, +iot:ListTagsForResource +``` + +### Update +```json +iot:UpdateDimension, +iot:ListTagsForResource, +iot:UntagResource, +iot:TagResource +``` + +### Delete +```json +iot:DescribeDimension, +iot:DeleteDimension +``` + diff --git a/docs/aws-docs/providers/aws/iot/dimensions/index.md b/docs/aws-docs/providers/aws/iot/dimensions/index.md new file mode 100644 index 0000000000..4d59cd695c --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/dimensions/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionA dimension can be used to limit the scope of a metric used in a security profile for AWS IoT Device Defender.
Idaws.iot.dimensions
+ +## Fields + + + + + +
NameDatatypeDescription
namestringA unique identifier for the dimension.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.iot.dimensions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the dimensions resource, the following permissions are required: + +### Create +```json +iot:CreateDimension, +iot:TagResource +``` + +### List +```json +iot:ListDimensions +``` + diff --git a/docs/aws-docs/providers/aws/iot/domain_configuration/index.md b/docs/aws-docs/providers/aws/iot/domain_configuration/index.md new file mode 100644 index 0000000000..8ccdd92758 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/domain_configuration/index.md @@ -0,0 +1,118 @@ +--- +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
DescriptionCreate and manage a Domain Configuration
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.iot.domain_configuration +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the domain_configuration resource, the following permissions are required: + +### Read +```json +iot:DescribeDomainConfiguration, +iot:ListTagsForResource +``` + +### Update +```json +iot:UpdateDomainConfiguration, +iot:DescribeDomainConfiguration, +iot:ListTagsForResource, +iot:TagResource, +iot:UntagResource +``` + +### Delete +```json +iot:DescribeDomainConfiguration, +iot:DeleteDomainConfiguration, +iot:UpdateDomainConfiguration +``` + diff --git a/docs/aws-docs/providers/aws/iot/domain_configurations/index.md b/docs/aws-docs/providers/aws/iot/domain_configurations/index.md new file mode 100644 index 0000000000..b7b3d6aea3 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/domain_configurations/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionCreate and manage a Domain Configuration
Idaws.iot.domain_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
domain_configuration_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +domain_configuration_name +FROM aws.iot.domain_configurations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the domain_configurations resource, the following permissions are required: + +### Create +```json +iot:CreateDomainConfiguration, +iot:UpdateDomainConfiguration, +iot:DescribeDomainConfiguration, +iot:TagResource, +iot:ListTagsForResource, +acm:GetCertificate +``` + +### List +```json +iot:ListDomainConfigurations +``` + diff --git a/docs/aws-docs/providers/aws/iot/fleet_metric/index.md b/docs/aws-docs/providers/aws/iot/fleet_metric/index.md new file mode 100644 index 0000000000..e571c42fd2 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/fleet_metric/index.md @@ -0,0 +1,119 @@ +--- +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
DescriptionAn aggregated metric of certain devices in your fleet
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.iot.fleet_metric +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the fleet_metric resource, the following permissions are required: + +### Read +```json +iot:DescribeFleetMetric, +iot:ListTagsForResource +``` + +### Update +```json +iot:UpdateFleetMetric, +iot:DescribeFleetMetric, +iot:ListTagsForResource, +iot:UntagResource, +iot:TagResource +``` + +### Delete +```json +iot:DeleteFleetMetric, +iot:DescribeFleetMetric +``` + diff --git a/docs/aws-docs/providers/aws/iot/fleet_metrics/index.md b/docs/aws-docs/providers/aws/iot/fleet_metrics/index.md new file mode 100644 index 0000000000..153e5dcda2 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/fleet_metrics/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionAn aggregated metric of certain devices in your fleet
Idaws.iot.fleet_metrics
+ +## Fields + + + + + +
NameDatatypeDescription
metric_namestringThe name of the fleet metric
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +metric_name +FROM aws.iot.fleet_metrics +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the fleet_metrics resource, the following permissions are required: + +### Create +```json +iot:CreateFleetMetric, +iot:DescribeFleetMetric, +iot:TagResource +``` + +### List +```json +iot:ListFleetMetrics +``` + diff --git a/docs/aws-docs/providers/aws/iot/index.md b/docs/aws-docs/providers/aws/iot/index.md new file mode 100644 index 0000000000..0807a3c568 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/iot/job_template/index.md b/docs/aws-docs/providers/aws/iot/job_template/index.md new file mode 100644 index 0000000000..50e8664921 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/job_template/index.md @@ -0,0 +1,103 @@ +--- +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 templates enable you to preconfigure jobs so that you can deploy them to multiple sets of target devices.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.iot.job_template +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the job_template resource, the following permissions are required: + +### Read +```json +iot:DescribeJobTemplate +``` + +### Delete +```json +iot:DeleteJobTemplate +``` + diff --git a/docs/aws-docs/providers/aws/iot/job_templates/index.md b/docs/aws-docs/providers/aws/iot/job_templates/index.md new file mode 100644 index 0000000000..75a36fdaa5 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/job_templates/index.md @@ -0,0 +1,80 @@ +--- +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 enable you to preconfigure jobs so that you can deploy them to multiple sets of target devices.
Idaws.iot.job_templates
+ +## Fields + + + + + +
NameDatatypeDescription
job_template_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +job_template_id +FROM aws.iot.job_templates +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the job_templates resource, the following permissions are required: + +### Create +```json +iot:CreateJobTemplate, +iam:PassRole, +s3:GetObject, +iot:TagResource +``` + +### List +```json +iot:ListJobTemplates +``` + diff --git a/docs/aws-docs/providers/aws/iot/logging/index.md b/docs/aws-docs/providers/aws/iot/logging/index.md new file mode 100644 index 0000000000..9a02e2b963 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/logging/index.md @@ -0,0 +1,94 @@ +--- +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 Options enable you to configure your IoT V2 logging role and default logging level so that you can monitor progress events logs as it passes from your devices through Iot core service.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +account_id, +role_arn, +default_log_level +FROM aws.iot.logging +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the logging resource, the following permissions are required: + +### Read +```json +iot:GetV2LoggingOptions +``` + +### Update +```json +iot:SetV2LoggingOptions, +iot:GetV2LoggingOptions, +iam:PassRole +``` + +### Delete +```json +iot:SetV2LoggingOptions, +iot:GetV2LoggingOptions +``` + diff --git a/docs/aws-docs/providers/aws/iot/loggings/index.md b/docs/aws-docs/providers/aws/iot/loggings/index.md new file mode 100644 index 0000000000..2802947af5 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/loggings/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionLogging Options enable you to configure your IoT V2 logging role and default logging level so that you can monitor progress events logs as it passes from your devices through Iot core service.
Idaws.iot.loggings
+ +## Fields + + + + + +
NameDatatypeDescription
account_idstringYour 12-digit account ID (used as the primary identifier for the CloudFormation resource).
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +account_id +FROM aws.iot.loggings +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the loggings resource, the following permissions are required: + +### Create +```json +iot:SetV2LoggingOptions, +iot:GetV2LoggingOptions, +iam:PassRole +``` + +### List +```json +iot:GetV2LoggingOptions +``` + diff --git a/docs/aws-docs/providers/aws/iot/mitigation_action/index.md b/docs/aws-docs/providers/aws/iot/mitigation_action/index.md new file mode 100644 index 0000000000..0c34797a78 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/mitigation_action/index.md @@ -0,0 +1,103 @@ +--- +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 actions can be used to take actions to mitigate issues that were found in an Audit finding or Detect violation.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +action_name, +role_arn, +tags, +action_params, +mitigation_action_arn, +mitigation_action_id +FROM aws.iot.mitigation_action +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the mitigation_action resource, the following permissions are required: + +### Read +```json +iot:DescribeMitigationAction, +iot:ListTagsForResource +``` + +### Update +```json +iot:UpdateMitigationAction, +iot:ListTagsForResource, +iot:UntagResource, +iot:TagResource, +iam:PassRole +``` + +### Delete +```json +iot:DescribeMitigationAction, +iot:DeleteMitigationAction +``` + diff --git a/docs/aws-docs/providers/aws/iot/mitigation_actions/index.md b/docs/aws-docs/providers/aws/iot/mitigation_actions/index.md new file mode 100644 index 0000000000..1ae9f1a86c --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/mitigation_actions/index.md @@ -0,0 +1,80 @@ +--- +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 can be used to take actions to mitigate issues that were found in an Audit finding or Detect violation.
Idaws.iot.mitigation_actions
+ +## Fields + + + + + +
NameDatatypeDescription
action_namestringA unique identifier for the mitigation action.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +action_name +FROM aws.iot.mitigation_actions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the mitigation_actions resource, the following permissions are required: + +### Create +```json +iot:CreateMitigationAction, +iot:DescribeMitigationAction, +iot:TagResource, +iam:PassRole +``` + +### List +```json +iot:ListMitigationActions +``` + diff --git a/docs/aws-docs/providers/aws/iot/policies/index.md b/docs/aws-docs/providers/aws/iot/policies/index.md new file mode 100644 index 0000000000..b2786af3be --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/policies/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionResource Type definition for AWS::IoT::Policy
Idaws.iot.policies
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.iot.policies +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the policies resource, the following permissions are required: + +### Create +```json +iot:CreatePolicy, +iot:GetPolicy, +iot:TagResource, +iot:ListTagsForResource +``` + +### List +```json +iot:ListPolicies +``` + diff --git a/docs/aws-docs/providers/aws/iot/policy/index.md b/docs/aws-docs/providers/aws/iot/policy/index.md new file mode 100644 index 0000000000..7a0c5cdc89 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/policy/index.md @@ -0,0 +1,106 @@ +--- +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
DescriptionResource Type definition for AWS::IoT::Policy
Idaws.iot.policy
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
idstring
arnstring
policy_documentobject
policy_namestring
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +arn, +policy_document, +policy_name, +tags +FROM aws.iot.policy +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the policy resource, the following permissions are required: + +### Read +```json +iot:GetPolicy, +iot:ListTagsForResource +``` + +### Delete +```json +iot:DeletePolicy, +iot:GetPolicy, +iot:ListPolicyVersions, +iot:DeletePolicyVersion +``` + +### Update +```json +iot:GetPolicy, +iot:ListPolicyVersions, +iot:CreatePolicyVersion, +iot:DeletePolicyVersion, +iot:SetDefaultPolicyVersion, +iot:TagResource, +iot:UntagResource, +iot:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/iot/provisioning_template/index.md b/docs/aws-docs/providers/aws/iot/provisioning_template/index.md new file mode 100644 index 0000000000..08830a2a9e --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/provisioning_template/index.md @@ -0,0 +1,114 @@ +--- +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
DescriptionCreates a fleet provisioning template.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +template_arn, +template_name, +description, +enabled, +provisioning_role_arn, +template_body, +template_type, +pre_provisioning_hook, +tags +FROM aws.iot.provisioning_template +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the provisioning_template resource, the following permissions are required: + +### Read +```json +iot:DescribeProvisioningTemplate, +iot:ListTagsForResource +``` + +### Update +```json +iam:GetRole, +iam:PassRole, +iot:UpdateProvisioningTemplate, +iot:CreateProvisioningTemplateVersion, +iot:ListProvisioningTemplateVersions, +iot:DeleteProvisioningTemplateVersion, +iot:DescribeProvisioningTemplate, +iot:TagResource, +iot:UntagResource, +iot:ListTagsForResource +``` + +### Delete +```json +iot:DeleteProvisioningTemplate, +iot:DescribeProvisioningTemplate +``` + diff --git a/docs/aws-docs/providers/aws/iot/provisioning_templates/index.md b/docs/aws-docs/providers/aws/iot/provisioning_templates/index.md new file mode 100644 index 0000000000..df33db93a7 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/provisioning_templates/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionCreates a fleet provisioning template.
Idaws.iot.provisioning_templates
+ +## Fields + + + + + +
NameDatatypeDescription
template_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +template_name +FROM aws.iot.provisioning_templates +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the provisioning_templates resource, the following permissions are required: + +### Create +```json +iam:GetRole, +iam:PassRole, +iot:CreateProvisioningTemplate, +iot:DescribeProvisioningTemplate, +iot:TagResource, +iot:ListTagsForResource +``` + +### List +```json +iot:ListProvisioningTemplates +``` + diff --git a/docs/aws-docs/providers/aws/iot/resource_specific_logging/index.md b/docs/aws-docs/providers/aws/iot/resource_specific_logging/index.md new file mode 100644 index 0000000000..ae96c555e5 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/resource_specific_logging/index.md @@ -0,0 +1,95 @@ +--- +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 allows you to specify a logging level for a specific thing group.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +target_type, +target_name, +log_level, +target_id +FROM aws.iot.resource_specific_logging +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the resource_specific_logging resource, the following permissions are required: + +### Read +```json +iot:ListV2LoggingLevels +``` + +### Update +```json +iot:ListV2LoggingLevels, +iot:SetV2LoggingLevel +``` + +### Delete +```json +iot:ListV2LoggingLevels, +iot:DeleteV2LoggingLevel +``` + diff --git a/docs/aws-docs/providers/aws/iot/resource_specific_loggings/index.md b/docs/aws-docs/providers/aws/iot/resource_specific_loggings/index.md new file mode 100644 index 0000000000..8231950c50 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/resource_specific_loggings/index.md @@ -0,0 +1,78 @@ +--- +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 logging allows you to specify a logging level for a specific thing group.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +target_id +FROM aws.iot.resource_specific_loggings +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the resource_specific_loggings resource, the following permissions are required: + +### Create +```json +iot:ListV2LoggingLevels, +iot:SetV2LoggingLevel +``` + +### List +```json +iot:ListV2LoggingLevels +``` + diff --git a/docs/aws-docs/providers/aws/iot/role_alias/index.md b/docs/aws-docs/providers/aws/iot/role_alias/index.md new file mode 100644 index 0000000000..626df36c0d --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/role_alias/index.md @@ -0,0 +1,105 @@ +--- +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
DescriptionUse the AWS::IoT::RoleAlias resource to declare an AWS IoT RoleAlias.
Idaws.iot.role_alias
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
role_aliasstring
role_alias_arnstring
role_arnstring
credential_duration_secondsinteger
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +role_alias, +role_alias_arn, +role_arn, +credential_duration_seconds, +tags +FROM aws.iot.role_alias +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the role_alias resource, the following permissions are required: + +### Read +```json +iam:GetRole, +iam:PassRole, +iot:DescribeRoleAlias, +iot:ListTagsForResource +``` + +### Update +```json +iam:GetRole, +iam:PassRole, +iot:UpdateRoleAlias, +iot:DescribeRoleAlias, +iot:TagResource, +iot:UntagResource, +iot:ListTagsForResource +``` + +### Delete +```json +iot:DeleteRoleAlias, +iot:DescribeRoleAlias +``` + diff --git a/docs/aws-docs/providers/aws/iot/role_aliases/index.md b/docs/aws-docs/providers/aws/iot/role_aliases/index.md new file mode 100644 index 0000000000..5120b3a7b6 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/role_aliases/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionUse the AWS::IoT::RoleAlias resource to declare an AWS IoT RoleAlias.
Idaws.iot.role_aliases
+ +## Fields + + + + + +
NameDatatypeDescription
role_aliasstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +role_alias +FROM aws.iot.role_aliases +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the role_aliases resource, the following permissions are required: + +### Create +```json +iam:GetRole, +iam:PassRole, +iot:CreateRoleAlias, +iot:DescribeRoleAlias, +iot:TagResource, +iot:ListTagsForResource +``` + +### List +```json +iot:ListRoleAliases +``` + diff --git a/docs/aws-docs/providers/aws/iot/scheduled_audit/index.md b/docs/aws-docs/providers/aws/iot/scheduled_audit/index.md new file mode 100644 index 0000000000..6f3a71221a --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/scheduled_audit/index.md @@ -0,0 +1,104 @@ +--- +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 audits can be used to specify the checks you want to perform during an audit and how often the audit should be run.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +scheduled_audit_name, +frequency, +day_of_month, +day_of_week, +target_check_names, +scheduled_audit_arn, +tags +FROM aws.iot.scheduled_audit +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the scheduled_audit resource, the following permissions are required: + +### Read +```json +iot:DescribeScheduledAudit, +iot:ListTagsForResource +``` + +### Update +```json +iot:UpdateScheduledAudit, +iot:ListTagsForResource, +iot:UntagResource, +iot:TagResource +``` + +### Delete +```json +iot:DescribeScheduledAudit, +iot:DeleteScheduledAudit +``` + diff --git a/docs/aws-docs/providers/aws/iot/scheduled_audits/index.md b/docs/aws-docs/providers/aws/iot/scheduled_audits/index.md new file mode 100644 index 0000000000..7a0f47d63c --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/scheduled_audits/index.md @@ -0,0 +1,79 @@ +--- +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 can be used to specify the checks you want to perform during an audit and how often the audit should be run.
Idaws.iot.scheduled_audits
+ +## Fields + + + + + +
NameDatatypeDescription
scheduled_audit_namestringThe name you want to give to the scheduled audit.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +scheduled_audit_name +FROM aws.iot.scheduled_audits +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the scheduled_audits resource, the following permissions are required: + +### Create +```json +iot:CreateScheduledAudit, +iot:DescribeScheduledAudit, +iot:TagResource +``` + +### List +```json +iot:ListScheduledAudits +``` + diff --git a/docs/aws-docs/providers/aws/iot/security_profile/index.md b/docs/aws-docs/providers/aws/iot/security_profile/index.md new file mode 100644 index 0000000000..509eaf82c8 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/security_profile/index.md @@ -0,0 +1,113 @@ +--- +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
DescriptionA security profile defines a set of expected behaviors for devices in your account.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.iot.security_profile +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the security_profile resource, the following permissions are required: + +### Read +```json +iot:DescribeSecurityProfile, +iot:ListTagsForResource, +iot:ListTargetsForSecurityProfile +``` + +### Update +```json +iot:UpdateSecurityProfile, +iot:ListTargetsForSecurityProfile, +iot:AttachSecurityProfile, +iot:DetachSecurityProfile, +iot:ListTagsForResource, +iot:UntagResource, +iot:TagResource, +iam:PassRole +``` + +### Delete +```json +iot:DescribeSecurityProfile, +iot:DeleteSecurityProfile +``` + diff --git a/docs/aws-docs/providers/aws/iot/security_profiles/index.md b/docs/aws-docs/providers/aws/iot/security_profiles/index.md new file mode 100644 index 0000000000..89c3143b83 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/security_profiles/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionA security profile defines a set of expected behaviors for devices in your account.
Idaws.iot.security_profiles
+ +## Fields + + + + + +
NameDatatypeDescription
security_profile_namestringA unique identifier for the security profile.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +security_profile_name +FROM aws.iot.security_profiles +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the security_profiles resource, the following permissions are required: + +### Create +```json +iot:CreateSecurityProfile, +iot:AttachSecurityProfile, +iot:DescribeSecurityProfile, +iot:TagResource, +iam:PassRole +``` + +### List +```json +iot:ListSecurityProfiles +``` + diff --git a/docs/aws-docs/providers/aws/iot/software_package/index.md b/docs/aws-docs/providers/aws/iot/software_package/index.md new file mode 100644 index 0000000000..6c6afd07f2 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/software_package/index.md @@ -0,0 +1,107 @@ +--- +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
Descriptionresource definition
Idaws.iot.software_package
+ +## Fields + + + + + + + + +
NameDatatypeDescription
descriptionstring
package_arnstring
package_namestring
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +description, +package_arn, +package_name, +tags +FROM aws.iot.software_package +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the software_package resource, the following permissions are required: + +### Read +```json +iot:GetPackage, +iot:ListTagsForResource +``` + +### Update +```json +iot:CreatePackage, +iot:UpdatePackage, +iot:GetPackage, +iot:ListTagsForResource, +iot:TagResource, +iot:UntagResource, +iot:GetIndexingConfiguration +``` + +### Delete +```json +iot:DeletePackage, +iot:DeletePackageVersion, +iot:GetPackage, +iot:GetPackageVersion, +iot:UpdatePackage, +iot:UpdatePackageVersion, +iot:GetIndexingConfiguration, +iot:ListPackageVersions +``` + diff --git a/docs/aws-docs/providers/aws/iot/software_package_version/index.md b/docs/aws-docs/providers/aws/iot/software_package_version/index.md new file mode 100644 index 0000000000..90901b7636 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/software_package_version/index.md @@ -0,0 +1,110 @@ +--- +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
Descriptionresource definition
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +attributes, +description, +error_reason, +package_name, +package_version_arn, +status, +tags, +version_name +FROM aws.iot.software_package_version +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the software_package_version resource, the following permissions are required: + +### Read +```json +iot:GetPackageVersion, +iot:ListTagsForResource +``` + +### Update +```json +iot:UpdatePackageVersion, +iot:GetPackageVersion, +iot:ListTagsForResource, +iot:TagResource, +iot:UntagResource, +iot:GetIndexingConfiguration +``` + +### Delete +```json +iot:DeletePackageVersion, +iot:UpdatePackageVersion, +iot:GetPackageVersion, +iot:GetIndexingConfiguration +``` + diff --git a/docs/aws-docs/providers/aws/iot/software_package_versions/index.md b/docs/aws-docs/providers/aws/iot/software_package_versions/index.md new file mode 100644 index 0000000000..725d64ae5a --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/software_package_versions/index.md @@ -0,0 +1,82 @@ +--- +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
Descriptionresource definition
Idaws.iot.software_package_versions
+ +## Fields + + + + + + +
NameDatatypeDescription
package_namestring
version_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +package_name, +version_name +FROM aws.iot.software_package_versions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the software_package_versions resource, the following permissions are required: + +### Create +```json +iot:CreatePackageVersion, +iot:GetPackageVersion, +iot:TagResource, +iot:GetIndexingConfiguration +``` + +### List +```json +iot:ListPackageVersions +``` + diff --git a/docs/aws-docs/providers/aws/iot/software_packages/index.md b/docs/aws-docs/providers/aws/iot/software_packages/index.md new file mode 100644 index 0000000000..be8d8d80e4 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/software_packages/index.md @@ -0,0 +1,80 @@ +--- +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
Descriptionresource definition
Idaws.iot.software_packages
+ +## Fields + + + + + +
NameDatatypeDescription
package_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +package_name +FROM aws.iot.software_packages +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the software_packages resource, the following permissions are required: + +### Create +```json +iot:CreatePackage, +iot:GetPackage, +iot:TagResource, +iot:GetIndexingConfiguration +``` + +### List +```json +iot:ListPackages +``` + diff --git a/docs/aws-docs/providers/aws/iot/thing/index.md b/docs/aws-docs/providers/aws/iot/thing/index.md new file mode 100644 index 0000000000..d24fcf3c22 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/thing/index.md @@ -0,0 +1,95 @@ +--- +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
DescriptionResource Type definition for AWS::IoT::Thing
Idaws.iot.thing
+ +## Fields + + + + + + + + +
NameDatatypeDescription
idstring
arnstring
attribute_payloadobject
thing_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +arn, +attribute_payload, +thing_name +FROM aws.iot.thing +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the thing resource, the following permissions are required: + +### Delete +```json +iot:DeleteThing, +iot:DescribeThing +``` + +### Read +```json +iot:DescribeThing +``` + +### Update +```json +iot:UpdateThing, +iot:DescribeThing +``` + diff --git a/docs/aws-docs/providers/aws/iot/thing_group/index.md b/docs/aws-docs/providers/aws/iot/thing_group/index.md new file mode 100644 index 0000000000..de5d665923 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/thing_group/index.md @@ -0,0 +1,107 @@ +--- +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
DescriptionResource Type definition for AWS::IoT::ThingGroup
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +arn, +thing_group_name, +parent_group_name, +query_string, +thing_group_properties, +tags +FROM aws.iot.thing_group +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the thing_group resource, the following permissions are required: + +### Delete +```json +iot:DescribeThingGroup, +iot:DeleteThingGroup, +iot:DeleteDynamicThingGroup +``` + +### Read +```json +iot:DescribeThingGroup, +iot:ListTagsForResource +``` + +### Update +```json +iot:ListTagsForResource, +iot:DescribeThingGroup, +iot:UpdateThingGroup, +iot:UpdateDynamicThingGroup, +iot:TagResource, +iot:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/iot/thing_groups/index.md b/docs/aws-docs/providers/aws/iot/thing_groups/index.md new file mode 100644 index 0000000000..32c1959880 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/thing_groups/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionResource Type definition for AWS::IoT::ThingGroup
Idaws.iot.thing_groups
+ +## Fields + + + + + +
NameDatatypeDescription
thing_group_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +thing_group_name +FROM aws.iot.thing_groups +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the thing_groups resource, the following permissions are required: + +### Create +```json +iot:DescribeThingGroup, +iot:ListTagsForResource, +iot:CreateThingGroup, +iot:CreateDynamicThingGroup, +iot:TagResource +``` + +### List +```json +iot:ListThingGroups, +iot:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/iot/thing_type/index.md b/docs/aws-docs/providers/aws/iot/thing_type/index.md new file mode 100644 index 0000000000..d98249fb19 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/thing_type/index.md @@ -0,0 +1,105 @@ +--- +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
DescriptionResource Type definition for AWS::IoT::ThingType
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +arn, +thing_type_name, +deprecate_thing_type, +thing_type_properties, +tags +FROM aws.iot.thing_type +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the thing_type resource, the following permissions are required: + +### Delete +```json +iot:DescribeThingType, +iot:DeleteThingType, +iot:DeprecateThingType +``` + +### Read +```json +iot:DescribeThingType, +iot:ListTagsForResource +``` + +### Update +```json +iot:DescribeThingType, +iot:UpdateThingType, +iot:ListTagsForResource, +iot:TagResource, +iot:UntagResource, +iot:DeprecateThingType +``` + diff --git a/docs/aws-docs/providers/aws/iot/thing_types/index.md b/docs/aws-docs/providers/aws/iot/thing_types/index.md new file mode 100644 index 0000000000..9f64bbd34f --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/thing_types/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionResource Type definition for AWS::IoT::ThingType
Idaws.iot.thing_types
+ +## Fields + + + + + +
NameDatatypeDescription
thing_type_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +thing_type_name +FROM aws.iot.thing_types +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the thing_types resource, the following permissions are required: + +### Create +```json +iot:DescribeThingType, +iot:ListTagsForResource, +iot:CreateThingType, +iot:DeprecateThingType, +iot:TagResource +``` + +### List +```json +iot:ListThingTypes, +iot:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/iot/things/index.md b/docs/aws-docs/providers/aws/iot/things/index.md new file mode 100644 index 0000000000..7a8d6ee83f --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/things/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionResource Type definition for AWS::IoT::Thing
Idaws.iot.things
+ +## Fields + + + + + +
NameDatatypeDescription
thing_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +thing_name +FROM aws.iot.things +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the things resource, the following permissions are required: + +### Create +```json +iot:CreateThing, +iot:DescribeThing +``` + +### List +```json +iot:ListThings +``` + diff --git a/docs/aws-docs/providers/aws/iot/topic_rule/index.md b/docs/aws-docs/providers/aws/iot/topic_rule/index.md new file mode 100644 index 0000000000..591c209327 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/topic_rule/index.md @@ -0,0 +1,100 @@ +--- +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
DescriptionResource Type definition for AWS::IoT::TopicRule
Idaws.iot.topic_rule
+ +## Fields + + + + + + + + +
NameDatatypeDescription
arnstring
rule_namestring
topic_rule_payloadobject
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +rule_name, +topic_rule_payload, +tags +FROM aws.iot.topic_rule +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the topic_rule resource, the following permissions are required: + +### Read +```json +iot:GetTopicRule, +iot:ListTagsForResource +``` + +### Update +```json +iam:PassRole, +iot:GetTopicRule, +iot:ListTagsForResource, +iot:ReplaceTopicRule, +iot:TagResource, +iot:UntagResource +``` + +### Delete +```json +iot:GetTopicRule, +iot:DeleteTopicRule +``` + diff --git a/docs/aws-docs/providers/aws/iot/topic_rule_destination/index.md b/docs/aws-docs/providers/aws/iot/topic_rule_destination/index.md new file mode 100644 index 0000000000..20fc2c9338 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/topic_rule_destination/index.md @@ -0,0 +1,98 @@ +--- +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
DescriptionResource Type definition for AWS::IoT::TopicRuleDestination
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +status, +http_url_properties, +status_reason, +vpc_properties +FROM aws.iot.topic_rule_destination +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the topic_rule_destination resource, the following permissions are required: + +### Read +```json +iot:GetTopicRuleDestination +``` + +### Update +```json +iam:PassRole, +iot:GetTopicRuleDestination, +iot:UpdateTopicRuleDestination +``` + +### Delete +```json +iot:GetTopicRuleDestination, +iot:DeleteTopicRuleDestination +``` + diff --git a/docs/aws-docs/providers/aws/iot/topic_rule_destinations/index.md b/docs/aws-docs/providers/aws/iot/topic_rule_destinations/index.md new file mode 100644 index 0000000000..098144fe47 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/topic_rule_destinations/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionResource Type definition for AWS::IoT::TopicRuleDestination
Idaws.iot.topic_rule_destinations
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringAmazon Resource Name (ARN).
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.iot.topic_rule_destinations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the topic_rule_destinations resource, the following permissions are required: + +### Create +```json +iam:PassRole, +iot:CreateTopicRuleDestination, +iot:GetTopicRuleDestination, +iot:UpdateTopicRuleDestination +``` + +### List +```json +iot:ListTopicRuleDestinations +``` + diff --git a/docs/aws-docs/providers/aws/iot/topic_rules/index.md b/docs/aws-docs/providers/aws/iot/topic_rules/index.md new file mode 100644 index 0000000000..e6de1f37f7 --- /dev/null +++ b/docs/aws-docs/providers/aws/iot/topic_rules/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionResource Type definition for AWS::IoT::TopicRule
Idaws.iot.topic_rules
+ +## Fields + + + + + +
NameDatatypeDescription
rule_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +rule_name +FROM aws.iot.topic_rules +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the topic_rules resource, the following permissions are required: + +### Create +```json +iam:PassRole, +iot:CreateTopicRule, +iot:GetTopicRule, +iot:TagResource, +iot:ListTagsForResource +``` + +### List +```json +iot:ListTopicRules +``` + diff --git a/docs/aws-docs/providers/aws/iotanalytics/dataset/index.md b/docs/aws-docs/providers/aws/iotanalytics/dataset/index.md new file mode 100644 index 0000000000..bba92c62e8 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotanalytics/dataset/index.md @@ -0,0 +1,106 @@ +--- +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
DescriptionResource Type definition for AWS::IoTAnalytics::Dataset
Idaws.iotanalytics.dataset
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
actionsarray
late_data_rulesarray
dataset_namestring
content_delivery_rulesarray
triggersarray
versioning_configurationobject
idstring
retention_periodobject
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +actions, +late_data_rules, +dataset_name, +content_delivery_rules, +triggers, +versioning_configuration, +id, +retention_period, +tags +FROM aws.iotanalytics.dataset +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the dataset resource, the following permissions are required: + +### Read +```json +iotanalytics:DescribeDataset, +iotanalytics:ListTagsForResource +``` + +### Update +```json +iotanalytics:UpdateDataset, +iotanalytics:TagResource, +iotanalytics:UntagResource +``` + +### Delete +```json +iotanalytics:DeleteDataset +``` + diff --git a/docs/aws-docs/providers/aws/iotanalytics/datasets/index.md b/docs/aws-docs/providers/aws/iotanalytics/datasets/index.md new file mode 100644 index 0000000000..4d3aa44d85 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotanalytics/datasets/index.md @@ -0,0 +1,77 @@ +--- +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
DescriptionResource Type definition for AWS::IoTAnalytics::Dataset
Idaws.iotanalytics.datasets
+ +## Fields + + + + + +
NameDatatypeDescription
dataset_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +dataset_name +FROM aws.iotanalytics.datasets +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the datasets resource, the following permissions are required: + +### Create +```json +iotanalytics:CreateDataset +``` + +### List +```json +iotanalytics:ListDatasets +``` + diff --git a/docs/aws-docs/providers/aws/iotanalytics/index.md b/docs/aws-docs/providers/aws/iotanalytics/index.md new file mode 100644 index 0000000000..88b69d9893 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/iotanalytics/pipeline/index.md b/docs/aws-docs/providers/aws/iotanalytics/pipeline/index.md new file mode 100644 index 0000000000..354632e3c6 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotanalytics/pipeline/index.md @@ -0,0 +1,96 @@ +--- +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
DescriptionResource Type definition for AWS::IoTAnalytics::Pipeline
Idaws.iotanalytics.pipeline
+ +## Fields + + + + + + + + +
NameDatatypeDescription
idstring
pipeline_namestring
tagsarray
pipeline_activitiesarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +pipeline_name, +tags, +pipeline_activities +FROM aws.iotanalytics.pipeline +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the pipeline resource, the following permissions are required: + +### Read +```json +iotanalytics:DescribePipeline, +iotanalytics:ListTagsForResource +``` + +### Update +```json +iotanalytics:UpdatePipeline, +iotanalytics:TagResource, +iotanalytics:UntagResource +``` + +### Delete +```json +iotanalytics:DeletePipeline +``` + diff --git a/docs/aws-docs/providers/aws/iotanalytics/pipelines/index.md b/docs/aws-docs/providers/aws/iotanalytics/pipelines/index.md new file mode 100644 index 0000000000..fd5317024d --- /dev/null +++ b/docs/aws-docs/providers/aws/iotanalytics/pipelines/index.md @@ -0,0 +1,77 @@ +--- +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
DescriptionResource Type definition for AWS::IoTAnalytics::Pipeline
Idaws.iotanalytics.pipelines
+ +## Fields + + + + + +
NameDatatypeDescription
pipeline_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +pipeline_name +FROM aws.iotanalytics.pipelines +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the pipelines resource, the following permissions are required: + +### Create +```json +iotanalytics:CreatePipeline +``` + +### List +```json +iotanalytics:ListPipelines +``` + diff --git a/docs/aws-docs/providers/aws/iotcoredeviceadvisor/index.md b/docs/aws-docs/providers/aws/iotcoredeviceadvisor/index.md new file mode 100644 index 0000000000..b82a18ae59 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/iotcoredeviceadvisor/suite_definition/index.md b/docs/aws-docs/providers/aws/iotcoredeviceadvisor/suite_definition/index.md new file mode 100644 index 0000000000..2f89ef90e0 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotcoredeviceadvisor/suite_definition/index.md @@ -0,0 +1,110 @@ +--- +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
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +suite_definition_configuration, +suite_definition_id, +suite_definition_arn, +suite_definition_version, +tags +FROM aws.iotcoredeviceadvisor.suite_definition +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the suite_definition resource, the following permissions are required: + +### Read +```json +iotdeviceadvisor:GetSuiteDefinition, +iotdeviceadvisor:TagResource +``` + +### Update +```json +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 +```json +iotdeviceadvisor:GetSuiteDefinition, +iotdeviceadvisor:DeleteSuiteDefinition +``` + diff --git a/docs/aws-docs/providers/aws/iotcoredeviceadvisor/suite_definitions/index.md b/docs/aws-docs/providers/aws/iotcoredeviceadvisor/suite_definitions/index.md new file mode 100644 index 0000000000..4fd21c7eba --- /dev/null +++ b/docs/aws-docs/providers/aws/iotcoredeviceadvisor/suite_definitions/index.md @@ -0,0 +1,88 @@ +--- +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
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Idaws.iotcoredeviceadvisor.suite_definitions
+ +## Fields + + + + + +
NameDatatypeDescription
suite_definition_idstringThe unique identifier for the suite definition.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +suite_definition_id +FROM aws.iotcoredeviceadvisor.suite_definitions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the suite_definitions resource, the following permissions are required: + +### Create +```json +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 +```json +iotdeviceadvisor:ListSuiteDefinitions +``` + diff --git a/docs/aws-docs/providers/aws/iotevents/alarm_model/index.md b/docs/aws-docs/providers/aws/iotevents/alarm_model/index.md new file mode 100644 index 0000000000..3646d9df47 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotevents/alarm_model/index.md @@ -0,0 +1,111 @@ +--- +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
DescriptionThe AWS::IoTEvents::AlarmModel resource creates a alarm model. AWS IoT Events alarms help you monitor your data for changes. The data can be metrics that you measure for your equipment and processes. You can create alarms that send notifications when a threshold is breached. Alarms help you detect issues, streamline maintenance, and optimize performance of your equipment and processes.<br/><br/>Alarms are instances of alarm models. The alarm model specifies what to detect, when to send notifications, who gets notified, and more. You can also specify one or more supported actions that occur when the alarm state changes. AWS IoT Events routes input attributes derived from your data to the appropriate alarms. If the data that you're monitoring is outside the specified range, the alarm is invoked. You can also acknowledge the alarms or set them to the snooze mode.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +alarm_model_name, +alarm_model_description, +role_arn, +key, +severity, +alarm_rule, +alarm_event_actions, +alarm_capabilities, +tags +FROM aws.iotevents.alarm_model +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the alarm_model resource, the following permissions are required: + +### Read +```json +iotevents:DescribeAlarmModel, +iotevents:ListTagsForResource +``` + +### Update +```json +iotevents:UpdateAlarmModel, +iotevents:UpdateInputRouting, +iotevents:DescribeAlarmModel, +iotevents:ListTagsForResource, +iotevents:UntagResource, +iotevents:TagResource, +iam:PassRole +``` + +### Delete +```json +iotevents:DeleteAlarmModel, +iotevents:DescribeAlarmModel +``` + diff --git a/docs/aws-docs/providers/aws/iotevents/alarm_models/index.md b/docs/aws-docs/providers/aws/iotevents/alarm_models/index.md new file mode 100644 index 0000000000..0f2a8251e3 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotevents/alarm_models/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionThe AWS::IoTEvents::AlarmModel resource creates a alarm model. AWS IoT Events alarms help you monitor your data for changes. The data can be metrics that you measure for your equipment and processes. You can create alarms that send notifications when a threshold is breached. Alarms help you detect issues, streamline maintenance, and optimize performance of your equipment and processes.<br/><br/>Alarms are instances of alarm models. The alarm model specifies what to detect, when to send notifications, who gets notified, and more. You can also specify one or more supported actions that occur when the alarm state changes. AWS IoT Events routes input attributes derived from your data to the appropriate alarms. If the data that you're monitoring is outside the specified range, the alarm is invoked. You can also acknowledge the alarms or set them to the snooze mode.
Idaws.iotevents.alarm_models
+ +## Fields + + + + + +
NameDatatypeDescription
alarm_model_namestringThe name of the alarm model.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +alarm_model_name +FROM aws.iotevents.alarm_models +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the alarm_models resource, the following permissions are required: + +### Create +```json +iotevents:CreateAlarmModel, +iotevents:UpdateInputRouting, +iotevents:DescribeAlarmModel, +iotevents:ListTagsForResource, +iotevents:TagResource, +iam:PassRole +``` + +### List +```json +iotevents:ListAlarmModels +``` + diff --git a/docs/aws-docs/providers/aws/iotevents/detector_model/index.md b/docs/aws-docs/providers/aws/iotevents/detector_model/index.md new file mode 100644 index 0000000000..15fff3a467 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotevents/detector_model/index.md @@ -0,0 +1,107 @@ +--- +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
DescriptionThe AWS::IoTEvents::DetectorModel resource creates a detector model. You create a *detector model* (a model of your equipment or process) using *states*. For each state, you define conditional (Boolean) logic that evaluates the incoming inputs to detect significant events. When an event is detected, it can change the state or trigger custom-built or predefined actions using other AWS services. You can define additional events that trigger actions when entering or exiting a state and, optionally, when a condition is met. For more information, see [How to Use AWS IoT Events](https://docs.aws.amazon.com/iotevents/latest/developerguide/how-to-use-iotevents.html) in the *AWS IoT Events Developer Guide*.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +detector_model_definition, +detector_model_description, +detector_model_name, +evaluation_method, +key, +role_arn, +tags +FROM aws.iotevents.detector_model +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the detector_model resource, the following permissions are required: + +### Read +```json +iotevents:DescribeDetectorModel, +iotevents:ListTagsForResource +``` + +### Update +```json +iotevents:UpdateDetectorModel, +iotevents:UpdateInputRouting, +iotevents:DescribeDetectorModel, +iotevents:ListTagsForResource, +iotevents:UntagResource, +iotevents:TagResource, +iam:PassRole +``` + +### Delete +```json +iotevents:DeleteDetectorModel, +iotevents:DescribeDetectorModel +``` + diff --git a/docs/aws-docs/providers/aws/iotevents/detector_models/index.md b/docs/aws-docs/providers/aws/iotevents/detector_models/index.md new file mode 100644 index 0000000000..285ec47598 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotevents/detector_models/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionThe AWS::IoTEvents::DetectorModel resource creates a detector model. You create a *detector model* (a model of your equipment or process) using *states*. For each state, you define conditional (Boolean) logic that evaluates the incoming inputs to detect significant events. When an event is detected, it can change the state or trigger custom-built or predefined actions using other AWS services. You can define additional events that trigger actions when entering or exiting a state and, optionally, when a condition is met. For more information, see [How to Use AWS IoT Events](https://docs.aws.amazon.com/iotevents/latest/developerguide/how-to-use-iotevents.html) in the *AWS IoT Events Developer Guide*.
Idaws.iotevents.detector_models
+ +## Fields + + + + + +
NameDatatypeDescription
detector_model_namestringThe name of the detector model.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +detector_model_name +FROM aws.iotevents.detector_models +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the detector_models resource, the following permissions are required: + +### Create +```json +iotevents:CreateDetectorModel, +iotevents:UpdateInputRouting, +iotevents:DescribeDetectorModel, +iotevents:ListTagsForResource, +iotevents:TagResource, +iam:PassRole +``` + +### List +```json +iotevents:ListDetectorModels +``` + diff --git a/docs/aws-docs/providers/aws/iotevents/index.md b/docs/aws-docs/providers/aws/iotevents/index.md new file mode 100644 index 0000000000..f8a59d37cb --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/iotevents/input/index.md b/docs/aws-docs/providers/aws/iotevents/input/index.md new file mode 100644 index 0000000000..b678fdfefc --- /dev/null +++ b/docs/aws-docs/providers/aws/iotevents/input/index.md @@ -0,0 +1,99 @@ +--- +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
DescriptionThe AWS::IoTEvents::Input resource creates an input. To monitor your devices and processes, they must have a way to get telemetry data into AWS IoT Events. This is done by sending messages as *inputs* to AWS IoT Events. For more information, see [How to Use AWS IoT Events](https://docs.aws.amazon.com/iotevents/latest/developerguide/how-to-use-iotevents.html) in the *AWS IoT Events Developer Guide*.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +input_definition, +input_description, +input_name, +tags +FROM aws.iotevents.input +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the input resource, the following permissions are required: + +### Read +```json +iotevents:DescribeInput, +iotevents:ListTagsForResource +``` + +### Update +```json +iotevents:UpdateInput, +iotevents:DescribeInput, +iotevents:ListTagsForResource, +iotevents:UntagResource, +iotevents:TagResource +``` + +### Delete +```json +iotevents:DeleteInput, +iotevents:DescribeInput +``` + diff --git a/docs/aws-docs/providers/aws/iotevents/inputs/index.md b/docs/aws-docs/providers/aws/iotevents/inputs/index.md new file mode 100644 index 0000000000..2087bb6a11 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotevents/inputs/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionThe AWS::IoTEvents::Input resource creates an input. To monitor your devices and processes, they must have a way to get telemetry data into AWS IoT Events. This is done by sending messages as *inputs* to AWS IoT Events. For more information, see [How to Use AWS IoT Events](https://docs.aws.amazon.com/iotevents/latest/developerguide/how-to-use-iotevents.html) in the *AWS IoT Events Developer Guide*.
Idaws.iotevents.inputs
+ +## Fields + + + + + +
NameDatatypeDescription
input_namestringThe name of the input.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +input_name +FROM aws.iotevents.inputs +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the inputs resource, the following permissions are required: + +### Create +```json +iotevents:CreateInput, +iotevents:TagResource, +iotevents:DescribeInput, +iotevents:ListTagsForResource +``` + +### List +```json +iotevents:ListInputs +``` + diff --git a/docs/aws-docs/providers/aws/iotfleethub/application/index.md b/docs/aws-docs/providers/aws/iotfleethub/application/index.md new file mode 100644 index 0000000000..d37cbb3ceb --- /dev/null +++ b/docs/aws-docs/providers/aws/iotfleethub/application/index.md @@ -0,0 +1,114 @@ +--- +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
DescriptionResource schema for AWS::IoTFleetHub::Application
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.iotfleethub.application +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the application resource, the following permissions are required: + +### Read +```json +iotfleethub:DescribeApplication +``` + +### Update +```json +iotfleethub:UpdateApplication, +iotfleethub:DescribeApplication, +iotfleethub:TagResource, +iotfleethub:UntagResource +``` + +### Delete +```json +iotfleethub:DeleteApplication, +iotfleethub:DescribeApplication, +sso:DeleteManagedApplicationInstance +``` + diff --git a/docs/aws-docs/providers/aws/iotfleethub/applications/index.md b/docs/aws-docs/providers/aws/iotfleethub/applications/index.md new file mode 100644 index 0000000000..c6c8aee0ff --- /dev/null +++ b/docs/aws-docs/providers/aws/iotfleethub/applications/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionResource schema for AWS::IoTFleetHub::Application
Idaws.iotfleethub.applications
+ +## Fields + + + + + +
NameDatatypeDescription
application_idstringThe ID of the application.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +application_id +FROM aws.iotfleethub.applications +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the applications resource, the following permissions are required: + +### Create +```json +iotfleethub:CreateApplication, +iotfleethub:TagResource, +iam:PassRole, +sso:CreateManagedApplicationInstance, +sso:DescribeRegisteredRegions +``` + +### List +```json +iotfleethub:ListApplications +``` + diff --git a/docs/aws-docs/providers/aws/iotfleethub/index.md b/docs/aws-docs/providers/aws/iotfleethub/index.md new file mode 100644 index 0000000000..5fb54e29e7 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/iotfleetwise/campaign/index.md b/docs/aws-docs/providers/aws/iotfleetwise/campaign/index.md new file mode 100644 index 0000000000..ed20c52626 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotfleetwise/campaign/index.md @@ -0,0 +1,133 @@ +--- +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
DescriptionDefinition of AWS::IoTFleetWise::Campaign Resource Type
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.iotfleetwise.campaign +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the campaign resource, the following permissions are required: + +### Read +```json +iotfleetwise:GetCampaign, +iotfleetwise:ListTagsForResource +``` + +### Update +```json +iotfleetwise:GetCampaign, +iotfleetwise:ListTagsForResource, +iotfleetwise:UpdateCampaign, +iotfleetwise:TagResource, +iotfleetwise:UntagResource +``` + +### Delete +```json +iotfleetwise:DeleteCampaign, +iotfleetwise:GetCampaign +``` + diff --git a/docs/aws-docs/providers/aws/iotfleetwise/campaigns/index.md b/docs/aws-docs/providers/aws/iotfleetwise/campaigns/index.md new file mode 100644 index 0000000000..41c34d2355 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotfleetwise/campaigns/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionDefinition of AWS::IoTFleetWise::Campaign Resource Type
Idaws.iotfleetwise.campaigns
+ +## Fields + + + + + +
NameDatatypeDescription
namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.iotfleetwise.campaigns +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the campaigns resource, the following permissions are required: + +### Create +```json +iotfleetwise:CreateCampaign, +iotfleetwise:GetCampaign, +iotfleetwise:ListTagsForResource, +iotfleetwise:TagResource, +iam:PassRole, +timestream:DescribeEndpoints, +timestream:DescribeTable +``` + +### List +```json +iotfleetwise:ListCampaigns, +iotfleetwise:GetCampaign +``` + diff --git a/docs/aws-docs/providers/aws/iotfleetwise/decoder_manifest/index.md b/docs/aws-docs/providers/aws/iotfleetwise/decoder_manifest/index.md new file mode 100644 index 0000000000..d807dc9ec9 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotfleetwise/decoder_manifest/index.md @@ -0,0 +1,115 @@ +--- +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
DescriptionDefinition of AWS::IoTFleetWise::DecoderManifest Resource Type
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +creation_time, +description, +last_modification_time, +model_manifest_arn, +name, +network_interfaces, +signal_decoders, +status, +tags +FROM aws.iotfleetwise.decoder_manifest +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the decoder_manifest resource, the following permissions are required: + +### Read +```json +iotfleetwise:GetDecoderManifest, +iotfleetwise:ListDecoderManifestSignals, +iotfleetwise:ListDecoderManifestNetworkInterfaces, +iotfleetwise:ListTagsForResource +``` + +### Update +```json +iotfleetwise:UpdateDecoderManifest, +iotfleetwise:GetDecoderManifest, +iotfleetwise:ListDecoderManifestSignals, +iotfleetwise:ListDecoderManifestNetworkInterfaces, +iotfleetwise:ListTagsForResource, +iotfleetwise:TagResource, +iotfleetwise:UntagResource +``` + +### Delete +```json +iotfleetwise:DeleteDecoderManifest, +iotfleetwise:GetDecoderManifest +``` + diff --git a/docs/aws-docs/providers/aws/iotfleetwise/decoder_manifests/index.md b/docs/aws-docs/providers/aws/iotfleetwise/decoder_manifests/index.md new file mode 100644 index 0000000000..82e9af64f6 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotfleetwise/decoder_manifests/index.md @@ -0,0 +1,83 @@ +--- +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
DescriptionDefinition of AWS::IoTFleetWise::DecoderManifest Resource Type
Idaws.iotfleetwise.decoder_manifests
+ +## Fields + + + + + +
NameDatatypeDescription
namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.iotfleetwise.decoder_manifests +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the decoder_manifests resource, the following permissions are required: + +### Create +```json +iotfleetwise:CreateDecoderManifest, +iotfleetwise:GetDecoderManifest, +iotfleetwise:UpdateDecoderManifest, +iotfleetwise:ListDecoderManifestSignals, +iotfleetwise:ListDecoderManifestNetworkInterfaces, +iotfleetwise:ListTagsForResource, +iotfleetwise:TagResource +``` + +### List +```json +iotfleetwise:ListDecoderManifests +``` + diff --git a/docs/aws-docs/providers/aws/iotfleetwise/fleet/index.md b/docs/aws-docs/providers/aws/iotfleetwise/fleet/index.md new file mode 100644 index 0000000000..633e264a60 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotfleetwise/fleet/index.md @@ -0,0 +1,105 @@ +--- +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
DescriptionDefinition of AWS::IoTFleetWise::Fleet Resource Type
Idaws.iotfleetwise.fleet
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
arnstring
creation_timestring
descriptionstring
idstring
last_modification_timestring
signal_catalog_arnstring
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +creation_time, +description, +id, +last_modification_time, +signal_catalog_arn, +tags +FROM aws.iotfleetwise.fleet +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the fleet resource, the following permissions are required: + +### Read +```json +iotfleetwise:GetFleet, +iotfleetwise:ListTagsForResource +``` + +### Update +```json +iotfleetwise:GetFleet, +iotfleetwise:UpdateFleet, +iotfleetwise:ListTagsForResource, +iotfleetwise:TagResource, +iotfleetwise:UntagResource +``` + +### Delete +```json +iotfleetwise:GetFleet, +iotfleetwise:DeleteFleet +``` + diff --git a/docs/aws-docs/providers/aws/iotfleetwise/fleets/index.md b/docs/aws-docs/providers/aws/iotfleetwise/fleets/index.md new file mode 100644 index 0000000000..d710cc84ce --- /dev/null +++ b/docs/aws-docs/providers/aws/iotfleetwise/fleets/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionDefinition of AWS::IoTFleetWise::Fleet Resource Type
Idaws.iotfleetwise.fleets
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.iotfleetwise.fleets +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the fleets resource, the following permissions are required: + +### Create +```json +iotfleetwise:GetFleet, +iotfleetwise:CreateFleet, +iotfleetwise:ListTagsForResource, +iotfleetwise:ListVehiclesInFleet, +iotfleetwise:TagResource +``` + +### List +```json +iotfleetwise:ListFleets +``` + diff --git a/docs/aws-docs/providers/aws/iotfleetwise/index.md b/docs/aws-docs/providers/aws/iotfleetwise/index.md new file mode 100644 index 0000000000..fd67ff3eb5 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/iotfleetwise/model_manifest/index.md b/docs/aws-docs/providers/aws/iotfleetwise/model_manifest/index.md new file mode 100644 index 0000000000..6e33f2946b --- /dev/null +++ b/docs/aws-docs/providers/aws/iotfleetwise/model_manifest/index.md @@ -0,0 +1,111 @@ +--- +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
DescriptionDefinition of AWS::IoTFleetWise::ModelManifest Resource Type
Idaws.iotfleetwise.model_manifest
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
creation_timestring
descriptionstring
last_modification_timestring
namestring
nodesarray
signal_catalog_arnstring
statusstring
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +creation_time, +description, +last_modification_time, +name, +nodes, +signal_catalog_arn, +status, +tags +FROM aws.iotfleetwise.model_manifest +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the model_manifest resource, the following permissions are required: + +### Read +```json +iotfleetwise:GetModelManifest, +iotfleetwise:ListModelManifestNodes, +iotfleetwise:ListTagsForResource +``` + +### Update +```json +iotfleetwise:UpdateModelManifest, +iotfleetwise:GetModelManifest, +iotfleetwise:ListModelManifestNodes, +iotfleetwise:ListTagsForResource, +iotfleetwise:TagResource, +iotfleetwise:UntagResource +``` + +### Delete +```json +iotfleetwise:DeleteModelManifest, +iotfleetwise:GetModelManifest +``` + diff --git a/docs/aws-docs/providers/aws/iotfleetwise/model_manifests/index.md b/docs/aws-docs/providers/aws/iotfleetwise/model_manifests/index.md new file mode 100644 index 0000000000..a4e120e65f --- /dev/null +++ b/docs/aws-docs/providers/aws/iotfleetwise/model_manifests/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionDefinition of AWS::IoTFleetWise::ModelManifest Resource Type
Idaws.iotfleetwise.model_manifests
+ +## Fields + + + + + +
NameDatatypeDescription
namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.iotfleetwise.model_manifests +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the model_manifests resource, the following permissions are required: + +### Create +```json +iotfleetwise:CreateModelManifest, +iotfleetwise:GetModelManifest, +iotfleetwise:UpdateModelManifest, +iotfleetwise:ListModelManifestNodes, +iotfleetwise:ListTagsForResource, +iotfleetwise:TagResource +``` + +### List +```json +iotfleetwise:ListModelManifests +``` + diff --git a/docs/aws-docs/providers/aws/iotfleetwise/signal_catalog/index.md b/docs/aws-docs/providers/aws/iotfleetwise/signal_catalog/index.md new file mode 100644 index 0000000000..837deaaad0 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotfleetwise/signal_catalog/index.md @@ -0,0 +1,109 @@ +--- +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
DescriptionDefinition of AWS::IoTFleetWise::SignalCatalog Resource Type
Idaws.iotfleetwise.signal_catalog
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
creation_timestring
descriptionstring
last_modification_timestring
namestring
node_countsobject
nodesarray
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +creation_time, +description, +last_modification_time, +name, +node_counts, +nodes, +tags +FROM aws.iotfleetwise.signal_catalog +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the signal_catalog resource, the following permissions are required: + +### Read +```json +iotfleetwise:GetSignalCatalog, +iotfleetwise:ListSignalCatalogNodes, +iotfleetwise:ListTagsForResource +``` + +### Update +```json +iotfleetwise:GetSignalCatalog, +iotfleetwise:UpdateSignalCatalog, +iotfleetwise:ListSignalCatalogNodes, +iotfleetwise:ListTagsForResource, +iotfleetwise:TagResource, +iotfleetwise:UntagResource +``` + +### Delete +```json +iotfleetwise:GetSignalCatalog, +iotfleetwise:DeleteSignalCatalog +``` + diff --git a/docs/aws-docs/providers/aws/iotfleetwise/signal_catalogs/index.md b/docs/aws-docs/providers/aws/iotfleetwise/signal_catalogs/index.md new file mode 100644 index 0000000000..a89bc8a082 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotfleetwise/signal_catalogs/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionDefinition of AWS::IoTFleetWise::SignalCatalog Resource Type
Idaws.iotfleetwise.signal_catalogs
+ +## Fields + + + + + +
NameDatatypeDescription
namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.iotfleetwise.signal_catalogs +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the signal_catalogs resource, the following permissions are required: + +### Create +```json +iotfleetwise:GetSignalCatalog, +iotfleetwise:CreateSignalCatalog, +iotfleetwise:ListSignalCatalogNodes, +iotfleetwise:ListTagsForResource, +iotfleetwise:TagResource +``` + +### List +```json +iotfleetwise:ListSignalCatalogs +``` + diff --git a/docs/aws-docs/providers/aws/iotfleetwise/vehicle/index.md b/docs/aws-docs/providers/aws/iotfleetwise/vehicle/index.md new file mode 100644 index 0000000000..475741ebfc --- /dev/null +++ b/docs/aws-docs/providers/aws/iotfleetwise/vehicle/index.md @@ -0,0 +1,109 @@ +--- +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
DescriptionDefinition of AWS::IoTFleetWise::Vehicle Resource Type
Idaws.iotfleetwise.vehicle
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
association_behaviorstring
attributesobject
creation_timestring
decoder_manifest_arnstring
namestring
last_modification_timestring
model_manifest_arnstring
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +association_behavior, +attributes, +creation_time, +decoder_manifest_arn, +name, +last_modification_time, +model_manifest_arn, +tags +FROM aws.iotfleetwise.vehicle +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the vehicle resource, the following permissions are required: + +### Read +```json +iotfleetwise:GetVehicle, +iotfleetwise:ListTagsForResource +``` + +### Update +```json +iotfleetwise:GetVehicle, +iotfleetwise:UpdateVehicle, +iotfleetwise:ListTagsForResource, +iotfleetwise:TagResource, +iotfleetwise:UntagResource +``` + +### Delete +```json +iotfleetwise:GetVehicle, +iotfleetwise:DeleteVehicle +``` + diff --git a/docs/aws-docs/providers/aws/iotfleetwise/vehicles/index.md b/docs/aws-docs/providers/aws/iotfleetwise/vehicles/index.md new file mode 100644 index 0000000000..f8c30dd7b3 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotfleetwise/vehicles/index.md @@ -0,0 +1,83 @@ +--- +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
DescriptionDefinition of AWS::IoTFleetWise::Vehicle Resource Type
Idaws.iotfleetwise.vehicles
+ +## Fields + + + + + +
NameDatatypeDescription
namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.iotfleetwise.vehicles +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the vehicles resource, the following permissions are required: + +### Create +```json +iotfleetwise:GetVehicle, +iotfleetwise:CreateVehicle, +iot:CreateThing, +iot:DescribeThing, +iotfleetwise:ListTagsForResource, +iotfleetwise:ListVehicles, +iotfleetwise:TagResource +``` + +### List +```json +iotfleetwise:ListVehicles +``` + diff --git a/docs/aws-docs/providers/aws/iotsitewise/access_policies/index.md b/docs/aws-docs/providers/aws/iotsitewise/access_policies/index.md new file mode 100644 index 0000000000..80702a243c --- /dev/null +++ b/docs/aws-docs/providers/aws/iotsitewise/access_policies/index.md @@ -0,0 +1,77 @@ +--- +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
DescriptionResource schema for AWS::IoTSiteWise::AccessPolicy
Idaws.iotsitewise.access_policies
+ +## Fields + + + + + +
NameDatatypeDescription
access_policy_idstringThe ID of the access policy.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +access_policy_id +FROM aws.iotsitewise.access_policies +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the access_policies resource, the following permissions are required: + +### Create +```json +iotsitewise:CreateAccessPolicy +``` + +### List +```json +iotsitewise:ListAccessPolicies +``` + diff --git a/docs/aws-docs/providers/aws/iotsitewise/access_policy/index.md b/docs/aws-docs/providers/aws/iotsitewise/access_policy/index.md new file mode 100644 index 0000000000..38575e68eb --- /dev/null +++ b/docs/aws-docs/providers/aws/iotsitewise/access_policy/index.md @@ -0,0 +1,97 @@ +--- +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
DescriptionResource schema for AWS::IoTSiteWise::AccessPolicy
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +access_policy_id, +access_policy_arn, +access_policy_identity, +access_policy_permission, +access_policy_resource +FROM aws.iotsitewise.access_policy +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the access_policy resource, the following permissions are required: + +### Read +```json +iotsitewise:DescribeAccessPolicy +``` + +### Update +```json +iotsitewise:DescribeAccessPolicy, +iotsitewise:UpdateAccessPolicy +``` + +### Delete +```json +iotsitewise:DescribeAccessPolicy, +iotsitewise:DeleteAccessPolicy +``` + diff --git a/docs/aws-docs/providers/aws/iotsitewise/asset/index.md b/docs/aws-docs/providers/aws/iotsitewise/asset/index.md new file mode 100644 index 0000000000..17a61018c2 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotsitewise/asset/index.md @@ -0,0 +1,130 @@ +--- +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
DescriptionResource schema for AWS::IoTSiteWise::Asset
Idaws.iotsitewise.asset
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
asset_idstringThe ID of the asset
asset_external_idstringThe External 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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +asset_id, +asset_external_id, +asset_model_id, +asset_arn, +asset_name, +asset_description, +asset_properties, +asset_hierarchies, +tags +FROM aws.iotsitewise.asset +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the asset resource, the following permissions are required: + +### Read +```json +iotsitewise:DescribeAsset, +iotsitewise:DescribeAssetModel, +iotsitewise:ListAssociatedAssets, +iotsitewise:ListAssetModelProperties, +iotsitewise:ListAssetModelCompositeModels, +iotsitewise:ListAssetProperties, +iotsitewise:ListTagsForResource +``` + +### Update +```json +iotsitewise:AssociateAssets, +iotsitewise:DescribeAsset, +iotsitewise:DescribeAssetModel, +iotsitewise:DisassociateAssets, +iotsitewise:ListAssociatedAssets, +iotsitewise:ListTagsForResource, +iotsitewise:TagResource, +iotsitewise:UpdateAsset, +iotsitewise:UpdateAssetProperty, +iotsitewise:ListAssetModelProperties, +iotsitewise:ListAssetProperties, +iotsitewise:ListAssetModelCompositeModels, +iotsitewise:UntagResource +``` + +### Delete +```json +iotsitewise:DeleteAsset, +iotsitewise:DescribeAsset, +iotsitewise:DescribeAssetModel, +iotsitewise:DisassociateAssets, +iotsitewise:ListAssociatedAssets, +iotsitewise:ListAssetProperties, +iotsitewise:ListTagsForResource, +iotsitewise:ListAssetModelCompositeModels, +iotsitewise:ListAssetModelProperties, +iotsitewise:ListAssetProperties +``` + diff --git a/docs/aws-docs/providers/aws/iotsitewise/asset_model/index.md b/docs/aws-docs/providers/aws/iotsitewise/asset_model/index.md new file mode 100644 index 0000000000..8c851346b7 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotsitewise/asset_model/index.md @@ -0,0 +1,122 @@ +--- +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
DescriptionResource schema for AWS::IoTSiteWise::AssetModel
Idaws.iotsitewise.asset_model
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
asset_model_idstringThe ID of the asset model.
asset_model_typestringThe type of the asset model (ASSET_MODEL OR COMPONENT_MODEL)
asset_model_external_idstringThe external 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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +asset_model_id, +asset_model_type, +asset_model_external_id, +asset_model_arn, +asset_model_name, +asset_model_description, +asset_model_properties, +asset_model_composite_models, +asset_model_hierarchies, +tags +FROM aws.iotsitewise.asset_model +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the asset_model resource, the following permissions are required: + +### Read +```json +iotsitewise:DescribeAssetModel, +iotsitewise:ListAssetModelProperties, +iotsitewise:DescribeAssetModelCompositeModel, +iotsitewise:ListAssetModelCompositeModels, +iotsitewise:ListTagsForResource +``` + +### Update +```json +iotsitewise:DescribeAssetModel, +iotsitewise:ListTagsForResource, +iotsitewise:TagResource, +iotsitewise:UntagResource, +iotsitewise:ListAssetModelProperties, +iotsitewise:ListAssetModelCompositeModels, +iotsitewise:CreateAssetModelCompositeModel, +iotsitewise:UpdateAssetModelCompositeModel, +iotsitewise:DeleteAssetModelCompositeModel, +iotsitewise:DescribeAssetModelCompositeModel, +iotsitewise:UpdateAssetModel +``` + +### Delete +```json +iotsitewise:DescribeAssetModel, +iotsitewise:DeleteAssetModel, +iotsitewise:ListAssetModelProperties, +iotsitewise:ListAssetModelCompositeModels +``` + diff --git a/docs/aws-docs/providers/aws/iotsitewise/asset_models/index.md b/docs/aws-docs/providers/aws/iotsitewise/asset_models/index.md new file mode 100644 index 0000000000..ae4ef14eab --- /dev/null +++ b/docs/aws-docs/providers/aws/iotsitewise/asset_models/index.md @@ -0,0 +1,90 @@ +--- +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
DescriptionResource schema for AWS::IoTSiteWise::AssetModel
Idaws.iotsitewise.asset_models
+ +## Fields + + + + + +
NameDatatypeDescription
asset_model_idstringThe ID of the asset model.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +asset_model_id +FROM aws.iotsitewise.asset_models +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the asset_models resource, the following permissions are required: + +### Create +```json +iotsitewise:CreateAssetModel, +iotsitewise:ListTagsForResource, +iotsitewise:TagResource, +iotsitewise:DescribeAssetModel, +iotsitewise:UpdateAssetModel, +iotsitewise:ListAssetModelProperties, +iotsitewise:ListAssetModelCompositeModels, +iotsitewise:UpdateAssetModelCompositeModel, +iotsitewise:DescribeAssetModelCompositeModel, +iotsitewise:CreateAssetModelCompositeModel +``` + +### List +```json +iotsitewise:DescribeAssetModel, +iotsitewise:ListAssetModels, +iotsitewise:ListTagsForResource, +iotsitewise:ListAssetModelProperties, +iotsitewise:ListAssetModelCompositeModels +``` + diff --git a/docs/aws-docs/providers/aws/iotsitewise/assets/index.md b/docs/aws-docs/providers/aws/iotsitewise/assets/index.md new file mode 100644 index 0000000000..1a58d0a414 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotsitewise/assets/index.md @@ -0,0 +1,88 @@ +--- +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
DescriptionResource schema for AWS::IoTSiteWise::Asset
Idaws.iotsitewise.assets
+ +## Fields + + + + + +
NameDatatypeDescription
asset_idstringThe ID of the asset
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +asset_id +FROM aws.iotsitewise.assets +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the assets resource, the following permissions are required: + +### Create +```json +iotsitewise:AssociateAssets, +iotsitewise:CreateAsset, +iotsitewise:DescribeAsset, +iotsitewise:DescribeAssetModel, +iotsitewise:ListAssociatedAssets, +iotsitewise:ListTagsForResource, +iotsitewise:TagResource, +iotsitewise:ListAssetModelProperties, +iotsitewise:ListAssetProperties, +iotsitewise:ListAssetModelCompositeModels, +iotsitewise:UpdateAssetProperty +``` + +### List +```json +iotsitewise:ListAssetModels, +iotsitewise:ListAssets +``` + diff --git a/docs/aws-docs/providers/aws/iotsitewise/dashboard/index.md b/docs/aws-docs/providers/aws/iotsitewise/dashboard/index.md new file mode 100644 index 0000000000..b561b3bc17 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotsitewise/dashboard/index.md @@ -0,0 +1,109 @@ +--- +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
DescriptionResource schema for AWS::IoTSiteWise::Dashboard
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +project_id, +dashboard_id, +dashboard_name, +dashboard_description, +dashboard_definition, +dashboard_arn, +tags +FROM aws.iotsitewise.dashboard +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the dashboard resource, the following permissions are required: + +### Read +```json +iotsitewise:DescribeDashboard, +iotsitewise:ListTagsForResource +``` + +### Update +```json +iotsitewise:DescribeDashboard, +iotsitewise:UpdateDashboard, +iotsitewise:TagResource, +iotsitewise:UntagResource, +iotsitewise:ListTagsForResource, +iotsitewise:DescribeAsset, +iotsitewise:DescribeAssetModel, +iotsitewise:ListAssetModelProperties, +iotsitewise:ListAssetModelCompositeModels +``` + +### Delete +```json +iotsitewise:DescribeDashboard, +iotsitewise:DeleteDashboard +``` + diff --git a/docs/aws-docs/providers/aws/iotsitewise/dashboards/index.md b/docs/aws-docs/providers/aws/iotsitewise/dashboards/index.md new file mode 100644 index 0000000000..6a2373581d --- /dev/null +++ b/docs/aws-docs/providers/aws/iotsitewise/dashboards/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionResource schema for AWS::IoTSiteWise::Dashboard
Idaws.iotsitewise.dashboards
+ +## Fields + + + + + +
NameDatatypeDescription
dashboard_idstringThe ID of the dashboard.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +dashboard_id +FROM aws.iotsitewise.dashboards +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the dashboards resource, the following permissions are required: + +### Create +```json +iotsitewise:CreateDashboard, +iotsitewise:DescribeDashboard, +iotsitewise:ListTagsForResource, +iotsitewise:TagResource, +iotsitewise:DescribeAsset, +iotsitewise:DescribeAssetModel, +iotsitewise:ListAssetModelProperties, +iotsitewise:ListAssetModelCompositeModels +``` + +### List +```json +iotsitewise:ListDashboards +``` + diff --git a/docs/aws-docs/providers/aws/iotsitewise/gateway/index.md b/docs/aws-docs/providers/aws/iotsitewise/gateway/index.md new file mode 100644 index 0000000000..37f3ec9b11 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotsitewise/gateway/index.md @@ -0,0 +1,105 @@ +--- +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
DescriptionResource schema for AWS::IoTSiteWise::Gateway
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +gateway_name, +gateway_platform, +tags, +gateway_id, +gateway_capability_summaries +FROM aws.iotsitewise.gateway +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the gateway resource, the following permissions are required: + +### Read +```json +iotsitewise:DescribeGateway, +iotsitewise:DescribeGatewayCapabilityConfiguration, +iotsitewise:ListTagsForResource +``` + +### Update +```json +iotsitewise:UpdateGateway, +iotsitewise:UpdateGatewayCapabilityConfiguration, +iotsitewise:TagResource, +iotsitewise:UntagResource, +iotsitewise:DescribeGateway, +iotsitewise:DescribeGatewayCapabilityConfiguration, +iotsitewise:ListTagsForResource +``` + +### Delete +```json +iotsitewise:DescribeGateway, +iotsitewise:DescribeGatewayCapabilityConfiguration, +iotsitewise:DeleteGateway +``` + diff --git a/docs/aws-docs/providers/aws/iotsitewise/gateways/index.md b/docs/aws-docs/providers/aws/iotsitewise/gateways/index.md new file mode 100644 index 0000000000..5f585e76cd --- /dev/null +++ b/docs/aws-docs/providers/aws/iotsitewise/gateways/index.md @@ -0,0 +1,86 @@ +--- +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
DescriptionResource schema for AWS::IoTSiteWise::Gateway
Idaws.iotsitewise.gateways
+ +## Fields + + + + + +
NameDatatypeDescription
gateway_idstringThe ID of the gateway device.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +gateway_id +FROM aws.iotsitewise.gateways +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the gateways resource, the following permissions are required: + +### Create +```json +iotsitewise:CreateGateway, +iotsitewise:DescribeGateway, +iotsitewise:DescribeGatewayCapabilityConfiguration, +iotsitewise:UpdateGatewayCapabilityConfiguration, +iam:PassRole, +iam:GetRole, +greengrass:GetCoreDevice, +iotsitewise:ListTagsForResource, +iotsitewise:TagResource, +iot:DescribeThing +``` + +### List +```json +iotsitewise:ListGateways +``` + diff --git a/docs/aws-docs/providers/aws/iotsitewise/index.md b/docs/aws-docs/providers/aws/iotsitewise/index.md new file mode 100644 index 0000000000..213dd6d47f --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/iotsitewise/portal/index.md b/docs/aws-docs/providers/aws/iotsitewise/portal/index.md new file mode 100644 index 0000000000..82609b4e17 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotsitewise/portal/index.md @@ -0,0 +1,119 @@ +--- +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
DescriptionResource schema for AWS::IoTSiteWise::Portal
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.iotsitewise.portal +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the portal resource, the following permissions are required: + +### Read +```json +iotsitewise:DescribePortal, +iotsitewise:ListTagsForResource +``` + +### Update +```json +iotsitewise:DescribePortal, +iotsitewise:ListTagsForResource, +iotsitewise:TagResource, +iotsitewise:UpdatePortal, +iotsitewise:UntagResource, +iam:PassRole, +sso:GetManagedApplicationInstance, +sso:UpdateApplicationInstanceDisplayData +``` + +### Delete +```json +iotsitewise:DescribePortal, +iotsitewise:DeletePortal, +sso:DeleteManagedApplicationInstance +``` + diff --git a/docs/aws-docs/providers/aws/iotsitewise/portals/index.md b/docs/aws-docs/providers/aws/iotsitewise/portals/index.md new file mode 100644 index 0000000000..0a86267511 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotsitewise/portals/index.md @@ -0,0 +1,83 @@ +--- +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
DescriptionResource schema for AWS::IoTSiteWise::Portal
Idaws.iotsitewise.portals
+ +## Fields + + + + + +
NameDatatypeDescription
portal_idstringThe ID of the portal.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +portal_id +FROM aws.iotsitewise.portals +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the portals resource, the following permissions are required: + +### Create +```json +iotsitewise:CreatePortal, +iotsitewise:DescribePortal, +iotsitewise:ListTagsForResource, +iotsitewise:TagResource, +iam:PassRole, +sso:CreateManagedApplicationInstance, +sso:DescribeRegisteredRegions +``` + +### List +```json +iotsitewise:ListPortals +``` + diff --git a/docs/aws-docs/providers/aws/iotsitewise/project/index.md b/docs/aws-docs/providers/aws/iotsitewise/project/index.md new file mode 100644 index 0000000000..a6039725fc --- /dev/null +++ b/docs/aws-docs/providers/aws/iotsitewise/project/index.md @@ -0,0 +1,109 @@ +--- +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
DescriptionResource schema for AWS::IoTSiteWise::Project
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +portal_id, +project_id, +project_name, +project_description, +project_arn, +asset_ids, +tags +FROM aws.iotsitewise.project +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the project resource, the following permissions are required: + +### Read +```json +iotsitewise:DescribeProject, +iotsitewise:ListTagsForResource, +iotsitewise:ListProjectAssets +``` + +### Update +```json +iotsitewise:DescribeProject, +iotsitewise:UpdateProject, +iotsitewise:BatchAssociateProjectAssets, +iotsitewise:BatchDisAssociateProjectAssets, +iotsitewise:ListProjectAssets, +iotsitewise:TagResource, +iotsitewise:UntagResource, +iotsitewise:ListTagsForResource +``` + +### Delete +```json +iotsitewise:DescribeProject, +iotsitewise:DeleteProject +``` + diff --git a/docs/aws-docs/providers/aws/iotsitewise/projects/index.md b/docs/aws-docs/providers/aws/iotsitewise/projects/index.md new file mode 100644 index 0000000000..c6631c5d86 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotsitewise/projects/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionResource schema for AWS::IoTSiteWise::Project
Idaws.iotsitewise.projects
+ +## Fields + + + + + +
NameDatatypeDescription
project_idstringThe ID of the project.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +project_id +FROM aws.iotsitewise.projects +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the projects resource, the following permissions are required: + +### Create +```json +iotsitewise:CreateProject, +iotsitewise:DescribeProject, +iotsitewise:ListProjectAssets, +iotsitewise:ListTagsForResource, +iotsitewise:TagResource, +iotsitewise:BatchAssociateProjectAssets +``` + +### List +```json +iotsitewise:ListProjects +``` + diff --git a/docs/aws-docs/providers/aws/iottwinmaker/component_type/index.md b/docs/aws-docs/providers/aws/iottwinmaker/component_type/index.md new file mode 100644 index 0000000000..7066cdc108 --- /dev/null +++ b/docs/aws-docs/providers/aws/iottwinmaker/component_type/index.md @@ -0,0 +1,126 @@ +--- +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
DescriptionResource schema for AWS::IoTTwinMaker::ComponentType
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.iottwinmaker.component_type +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the component_type resource, the following permissions are required: + +### Read +```json +iottwinmaker:GetComponentType, +iottwinmaker:GetWorkspace, +iottwinmaker:ListTagsForResource +``` + +### Update +```json +iottwinmaker:GetComponentType, +iottwinmaker:GetWorkspace, +iottwinmaker:ListTagsForResource, +iottwinmaker:TagResource, +iottwinmaker:UntagResource, +iottwinmaker:UpdateComponentType +``` + +### Delete +```json +iottwinmaker:DeleteComponentType, +iottwinmaker:GetComponentType, +iottwinmaker:GetWorkspace +``` + diff --git a/docs/aws-docs/providers/aws/iottwinmaker/component_types/index.md b/docs/aws-docs/providers/aws/iottwinmaker/component_types/index.md new file mode 100644 index 0000000000..a35bded199 --- /dev/null +++ b/docs/aws-docs/providers/aws/iottwinmaker/component_types/index.md @@ -0,0 +1,86 @@ +--- +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
DescriptionResource schema for AWS::IoTTwinMaker::ComponentType
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +workspace_id, +component_type_id +FROM aws.iottwinmaker.component_types +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the component_types resource, the following permissions are required: + +### Create +```json +iottwinmaker:CreateComponentType, +iottwinmaker:GetComponentType, +iottwinmaker:GetWorkspace, +iottwinmaker:ListTagsForResource, +iottwinmaker:TagResource +``` + +### List +```json +iottwinmaker:GetComponentType, +iottwinmaker:GetWorkspace, +iottwinmaker:ListComponentTypes, +iottwinmaker:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/iottwinmaker/entities/index.md b/docs/aws-docs/providers/aws/iottwinmaker/entities/index.md new file mode 100644 index 0000000000..61bb40423c --- /dev/null +++ b/docs/aws-docs/providers/aws/iottwinmaker/entities/index.md @@ -0,0 +1,88 @@ +--- +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
DescriptionResource schema for AWS::IoTTwinMaker::Entity
Idaws.iottwinmaker.entities
+ +## Fields + + + + + + +
NameDatatypeDescription
workspace_idstringThe ID of the workspace.
entity_idstringThe ID of the entity.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +workspace_id, +entity_id +FROM aws.iottwinmaker.entities +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the entities resource, the following permissions are required: + +### Create +```json +iottwinmaker:GetWorkspace, +iottwinmaker:CreateEntity, +iottwinmaker:GetEntity, +iottwinmaker:ListComponents, +iottwinmaker:ListProperties, +iottwinmaker:ListTagsForResource, +iottwinmaker:TagResource +``` + +### List +```json +iottwinmaker:GetWorkspace, +iottwinmaker:ListTagsForResource, +iottwinmaker:GetEntity, +iottwinmaker:ListEntities +``` + diff --git a/docs/aws-docs/providers/aws/iottwinmaker/entity/index.md b/docs/aws-docs/providers/aws/iottwinmaker/entity/index.md new file mode 100644 index 0000000000..c6ab2063b5 --- /dev/null +++ b/docs/aws-docs/providers/aws/iottwinmaker/entity/index.md @@ -0,0 +1,128 @@ +--- +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
DescriptionResource schema for AWS::IoTTwinMaker::Entity
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.iottwinmaker.entity +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the entity resource, the following permissions are required: + +### Read +```json +iottwinmaker:GetComponentType, +iottwinmaker:GetEntity, +iottwinmaker:ListComponents, +iottwinmaker:ListProperties, +iottwinmaker:GetWorkspace, +iottwinmaker:ListEntities, +iottwinmaker:ListTagsForResource +``` + +### Update +```json +iottwinmaker:GetComponentType, +iottwinmaker:GetEntity, +iottwinmaker:ListComponents, +iottwinmaker:ListProperties, +iottwinmaker:GetWorkspace, +iottwinmaker:ListTagsForResource, +iottwinmaker:TagResource, +iottwinmaker:UntagResource, +iottwinmaker:UpdateEntity, +iottwinmaker:UpdateComponentType +``` + +### Delete +```json +iottwinmaker:GetEntity, +iottwinmaker:GetWorkspace, +iottwinmaker:DeleteEntity +``` + diff --git a/docs/aws-docs/providers/aws/iottwinmaker/index.md b/docs/aws-docs/providers/aws/iottwinmaker/index.md new file mode 100644 index 0000000000..afeb15e5ac --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/iottwinmaker/scene/index.md b/docs/aws-docs/providers/aws/iottwinmaker/scene/index.md new file mode 100644 index 0000000000..b4c3c886cf --- /dev/null +++ b/docs/aws-docs/providers/aws/iottwinmaker/scene/index.md @@ -0,0 +1,116 @@ +--- +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
DescriptionResource schema for AWS::IoTTwinMaker::Scene
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.iottwinmaker.scene +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the scene resource, the following permissions are required: + +### Read +```json +iottwinmaker:GetWorkspace, +iottwinmaker:GetScene, +iottwinmaker:ListTagsForResource +``` + +### Update +```json +iottwinmaker:GetScene, +iottwinmaker:GetWorkspace, +iottwinmaker:ListTagsForResource, +iottwinmaker:TagResource, +iottwinmaker:UntagResource, +iottwinmaker:UpdateScene +``` + +### Delete +```json +iottwinmaker:DeleteScene, +iottwinmaker:GetScene, +iottwinmaker:GetWorkspace +``` + diff --git a/docs/aws-docs/providers/aws/iottwinmaker/scenes/index.md b/docs/aws-docs/providers/aws/iottwinmaker/scenes/index.md new file mode 100644 index 0000000000..03ac379371 --- /dev/null +++ b/docs/aws-docs/providers/aws/iottwinmaker/scenes/index.md @@ -0,0 +1,85 @@ +--- +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
DescriptionResource schema for AWS::IoTTwinMaker::Scene
Idaws.iottwinmaker.scenes
+ +## Fields + + + + + + +
NameDatatypeDescription
workspace_idstringThe ID of the scene.
scene_idstringThe ID of the scene.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +workspace_id, +scene_id +FROM aws.iottwinmaker.scenes +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the scenes resource, the following permissions are required: + +### Create +```json +iottwinmaker:CreateScene, +iottwinmaker:GetScene, +iottwinmaker:GetWorkspace, +iottwinmaker:ListTagsForResource, +iottwinmaker:TagResource +``` + +### List +```json +iottwinmaker:GetWorkspace, +iottwinmaker:ListTagsForResource, +iottwinmaker:ListScenes +``` + diff --git a/docs/aws-docs/providers/aws/iottwinmaker/sync_job/index.md b/docs/aws-docs/providers/aws/iottwinmaker/sync_job/index.md new file mode 100644 index 0000000000..5101142613 --- /dev/null +++ b/docs/aws-docs/providers/aws/iottwinmaker/sync_job/index.md @@ -0,0 +1,95 @@ +--- +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
DescriptionResource schema for AWS::IoTTwinMaker::SyncJob
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +workspace_id, +sync_source, +sync_role, +creation_date_time, +update_date_time, +arn, +state, +tags +FROM aws.iottwinmaker.sync_job +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the sync_job resource, the following permissions are required: + +### Read +```json +iottwinmaker:GetSyncJob, +iottwinmaker:GetWorkspace, +iottwinmaker:ListTagsForResource +``` + +### Delete +```json +iottwinmaker:DeleteSyncJob, +iottwinmaker:GetSyncJob, +iottwinmaker:GetWorkspace +``` + diff --git a/docs/aws-docs/providers/aws/iottwinmaker/sync_jobs/index.md b/docs/aws-docs/providers/aws/iottwinmaker/sync_jobs/index.md new file mode 100644 index 0000000000..904a835fbc --- /dev/null +++ b/docs/aws-docs/providers/aws/iottwinmaker/sync_jobs/index.md @@ -0,0 +1,86 @@ +--- +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
DescriptionResource schema for AWS::IoTTwinMaker::SyncJob
Idaws.iottwinmaker.sync_jobs
+ +## Fields + + + + + + +
NameDatatypeDescription
workspace_idstringThe ID of the workspace.
sync_sourcestringThe source of the SyncJob.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +workspace_id, +sync_source +FROM aws.iottwinmaker.sync_jobs +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the sync_jobs resource, the following permissions are required: + +### Create +```json +iam:PassRole, +iottwinmaker:CreateSyncJob, +iottwinmaker:GetSyncJob, +iottwinmaker:GetWorkspace, +iottwinmaker:ListTagsForResource, +iottwinmaker:TagResource +``` + +### List +```json +iottwinmaker:GetWorkspace, +iottwinmaker:ListSyncJobs, +iottwinmaker:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/iottwinmaker/workspace/index.md b/docs/aws-docs/providers/aws/iottwinmaker/workspace/index.md new file mode 100644 index 0000000000..16c779601b --- /dev/null +++ b/docs/aws-docs/providers/aws/iottwinmaker/workspace/index.md @@ -0,0 +1,107 @@ +--- +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
DescriptionResource schema for AWS::IoTTwinMaker::Workspace
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +workspace_id, +arn, +description, +role, +s3_location, +creation_date_time, +update_date_time, +tags +FROM aws.iottwinmaker.workspace +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the workspace resource, the following permissions are required: + +### Read +```json +iottwinmaker:GetWorkspace, +iottwinmaker:ListTagsForResource +``` + +### Update +```json +iottwinmaker:GetWorkspace, +iottwinmaker:ListTagsForResource, +iottwinmaker:TagResource, +iottwinmaker:UntagResource, +iottwinmaker:UpdateWorkspace +``` + +### Delete +```json +iottwinmaker:DeleteWorkspace, +iottwinmaker:GetWorkspace +``` + diff --git a/docs/aws-docs/providers/aws/iottwinmaker/workspaces/index.md b/docs/aws-docs/providers/aws/iottwinmaker/workspaces/index.md new file mode 100644 index 0000000000..023a2421b0 --- /dev/null +++ b/docs/aws-docs/providers/aws/iottwinmaker/workspaces/index.md @@ -0,0 +1,83 @@ +--- +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
DescriptionResource schema for AWS::IoTTwinMaker::Workspace
Idaws.iottwinmaker.workspaces
+ +## Fields + + + + + +
NameDatatypeDescription
workspace_idstringThe ID of the workspace.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +workspace_id +FROM aws.iottwinmaker.workspaces +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the workspaces resource, the following permissions are required: + +### Create +```json +iam:PassRole, +iottwinmaker:CreateWorkspace, +iottwinmaker:GetWorkspace, +iottwinmaker:ListTagsForResource, +iottwinmaker:TagResource +``` + +### List +```json +iottwinmaker:GetWorkspace, +iottwinmaker:ListTagsForResource, +iottwinmaker:ListWorkspaces +``` + diff --git a/docs/aws-docs/providers/aws/iotwireless/destination/index.md b/docs/aws-docs/providers/aws/iotwireless/destination/index.md new file mode 100644 index 0000000000..db761b8b33 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotwireless/destination/index.md @@ -0,0 +1,103 @@ +--- +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's resource schema demonstrating some basic constructs and validation rules.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +expression, +expression_type, +description, +tags, +role_arn, +arn +FROM aws.iotwireless.destination +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the destination resource, the following permissions are required: + +### Read +```json +iotwireless:GetDestination, +iotwireless:ListTagsForResource +``` + +### Update +```json +iam:PassRole, +iotwireless:UpdateDestination, +iotwireless:UntagResource, +iotwireless:ListTagsForResource +``` + +### Delete +```json +iotwireless:DeleteDestination +``` + diff --git a/docs/aws-docs/providers/aws/iotwireless/destinations/index.md b/docs/aws-docs/providers/aws/iotwireless/destinations/index.md new file mode 100644 index 0000000000..0ebb18be77 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotwireless/destinations/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionDestination's resource schema demonstrating some basic constructs and validation rules.
Idaws.iotwireless.destinations
+ +## Fields + + + + + +
NameDatatypeDescription
namestringUnique name of destination
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.iotwireless.destinations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the destinations resource, the following permissions are required: + +### Create +```json +iam:PassRole, +iotwireless:CreateDestination, +iotwireless:TagResource, +iotwireless:ListTagsForResource +``` + +### List +```json +iotwireless:ListDestinations, +iotwireless:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/iotwireless/device_profile/index.md b/docs/aws-docs/providers/aws/iotwireless/device_profile/index.md new file mode 100644 index 0000000000..2b622fea6a --- /dev/null +++ b/docs/aws-docs/providers/aws/iotwireless/device_profile/index.md @@ -0,0 +1,86 @@ +--- +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's resource schema demonstrating some basic constructs and validation rules.
Idaws.iotwireless.device_profile
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
namestringName of service profile
lo_ra_wanobjectLoRaWANDeviceProfile 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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +lo_ra_wan, +tags, +arn, +id +FROM aws.iotwireless.device_profile +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the device_profile resource, the following permissions are required: + +### Read +```json +iotwireless:GetDeviceProfile, +iotwireless:ListTagsForResource +``` + +### Delete +```json +iotwireless:DeleteDeviceProfile +``` + diff --git a/docs/aws-docs/providers/aws/iotwireless/device_profiles/index.md b/docs/aws-docs/providers/aws/iotwireless/device_profiles/index.md new file mode 100644 index 0000000000..a5af024c8e --- /dev/null +++ b/docs/aws-docs/providers/aws/iotwireless/device_profiles/index.md @@ -0,0 +1,80 @@ +--- +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 Profile's resource schema demonstrating some basic constructs and validation rules.
Idaws.iotwireless.device_profiles
+ +## Fields + + + + + +
NameDatatypeDescription
idstringService profile Id. Returned after successful create.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.iotwireless.device_profiles +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the device_profiles resource, the following permissions are required: + +### Create +```json +iotwireless:CreateDeviceProfile, +iotwireless:TagResource, +iotwireless:ListTagsForResource +``` + +### List +```json +iotwireless:ListDeviceProfiles, +iotwireless:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/iotwireless/fuota_task/index.md b/docs/aws-docs/providers/aws/iotwireless/fuota_task/index.md new file mode 100644 index 0000000000..b1fc6c30d7 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotwireless/fuota_task/index.md @@ -0,0 +1,119 @@ +--- +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
DescriptionCreate and manage FUOTA tasks.
Idaws.iotwireless.fuota_task
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
namestringName of FUOTA task
descriptionstringFUOTA task description
lo_ra_wanobjectFUOTA 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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +description, +lo_ra_wan, +firmware_update_image, +firmware_update_role, +arn, +id, +tags, +fuota_task_status, +associate_wireless_device, +disassociate_wireless_device, +associate_multicast_group, +disassociate_multicast_group +FROM aws.iotwireless.fuota_task +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the fuota_task resource, the following permissions are required: + +### Read +```json +iotwireless:GetFuotaTask, +iotwireless:ListTagsForResource +``` + +### Update +```json +iam:PassRole, +iotwireless:UpdateFuotaTask, +iotwireless:UntagResource, +iotwireless:ListTagsForResource, +iotwireless:AssociateMulticastGroupWithFuotaTask, +iotwireless:DisassociateMulticastGroupFromFuotaTask, +iotwireless:AssociateWirelessDeviceWithFuotaTask, +iotwireless:DisassociateWirelessDeviceFromFuotaTask +``` + +### Delete +```json +iotwireless:DeleteFuotaTask +``` + diff --git a/docs/aws-docs/providers/aws/iotwireless/fuota_tasks/index.md b/docs/aws-docs/providers/aws/iotwireless/fuota_tasks/index.md new file mode 100644 index 0000000000..ba06e88e88 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotwireless/fuota_tasks/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionCreate and manage FUOTA tasks.
Idaws.iotwireless.fuota_tasks
+ +## Fields + + + + + +
NameDatatypeDescription
idstringFUOTA task id. Returned after successful create.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.iotwireless.fuota_tasks +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the fuota_tasks resource, the following permissions are required: + +### Create +```json +iotwireless:CreateFuotaTask, +iotwireless:TagResource, +iotwireless:ListTagsForResource, +iam:GetRole, +iam:PassRole +``` + +### List +```json +iotwireless:ListFuotaTasks, +iotwireless:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/iotwireless/index.md b/docs/aws-docs/providers/aws/iotwireless/index.md new file mode 100644 index 0000000000..06f7409c69 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/iotwireless/multicast_group/index.md b/docs/aws-docs/providers/aws/iotwireless/multicast_group/index.md new file mode 100644 index 0000000000..1dd5459693 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotwireless/multicast_group/index.md @@ -0,0 +1,108 @@ +--- +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
DescriptionCreate and manage Multicast groups.
Idaws.iotwireless.multicast_group
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
namestringName of Multicast group
descriptionstringMulticast group description
lo_ra_wanobjectMulticast 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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +description, +lo_ra_wan, +arn, +id, +tags, +status, +associate_wireless_device, +disassociate_wireless_device +FROM aws.iotwireless.multicast_group +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the multicast_group resource, the following permissions are required: + +### Read +```json +iotwireless:GetMulticastGroup, +iotwireless:ListTagsForResource +``` + +### Update +```json +iotwireless:UpdateMulticastGroup, +iotwireless:UntagResource, +iotwireless:ListTagsForResource, +iotwireless:AssociateWirelessDeviceWithMulticastGroup, +iotwireless:DisassociateWirelessDeviceFromMulticastGroup +``` + +### Delete +```json +iotwireless:DeleteMulticastGroup +``` + diff --git a/docs/aws-docs/providers/aws/iotwireless/multicast_groups/index.md b/docs/aws-docs/providers/aws/iotwireless/multicast_groups/index.md new file mode 100644 index 0000000000..0187890243 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotwireless/multicast_groups/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionCreate and manage Multicast groups.
Idaws.iotwireless.multicast_groups
+ +## Fields + + + + + +
NameDatatypeDescription
idstringMulticast group id. Returned after successful create.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.iotwireless.multicast_groups +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the multicast_groups resource, the following permissions are required: + +### Create +```json +iotwireless:CreateMulticastGroup, +iotwireless:TagResource, +iotwireless:ListTagsForResource +``` + +### List +```json +iotwireless:ListMulticastGroups, +iotwireless:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/iotwireless/network_analyzer_configuration/index.md b/docs/aws-docs/providers/aws/iotwireless/network_analyzer_configuration/index.md new file mode 100644 index 0000000000..aa351e02a4 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotwireless/network_analyzer_configuration/index.md @@ -0,0 +1,102 @@ +--- +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
DescriptionCreate and manage NetworkAnalyzerConfiguration resource.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +description, +trace_content, +wireless_devices, +wireless_gateways, +arn, +tags +FROM aws.iotwireless.network_analyzer_configuration +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the network_analyzer_configuration resource, the following permissions are required: + +### Read +```json +iotwireless:GetNetworkAnalyzerConfiguration, +iotwireless:ListTagsForResource +``` + +### Update +```json +iotwireless:UpdateNetworkAnalyzerConfiguration, +iotwireless:UntagResource, +iotwireless:ListTagsForResource +``` + +### Delete +```json +iotwireless:DeleteNetworkAnalyzerConfiguration +``` + diff --git a/docs/aws-docs/providers/aws/iotwireless/network_analyzer_configurations/index.md b/docs/aws-docs/providers/aws/iotwireless/network_analyzer_configurations/index.md new file mode 100644 index 0000000000..9ce12af713 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotwireless/network_analyzer_configurations/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionCreate and manage NetworkAnalyzerConfiguration resource.
Idaws.iotwireless.network_analyzer_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
namestringName of the network analyzer configuration
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.iotwireless.network_analyzer_configurations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the network_analyzer_configurations resource, the following permissions are required: + +### Create +```json +iotwireless:CreateNetworkAnalyzerConfiguration, +iotwireless:TagResource, +iotwireless:ListTagsForResource +``` + +### List +```json +iotwireless:ListNetworkAnalyzerConfigurations, +iotwireless:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/iotwireless/partner_account/index.md b/docs/aws-docs/providers/aws/iotwireless/partner_account/index.md new file mode 100644 index 0000000000..53b95e2c78 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotwireless/partner_account/index.md @@ -0,0 +1,106 @@ +--- +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
DescriptionCreate and manage partner account
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +sidewalk, +partner_account_id, +partner_type, +sidewalk_response, +account_linked, +sidewalk_update, +fingerprint, +arn, +tags +FROM aws.iotwireless.partner_account +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the partner_account resource, the following permissions are required: + +### Read +```json +iotwireless:GetPartnerAccount, +iotwireless:ListTagsForResource +``` + +### Update +```json +iotwireless:UpdatePartnerAccount, +iotwireless:UntagResource, +iotwireless:ListTagsForResource +``` + +### Delete +```json +iotwireless:DisassociateAwsAccountFromPartnerAccount +``` + diff --git a/docs/aws-docs/providers/aws/iotwireless/partner_accounts/index.md b/docs/aws-docs/providers/aws/iotwireless/partner_accounts/index.md new file mode 100644 index 0000000000..c2041bc312 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotwireless/partner_accounts/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionCreate and manage partner account
Idaws.iotwireless.partner_accounts
+ +## Fields + + + + + +
NameDatatypeDescription
partner_account_idstringThe partner account ID to disassociate from the AWS account
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +partner_account_id +FROM aws.iotwireless.partner_accounts +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the partner_accounts resource, the following permissions are required: + +### Create +```json +iotwireless:AssociateAwsAccountWithPartnerAccount, +iotwireless:TagResource, +iotwireless:ListTagsForResource +``` + +### List +```json +iotwireless:ListPartnerAccounts, +iotwireless:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/iotwireless/service_profile/index.md b/docs/aws-docs/providers/aws/iotwireless/service_profile/index.md new file mode 100644 index 0000000000..9812f080af --- /dev/null +++ b/docs/aws-docs/providers/aws/iotwireless/service_profile/index.md @@ -0,0 +1,86 @@ +--- +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
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Idaws.iotwireless.service_profile
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
namestringName of service profile
lo_ra_wanobjectLoRaWAN 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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +lo_ra_wan, +tags, +arn, +id +FROM aws.iotwireless.service_profile +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the service_profile resource, the following permissions are required: + +### Read +```json +iotwireless:GetServiceProfile, +iotwireless:ListTagsForResource +``` + +### Delete +```json +iotwireless:DeleteServiceProfile +``` + diff --git a/docs/aws-docs/providers/aws/iotwireless/service_profiles/index.md b/docs/aws-docs/providers/aws/iotwireless/service_profiles/index.md new file mode 100644 index 0000000000..70e2f32a49 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotwireless/service_profiles/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Idaws.iotwireless.service_profiles
+ +## Fields + + + + + +
NameDatatypeDescription
idstringService profile Id. Returned after successful create.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.iotwireless.service_profiles +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the service_profiles resource, the following permissions are required: + +### Create +```json +iotwireless:CreateServiceProfile, +iotwireless:TagResource, +iotwireless:ListTagsForResource +``` + +### List +```json +iotwireless:ListServiceProfiles, +iotwireless:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/iotwireless/task_definition/index.md b/docs/aws-docs/providers/aws/iotwireless/task_definition/index.md new file mode 100644 index 0000000000..b4c0788c1c --- /dev/null +++ b/docs/aws-docs/providers/aws/iotwireless/task_definition/index.md @@ -0,0 +1,92 @@ +--- +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
DescriptionCreates a gateway task definition.
Idaws.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_wan_update_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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +auto_create_tasks, +update, +lo_ra_wan_update_gateway_task_entry, +id, +task_definition_type, +arn, +tags +FROM aws.iotwireless.task_definition +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the task_definition resource, the following permissions are required: + +### Read +```json +iotwireless:GetWirelessGatewayTaskDefinition, +iotwireless:ListTagsForResource +``` + +### Delete +```json +iotwireless:DeleteWirelessGatewayTaskDefinition +``` + diff --git a/docs/aws-docs/providers/aws/iotwireless/task_definitions/index.md b/docs/aws-docs/providers/aws/iotwireless/task_definitions/index.md new file mode 100644 index 0000000000..fd51c19d75 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotwireless/task_definitions/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionCreates a gateway task definition.
Idaws.iotwireless.task_definitions
+ +## Fields + + + + + +
NameDatatypeDescription
idstringThe ID of the new wireless gateway task definition
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.iotwireless.task_definitions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the task_definitions resource, the following permissions are required: + +### Create +```json +iotwireless:CreateWirelessGatewayTaskDefinition, +iotwireless:TagResource, +iotwireless:ListTagsForResource, +iam:GetRole, +iam:PassRole +``` + +### List +```json +iotwireless:ListWirelessGatewayTaskDefinitions, +iotwireless:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/iotwireless/wireless_device/index.md b/docs/aws-docs/providers/aws/iotwireless/wireless_device/index.md new file mode 100644 index 0000000000..15e86c2b7e --- /dev/null +++ b/docs/aws-docs/providers/aws/iotwireless/wireless_device/index.md @@ -0,0 +1,114 @@ +--- +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
DescriptionCreate and manage wireless gateways, including LoRa gateways.
Idaws.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_wanobjectThe 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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +type, +name, +description, +destination_name, +lo_ra_wan, +tags, +arn, +id, +thing_arn, +thing_name, +last_uplink_received_at, +positioning +FROM aws.iotwireless.wireless_device +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the wireless_device resource, the following permissions are required: + +### Read +```json +iotwireless:GetWirelessDevice, +iotwireless:ListTagsForResource +``` + +### Update +```json +iotwireless:UpdateWirelessDevice, +iotwireless:UntagResource, +iotwireless:ListTagsForResource, +iotwireless:AssociateWirelessDeviceWithThing +``` + +### Delete +```json +iotwireless:DeleteWirelessDevice, +iotwireless:DisassociateWirelessDeviceFromThing +``` + diff --git a/docs/aws-docs/providers/aws/iotwireless/wireless_device_import_task/index.md b/docs/aws-docs/providers/aws/iotwireless/wireless_device_import_task/index.md new file mode 100644 index 0000000000..339dfed855 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotwireless/wireless_device_import_task/index.md @@ -0,0 +1,113 @@ +--- +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 Tasks
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.iotwireless.wireless_device_import_task +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the wireless_device_import_task resource, the following permissions are required: + +### Read +```json +iotwireless:GetWirelessDeviceImportTask, +iotwireless:ListTagsForResource +``` + +### Update +```json +iotwireless:UpdateWirelessDeviceImportTask, +iotwireless:UntagResource, +iotwireless:ListTagsForResource, +iam:PassRole +``` + +### Delete +```json +iotwireless:DeleteWirelessDeviceImportTask +``` + diff --git a/docs/aws-docs/providers/aws/iotwireless/wireless_device_import_tasks/index.md b/docs/aws-docs/providers/aws/iotwireless/wireless_device_import_tasks/index.md new file mode 100644 index 0000000000..42281945d9 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotwireless/wireless_device_import_tasks/index.md @@ -0,0 +1,82 @@ +--- +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
Idaws.iotwireless.wireless_device_import_tasks
+ +## Fields + + + + + +
NameDatatypeDescription
idstringId for Wireless Device Import Task, Returned upon successful start.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.iotwireless.wireless_device_import_tasks +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the wireless_device_import_tasks resource, the following permissions are required: + +### Create +```json +iotwireless:StartWirelessDeviceImportTask, +iotwireless:StartSingleWirelessDeviceImportTask, +iotwireless:TagResource, +iotwireless:ListTagsForResource, +iam:PassRole +``` + +### List +```json +iotwireless:ListWirelessDeviceImportTasks, +iotwireless:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/iotwireless/wireless_devices/index.md b/docs/aws-docs/providers/aws/iotwireless/wireless_devices/index.md new file mode 100644 index 0000000000..98ddd3b81c --- /dev/null +++ b/docs/aws-docs/providers/aws/iotwireless/wireless_devices/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionCreate and manage wireless gateways, including LoRa gateways.
Idaws.iotwireless.wireless_devices
+ +## Fields + + + + + +
NameDatatypeDescription
idstringWireless device Id. Returned after successful create.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.iotwireless.wireless_devices +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the wireless_devices resource, the following permissions are required: + +### Create +```json +iotwireless:CreateWirelessDevice, +iotwireless:TagResource, +iotwireless:ListTagsForResource +``` + +### List +```json +iotwireless:ListWirelessDevices, +iotwireless:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/iotwireless/wireless_gateway/index.md b/docs/aws-docs/providers/aws/iotwireless/wireless_gateway/index.md new file mode 100644 index 0000000000..6e9e93e1f3 --- /dev/null +++ b/docs/aws-docs/providers/aws/iotwireless/wireless_gateway/index.md @@ -0,0 +1,108 @@ +--- +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
DescriptionCreate and manage wireless gateways, including LoRa gateways.
Idaws.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_wanobjectThe 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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +description, +tags, +lo_ra_wan, +arn, +id, +thing_arn, +thing_name, +last_uplink_received_at +FROM aws.iotwireless.wireless_gateway +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the wireless_gateway resource, the following permissions are required: + +### Read +```json +iotwireless:GetWirelessGateway, +iotwireless:ListTagsForResource +``` + +### Update +```json +iotwireless:UpdateWirelessGateway, +iotwireless:UntagResource, +iotwireless:ListTagsForResource, +iotwireless:AssociateWirelessGatewayWithThing +``` + +### Delete +```json +iotwireless:DeleteWirelessGateway, +iotwireless:DisassociateWirelessGatewayFromThing +``` + diff --git a/docs/aws-docs/providers/aws/iotwireless/wireless_gateways/index.md b/docs/aws-docs/providers/aws/iotwireless/wireless_gateways/index.md new file mode 100644 index 0000000000..68d70e3b4a --- /dev/null +++ b/docs/aws-docs/providers/aws/iotwireless/wireless_gateways/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionCreate and manage wireless gateways, including LoRa gateways.
Idaws.iotwireless.wireless_gateways
+ +## Fields + + + + + +
NameDatatypeDescription
idstringId for Wireless Gateway. Returned upon successful create.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.iotwireless.wireless_gateways +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the wireless_gateways resource, the following permissions are required: + +### Create +```json +iotwireless:CreateWirelessGateway, +iotwireless:TagResource, +iotwireless:ListTagsForResource +``` + +### List +```json +iotwireless:ListWirelessGateways, +iotwireless:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/ivs/channel/index.md b/docs/aws-docs/providers/aws/ivs/channel/index.md new file mode 100644 index 0000000000..8eaf1df9ee --- /dev/null +++ b/docs/aws-docs/providers/aws/ivs/channel/index.md @@ -0,0 +1,113 @@ +--- +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
DescriptionResource Type definition for AWS::IVS::Channel
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +name, +authorized, +insecure_ingest, +latency_mode, +type, +tags, +playback_url, +ingest_endpoint, +recording_configuration_arn, +preset +FROM aws.ivs.channel +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the channel resource, the following permissions are required: + +### Read +```json +ivs:GetChannel, +ivs:ListTagsForResource +``` + +### Update +```json +ivs:GetChannel, +ivs:UpdateChannel, +ivs:TagResource, +ivs:UnTagResource, +ivs:ListTagsForResource +``` + +### Delete +```json +ivs:DeleteChannel, +ivs:UnTagResource +``` + diff --git a/docs/aws-docs/providers/aws/ivs/channels/index.md b/docs/aws-docs/providers/aws/ivs/channels/index.md new file mode 100644 index 0000000000..1aab0991d1 --- /dev/null +++ b/docs/aws-docs/providers/aws/ivs/channels/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource Type definition for AWS::IVS::Channel
Idaws.ivs.channels
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringChannel ARN is automatically generated on creation and assigned as the unique identifier.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.ivs.channels +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the channels resource, the following permissions are required: + +### Create +```json +ivs:CreateChannel, +ivs:TagResource +``` + +### List +```json +ivs:ListChannels, +ivs:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/ivs/encoder_configuration/index.md b/docs/aws-docs/providers/aws/ivs/encoder_configuration/index.md new file mode 100644 index 0000000000..1b25b5357f --- /dev/null +++ b/docs/aws-docs/providers/aws/ivs/encoder_configuration/index.md @@ -0,0 +1,98 @@ +--- +title: encoder_configuration +hide_title: false +hide_table_of_contents: false +keywords: + - encoder_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 encoder_configuration resource + +## Overview + + + + + +
Nameencoder_configuration
TypeResource
DescriptionResource Type definition for AWS::IVS::EncoderConfiguration.
Idaws.ivs.encoder_configuration
+ +## Fields + + + + + + + + +
NameDatatypeDescription
arnstringEncoder configuration identifier.
videoobjectVideo configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps
namestringEncoder configuration name.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +video, +name, +tags +FROM aws.ivs.encoder_configuration +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the encoder_configuration resource, the following permissions are required: + +### Read +```json +ivs:GetEncoderConfiguration, +ivs:ListTagsForResource +``` + +### Update +```json +ivs:GetEncoderConfiguration, +ivs:ListTagsForResource, +ivs:UntagResource, +ivs:TagResource +``` + +### Delete +```json +ivs:DeleteEncoderConfiguration, +ivs:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/ivs/encoder_configurations/index.md b/docs/aws-docs/providers/aws/ivs/encoder_configurations/index.md new file mode 100644 index 0000000000..deacb617c7 --- /dev/null +++ b/docs/aws-docs/providers/aws/ivs/encoder_configurations/index.md @@ -0,0 +1,79 @@ +--- +title: encoder_configurations +hide_title: false +hide_table_of_contents: false +keywords: + - encoder_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 encoder_configurations in a region + +## Overview + + + + + +
Nameencoder_configurations
TypeResource
DescriptionResource Type definition for AWS::IVS::EncoderConfiguration.
Idaws.ivs.encoder_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringEncoder configuration identifier.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.ivs.encoder_configurations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the encoder_configurations resource, the following permissions are required: + +### Create +```json +ivs:CreateEncoderConfiguration, +ivs:TagResource +``` + +### List +```json +ivs:ListEncoderConfigurations, +ivs:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/ivs/index.md b/docs/aws-docs/providers/aws/ivs/index.md new file mode 100644 index 0000000000..0fdb217ad6 --- /dev/null +++ b/docs/aws-docs/providers/aws/ivs/index.md @@ -0,0 +1,53 @@ +--- +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: 16
+total selectable resources: 16
+total methods: 16
+
+
+ +::: + +## Resources +
+
+channel
+channels
+encoder_configuration
+encoder_configurations
+playback_key_pair
+playback_key_pairs
+playback_restriction_policies
+playback_restriction_policy +
+
+recording_configuration
+recording_configurations
+stage
+stages
+storage_configuration
+storage_configurations
+stream_key
+stream_keys +
+
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/ivs/playback_key_pair/index.md b/docs/aws-docs/providers/aws/ivs/playback_key_pair/index.md new file mode 100644 index 0000000000..5c50f10dc6 --- /dev/null +++ b/docs/aws-docs/providers/aws/ivs/playback_key_pair/index.md @@ -0,0 +1,99 @@ +--- +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
DescriptionResource Type definition for AWS::IVS::PlaybackKeyPair
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +public_key_material, +fingerprint, +arn, +tags +FROM aws.ivs.playback_key_pair +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the playback_key_pair resource, the following permissions are required: + +### Read +```json +ivs:GetPlaybackKeyPair +``` + +### Update +```json +ivs:GetPlaybackKeyPair, +ivs:ListTagsForResource, +ivs:UntagResource, +ivs:TagResource +``` + +### Delete +```json +ivs:DeletePlaybackKeyPair, +ivs:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/ivs/playback_key_pairs/index.md b/docs/aws-docs/providers/aws/ivs/playback_key_pairs/index.md new file mode 100644 index 0000000000..3559d5c9ad --- /dev/null +++ b/docs/aws-docs/providers/aws/ivs/playback_key_pairs/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource Type definition for AWS::IVS::PlaybackKeyPair
Idaws.ivs.playback_key_pairs
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringKey-pair identifier.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.ivs.playback_key_pairs +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the playback_key_pairs resource, the following permissions are required: + +### Create +```json +ivs:ImportPlaybackKeyPair, +ivs:TagResource +``` + +### List +```json +ivs:ListPlaybackKeyPairs, +ivs:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/ivs/playback_restriction_policies/index.md b/docs/aws-docs/providers/aws/ivs/playback_restriction_policies/index.md new file mode 100644 index 0000000000..ee8098a814 --- /dev/null +++ b/docs/aws-docs/providers/aws/ivs/playback_restriction_policies/index.md @@ -0,0 +1,79 @@ +--- +title: playback_restriction_policies +hide_title: false +hide_table_of_contents: false +keywords: + - playback_restriction_policies + - 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_restriction_policies in a region + +## Overview + + + + + +
Nameplayback_restriction_policies
TypeResource
DescriptionResource Type definition for AWS::IVS::PlaybackRestrictionPolicy.
Idaws.ivs.playback_restriction_policies
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringPlayback-restriction-policy identifier.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.ivs.playback_restriction_policies +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the playback_restriction_policies resource, the following permissions are required: + +### Create +```json +ivs:CreatePlaybackRestrictionPolicy, +ivs:TagResource +``` + +### List +```json +ivs:ListPlaybackRestrictionPolicies, +ivs:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/ivs/playback_restriction_policy/index.md b/docs/aws-docs/providers/aws/ivs/playback_restriction_policy/index.md new file mode 100644 index 0000000000..da2863ce57 --- /dev/null +++ b/docs/aws-docs/providers/aws/ivs/playback_restriction_policy/index.md @@ -0,0 +1,103 @@ +--- +title: playback_restriction_policy +hide_title: false +hide_table_of_contents: false +keywords: + - playback_restriction_policy + - 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_restriction_policy resource + +## Overview + + + + + +
Nameplayback_restriction_policy
TypeResource
DescriptionResource Type definition for AWS::IVS::PlaybackRestrictionPolicy.
Idaws.ivs.playback_restriction_policy
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
arnstringPlayback-restriction-policy identifier.
allowed_countriesarrayA list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).
allowed_originsarrayA list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin
enable_strict_origin_enforcementbooleanWhether channel playback is constrained by origin site.
namestringPlayback-restriction-policy name.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +allowed_countries, +allowed_origins, +enable_strict_origin_enforcement, +name, +tags +FROM aws.ivs.playback_restriction_policy +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the playback_restriction_policy resource, the following permissions are required: + +### Read +```json +ivs:GetPlaybackRestrictionPolicy, +ivs:ListTagsForResource +``` + +### Update +```json +ivs:GetPlaybackRestrictionPolicy, +ivs:UpdatePlaybackRestrictionPolicy, +ivs:ListTagsForResource, +ivs:UntagResource, +ivs:TagResource +``` + +### Delete +```json +ivs:DeletePlaybackRestrictionPolicy, +ivs:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/ivs/recording_configuration/index.md b/docs/aws-docs/providers/aws/ivs/recording_configuration/index.md new file mode 100644 index 0000000000..032c991b6a --- /dev/null +++ b/docs/aws-docs/providers/aws/ivs/recording_configuration/index.md @@ -0,0 +1,113 @@ +--- +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
DescriptionResource Type definition for AWS::IVS::RecordingConfiguration
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +name, +state, +recording_reconnect_window_seconds, +destination_configuration, +tags, +thumbnail_configuration, +rendition_configuration +FROM aws.ivs.recording_configuration +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the recording_configuration resource, the following permissions are required: + +### Read +```json +ivs:GetRecordingConfiguration, +s3:GetBucketLocation, +ivs:ListTagsForResource +``` + +### Update +```json +ivs:GetRecordingConfiguration, +sts:AssumeRole, +iam:CreateServiceLinkedRole, +iam:PutRolePolicy, +iam:AttachRolePolicy, +s3:ListBucket, +ivs:TagResource, +ivs:UntagResource, +ivs:ListTagsForResource +``` + +### Delete +```json +ivs:DeleteRecordingConfiguration, +ivs:UntagResource, +iam:CreateServiceLinkedRole +``` + diff --git a/docs/aws-docs/providers/aws/ivs/recording_configurations/index.md b/docs/aws-docs/providers/aws/ivs/recording_configurations/index.md new file mode 100644 index 0000000000..1edb39c20c --- /dev/null +++ b/docs/aws-docs/providers/aws/ivs/recording_configurations/index.md @@ -0,0 +1,87 @@ +--- +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
DescriptionResource Type definition for AWS::IVS::RecordingConfiguration
Idaws.ivs.recording_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringRecording Configuration ARN is automatically generated on creation and assigned as the unique identifier.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.ivs.recording_configurations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the recording_configurations resource, the following permissions are required: + +### Create +```json +ivs:CreateRecordingConfiguration, +ivs:GetRecordingConfiguration, +ivs:TagResource, +iam:CreateServiceLinkedRole, +iam:PutRolePolicy, +iam:AttachRolePolicy, +s3:ListBucket, +s3:GetBucketLocation, +cloudformation:ListExports +``` + +### List +```json +ivs:ListRecordingConfigurations, +s3:GetBucketLocation, +ivs:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/ivs/stage/index.md b/docs/aws-docs/providers/aws/ivs/stage/index.md new file mode 100644 index 0000000000..9009c005a8 --- /dev/null +++ b/docs/aws-docs/providers/aws/ivs/stage/index.md @@ -0,0 +1,99 @@ +--- +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
DescriptionResource Definition for type AWS::IVS::Stage.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +name, +tags, +active_session_id +FROM aws.ivs.stage +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the stage resource, the following permissions are required: + +### Read +```json +ivs:GetStage, +ivs:ListTagsForResource +``` + +### Update +```json +ivs:GetStage, +ivs:UpdateStage, +ivs:TagResource, +ivs:UnTagResource, +ivs:ListTagsForResource +``` + +### Delete +```json +ivs:DeleteStage, +ivs:UnTagResource +``` + diff --git a/docs/aws-docs/providers/aws/ivs/stages/index.md b/docs/aws-docs/providers/aws/ivs/stages/index.md new file mode 100644 index 0000000000..b5baddf3ed --- /dev/null +++ b/docs/aws-docs/providers/aws/ivs/stages/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionResource Definition for type AWS::IVS::Stage.
Idaws.ivs.stages
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringStage ARN is automatically generated on creation and assigned as the unique identifier.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.ivs.stages +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the stages resource, the following permissions are required: + +### Create +```json +ivs:CreateStage, +ivs:GetStage, +ivs:TagResource, +ivs:ListTagsForResource +``` + +### List +```json +ivs:ListStages, +ivs:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/ivs/storage_configuration/index.md b/docs/aws-docs/providers/aws/ivs/storage_configuration/index.md new file mode 100644 index 0000000000..d4aedc2340 --- /dev/null +++ b/docs/aws-docs/providers/aws/ivs/storage_configuration/index.md @@ -0,0 +1,102 @@ +--- +title: storage_configuration +hide_title: false +hide_table_of_contents: false +keywords: + - storage_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 storage_configuration resource + +## Overview + + + + + +
Namestorage_configuration
TypeResource
DescriptionResource Type definition for AWS::IVS::StorageConfiguration
Idaws.ivs.storage_configuration
+ +## Fields + + + + + + + + +
NameDatatypeDescription
arnstringStorage Configuration ARN is automatically generated on creation and assigned as the unique identifier.
namestringStorage Configuration Name.
s3object
tagsarrayA list of key-value pairs that contain metadata for the asset model.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +name, +s3, +tags +FROM aws.ivs.storage_configuration +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the storage_configuration resource, the following permissions are required: + +### Read +```json +ivs:GetStorageConfiguration, +ivs:ListTagsForResource, +s3:GetBucketLocation +``` + +### Update +```json +ivs:GetStorageConfiguration, +ivs:TagResource, +ivs:UntagResource, +ivs:ListTagsForResource +``` + +### Delete +```json +ivs:DeleteStorageConfiguration, +ivs:UntagResource, +s3:GetBucketPolicy, +s3:DeleteBucketPolicy, +s3:PutBucketPolicy +``` + diff --git a/docs/aws-docs/providers/aws/ivs/storage_configurations/index.md b/docs/aws-docs/providers/aws/ivs/storage_configurations/index.md new file mode 100644 index 0000000000..d6d6a53eb5 --- /dev/null +++ b/docs/aws-docs/providers/aws/ivs/storage_configurations/index.md @@ -0,0 +1,84 @@ +--- +title: storage_configurations +hide_title: false +hide_table_of_contents: false +keywords: + - storage_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 storage_configurations in a region + +## Overview + + + + + +
Namestorage_configurations
TypeResource
DescriptionResource Type definition for AWS::IVS::StorageConfiguration
Idaws.ivs.storage_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringStorage Configuration ARN is automatically generated on creation and assigned as the unique identifier.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.ivs.storage_configurations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the storage_configurations resource, the following permissions are required: + +### Create +```json +ivs:CreateStorageConfiguration, +ivs:GetStorageConfiguration, +ivs:TagResource, +s3:GetBucketLocation, +s3:GetBucketPolicy, +s3:PutBucketPolicy +``` + +### List +```json +ivs:ListStorageConfigurations, +s3:GetBucketLocation, +ivs:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/ivs/stream_key/index.md b/docs/aws-docs/providers/aws/ivs/stream_key/index.md new file mode 100644 index 0000000000..0eb8914618 --- /dev/null +++ b/docs/aws-docs/providers/aws/ivs/stream_key/index.md @@ -0,0 +1,98 @@ +--- +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
DescriptionResource Type definition for AWS::IVS::StreamKey
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +channel_arn, +tags, +value +FROM aws.ivs.stream_key +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the stream_key resource, the following permissions are required: + +### Read +```json +ivs:GetStreamKey, +ivs:ListTagsForResource +``` + +### Update +```json +ivs:GetStreamKey, +ivs:TagResource, +ivs:UntagResource, +ivs:ListTagsForResource +``` + +### Delete +```json +ivs:DeleteStreamKey, +ivs:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/ivs/stream_keys/index.md b/docs/aws-docs/providers/aws/ivs/stream_keys/index.md new file mode 100644 index 0000000000..c42ef2d72a --- /dev/null +++ b/docs/aws-docs/providers/aws/ivs/stream_keys/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionResource Type definition for AWS::IVS::StreamKey
Idaws.ivs.stream_keys
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringStream Key ARN is automatically generated on creation and assigned as the unique identifier.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.ivs.stream_keys +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the stream_keys resource, the following permissions are required: + +### Create +```json +ivs:TagResource, +ivs:UntagResource, +ivs:CreateStreamKey +``` + +### List +```json +ivs:ListStreamKeys, +ivs:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/ivschat/index.md b/docs/aws-docs/providers/aws/ivschat/index.md new file mode 100644 index 0000000000..25af3fcc3b --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/ivschat/logging_configuration/index.md b/docs/aws-docs/providers/aws/ivschat/logging_configuration/index.md new file mode 100644 index 0000000000..e81f390857 --- /dev/null +++ b/docs/aws-docs/providers/aws/ivschat/logging_configuration/index.md @@ -0,0 +1,119 @@ +--- +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
DescriptionResource type definition for AWS::IVSChat::LoggingConfiguration.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +id, +destination_configuration, +name, +state, +tags +FROM aws.ivschat.logging_configuration +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the logging_configuration resource, the following permissions are required: + +### Read +```json +ivschat:GetLoggingConfiguration, +ivschat:ListTagsForResource +``` + +### Update +```json +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 +```json +ivschat:DeleteLoggingConfiguration, +ivschat:GetLoggingConfiguration, +logs:DeleteLogDelivery, +logs:ListLogDeliveries, +ivschat:UntagResource, +logs:GetLogDelivery +``` + diff --git a/docs/aws-docs/providers/aws/ivschat/logging_configurations/index.md b/docs/aws-docs/providers/aws/ivschat/logging_configurations/index.md new file mode 100644 index 0000000000..b5e0d0bde1 --- /dev/null +++ b/docs/aws-docs/providers/aws/ivschat/logging_configurations/index.md @@ -0,0 +1,88 @@ +--- +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
DescriptionResource type definition for AWS::IVSChat::LoggingConfiguration.
Idaws.ivschat.logging_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringLoggingConfiguration ARN is automatically generated on creation and assigned as the unique identifier.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.ivschat.logging_configurations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the logging_configurations resource, the following permissions are required: + +### Create +```json +ivschat:CreateLoggingConfiguration, +ivschat:GetLoggingConfiguration, +logs:CreateLogDelivery, +logs:PutResourcePolicy, +logs:DescribeResourcePolicies, +logs:DescribeLogGroups, +s3:PutBucketPolicy, +s3:GetBucketPolicy, +iam:CreateServiceLinkedRole, +firehose:TagDeliveryStream, +ivschat:TagResource +``` + +### List +```json +ivschat:ListLoggingConfigurations, +ivschat:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/ivschat/room/index.md b/docs/aws-docs/providers/aws/ivschat/room/index.md new file mode 100644 index 0000000000..2d636efbde --- /dev/null +++ b/docs/aws-docs/providers/aws/ivschat/room/index.md @@ -0,0 +1,106 @@ +--- +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
DescriptionResource type definition for AWS::IVSChat::Room.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +id, +name, +logging_configuration_identifiers, +maximum_message_length, +maximum_message_rate_per_second, +message_review_handler, +tags +FROM aws.ivschat.room +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the room resource, the following permissions are required: + +### Read +```json +ivschat:GetRoom, +ivschat:ListTagsForResource +``` + +### Update +```json +ivschat:UpdateRoom, +ivschat:TagResource, +ivschat:UntagResource, +ivschat:ListTagsForResource +``` + +### Delete +```json +ivschat:DeleteRoom, +ivschat:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/ivschat/rooms/index.md b/docs/aws-docs/providers/aws/ivschat/rooms/index.md new file mode 100644 index 0000000000..7d7379d690 --- /dev/null +++ b/docs/aws-docs/providers/aws/ivschat/rooms/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource type definition for AWS::IVSChat::Room.
Idaws.ivschat.rooms
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringRoom ARN is automatically generated on creation and assigned as the unique identifier.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.ivschat.rooms +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the rooms resource, the following permissions are required: + +### Create +```json +ivschat:CreateRoom, +ivschat:TagResource +``` + +### List +```json +ivschat:ListRooms, +ivschat:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/kafkaconnect/connector/index.md b/docs/aws-docs/providers/aws/kafkaconnect/connector/index.md new file mode 100644 index 0000000000..e813441ada --- /dev/null +++ b/docs/aws-docs/providers/aws/kafkaconnect/connector/index.md @@ -0,0 +1,132 @@ +--- +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
DescriptionResource Type definition for AWS::KafkaConnect::Connector
Idaws.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.
tagsarrayA collection of tags associated with a resource
worker_configurationobject
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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, +tags, +worker_configuration +FROM aws.kafkaconnect.connector +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the connector resource, the following permissions are required: + +### Read +```json +kafkaconnect:DescribeConnector, +kafkaconnect:ListTagsForResource +``` + +### Delete +```json +kafkaconnect:DeleteConnector, +kafkaconnect:DescribeConnector, +logs:DeleteLogDelivery, +logs:GetLogDelivery, +logs:ListLogDeliveries +``` + +### Update +```json +kafkaconnect:UpdateConnector, +kafkaconnect:DescribeConnector, +kafkaconnect:TagResource, +kafkaconnect:ListTagsForResource, +kafkaconnect:UntagResource, +iam:CreateServiceLinkedRole, +logs:UpdateLogDelivery, +logs:GetLogDelivery, +logs:ListLogDeliveries, +logs:PutResourcePolicy, +logs:DescribeResourcePolicies, +logs:DescribeLogGroups, +s3:GetBucketPolicy, +s3:PutBucketPolicy, +firehose:TagDeliveryStream +``` + diff --git a/docs/aws-docs/providers/aws/kafkaconnect/connectors/index.md b/docs/aws-docs/providers/aws/kafkaconnect/connectors/index.md new file mode 100644 index 0000000000..2efac538e2 --- /dev/null +++ b/docs/aws-docs/providers/aws/kafkaconnect/connectors/index.md @@ -0,0 +1,95 @@ +--- +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
DescriptionResource Type definition for AWS::KafkaConnect::Connector
Idaws.kafkaconnect.connectors
+ +## Fields + + + + + +
NameDatatypeDescription
connector_arnstringAmazon Resource Name for the created Connector.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +connector_arn +FROM aws.kafkaconnect.connectors +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the connectors resource, the following permissions are required: + +### Create +```json +kafkaconnect:CreateConnector, +kafkaconnect:DescribeConnector, +kafkaconnect:TagResource, +kafkaconnect:ListTagsForResource, +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 +```json +kafkaconnect:ListConnectors +``` + diff --git a/docs/aws-docs/providers/aws/kafkaconnect/custom_plugin/index.md b/docs/aws-docs/providers/aws/kafkaconnect/custom_plugin/index.md new file mode 100644 index 0000000000..c65091f78c --- /dev/null +++ b/docs/aws-docs/providers/aws/kafkaconnect/custom_plugin/index.md @@ -0,0 +1,106 @@ +--- +title: custom_plugin +hide_title: false +hide_table_of_contents: false +keywords: + - custom_plugin + - 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 custom_plugin resource + +## Overview + + + + + +
Namecustom_plugin
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Idaws.kafkaconnect.custom_plugin
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
namestringThe name of the custom plugin.
descriptionstringA summary description of the custom plugin.
custom_plugin_arnstringThe Amazon Resource Name (ARN) of the custom plugin to use.
content_typestringThe type of the plugin file.
file_descriptionobject
locationobject
revisionintegerThe revision of the custom plugin.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +description, +custom_plugin_arn, +content_type, +file_description, +location, +revision, +tags +FROM aws.kafkaconnect.custom_plugin +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the custom_plugin resource, the following permissions are required: + +### Read +```json +kafkaconnect:DescribeCustomPlugin, +kafkaconnect:ListTagsForResource +``` + +### Update +```json +kafkaconnect:DescribeCustomPlugin, +kafkaconnect:ListTagsForResource, +kafkaconnect:TagResource, +kafkaconnect:UntagResource +``` + +### Delete +```json +kafkaconnect:DeleteCustomPlugin, +kafkaconnect:DescribeCustomPlugin +``` + diff --git a/docs/aws-docs/providers/aws/kafkaconnect/custom_plugins/index.md b/docs/aws-docs/providers/aws/kafkaconnect/custom_plugins/index.md new file mode 100644 index 0000000000..1a49008750 --- /dev/null +++ b/docs/aws-docs/providers/aws/kafkaconnect/custom_plugins/index.md @@ -0,0 +1,84 @@ +--- +title: custom_plugins +hide_title: false +hide_table_of_contents: false +keywords: + - custom_plugins + - 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 custom_plugins in a region + +## Overview + + + + + +
Namecustom_plugins
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Idaws.kafkaconnect.custom_plugins
+ +## Fields + + + + + +
NameDatatypeDescription
custom_plugin_arnstringThe Amazon Resource Name (ARN) of the custom plugin to use.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +custom_plugin_arn +FROM aws.kafkaconnect.custom_plugins +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the custom_plugins resource, the following permissions are required: + +### Create +```json +kafkaconnect:DescribeCustomPlugin, +kafkaconnect:ListTagsForResource, +kafkaconnect:CreateCustomPlugin, +kafkaconnect:TagResource, +s3:GetObject, +s3:GetObjectVersion, +s3:GetObjectAttributes, +s3:GetObjectVersionAttributes +``` + +### List +```json +kafkaconnect:ListCustomPlugins +``` + diff --git a/docs/aws-docs/providers/aws/kafkaconnect/index.md b/docs/aws-docs/providers/aws/kafkaconnect/index.md new file mode 100644 index 0000000000..9b9988c397 --- /dev/null +++ b/docs/aws-docs/providers/aws/kafkaconnect/index.md @@ -0,0 +1,43 @@ +--- +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: 6
+total selectable resources: 6
+total methods: 6
+
+
+ +::: + +## Resources +
+
+connector
+connectors
+custom_plugin +
+
+custom_plugins
+worker_configuration
+worker_configurations +
+
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/kafkaconnect/worker_configuration/index.md b/docs/aws-docs/providers/aws/kafkaconnect/worker_configuration/index.md new file mode 100644 index 0000000000..27a2475b3a --- /dev/null +++ b/docs/aws-docs/providers/aws/kafkaconnect/worker_configuration/index.md @@ -0,0 +1,102 @@ +--- +title: worker_configuration +hide_title: false +hide_table_of_contents: false +keywords: + - worker_configuration + - 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 worker_configuration resource + +## Overview + + + + + +
Nameworker_configuration
TypeResource
DescriptionThe configuration of the workers, which are the processes that run the connector logic.
Idaws.kafkaconnect.worker_configuration
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
namestringThe name of the worker configuration.
descriptionstringA summary description of the worker configuration.
worker_configuration_arnstringThe Amazon Resource Name (ARN) of the custom configuration.
properties_file_contentstringBase64 encoded contents of connect-distributed.properties file.
revisionintegerThe description of a revision of the worker configuration.
tagsarrayA collection of tags associated with a resource
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +description, +worker_configuration_arn, +properties_file_content, +revision, +tags +FROM aws.kafkaconnect.worker_configuration +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the worker_configuration resource, the following permissions are required: + +### Read +```json +kafkaconnect:DescribeWorkerConfiguration, +kafkaconnect:ListTagsForResource +``` + +### Update +```json +kafkaconnect:DescribeWorkerConfiguration, +kafkaconnect:ListTagsForResource, +kafkaconnect:TagResource, +kafkaconnect:UntagResource +``` + +### Delete +```json +kafkaconnect:DescribeWorkerConfiguration, +kafkaconnect:DeleteWorkerConfiguration +``` + diff --git a/docs/aws-docs/providers/aws/kafkaconnect/worker_configurations/index.md b/docs/aws-docs/providers/aws/kafkaconnect/worker_configurations/index.md new file mode 100644 index 0000000000..76d33ec346 --- /dev/null +++ b/docs/aws-docs/providers/aws/kafkaconnect/worker_configurations/index.md @@ -0,0 +1,80 @@ +--- +title: worker_configurations +hide_title: false +hide_table_of_contents: false +keywords: + - worker_configurations + - 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 worker_configurations in a region + +## Overview + + + + + +
Nameworker_configurations
TypeResource
DescriptionThe configuration of the workers, which are the processes that run the connector logic.
Idaws.kafkaconnect.worker_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
worker_configuration_arnstringThe Amazon Resource Name (ARN) of the custom configuration.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +worker_configuration_arn +FROM aws.kafkaconnect.worker_configurations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the worker_configurations resource, the following permissions are required: + +### Create +```json +kafkaconnect:DescribeWorkerConfiguration, +kafkaconnect:CreateWorkerConfiguration, +kafkaconnect:TagResource, +kafkaconnect:ListTagsForResource +``` + +### List +```json +kafkaconnect:ListWorkerConfigurations +``` + diff --git a/docs/aws-docs/providers/aws/kendra/data_source/index.md b/docs/aws-docs/providers/aws/kendra/data_source/index.md new file mode 100644 index 0000000000..5f20501da4 --- /dev/null +++ b/docs/aws-docs/providers/aws/kendra/data_source/index.md @@ -0,0 +1,116 @@ +--- +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
DescriptionKendra DataSource
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.kendra.data_source +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the data_source resource, the following permissions are required: + +### Read +```json +kendra:DescribeDataSource, +kendra:ListTagsForResource +``` + +### Delete +```json +kendra:DescribeDataSource, +kendra:DeleteDataSource +``` + +### Update +```json +kendra:DescribeDataSource, +kendra:UpdateDataSource, +kendra:ListTagsForResource, +kendra:TagResource, +kendra:UntagResource, +iam:PassRole +``` + diff --git a/docs/aws-docs/providers/aws/kendra/data_sources/index.md b/docs/aws-docs/providers/aws/kendra/data_sources/index.md new file mode 100644 index 0000000000..0add20683a --- /dev/null +++ b/docs/aws-docs/providers/aws/kendra/data_sources/index.md @@ -0,0 +1,83 @@ +--- +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
DescriptionKendra DataSource
Idaws.kendra.data_sources
+ +## Fields + + + + + + +
NameDatatypeDescription
idundefined
index_idundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id, +index_id +FROM aws.kendra.data_sources +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the data_sources resource, the following permissions are required: + +### Create +```json +kendra:CreateDataSource, +kendra:DescribeDataSource, +kendra:ListTagsForResource, +iam:PassRole, +kendra:TagResource +``` + +### List +```json +kendra:ListDataSources +``` + diff --git a/docs/aws-docs/providers/aws/kendra/faq/index.md b/docs/aws-docs/providers/aws/kendra/faq/index.md new file mode 100644 index 0000000000..cb3a8dde57 --- /dev/null +++ b/docs/aws-docs/providers/aws/kendra/faq/index.md @@ -0,0 +1,109 @@ +--- +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
DescriptionA Kendra FAQ resource
Idaws.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
language_codestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +index_id, +name, +description, +file_format, +s3_path, +role_arn, +tags, +arn, +language_code +FROM aws.kendra.faq +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the faq resource, the following permissions are required: + +### Update +```json +kendra:ListTagsForResource, +kendra:UntagResource, +kendra:TagResource +``` + +### Read +```json +kendra:DescribeFaq, +kendra:ListTagsForResource +``` + +### Delete +```json +kendra:DeleteFaq, +kendra:DescribeFaq +``` + diff --git a/docs/aws-docs/providers/aws/kendra/faqs/index.md b/docs/aws-docs/providers/aws/kendra/faqs/index.md new file mode 100644 index 0000000000..f7feab1c56 --- /dev/null +++ b/docs/aws-docs/providers/aws/kendra/faqs/index.md @@ -0,0 +1,83 @@ +--- +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
DescriptionA Kendra FAQ resource
Idaws.kendra.faqs
+ +## Fields + + + + + + +
NameDatatypeDescription
idundefined
index_idundefinedIndex ID
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id, +index_id +FROM aws.kendra.faqs +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the faqs resource, the following permissions are required: + +### Create +```json +kendra:CreateFaq, +kendra:DescribeFaq, +iam:PassRole, +kendra:ListTagsForResource, +kendra:TagResource +``` + +### List +```json +kendra:ListFaqs +``` + diff --git a/docs/aws-docs/providers/aws/kendra/index.md b/docs/aws-docs/providers/aws/kendra/index.md new file mode 100644 index 0000000000..a1ac55addf --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/kendra/index/index.md b/docs/aws-docs/providers/aws/kendra/index/index.md new file mode 100644 index 0000000000..bedd7e8052 --- /dev/null +++ b/docs/aws-docs/providers/aws/kendra/index/index.md @@ -0,0 +1,116 @@ +--- +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
DescriptionA Kendra index
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.kendra.index +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the index resource, the following permissions are required: + +### Read +```json +kendra:DescribeIndex, +kendra:ListTagsForResource +``` + +### Update +```json +kendra:DescribeIndex, +kendra:UpdateIndex, +kendra:ListTagsForResource, +kendra:TagResource, +kendra:UntagResource, +iam:PassRole +``` + +### Delete +```json +kendra:DescribeIndex, +kendra:DeleteIndex +``` + diff --git a/docs/aws-docs/providers/aws/kendra/indices/index.md b/docs/aws-docs/providers/aws/kendra/indices/index.md new file mode 100644 index 0000000000..d6347214a4 --- /dev/null +++ b/docs/aws-docs/providers/aws/kendra/indices/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionA Kendra index
Idaws.kendra.indices
+ +## Fields + + + + + +
NameDatatypeDescription
idundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.kendra.indices +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the indices resource, the following permissions are required: + +### Create +```json +kendra:CreateIndex, +kendra:DescribeIndex, +kendra:UpdateIndex, +kendra:ListTagsForResource, +iam:PassRole, +kendra:TagResource +``` + +### List +```json +kendra:ListIndices +``` + diff --git a/docs/aws-docs/providers/aws/kendraranking/execution_plan/index.md b/docs/aws-docs/providers/aws/kendraranking/execution_plan/index.md new file mode 100644 index 0000000000..1ebbbb34e6 --- /dev/null +++ b/docs/aws-docs/providers/aws/kendraranking/execution_plan/index.md @@ -0,0 +1,103 @@ +--- +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
DescriptionA KendraRanking Rescore execution plan
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +arn, +description, +tags, +name, +capacity_units +FROM aws.kendraranking.execution_plan +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the execution_plan resource, the following permissions are required: + +### Read +```json +kendra-ranking:DescribeRescoreExecutionPlan, +kendra-ranking:ListTagsForResource +``` + +### Update +```json +kendra-ranking:DescribeRescoreExecutionPlan, +kendra-ranking:UpdateRescoreExecutionPlan, +kendra-ranking:ListTagsForResource, +kendra-ranking:TagResource, +kendra-ranking:UntagResource +``` + +### Delete +```json +kendra-ranking:DescribeRescoreExecutionPlan, +kendra-ranking:DeleteRescoreExecutionPlan +``` + diff --git a/docs/aws-docs/providers/aws/kendraranking/execution_plans/index.md b/docs/aws-docs/providers/aws/kendraranking/execution_plans/index.md new file mode 100644 index 0000000000..38f9091d6a --- /dev/null +++ b/docs/aws-docs/providers/aws/kendraranking/execution_plans/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionA KendraRanking Rescore execution plan
Idaws.kendraranking.execution_plans
+ +## Fields + + + + + +
NameDatatypeDescription
idundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.kendraranking.execution_plans +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the execution_plans resource, the following permissions are required: + +### Create +```json +kendra-ranking:CreateRescoreExecutionPlan, +kendra-ranking:DescribeRescoreExecutionPlan, +kendra-ranking:UpdateRescoreExecutionPlan, +kendra-ranking:ListTagsForResource, +kendra-ranking:TagResource +``` + +### List +```json +kendra-ranking:ListRescoreExecutionPlans +``` + diff --git a/docs/aws-docs/providers/aws/kendraranking/index.md b/docs/aws-docs/providers/aws/kendraranking/index.md new file mode 100644 index 0000000000..c3a3229ec5 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/kinesis/index.md b/docs/aws-docs/providers/aws/kinesis/index.md new file mode 100644 index 0000000000..36002dc555 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/kinesis/kinesis_stream/index.md b/docs/aws-docs/providers/aws/kinesis/kinesis_stream/index.md new file mode 100644 index 0000000000..4f9006cf88 --- /dev/null +++ b/docs/aws-docs/providers/aws/kinesis/kinesis_stream/index.md @@ -0,0 +1,113 @@ +--- +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
DescriptionResource Type definition for AWS::Kinesis::Stream
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +stream_mode_details, +stream_encryption, +arn, +retention_period_hours, +tags, +name, +shard_count +FROM aws.kinesis.kinesis_stream +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the kinesis_stream resource, the following permissions are required: + +### Read +```json +kinesis:DescribeStreamSummary, +kinesis:ListTagsForStream +``` + +### Update +```json +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 +```json +kinesis:DescribeStreamSummary, +kinesis:DeleteStream, +kinesis:RemoveTagsFromStream +``` + diff --git a/docs/aws-docs/providers/aws/kinesis/streams/index.md b/docs/aws-docs/providers/aws/kinesis/streams/index.md new file mode 100644 index 0000000000..0055e04bde --- /dev/null +++ b/docs/aws-docs/providers/aws/kinesis/streams/index.md @@ -0,0 +1,83 @@ +--- +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
DescriptionResource Type definition for AWS::Kinesis::Stream
Idaws.kinesis.streams
+ +## Fields + + + + + +
NameDatatypeDescription
namestringThe name of the Kinesis stream.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.kinesis.streams +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the streams resource, the following permissions are required: + +### Create +```json +kinesis:EnableEnhancedMonitoring, +kinesis:DescribeStreamSummary, +kinesis:CreateStream, +kinesis:IncreaseStreamRetentionPeriod, +kinesis:StartStreamEncryption, +kinesis:AddTagsToStream, +kinesis:ListTagsForStream +``` + +### List +```json +kinesis:ListStreams +``` + diff --git a/docs/aws-docs/providers/aws/kinesisanalyticsv2/application/index.md b/docs/aws-docs/providers/aws/kinesisanalyticsv2/application/index.md new file mode 100644 index 0000000000..f3881b4f13 --- /dev/null +++ b/docs/aws-docs/providers/aws/kinesisanalyticsv2/application/index.md @@ -0,0 +1,112 @@ +--- +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
DescriptionCreates an Amazon Kinesis Data Analytics application. For information about creating a Kinesis Data Analytics application, see [Creating an Application](https://docs.aws.amazon.com/kinesisanalytics/latest/java/getting-started.html).
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +application_configuration, +application_description, +application_mode, +application_name, +runtime_environment, +service_execution_role, +run_configuration, +application_maintenance_configuration, +tags +FROM aws.kinesisanalyticsv2.application +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the application resource, the following permissions are required: + +### Read +```json +kinesisanalytics:DescribeApplication, +kinesisanalytics:ListTagsForResource +``` + +### Update +```json +kinesisanalytics:UpdateApplication, +kinesisanalytics:DescribeApplication, +kinesisanalytics:TagResource, +kinesisanalytics:UntagResource, +kinesisanalytics:AddApplicationVpcConfiguration, +kinesisanalytics:DeleteApplicationVpcConfiguration, +kinesisanalytics:UpdateApplicationMaintenanceConfiguration, +kinesisanalytics:ListTagsForResource +``` + +### Delete +```json +kinesisanalytics:DescribeApplication, +kinesisanalytics:DeleteApplication +``` + diff --git a/docs/aws-docs/providers/aws/kinesisanalyticsv2/applications/index.md b/docs/aws-docs/providers/aws/kinesisanalyticsv2/applications/index.md new file mode 100644 index 0000000000..22f5976691 --- /dev/null +++ b/docs/aws-docs/providers/aws/kinesisanalyticsv2/applications/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionCreates an Amazon Kinesis Data Analytics application. For information about creating a Kinesis Data Analytics application, see [Creating an Application](https://docs.aws.amazon.com/kinesisanalytics/latest/java/getting-started.html).
Idaws.kinesisanalyticsv2.applications
+ +## Fields + + + + + +
NameDatatypeDescription
application_namestringThe name of the application.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +application_name +FROM aws.kinesisanalyticsv2.applications +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the applications resource, the following permissions are required: + +### Create +```json +iam:PassRole, +kinesisanalytics:CreateApplication, +kinesisanalytics:DescribeApplication, +kinesisanalytics:ListTagsForResource, +kinesisanalytics:UpdateApplicationMaintenanceConfiguration +``` + +### List +```json +kinesisanalytics:ListApplications +``` + diff --git a/docs/aws-docs/providers/aws/kinesisanalyticsv2/index.md b/docs/aws-docs/providers/aws/kinesisanalyticsv2/index.md new file mode 100644 index 0000000000..6abb795891 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/kinesisfirehose/delivery_stream/index.md b/docs/aws-docs/providers/aws/kinesisfirehose/delivery_stream/index.md new file mode 100644 index 0000000000..371786f3f3 --- /dev/null +++ b/docs/aws-docs/providers/aws/kinesisfirehose/delivery_stream/index.md @@ -0,0 +1,130 @@ +--- +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
DescriptionResource Type definition for AWS::KinesisFirehose::DeliveryStream
Idaws.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
msk_source_configurationobject
redshift_destination_configurationobject
s3_destination_configurationobject
splunk_destination_configurationobject
http_endpoint_destination_configurationobject
snowflake_destination_configurationobject
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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, +msk_source_configuration, +redshift_destination_configuration, +s3_destination_configuration, +splunk_destination_configuration, +http_endpoint_destination_configuration, +snowflake_destination_configuration, +tags +FROM aws.kinesisfirehose.delivery_stream +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the delivery_stream resource, the following permissions are required: + +### Read +```json +firehose:DescribeDeliveryStream, +firehose:ListTagsForDeliveryStream +``` + +### Update +```json +firehose:UpdateDestination, +firehose:DescribeDeliveryStream, +firehose:StartDeliveryStreamEncryption, +firehose:StopDeliveryStreamEncryption, +firehose:ListTagsForDeliveryStream, +firehose:TagDeliveryStream, +firehose:UntagDeliveryStream, +kms:CreateGrant, +kms:RevokeGrant, +kms:DescribeKey +``` + +### Delete +```json +firehose:DeleteDeliveryStream, +firehose:DescribeDeliveryStream, +kms:RevokeGrant, +kms:DescribeKey +``` + diff --git a/docs/aws-docs/providers/aws/kinesisfirehose/delivery_streams/index.md b/docs/aws-docs/providers/aws/kinesisfirehose/delivery_streams/index.md new file mode 100644 index 0000000000..2d7ae7688d --- /dev/null +++ b/docs/aws-docs/providers/aws/kinesisfirehose/delivery_streams/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionResource Type definition for AWS::KinesisFirehose::DeliveryStream
Idaws.kinesisfirehose.delivery_streams
+ +## Fields + + + + + +
NameDatatypeDescription
delivery_stream_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +delivery_stream_name +FROM aws.kinesisfirehose.delivery_streams +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the delivery_streams resource, the following permissions are required: + +### Create +```json +firehose:CreateDeliveryStream, +firehose:DescribeDeliveryStream, +iam:GetRole, +iam:PassRole, +kms:CreateGrant, +kms:DescribeKey +``` + +### List +```json +firehose:ListDeliveryStreams +``` + diff --git a/docs/aws-docs/providers/aws/kinesisfirehose/index.md b/docs/aws-docs/providers/aws/kinesisfirehose/index.md new file mode 100644 index 0000000000..570f730a5d --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/kinesisvideo/index.md b/docs/aws-docs/providers/aws/kinesisvideo/index.md new file mode 100644 index 0000000000..9b5654a4f0 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/kinesisvideo/kinesisvideo_stream/index.md b/docs/aws-docs/providers/aws/kinesisvideo/kinesisvideo_stream/index.md new file mode 100644 index 0000000000..6e1ade6c12 --- /dev/null +++ b/docs/aws-docs/providers/aws/kinesisvideo/kinesisvideo_stream/index.md @@ -0,0 +1,102 @@ +--- +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
DescriptionResource Type Definition for AWS::KinesisVideo::Stream
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +name, +data_retention_in_hours, +device_name, +kms_key_id, +media_type, +tags +FROM aws.kinesisvideo.kinesisvideo_stream +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the kinesisvideo_stream resource, the following permissions are required: + +### Read +```json +kinesisvideo:DescribeStream +``` + +### Update +```json +kinesisvideo:DescribeStream, +kinesisvideo:UpdateStream, +kinesisvideo:UpdateDataRetention +``` + +### Delete +```json +kinesisvideo:DescribeStream, +kinesisvideo:DeleteStream +``` + diff --git a/docs/aws-docs/providers/aws/kinesisvideo/signaling_channel/index.md b/docs/aws-docs/providers/aws/kinesisvideo/signaling_channel/index.md new file mode 100644 index 0000000000..e7f9725f71 --- /dev/null +++ b/docs/aws-docs/providers/aws/kinesisvideo/signaling_channel/index.md @@ -0,0 +1,97 @@ +--- +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
DescriptionResource Type Definition for AWS::KinesisVideo::SignalingChannel
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +name, +type, +message_ttl_seconds, +tags +FROM aws.kinesisvideo.signaling_channel +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the signaling_channel resource, the following permissions are required: + +### Read +```json +kinesisvideo:DescribeSignalingChannel +``` + +### Update +```json +kinesisvideo:UpdateSignalingChannel, +kinesisvideo:DescribeSignalingChannel +``` + +### Delete +```json +kinesisvideo:DeleteSignalingChannel, +kinesisvideo:DescribeSignalingChannel +``` + diff --git a/docs/aws-docs/providers/aws/kinesisvideo/signaling_channels/index.md b/docs/aws-docs/providers/aws/kinesisvideo/signaling_channels/index.md new file mode 100644 index 0000000000..ea3abb13b3 --- /dev/null +++ b/docs/aws-docs/providers/aws/kinesisvideo/signaling_channels/index.md @@ -0,0 +1,68 @@ +--- +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
DescriptionResource Type Definition for AWS::KinesisVideo::SignalingChannel
Idaws.kinesisvideo.signaling_channels
+ +## Fields + + + + + +
NameDatatypeDescription
namestringThe name of the Kinesis Video Signaling Channel.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.kinesisvideo.signaling_channels +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the signaling_channels resource, the following permissions are required: + +### Create +```json +kinesisvideo:CreateSignalingChannel, +kinesisvideo:DescribeSignalingChannel +``` + diff --git a/docs/aws-docs/providers/aws/kinesisvideo/streams/index.md b/docs/aws-docs/providers/aws/kinesisvideo/streams/index.md new file mode 100644 index 0000000000..17396da3cc --- /dev/null +++ b/docs/aws-docs/providers/aws/kinesisvideo/streams/index.md @@ -0,0 +1,68 @@ +--- +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
DescriptionResource Type Definition for AWS::KinesisVideo::Stream
Idaws.kinesisvideo.streams
+ +## Fields + + + + + +
NameDatatypeDescription
namestringThe name of the Kinesis Video stream.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.kinesisvideo.streams +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the streams resource, the following permissions are required: + +### Create +```json +kinesisvideo:DescribeStream, +kinesisvideo:CreateStream +``` + diff --git a/docs/aws-docs/providers/aws/kms/alias/index.md b/docs/aws-docs/providers/aws/kms/alias/index.md new file mode 100644 index 0000000000..d7ff979c7e --- /dev/null +++ b/docs/aws-docs/providers/aws/kms/alias/index.md @@ -0,0 +1,89 @@ +--- +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
DescriptionThe ``AWS::KMS::Alias`` resource specifies a display name for a [KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys). You can use an alias to identify a KMS key in the KMS console, in the [DescribeKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html) operation, and in [cryptographic operations](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations), such as [Decrypt](https://docs.aws.amazon.com/kms/latest/APIReference/API_Decrypt.html) and [GenerateDataKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateDataKey.html).<br/> Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see [ABAC for](https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the *Developer Guide*.<br/> Using an alias to refer to a KMS key can help you simplify key management. For example, an alias in your code can be associated with different KMS keys i
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +target_key_id, +alias_name +FROM aws.kms.alias +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the alias resource, the following permissions are required: + +### Read +```json +kms:ListAliases +``` + +### Update +```json +kms:UpdateAlias +``` + +### Delete +```json +kms:DeleteAlias +``` + diff --git a/docs/aws-docs/providers/aws/kms/aliases/index.md b/docs/aws-docs/providers/aws/kms/aliases/index.md new file mode 100644 index 0000000000..4f90c6a1e4 --- /dev/null +++ b/docs/aws-docs/providers/aws/kms/aliases/index.md @@ -0,0 +1,77 @@ +--- +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
DescriptionThe ``AWS::KMS::Alias`` resource specifies a display name for a [KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys). You can use an alias to identify a KMS key in the KMS console, in the [DescribeKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html) operation, and in [cryptographic operations](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations), such as [Decrypt](https://docs.aws.amazon.com/kms/latest/APIReference/API_Decrypt.html) and [GenerateDataKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateDataKey.html).<br/> Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see [ABAC for](https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the *Developer Guide*.<br/> Using an alias to refer to a KMS key can help you simplify key management. For example, an alias in your code can be associated with different KMS keys i
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +alias_name +FROM aws.kms.aliases +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the aliases resource, the following permissions are required: + +### Create +```json +kms:CreateAlias +``` + +### List +```json +kms:ListAliases +``` + diff --git a/docs/aws-docs/providers/aws/kms/index.md b/docs/aws-docs/providers/aws/kms/index.md new file mode 100644 index 0000000000..7bea727de3 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/kms/key/index.md b/docs/aws-docs/providers/aws/kms/key/index.md new file mode 100644 index 0000000000..fb61b17fee --- /dev/null +++ b/docs/aws-docs/providers/aws/kms/key/index.md @@ -0,0 +1,126 @@ +--- +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
DescriptionThe ``AWS::KMS::Key`` resource specifies an [KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys) in KMSlong. You can use this resource to create symmetric encryption KMS keys, asymmetric KMS keys for encryption or signing, and symmetric HMAC KMS keys. You can use ``AWS::KMS::Key`` to create [multi-Region primary keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html#mrk-primary-key) of all supported types. To replicate a multi-Region key, use the ``AWS::KMS::ReplicaKey`` resource.<br/> If you change the value of the ``KeySpec``, ``KeyUsage``, ``Origin``, or ``MultiRegion`` properties of an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing any of its immutable property values.<br/> KMS replaced the term *customer master key (CMK)* with ** and *KMS key*. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.<br/> You can use symmetric encryption KMS keys to encrypt and decrypt small amounts of data, but they are more commonly used to generate data keys and data key pairs. You can also use a symmetric encryption KMS key to encrypt data stored in AWS services that are [integrated with](https://docs.aws.amazon.com//kms/features/#AWS_Service_Integration). For more information, see [Symmetric encryption KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#symmetric-cmks) in the *Developer Guide*.<br/> You can use asymmetric KMS keys to encrypt and decrypt data or sign messages and verify signatures. To create an asymmetric key, you must specify an asymmetric ``KeySpec`` value and a ``KeyUsage`` value. For details, see [Asymmetric keys in](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) in the *Developer Guide*.<br/> You can use HMAC KMS keys (which are also symmetric keys) to generate and verify hash-based message authentication codes. To create an HMAC key, you must specify an HMAC ``KeySpec`` value and a ``KeyUsage`` value of ``GENERATE_VERIFY_MAC``. For details, see [HMAC keys in](https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html) in the *Developer Guide*.<br/> You can also create symmetric encryption, asymmetric, and HMAC multi-Region primary keys. To create a multi-Region primary key, set the ``MultiRegion`` property to ``true``. For information about multi-Region keys, see [Multi-Region keys in](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *Developer Guide*.<br/> You cannot use the ``AWS::KMS::Key`` resource to specify a KMS key with [imported key material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) or a KMS key in a [custom key store](https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html).<br/> *Regions*<br/> KMS CloudFormation resources are available in all Regions in which KMS and CFN are supported. You can use the ``AWS::KMS::Key`` resource to create and manage all KMS key types that are supported in a Region.
Idaws.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. For detailed information about automatic key rotation, see [Rotating KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) in the *Developer Guide*.
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 [Changes that I make are not always immediately visible](https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency) in the *User Guide*.<br/> <br/> If you do not provide a key policy, KMS attaches a default key policy to the KMS key. For more information, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default) in the *Developer Guide*.<br/> A key policy document can include only the following characters:<br/> + Printable ASCII characters<br/> + Printable characters in the Basic Latin and Latin-1 Supplement character set<br/> + The tab (``\u0009``), line feed (``\u000A``), and carriage return (``\u000D``) special characters<br/> <br/> *Minimum*: ``1``<br/> *Maximum*: ``32768``
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 ``SIGN_VERIFY``.<br/> + For asymmetric KMS keys with SM2 (China Regions only) key material, specify ``ENCRYPT_DECRYPT`` or ``SIGN_VERIFY``.<br/> + For HMAC KMS keys, specify ``GENERATE_VERIFY_MAC``.
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 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/> [services that are integrated with](https://docs.aws.amazon.com/kms/features/#AWS_Service_Integration) use symmetric encryption KMS keys to protect your data. These services do not support encryption with asymmetric KMS keys. For help determining whether a KMS key is asymmetric, see [Identifying asymmetric KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/find-symm-asymm.html) in the *Developer Guide*.<br/> KMS supports the following key specs for KMS keys:<br/> + Symmetric encryption key (default)<br/> + ``SYMMETRIC_DEFAULT`` (AES-256-GCM)<br/> <br/> + HMAC keys (symmetric)<br/> + ``HMAC_224`` <br/> + ``HMAC_256`` <br/> + ``HMAC_384`` <br/> + ``HMAC_512`` <br/> <br/> + Asymmetric RSA key pairs<br/> + ``RSA_2048`` <br/> + ``RSA_3072`` <br/> + ``RSA_4096`` <br/> <br/> + Asymmetric NIST-recommended elliptic curve key pairs<br/> + ``ECC_NIST_P256`` (secp256r1)<br/> + ``ECC_NIST_P384`` (secp384r1)<br/> + ``ECC_NIST_P521`` (secp521r1)<br/> <br/> + Other asymmetric elliptic curve key pairs<br/> + ``ECC_SECG_P256K1`` (secp256k1), commonly used for cryptocurrencies.<br/> <br/> + SM2 key pairs (China Regions only)<br/> + ``SM2``
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. Because these KMS keys have the same key ID, key material, and other metadata, you can use them to encrypt data in one AWS-Region and decrypt it in a different AWS-Region without making a cross-Region call or exposing the plaintext data. For more information, see [Multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *Developer Guide*.<br/> You can create a symmetric encryption, HMAC, or asymmetric multi-Region KMS key, and you can create a multi-Region key with imported key material. However, you cannot create a multi-Region key in a custom key store.<br/> To create a replica of this primary key in a different AWS-Region , create an [AWS::KMS::ReplicaKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html) resource in a CloudFormation stack in the replica Region. Specify the key ARN of this primary key.
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 operations. This state can persist indefinitely. When the last of its replica keys is deleted, the key state of the primary key changes to ``PendingDeletion`` and the waiting period specified by ``PendingWindowInDays`` begins. When this waiting period expires, KMS deletes the primary key. For details, see [Deleting multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html) in the *Developer Guide*.<br/> You cannot use a CloudFormation template to cancel deletion of the KMS key after you remove it from the stack, regardless of the waiting period. If you specify a KMS key in your template, even one with the same name, CloudFormation creates a new KMS key. To cancel deletion of a KMS key, use the KMS console or the [CancelKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_CancelKeyDeletion.html) operation.<br/> For information about the ``Pending Deletion`` and ``Pending Replica Deletion`` key states, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *Developer Guide*. For more information about deleting KMS keys, see the [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operation in the *API Reference* and [Deleting KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html) in the *Developer Guide*.
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.
rotation_period_in_daysinteger
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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, +rotation_period_in_days +FROM aws.kms.key +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the key resource, the following permissions are required: + +### Read +```json +kms:DescribeKey, +kms:GetKeyPolicy, +kms:GetKeyRotationStatus, +kms:ListResourceTags +``` + +### Update +```json +kms:DescribeKey, +kms:DisableKey, +kms:DisableKeyRotation, +kms:EnableKey, +kms:EnableKeyRotation, +kms:PutKeyPolicy, +kms:TagResource, +kms:UntagResource, +kms:UpdateKeyDescription, +kms:ListResourceTags +``` + +### Delete +```json +kms:DescribeKey, +kms:ScheduleKeyDeletion +``` + diff --git a/docs/aws-docs/providers/aws/kms/keys/index.md b/docs/aws-docs/providers/aws/kms/keys/index.md new file mode 100644 index 0000000000..49deab0a90 --- /dev/null +++ b/docs/aws-docs/providers/aws/kms/keys/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionThe ``AWS::KMS::Key`` resource specifies an [KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys) in KMSlong. You can use this resource to create symmetric encryption KMS keys, asymmetric KMS keys for encryption or signing, and symmetric HMAC KMS keys. You can use ``AWS::KMS::Key`` to create [multi-Region primary keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html#mrk-primary-key) of all supported types. To replicate a multi-Region key, use the ``AWS::KMS::ReplicaKey`` resource.<br/> If you change the value of the ``KeySpec``, ``KeyUsage``, ``Origin``, or ``MultiRegion`` properties of an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing any of its immutable property values.<br/> KMS replaced the term *customer master key (CMK)* with ** and *KMS key*. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.<br/> You can use symmetric encryption KMS keys to encrypt and decrypt small amounts of data, but they are more commonly used to generate data keys and data key pairs. You can also use a symmetric encryption KMS key to encrypt data stored in AWS services that are [integrated with](https://docs.aws.amazon.com//kms/features/#AWS_Service_Integration). For more information, see [Symmetric encryption KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#symmetric-cmks) in the *Developer Guide*.<br/> You can use asymmetric KMS keys to encrypt and decrypt data or sign messages and verify signatures. To create an asymmetric key, you must specify an asymmetric ``KeySpec`` value and a ``KeyUsage`` value. For details, see [Asymmetric keys in](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) in the *Developer Guide*.<br/> You can use HMAC KMS keys (which are also symmetric keys) to generate and verify hash-based message authentication codes. To create an HMAC key, you must specify an HMAC ``KeySpec`` value and a ``KeyUsage`` value of ``GENERATE_VERIFY_MAC``. For details, see [HMAC keys in](https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html) in the *Developer Guide*.<br/> You can also create symmetric encryption, asymmetric, and HMAC multi-Region primary keys. To create a multi-Region primary key, set the ``MultiRegion`` property to ``true``. For information about multi-Region keys, see [Multi-Region keys in](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *Developer Guide*.<br/> You cannot use the ``AWS::KMS::Key`` resource to specify a KMS key with [imported key material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) or a KMS key in a [custom key store](https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html).<br/> *Regions*<br/> KMS CloudFormation resources are available in all Regions in which KMS and CFN are supported. You can use the ``AWS::KMS::Key`` resource to create and manage all KMS key types that are supported in a Region.
Idaws.kms.keys
+ +## Fields + + + + + +
NameDatatypeDescription
key_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +key_id +FROM aws.kms.keys +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the keys resource, the following permissions are required: + +### Create +```json +kms:CreateKey, +kms:EnableKeyRotation, +kms:DisableKey, +kms:TagResource, +kms:PutKeyPolicy +``` + +### List +```json +kms:ListKeys, +kms:DescribeKey +``` + diff --git a/docs/aws-docs/providers/aws/kms/replica_key/index.md b/docs/aws-docs/providers/aws/kms/replica_key/index.md new file mode 100644 index 0000000000..7d74c310ce --- /dev/null +++ b/docs/aws-docs/providers/aws/kms/replica_key/index.md @@ -0,0 +1,110 @@ +--- +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
DescriptionThe AWS::KMS::ReplicaKey resource specifies a multi-region replica AWS KMS key in AWS Key Management Service (AWS KMS).
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +description, +pending_window_in_days, +key_policy, +primary_key_arn, +enabled, +key_id, +arn, +tags +FROM aws.kms.replica_key +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the replica_key resource, the following permissions are required: + +### Read +```json +kms:DescribeKey, +kms:GetKeyPolicy, +kms:ListResourceTags +``` + +### Update +```json +kms:DescribeKey, +kms:DisableKey, +kms:EnableKey, +kms:PutKeyPolicy, +kms:TagResource, +kms:UntagResource, +kms:UpdateKeyDescription +``` + +### Delete +```json +kms:DescribeKey, +kms:ScheduleKeyDeletion +``` + diff --git a/docs/aws-docs/providers/aws/kms/replica_keys/index.md b/docs/aws-docs/providers/aws/kms/replica_keys/index.md new file mode 100644 index 0000000000..77f3ca5cad --- /dev/null +++ b/docs/aws-docs/providers/aws/kms/replica_keys/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionThe AWS::KMS::ReplicaKey resource specifies a multi-region replica AWS KMS key in AWS Key Management Service (AWS KMS).
Idaws.kms.replica_keys
+ +## Fields + + + + + +
NameDatatypeDescription
key_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +key_id +FROM aws.kms.replica_keys +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the replica_keys resource, the following permissions are required: + +### Create +```json +kms:ReplicateKey, +kms:CreateKey, +kms:DescribeKey, +kms:DisableKey, +kms:TagResource +``` + +### List +```json +kms:ListKeys, +kms:DescribeKey +``` + diff --git a/docs/aws-docs/providers/aws/lakeformation/data_cells_filter/index.md b/docs/aws-docs/providers/aws/lakeformation/data_cells_filter/index.md new file mode 100644 index 0000000000..a4a64f5bd1 --- /dev/null +++ b/docs/aws-docs/providers/aws/lakeformation/data_cells_filter/index.md @@ -0,0 +1,89 @@ +--- +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
DescriptionA resource schema representing a Lake Formation Data Cells Filter.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +table_catalog_id, +database_name, +table_name, +name, +row_filter, +column_names, +column_wildcard +FROM aws.lakeformation.data_cells_filter +WHERE data__Identifier = '|||'; +``` + +## Permissions + +To operate on the data_cells_filter resource, the following permissions are required: + +### Delete +```json +lakeformation:DeleteDataCellsFilter +``` + +### Read +```json +lakeformation:ListDataCellsFilter +``` + diff --git a/docs/aws-docs/providers/aws/lakeformation/data_cells_filters/index.md b/docs/aws-docs/providers/aws/lakeformation/data_cells_filters/index.md new file mode 100644 index 0000000000..93ff221217 --- /dev/null +++ b/docs/aws-docs/providers/aws/lakeformation/data_cells_filters/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionA resource schema representing a Lake Formation Data Cells Filter.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +table_catalog_id, +database_name, +table_name, +name +FROM aws.lakeformation.data_cells_filters +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the data_cells_filters resource, the following permissions are required: + +### Create +```json +lakeformation:CreateDataCellsFilter, +glue:GetTable +``` + +### List +```json +lakeformation:ListDataCellsFilter +``` + diff --git a/docs/aws-docs/providers/aws/lakeformation/index.md b/docs/aws-docs/providers/aws/lakeformation/index.md new file mode 100644 index 0000000000..f758b30673 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/lakeformation/principal_permissions/index.md b/docs/aws-docs/providers/aws/lakeformation/principal_permissions/index.md new file mode 100644 index 0000000000..4963f5c0da --- /dev/null +++ b/docs/aws-docs/providers/aws/lakeformation/principal_permissions/index.md @@ -0,0 +1,94 @@ +--- +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
DescriptionThe ``AWS::LakeFormation::PrincipalPermissions`` resource represents the permissions that a principal has on a GLUDC resource (such as GLUlong databases or GLUlong tables). When you create a ``PrincipalPermissions`` resource, the permissions are granted via the LFlong ``GrantPermissions`` API operation. When you delete a ``PrincipalPermissions`` resource, the permissions on principal-resource pair are revoked via the LFlong ``RevokePermissions`` API operation.
Idaws.lakeformation.principal_permissions
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
catalogstringThe identifier for the GLUDC. By default, the account ID. The GLUDC is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
principalobjectThe principal to be granted a permission.
resourceobjectThe resource to be granted or revoked permissions.
permissionsarrayThe permissions granted or revoked.
permissions_with_grant_optionarrayIndicates the ability to grant permissions (as a subset of permissions granted).
principal_identifierstring
resource_identifierstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +catalog, +principal, +resource, +permissions, +permissions_with_grant_option, +principal_identifier, +resource_identifier +FROM aws.lakeformation.principal_permissions +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the principal_permissions resource, the following permissions are required: + +### Read +```json +lakeformation:ListPermissions, +glue:GetTable, +glue:GetDatabase +``` + +### Delete +```json +lakeformation:RevokePermissions, +lakeformation:ListPermissions, +glue:GetTable, +glue:GetDatabase +``` + diff --git a/docs/aws-docs/providers/aws/lakeformation/tag/index.md b/docs/aws-docs/providers/aws/lakeformation/tag/index.md new file mode 100644 index 0000000000..5a67dc1090 --- /dev/null +++ b/docs/aws-docs/providers/aws/lakeformation/tag/index.md @@ -0,0 +1,91 @@ +--- +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
DescriptionA resource schema representing a Lake Formation Tag.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +catalog_id, +tag_key, +tag_values +FROM aws.lakeformation.tag +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the tag resource, the following permissions are required: + +### Read +```json +lakeformation:GetLFTag +``` + +### Update +```json +lakeformation:UpdateLFTag +``` + +### Delete +```json +lakeformation:DeleteLFTag +``` + diff --git a/docs/aws-docs/providers/aws/lakeformation/tag_association/index.md b/docs/aws-docs/providers/aws/lakeformation/tag_association/index.md new file mode 100644 index 0000000000..867aa32e5c --- /dev/null +++ b/docs/aws-docs/providers/aws/lakeformation/tag_association/index.md @@ -0,0 +1,87 @@ +--- +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
DescriptionA resource schema representing a Lake Formation Tag Association. While tag associations are not explicit Lake Formation resources, this CloudFormation resource can be used to associate tags with Lake Formation entities.
Idaws.lakeformation.tag_association
+ +## Fields + + + + + + + + +
NameDatatypeDescription
resourceobjectResource to tag with the Lake Formation Tags
lf_tagsarrayList 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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +resource, +lf_tags, +resource_identifier, +tags_identifier +FROM aws.lakeformation.tag_association +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the tag_association resource, the following permissions are required: + +### Read +```json +lakeformation:GetResourceLFTags, +glue:GetDatabase, +glue:GetTable +``` + +### Delete +```json +lakeformation:RemoveLFTagsFromResource, +glue:GetDatabase, +glue:GetTable +``` + diff --git a/docs/aws-docs/providers/aws/lakeformation/tag_associations/index.md b/docs/aws-docs/providers/aws/lakeformation/tag_associations/index.md new file mode 100644 index 0000000000..d8df5cbbcc --- /dev/null +++ b/docs/aws-docs/providers/aws/lakeformation/tag_associations/index.md @@ -0,0 +1,71 @@ +--- +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
DescriptionA resource schema representing a Lake Formation Tag Association. While tag associations are not explicit Lake Formation resources, this CloudFormation resource can be used to associate tags with Lake Formation entities.
Idaws.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 + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +resource_identifier, +tags_identifier +FROM aws.lakeformation.tag_associations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the tag_associations resource, the following permissions are required: + +### Create +```json +lakeformation:AddLFTagsToResource, +glue:GetDatabase, +glue:GetTable +``` + diff --git a/docs/aws-docs/providers/aws/lakeformation/tags/index.md b/docs/aws-docs/providers/aws/lakeformation/tags/index.md new file mode 100644 index 0000000000..4e8361a61c --- /dev/null +++ b/docs/aws-docs/providers/aws/lakeformation/tags/index.md @@ -0,0 +1,77 @@ +--- +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
DescriptionA resource schema representing a Lake Formation Tag.
Idaws.lakeformation.tags
+ +## Fields + + + + + +
NameDatatypeDescription
tag_keyundefinedThe key-name for the LF-tag.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +tag_key +FROM aws.lakeformation.tags +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the tags resource, the following permissions are required: + +### Create +```json +lakeformation:CreateLFTag +``` + +### List +```json +lakeformation:ListLFTags +``` + diff --git a/docs/aws-docs/providers/aws/lambda/code_signing_config/index.md b/docs/aws-docs/providers/aws/lambda/code_signing_config/index.md new file mode 100644 index 0000000000..d0f09ee5b0 --- /dev/null +++ b/docs/aws-docs/providers/aws/lambda/code_signing_config/index.md @@ -0,0 +1,95 @@ +--- +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
DescriptionResource Type definition for AWS::Lambda::CodeSigningConfig.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +description, +allowed_publishers, +code_signing_policies, +code_signing_config_id, +code_signing_config_arn +FROM aws.lambda.code_signing_config +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the code_signing_config resource, the following permissions are required: + +### Read +```json +lambda:GetCodeSigningConfig +``` + +### Update +```json +lambda:UpdateCodeSigningConfig +``` + +### Delete +```json +lambda:DeleteCodeSigningConfig +``` + diff --git a/docs/aws-docs/providers/aws/lambda/code_signing_configs/index.md b/docs/aws-docs/providers/aws/lambda/code_signing_configs/index.md new file mode 100644 index 0000000000..e0335de690 --- /dev/null +++ b/docs/aws-docs/providers/aws/lambda/code_signing_configs/index.md @@ -0,0 +1,77 @@ +--- +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
DescriptionResource Type definition for AWS::Lambda::CodeSigningConfig.
Idaws.lambda.code_signing_configs
+ +## Fields + + + + + +
NameDatatypeDescription
code_signing_config_arnstringA unique Arn for CodeSigningConfig resource
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +code_signing_config_arn +FROM aws.lambda.code_signing_configs +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the code_signing_configs resource, the following permissions are required: + +### Create +```json +lambda:CreateCodeSigningConfig +``` + +### List +```json +lambda:ListCodeSigningConfigs +``` + diff --git a/docs/aws-docs/providers/aws/lambda/event_invoke_config/index.md b/docs/aws-docs/providers/aws/lambda/event_invoke_config/index.md new file mode 100644 index 0000000000..a482317f73 --- /dev/null +++ b/docs/aws-docs/providers/aws/lambda/event_invoke_config/index.md @@ -0,0 +1,95 @@ +--- +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
DescriptionThe AWS::Lambda::EventInvokeConfig resource configures options for asynchronous invocation on a version or an alias.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +destination_config, +function_name, +maximum_event_age_in_seconds, +maximum_retry_attempts, +qualifier +FROM aws.lambda.event_invoke_config +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the event_invoke_config resource, the following permissions are required: + +### Read +```json +lambda:GetFunctionEventInvokeConfig +``` + +### Update +```json +lambda:UpdateFunctionEventInvokeConfig +``` + +### Delete +```json +lambda:DeleteFunctionEventInvokeConfig +``` + diff --git a/docs/aws-docs/providers/aws/lambda/event_invoke_configs/index.md b/docs/aws-docs/providers/aws/lambda/event_invoke_configs/index.md new file mode 100644 index 0000000000..2bfc85f8d9 --- /dev/null +++ b/docs/aws-docs/providers/aws/lambda/event_invoke_configs/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionThe AWS::Lambda::EventInvokeConfig resource configures options for asynchronous invocation on a version or an alias.
Idaws.lambda.event_invoke_configs
+ +## Fields + + + + + + +
NameDatatypeDescription
function_namestringThe name of the Lambda function.
qualifierstringThe identifier of a version or alias.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +function_name, +qualifier +FROM aws.lambda.event_invoke_configs +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the event_invoke_configs resource, the following permissions are required: + +### Create +```json +lambda:PutFunctionEventInvokeConfig +``` + +### List +```json +lambda:ListFunctionEventInvokeConfigs +``` + diff --git a/docs/aws-docs/providers/aws/lambda/event_source_mapping/index.md b/docs/aws-docs/providers/aws/lambda/event_source_mapping/index.md new file mode 100644 index 0000000000..e589d09977 --- /dev/null +++ b/docs/aws-docs/providers/aws/lambda/event_source_mapping/index.md @@ -0,0 +1,135 @@ +--- +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
DescriptionThe ``AWS::Lambda::EventSourceMapping`` resource creates a mapping between an event source and an LAMlong function. LAM reads items from the event source and triggers the function.<br/> For details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source. <br/> + [Configuring a Dynamo DB stream as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-dynamodb-eventsourcemapping)<br/> + [Configuring a Kinesis stream as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-eventsourcemapping)<br/> + [Configuring an SQS queue as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-eventsource)<br/> + [Configuring an MQ broker as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-mq.html#services-mq-eventsourcemapping)<br/> + [Configuring MSK as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html)<br/> + [Configuring Self-Managed Apache Kafka as an event source](https://docs.aws.amazon.com/lambda/latest/dg/kafka-smaa.html)<br/> + [Configuring Amazon DocumentDB as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-documentdb.html)
Idaws.lambda.event_source_mapping
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
idstring
batch_sizeintegerThe maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).<br/> + *Amazon Kinesis* – Default 100. Max 10,000.<br/> + *Amazon DynamoDB Streams* – Default 100. Max 10,000.<br/> + *Amazon Simple Queue Service* – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.<br/> + *Amazon Managed Streaming for Apache Kafka* – Default 100. Max 10,000.<br/> + *Self-managed Apache Kafka* – Default 100. Max 10,000.<br/> + *Amazon MQ (ActiveMQ and RabbitMQ)* – Default 100. Max 10,000.<br/> + *DocumentDB* – Default 100. Max 10,000.
bisect_batch_on_function_errorboolean(Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. The default value is false.
destination_configobject(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka event sources only) A configuration object that specifies the destination of an event after Lambda processes it.
enabledbooleanWhen true, the event source mapping is active. When false, Lambda pauses polling and invocation.<br/> Default: True
event_source_arnstringThe Amazon Resource Name (ARN) of the event source.<br/> + *Amazon Kinesis* – The ARN of the data stream or a stream consumer.<br/> + *Amazon DynamoDB Streams* – The ARN of the stream.<br/> + *Amazon Simple Queue Service* – The ARN of the queue.<br/> + *Amazon Managed Streaming for Apache Kafka* – The ARN of the cluster or the ARN of the VPC connection (for [cross-account event source mappings](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#msk-multi-vpc)).<br/> + *Amazon MQ* – The ARN of the broker.<br/> + *Amazon DocumentDB* – The ARN of the DocumentDB change stream.
filter_criteriaobjectAn object that defines the filter criteria that determine whether Lambda should process an event. For more information, see [Lambda event filtering](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html).
function_namestringThe name or ARN of the Lambda function.<br/> **Name formats**<br/> + *Function name* – ``MyFunction``.<br/> + *Function ARN* – ``arn:aws:lambda:us-west-2:123456789012:function:MyFunction``.<br/> + *Version or Alias ARN* – ``arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD``.<br/> + *Partial ARN* – ``123456789012:function:MyFunction``.<br/> <br/> The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.
maximum_batching_window_in_secondsintegerThe maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.<br/> *Default (, , event sources)*: 0<br/> *Default (, Kafka, , event sources)*: 500 ms<br/> *Related setting:* For SQS event sources, when you set ``BatchSize`` to a value greater than 10, you must set ``MaximumBatchingWindowInSeconds`` to at least 1.
maximum_record_age_in_secondsinteger(Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.<br/> The minimum valid value for maximum record age is 60s. Although values less than 60 and greater than -1 fall within the parameter's absolute range, they are not allowed
maximum_retry_attemptsinteger(Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source.
parallelization_factorinteger(Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1.
starting_positionstringThe position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB.<br/> + *LATEST* - Read only new records.<br/> + *TRIM_HORIZON* - Process all available records.<br/> + *AT_TIMESTAMP* - Specify a time from which to start reading records.
starting_position_timestampnumberWith ``StartingPosition`` set to ``AT_TIMESTAMP``, the time from which to start reading, in Unix time seconds. ``StartingPositionTimestamp`` cannot be in the future.
topicsarrayThe name of the Kafka topic.
queuesarray(Amazon MQ) The name of the Amazon MQ broker destination queue to consume.
source_access_configurationsarrayAn array of the authentication protocol, VPC components, or virtual host to secure and define your event source.
tumbling_window_in_secondsinteger(Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window.
function_response_typesarray(Streams and SQS) A list of current response type enums applied to the event source mapping.<br/> Valid Values: ``ReportBatchItemFailures``
self_managed_event_sourceobjectThe self-managed Apache Kafka cluster for your event source.
amazon_managed_kafka_event_source_configobjectSpecific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.
self_managed_kafka_event_source_configobjectSpecific configuration settings for a self-managed Apache Kafka event source.
scaling_configobject(Amazon SQS only) The scaling configuration for the event source. For more information, see [Configuring maximum concurrency for Amazon SQS event sources](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-max-concurrency).
document_db_event_source_configobjectSpecific configuration settings for a DocumentDB event source.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.lambda.event_source_mapping +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the event_source_mapping resource, the following permissions are required: + +### Delete +```json +lambda:DeleteEventSourceMapping, +lambda:GetEventSourceMapping +``` + +### Read +```json +lambda:GetEventSourceMapping +``` + +### Update +```json +lambda:UpdateEventSourceMapping, +lambda:GetEventSourceMapping +``` + diff --git a/docs/aws-docs/providers/aws/lambda/event_source_mappings/index.md b/docs/aws-docs/providers/aws/lambda/event_source_mappings/index.md new file mode 100644 index 0000000000..2ea037be3c --- /dev/null +++ b/docs/aws-docs/providers/aws/lambda/event_source_mappings/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionThe ``AWS::Lambda::EventSourceMapping`` resource creates a mapping between an event source and an LAMlong function. LAM reads items from the event source and triggers the function.<br/> For details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source. <br/> + [Configuring a Dynamo DB stream as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-dynamodb-eventsourcemapping)<br/> + [Configuring a Kinesis stream as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-eventsourcemapping)<br/> + [Configuring an SQS queue as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-eventsource)<br/> + [Configuring an MQ broker as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-mq.html#services-mq-eventsourcemapping)<br/> + [Configuring MSK as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html)<br/> + [Configuring Self-Managed Apache Kafka as an event source](https://docs.aws.amazon.com/lambda/latest/dg/kafka-smaa.html)<br/> + [Configuring Amazon DocumentDB as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-documentdb.html)
Idaws.lambda.event_source_mappings
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.lambda.event_source_mappings +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the event_source_mappings resource, the following permissions are required: + +### Create +```json +lambda:CreateEventSourceMapping, +lambda:GetEventSourceMapping +``` + +### List +```json +lambda:ListEventSourceMappings +``` + diff --git a/docs/aws-docs/providers/aws/lambda/function/index.md b/docs/aws-docs/providers/aws/lambda/function/index.md new file mode 100644 index 0000000000..743df09ad3 --- /dev/null +++ b/docs/aws-docs/providers/aws/lambda/function/index.md @@ -0,0 +1,171 @@ +--- +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
DescriptionThe ``AWS::Lambda::Function`` resource creates a Lambda function. To create a function, you need a [deployment package](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html) and an [execution role](https://docs.aws.amazon.com/lambda/latest/dg/lambda-intro-execution-role.html). The deployment package is a .zip file archive or container image that contains your function code. The execution role grants the function permission to use AWS services, such as Amazon CloudWatch Logs for log streaming and AWS X-Ray for request tracing.<br/> You set the package type to ``Image`` if the deployment package is a [container image](https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html). For a container image, the code property must include the URI of a container image in the Amazon ECR registry. You do not need to specify the handler and runtime properties. <br/> You set the package type to ``Zip`` if the deployment package is a [.zip file archive](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html#gettingstarted-package-zip). For a .zip file archive, the code property specifies the location of the .zip file. You must also specify the handler and runtime properties. For a Python example, see [Deploy Python Lambda functions with .zip file archives](https://docs.aws.amazon.com/lambda/latest/dg/python-package.html).<br/> You can use [code signing](https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html) if your deployment package is a .zip file archive. To enable code signing for this function, specify the ARN of a code-signing configuration. When a user attempts to deploy a code package with ``UpdateFunctionCode``, Lambda checks that the code package has a valid signature from a trusted publisher. The code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function.<br/> Note that you configure [provisioned concurrency](https://docs.aws.amazon.com/lambda/latest/dg/provisioned-concurrency.html) on a ``AWS::Lambda::Version`` or a ``AWS::Lambda::Alias``.<br/> For a complete introduction to Lambda functions, see [What is Lambda?](https://docs.aws.amazon.com/lambda/latest/dg/lambda-welcome.html) in the *Lambda developer guide.*
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.lambda.function +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the function resource, the following permissions are required: + +### Read +```json +lambda:GetFunction, +lambda:GetFunctionCodeSigningConfig +``` + +### Update +```json +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 +```json +lambda:DeleteFunction, +lambda:GetFunction, +ec2:DescribeNetworkInterfaces +``` + diff --git a/docs/aws-docs/providers/aws/lambda/functions/index.md b/docs/aws-docs/providers/aws/lambda/functions/index.md new file mode 100644 index 0000000000..7a0cc8b42e --- /dev/null +++ b/docs/aws-docs/providers/aws/lambda/functions/index.md @@ -0,0 +1,101 @@ +--- +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
DescriptionThe ``AWS::Lambda::Function`` resource creates a Lambda function. To create a function, you need a [deployment package](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html) and an [execution role](https://docs.aws.amazon.com/lambda/latest/dg/lambda-intro-execution-role.html). The deployment package is a .zip file archive or container image that contains your function code. The execution role grants the function permission to use AWS services, such as Amazon CloudWatch Logs for log streaming and AWS X-Ray for request tracing.<br/> You set the package type to ``Image`` if the deployment package is a [container image](https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html). For a container image, the code property must include the URI of a container image in the Amazon ECR registry. You do not need to specify the handler and runtime properties. <br/> You set the package type to ``Zip`` if the deployment package is a [.zip file archive](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html#gettingstarted-package-zip). For a .zip file archive, the code property specifies the location of the .zip file. You must also specify the handler and runtime properties. For a Python example, see [Deploy Python Lambda functions with .zip file archives](https://docs.aws.amazon.com/lambda/latest/dg/python-package.html).<br/> You can use [code signing](https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html) if your deployment package is a .zip file archive. To enable code signing for this function, specify the ARN of a code-signing configuration. When a user attempts to deploy a code package with ``UpdateFunctionCode``, Lambda checks that the code package has a valid signature from a trusted publisher. The code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function.<br/> Note that you configure [provisioned concurrency](https://docs.aws.amazon.com/lambda/latest/dg/provisioned-concurrency.html) on a ``AWS::Lambda::Version`` or a ``AWS::Lambda::Alias``.<br/> For a complete introduction to Lambda functions, see [What is Lambda?](https://docs.aws.amazon.com/lambda/latest/dg/lambda-welcome.html) in the *Lambda developer guide.*
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +function_name +FROM aws.lambda.functions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the functions resource, the following permissions are required: + +### Create +```json +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 +```json +lambda:ListFunctions +``` + diff --git a/docs/aws-docs/providers/aws/lambda/index.md b/docs/aws-docs/providers/aws/lambda/index.md new file mode 100644 index 0000000000..31d9a66e68 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/lambda/layer_version/index.md b/docs/aws-docs/providers/aws/lambda/layer_version/index.md new file mode 100644 index 0000000000..7db5c53575 --- /dev/null +++ b/docs/aws-docs/providers/aws/lambda/layer_version/index.md @@ -0,0 +1,90 @@ +--- +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
DescriptionResource Type definition for AWS::Lambda::LayerVersion
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +compatible_runtimes, +license_info, +description, +layer_name, +content, +layer_version_arn, +compatible_architectures +FROM aws.lambda.layer_version +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the layer_version resource, the following permissions are required: + +### Read +```json +lambda:GetLayerVersion +``` + +### Delete +```json +lambda:GetLayerVersion, +lambda:DeleteLayerVersion +``` + diff --git a/docs/aws-docs/providers/aws/lambda/layer_version_permission/index.md b/docs/aws-docs/providers/aws/lambda/layer_version_permission/index.md new file mode 100644 index 0000000000..e6ac184730 --- /dev/null +++ b/docs/aws-docs/providers/aws/lambda/layer_version_permission/index.md @@ -0,0 +1,86 @@ +--- +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
DescriptionSchema for Lambda LayerVersionPermission
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +action, +layer_version_arn, +organization_id, +principal +FROM aws.lambda.layer_version_permission +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the layer_version_permission resource, the following permissions are required: + +### Read +```json +lambda:GetLayerVersionPolicy +``` + +### Delete +```json +lambda:GetLayerVersionPolicy, +lambda:RemoveLayerVersionPermission +``` + diff --git a/docs/aws-docs/providers/aws/lambda/layer_version_permissions/index.md b/docs/aws-docs/providers/aws/lambda/layer_version_permissions/index.md new file mode 100644 index 0000000000..056215aacc --- /dev/null +++ b/docs/aws-docs/providers/aws/lambda/layer_version_permissions/index.md @@ -0,0 +1,77 @@ +--- +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
DescriptionSchema for Lambda LayerVersionPermission
Idaws.lambda.layer_version_permissions
+ +## Fields + + + + + +
NameDatatypeDescription
idstringID generated by service
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.lambda.layer_version_permissions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the layer_version_permissions resource, the following permissions are required: + +### Create +```json +lambda:AddLayerVersionPermission +``` + +### List +```json +lambda:GetLayerVersionPolicy +``` + diff --git a/docs/aws-docs/providers/aws/lambda/layer_versions/index.md b/docs/aws-docs/providers/aws/lambda/layer_versions/index.md new file mode 100644 index 0000000000..d68916f285 --- /dev/null +++ b/docs/aws-docs/providers/aws/lambda/layer_versions/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource Type definition for AWS::Lambda::LayerVersion
Idaws.lambda.layer_versions
+ +## Fields + + + + + +
NameDatatypeDescription
layer_version_arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +layer_version_arn +FROM aws.lambda.layer_versions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the layer_versions resource, the following permissions are required: + +### Create +```json +lambda:PublishLayerVersion, +s3:GetObject, +s3:GetObjectVersion +``` + +### List +```json +lambda:ListLayerVersions +``` + diff --git a/docs/aws-docs/providers/aws/lambda/permission/index.md b/docs/aws-docs/providers/aws/lambda/permission/index.md new file mode 100644 index 0000000000..ab49d1500b --- /dev/null +++ b/docs/aws-docs/providers/aws/lambda/permission/index.md @@ -0,0 +1,93 @@ +--- +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
DescriptionThe ``AWS::Lambda::Permission`` resource grants an AWS service or another account permission to use a function. You can apply the policy at the function level, or specify a qualifier to restrict access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name (ARN) of that version or alias to invoke the function.<br/> To grant permission to another account, specify the account ID as the ``Principal``. To grant permission to an organization defined in AOlong, specify the organization ID as the ``PrincipalOrgID``. For AWS services, the principal is a domain-style identifier defined by the service, like ``s3.amazonaws.com`` or ``sns.amazonaws.com``. For AWS services, you can also specify the ARN of the associated resource as the ``SourceArn``. If you grant permission to a service principal without specifying the source, other accounts could potentially configure resources in their account to invoke your Lambda function.<br/> If your function has a fu
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +action, +event_source_token, +function_name, +function_url_auth_type, +principal, +principal_org_id, +source_account, +source_arn +FROM aws.lambda.permission +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the permission resource, the following permissions are required: + +### Read +```json +lambda:GetPolicy +``` + +### Delete +```json +lambda:RemovePermission +``` + diff --git a/docs/aws-docs/providers/aws/lambda/permissions/index.md b/docs/aws-docs/providers/aws/lambda/permissions/index.md new file mode 100644 index 0000000000..d583257edb --- /dev/null +++ b/docs/aws-docs/providers/aws/lambda/permissions/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionThe ``AWS::Lambda::Permission`` resource grants an AWS service or another account permission to use a function. You can apply the policy at the function level, or specify a qualifier to restrict access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name (ARN) of that version or alias to invoke the function.<br/> To grant permission to another account, specify the account ID as the ``Principal``. To grant permission to an organization defined in AOlong, specify the organization ID as the ``PrincipalOrgID``. For AWS services, the principal is a domain-style identifier defined by the service, like ``s3.amazonaws.com`` or ``sns.amazonaws.com``. For AWS services, you can also specify the ARN of the associated resource as the ``SourceArn``. If you grant permission to a service principal without specifying the source, other accounts could potentially configure resources in their account to invoke your Lambda function.<br/> If your function has a fu
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +function_name, +id +FROM aws.lambda.permissions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the permissions resource, the following permissions are required: + +### Create +```json +lambda:AddPermission +``` + +### List +```json +lambda:GetPolicy +``` + diff --git a/docs/aws-docs/providers/aws/lambda/url/index.md b/docs/aws-docs/providers/aws/lambda/url/index.md new file mode 100644 index 0000000000..c565da6b3d --- /dev/null +++ b/docs/aws-docs/providers/aws/lambda/url/index.md @@ -0,0 +1,99 @@ +--- +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
DescriptionResource Type definition for AWS::Lambda::Url
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +target_function_arn, +qualifier, +auth_type, +invoke_mode, +function_arn, +function_url, +cors +FROM aws.lambda.url +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the url resource, the following permissions are required: + +### Read +```json +lambda:GetFunctionUrlConfig +``` + +### Update +```json +lambda:UpdateFunctionUrlConfig +``` + +### Delete +```json +lambda:DeleteFunctionUrlConfig +``` + diff --git a/docs/aws-docs/providers/aws/lambda/urls/index.md b/docs/aws-docs/providers/aws/lambda/urls/index.md new file mode 100644 index 0000000000..89b8abd898 --- /dev/null +++ b/docs/aws-docs/providers/aws/lambda/urls/index.md @@ -0,0 +1,77 @@ +--- +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
DescriptionResource Type definition for AWS::Lambda::Url
Idaws.lambda.urls
+ +## Fields + + + + + +
NameDatatypeDescription
function_arnstringThe full Amazon Resource Name (ARN) of the function associated with the Function URL.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +function_arn +FROM aws.lambda.urls +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the urls resource, the following permissions are required: + +### Create +```json +lambda:CreateFunctionUrlConfig +``` + +### List +```json +lambda:ListFunctionUrlConfigs +``` + diff --git a/docs/aws-docs/providers/aws/lambda/version/index.md b/docs/aws-docs/providers/aws/lambda/version/index.md new file mode 100644 index 0000000000..d5971f9aff --- /dev/null +++ b/docs/aws-docs/providers/aws/lambda/version/index.md @@ -0,0 +1,97 @@ +--- +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
DescriptionResource Type definition for AWS::Lambda::Version
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +function_arn, +version, +code_sha256, +description, +function_name, +provisioned_concurrency_config, +runtime_policy +FROM aws.lambda.version +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the version resource, the following permissions are required: + +### Read +```json +lambda:GetFunctionConfiguration, +lambda:GetProvisionedConcurrencyConfig, +lambda:GetRuntimeManagementConfig +``` + +### Delete +```json +lambda:GetFunctionConfiguration, +lambda:DeleteFunction +``` + diff --git a/docs/aws-docs/providers/aws/lambda/versions/index.md b/docs/aws-docs/providers/aws/lambda/versions/index.md new file mode 100644 index 0000000000..e4103068cc --- /dev/null +++ b/docs/aws-docs/providers/aws/lambda/versions/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionResource Type definition for AWS::Lambda::Version
Idaws.lambda.versions
+ +## Fields + + + + + +
NameDatatypeDescription
function_arnstringThe ARN of the version.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +function_arn +FROM aws.lambda.versions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the versions resource, the following permissions are required: + +### Create +```json +lambda:PublishVersion, +lambda:GetFunctionConfiguration, +lambda:PutProvisionedConcurrencyConfig, +lambda:GetProvisionedConcurrencyConfig, +lambda:PutRuntimeManagementConfig, +lambda:GetRuntimeManagementConfig +``` + +### List +```json +lambda:ListVersionsByFunction +``` + diff --git a/docs/aws-docs/providers/aws/lex/bot/index.md b/docs/aws-docs/providers/aws/lex/bot/index.md new file mode 100644 index 0000000000..a4fda6a41a --- /dev/null +++ b/docs/aws-docs/providers/aws/lex/bot/index.md @@ -0,0 +1,151 @@ +--- +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
DescriptionAmazon Lex conversational bot performing automated tasks such as ordering a pizza, booking a hotel, and so on.
Idaws.lex.bot
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
idstring
arnstring
namestring
descriptionstring
role_arnstring
data_privacyobjectData privacy setting of the Bot.
idle_session_ttl_in_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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +arn, +name, +description, +role_arn, +data_privacy, +idle_session_ttl_in_seconds, +bot_locales, +bot_file_s3_location, +bot_tags, +test_bot_alias_tags, +auto_build_bot_locales, +test_bot_alias_settings +FROM aws.lex.bot +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the bot resource, the following permissions are required: + +### Read +```json +lex:DescribeBot, +lex:ListTagsForResource +``` + +### Update +```json +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 +```json +lex:DeleteBot, +lex:DescribeBot, +lex:DeleteBotLocale, +lex:DeleteIntent, +lex:DeleteSlotType, +lex:DeleteSlot, +lex:DeleteBotVersion, +lex:DeleteBotChannel, +lex:DeleteBotAlias, +lex:DeleteCustomVocabulary +``` + diff --git a/docs/aws-docs/providers/aws/lex/bot_alias/index.md b/docs/aws-docs/providers/aws/lex/bot_alias/index.md new file mode 100644 index 0000000000..33508c25c0 --- /dev/null +++ b/docs/aws-docs/providers/aws/lex/bot_alias/index.md @@ -0,0 +1,111 @@ +--- +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
DescriptionA Bot Alias enables you to change the version of a bot without updating applications that use the bot
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.lex.bot_alias +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the bot_alias resource, the following permissions are required: + +### Update +```json +lex:UpdateBotAlias, +lex:DescribeBotAlias, +lex:ListTagsForResource, +lex:TagResource, +lex:UntagResource +``` + +### Read +```json +lex:DescribeBotAlias +``` + +### Delete +```json +lex:DeleteBotAlias +``` + diff --git a/docs/aws-docs/providers/aws/lex/bot_aliases/index.md b/docs/aws-docs/providers/aws/lex/bot_aliases/index.md new file mode 100644 index 0000000000..dfdb8782dd --- /dev/null +++ b/docs/aws-docs/providers/aws/lex/bot_aliases/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionA Bot Alias enables you to change the version of a bot without updating applications that use the bot
Idaws.lex.bot_aliases
+ +## Fields + + + + + + +
NameDatatypeDescription
bot_alias_idundefined
bot_idundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +bot_alias_id, +bot_id +FROM aws.lex.bot_aliases +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the bot_aliases resource, the following permissions are required: + +### Create +```json +lex:CreateBotAlias, +lex:DescribeBot +``` + +### List +```json +lex:ListBotAliases +``` + diff --git a/docs/aws-docs/providers/aws/lex/bot_version/index.md b/docs/aws-docs/providers/aws/lex/bot_version/index.md new file mode 100644 index 0000000000..597427d8c1 --- /dev/null +++ b/docs/aws-docs/providers/aws/lex/bot_version/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionA version is a numbered snapshot of your work that you can publish for use in different parts of your workflow, such as development, beta deployment, and production.
Idaws.lex.bot_version
+ +## Fields + + + + + + + + +
NameDatatypeDescription
bot_idstring
bot_versionobject
descriptionstring
bot_version_locale_specificationarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +bot_id, +bot_version, +description, +bot_version_locale_specification +FROM aws.lex.bot_version +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the bot_version resource, the following permissions are required: + +### Read +```json +lex:DescribeBotVersion +``` + +### Delete +```json +lex:DeleteBotVersion, +lex:DescribeBotVersion +``` + diff --git a/docs/aws-docs/providers/aws/lex/bot_versions/index.md b/docs/aws-docs/providers/aws/lex/bot_versions/index.md new file mode 100644 index 0000000000..57183fa7b9 --- /dev/null +++ b/docs/aws-docs/providers/aws/lex/bot_versions/index.md @@ -0,0 +1,83 @@ +--- +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
DescriptionA version is a numbered snapshot of your work that you can publish for use in different parts of your workflow, such as development, beta deployment, and production.
Idaws.lex.bot_versions
+ +## Fields + + + + + + +
NameDatatypeDescription
bot_idundefined
bot_versionundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +bot_id, +bot_version +FROM aws.lex.bot_versions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the bot_versions resource, the following permissions are required: + +### Create +```json +lex:CreateBotVersion, +lex:DescribeBotVersion, +lex:DescribeBot, +lex:DescribeBotLocale, +lex:BuildBotLocale +``` + +### List +```json +lex:ListBotVersions +``` + diff --git a/docs/aws-docs/providers/aws/lex/bots/index.md b/docs/aws-docs/providers/aws/lex/bots/index.md new file mode 100644 index 0000000000..c97813619a --- /dev/null +++ b/docs/aws-docs/providers/aws/lex/bots/index.md @@ -0,0 +1,106 @@ +--- +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
DescriptionAmazon Lex conversational bot performing automated tasks such as ordering a pizza, booking a hotel, and so on.
Idaws.lex.bots
+ +## Fields + + + + + +
NameDatatypeDescription
idundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.lex.bots +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the bots resource, the following permissions are required: + +### Create +```json +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 +```json +lex:ListBots +``` + diff --git a/docs/aws-docs/providers/aws/lex/index.md b/docs/aws-docs/providers/aws/lex/index.md new file mode 100644 index 0000000000..637437c3c6 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/lex/resource_policies/index.md b/docs/aws-docs/providers/aws/lex/resource_policies/index.md new file mode 100644 index 0000000000..8bb9ab35a0 --- /dev/null +++ b/docs/aws-docs/providers/aws/lex/resource_policies/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionA resource policy with specified policy statements that attaches to a Lex bot or bot alias.
Idaws.lex.resource_policies
+ +## Fields + + + + + +
NameDatatypeDescription
idundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.lex.resource_policies +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the resource_policies resource, the following permissions are required: + +### Create +```json +lex:CreateResourcePolicy, +lex:DescribeResourcePolicy +``` + +### List +```json +lex:DescribeResourcePolicy +``` + diff --git a/docs/aws-docs/providers/aws/lex/resource_policy/index.md b/docs/aws-docs/providers/aws/lex/resource_policy/index.md new file mode 100644 index 0000000000..20d702c1fc --- /dev/null +++ b/docs/aws-docs/providers/aws/lex/resource_policy/index.md @@ -0,0 +1,95 @@ +--- +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
DescriptionA resource policy with specified policy statements that attaches to a Lex bot or bot alias.
Idaws.lex.resource_policy
+ +## Fields + + + + + + + + +
NameDatatypeDescription
resource_arnstring
revision_idstring
policyobject
idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +resource_arn, +revision_id, +policy, +id +FROM aws.lex.resource_policy +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the resource_policy resource, the following permissions are required: + +### Read +```json +lex:DescribeResourcePolicy +``` + +### Update +```json +lex:UpdateResourcePolicy, +lex:DescribeResourcePolicy +``` + +### Delete +```json +lex:DeleteResourcePolicy, +lex:DescribeResourcePolicy +``` + diff --git a/docs/aws-docs/providers/aws/licensemanager/grant/index.md b/docs/aws-docs/providers/aws/licensemanager/grant/index.md new file mode 100644 index 0000000000..2df6b036be --- /dev/null +++ b/docs/aws-docs/providers/aws/licensemanager/grant/index.md @@ -0,0 +1,101 @@ +--- +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
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +grant_arn, +grant_name, +license_arn, +home_region, +version, +allowed_operations, +principals, +status +FROM aws.licensemanager.grant +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the grant resource, the following permissions are required: + +### Read +```json +license-manager:GetGrant +``` + +### Update +```json +license-manager:CreateGrantVersion +``` + +### Delete +```json +license-manager:DeleteGrant +``` + diff --git a/docs/aws-docs/providers/aws/licensemanager/grants/index.md b/docs/aws-docs/providers/aws/licensemanager/grants/index.md new file mode 100644 index 0000000000..901604a58b --- /dev/null +++ b/docs/aws-docs/providers/aws/licensemanager/grants/index.md @@ -0,0 +1,77 @@ +--- +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
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Idaws.licensemanager.grants
+ +## Fields + + + + + +
NameDatatypeDescription
grant_arnundefinedArn of the grant.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +grant_arn +FROM aws.licensemanager.grants +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the grants resource, the following permissions are required: + +### Create +```json +license-manager:CreateGrant +``` + +### List +```json +license-manager:ListDistributedGrants +``` + diff --git a/docs/aws-docs/providers/aws/licensemanager/index.md b/docs/aws-docs/providers/aws/licensemanager/index.md new file mode 100644 index 0000000000..5db3d76703 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/licensemanager/license/index.md b/docs/aws-docs/providers/aws/licensemanager/license/index.md new file mode 100644 index 0000000000..20ff075397 --- /dev/null +++ b/docs/aws-docs/providers/aws/licensemanager/license/index.md @@ -0,0 +1,111 @@ +--- +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
DescriptionResource Type definition for AWS::LicenseManager::License
Idaws.licensemanager.license
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
product_skustringProductSKU 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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +product_sku, +issuer, +license_name, +product_name, +home_region, +validity, +entitlements, +beneficiary, +consumption_configuration, +license_metadata, +license_arn, +status, +version +FROM aws.licensemanager.license +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the license resource, the following permissions are required: + +### Read +```json +license-manager:GetLicense +``` + +### Update +```json +license-manager:CreateLicenseVersion +``` + +### Delete +```json +license-manager:DeleteLicense +``` + diff --git a/docs/aws-docs/providers/aws/licensemanager/licenses/index.md b/docs/aws-docs/providers/aws/licensemanager/licenses/index.md new file mode 100644 index 0000000000..60d39030ea --- /dev/null +++ b/docs/aws-docs/providers/aws/licensemanager/licenses/index.md @@ -0,0 +1,77 @@ +--- +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
DescriptionResource Type definition for AWS::LicenseManager::License
Idaws.licensemanager.licenses
+ +## Fields + + + + + +
NameDatatypeDescription
license_arnundefinedAmazon Resource Name is a unique name for each resource.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +license_arn +FROM aws.licensemanager.licenses +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the licenses resource, the following permissions are required: + +### Create +```json +license-manager:CreateLicense +``` + +### List +```json +license-manager:ListLicenses +``` + diff --git a/docs/aws-docs/providers/aws/lightsail/alarm/index.md b/docs/aws-docs/providers/aws/lightsail/alarm/index.md new file mode 100644 index 0000000000..0c56f8ca04 --- /dev/null +++ b/docs/aws-docs/providers/aws/lightsail/alarm/index.md @@ -0,0 +1,113 @@ +--- +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
DescriptionResource Type definition for AWS::Lightsail::Alarm
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.lightsail.alarm +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the alarm resource, the following permissions are required: + +### Read +```json +lightsail:GetAlarms +``` + +### Update +```json +lightsail:PutAlarm, +lightsail:GetAlarms +``` + +### Delete +```json +lightsail:DeleteAlarm, +lightsail:GetAlarms +``` + diff --git a/docs/aws-docs/providers/aws/lightsail/alarms/index.md b/docs/aws-docs/providers/aws/lightsail/alarms/index.md new file mode 100644 index 0000000000..617d5afd17 --- /dev/null +++ b/docs/aws-docs/providers/aws/lightsail/alarms/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionResource Type definition for AWS::Lightsail::Alarm
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +alarm_name +FROM aws.lightsail.alarms +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the alarms resource, the following permissions are required: + +### Create +```json +lightsail:PutAlarm, +lightsail:GetAlarms +``` + +### List +```json +lightsail:GetAlarms +``` + diff --git a/docs/aws-docs/providers/aws/lightsail/bucket/index.md b/docs/aws-docs/providers/aws/lightsail/bucket/index.md new file mode 100644 index 0000000000..5a2a9304df --- /dev/null +++ b/docs/aws-docs/providers/aws/lightsail/bucket/index.md @@ -0,0 +1,112 @@ +--- +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
DescriptionResource Type definition for AWS::Lightsail::Bucket
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.lightsail.bucket +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the bucket resource, the following permissions are required: + +### Read +```json +lightsail:GetBuckets +``` + +### Delete +```json +lightsail:DeleteBucket, +lightsail:GetBuckets +``` + +### Update +```json +lightsail:GetBuckets, +lightsail:GetInstance, +lightsail:UpdateBucket, +lightsail:UpdateBucketBundle, +lightsail:SetResourceAccessForBucket, +lightsail:TagResource, +lightsail:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/lightsail/buckets/index.md b/docs/aws-docs/providers/aws/lightsail/buckets/index.md new file mode 100644 index 0000000000..582180b9b3 --- /dev/null +++ b/docs/aws-docs/providers/aws/lightsail/buckets/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionResource Type definition for AWS::Lightsail::Bucket
Idaws.lightsail.buckets
+ +## Fields + + + + + +
NameDatatypeDescription
bucket_namestringThe name for the bucket.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +bucket_name +FROM aws.lightsail.buckets +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the buckets resource, the following permissions are required: + +### Create +```json +lightsail:CreateBucket, +lightsail:GetBuckets, +lightsail:GetInstance, +lightsail:UpdateBucket, +lightsail:UpdateBucketBundle, +lightsail:SetResourceAccessForBucket, +lightsail:TagResource, +lightsail:UntagResource +``` + +### List +```json +lightsail:GetBuckets +``` + diff --git a/docs/aws-docs/providers/aws/lightsail/certificate/index.md b/docs/aws-docs/providers/aws/lightsail/certificate/index.md new file mode 100644 index 0000000000..ee899cb731 --- /dev/null +++ b/docs/aws-docs/providers/aws/lightsail/certificate/index.md @@ -0,0 +1,100 @@ +--- +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
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +certificate_name, +domain_name, +subject_alternative_names, +certificate_arn, +status, +tags +FROM aws.lightsail.certificate +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the certificate resource, the following permissions are required: + +### Read +```json +lightsail:GetCertificates +``` + +### Update +```json +lightsail:GetCertificates, +lightsail:TagResource, +lightsail:UntagResource +``` + +### Delete +```json +lightsail:DeleteCertificate, +lightsail:GetCertificates +``` + diff --git a/docs/aws-docs/providers/aws/lightsail/certificates/index.md b/docs/aws-docs/providers/aws/lightsail/certificates/index.md new file mode 100644 index 0000000000..8a5cd96ac6 --- /dev/null +++ b/docs/aws-docs/providers/aws/lightsail/certificates/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Idaws.lightsail.certificates
+ +## Fields + + + + + +
NameDatatypeDescription
certificate_namestringThe name for the certificate.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +certificate_name +FROM aws.lightsail.certificates +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the certificates resource, the following permissions are required: + +### Create +```json +lightsail:CreateCertificate, +lightsail:GetCertificates, +lightsail:TagResource, +lightsail:UntagResource +``` + +### List +```json +lightsail:GetCertificates +``` + diff --git a/docs/aws-docs/providers/aws/lightsail/container/index.md b/docs/aws-docs/providers/aws/lightsail/container/index.md new file mode 100644 index 0000000000..4e8e3709b9 --- /dev/null +++ b/docs/aws-docs/providers/aws/lightsail/container/index.md @@ -0,0 +1,112 @@ +--- +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
DescriptionResource Type definition for AWS::Lightsail::Container
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.lightsail.container +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the container resource, the following permissions are required: + +### Read +```json +lightsail:GetContainerServices +``` + +### Delete +```json +lightsail:DeleteContainerService, +lightsail:GetContainerServices +``` + +### Update +```json +lightsail:CreateContainerServiceDeployment, +lightsail:GetContainerServices, +lightsail:TagResource, +lightsail:UntagResource, +lightsail:UpdateContainerService +``` + diff --git a/docs/aws-docs/providers/aws/lightsail/containers/index.md b/docs/aws-docs/providers/aws/lightsail/containers/index.md new file mode 100644 index 0000000000..9e0c97f772 --- /dev/null +++ b/docs/aws-docs/providers/aws/lightsail/containers/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionResource Type definition for AWS::Lightsail::Container
Idaws.lightsail.containers
+ +## Fields + + + + + +
NameDatatypeDescription
service_namestringThe name for the container service.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +service_name +FROM aws.lightsail.containers +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the containers resource, the following permissions are required: + +### Create +```json +lightsail:CreateContainerService, +lightsail:CreateContainerServiceDeployment, +lightsail:GetContainerServices, +lightsail:TagResource, +lightsail:UntagResource, +lightsail:UpdateContainerService +``` + +### List +```json +lightsail:GetContainerServices +``` + diff --git a/docs/aws-docs/providers/aws/lightsail/database/index.md b/docs/aws-docs/providers/aws/lightsail/database/index.md new file mode 100644 index 0000000000..7530fd9489 --- /dev/null +++ b/docs/aws-docs/providers/aws/lightsail/database/index.md @@ -0,0 +1,125 @@ +--- +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
DescriptionResource Type definition for AWS::Lightsail::Database
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.lightsail.database +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the database resource, the following permissions are required: + +### Read +```json +lightsail:GetRelationalDatabase, +lightsail:GetRelationalDatabases +``` + +### Update +```json +lightsail:GetRelationalDatabase, +lightsail:GetRelationalDatabases, +lightsail:TagResource, +lightsail:UntagResource, +lightsail:UpdateRelationalDatabase, +lightsail:UpdateRelationalDatabaseParameters +``` + +### Delete +```json +lightsail:DeleteRelationalDatabase, +lightsail:GetRelationalDatabase, +lightsail:GetRelationalDatabases +``` + diff --git a/docs/aws-docs/providers/aws/lightsail/databases/index.md b/docs/aws-docs/providers/aws/lightsail/databases/index.md new file mode 100644 index 0000000000..e943e05a99 --- /dev/null +++ b/docs/aws-docs/providers/aws/lightsail/databases/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionResource Type definition for AWS::Lightsail::Database
Idaws.lightsail.databases
+ +## Fields + + + + + +
NameDatatypeDescription
relational_database_namestringThe name to use for your new Lightsail database resource.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +relational_database_name +FROM aws.lightsail.databases +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the databases resource, the following permissions are required: + +### Create +```json +lightsail:CreateRelationalDatabase, +lightsail:GetRelationalDatabase, +lightsail:GetRelationalDatabases, +lightsail:GetRegions, +lightsail:TagResource, +lightsail:UntagResource, +lightsail:UpdateRelationalDatabase, +lightsail:UpdateRelationalDatabaseParameters +``` + +### List +```json +lightsail:GetRelationalDatabases +``` + diff --git a/docs/aws-docs/providers/aws/lightsail/distribution/index.md b/docs/aws-docs/providers/aws/lightsail/distribution/index.md new file mode 100644 index 0000000000..a24c5dd2c3 --- /dev/null +++ b/docs/aws-docs/providers/aws/lightsail/distribution/index.md @@ -0,0 +1,120 @@ +--- +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
DescriptionResource Type definition for AWS::Lightsail::Distribution
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.lightsail.distribution +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the distribution resource, the following permissions are required: + +### Read +```json +lightsail:GetDistributions +``` + +### Update +```json +lightsail:AttachCertificateToDistribution, +lightsail:DetachCertificateFromDistribution, +lightsail:GetCertificates, +lightsail:GetCertificateDetails, +lightsail:GetDistributions, +lightsail:TagResource, +lightsail:UntagResource, +lightsail:UpdateDistribution, +lightsail:UpdateDistributionBundle +``` + +### Delete +```json +lightsail:DeleteDistribution, +lightsail:GetDistributions +``` + diff --git a/docs/aws-docs/providers/aws/lightsail/distributions/index.md b/docs/aws-docs/providers/aws/lightsail/distributions/index.md new file mode 100644 index 0000000000..16b0c949e6 --- /dev/null +++ b/docs/aws-docs/providers/aws/lightsail/distributions/index.md @@ -0,0 +1,86 @@ +--- +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
DescriptionResource Type definition for AWS::Lightsail::Distribution
Idaws.lightsail.distributions
+ +## Fields + + + + + +
NameDatatypeDescription
distribution_namestringThe name for the distribution.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +distribution_name +FROM aws.lightsail.distributions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the distributions resource, the following permissions are required: + +### Create +```json +lightsail:AttachCertificateToDistribution, +lightsail:CreateDistribution, +lightsail:DetachCertificateFromDistribution, +lightsail:GetCertificates, +lightsail:GetCertificateDetails, +lightsail:GetDistributions, +lightsail:TagResource, +lightsail:UntagResource, +lightsail:UpdateDistribution, +lightsail:UpdateDistributionBundle +``` + +### List +```json +lightsail:GetDistributions +``` + diff --git a/docs/aws-docs/providers/aws/lightsail/index.md b/docs/aws-docs/providers/aws/lightsail/index.md new file mode 100644 index 0000000000..b13bc529a8 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/lightsail/instance/index.md b/docs/aws-docs/providers/aws/lightsail/instance/index.md new file mode 100644 index 0000000000..56dcf27a83 --- /dev/null +++ b/docs/aws-docs/providers/aws/lightsail/instance/index.md @@ -0,0 +1,140 @@ +--- +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
DescriptionResource Type definition for AWS::Lightsail::Instance
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.lightsail.instance +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the instance resource, the following permissions are required: + +### Read +```json +lightsail:GetInstances, +lightsail:GetInstance +``` + +### Delete +```json +lightsail:GetInstances, +lightsail:GetInstance, +lightsail:DeleteInstance +``` + +### Update +```json +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 +``` + diff --git a/docs/aws-docs/providers/aws/lightsail/instances/index.md b/docs/aws-docs/providers/aws/lightsail/instances/index.md new file mode 100644 index 0000000000..5e848ed028 --- /dev/null +++ b/docs/aws-docs/providers/aws/lightsail/instances/index.md @@ -0,0 +1,90 @@ +--- +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
DescriptionResource Type definition for AWS::Lightsail::Instance
Idaws.lightsail.instances
+ +## Fields + + + + + +
NameDatatypeDescription
instance_namestringThe names to use for your new Lightsail instance.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +instance_name +FROM aws.lightsail.instances +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the instances resource, the following permissions are required: + +### Create +```json +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 +```json +lightsail:GetInstances +``` + diff --git a/docs/aws-docs/providers/aws/lightsail/load_balancer/index.md b/docs/aws-docs/providers/aws/lightsail/load_balancer/index.md new file mode 100644 index 0000000000..49b1d09d2a --- /dev/null +++ b/docs/aws-docs/providers/aws/lightsail/load_balancer/index.md @@ -0,0 +1,115 @@ +--- +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
DescriptionResource Type definition for AWS::Lightsail::LoadBalancer
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.lightsail.load_balancer +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the load_balancer resource, the following permissions are required: + +### Read +```json +lightsail:GetLoadBalancer, +lightsail:GetLoadBalancers +``` + +### Update +```json +lightsail:GetLoadBalancer, +lightsail:GetLoadBalancers, +lightsail:GetInstance, +lightsail:AttachInstancesToLoadBalancer, +lightsail:DetachInstancesFromLoadBalancer, +lightsail:UpdateLoadBalancerAttribute, +lightsail:TagResource, +lightsail:UntagResource +``` + +### Delete +```json +lightsail:DeleteLoadBalancer, +lightsail:GetLoadBalancer, +lightsail:GetLoadBalancers +``` + diff --git a/docs/aws-docs/providers/aws/lightsail/load_balancer_tls_certificate/index.md b/docs/aws-docs/providers/aws/lightsail/load_balancer_tls_certificate/index.md new file mode 100644 index 0000000000..72155c3e04 --- /dev/null +++ b/docs/aws-docs/providers/aws/lightsail/load_balancer_tls_certificate/index.md @@ -0,0 +1,107 @@ +--- +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
DescriptionResource Type definition for AWS::Lightsail::LoadBalancerTlsCertificate
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.lightsail.load_balancer_tls_certificate +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the load_balancer_tls_certificate resource, the following permissions are required: + +### Read +```json +lightsail:GetLoadBalancerTlsCertificates, +lightsail:GetLoadBalancer +``` + +### Update +```json +lightsail:AttachLoadBalancerTlsCertificate, +lightsail:GetLoadBalancerTlsCertificates, +lightsail:GetLoadBalancer, +lightsail:UpdateLoadBalancerAttribute +``` + +### Delete +```json +lightsail:DeleteLoadBalancerTlsCertificate, +lightsail:GetLoadBalancerTlsCertificates, +lightsail:GetLoadBalancer +``` + diff --git a/docs/aws-docs/providers/aws/lightsail/load_balancer_tls_certificates/index.md b/docs/aws-docs/providers/aws/lightsail/load_balancer_tls_certificates/index.md new file mode 100644 index 0000000000..e03c8359cf --- /dev/null +++ b/docs/aws-docs/providers/aws/lightsail/load_balancer_tls_certificates/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionResource Type definition for AWS::Lightsail::LoadBalancerTlsCertificate
Idaws.lightsail.load_balancer_tls_certificates
+ +## Fields + + + + + + +
NameDatatypeDescription
certificate_namestringThe SSL/TLS certificate name.
load_balancer_namestringThe name of your load balancer.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +certificate_name, +load_balancer_name +FROM aws.lightsail.load_balancer_tls_certificates +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the load_balancer_tls_certificates resource, the following permissions are required: + +### Create +```json +lightsail:CreateLoadBalancerTlsCertificate, +lightsail:GetLoadBalancerTlsCertificates, +lightsail:GetLoadBalancer, +lightsail:AttachLoadBalancerTlsCertificate, +lightsail:UpdateLoadBalancerAttribute +``` + +### List +```json +lightsail:GetLoadBalancerTlsCertificates, +lightsail:GetLoadBalancer +``` + diff --git a/docs/aws-docs/providers/aws/lightsail/load_balancers/index.md b/docs/aws-docs/providers/aws/lightsail/load_balancers/index.md new file mode 100644 index 0000000000..c923043a76 --- /dev/null +++ b/docs/aws-docs/providers/aws/lightsail/load_balancers/index.md @@ -0,0 +1,85 @@ +--- +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
DescriptionResource Type definition for AWS::Lightsail::LoadBalancer
Idaws.lightsail.load_balancers
+ +## Fields + + + + + +
NameDatatypeDescription
load_balancer_namestringThe name of your load balancer.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +load_balancer_name +FROM aws.lightsail.load_balancers +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the load_balancers resource, the following permissions are required: + +### Create +```json +lightsail:CreateLoadBalancer, +lightsail:GetLoadBalancer, +lightsail:GetLoadBalancers, +lightsail:GetInstance, +lightsail:AttachInstancesToLoadBalancer, +lightsail:DetachInstancesFromLoadBalancer, +lightsail:UpdateLoadBalancerAttribute, +lightsail:TagResource, +lightsail:UntagResource +``` + +### List +```json +lightsail:GetLoadBalancers +``` + diff --git a/docs/aws-docs/providers/aws/lightsail/static_ip/index.md b/docs/aws-docs/providers/aws/lightsail/static_ip/index.md new file mode 100644 index 0000000000..fc37381e75 --- /dev/null +++ b/docs/aws-docs/providers/aws/lightsail/static_ip/index.md @@ -0,0 +1,102 @@ +--- +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
DescriptionResource Type definition for AWS::Lightsail::StaticIp
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +static_ip_name, +attached_to, +is_attached, +ip_address, +static_ip_arn +FROM aws.lightsail.static_ip +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the static_ip resource, the following permissions are required: + +### Read +```json +lightsail:GetStaticIp, +lightsail:GetStaticIps +``` + +### Update +```json +lightsail:AttachStaticIp, +lightsail:DetachStaticIp, +lightsail:GetInstance, +lightsail:GetStaticIp, +lightsail:GetStaticIps +``` + +### Delete +```json +lightsail:GetStaticIp, +lightsail:GetStaticIps, +lightsail:ReleaseStaticIp +``` + diff --git a/docs/aws-docs/providers/aws/lightsail/static_ips/index.md b/docs/aws-docs/providers/aws/lightsail/static_ips/index.md new file mode 100644 index 0000000000..975eae3d4e --- /dev/null +++ b/docs/aws-docs/providers/aws/lightsail/static_ips/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionResource Type definition for AWS::Lightsail::StaticIp
Idaws.lightsail.static_ips
+ +## Fields + + + + + +
NameDatatypeDescription
static_ip_namestringThe name of the static IP address.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +static_ip_name +FROM aws.lightsail.static_ips +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the static_ips resource, the following permissions are required: + +### Create +```json +lightsail:AllocateStaticIp, +lightsail:AttachStaticIp, +lightsail:DetachStaticIp, +lightsail:GetInstance, +lightsail:GetStaticIp, +lightsail:GetStaticIps +``` + +### List +```json +lightsail:GetStaticIps +``` + diff --git a/docs/aws-docs/providers/aws/location/api_key/index.md b/docs/aws-docs/providers/aws/location/api_key/index.md new file mode 100644 index 0000000000..3742b69944 --- /dev/null +++ b/docs/aws-docs/providers/aws/location/api_key/index.md @@ -0,0 +1,124 @@ +--- +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
DescriptionDefinition of AWS::Location::APIKey Resource Type
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.location.api_key +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the api_key resource, the following permissions are required: + +### Read +```json +geo:DescribeKey +``` + +### Update +```json +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 +```json +geo:DeleteKey, +geo:DescribeKey +``` + diff --git a/docs/aws-docs/providers/aws/location/api_keys/index.md b/docs/aws-docs/providers/aws/location/api_keys/index.md new file mode 100644 index 0000000000..6907c9a3c2 --- /dev/null +++ b/docs/aws-docs/providers/aws/location/api_keys/index.md @@ -0,0 +1,90 @@ +--- +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
DescriptionDefinition of AWS::Location::APIKey Resource Type
Idaws.location.api_keys
+ +## Fields + + + + + +
NameDatatypeDescription
key_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +key_name +FROM aws.location.api_keys +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the api_keys resource, the following permissions are required: + +### Create +```json +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 +```json +geo:ListKeys +``` + diff --git a/docs/aws-docs/providers/aws/location/geofence_collection/index.md b/docs/aws-docs/providers/aws/location/geofence_collection/index.md new file mode 100644 index 0000000000..21abc7576c --- /dev/null +++ b/docs/aws-docs/providers/aws/location/geofence_collection/index.md @@ -0,0 +1,113 @@ +--- +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
DescriptionDefinition of AWS::Location::GeofenceCollection Resource Type
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.location.geofence_collection +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the geofence_collection resource, the following permissions are required: + +### Read +```json +geo:DescribeGeofenceCollection, +kms:DescribeKey +``` + +### Update +```json +geo:CreateGeofenceCollection, +geo:DescribeGeofenceCollection, +geo:TagResource, +geo:UntagResource, +kms:DescribeKey, +kms:CreateGrant, +geo:UpdateGeofenceCollection +``` + +### Delete +```json +geo:DeleteGeofenceCollection, +geo:DescribeGeofenceCollection +``` + diff --git a/docs/aws-docs/providers/aws/location/geofence_collections/index.md b/docs/aws-docs/providers/aws/location/geofence_collections/index.md new file mode 100644 index 0000000000..952b81c092 --- /dev/null +++ b/docs/aws-docs/providers/aws/location/geofence_collections/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionDefinition of AWS::Location::GeofenceCollection Resource Type
Idaws.location.geofence_collections
+ +## Fields + + + + + +
NameDatatypeDescription
collection_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +collection_name +FROM aws.location.geofence_collections +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the geofence_collections resource, the following permissions are required: + +### Create +```json +geo:CreateGeofenceCollection, +geo:DescribeGeofenceCollection, +geo:TagResource, +geo:UntagResource, +kms:DescribeKey, +kms:CreateGrant +``` + +### List +```json +geo:ListGeofenceCollections +``` + diff --git a/docs/aws-docs/providers/aws/location/index.md b/docs/aws-docs/providers/aws/location/index.md new file mode 100644 index 0000000000..164ab1479e --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/location/map/index.md b/docs/aws-docs/providers/aws/location/map/index.md new file mode 100644 index 0000000000..2f70daa51e --- /dev/null +++ b/docs/aws-docs/providers/aws/location/map/index.md @@ -0,0 +1,108 @@ +--- +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
DescriptionDefinition of AWS::Location::Map Resource Type
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +configuration, +create_time, +description, +map_arn, +map_name, +pricing_plan, +tags, +update_time, +arn +FROM aws.location.map +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the map resource, the following permissions are required: + +### Read +```json +geo:DescribeMap +``` + +### Update +```json +geo:CreateMap, +geo:DescribeMap, +geo:TagResource, +geo:UntagResource, +geo:UpdateMap +``` + +### Delete +```json +geo:DeleteMap, +geo:DescribeMap +``` + diff --git a/docs/aws-docs/providers/aws/location/maps/index.md b/docs/aws-docs/providers/aws/location/maps/index.md new file mode 100644 index 0000000000..168663b347 --- /dev/null +++ b/docs/aws-docs/providers/aws/location/maps/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionDefinition of AWS::Location::Map Resource Type
Idaws.location.maps
+ +## Fields + + + + + +
NameDatatypeDescription
map_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +map_name +FROM aws.location.maps +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the maps resource, the following permissions are required: + +### Create +```json +geo:CreateMap, +geo:DescribeMap, +geo:TagResource, +geo:UntagResource +``` + +### List +```json +geo:ListMaps +``` + diff --git a/docs/aws-docs/providers/aws/location/place_index/index.md b/docs/aws-docs/providers/aws/location/place_index/index.md new file mode 100644 index 0000000000..17bdcdebd1 --- /dev/null +++ b/docs/aws-docs/providers/aws/location/place_index/index.md @@ -0,0 +1,110 @@ +--- +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
DescriptionDefinition of AWS::Location::PlaceIndex Resource Type
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +create_time, +data_source, +data_source_configuration, +description, +index_arn, +index_name, +pricing_plan, +tags, +update_time, +arn +FROM aws.location.place_index +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the place_index resource, the following permissions are required: + +### Read +```json +geo:DescribePlaceIndex +``` + +### Update +```json +geo:CreatePlaceIndex, +geo:DescribePlaceIndex, +geo:TagResource, +geo:UntagResource, +geo:UpdatePlaceIndex +``` + +### Delete +```json +geo:DeletePlaceIndex, +geo:DescribePlaceIndex +``` + diff --git a/docs/aws-docs/providers/aws/location/place_indices/index.md b/docs/aws-docs/providers/aws/location/place_indices/index.md new file mode 100644 index 0000000000..5c04821b7f --- /dev/null +++ b/docs/aws-docs/providers/aws/location/place_indices/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionDefinition of AWS::Location::PlaceIndex Resource Type
Idaws.location.place_indices
+ +## Fields + + + + + +
NameDatatypeDescription
index_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +index_name +FROM aws.location.place_indices +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the place_indices resource, the following permissions are required: + +### Create +```json +geo:CreatePlaceIndex, +geo:DescribePlaceIndex, +geo:TagResource, +geo:UntagResource +``` + +### List +```json +geo:ListPlaceIndexes +``` + diff --git a/docs/aws-docs/providers/aws/location/route_calculator/index.md b/docs/aws-docs/providers/aws/location/route_calculator/index.md new file mode 100644 index 0000000000..7017f32bdf --- /dev/null +++ b/docs/aws-docs/providers/aws/location/route_calculator/index.md @@ -0,0 +1,108 @@ +--- +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
DescriptionDefinition of AWS::Location::RouteCalculator Resource Type
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +calculator_arn, +calculator_name, +create_time, +data_source, +description, +pricing_plan, +tags, +update_time, +arn +FROM aws.location.route_calculator +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the route_calculator resource, the following permissions are required: + +### Read +```json +geo:DescribeRouteCalculator +``` + +### Update +```json +geo:CreateRouteCalculator, +geo:DescribeRouteCalculator, +geo:TagResource, +geo:UntagResource, +geo:UpdateRouteCalculator +``` + +### Delete +```json +geo:DeleteRouteCalculator, +geo:DescribeRouteCalculator +``` + diff --git a/docs/aws-docs/providers/aws/location/route_calculators/index.md b/docs/aws-docs/providers/aws/location/route_calculators/index.md new file mode 100644 index 0000000000..e90fd0562a --- /dev/null +++ b/docs/aws-docs/providers/aws/location/route_calculators/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionDefinition of AWS::Location::RouteCalculator Resource Type
Idaws.location.route_calculators
+ +## Fields + + + + + +
NameDatatypeDescription
calculator_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +calculator_name +FROM aws.location.route_calculators +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the route_calculators resource, the following permissions are required: + +### Create +```json +geo:CreateRouteCalculator, +geo:DescribeRouteCalculator, +geo:TagResource, +geo:UntagResource +``` + +### List +```json +geo:ListRouteCalculators +``` + diff --git a/docs/aws-docs/providers/aws/location/tracker/index.md b/docs/aws-docs/providers/aws/location/tracker/index.md new file mode 100644 index 0000000000..d91a773759 --- /dev/null +++ b/docs/aws-docs/providers/aws/location/tracker/index.md @@ -0,0 +1,119 @@ +--- +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
DescriptionDefinition of AWS::Location::Tracker Resource Type
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.location.tracker +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the tracker resource, the following permissions are required: + +### Read +```json +geo:DescribeTracker, +kms:DescribeKey +``` + +### Update +```json +geo:CreateTracker, +geo:DescribeTracker, +geo:TagResource, +geo:UntagResource, +kms:DescribeKey, +kms:CreateGrant, +geo:UpdateTracker +``` + +### Delete +```json +geo:DeleteTracker, +geo:DescribeTracker +``` + diff --git a/docs/aws-docs/providers/aws/location/tracker_consumer/index.md b/docs/aws-docs/providers/aws/location/tracker_consumer/index.md new file mode 100644 index 0000000000..a59f62a8c4 --- /dev/null +++ b/docs/aws-docs/providers/aws/location/tracker_consumer/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionDefinition of AWS::Location::TrackerConsumer Resource Type
Idaws.location.tracker_consumer
+ +## Fields + + + + + + +
NameDatatypeDescription
consumer_arnstring
tracker_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +consumer_arn, +tracker_name +FROM aws.location.tracker_consumer +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the tracker_consumer resource, the following permissions are required: + +### Delete +```json +geo:DisassociateTrackerConsumer, +geo:ListTrackerConsumers +``` + +### Read +```json +geo:ListTrackerConsumers +``` + diff --git a/docs/aws-docs/providers/aws/location/tracker_consumers/index.md b/docs/aws-docs/providers/aws/location/tracker_consumers/index.md new file mode 100644 index 0000000000..01783e3399 --- /dev/null +++ b/docs/aws-docs/providers/aws/location/tracker_consumers/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionDefinition of AWS::Location::TrackerConsumer Resource Type
Idaws.location.tracker_consumers
+ +## Fields + + + + + + +
NameDatatypeDescription
tracker_namestring
consumer_arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +tracker_name, +consumer_arn +FROM aws.location.tracker_consumers +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the tracker_consumers resource, the following permissions are required: + +### Create +```json +geo:AssociateTrackerConsumer, +geo:ListTrackerConsumers +``` + +### List +```json +geo:ListTrackerConsumers +``` + diff --git a/docs/aws-docs/providers/aws/location/trackers/index.md b/docs/aws-docs/providers/aws/location/trackers/index.md new file mode 100644 index 0000000000..bc73c2a608 --- /dev/null +++ b/docs/aws-docs/providers/aws/location/trackers/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionDefinition of AWS::Location::Tracker Resource Type
Idaws.location.trackers
+ +## Fields + + + + + +
NameDatatypeDescription
tracker_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +tracker_name +FROM aws.location.trackers +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the trackers resource, the following permissions are required: + +### Create +```json +geo:CreateTracker, +geo:DescribeTracker, +geo:TagResource, +geo:UntagResource, +kms:DescribeKey, +kms:CreateGrant +``` + +### List +```json +geo:ListTrackers +``` + diff --git a/docs/aws-docs/providers/aws/logs/account_policies/index.md b/docs/aws-docs/providers/aws/logs/account_policies/index.md new file mode 100644 index 0000000000..578d154780 --- /dev/null +++ b/docs/aws-docs/providers/aws/logs/account_policies/index.md @@ -0,0 +1,89 @@ +--- +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
DescriptionThe AWS::Logs::AccountPolicy resource specifies a CloudWatch Logs AccountPolicy.
Idaws.logs.account_policies
+ +## Fields + + + + + + + +
NameDatatypeDescription
account_idstringUser account id
policy_typestringType of the policy.
policy_namestringThe name of the account policy
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +account_id, +policy_type, +policy_name +FROM aws.logs.account_policies +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the account_policies resource, the following permissions are required: + +### Create +```json +logs:PutAccountPolicy, +logs:PutDataProtectionPolicy, +logs:DescribeAccountPolicies, +logs:CreateLogDelivery, +s3:REST.PUT.OBJECT, +firehose:TagDeliveryStream, +logs:PutSubscriptionFilter, +logs:DeleteSubscriptionFilter, +iam:PassRole +``` + +### List +```json +logs:DescribeAccountPolicies +``` + diff --git a/docs/aws-docs/providers/aws/logs/account_policy/index.md b/docs/aws-docs/providers/aws/logs/account_policy/index.md new file mode 100644 index 0000000000..79af5525cb --- /dev/null +++ b/docs/aws-docs/providers/aws/logs/account_policy/index.md @@ -0,0 +1,111 @@ +--- +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
DescriptionThe AWS::Logs::AccountPolicy resource specifies a CloudWatch Logs AccountPolicy.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +account_id, +policy_name, +policy_document, +policy_type, +scope, +selection_criteria +FROM aws.logs.account_policy +WHERE data__Identifier = '||'; +``` + +## Permissions + +To operate on the account_policy resource, the following permissions are required: + +### Read +```json +logs:DescribeAccountPolicies +``` + +### Update +```json +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 +```json +logs:DeleteAccountPolicy, +logs:DeleteDataProtectionPolicy, +logs:DescribeAccountPolicies, +logs:DeleteSubscriptionFilter, +iam:PassRole +``` + diff --git a/docs/aws-docs/providers/aws/logs/deliveries/index.md b/docs/aws-docs/providers/aws/logs/deliveries/index.md new file mode 100644 index 0000000000..252e4bed40 --- /dev/null +++ b/docs/aws-docs/providers/aws/logs/deliveries/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionThis structure contains information about one delivery in your account.<br/><br/>A delivery is a connection between a logical delivery source and a logical delivery destination.<br/><br/>For more information, see [CreateDelivery](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html).
Idaws.logs.deliveries
+ +## Fields + + + + + +
NameDatatypeDescription
delivery_idstringThe unique ID that identifies this delivery in your account.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +delivery_id +FROM aws.logs.deliveries +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the deliveries resource, the following permissions are required: + +### Create +```json +logs:CreateDelivery, +logs:GetDelivery, +logs:DescribeDeliveries, +logs:ListTagsForResource, +logs:TagResource, +logs:GetDeliverySource, +logs:GetDeliveryDestination +``` + +### List +```json +logs:DescribeDeliveries, +logs:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/logs/delivery/index.md b/docs/aws-docs/providers/aws/logs/delivery/index.md new file mode 100644 index 0000000000..c46362cd24 --- /dev/null +++ b/docs/aws-docs/providers/aws/logs/delivery/index.md @@ -0,0 +1,103 @@ +--- +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
DescriptionThis structure contains information about one delivery in your account.<br/><br/>A delivery is a connection between a logical delivery source and a logical delivery destination.<br/><br/>For more information, see [CreateDelivery](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html).
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +delivery_id, +arn, +delivery_source_name, +delivery_destination_arn, +delivery_destination_type, +tags +FROM aws.logs.delivery +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the delivery resource, the following permissions are required: + +### Read +```json +logs:GetDelivery, +logs:ListTagsForResource +``` + +### Update +```json +logs:GetDelivery, +logs:ListTagsForResource, +logs:TagResource, +logs:UntagResource +``` + +### Delete +```json +logs:DeleteDelivery, +logs:ListTagsForResource, +logs:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/logs/delivery_destination/index.md b/docs/aws-docs/providers/aws/logs/delivery_destination/index.md new file mode 100644 index 0000000000..8b510c268f --- /dev/null +++ b/docs/aws-docs/providers/aws/logs/delivery_destination/index.md @@ -0,0 +1,107 @@ +--- +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
DescriptionThis structure contains information about one delivery destination in your account.<br/><br/>A delivery destination is an AWS resource that represents an AWS service that logs can be sent to CloudWatch Logs, Amazon S3, are supported as Kinesis Data Firehose delivery destinations.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +arn, +destination_resource_arn, +tags, +delivery_destination_type, +delivery_destination_policy +FROM aws.logs.delivery_destination +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the delivery_destination resource, the following permissions are required: + +### Read +```json +logs:GetDeliveryDestination, +logs:ListTagsForResource, +logs:GetDeliveryDestinationPolicy +``` + +### Update +```json +logs:PutDeliveryDestination, +logs:GetDeliveryDestination, +logs:ListTagsForResource, +logs:TagResource, +logs:UntagResource, +logs:DeleteDeliveryDestinationPolicy, +logs:PutDeliveryDestinationPolicy, +logs:GetDeliveryDestinationPolicy +``` + +### Delete +```json +logs:DeleteDeliveryDestination, +logs:DeleteDeliveryDestinationPolicy +``` + diff --git a/docs/aws-docs/providers/aws/logs/delivery_destinations/index.md b/docs/aws-docs/providers/aws/logs/delivery_destinations/index.md new file mode 100644 index 0000000000..679f0beda6 --- /dev/null +++ b/docs/aws-docs/providers/aws/logs/delivery_destinations/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionThis structure contains information about one delivery destination in your account.<br/><br/>A delivery destination is an AWS resource that represents an AWS service that logs can be sent to CloudWatch Logs, Amazon S3, are supported as Kinesis Data Firehose delivery destinations.
Idaws.logs.delivery_destinations
+ +## Fields + + + + + +
NameDatatypeDescription
namestringThe name of this delivery destination.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.logs.delivery_destinations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the delivery_destinations resource, the following permissions are required: + +### Create +```json +logs:PutDeliveryDestination, +logs:GetDeliveryDestination, +logs:ListTagsForResource, +logs:TagResource, +logs:UntagResource, +logs:PutDeliveryDestinationPolicy, +logs:GetDeliveryDestinationPolicy +``` + +### List +```json +logs:DescribeDeliveryDestinations, +logs:GetDeliveryDestinationPolicy +``` + diff --git a/docs/aws-docs/providers/aws/logs/delivery_source/index.md b/docs/aws-docs/providers/aws/logs/delivery_source/index.md new file mode 100644 index 0000000000..da34161f0f --- /dev/null +++ b/docs/aws-docs/providers/aws/logs/delivery_source/index.md @@ -0,0 +1,104 @@ +--- +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
Description A delivery source is an AWS resource that sends logs to an AWS destination. The destination can be CloudWatch Logs, Amazon S3, or Kinesis Data Firehose.<br/><br/>Only some AWS services support being configured as a delivery source. These services are listed as Supported [V2 Permissions] in the table at [Enabling logging from AWS services](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html).
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +arn, +resource_arns, +resource_arn, +service, +log_type, +tags +FROM aws.logs.delivery_source +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the delivery_source resource, the following permissions are required: + +### Read +```json +logs:GetDeliverySource, +logs:ListTagsForResource +``` + +### Update +```json +logs:PutDeliverySource, +logs:GetDeliverySource, +logs:ListTagsForResource, +logs:TagResource, +logs:UntagResource +``` + +### Delete +```json +logs:DeleteDeliverySource +``` + diff --git a/docs/aws-docs/providers/aws/logs/delivery_sources/index.md b/docs/aws-docs/providers/aws/logs/delivery_sources/index.md new file mode 100644 index 0000000000..4557cfa8bc --- /dev/null +++ b/docs/aws-docs/providers/aws/logs/delivery_sources/index.md @@ -0,0 +1,84 @@ +--- +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
Description A delivery source is an AWS resource that sends logs to an AWS destination. The destination can be CloudWatch Logs, Amazon S3, or Kinesis Data Firehose.<br/><br/>Only some AWS services support being configured as a delivery source. These services are listed as Supported [V2 Permissions] in the table at [Enabling logging from AWS services](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html).
Idaws.logs.delivery_sources
+ +## Fields + + + + + +
NameDatatypeDescription
namestringThe unique name of the Log source.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.logs.delivery_sources +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the delivery_sources resource, the following permissions are required: + +### Create +```json +logs:PutDeliverySource, +logs:GetDeliverySource, +logs:ListTagsForResource, +logs:TagResource, +logs:AllowVendedLogDeliveryForResource, +codewhisperer:AllowVendedLogDeliveryForResource, +autoloop:AllowVendedLogDeliveryForResource, +workmail:AllowVendedLogDeliveryForResource +``` + +### List +```json +logs:DescribeDeliverySources +``` + diff --git a/docs/aws-docs/providers/aws/logs/destination/index.md b/docs/aws-docs/providers/aws/logs/destination/index.md new file mode 100644 index 0000000000..9b485b878c --- /dev/null +++ b/docs/aws-docs/providers/aws/logs/destination/index.md @@ -0,0 +1,98 @@ +--- +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
DescriptionThe AWS::Logs::Destination resource specifies a CloudWatch Logs destination. A destination encapsulates a physical resource (such as an Amazon Kinesis data stream) and enables you to subscribe that resource to a stream of log events.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +destination_name, +destination_policy, +role_arn, +target_arn +FROM aws.logs.destination +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the destination resource, the following permissions are required: + +### Read +```json +logs:DescribeDestinations +``` + +### Update +```json +logs:PutDestination, +logs:PutDestinationPolicy, +logs:DescribeDestinations, +iam:PassRole +``` + +### Delete +```json +logs:DeleteDestination +``` + diff --git a/docs/aws-docs/providers/aws/logs/destinations/index.md b/docs/aws-docs/providers/aws/logs/destinations/index.md new file mode 100644 index 0000000000..43a7d4322e --- /dev/null +++ b/docs/aws-docs/providers/aws/logs/destinations/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionThe AWS::Logs::Destination resource specifies a CloudWatch Logs destination. A destination encapsulates a physical resource (such as an Amazon Kinesis data stream) and enables you to subscribe that resource to a stream of log events.
Idaws.logs.destinations
+ +## Fields + + + + + +
NameDatatypeDescription
destination_namestringThe name of the destination resource
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +destination_name +FROM aws.logs.destinations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the destinations resource, the following permissions are required: + +### Create +```json +logs:PutDestination, +logs:PutDestinationPolicy, +logs:DescribeDestinations, +iam:PassRole +``` + +### List +```json +logs:DescribeDestinations +``` + diff --git a/docs/aws-docs/providers/aws/logs/index.md b/docs/aws-docs/providers/aws/logs/index.md new file mode 100644 index 0000000000..f4b2ad33ad --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/logs/log_anomaly_detector/index.md b/docs/aws-docs/providers/aws/logs/log_anomaly_detector/index.md new file mode 100644 index 0000000000..361fb487d0 --- /dev/null +++ b/docs/aws-docs/providers/aws/logs/log_anomaly_detector/index.md @@ -0,0 +1,107 @@ +--- +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
DescriptionThe AWS::Logs::LogAnomalyDetector resource specifies a CloudWatch Logs LogAnomalyDetector.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.logs.log_anomaly_detector +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the log_anomaly_detector resource, the following permissions are required: + +### Read +```json +logs:GetLogAnomalyDetector +``` + +### Update +```json +logs:UpdateLogAnomalyDetector +``` + +### Delete +```json +logs:DeleteLogAnomalyDetector +``` + diff --git a/docs/aws-docs/providers/aws/logs/log_anomaly_detectors/index.md b/docs/aws-docs/providers/aws/logs/log_anomaly_detectors/index.md new file mode 100644 index 0000000000..e1ee5e0deb --- /dev/null +++ b/docs/aws-docs/providers/aws/logs/log_anomaly_detectors/index.md @@ -0,0 +1,77 @@ +--- +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
DescriptionThe AWS::Logs::LogAnomalyDetector resource specifies a CloudWatch Logs LogAnomalyDetector.
Idaws.logs.log_anomaly_detectors
+ +## Fields + + + + + +
NameDatatypeDescription
anomaly_detector_arnstringARN of LogAnomalyDetector
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +anomaly_detector_arn +FROM aws.logs.log_anomaly_detectors +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the log_anomaly_detectors resource, the following permissions are required: + +### Create +```json +logs:CreateLogAnomalyDetector +``` + +### List +```json +logs:ListLogAnomalyDetectors +``` + diff --git a/docs/aws-docs/providers/aws/logs/log_stream/index.md b/docs/aws-docs/providers/aws/logs/log_stream/index.md new file mode 100644 index 0000000000..d147688f07 --- /dev/null +++ b/docs/aws-docs/providers/aws/logs/log_stream/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource Type definition for AWS::Logs::LogStream
Idaws.logs.log_stream
+ +## Fields + + + + + + +
NameDatatypeDescription
log_stream_namestringThe name of the log stream. The name must be unique wihtin the log group.
log_group_namestringThe name of the log group where the log stream is created.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +log_stream_name, +log_group_name +FROM aws.logs.log_stream +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the log_stream resource, the following permissions are required: + +### Read +```json +logs:DescribeLogStreams +``` + +### Delete +```json +logs:DeleteLogStream +``` + diff --git a/docs/aws-docs/providers/aws/logs/log_streams/index.md b/docs/aws-docs/providers/aws/logs/log_streams/index.md new file mode 100644 index 0000000000..ca50b10d4c --- /dev/null +++ b/docs/aws-docs/providers/aws/logs/log_streams/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionResource Type definition for AWS::Logs::LogStream
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +log_group_name, +log_stream_name +FROM aws.logs.log_streams +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the log_streams resource, the following permissions are required: + +### Create +```json +logs:CreateLogStream, +logs:DescribeLogStreams +``` + +### List +```json +logs:DescribeLogStreams +``` + diff --git a/docs/aws-docs/providers/aws/logs/metric_filter/index.md b/docs/aws-docs/providers/aws/logs/metric_filter/index.md new file mode 100644 index 0000000000..648dcc6570 --- /dev/null +++ b/docs/aws-docs/providers/aws/logs/metric_filter/index.md @@ -0,0 +1,94 @@ +--- +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
DescriptionThe ``AWS::Logs::MetricFilter`` resource specifies a metric filter that describes how CWL extracts information from logs and transforms it into Amazon CloudWatch metrics. If you have multiple metric filters that are associated with a log group, all the filters are applied to the log streams in that group.<br/> The maximum number of metric filters that can be associated with a log group is 100.
Idaws.logs.metric_filter
+ +## Fields + + + + + + + + +
NameDatatypeDescription
metric_transformationsarrayThe metric transformations.
filter_patternstringA filter pattern for extracting metric data out of ingested log events. For more information, see [Filter and Pattern Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html).
log_group_namestringThe name of an existing log group that you want to associate with this metric filter.
filter_namestringThe name of the metric filter.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +metric_transformations, +filter_pattern, +log_group_name, +filter_name +FROM aws.logs.metric_filter +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the metric_filter resource, the following permissions are required: + +### Read +```json +logs:DescribeMetricFilters +``` + +### Update +```json +logs:PutMetricFilter, +logs:DescribeMetricFilters +``` + +### Delete +```json +logs:DeleteMetricFilter +``` + diff --git a/docs/aws-docs/providers/aws/logs/metric_filters/index.md b/docs/aws-docs/providers/aws/logs/metric_filters/index.md new file mode 100644 index 0000000000..537de6308d --- /dev/null +++ b/docs/aws-docs/providers/aws/logs/metric_filters/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionThe ``AWS::Logs::MetricFilter`` resource specifies a metric filter that describes how CWL extracts information from logs and transforms it into Amazon CloudWatch metrics. If you have multiple metric filters that are associated with a log group, all the filters are applied to the log streams in that group.<br/> The maximum number of metric filters that can be associated with a log group is 100.
Idaws.logs.metric_filters
+ +## Fields + + + + + + +
NameDatatypeDescription
log_group_namestringThe name of an existing log group that you want to associate with this metric filter.
filter_namestringThe name of the metric filter.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +log_group_name, +filter_name +FROM aws.logs.metric_filters +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the metric_filters resource, the following permissions are required: + +### Create +```json +logs:PutMetricFilter, +logs:DescribeMetricFilters +``` + +### List +```json +logs:DescribeMetricFilters +``` + diff --git a/docs/aws-docs/providers/aws/logs/query_definition/index.md b/docs/aws-docs/providers/aws/logs/query_definition/index.md new file mode 100644 index 0000000000..55815c981a --- /dev/null +++ b/docs/aws-docs/providers/aws/logs/query_definition/index.md @@ -0,0 +1,93 @@ +--- +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
DescriptionThe resource schema for AWSLogs QueryDefinition
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +query_string, +log_group_names, +query_definition_id +FROM aws.logs.query_definition +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the query_definition resource, the following permissions are required: + +### Read +```json +logs:DescribeQueryDefinitions +``` + +### Update +```json +logs:PutQueryDefinition +``` + +### Delete +```json +logs:DeleteQueryDefinition +``` + diff --git a/docs/aws-docs/providers/aws/logs/query_definitions/index.md b/docs/aws-docs/providers/aws/logs/query_definitions/index.md new file mode 100644 index 0000000000..c308d42719 --- /dev/null +++ b/docs/aws-docs/providers/aws/logs/query_definitions/index.md @@ -0,0 +1,77 @@ +--- +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
DescriptionThe resource schema for AWSLogs QueryDefinition
Idaws.logs.query_definitions
+ +## Fields + + + + + +
NameDatatypeDescription
query_definition_idstringUnique identifier of a query definition
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +query_definition_id +FROM aws.logs.query_definitions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the query_definitions resource, the following permissions are required: + +### Create +```json +logs:PutQueryDefinition +``` + +### List +```json +logs:DescribeQueryDefinitions +``` + diff --git a/docs/aws-docs/providers/aws/logs/resource_policies/index.md b/docs/aws-docs/providers/aws/logs/resource_policies/index.md new file mode 100644 index 0000000000..8a868edc12 --- /dev/null +++ b/docs/aws-docs/providers/aws/logs/resource_policies/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionThe resource schema for AWSLogs ResourcePolicy
Idaws.logs.resource_policies
+ +## Fields + + + + + +
NameDatatypeDescription
policy_namestringA name for resource policy
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +policy_name +FROM aws.logs.resource_policies +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the resource_policies resource, the following permissions are required: + +### Create +```json +logs:PutResourcePolicy, +logs:DescribeResourcePolicies +``` + +### List +```json +logs:DescribeResourcePolicies +``` + diff --git a/docs/aws-docs/providers/aws/logs/resource_policy/index.md b/docs/aws-docs/providers/aws/logs/resource_policy/index.md new file mode 100644 index 0000000000..821f0e6fd0 --- /dev/null +++ b/docs/aws-docs/providers/aws/logs/resource_policy/index.md @@ -0,0 +1,91 @@ +--- +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
DescriptionThe resource schema for AWSLogs ResourcePolicy
Idaws.logs.resource_policy
+ +## Fields + + + + + + +
NameDatatypeDescription
policy_namestringA name for resource policy
policy_documentstringThe policy document
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +policy_name, +policy_document +FROM aws.logs.resource_policy +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the resource_policy resource, the following permissions are required: + +### Read +```json +logs:DescribeResourcePolicies +``` + +### Update +```json +logs:PutResourcePolicy, +logs:DescribeResourcePolicies, +logs:DeleteResourcePolicy +``` + +### Delete +```json +logs:DeleteResourcePolicy +``` + diff --git a/docs/aws-docs/providers/aws/logs/subscription_filter/index.md b/docs/aws-docs/providers/aws/logs/subscription_filter/index.md new file mode 100644 index 0000000000..7b0ba18c2b --- /dev/null +++ b/docs/aws-docs/providers/aws/logs/subscription_filter/index.md @@ -0,0 +1,99 @@ +--- +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
DescriptionThe ``AWS::Logs::SubscriptionFilter`` resource specifies a subscription filter and associates it with the specified log group. Subscription filters allow you to subscribe to a real-time stream of log events and have them delivered to a specific destination. Currently, the supported destinations are:<br/> + An Amazon Kinesis data stream belonging to the same account as the subscription filter, for same-account delivery.<br/> + A logical destination that belongs to a different account, for cross-account delivery.<br/> + An Amazon Kinesis Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery.<br/> + An LAMlong function that belongs to the same account as the subscription filter, for same-account delivery.<br/> <br/> There can be as many as two subscription filters associated with a log group.
Idaws.logs.subscription_filter
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
filter_namestringThe name of the subscription filter.
destination_arnstringThe Amazon Resource Name (ARN) of the destination.
filter_patternstringThe filtering expressions that restrict what gets delivered to the destination AWS resource. For more information about the filter pattern syntax, see [Filter and Pattern Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html).
log_group_namestringThe log group to associate with the subscription filter. All log events that are uploaded to this log group are filtered and delivered to the specified AWS resource if the filter pattern matches the log events.
role_arnstringThe ARN of an IAM role that grants CWL permissions to deliver ingested log events to the destination stream. You don't need to provide the ARN when you are working with a logical destination for cross-account delivery.
distributionstringThe method used to distribute log data to the destination, which can be either random or grouped by log stream.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +filter_name, +destination_arn, +filter_pattern, +log_group_name, +role_arn, +distribution +FROM aws.logs.subscription_filter +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the subscription_filter resource, the following permissions are required: + +### Read +```json +logs:DescribeSubscriptionFilters +``` + +### Update +```json +iam:PassRole, +logs:PutSubscriptionFilter, +logs:DescribeSubscriptionFilters +``` + +### Delete +```json +logs:DeleteSubscriptionFilter +``` + diff --git a/docs/aws-docs/providers/aws/logs/subscription_filters/index.md b/docs/aws-docs/providers/aws/logs/subscription_filters/index.md new file mode 100644 index 0000000000..1fac2dffee --- /dev/null +++ b/docs/aws-docs/providers/aws/logs/subscription_filters/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionThe ``AWS::Logs::SubscriptionFilter`` resource specifies a subscription filter and associates it with the specified log group. Subscription filters allow you to subscribe to a real-time stream of log events and have them delivered to a specific destination. Currently, the supported destinations are:<br/> + An Amazon Kinesis data stream belonging to the same account as the subscription filter, for same-account delivery.<br/> + A logical destination that belongs to a different account, for cross-account delivery.<br/> + An Amazon Kinesis Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery.<br/> + An LAMlong function that belongs to the same account as the subscription filter, for same-account delivery.<br/> <br/> There can be as many as two subscription filters associated with a log group.
Idaws.logs.subscription_filters
+ +## Fields + + + + + + +
NameDatatypeDescription
filter_namestringThe name of the subscription filter.
log_group_namestringThe log group to associate with the subscription filter. All log events that are uploaded to this log group are filtered and delivered to the specified AWS resource if the filter pattern matches the log events.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +filter_name, +log_group_name +FROM aws.logs.subscription_filters +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the subscription_filters resource, the following permissions are required: + +### Create +```json +iam:PassRole, +logs:PutSubscriptionFilter, +logs:DescribeSubscriptionFilters +``` + +### List +```json +logs:DescribeSubscriptionFilters +``` + diff --git a/docs/aws-docs/providers/aws/lookoutequipment/index.md b/docs/aws-docs/providers/aws/lookoutequipment/index.md new file mode 100644 index 0000000000..29089b225b --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/lookoutequipment/inference_scheduler/index.md b/docs/aws-docs/providers/aws/lookoutequipment/inference_scheduler/index.md new file mode 100644 index 0000000000..ef9f3e2a94 --- /dev/null +++ b/docs/aws-docs/providers/aws/lookoutequipment/inference_scheduler/index.md @@ -0,0 +1,110 @@ +--- +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
DescriptionResource schema for LookoutEquipment InferenceScheduler.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.lookoutequipment.inference_scheduler +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the inference_scheduler resource, the following permissions are required: + +### Read +```json +lookoutequipment:DescribeInferenceScheduler +``` + +### Delete +```json +lookoutequipment:DeleteInferenceScheduler, +lookoutequipment:StopInferenceScheduler, +lookoutequipment:DescribeInferenceScheduler +``` + +### Update +```json +lookoutequipment:UpdateInferenceScheduler, +lookoutequipment:DescribeInferenceScheduler, +lookoutequipment:StopInferenceScheduler, +lookoutequipment:StartInferenceScheduler +``` + diff --git a/docs/aws-docs/providers/aws/lookoutequipment/inference_schedulers/index.md b/docs/aws-docs/providers/aws/lookoutequipment/inference_schedulers/index.md new file mode 100644 index 0000000000..4ff7fea68f --- /dev/null +++ b/docs/aws-docs/providers/aws/lookoutequipment/inference_schedulers/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource schema for LookoutEquipment InferenceScheduler.
Idaws.lookoutequipment.inference_schedulers
+ +## Fields + + + + + +
NameDatatypeDescription
inference_scheduler_namestringThe name of the inference scheduler being created.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +inference_scheduler_name +FROM aws.lookoutequipment.inference_schedulers +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the inference_schedulers resource, the following permissions are required: + +### Create +```json +iam:PassRole, +lookoutequipment:CreateInferenceScheduler, +lookoutequipment:DescribeInferenceScheduler +``` + +### List +```json +lookoutequipment:ListInferenceSchedulers +``` + diff --git a/docs/aws-docs/providers/aws/lookoutmetrics/alert/index.md b/docs/aws-docs/providers/aws/lookoutmetrics/alert/index.md new file mode 100644 index 0000000000..ae845bf9b1 --- /dev/null +++ b/docs/aws-docs/providers/aws/lookoutmetrics/alert/index.md @@ -0,0 +1,87 @@ +--- +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
DescriptionResource Type definition for AWS::LookoutMetrics::Alert
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +alert_name, +arn, +alert_description, +anomaly_detector_arn, +alert_sensitivity_threshold, +action +FROM aws.lookoutmetrics.alert +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the alert resource, the following permissions are required: + +### Read +```json +lookoutmetrics:DescribeAlert +``` + +### Delete +```json +lookoutmetrics:DeleteAlert +``` + diff --git a/docs/aws-docs/providers/aws/lookoutmetrics/alerts/index.md b/docs/aws-docs/providers/aws/lookoutmetrics/alerts/index.md new file mode 100644 index 0000000000..28d5be8d68 --- /dev/null +++ b/docs/aws-docs/providers/aws/lookoutmetrics/alerts/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionResource Type definition for AWS::LookoutMetrics::Alert
Idaws.lookoutmetrics.alerts
+ +## Fields + + + + + +
NameDatatypeDescription
arnundefinedARN assigned to the alert.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.lookoutmetrics.alerts +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the alerts resource, the following permissions are required: + +### Create +```json +lookoutmetrics:CreateAlert, +iam:PassRole +``` + +### List +```json +lookoutmetrics:ListAlerts +``` + diff --git a/docs/aws-docs/providers/aws/lookoutmetrics/anomaly_detector/index.md b/docs/aws-docs/providers/aws/lookoutmetrics/anomaly_detector/index.md new file mode 100644 index 0000000000..892e8c9ebc --- /dev/null +++ b/docs/aws-docs/providers/aws/lookoutmetrics/anomaly_detector/index.md @@ -0,0 +1,101 @@ +--- +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
DescriptionAn Amazon Lookout for Metrics Detector
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +anomaly_detector_name, +anomaly_detector_description, +anomaly_detector_config, +metric_set_list, +kms_key_arn +FROM aws.lookoutmetrics.anomaly_detector +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the anomaly_detector resource, the following permissions are required: + +### Read +```json +lookoutmetrics:DescribeAnomalyDetector, +lookoutmetrics:DescribeMetricSet, +lookoutmetrics:ListMetricSets +``` + +### Update +```json +lookoutmetrics:UpdateAnomalyDetector, +lookoutmetrics:UpdateMetricSet +``` + +### Delete +```json +lookoutmetrics:DescribeAnomalyDetector, +lookoutmetrics:DeleteAnomalyDetector +``` + diff --git a/docs/aws-docs/providers/aws/lookoutmetrics/anomaly_detectors/index.md b/docs/aws-docs/providers/aws/lookoutmetrics/anomaly_detectors/index.md new file mode 100644 index 0000000000..ff85198cee --- /dev/null +++ b/docs/aws-docs/providers/aws/lookoutmetrics/anomaly_detectors/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionAn Amazon Lookout for Metrics Detector
Idaws.lookoutmetrics.anomaly_detectors
+ +## Fields + + + + + +
NameDatatypeDescription
arnundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.lookoutmetrics.anomaly_detectors +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the anomaly_detectors resource, the following permissions are required: + +### Create +```json +lookoutmetrics:CreateAnomalyDetector, +lookoutmetrics:DeleteAnomalyDetector, +lookoutmetrics:CreateMetricSet, +iam:PassRole +``` + +### List +```json +lookoutmetrics:ListAnomalyDetectors +``` + diff --git a/docs/aws-docs/providers/aws/lookoutmetrics/index.md b/docs/aws-docs/providers/aws/lookoutmetrics/index.md new file mode 100644 index 0000000000..9bb671ca33 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/lookoutvision/index.md b/docs/aws-docs/providers/aws/lookoutvision/index.md new file mode 100644 index 0000000000..ddc0ef5a15 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/lookoutvision/project/index.md b/docs/aws-docs/providers/aws/lookoutvision/project/index.md new file mode 100644 index 0000000000..42419b74e6 --- /dev/null +++ b/docs/aws-docs/providers/aws/lookoutvision/project/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionThe AWS::LookoutVision::Project type creates an Amazon Lookout for Vision project. A project is a grouping of the resources needed to create and manage a Lookout for Vision model.
Idaws.lookoutvision.project
+ +## Fields + + + + + + +
NameDatatypeDescription
arnstring
project_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +project_name +FROM aws.lookoutvision.project +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the project resource, the following permissions are required: + +### Read +```json +lookoutvision:DescribeProject +``` + +### Delete +```json +lookoutvision:DeleteProject +``` + diff --git a/docs/aws-docs/providers/aws/lookoutvision/projects/index.md b/docs/aws-docs/providers/aws/lookoutvision/projects/index.md new file mode 100644 index 0000000000..9e0ba0856d --- /dev/null +++ b/docs/aws-docs/providers/aws/lookoutvision/projects/index.md @@ -0,0 +1,77 @@ +--- +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
DescriptionThe AWS::LookoutVision::Project type creates an Amazon Lookout for Vision project. A project is a grouping of the resources needed to create and manage a Lookout for Vision model.
Idaws.lookoutvision.projects
+ +## Fields + + + + + +
NameDatatypeDescription
project_nameundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +project_name +FROM aws.lookoutvision.projects +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the projects resource, the following permissions are required: + +### Create +```json +lookoutvision:CreateProject +``` + +### List +```json +lookoutvision:ListProjects +``` + diff --git a/docs/aws-docs/providers/aws/m2/application/index.md b/docs/aws-docs/providers/aws/m2/application/index.md new file mode 100644 index 0000000000..446ad8cd9b --- /dev/null +++ b/docs/aws-docs/providers/aws/m2/application/index.md @@ -0,0 +1,114 @@ +--- +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
DescriptionRepresents an application that runs on an AWS Mainframe Modernization Environment
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +application_arn, +application_id, +definition, +description, +engine_type, +kms_key_id, +name, +role_arn, +tags +FROM aws.m2.application +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the application resource, the following permissions are required: + +### Read +```json +m2:GetApplication, +m2:ListTagsForResource +``` + +### Update +```json +m2:UpdateApplication, +m2:GetApplication, +m2:ListTagsForResource, +m2:TagResource, +m2:UntagResource, +s3:GetObject, +s3:ListBucket +``` + +### Delete +```json +elasticloadbalancing:DeleteListener, +elasticloadbalancing:DeleteTargetGroup, +logs:DeleteLogDelivery, +m2:GetApplication, +m2:DeleteApplication +``` + diff --git a/docs/aws-docs/providers/aws/m2/applications/index.md b/docs/aws-docs/providers/aws/m2/applications/index.md new file mode 100644 index 0000000000..efe9770551 --- /dev/null +++ b/docs/aws-docs/providers/aws/m2/applications/index.md @@ -0,0 +1,85 @@ +--- +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
DescriptionRepresents an application that runs on an AWS Mainframe Modernization Environment
Idaws.m2.applications
+ +## Fields + + + + + +
NameDatatypeDescription
application_arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +application_arn +FROM aws.m2.applications +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the applications resource, the following permissions are required: + +### Create +```json +m2:CreateApplication, +m2:GetApplication, +m2:ListTagsForResource, +m2:TagResource, +s3:GetObject, +s3:ListBucket, +kms:DescribeKey, +kms:CreateGrant, +iam:PassRole +``` + +### List +```json +m2:ListApplications +``` + diff --git a/docs/aws-docs/providers/aws/m2/environment/index.md b/docs/aws-docs/providers/aws/m2/environment/index.md new file mode 100644 index 0000000000..e74b9908f6 --- /dev/null +++ b/docs/aws-docs/providers/aws/m2/environment/index.md @@ -0,0 +1,122 @@ +--- +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
DescriptionRepresents a runtime environment that can run migrated mainframe applications.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.m2.environment +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the environment resource, the following permissions are required: + +### Read +```json +m2:ListTagsForResource, +m2:GetEnvironment +``` + +### Update +```json +m2:TagResource, +m2:UntagResource, +m2:ListTagsForResource, +m2:GetEnvironment, +m2:UpdateEnvironment +``` + +### Delete +```json +elasticloadbalancing:DeleteLoadBalancer, +m2:DeleteEnvironment, +m2:GetEnvironment +``` + diff --git a/docs/aws-docs/providers/aws/m2/environments/index.md b/docs/aws-docs/providers/aws/m2/environments/index.md new file mode 100644 index 0000000000..a3d2bcfc6c --- /dev/null +++ b/docs/aws-docs/providers/aws/m2/environments/index.md @@ -0,0 +1,95 @@ +--- +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
DescriptionRepresents a runtime environment that can run migrated mainframe applications.
Idaws.m2.environments
+ +## Fields + + + + + +
NameDatatypeDescription
environment_arnstringThe Amazon Resource Name (ARN) of the runtime environment.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +environment_arn +FROM aws.m2.environments +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the environments resource, the following permissions are required: + +### Create +```json +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 +```json +m2:ListEnvironments +``` + diff --git a/docs/aws-docs/providers/aws/m2/index.md b/docs/aws-docs/providers/aws/m2/index.md new file mode 100644 index 0000000000..6dc62d76be --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/macie/allow_list/index.md b/docs/aws-docs/providers/aws/macie/allow_list/index.md new file mode 100644 index 0000000000..3c8e2c6828 --- /dev/null +++ b/docs/aws-docs/providers/aws/macie/allow_list/index.md @@ -0,0 +1,102 @@ +--- +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
DescriptionMacie AllowList resource schema
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +description, +criteria, +id, +arn, +status, +tags +FROM aws.macie.allow_list +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the allow_list resource, the following permissions are required: + +### Read +```json +macie2:GetAllowList +``` + +### Update +```json +macie2:UpdateAllowList, +macie2:GetAllowList, +macie2:TagResource, +macie2:UntagResource +``` + +### Delete +```json +macie2:DeleteAllowList +``` + diff --git a/docs/aws-docs/providers/aws/macie/allow_lists/index.md b/docs/aws-docs/providers/aws/macie/allow_lists/index.md new file mode 100644 index 0000000000..3dace99ca2 --- /dev/null +++ b/docs/aws-docs/providers/aws/macie/allow_lists/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionMacie AllowList resource schema
Idaws.macie.allow_lists
+ +## Fields + + + + + +
NameDatatypeDescription
idstringAllowList ID.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.macie.allow_lists +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the allow_lists resource, the following permissions are required: + +### Create +```json +macie2:CreateAllowList, +macie2:GetAllowList, +macie2:TagResource +``` + +### List +```json +macie2:ListAllowLists +``` + diff --git a/docs/aws-docs/providers/aws/macie/custom_data_identifier/index.md b/docs/aws-docs/providers/aws/macie/custom_data_identifier/index.md new file mode 100644 index 0000000000..1638a83519 --- /dev/null +++ b/docs/aws-docs/providers/aws/macie/custom_data_identifier/index.md @@ -0,0 +1,104 @@ +--- +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
DescriptionMacie CustomDataIdentifier resource schema
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +description, +regex, +maximum_match_distance, +keywords, +ignore_words, +id, +arn, +tags +FROM aws.macie.custom_data_identifier +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the custom_data_identifier resource, the following permissions are required: + +### Read +```json +macie2:GetCustomDataIdentifier +``` + +### Delete +```json +macie2:DeleteCustomDataIdentifier +``` + +### Update +```json +macie2:TagResource, +macie2:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/macie/custom_data_identifiers/index.md b/docs/aws-docs/providers/aws/macie/custom_data_identifiers/index.md new file mode 100644 index 0000000000..81941a9edc --- /dev/null +++ b/docs/aws-docs/providers/aws/macie/custom_data_identifiers/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionMacie CustomDataIdentifier resource schema
Idaws.macie.custom_data_identifiers
+ +## Fields + + + + + +
NameDatatypeDescription
idstringCustom data identifier ID.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.macie.custom_data_identifiers +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the custom_data_identifiers resource, the following permissions are required: + +### Create +```json +macie2:CreateCustomDataIdentifier, +macie2:GetCustomDataIdentifier, +macie2:TagResource +``` + +### List +```json +macie2:ListCustomDataIdentifiers +``` + diff --git a/docs/aws-docs/providers/aws/macie/findings_filter/index.md b/docs/aws-docs/providers/aws/macie/findings_filter/index.md new file mode 100644 index 0000000000..798e271c93 --- /dev/null +++ b/docs/aws-docs/providers/aws/macie/findings_filter/index.md @@ -0,0 +1,104 @@ +--- +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
DescriptionMacie FindingsFilter resource schema.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +description, +finding_criteria, +action, +position, +id, +arn, +tags +FROM aws.macie.findings_filter +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the findings_filter resource, the following permissions are required: + +### Read +```json +macie2:GetFindingsFilter +``` + +### Update +```json +macie2:GetFindingsFilter, +macie2:UpdateFindingsFilter, +macie2:TagResource, +macie2:UntagResource +``` + +### Delete +```json +macie2:DeleteFindingsFilter +``` + diff --git a/docs/aws-docs/providers/aws/macie/findings_filters/index.md b/docs/aws-docs/providers/aws/macie/findings_filters/index.md new file mode 100644 index 0000000000..e8a90f05b7 --- /dev/null +++ b/docs/aws-docs/providers/aws/macie/findings_filters/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionMacie FindingsFilter resource schema.
Idaws.macie.findings_filters
+ +## Fields + + + + + +
NameDatatypeDescription
idstringFindings filter ID.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.macie.findings_filters +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the findings_filters resource, the following permissions are required: + +### Create +```json +macie2:GetFindingsFilter, +macie2:CreateFindingsFilter, +macie2:TagResource +``` + +### List +```json +macie2:ListFindingsFilters +``` + diff --git a/docs/aws-docs/providers/aws/macie/index.md b/docs/aws-docs/providers/aws/macie/index.md new file mode 100644 index 0000000000..860021f5bb --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/macie/session/index.md b/docs/aws-docs/providers/aws/macie/session/index.md new file mode 100644 index 0000000000..6e18ca5877 --- /dev/null +++ b/docs/aws-docs/providers/aws/macie/session/index.md @@ -0,0 +1,94 @@ +--- +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
DescriptionThe AWS::Macie::Session resource specifies a new Amazon Macie session. A session is an object that represents the Amazon Macie service. A session is required for Amazon Macie to become operational.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +aws_account_id, +status, +finding_publishing_frequency, +service_role +FROM aws.macie.session +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the session resource, the following permissions are required: + +### Read +```json +macie2:GetMacieSession +``` + +### Update +```json +macie2:GetMacieSession, +macie2:UpdateMacieSession +``` + +### Delete +```json +macie2:DisableMacie +``` + diff --git a/docs/aws-docs/providers/aws/macie/sessions/index.md b/docs/aws-docs/providers/aws/macie/sessions/index.md new file mode 100644 index 0000000000..8dbe88e73a --- /dev/null +++ b/docs/aws-docs/providers/aws/macie/sessions/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionThe AWS::Macie::Session resource specifies a new Amazon Macie session. A session is an object that represents the Amazon Macie service. A session is required for Amazon Macie to become operational.
Idaws.macie.sessions
+ +## Fields + + + + + +
NameDatatypeDescription
aws_account_idstringAWS account ID of customer
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +aws_account_id +FROM aws.macie.sessions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the sessions resource, the following permissions are required: + +### Create +```json +macie2:GetMacieSession, +macie2:EnableMacie +``` + +### List +```json +macie2:GetMacieSession +``` + diff --git a/docs/aws-docs/providers/aws/managedblockchain/accessor/index.md b/docs/aws-docs/providers/aws/managedblockchain/accessor/index.md new file mode 100644 index 0000000000..035cc2f47d --- /dev/null +++ b/docs/aws-docs/providers/aws/managedblockchain/accessor/index.md @@ -0,0 +1,104 @@ +--- +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
DescriptionDefinition of AWS::ManagedBlockchain::com.amazonaws.taiga.webservice.api#Accessor Resource Type
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +billing_token, +creation_date, +id, +status, +accessor_type, +network_type, +tags +FROM aws.managedblockchain.accessor +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the accessor resource, the following permissions are required: + +### Read +```json +managedblockchain:GetAccessor +``` + +### Update +```json +managedblockchain:GetAccessor, +managedblockchain:CreateAccessor, +managedblockchain:TagResource, +managedblockchain:UntagResource +``` + +### Delete +```json +managedblockchain:DeleteAccessor +``` + diff --git a/docs/aws-docs/providers/aws/managedblockchain/accessors/index.md b/docs/aws-docs/providers/aws/managedblockchain/accessors/index.md new file mode 100644 index 0000000000..e30e35adc3 --- /dev/null +++ b/docs/aws-docs/providers/aws/managedblockchain/accessors/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionDefinition of AWS::ManagedBlockchain::com.amazonaws.taiga.webservice.api#Accessor Resource Type
Idaws.managedblockchain.accessors
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.managedblockchain.accessors +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the accessors resource, the following permissions are required: + +### Create +```json +managedblockchain:CreateAccessor, +managedblockchain:TagResource, +managedblockchain:GetAccessor +``` + +### List +```json +managedblockchain:ListAccessors +``` + diff --git a/docs/aws-docs/providers/aws/managedblockchain/index.md b/docs/aws-docs/providers/aws/managedblockchain/index.md new file mode 100644 index 0000000000..f14231fb7b --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/mediaconnect/bridge/index.md b/docs/aws-docs/providers/aws/mediaconnect/bridge/index.md new file mode 100644 index 0000000000..d81d3d1f14 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediaconnect/bridge/index.md @@ -0,0 +1,105 @@ +--- +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
DescriptionResource schema for AWS::MediaConnect::Bridge
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +bridge_arn, +placement_arn, +bridge_state, +source_failover_config, +outputs, +sources, +ingress_gateway_bridge, +egress_gateway_bridge +FROM aws.mediaconnect.bridge +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the bridge resource, the following permissions are required: + +### Read +```json +mediaconnect:DescribeBridge +``` + +### Update +```json +mediaconnect:DescribeBridge, +mediaconnect:UpdateBridge +``` + +### Delete +```json +mediaconnect:DescribeBridge, +mediaconnect:DeleteBridge +``` + diff --git a/docs/aws-docs/providers/aws/mediaconnect/bridge_output/index.md b/docs/aws-docs/providers/aws/mediaconnect/bridge_output/index.md new file mode 100644 index 0000000000..ba24979cc5 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediaconnect/bridge_output/index.md @@ -0,0 +1,92 @@ +--- +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
DescriptionResource schema for AWS::MediaConnect::BridgeOutput
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +bridge_arn, +network_output, +name +FROM aws.mediaconnect.bridge_output +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the bridge_output resource, the following permissions are required: + +### Read +```json +mediaconnect:DescribeBridge +``` + +### Update +```json +mediaconnect:DescribeBridge, +mediaconnect:UpdateBridgeOutput +``` + +### Delete +```json +mediaconnect:RemoveBridgeOutput +``` + diff --git a/docs/aws-docs/providers/aws/mediaconnect/bridge_outputs/index.md b/docs/aws-docs/providers/aws/mediaconnect/bridge_outputs/index.md new file mode 100644 index 0000000000..f15caf7a1c --- /dev/null +++ b/docs/aws-docs/providers/aws/mediaconnect/bridge_outputs/index.md @@ -0,0 +1,70 @@ +--- +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
DescriptionResource schema for AWS::MediaConnect::BridgeOutput
Idaws.mediaconnect.bridge_outputs
+ +## Fields + + + + + + +
NameDatatypeDescription
bridge_arnstringThe Amazon Resource Number (ARN) of the bridge.
namestringThe network output name.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +bridge_arn, +name +FROM aws.mediaconnect.bridge_outputs +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the bridge_outputs resource, the following permissions are required: + +### Create +```json +mediaconnect:AddBridgeOutputs, +mediaconnect:DescribeBridge +``` + diff --git a/docs/aws-docs/providers/aws/mediaconnect/bridge_source/index.md b/docs/aws-docs/providers/aws/mediaconnect/bridge_source/index.md new file mode 100644 index 0000000000..80ef457770 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediaconnect/bridge_source/index.md @@ -0,0 +1,94 @@ +--- +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
DescriptionResource schema for AWS::MediaConnect::BridgeSource
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +bridge_arn, +flow_source, +network_source +FROM aws.mediaconnect.bridge_source +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the bridge_source resource, the following permissions are required: + +### Read +```json +mediaconnect:DescribeBridge +``` + +### Update +```json +mediaconnect:DescribeBridge, +mediaconnect:UpdateBridgeSource +``` + +### Delete +```json +mediaconnect:RemoveBridgeSource +``` + diff --git a/docs/aws-docs/providers/aws/mediaconnect/bridge_sources/index.md b/docs/aws-docs/providers/aws/mediaconnect/bridge_sources/index.md new file mode 100644 index 0000000000..e3d8db5ede --- /dev/null +++ b/docs/aws-docs/providers/aws/mediaconnect/bridge_sources/index.md @@ -0,0 +1,70 @@ +--- +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
DescriptionResource schema for AWS::MediaConnect::BridgeSource
Idaws.mediaconnect.bridge_sources
+ +## Fields + + + + + + +
NameDatatypeDescription
bridge_arnstringThe Amazon Resource Number (ARN) of the bridge.
namestringThe name of the source.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +bridge_arn, +name +FROM aws.mediaconnect.bridge_sources +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the bridge_sources resource, the following permissions are required: + +### Create +```json +mediaconnect:AddBridgeSources, +mediaconnect:DescribeBridge +``` + diff --git a/docs/aws-docs/providers/aws/mediaconnect/bridges/index.md b/docs/aws-docs/providers/aws/mediaconnect/bridges/index.md new file mode 100644 index 0000000000..ef2638e02b --- /dev/null +++ b/docs/aws-docs/providers/aws/mediaconnect/bridges/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionResource schema for AWS::MediaConnect::Bridge
Idaws.mediaconnect.bridges
+ +## Fields + + + + + +
NameDatatypeDescription
bridge_arnstringThe Amazon Resource Number (ARN) of the bridge.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +bridge_arn +FROM aws.mediaconnect.bridges +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the bridges resource, the following permissions are required: + +### Create +```json +mediaconnect:CreateBridge, +mediaconnect:DescribeBridge +``` + +### List +```json +mediaconnect:ListBridges +``` + diff --git a/docs/aws-docs/providers/aws/mediaconnect/flow/index.md b/docs/aws-docs/providers/aws/mediaconnect/flow/index.md new file mode 100644 index 0000000000..cbd45d7979 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediaconnect/flow/index.md @@ -0,0 +1,100 @@ +--- +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
DescriptionResource schema for AWS::MediaConnect::Flow
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +flow_arn, +name, +availability_zone, +flow_availability_zone, +source, +source_failover_config +FROM aws.mediaconnect.flow +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the flow resource, the following permissions are required: + +### Read +```json +mediaconnect:DescribeFlow +``` + +### Update +```json +mediaconnect:DescribeFlow, +mediaconnect:UpdateFlow, +mediaconnect:UpdateFlowSource +``` + +### Delete +```json +mediaconnect:DescribeFlow, +mediaconnect:DeleteFlow +``` + diff --git a/docs/aws-docs/providers/aws/mediaconnect/flow_entitlement/index.md b/docs/aws-docs/providers/aws/mediaconnect/flow_entitlement/index.md new file mode 100644 index 0000000000..f4b36dafc8 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediaconnect/flow_entitlement/index.md @@ -0,0 +1,103 @@ +--- +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
DescriptionResource schema for AWS::MediaConnect::FlowEntitlement
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +flow_arn, +entitlement_arn, +data_transfer_subscriber_fee_percent, +description, +encryption, +entitlement_status, +name, +subscribers +FROM aws.mediaconnect.flow_entitlement +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the flow_entitlement resource, the following permissions are required: + +### Read +```json +mediaconnect:DescribeFlow +``` + +### Update +```json +mediaconnect:DescribeFlow, +mediaconnect:UpdateFlowEntitlement +``` + +### Delete +```json +mediaconnect:DescribeFlow, +mediaconnect:RevokeFlowEntitlement +``` + diff --git a/docs/aws-docs/providers/aws/mediaconnect/flow_entitlements/index.md b/docs/aws-docs/providers/aws/mediaconnect/flow_entitlements/index.md new file mode 100644 index 0000000000..29bbaac65d --- /dev/null +++ b/docs/aws-docs/providers/aws/mediaconnect/flow_entitlements/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionResource schema for AWS::MediaConnect::FlowEntitlement
Idaws.mediaconnect.flow_entitlements
+ +## Fields + + + + + +
NameDatatypeDescription
entitlement_arnstringThe ARN of the entitlement.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +entitlement_arn +FROM aws.mediaconnect.flow_entitlements +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the flow_entitlements resource, the following permissions are required: + +### Create +```json +iam:PassRole, +mediaconnect:GrantFlowEntitlements +``` + +### List +```json +mediaconnect:DescribeFlow +``` + diff --git a/docs/aws-docs/providers/aws/mediaconnect/flow_output/index.md b/docs/aws-docs/providers/aws/mediaconnect/flow_output/index.md new file mode 100644 index 0000000000..294bda4927 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediaconnect/flow_output/index.md @@ -0,0 +1,117 @@ +--- +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
DescriptionResource schema for AWS::MediaConnect::FlowOutput
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.mediaconnect.flow_output +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the flow_output resource, the following permissions are required: + +### Read +```json +mediaconnect:DescribeFlow +``` + +### Update +```json +mediaconnect:DescribeFlow, +mediaconnect:UpdateFlowOutput +``` + +### Delete +```json +mediaconnect:DescribeFlow, +mediaconnect:RemoveFlowOutput +``` + diff --git a/docs/aws-docs/providers/aws/mediaconnect/flow_outputs/index.md b/docs/aws-docs/providers/aws/mediaconnect/flow_outputs/index.md new file mode 100644 index 0000000000..364c4cf662 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediaconnect/flow_outputs/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionResource schema for AWS::MediaConnect::FlowOutput
Idaws.mediaconnect.flow_outputs
+ +## Fields + + + + + +
NameDatatypeDescription
output_arnstringThe ARN of the output.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +output_arn +FROM aws.mediaconnect.flow_outputs +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the flow_outputs resource, the following permissions are required: + +### Create +```json +iam:PassRole, +mediaconnect:AddFlowOutputs +``` + +### List +```json +mediaconnect:DescribeFlow +``` + diff --git a/docs/aws-docs/providers/aws/mediaconnect/flow_source/index.md b/docs/aws-docs/providers/aws/mediaconnect/flow_source/index.md new file mode 100644 index 0000000000..3b662fddba --- /dev/null +++ b/docs/aws-docs/providers/aws/mediaconnect/flow_source/index.md @@ -0,0 +1,129 @@ +--- +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
DescriptionResource schema for AWS::MediaConnect::FlowSource
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.mediaconnect.flow_source +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the flow_source resource, the following permissions are required: + +### Read +```json +mediaconnect:DescribeFlow +``` + +### Update +```json +mediaconnect:DescribeFlow, +mediaconnect:UpdateFlowSource +``` + +### Delete +```json +mediaconnect:DescribeFlow, +mediaconnect:RemoveFlowSource +``` + diff --git a/docs/aws-docs/providers/aws/mediaconnect/flow_sources/index.md b/docs/aws-docs/providers/aws/mediaconnect/flow_sources/index.md new file mode 100644 index 0000000000..787bf2478c --- /dev/null +++ b/docs/aws-docs/providers/aws/mediaconnect/flow_sources/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionResource schema for AWS::MediaConnect::FlowSource
Idaws.mediaconnect.flow_sources
+ +## Fields + + + + + +
NameDatatypeDescription
source_arnstringThe ARN of the source.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +source_arn +FROM aws.mediaconnect.flow_sources +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the flow_sources resource, the following permissions are required: + +### Create +```json +mediaconnect:CreateFlow, +mediaconnect:DescribeFlow, +mediaconnect:AddFlowSources, +iam:PassRole +``` + +### List +```json +mediaconnect:DescribeFlow +``` + diff --git a/docs/aws-docs/providers/aws/mediaconnect/flow_vpc_interface/index.md b/docs/aws-docs/providers/aws/mediaconnect/flow_vpc_interface/index.md new file mode 100644 index 0000000000..e843581c9e --- /dev/null +++ b/docs/aws-docs/providers/aws/mediaconnect/flow_vpc_interface/index.md @@ -0,0 +1,100 @@ +--- +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
DescriptionResource schema for AWS::MediaConnect::FlowVpcInterface
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +flow_arn, +name, +role_arn, +security_group_ids, +subnet_id, +network_interface_ids +FROM aws.mediaconnect.flow_vpc_interface +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the flow_vpc_interface resource, the following permissions are required: + +### Read +```json +mediaconnect:DescribeFlow +``` + +### Update +```json +mediaconnect:DescribeFlow, +mediaconnect:AddFlowVpcInterfaces, +mediaconnect:RemoveFlowVpcInterface +``` + +### Delete +```json +mediaconnect:DescribeFlow, +mediaconnect:RemoveFlowVpcInterface +``` + diff --git a/docs/aws-docs/providers/aws/mediaconnect/flow_vpc_interfaces/index.md b/docs/aws-docs/providers/aws/mediaconnect/flow_vpc_interfaces/index.md new file mode 100644 index 0000000000..3f59a9edbb --- /dev/null +++ b/docs/aws-docs/providers/aws/mediaconnect/flow_vpc_interfaces/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionResource schema for AWS::MediaConnect::FlowVpcInterface
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +flow_arn, +name +FROM aws.mediaconnect.flow_vpc_interfaces +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the flow_vpc_interfaces resource, the following permissions are required: + +### Create +```json +iam:PassRole, +mediaconnect:DescribeFlow, +mediaconnect:AddFlowVpcInterfaces +``` + +### List +```json +mediaconnect:DescribeFlow +``` + diff --git a/docs/aws-docs/providers/aws/mediaconnect/flows/index.md b/docs/aws-docs/providers/aws/mediaconnect/flows/index.md new file mode 100644 index 0000000000..8c6b54ad90 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediaconnect/flows/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionResource schema for AWS::MediaConnect::Flow
Idaws.mediaconnect.flows
+ +## Fields + + + + + +
NameDatatypeDescription
flow_arnstringThe Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +flow_arn +FROM aws.mediaconnect.flows +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the flows resource, the following permissions are required: + +### Create +```json +mediaconnect:CreateFlow, +iam:PassRole +``` + +### List +```json +mediaconnect:ListFlows +``` + diff --git a/docs/aws-docs/providers/aws/mediaconnect/gateway/index.md b/docs/aws-docs/providers/aws/mediaconnect/gateway/index.md new file mode 100644 index 0000000000..4bda345c15 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediaconnect/gateway/index.md @@ -0,0 +1,87 @@ +--- +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
DescriptionResource schema for AWS::MediaConnect::Gateway
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +gateway_arn, +gateway_state, +egress_cidr_blocks, +networks +FROM aws.mediaconnect.gateway +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the gateway resource, the following permissions are required: + +### Read +```json +mediaconnect:DescribeGateway +``` + +### Delete +```json +iam:CreateServiceLinkedRole, +mediaconnect:DescribeGateway, +mediaconnect:DeleteGateway +``` + diff --git a/docs/aws-docs/providers/aws/mediaconnect/gateways/index.md b/docs/aws-docs/providers/aws/mediaconnect/gateways/index.md new file mode 100644 index 0000000000..5fdd5601f5 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediaconnect/gateways/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource schema for AWS::MediaConnect::Gateway
Idaws.mediaconnect.gateways
+ +## Fields + + + + + +
NameDatatypeDescription
gateway_arnstringThe Amazon Resource Name (ARN) of the gateway.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +gateway_arn +FROM aws.mediaconnect.gateways +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the gateways resource, the following permissions are required: + +### Create +```json +iam:CreateServiceLinkedRole, +mediaconnect:CreateGateway, +mediaconnect:DescribeGateway +``` + +### List +```json +mediaconnect:ListGateways +``` + diff --git a/docs/aws-docs/providers/aws/mediaconnect/index.md b/docs/aws-docs/providers/aws/mediaconnect/index.md new file mode 100644 index 0000000000..878c0473ef --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/medialive/index.md b/docs/aws-docs/providers/aws/medialive/index.md new file mode 100644 index 0000000000..0e85ac662c --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/medialive/multiplex/index.md b/docs/aws-docs/providers/aws/medialive/multiplex/index.md new file mode 100644 index 0000000000..edce442568 --- /dev/null +++ b/docs/aws-docs/providers/aws/medialive/multiplex/index.md @@ -0,0 +1,109 @@ +--- +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
DescriptionResource schema for AWS::MediaLive::Multiplex
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +availability_zones, +destinations, +id, +multiplex_settings, +name, +pipelines_running_count, +program_count, +state, +tags +FROM aws.medialive.multiplex +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the multiplex resource, the following permissions are required: + +### Read +```json +medialive:DescribeMultiplex +``` + +### Update +```json +medialive:UpdateMultiplex, +medialive:DescribeMultiplex, +medialive:CreateTags, +medialive:DeleteTags +``` + +### Delete +```json +medialive:DeleteMultiplex, +medialive:DescribeMultiplex +``` + diff --git a/docs/aws-docs/providers/aws/medialive/multiplexes/index.md b/docs/aws-docs/providers/aws/medialive/multiplexes/index.md new file mode 100644 index 0000000000..d39f1befa9 --- /dev/null +++ b/docs/aws-docs/providers/aws/medialive/multiplexes/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource schema for AWS::MediaLive::Multiplex
Idaws.medialive.multiplexes
+ +## Fields + + + + + +
NameDatatypeDescription
idstringThe unique id of the multiplex.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.medialive.multiplexes +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the multiplexes resource, the following permissions are required: + +### Create +```json +medialive:CreateMultiplex, +medialive:DescribeMultiplex, +medialive:CreateTags +``` + +### List +```json +medialive:ListMultiplexes +``` + diff --git a/docs/aws-docs/providers/aws/medialive/multiplexprogram/index.md b/docs/aws-docs/providers/aws/medialive/multiplexprogram/index.md new file mode 100644 index 0000000000..d25785a6bf --- /dev/null +++ b/docs/aws-docs/providers/aws/medialive/multiplexprogram/index.md @@ -0,0 +1,101 @@ +--- +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
DescriptionResource schema for AWS::MediaLive::Multiplexprogram
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +channel_id, +multiplex_id, +multiplex_program_settings, +preferred_channel_pipeline, +packet_identifiers_map, +pipeline_details, +program_name +FROM aws.medialive.multiplexprogram +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the multiplexprogram resource, the following permissions are required: + +### Read +```json +medialive:DescribeMultiplexProgram +``` + +### Update +```json +medialive:UpdateMultiplexProgram, +medialive:DescribeMultiplexProgram +``` + +### Delete +```json +medialive:DeleteMultiplexProgram, +medialive:DescribeMultiplexProgram +``` + diff --git a/docs/aws-docs/providers/aws/medialive/multiplexprograms/index.md b/docs/aws-docs/providers/aws/medialive/multiplexprograms/index.md new file mode 100644 index 0000000000..60efbc4f20 --- /dev/null +++ b/docs/aws-docs/providers/aws/medialive/multiplexprograms/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionResource schema for AWS::MediaLive::Multiplexprogram
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +program_name, +multiplex_id +FROM aws.medialive.multiplexprograms +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the multiplexprograms resource, the following permissions are required: + +### Create +```json +medialive:CreateMultiplexProgram, +medialive:DescribeMultiplexProgram +``` + +### List +```json +medialive:ListMultiplexPrograms +``` + diff --git a/docs/aws-docs/providers/aws/mediapackage/asset/index.md b/docs/aws-docs/providers/aws/mediapackage/asset/index.md new file mode 100644 index 0000000000..7861b346c6 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediapackage/asset/index.md @@ -0,0 +1,94 @@ +--- +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
DescriptionResource schema for AWS::MediaPackage::Asset
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +created_at, +egress_endpoints, +id, +packaging_group_id, +resource_id, +source_arn, +source_role_arn, +tags +FROM aws.mediapackage.asset +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the asset resource, the following permissions are required: + +### Read +```json +mediapackage-vod:DescribeAsset +``` + +### Delete +```json +mediapackage-vod:DescribeAsset, +mediapackage-vod:DeleteAsset +``` + diff --git a/docs/aws-docs/providers/aws/mediapackage/assets/index.md b/docs/aws-docs/providers/aws/mediapackage/assets/index.md new file mode 100644 index 0000000000..53faa5c668 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediapackage/assets/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionResource schema for AWS::MediaPackage::Asset
Idaws.mediapackage.assets
+ +## Fields + + + + + +
NameDatatypeDescription
idstringThe unique identifier for the Asset.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.mediapackage.assets +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the assets resource, the following permissions are required: + +### Create +```json +mediapackage-vod:CreateAsset, +mediapackage-vod:DescribeAsset, +mediapackage-vod:TagResource, +iam:PassRole +``` + +### List +```json +mediapackage-vod:ListAssets, +mediapackage-vod:DescribePackagingGroup +``` + diff --git a/docs/aws-docs/providers/aws/mediapackage/channel/index.md b/docs/aws-docs/providers/aws/mediapackage/channel/index.md new file mode 100644 index 0000000000..df4c5c40c9 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediapackage/channel/index.md @@ -0,0 +1,101 @@ +--- +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
DescriptionResource schema for AWS::MediaPackage::Channel
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +id, +description, +hls_ingest, +tags, +egress_access_logs, +ingress_access_logs +FROM aws.mediapackage.channel +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the channel resource, the following permissions are required: + +### Read +```json +mediapackage:DescribeChannel +``` + +### Update +```json +mediapackage:UpdateChannel, +mediapackage:ConfigureLogs, +iam:CreateServiceLinkedRole +``` + +### Delete +```json +mediapackage:DeleteChannel +``` + diff --git a/docs/aws-docs/providers/aws/mediapackage/channels/index.md b/docs/aws-docs/providers/aws/mediapackage/channels/index.md new file mode 100644 index 0000000000..5fff3266eb --- /dev/null +++ b/docs/aws-docs/providers/aws/mediapackage/channels/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionResource schema for AWS::MediaPackage::Channel
Idaws.mediapackage.channels
+ +## Fields + + + + + +
NameDatatypeDescription
idstringThe ID of the Channel.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.mediapackage.channels +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the channels resource, the following permissions are required: + +### Create +```json +mediapackage:CreateChannel, +mediapackage:DescribeChannel, +mediapackage:UpdateChannel, +mediapackage:TagResource, +mediapackage:ConfigureLogs, +iam:CreateServiceLinkedRole +``` + +### List +```json +mediapackage:ListChannels +``` + diff --git a/docs/aws-docs/providers/aws/mediapackage/index.md b/docs/aws-docs/providers/aws/mediapackage/index.md new file mode 100644 index 0000000000..b2d5001e42 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/mediapackage/origin_endpoint/index.md b/docs/aws-docs/providers/aws/mediapackage/origin_endpoint/index.md new file mode 100644 index 0000000000..34f2dc8b3b --- /dev/null +++ b/docs/aws-docs/providers/aws/mediapackage/origin_endpoint/index.md @@ -0,0 +1,118 @@ +--- +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
DescriptionResource schema for AWS::MediaPackage::OriginEndpoint
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.mediapackage.origin_endpoint +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the origin_endpoint resource, the following permissions are required: + +### Read +```json +mediapackage:DescribeOriginEndpoint +``` + +### Update +```json +mediapackage:UpdateOriginEndpoint, +iam:PassRole +``` + +### Delete +```json +mediapackage:DeleteOriginEndpoint +``` + diff --git a/docs/aws-docs/providers/aws/mediapackage/origin_endpoints/index.md b/docs/aws-docs/providers/aws/mediapackage/origin_endpoints/index.md new file mode 100644 index 0000000000..384bfde607 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediapackage/origin_endpoints/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionResource schema for AWS::MediaPackage::OriginEndpoint
Idaws.mediapackage.origin_endpoints
+ +## Fields + + + + + +
NameDatatypeDescription
idstringThe ID of the OriginEndpoint.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.mediapackage.origin_endpoints +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the origin_endpoints resource, the following permissions are required: + +### Create +```json +mediapackage:CreateOriginEndpoint, +mediapackage:DescribeOriginEndpoint, +mediapackage:DescribeChannel, +mediapackage:TagResource, +iam:PassRole, +acm:DescribeCertificate +``` + +### List +```json +mediapackage:ListOriginEndpoints +``` + diff --git a/docs/aws-docs/providers/aws/mediapackage/packaging_configuration/index.md b/docs/aws-docs/providers/aws/mediapackage/packaging_configuration/index.md new file mode 100644 index 0000000000..539ace05db --- /dev/null +++ b/docs/aws-docs/providers/aws/mediapackage/packaging_configuration/index.md @@ -0,0 +1,92 @@ +--- +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
DescriptionResource schema for AWS::MediaPackage::PackagingConfiguration
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +packaging_group_id, +arn, +cmaf_package, +dash_package, +hls_package, +mss_package, +tags +FROM aws.mediapackage.packaging_configuration +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the packaging_configuration resource, the following permissions are required: + +### Read +```json +mediapackage-vod:DescribePackagingConfiguration +``` + +### Delete +```json +mediapackage-vod:DescribePackagingConfiguration, +mediapackage-vod:DeletePackagingConfiguration +``` + diff --git a/docs/aws-docs/providers/aws/mediapackage/packaging_configurations/index.md b/docs/aws-docs/providers/aws/mediapackage/packaging_configurations/index.md new file mode 100644 index 0000000000..e6a662273c --- /dev/null +++ b/docs/aws-docs/providers/aws/mediapackage/packaging_configurations/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionResource schema for AWS::MediaPackage::PackagingConfiguration
Idaws.mediapackage.packaging_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
idstringThe ID of the PackagingConfiguration.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.mediapackage.packaging_configurations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the packaging_configurations resource, the following permissions are required: + +### Create +```json +mediapackage-vod:CreatePackagingConfiguration, +mediapackage-vod:DescribePackagingConfiguration, +mediapackage-vod:TagResource, +iam:PassRole +``` + +### List +```json +mediapackage-vod:ListPackagingConfigurations, +mediapackage-vod:DescribePackagingGroup +``` + diff --git a/docs/aws-docs/providers/aws/mediapackage/packaging_group/index.md b/docs/aws-docs/providers/aws/mediapackage/packaging_group/index.md new file mode 100644 index 0000000000..02a09e927c --- /dev/null +++ b/docs/aws-docs/providers/aws/mediapackage/packaging_group/index.md @@ -0,0 +1,103 @@ +--- +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
DescriptionResource schema for AWS::MediaPackage::PackagingGroup
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +arn, +domain_name, +authorization, +tags, +egress_access_logs +FROM aws.mediapackage.packaging_group +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the packaging_group resource, the following permissions are required: + +### Read +```json +mediapackage-vod:DescribePackagingGroup +``` + +### Update +```json +mediapackage-vod:DescribePackagingGroup, +mediapackage-vod:UpdatePackagingGroup, +mediapackage-vod:ConfigureLogs, +mediapackage-vod:TagResource, +iam:PassRole, +iam:CreateServiceLinkedRole +``` + +### Delete +```json +mediapackage-vod:DescribePackagingGroup, +mediapackage-vod:DeletePackagingGroup +``` + diff --git a/docs/aws-docs/providers/aws/mediapackage/packaging_groups/index.md b/docs/aws-docs/providers/aws/mediapackage/packaging_groups/index.md new file mode 100644 index 0000000000..b8e0c33dea --- /dev/null +++ b/docs/aws-docs/providers/aws/mediapackage/packaging_groups/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionResource schema for AWS::MediaPackage::PackagingGroup
Idaws.mediapackage.packaging_groups
+ +## Fields + + + + + +
NameDatatypeDescription
idstringThe ID of the PackagingGroup.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.mediapackage.packaging_groups +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the packaging_groups resource, the following permissions are required: + +### Create +```json +mediapackage-vod:CreatePackagingGroup, +mediapackage-vod:DescribePackagingGroup, +mediapackage-vod:TagResource, +mediapackage-vod:ConfigureLogs, +iam:PassRole, +iam:CreateServiceLinkedRole +``` + +### List +```json +mediapackage-vod:ListPackagingGroups +``` + diff --git a/docs/aws-docs/providers/aws/mediapackagev2/channel/index.md b/docs/aws-docs/providers/aws/mediapackagev2/channel/index.md new file mode 100644 index 0000000000..f45090480d --- /dev/null +++ b/docs/aws-docs/providers/aws/mediapackagev2/channel/index.md @@ -0,0 +1,105 @@ +--- +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
Description<p>Represents an entry point into AWS Elemental MediaPackage for an ABR video content stream sent from an upstream encoder such as AWS Elemental MediaLive. The channel continuously analyzes the content that it receives and prepares it to be distributed to consumers via one or more origin endpoints.</p>
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +channel_group_name, +channel_name, +created_at, +description, +ingest_endpoints, +modified_at, +tags +FROM aws.mediapackagev2.channel +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the channel resource, the following permissions are required: + +### Read +```json +mediapackagev2:GetChannel +``` + +### Update +```json +mediapackagev2:TagResource, +mediapackagev2:UntagResource, +mediapackagev2:ListTagsForResource, +mediapackagev2:UpdateChannel +``` + +### Delete +```json +mediapackagev2:GetChannel, +mediapackagev2:DeleteChannel +``` + diff --git a/docs/aws-docs/providers/aws/mediapackagev2/channel_group/index.md b/docs/aws-docs/providers/aws/mediapackagev2/channel_group/index.md new file mode 100644 index 0000000000..168d84c2ba --- /dev/null +++ b/docs/aws-docs/providers/aws/mediapackagev2/channel_group/index.md @@ -0,0 +1,103 @@ +--- +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
Description<p>Represents a channel group that facilitates the grouping of multiple channels.</p>
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +channel_group_name, +created_at, +description, +egress_domain, +modified_at, +tags +FROM aws.mediapackagev2.channel_group +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the channel_group resource, the following permissions are required: + +### Read +```json +mediapackagev2:GetChannelGroup +``` + +### Update +```json +mediapackagev2:TagResource, +mediapackagev2:UntagResource, +mediapackagev2:ListTagsForResource, +mediapackagev2:UpdateChannelGroup +``` + +### Delete +```json +mediapackagev2:GetChannelGroup, +mediapackagev2:DeleteChannelGroup +``` + diff --git a/docs/aws-docs/providers/aws/mediapackagev2/channel_groups/index.md b/docs/aws-docs/providers/aws/mediapackagev2/channel_groups/index.md new file mode 100644 index 0000000000..456fb13e90 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediapackagev2/channel_groups/index.md @@ -0,0 +1,78 @@ +--- +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
Description<p>Represents a channel group that facilitates the grouping of multiple channels.</p>
Idaws.mediapackagev2.channel_groups
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring<p>The Amazon Resource Name (ARN) associated with the resource.</p>
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.mediapackagev2.channel_groups +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the channel_groups resource, the following permissions are required: + +### Create +```json +mediapackagev2:TagResource, +mediapackagev2:CreateChannelGroup +``` + +### List +```json +mediapackagev2:ListChannelGroups +``` + diff --git a/docs/aws-docs/providers/aws/mediapackagev2/channel_policies/index.md b/docs/aws-docs/providers/aws/mediapackagev2/channel_policies/index.md new file mode 100644 index 0000000000..535280c4f8 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediapackagev2/channel_policies/index.md @@ -0,0 +1,70 @@ +--- +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
Description<p>Represents a resource-based policy that allows or denies access to a channel.</p>
Idaws.mediapackagev2.channel_policies
+ +## Fields + + + + + + +
NameDatatypeDescription
channel_group_namestring
channel_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +channel_group_name, +channel_name +FROM aws.mediapackagev2.channel_policies +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the channel_policies resource, the following permissions are required: + +### Create +```json +mediapackagev2:GetChannelPolicy, +mediapackagev2:PutChannelPolicy +``` + diff --git a/docs/aws-docs/providers/aws/mediapackagev2/channel_policy/index.md b/docs/aws-docs/providers/aws/mediapackagev2/channel_policy/index.md new file mode 100644 index 0000000000..e9ebda4233 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediapackagev2/channel_policy/index.md @@ -0,0 +1,93 @@ +--- +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
Description<p>Represents a resource-based policy that allows or denies access to a channel.</p>
Idaws.mediapackagev2.channel_policy
+ +## Fields + + + + + + + +
NameDatatypeDescription
channel_group_namestring
channel_namestring
policyobject
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +channel_group_name, +channel_name, +policy +FROM aws.mediapackagev2.channel_policy +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the channel_policy resource, the following permissions are required: + +### Read +```json +mediapackagev2:GetChannelPolicy +``` + +### Update +```json +mediapackagev2:GetChannelPolicy, +mediapackagev2:PutChannelPolicy +``` + +### Delete +```json +mediapackagev2:GetChannelPolicy, +mediapackagev2:DeleteChannelPolicy +``` + diff --git a/docs/aws-docs/providers/aws/mediapackagev2/channels/index.md b/docs/aws-docs/providers/aws/mediapackagev2/channels/index.md new file mode 100644 index 0000000000..3f45e56317 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediapackagev2/channels/index.md @@ -0,0 +1,78 @@ +--- +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
Description<p>Represents an entry point into AWS Elemental MediaPackage for an ABR video content stream sent from an upstream encoder such as AWS Elemental MediaLive. The channel continuously analyzes the content that it receives and prepares it to be distributed to consumers via one or more origin endpoints.</p>
Idaws.mediapackagev2.channels
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring<p>The Amazon Resource Name (ARN) associated with the resource.</p>
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.mediapackagev2.channels +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the channels resource, the following permissions are required: + +### Create +```json +mediapackagev2:TagResource, +mediapackagev2:CreateChannel +``` + +### List +```json +mediapackagev2:ListChannels +``` + diff --git a/docs/aws-docs/providers/aws/mediapackagev2/index.md b/docs/aws-docs/providers/aws/mediapackagev2/index.md new file mode 100644 index 0000000000..67a72dc0ad --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/mediapackagev2/origin_endpoint/index.md b/docs/aws-docs/providers/aws/mediapackagev2/origin_endpoint/index.md new file mode 100644 index 0000000000..132444f40b --- /dev/null +++ b/docs/aws-docs/providers/aws/mediapackagev2/origin_endpoint/index.md @@ -0,0 +1,116 @@ +--- +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
Description<p>Represents an origin endpoint that is associated with a channel, offering a dynamically repackaged version of its content through various streaming media protocols. The content can be efficiently disseminated to end-users via a Content Delivery Network (CDN), like Amazon CloudFront.</p>
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.mediapackagev2.origin_endpoint +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the origin_endpoint resource, the following permissions are required: + +### Read +```json +mediapackagev2:GetOriginEndpoint +``` + +### Update +```json +mediapackagev2:TagResource, +mediapackagev2:UntagResource, +mediapackagev2:ListTagsForResource, +mediapackagev2:UpdateOriginEndpoint, +iam:PassRole +``` + +### Delete +```json +mediapackagev2:GetOriginEndpoint, +mediapackagev2:DeleteOriginEndpoint +``` + diff --git a/docs/aws-docs/providers/aws/mediapackagev2/origin_endpoint_policies/index.md b/docs/aws-docs/providers/aws/mediapackagev2/origin_endpoint_policies/index.md new file mode 100644 index 0000000000..1a8621e3c3 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediapackagev2/origin_endpoint_policies/index.md @@ -0,0 +1,72 @@ +--- +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
Description<p>Represents a resource policy that allows or denies access to an origin endpoint.</p>
Idaws.mediapackagev2.origin_endpoint_policies
+ +## Fields + + + + + + + +
NameDatatypeDescription
channel_group_namestring
channel_namestring
origin_endpoint_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +channel_group_name, +channel_name, +origin_endpoint_name +FROM aws.mediapackagev2.origin_endpoint_policies +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the origin_endpoint_policies resource, the following permissions are required: + +### Create +```json +mediapackagev2:GetOriginEndpointPolicy, +mediapackagev2:PutOriginEndpointPolicy +``` + diff --git a/docs/aws-docs/providers/aws/mediapackagev2/origin_endpoint_policy/index.md b/docs/aws-docs/providers/aws/mediapackagev2/origin_endpoint_policy/index.md new file mode 100644 index 0000000000..ce07e508ac --- /dev/null +++ b/docs/aws-docs/providers/aws/mediapackagev2/origin_endpoint_policy/index.md @@ -0,0 +1,95 @@ +--- +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
Description<p>Represents a resource policy that allows or denies access to an origin endpoint.</p>
Idaws.mediapackagev2.origin_endpoint_policy
+ +## Fields + + + + + + + + +
NameDatatypeDescription
channel_group_namestring
channel_namestring
origin_endpoint_namestring
policyobject
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +channel_group_name, +channel_name, +origin_endpoint_name, +policy +FROM aws.mediapackagev2.origin_endpoint_policy +WHERE data__Identifier = '||'; +``` + +## Permissions + +To operate on the origin_endpoint_policy resource, the following permissions are required: + +### Read +```json +mediapackagev2:GetOriginEndpointPolicy +``` + +### Update +```json +mediapackagev2:GetOriginEndpointPolicy, +mediapackagev2:PutOriginEndpointPolicy +``` + +### Delete +```json +mediapackagev2:GetOriginEndpointPolicy, +mediapackagev2:DeleteOriginEndpointPolicy +``` + diff --git a/docs/aws-docs/providers/aws/mediapackagev2/origin_endpoints/index.md b/docs/aws-docs/providers/aws/mediapackagev2/origin_endpoints/index.md new file mode 100644 index 0000000000..e19c448afd --- /dev/null +++ b/docs/aws-docs/providers/aws/mediapackagev2/origin_endpoints/index.md @@ -0,0 +1,79 @@ +--- +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
Description<p>Represents an origin endpoint that is associated with a channel, offering a dynamically repackaged version of its content through various streaming media protocols. The content can be efficiently disseminated to end-users via a Content Delivery Network (CDN), like Amazon CloudFront.</p>
Idaws.mediapackagev2.origin_endpoints
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring<p>The Amazon Resource Name (ARN) associated with the resource.</p>
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.mediapackagev2.origin_endpoints +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the origin_endpoints resource, the following permissions are required: + +### Create +```json +mediapackagev2:TagResource, +mediapackagev2:CreateOriginEndpoint, +iam:PassRole +``` + +### List +```json +mediapackagev2:ListOriginEndpoints +``` + diff --git a/docs/aws-docs/providers/aws/mediatailor/channel/index.md b/docs/aws-docs/providers/aws/mediatailor/channel/index.md new file mode 100644 index 0000000000..ec37446897 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediatailor/channel/index.md @@ -0,0 +1,111 @@ +--- +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
DescriptionDefinition of AWS::MediaTailor::Channel Resource Type
Idaws.mediatailor.channel
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring<p>The ARN of the channel.</p>
audiencesarray<p>The list of audiences defined in 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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +audiences, +channel_name, +filler_slate, +log_configuration, +outputs, +playback_mode, +tags, +tier, +time_shift_configuration +FROM aws.mediatailor.channel +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the channel resource, the following permissions are required: + +### Read +```json +mediatailor:DescribeChannel +``` + +### Update +```json +mediatailor:UpdateChannel, +mediatailor:TagResource, +mediatailor:UntagResource, +iam:CreateServiceLinkedRole, +mediatailor:ConfigureLogsForChannel, +mediatailor:DescribeChannel +``` + +### Delete +```json +mediatailor:DeleteChannel, +mediatailor:DescribeChannel +``` + diff --git a/docs/aws-docs/providers/aws/mediatailor/channel_policies/index.md b/docs/aws-docs/providers/aws/mediatailor/channel_policies/index.md new file mode 100644 index 0000000000..a01499f55e --- /dev/null +++ b/docs/aws-docs/providers/aws/mediatailor/channel_policies/index.md @@ -0,0 +1,68 @@ +--- +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
DescriptionDefinition of AWS::MediaTailor::ChannelPolicy Resource Type
Idaws.mediatailor.channel_policies
+ +## Fields + + + + + +
NameDatatypeDescription
channel_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +channel_name +FROM aws.mediatailor.channel_policies +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the channel_policies resource, the following permissions are required: + +### Create +```json +mediatailor:PutChannelPolicy, +mediatailor:GetChannelPolicy +``` + diff --git a/docs/aws-docs/providers/aws/mediatailor/channel_policy/index.md b/docs/aws-docs/providers/aws/mediatailor/channel_policy/index.md new file mode 100644 index 0000000000..800a828370 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediatailor/channel_policy/index.md @@ -0,0 +1,91 @@ +--- +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
DescriptionDefinition of AWS::MediaTailor::ChannelPolicy Resource Type
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +channel_name, +policy +FROM aws.mediatailor.channel_policy +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the channel_policy resource, the following permissions are required: + +### Read +```json +mediatailor:GetChannelPolicy +``` + +### Update +```json +mediatailor:PutChannelPolicy, +mediatailor:GetChannelPolicy +``` + +### Delete +```json +mediatailor:DeleteChannelPolicy, +mediatailor:GetChannelPolicy +``` + diff --git a/docs/aws-docs/providers/aws/mediatailor/channels/index.md b/docs/aws-docs/providers/aws/mediatailor/channels/index.md new file mode 100644 index 0000000000..a7cb75f107 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediatailor/channels/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionDefinition of AWS::MediaTailor::Channel Resource Type
Idaws.mediatailor.channels
+ +## Fields + + + + + +
NameDatatypeDescription
channel_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +channel_name +FROM aws.mediatailor.channels +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the channels resource, the following permissions are required: + +### Create +```json +mediatailor:CreateChannel, +mediatailor:TagResource, +mediatailor:ConfigureLogsForChannel, +iam:CreateServiceLinkedRole, +mediatailor:DescribeChannel +``` + +### List +```json +mediatailor:ListChannels +``` + diff --git a/docs/aws-docs/providers/aws/mediatailor/index.md b/docs/aws-docs/providers/aws/mediatailor/index.md new file mode 100644 index 0000000000..a7c36cd8a5 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/mediatailor/live_source/index.md b/docs/aws-docs/providers/aws/mediatailor/live_source/index.md new file mode 100644 index 0000000000..7408f2cd38 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediatailor/live_source/index.md @@ -0,0 +1,99 @@ +--- +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
DescriptionDefinition of AWS::MediaTailor::LiveSource Resource Type
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +http_package_configurations, +live_source_name, +source_location_name, +tags +FROM aws.mediatailor.live_source +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the live_source resource, the following permissions are required: + +### Read +```json +mediatailor:DescribeLiveSource +``` + +### Update +```json +mediatailor:UpdateLiveSource, +mediatailor:DescribeLiveSource, +mediatailor:TagResource, +mediatailor:UntagResource +``` + +### Delete +```json +mediatailor:DeleteLiveSource, +mediatailor:DescribeLiveSource +``` + diff --git a/docs/aws-docs/providers/aws/mediatailor/live_sources/index.md b/docs/aws-docs/providers/aws/mediatailor/live_sources/index.md new file mode 100644 index 0000000000..5dd504e4c7 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediatailor/live_sources/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionDefinition of AWS::MediaTailor::LiveSource Resource Type
Idaws.mediatailor.live_sources
+ +## Fields + + + + + + +
NameDatatypeDescription
live_source_namestring
source_location_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +live_source_name, +source_location_name +FROM aws.mediatailor.live_sources +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the live_sources resource, the following permissions are required: + +### Create +```json +mediatailor:CreateLiveSource, +mediatailor:DescribeLiveSource, +mediatailor:TagResource +``` + +### List +```json +mediatailor:ListLiveSources +``` + diff --git a/docs/aws-docs/providers/aws/mediatailor/playback_configuration/index.md b/docs/aws-docs/providers/aws/mediatailor/playback_configuration/index.md new file mode 100644 index 0000000000..c0c3a6e8b7 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediatailor/playback_configuration/index.md @@ -0,0 +1,125 @@ +--- +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
DescriptionResource schema for AWS::MediaTailor::PlaybackConfiguration
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.mediatailor.playback_configuration +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the playback_configuration resource, the following permissions are required: + +### Read +```json +mediatailor:GetPlaybackConfiguration +``` + +### Update +```json +mediatailor:PutPlaybackConfiguration, +mediatailor:ConfigureLogsForPlaybackConfiguration, +iam:CreateServiceLinkedRole, +mediatailor:UntagResource, +mediatailor:TagResource +``` + +### Delete +```json +mediatailor:DeletePlaybackConfiguration +``` + diff --git a/docs/aws-docs/providers/aws/mediatailor/playback_configurations/index.md b/docs/aws-docs/providers/aws/mediatailor/playback_configurations/index.md new file mode 100644 index 0000000000..3d18d07235 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediatailor/playback_configurations/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionResource schema for AWS::MediaTailor::PlaybackConfiguration
Idaws.mediatailor.playback_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
namestringThe identifier for the playback configuration.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.mediatailor.playback_configurations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the playback_configurations resource, the following permissions are required: + +### Create +```json +mediatailor:PutPlaybackConfiguration, +mediatailor:ConfigureLogsForPlaybackConfiguration, +iam:CreateServiceLinkedRole, +mediatailor:UntagResource, +mediatailor:TagResource +``` + +### List +```json +mediatailor:ListPlaybackConfigurations +``` + diff --git a/docs/aws-docs/providers/aws/mediatailor/source_location/index.md b/docs/aws-docs/providers/aws/mediatailor/source_location/index.md new file mode 100644 index 0000000000..dcf7f3c062 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediatailor/source_location/index.md @@ -0,0 +1,106 @@ +--- +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
DescriptionDefinition of AWS::MediaTailor::SourceLocation Resource Type
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +access_configuration, +arn, +default_segment_delivery_configuration, +http_configuration, +segment_delivery_configurations, +source_location_name, +tags +FROM aws.mediatailor.source_location +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the source_location resource, the following permissions are required: + +### Read +```json +mediatailor:DescribeSourceLocation +``` + +### Update +```json +mediatailor:DescribeSourceLocation, +mediatailor:TagResource, +mediatailor:UntagResource, +mediatailor:UpdateSourceLocation, +secretsmanager:DescribeSecret, +secretsmanager:GetSecretValue, +kms:CreateGrant +``` + +### Delete +```json +mediatailor:DeleteSourceLocation, +mediatailor:DescribeSourceLocation +``` + diff --git a/docs/aws-docs/providers/aws/mediatailor/source_locations/index.md b/docs/aws-docs/providers/aws/mediatailor/source_locations/index.md new file mode 100644 index 0000000000..b089449447 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediatailor/source_locations/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionDefinition of AWS::MediaTailor::SourceLocation Resource Type
Idaws.mediatailor.source_locations
+ +## Fields + + + + + +
NameDatatypeDescription
source_location_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +source_location_name +FROM aws.mediatailor.source_locations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the source_locations resource, the following permissions are required: + +### Create +```json +mediatailor:CreateSourceLocation, +mediatailor:DescribeSourceLocation, +mediatailor:TagResource, +secretsmanager:DescribeSecret, +secretsmanager:GetSecretValue, +kms:CreateGrant +``` + +### List +```json +mediatailor:ListSourceLocations +``` + diff --git a/docs/aws-docs/providers/aws/mediatailor/vod_source/index.md b/docs/aws-docs/providers/aws/mediatailor/vod_source/index.md new file mode 100644 index 0000000000..6b6a9ea41f --- /dev/null +++ b/docs/aws-docs/providers/aws/mediatailor/vod_source/index.md @@ -0,0 +1,99 @@ +--- +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
DescriptionDefinition of AWS::MediaTailor::VodSource Resource Type
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +http_package_configurations, +source_location_name, +tags, +vod_source_name +FROM aws.mediatailor.vod_source +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the vod_source resource, the following permissions are required: + +### Read +```json +mediatailor:DescribeVodSource +``` + +### Update +```json +mediatailor:DescribeVodSource, +mediatailor:TagResource, +mediatailor:UntagResource, +mediatailor:UpdateVodSource +``` + +### Delete +```json +mediatailor:DeleteVodSource, +mediatailor:DescribeVodSource +``` + diff --git a/docs/aws-docs/providers/aws/mediatailor/vod_sources/index.md b/docs/aws-docs/providers/aws/mediatailor/vod_sources/index.md new file mode 100644 index 0000000000..7f16f329d4 --- /dev/null +++ b/docs/aws-docs/providers/aws/mediatailor/vod_sources/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionDefinition of AWS::MediaTailor::VodSource Resource Type
Idaws.mediatailor.vod_sources
+ +## Fields + + + + + + +
NameDatatypeDescription
source_location_namestring
vod_source_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +source_location_name, +vod_source_name +FROM aws.mediatailor.vod_sources +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the vod_sources resource, the following permissions are required: + +### Create +```json +mediatailor:CreateVodSource, +mediatailor:DescribeVodSource, +mediatailor:TagResource +``` + +### List +```json +mediatailor:ListVodSources +``` + diff --git a/docs/aws-docs/providers/aws/memorydb/acl/index.md b/docs/aws-docs/providers/aws/memorydb/acl/index.md new file mode 100644 index 0000000000..2bd19dbb3a --- /dev/null +++ b/docs/aws-docs/providers/aws/memorydb/acl/index.md @@ -0,0 +1,102 @@ +--- +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
DescriptionResource Type definition for AWS::MemoryDB::ACL
Idaws.memorydb.acl
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
statusstringIndicates acl status. Can be "creating", "active", "modifying", "deleting".
acl_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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +status, +acl_name, +user_names, +arn, +tags +FROM aws.memorydb.acl +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the acl resource, the following permissions are required: + +### Read +```json +memorydb:DescribeACLs, +memorydb:ListTags +``` + +### Update +```json +memorydb:UpdateACL, +memorydb:DescribeACLs, +memorydb:ListTags, +memorydb:TagResource, +memorydb:UntagResource +``` + +### Delete +```json +memorydb:ModifyReplicationGroup, +memorydb:DeleteACL, +memorydb:DescribeACLs +``` + diff --git a/docs/aws-docs/providers/aws/memorydb/acls/index.md b/docs/aws-docs/providers/aws/memorydb/acls/index.md new file mode 100644 index 0000000000..71c1ba2422 --- /dev/null +++ b/docs/aws-docs/providers/aws/memorydb/acls/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionResource Type definition for AWS::MemoryDB::ACL
Idaws.memorydb.acls
+ +## Fields + + + + + +
NameDatatypeDescription
acl_namestringThe name of the acl.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +acl_name +FROM aws.memorydb.acls +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the acls resource, the following permissions are required: + +### Create +```json +memorydb:CreateACL, +memorydb:DescribeACLs, +memorydb:TagResource, +memorydb:ListTags +``` + +### List +```json +memorydb:DescribeACLs, +memorydb:ListTags +``` + diff --git a/docs/aws-docs/providers/aws/memorydb/cluster/index.md b/docs/aws-docs/providers/aws/memorydb/cluster/index.md new file mode 100644 index 0000000000..7a14c70d95 --- /dev/null +++ b/docs/aws-docs/providers/aws/memorydb/cluster/index.md @@ -0,0 +1,147 @@ +--- +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
DescriptionThe AWS::MemoryDB::Cluster resource creates an Amazon MemoryDB Cluster.
Idaws.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.
acl_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.
tls_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.
arnstringThe 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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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, +acl_name, +sns_topic_arn, +sns_topic_status, +tls_enabled, +data_tiering, +kms_key_id, +snapshot_arns, +snapshot_name, +final_snapshot_name, +arn, +engine_version, +cluster_endpoint, +auto_minor_version_upgrade, +tags +FROM aws.memorydb.cluster +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the cluster resource, the following permissions are required: + +### Read +```json +memorydb:DescribeClusters, +memorydb:ListTags +``` + +### Update +```json +memorydb:UpdateCluster, +memorydb:DescribeClusters, +memorydb:ListTags, +memorydb:TagResource, +memorydb:UntagResource +``` + +### Delete +```json +memorydb:DeleteCluster, +memorydb:DescribeClusters +``` + diff --git a/docs/aws-docs/providers/aws/memorydb/clusters/index.md b/docs/aws-docs/providers/aws/memorydb/clusters/index.md new file mode 100644 index 0000000000..25baecc9f5 --- /dev/null +++ b/docs/aws-docs/providers/aws/memorydb/clusters/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionThe AWS::MemoryDB::Cluster resource creates an Amazon MemoryDB Cluster.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +cluster_name +FROM aws.memorydb.clusters +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the clusters resource, the following permissions are required: + +### Create +```json +memorydb:CreateCluster, +memorydb:DescribeClusters, +memorydb:ListTags +``` + +### List +```json +memorydb:DescribeClusters +``` + diff --git a/docs/aws-docs/providers/aws/memorydb/index.md b/docs/aws-docs/providers/aws/memorydb/index.md new file mode 100644 index 0000000000..f5eb152433 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/memorydb/parameter_group/index.md b/docs/aws-docs/providers/aws/memorydb/parameter_group/index.md new file mode 100644 index 0000000000..42cecf3afc --- /dev/null +++ b/docs/aws-docs/providers/aws/memorydb/parameter_group/index.md @@ -0,0 +1,104 @@ +--- +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
DescriptionThe AWS::MemoryDB::ParameterGroup resource creates an Amazon MemoryDB ParameterGroup.
Idaws.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.
arnstringThe Amazon Resource Name (ARN) of the parameter group.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +parameter_group_name, +family, +description, +tags, +parameters, +arn +FROM aws.memorydb.parameter_group +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the parameter_group resource, the following permissions are required: + +### Read +```json +memorydb:DescribeParameterGroups, +memorydb:ListTags +``` + +### Update +```json +memorydb:UpdateParameterGroup, +memorydb:DescribeParameterGroups, +memorydb:DescribeParameters, +memorydb:DescribeClusters, +memorydb:ListTags, +memorydb:TagResource, +memorydb:UntagResource +``` + +### Delete +```json +memorydb:DeleteParameterGroup +``` + diff --git a/docs/aws-docs/providers/aws/memorydb/parameter_groups/index.md b/docs/aws-docs/providers/aws/memorydb/parameter_groups/index.md new file mode 100644 index 0000000000..0fd2a87aed --- /dev/null +++ b/docs/aws-docs/providers/aws/memorydb/parameter_groups/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionThe AWS::MemoryDB::ParameterGroup resource creates an Amazon MemoryDB ParameterGroup.
Idaws.memorydb.parameter_groups
+ +## Fields + + + + + +
NameDatatypeDescription
parameter_group_namestringThe name of the parameter group.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +parameter_group_name +FROM aws.memorydb.parameter_groups +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the parameter_groups resource, the following permissions are required: + +### Create +```json +memorydb:CreateParameterGroup, +memorydb:DescribeParameterGroups, +memorydb:TagResource, +memorydb:ListTags +``` + +### List +```json +memorydb:DescribeParameterGroups +``` + diff --git a/docs/aws-docs/providers/aws/memorydb/subnet_group/index.md b/docs/aws-docs/providers/aws/memorydb/subnet_group/index.md new file mode 100644 index 0000000000..173888dea0 --- /dev/null +++ b/docs/aws-docs/providers/aws/memorydb/subnet_group/index.md @@ -0,0 +1,101 @@ +--- +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
DescriptionThe AWS::MemoryDB::SubnetGroup resource creates an Amazon MemoryDB Subnet Group.
Idaws.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.
arnstringThe Amazon Resource Name (ARN) of the subnet group.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +subnet_group_name, +description, +subnet_ids, +tags, +arn +FROM aws.memorydb.subnet_group +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the subnet_group resource, the following permissions are required: + +### Read +```json +memorydb:DescribeSubnetGroups, +memorydb:ListTags +``` + +### Update +```json +memorydb:UpdateSubnetGroup, +memorydb:DescribeSubnetGroups, +memorydb:ListTags, +memorydb:TagResource, +memorydb:UntagResource +``` + +### Delete +```json +memorydb:DeleteSubnetGroup, +memorydb:DescribeSubnetGroups +``` + diff --git a/docs/aws-docs/providers/aws/memorydb/subnet_groups/index.md b/docs/aws-docs/providers/aws/memorydb/subnet_groups/index.md new file mode 100644 index 0000000000..6785609db9 --- /dev/null +++ b/docs/aws-docs/providers/aws/memorydb/subnet_groups/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionThe AWS::MemoryDB::SubnetGroup resource creates an Amazon MemoryDB Subnet Group.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +subnet_group_name +FROM aws.memorydb.subnet_groups +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the subnet_groups resource, the following permissions are required: + +### Create +```json +memorydb:CreateSubnetGroup, +memorydb:DescribeSubnetGroups, +memorydb:TagResource, +memorydb:ListTags +``` + +### List +```json +memorydb:DescribeSubnetGroups +``` + diff --git a/docs/aws-docs/providers/aws/memorydb/user/index.md b/docs/aws-docs/providers/aws/memorydb/user/index.md new file mode 100644 index 0000000000..7a0a45acec --- /dev/null +++ b/docs/aws-docs/providers/aws/memorydb/user/index.md @@ -0,0 +1,103 @@ +--- +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
DescriptionResource Type definition for AWS::MemoryDB::User
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +status, +user_name, +access_string, +authentication_mode, +arn, +tags +FROM aws.memorydb.user +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the user resource, the following permissions are required: + +### Read +```json +memorydb:DescribeUsers, +memorydb:ListTags +``` + +### Update +```json +memorydb:UpdateUser, +memorydb:DescribeUsers, +memorydb:ListTags, +memorydb:TagResource, +memorydb:UntagResource +``` + +### Delete +```json +memorydb:DeleteUser, +memorydb:DescribeUsers +``` + diff --git a/docs/aws-docs/providers/aws/memorydb/users/index.md b/docs/aws-docs/providers/aws/memorydb/users/index.md new file mode 100644 index 0000000000..5f7e31fbf2 --- /dev/null +++ b/docs/aws-docs/providers/aws/memorydb/users/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionResource Type definition for AWS::MemoryDB::User
Idaws.memorydb.users
+ +## Fields + + + + + +
NameDatatypeDescription
user_namestringThe name of the user.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +user_name +FROM aws.memorydb.users +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the users resource, the following permissions are required: + +### Create +```json +memorydb:CreateUser, +memorydb:DescribeUsers, +memorydb:TagResource, +memorydb:ListTags +``` + +### List +```json +memorydb:DescribeUsers, +memorydb:ListTags +``` + diff --git a/docs/aws-docs/providers/aws/msk/batch_scram_secret/index.md b/docs/aws-docs/providers/aws/msk/batch_scram_secret/index.md new file mode 100644 index 0000000000..663c0320a6 --- /dev/null +++ b/docs/aws-docs/providers/aws/msk/batch_scram_secret/index.md @@ -0,0 +1,100 @@ +--- +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
DescriptionResource Type definition for AWS::MSK::BatchScramSecret
Idaws.msk.batch_scram_secret
+ +## Fields + + + + + + +
NameDatatypeDescription
cluster_arnstring
secret_arn_listarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +cluster_arn, +secret_arn_list +FROM aws.msk.batch_scram_secret +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the batch_scram_secret resource, the following permissions are required: + +### Delete +```json +kafka:BatchDisassociateScramSecret, +kafka:ListScramSecrets, +kms:CreateGrant, +kms:DescribeKey +``` + +### Read +```json +kafka:ListScramSecrets, +kms:CreateGrant, +kms:DescribeKey, +secretsmanager:GetSecretValue +``` + +### Update +```json +kafka:BatchAssociateScramSecret, +kafka:BatchDisassociateScramSecret, +kafka:ListScramSecrets, +kms:CreateGrant, +kms:DescribeKey, +secretsmanager:GetSecretValue +``` + diff --git a/docs/aws-docs/providers/aws/msk/batch_scram_secrets/index.md b/docs/aws-docs/providers/aws/msk/batch_scram_secrets/index.md new file mode 100644 index 0000000000..0c7026d682 --- /dev/null +++ b/docs/aws-docs/providers/aws/msk/batch_scram_secrets/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionResource Type definition for AWS::MSK::BatchScramSecret
Idaws.msk.batch_scram_secrets
+ +## Fields + + + + + +
NameDatatypeDescription
cluster_arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +cluster_arn +FROM aws.msk.batch_scram_secrets +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the batch_scram_secrets resource, the following permissions are required: + +### Create +```json +kafka:BatchAssociateScramSecret, +kafka:ListScramSecrets, +kms:CreateGrant, +kms:DescribeKey, +secretsmanager:GetSecretValue +``` + +### List +```json +kafka:ListScramSecrets, +kms:CreateGrant, +kms:DescribeKey, +secretsmanager:GetSecretValue +``` + diff --git a/docs/aws-docs/providers/aws/msk/cluster/index.md b/docs/aws-docs/providers/aws/msk/cluster/index.md new file mode 100644 index 0000000000..dd0f3f5bd1 --- /dev/null +++ b/docs/aws-docs/providers/aws/msk/cluster/index.md @@ -0,0 +1,145 @@ +--- +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
DescriptionResource Type definition for AWS::MSK::Cluster
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.msk.cluster +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the cluster resource, the following permissions are required: + +### Update +```json +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 +```json +kafka:DeleteCluster, +kafka:DescribeCluster +``` + +### Read +```json +kafka:DescribeCluster +``` + diff --git a/docs/aws-docs/providers/aws/msk/cluster_policies/index.md b/docs/aws-docs/providers/aws/msk/cluster_policies/index.md new file mode 100644 index 0000000000..562f08cb6d --- /dev/null +++ b/docs/aws-docs/providers/aws/msk/cluster_policies/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionResource Type definition for AWS::MSK::ClusterPolicy
Idaws.msk.cluster_policies
+ +## Fields + + + + + +
NameDatatypeDescription
cluster_arnstringThe arn of the cluster for the resource policy.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +cluster_arn +FROM aws.msk.cluster_policies +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the cluster_policies resource, the following permissions are required: + +### Create +```json +kafka:PutClusterPolicy, +kafka:GetClusterPolicy +``` + +### List +```json +kafka:GetClusterPolicy +``` + diff --git a/docs/aws-docs/providers/aws/msk/cluster_policy/index.md b/docs/aws-docs/providers/aws/msk/cluster_policy/index.md new file mode 100644 index 0000000000..cb167c5b4a --- /dev/null +++ b/docs/aws-docs/providers/aws/msk/cluster_policy/index.md @@ -0,0 +1,93 @@ +--- +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
DescriptionResource Type definition for AWS::MSK::ClusterPolicy
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +policy, +cluster_arn, +current_version +FROM aws.msk.cluster_policy +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the cluster_policy resource, the following permissions are required: + +### Read +```json +kafka:GetClusterPolicy +``` + +### Update +```json +kafka:PutClusterPolicy, +kafka:GetClusterPolicy +``` + +### Delete +```json +kafka:DeleteClusterPolicy, +kafka:GetClusterPolicy +``` + diff --git a/docs/aws-docs/providers/aws/msk/clusters/index.md b/docs/aws-docs/providers/aws/msk/clusters/index.md new file mode 100644 index 0000000000..531d455890 --- /dev/null +++ b/docs/aws-docs/providers/aws/msk/clusters/index.md @@ -0,0 +1,99 @@ +--- +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
DescriptionResource Type definition for AWS::MSK::Cluster
Idaws.msk.clusters
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.msk.clusters +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the clusters resource, the following permissions are required: + +### Create +```json +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 +```json +kafka:ListClusters +``` + diff --git a/docs/aws-docs/providers/aws/msk/configuration/index.md b/docs/aws-docs/providers/aws/msk/configuration/index.md new file mode 100644 index 0000000000..b725e8aa44 --- /dev/null +++ b/docs/aws-docs/providers/aws/msk/configuration/index.md @@ -0,0 +1,99 @@ +--- +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
DescriptionResource Type definition for AWS::MSK::Configuration
Idaws.msk.configuration
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
namestring
descriptionstring
server_propertiesstring
kafka_versions_listarray
arnstring
latest_revisionobject
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +description, +server_properties, +kafka_versions_list, +arn, +latest_revision +FROM aws.msk.configuration +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the configuration resource, the following permissions are required: + +### Delete +```json +kafka:DeleteConfiguration, +kafka:DescribeConfiguration +``` + +### Read +```json +kafka:DescribeConfiguration +``` + +### Update +```json +kafka:UpdateConfiguration, +kafka:DescribeConfiguration +``` + diff --git a/docs/aws-docs/providers/aws/msk/configurations/index.md b/docs/aws-docs/providers/aws/msk/configurations/index.md new file mode 100644 index 0000000000..c92f9bd45c --- /dev/null +++ b/docs/aws-docs/providers/aws/msk/configurations/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionResource Type definition for AWS::MSK::Configuration
Idaws.msk.configurations
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.msk.configurations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the configurations resource, the following permissions are required: + +### Create +```json +kafka:CreateConfiguration, +Kafka:DescribeConfiguration +``` + +### List +```json +kafka:ListConfigurations +``` + diff --git a/docs/aws-docs/providers/aws/msk/index.md b/docs/aws-docs/providers/aws/msk/index.md new file mode 100644 index 0000000000..f9d5c53cbb --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/msk/replicator/index.md b/docs/aws-docs/providers/aws/msk/replicator/index.md new file mode 100644 index 0000000000..224f9dbe82 --- /dev/null +++ b/docs/aws-docs/providers/aws/msk/replicator/index.md @@ -0,0 +1,109 @@ +--- +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
DescriptionResource Type definition for AWS::MSK::Replicator
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +replicator_arn, +replicator_name, +current_version, +description, +kafka_clusters, +replication_info_list, +service_execution_role_arn, +tags +FROM aws.msk.replicator +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the replicator resource, the following permissions are required: + +### Read +```json +kafka:DescribeReplicator, +kafka:ListTagsForResource +``` + +### Update +```json +kafka:DescribeReplicator, +kafka:ListTagsForResource, +kafka:TagResource, +kafka:UntagResource, +kafka:UpdateReplicationInfo +``` + +### Delete +```json +kafka:DeleteReplicator, +kafka:DescribeReplicator, +kafka:ListTagsForResource, +kafka:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/msk/replicators/index.md b/docs/aws-docs/providers/aws/msk/replicators/index.md new file mode 100644 index 0000000000..a9676519bb --- /dev/null +++ b/docs/aws-docs/providers/aws/msk/replicators/index.md @@ -0,0 +1,89 @@ +--- +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
DescriptionResource Type definition for AWS::MSK::Replicator
Idaws.msk.replicators
+ +## Fields + + + + + +
NameDatatypeDescription
replicator_arnstringAmazon Resource Name for the created replicator.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +replicator_arn +FROM aws.msk.replicators +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the replicators resource, the following permissions are required: + +### Create +```json +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 +```json +kafka:ListReplicators +``` + diff --git a/docs/aws-docs/providers/aws/msk/serverless_cluster/index.md b/docs/aws-docs/providers/aws/msk/serverless_cluster/index.md new file mode 100644 index 0000000000..dd64b9cb5f --- /dev/null +++ b/docs/aws-docs/providers/aws/msk/serverless_cluster/index.md @@ -0,0 +1,87 @@ +--- +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
DescriptionResource Type definition for AWS::MSK::ServerlessCluster
Idaws.msk.serverless_cluster
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
arnstring
cluster_namestring
vpc_configsarray
client_authenticationobject
tagsobjectA key-value pair to associate with a resource.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +cluster_name, +vpc_configs, +client_authentication, +tags +FROM aws.msk.serverless_cluster +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the serverless_cluster resource, the following permissions are required: + +### Read +```json +kafka:DescribeClusterV2 +``` + +### Delete +```json +kafka:DeleteCluster, +kafka:DescribeClusterV2, +ec2:DeleteVpcEndpoints +``` + diff --git a/docs/aws-docs/providers/aws/msk/serverless_clusters/index.md b/docs/aws-docs/providers/aws/msk/serverless_clusters/index.md new file mode 100644 index 0000000000..5e6afff4bd --- /dev/null +++ b/docs/aws-docs/providers/aws/msk/serverless_clusters/index.md @@ -0,0 +1,86 @@ +--- +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
DescriptionResource Type definition for AWS::MSK::ServerlessCluster
Idaws.msk.serverless_clusters
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.msk.serverless_clusters +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the serverless_clusters resource, the following permissions are required: + +### Create +```json +kafka:CreateClusterV2, +kafka:TagResource, +kafka:DescribeClusterV2, +ec2:CreateVpcEndpoint, +ec2:CreateTags, +ec2:DescribeVpcAttribute, +ec2:DescribeSubnets, +ec2:DescribeVpcEndpoints, +ec2:DescribeVpcs, +ec2:DescribeSecurityGroups +``` + +### List +```json +kafka:ListClustersV2 +``` + diff --git a/docs/aws-docs/providers/aws/msk/vpc_connection/index.md b/docs/aws-docs/providers/aws/msk/vpc_connection/index.md new file mode 100644 index 0000000000..1aa01a5062 --- /dev/null +++ b/docs/aws-docs/providers/aws/msk/vpc_connection/index.md @@ -0,0 +1,112 @@ +--- +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
DescriptionResource Type definition for AWS::MSK::VpcConnection
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +authentication, +client_subnets, +target_cluster_arn, +security_groups, +tags, +vpc_id +FROM aws.msk.vpc_connection +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the vpc_connection resource, the following permissions are required: + +### Read +```json +kafka:DescribeVpcConnection, +kms:CreateGrant, +kms:DescribeKey +``` + +### Update +```json +kafka:DescribeVpcConnection, +kms:CreateGrant, +kms:DescribeKey, +kafka:TagResource, +kafka:UntagResource +``` + +### Delete +```json +ec2:DeleteVpcEndpoint, +ec2:DeleteVpcEndpoints, +ec2:DescribeVpcEndpoints, +ec2:DescribeVpcEndpointConnections, +kafka:DeleteVpcConnection, +kafka:DescribeVpcConnection, +kms:CreateGrant, +kms:DescribeKey +``` + diff --git a/docs/aws-docs/providers/aws/msk/vpc_connections/index.md b/docs/aws-docs/providers/aws/msk/vpc_connections/index.md new file mode 100644 index 0000000000..aea826464b --- /dev/null +++ b/docs/aws-docs/providers/aws/msk/vpc_connections/index.md @@ -0,0 +1,96 @@ +--- +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
DescriptionResource Type definition for AWS::MSK::VpcConnection
Idaws.msk.vpc_connections
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.msk.vpc_connections +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the vpc_connections resource, the following permissions are required: + +### Create +```json +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 +```json +kafka:ListVpcConnections, +kms:CreateGrant, +kms:DescribeKey +``` + diff --git a/docs/aws-docs/providers/aws/mwaa/environment/index.md b/docs/aws-docs/providers/aws/mwaa/environment/index.md new file mode 100644 index 0000000000..257ea6ed89 --- /dev/null +++ b/docs/aws-docs/providers/aws/mwaa/environment/index.md @@ -0,0 +1,143 @@ +--- +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
DescriptionResource schema for AWS::MWAA::Environment
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.mwaa.environment +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the environment resource, the following permissions are required: + +### Read +```json +airflow:GetEnvironment +``` + +### Update +```json +airflow:UpdateEnvironment, +airflow:TagResource, +airflow:UntagResource +``` + +### Delete +```json +airflow:DeleteEnvironment +``` + diff --git a/docs/aws-docs/providers/aws/mwaa/environments/index.md b/docs/aws-docs/providers/aws/mwaa/environments/index.md new file mode 100644 index 0000000000..a6b2dad9d0 --- /dev/null +++ b/docs/aws-docs/providers/aws/mwaa/environments/index.md @@ -0,0 +1,77 @@ +--- +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
DescriptionResource schema for AWS::MWAA::Environment
Idaws.mwaa.environments
+ +## Fields + + + + + +
NameDatatypeDescription
nameundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.mwaa.environments +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the environments resource, the following permissions are required: + +### Create +```json +airflow:CreateEnvironment +``` + +### List +```json +airflow:ListEnvironments +``` + diff --git a/docs/aws-docs/providers/aws/mwaa/index.md b/docs/aws-docs/providers/aws/mwaa/index.md new file mode 100644 index 0000000000..7d06717530 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/neptune/db_cluster/index.md b/docs/aws-docs/providers/aws/neptune/db_cluster/index.md new file mode 100644 index 0000000000..4846f9d2e9 --- /dev/null +++ b/docs/aws-docs/providers/aws/neptune/db_cluster/index.md @@ -0,0 +1,166 @@ +--- +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
DescriptionThe AWS::Neptune::DBCluster resource creates an Amazon Neptune DB cluster.
Idaws.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.
db_cluster_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.
db_cluster_parameter_group_namestringProvides the name of the DB cluster parameter group.
db_instance_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.
db_portintegerThe 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.
db_subnet_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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +endpoint, +read_endpoint, +cluster_resource_id, +associated_roles, +availability_zones, +backup_retention_period, +copy_tags_to_snapshot, +db_cluster_identifier, +db_cluster_parameter_group_name, +db_instance_parameter_group_name, +db_port, +db_subnet_group_name, +deletion_protection, +enable_cloudwatch_logs_exports, +engine_version, +iam_auth_enabled, +kms_key_id, +port, +preferred_backup_window, +preferred_maintenance_window, +restore_to_time, +restore_type, +serverless_scaling_configuration, +snapshot_identifier, +source_db_cluster_identifier, +storage_encrypted, +tags, +use_latest_restorable_time, +vpc_security_group_ids +FROM aws.neptune.db_cluster +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the db_cluster resource, the following permissions are required: + +### Read +```json +rds:DescribeDBClusters, +rds:ListTagsForResource, +kms:* +``` + +### Update +```json +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 +```json +rds:DeleteDBCluster, +rds:DeleteDBInstance, +rds:DescribeDBClusters, +rds:DescribeGlobalClusters, +rds:ListTagsForResource, +rds:RemoveFromGlobalCluster, +rds:CreateDBClusterSnapshot, +kms:* +``` + diff --git a/docs/aws-docs/providers/aws/neptune/db_clusters/index.md b/docs/aws-docs/providers/aws/neptune/db_clusters/index.md new file mode 100644 index 0000000000..f40485538a --- /dev/null +++ b/docs/aws-docs/providers/aws/neptune/db_clusters/index.md @@ -0,0 +1,89 @@ +--- +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
DescriptionThe AWS::Neptune::DBCluster resource creates an Amazon Neptune DB cluster.
Idaws.neptune.db_clusters
+ +## Fields + + + + + +
NameDatatypeDescription
db_cluster_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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +db_cluster_identifier +FROM aws.neptune.db_clusters +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the db_clusters resource, the following permissions are required: + +### Create +```json +iam:PassRole, +rds:AddRoleToDBCluster, +rds:AddTagsToResource, +rds:CreateDBCluster, +rds:CreateDBInstance, +rds:DescribeDBClusters, +rds:ListTagsForResource, +rds:ModifyDBCluster, +rds:RestoreDBClusterFromSnapshot, +rds:RestoreDBClusterToPointInTime, +kms:* +``` + +### List +```json +rds:DescribeDBClusters, +rds:ListTagsForResource, +kms:* +``` + diff --git a/docs/aws-docs/providers/aws/neptune/index.md b/docs/aws-docs/providers/aws/neptune/index.md new file mode 100644 index 0000000000..2bb86771ba --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/neptunegraph/graph/index.md b/docs/aws-docs/providers/aws/neptunegraph/graph/index.md new file mode 100644 index 0000000000..0073557f01 --- /dev/null +++ b/docs/aws-docs/providers/aws/neptunegraph/graph/index.md @@ -0,0 +1,121 @@ +--- +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
DescriptionThe AWS::NeptuneGraph::Graph resource creates an Amazon NeptuneGraph Graph.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +deletion_protection, +graph_name, +provisioned_memory, +public_connectivity, +replica_count, +tags, +vector_search_configuration, +endpoint, +graph_arn, +graph_id +FROM aws.neptunegraph.graph +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the graph resource, the following permissions are required: + +### Read +```json +neptune-graph:GetGraph, +neptune-graph:ListTagsForResource, +kms:DescribeKey, +kms:CreateGrant, +kms:Decrypt +``` + +### Update +```json +iam:PassRole, +neptune-graph:GetGraph, +neptune-graph:ListTagsForResource, +neptune-graph:TagResource, +neptune-graph:UntagResource, +neptune-graph:UpdateGraph, +kms:DescribeKey, +kms:CreateGrant, +kms:Decrypt +``` + +### Delete +```json +neptune-graph:DeleteGraph, +neptune-graph:GetGraph, +kms:DescribeKey, +kms:CreateGrant, +kms:Decrypt +``` + diff --git a/docs/aws-docs/providers/aws/neptunegraph/graphs/index.md b/docs/aws-docs/providers/aws/neptunegraph/graphs/index.md new file mode 100644 index 0000000000..2e5e39745d --- /dev/null +++ b/docs/aws-docs/providers/aws/neptunegraph/graphs/index.md @@ -0,0 +1,89 @@ +--- +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
DescriptionThe AWS::NeptuneGraph::Graph resource creates an Amazon NeptuneGraph Graph.
Idaws.neptunegraph.graphs
+ +## Fields + + + + + +
NameDatatypeDescription
graph_idstringThe auto-generated id assigned by the service.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +graph_id +FROM aws.neptunegraph.graphs +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the graphs resource, the following permissions are required: + +### Create +```json +iam:PassRole, +neptune-graph:CreateGraph, +neptune-graph:GetGraph, +neptune-graph:ListTagsForResource, +neptune-graph:TagResource, +kms:DescribeKey, +kms:CreateGrant, +kms:Decrypt, +iam:CreateServiceLinkedRole +``` + +### List +```json +neptune-graph:GetGraph, +neptune-graph:ListGraphs, +kms:DescribeKey, +kms:CreateGrant, +kms:Decrypt +``` + diff --git a/docs/aws-docs/providers/aws/neptunegraph/index.md b/docs/aws-docs/providers/aws/neptunegraph/index.md new file mode 100644 index 0000000000..da976b1fa4 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/neptunegraph/private_graph_endpoint/index.md b/docs/aws-docs/providers/aws/neptunegraph/private_graph_endpoint/index.md new file mode 100644 index 0000000000..61f672d2d3 --- /dev/null +++ b/docs/aws-docs/providers/aws/neptunegraph/private_graph_endpoint/index.md @@ -0,0 +1,108 @@ +--- +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
DescriptionThe AWS::NeptuneGraph::PrivateGraphEndpoint resource creates an Amazon NeptuneGraph PrivateGraphEndpoint.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +graph_identifier, +security_group_ids, +subnet_ids, +vpc_id, +private_graph_endpoint_identifier, +vpc_endpoint_id +FROM aws.neptunegraph.private_graph_endpoint +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the private_graph_endpoint resource, the following permissions are required: + +### Read +```json +neptune-graph:GetPrivateGraphEndpoint +``` + +### Update +```json +iam:PassRole, +neptune-graph:GetPrivateGraphEndpoint +``` + +### Delete +```json +ec2:DeleteVpcEndpoints, +ec2:DescribeVpcEndpoints, +ec2:DescribeSecurityGroups, +ec2:DescribeSubnets, +ec2:DescribeVpcs, +ec2:DescribeVpcAttribute, +ec2:DescribeAvailabilityZones, +ec2:ModifyVpcEndpoint, +route53:DisassociateVPCFromHostedZone, +neptune-graph:DeletePrivateGraphEndpoint, +neptune-graph:GetPrivateGraphEndpoint +``` + diff --git a/docs/aws-docs/providers/aws/neptunegraph/private_graph_endpoints/index.md b/docs/aws-docs/providers/aws/neptunegraph/private_graph_endpoints/index.md new file mode 100644 index 0000000000..91a8fd1479 --- /dev/null +++ b/docs/aws-docs/providers/aws/neptunegraph/private_graph_endpoints/index.md @@ -0,0 +1,90 @@ +--- +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
DescriptionThe AWS::NeptuneGraph::PrivateGraphEndpoint resource creates an Amazon NeptuneGraph PrivateGraphEndpoint.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +private_graph_endpoint_identifier +FROM aws.neptunegraph.private_graph_endpoints +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the private_graph_endpoints resource, the following permissions are required: + +### Create +```json +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 +```json +neptune-graph:GetPrivateGraphEndpoint, +neptune-graph:ListPrivateGraphEndpoints +``` + diff --git a/docs/aws-docs/providers/aws/networkfirewall/firewall/index.md b/docs/aws-docs/providers/aws/networkfirewall/firewall/index.md new file mode 100644 index 0000000000..72cc47b579 --- /dev/null +++ b/docs/aws-docs/providers/aws/networkfirewall/firewall/index.md @@ -0,0 +1,127 @@ +--- +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
DescriptionResource type definition for AWS::NetworkFirewall::Firewall
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.networkfirewall.firewall +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the firewall resource, the following permissions are required: + +### Read +```json +network-firewall:DescribeFirewall, +network-firewall:ListTagsForResources +``` + +### Update +```json +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 +```json +ec2:DeleteVpcEndpoints, +ec2:DescribeRouteTables, +logs:DescribeLogGroups, +logs:DescribeResourcePolicies, +logs:GetLogDelivery, +logs:ListLogDeliveries, +network-firewall:DeleteFirewall, +network-firewall:UntagResource, +network-firewall:DescribeFirewall +``` + diff --git a/docs/aws-docs/providers/aws/networkfirewall/firewall_policies/index.md b/docs/aws-docs/providers/aws/networkfirewall/firewall_policies/index.md new file mode 100644 index 0000000000..d73e8521fb --- /dev/null +++ b/docs/aws-docs/providers/aws/networkfirewall/firewall_policies/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionResource type definition for AWS::NetworkFirewall::FirewallPolicy
Idaws.networkfirewall.firewall_policies
+ +## Fields + + + + + +
NameDatatypeDescription
firewall_policy_arnundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +firewall_policy_arn +FROM aws.networkfirewall.firewall_policies +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the firewall_policies resource, the following permissions are required: + +### Create +```json +network-firewall:CreateFirewallPolicy, +network-firewall:DescribeFirewallPolicy, +network-firewall:ListTLSInspectionConfigurations, +network-firewall:TagResource, +network-firewall:ListRuleGroups +``` + +### List +```json +network-firewall:ListFirewallPolicies +``` + diff --git a/docs/aws-docs/providers/aws/networkfirewall/firewall_policy/index.md b/docs/aws-docs/providers/aws/networkfirewall/firewall_policy/index.md new file mode 100644 index 0000000000..cea1c201c2 --- /dev/null +++ b/docs/aws-docs/providers/aws/networkfirewall/firewall_policy/index.md @@ -0,0 +1,105 @@ +--- +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
DescriptionResource type definition for AWS::NetworkFirewall::FirewallPolicy
Idaws.networkfirewall.firewall_policy
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
firewall_policy_namestring
firewall_policy_arnstring
firewall_policyobject
firewall_policy_idstring
descriptionstring
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +firewall_policy_name, +firewall_policy_arn, +firewall_policy, +firewall_policy_id, +description, +tags +FROM aws.networkfirewall.firewall_policy +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the firewall_policy resource, the following permissions are required: + +### Read +```json +network-firewall:DescribeFirewallPolicy, +network-firewall:ListTagsForResources +``` + +### Update +```json +network-firewall:UpdateFirewallPolicy, +network-firewall:DescribeFirewallPolicy, +network-firewall:TagResource, +network-firewall:UntagResource, +network-firewall:ListRuleGroups, +network-firewall:ListTLSInspectionConfigurations +``` + +### Delete +```json +network-firewall:DeleteFirewallPolicy, +network-firewall:DescribeFirewallPolicy, +network-firewall:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/networkfirewall/firewalls/index.md b/docs/aws-docs/providers/aws/networkfirewall/firewalls/index.md new file mode 100644 index 0000000000..b26efd0631 --- /dev/null +++ b/docs/aws-docs/providers/aws/networkfirewall/firewalls/index.md @@ -0,0 +1,88 @@ +--- +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
DescriptionResource type definition for AWS::NetworkFirewall::Firewall
Idaws.networkfirewall.firewalls
+ +## Fields + + + + + +
NameDatatypeDescription
firewall_arnundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +firewall_arn +FROM aws.networkfirewall.firewalls +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the firewalls resource, the following permissions are required: + +### Create +```json +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 +```json +network-firewall:ListFirewalls +``` + diff --git a/docs/aws-docs/providers/aws/networkfirewall/index.md b/docs/aws-docs/providers/aws/networkfirewall/index.md new file mode 100644 index 0000000000..929d8b150d --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/networkfirewall/logging_configuration/index.md b/docs/aws-docs/providers/aws/networkfirewall/logging_configuration/index.md new file mode 100644 index 0000000000..eb04f1a63b --- /dev/null +++ b/docs/aws-docs/providers/aws/networkfirewall/logging_configuration/index.md @@ -0,0 +1,110 @@ +--- +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
DescriptionResource type definition for AWS::NetworkFirewall::LoggingConfiguration
Idaws.networkfirewall.logging_configuration
+ +## Fields + + + + + + + +
NameDatatypeDescription
firewall_namestring
firewall_arnstring
logging_configurationobject
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +firewall_name, +firewall_arn, +logging_configuration +FROM aws.networkfirewall.logging_configuration +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the logging_configuration resource, the following permissions are required: + +### Read +```json +logs:GetLogDelivery, +logs:ListLogDeliveries, +network-firewall:DescribeLoggingConfiguration +``` + +### Update +```json +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 +```json +logs:DeleteLogDelivery, +logs:ListLogDeliveries, +logs:GetLogDelivery, +network-firewall:UpdateLoggingConfiguration, +network-firewall:DescribeLoggingConfiguration +``` + diff --git a/docs/aws-docs/providers/aws/networkfirewall/logging_configurations/index.md b/docs/aws-docs/providers/aws/networkfirewall/logging_configurations/index.md new file mode 100644 index 0000000000..f9d12ef430 --- /dev/null +++ b/docs/aws-docs/providers/aws/networkfirewall/logging_configurations/index.md @@ -0,0 +1,90 @@ +--- +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
DescriptionResource type definition for AWS::NetworkFirewall::LoggingConfiguration
Idaws.networkfirewall.logging_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
firewall_arnundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +firewall_arn +FROM aws.networkfirewall.logging_configurations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the logging_configurations resource, the following permissions are required: + +### Create +```json +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 +```json +logs:GetLogDelivery, +logs:ListLogDeliveries, +network-firewall:DescribeLoggingConfiguration +``` + diff --git a/docs/aws-docs/providers/aws/networkfirewall/rule_group/index.md b/docs/aws-docs/providers/aws/networkfirewall/rule_group/index.md new file mode 100644 index 0000000000..ac622f3331 --- /dev/null +++ b/docs/aws-docs/providers/aws/networkfirewall/rule_group/index.md @@ -0,0 +1,109 @@ +--- +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
DescriptionResource type definition for AWS::NetworkFirewall::RuleGroup
Idaws.networkfirewall.rule_group
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
rule_group_namestring
rule_group_arnstring
rule_group_idstring
rule_groupobject
typestring
capacityinteger
descriptionstring
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +rule_group_name, +rule_group_arn, +rule_group_id, +rule_group, +type, +capacity, +description, +tags +FROM aws.networkfirewall.rule_group +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the rule_group resource, the following permissions are required: + +### Read +```json +network-firewall:DescribeRuleGroup, +network-firewall:ListTagsForResources +``` + +### Update +```json +network-firewall:UpdateRuleGroup, +network-firewall:DescribeRuleGroup, +network-firewall:TagResource, +network-firewall:UntagResource, +iam:CreateServiceLinkedRole, +ec2:GetManagedPrefixListEntries +``` + +### Delete +```json +network-firewall:DeleteRuleGroup, +network-firewall:DescribeRuleGroup, +network-firewall:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/networkfirewall/rule_groups/index.md b/docs/aws-docs/providers/aws/networkfirewall/rule_groups/index.md new file mode 100644 index 0000000000..b5782ad07a --- /dev/null +++ b/docs/aws-docs/providers/aws/networkfirewall/rule_groups/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionResource type definition for AWS::NetworkFirewall::RuleGroup
Idaws.networkfirewall.rule_groups
+ +## Fields + + + + + +
NameDatatypeDescription
rule_group_arnundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +rule_group_arn +FROM aws.networkfirewall.rule_groups +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the rule_groups resource, the following permissions are required: + +### Create +```json +network-firewall:CreateRuleGroup, +network-firewall:DescribeRuleGroup, +network-firewall:TagResource, +network-firewall:ListRuleGroups, +iam:CreateServiceLinkedRole, +ec2:GetManagedPrefixListEntries +``` + +### List +```json +network-firewall:ListRuleGroups +``` + diff --git a/docs/aws-docs/providers/aws/networkfirewall/tls_inspection_configuration/index.md b/docs/aws-docs/providers/aws/networkfirewall/tls_inspection_configuration/index.md new file mode 100644 index 0000000000..3819348a6d --- /dev/null +++ b/docs/aws-docs/providers/aws/networkfirewall/tls_inspection_configuration/index.md @@ -0,0 +1,103 @@ +--- +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
DescriptionResource type definition for AWS::NetworkFirewall::TLSInspectionConfiguration
Idaws.networkfirewall.tls_inspection_configuration
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
tls_inspection_configuration_namestring
tls_inspection_configuration_arnstring
tls_inspection_configurationobject
tls_inspection_configuration_idstring
descriptionstring
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +tls_inspection_configuration_name, +tls_inspection_configuration_arn, +tls_inspection_configuration, +tls_inspection_configuration_id, +description, +tags +FROM aws.networkfirewall.tls_inspection_configuration +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the tls_inspection_configuration resource, the following permissions are required: + +### Read +```json +network-firewall:DescribeTLSInspectionConfiguration, +network-firewall:ListTagsForResources +``` + +### Update +```json +network-firewall:UpdateTLSInspectionConfiguration, +network-firewall:DescribeTLSInspectionConfiguration, +network-firewall:TagResource, +network-firewall:UntagResource +``` + +### Delete +```json +network-firewall:DeleteTLSInspectionConfiguration, +network-firewall:DescribeTLSInspectionConfiguration, +network-firewall:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/networkfirewall/tls_inspection_configurations/index.md b/docs/aws-docs/providers/aws/networkfirewall/tls_inspection_configurations/index.md new file mode 100644 index 0000000000..3153f493e0 --- /dev/null +++ b/docs/aws-docs/providers/aws/networkfirewall/tls_inspection_configurations/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionResource type definition for AWS::NetworkFirewall::TLSInspectionConfiguration
Idaws.networkfirewall.tls_inspection_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
tls_inspection_configuration_arnundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +tls_inspection_configuration_arn +FROM aws.networkfirewall.tls_inspection_configurations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the tls_inspection_configurations resource, the following permissions are required: + +### Create +```json +iam:CreateServiceLinkedRole, +network-firewall:CreateTLSInspectionConfiguration, +network-firewall:DescribeTLSInspectionConfiguration, +network-firewall:TagResource +``` + +### List +```json +network-firewall:ListTLSInspectionConfigurations +``` + diff --git a/docs/aws-docs/providers/aws/networkmanager/connect_attachment/index.md b/docs/aws-docs/providers/aws/networkmanager/connect_attachment/index.md new file mode 100644 index 0000000000..1c4e761313 --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/connect_attachment/index.md @@ -0,0 +1,123 @@ +--- +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
DescriptionAWS::NetworkManager::ConnectAttachment Resource Type Definition
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.networkmanager.connect_attachment +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the connect_attachment resource, the following permissions are required: + +### Read +```json +networkmanager:GetConnectAttachment +``` + +### Update +```json +networkmanager:GetConnectAttachment, +networkmanager:ListTagsForResource, +networkmanager:TagResource, +networkmanager:UntagResource, +ec2:DescribeRegions +``` + +### Delete +```json +networkmanager:GetConnectAttachment, +networkmanager:DeleteAttachment, +ec2:DescribeRegions +``` + diff --git a/docs/aws-docs/providers/aws/networkmanager/connect_attachments/index.md b/docs/aws-docs/providers/aws/networkmanager/connect_attachments/index.md new file mode 100644 index 0000000000..e313427c02 --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/connect_attachments/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionAWS::NetworkManager::ConnectAttachment Resource Type Definition
Idaws.networkmanager.connect_attachments
+ +## Fields + + + + + +
NameDatatypeDescription
attachment_idstringThe ID of the attachment.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +attachment_id +FROM aws.networkmanager.connect_attachments +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the connect_attachments resource, the following permissions are required: + +### Create +```json +networkmanager:GetConnectAttachment, +networkmanager:CreateConnectAttachment, +networkmanager:TagResource, +ec2:DescribeRegions +``` + +### List +```json +networkmanager:ListAttachments +``` + diff --git a/docs/aws-docs/providers/aws/networkmanager/connect_peer/index.md b/docs/aws-docs/providers/aws/networkmanager/connect_peer/index.md new file mode 100644 index 0000000000..d9dad98dfe --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/connect_peer/index.md @@ -0,0 +1,117 @@ +--- +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
DescriptionAWS::NetworkManager::ConnectPeer Resource Type Definition.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.networkmanager.connect_peer +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the connect_peer resource, the following permissions are required: + +### Read +```json +networkmanager:GetConnectPeer +``` + +### Update +```json +networkmanager:GetConnectPeer, +networkmanager:ListTagsForResource, +networkmanager:TagResource, +networkmanager:UntagResource, +ec2:DescribeRegions +``` + +### Delete +```json +networkmanager:GetConnectPeer, +networkmanager:DeleteConnectPeer, +ec2:DescribeRegions +``` + diff --git a/docs/aws-docs/providers/aws/networkmanager/connect_peers/index.md b/docs/aws-docs/providers/aws/networkmanager/connect_peers/index.md new file mode 100644 index 0000000000..95ebfdb495 --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/connect_peers/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionAWS::NetworkManager::ConnectPeer Resource Type Definition.
Idaws.networkmanager.connect_peers
+ +## Fields + + + + + +
NameDatatypeDescription
connect_peer_idstringThe ID of the Connect peer.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +connect_peer_id +FROM aws.networkmanager.connect_peers +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the connect_peers resource, the following permissions are required: + +### Create +```json +networkmanager:GetConnectPeer, +networkmanager:CreateConnectPeer, +networkmanager:TagResource, +ec2:DescribeRegions +``` + +### List +```json +networkmanager:ListConnectPeers +``` + diff --git a/docs/aws-docs/providers/aws/networkmanager/core_network/index.md b/docs/aws-docs/providers/aws/networkmanager/core_network/index.md new file mode 100644 index 0000000000..43ada36a5a --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/core_network/index.md @@ -0,0 +1,120 @@ +--- +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
DescriptionAWS::NetworkManager::CoreNetwork Resource Type Definition.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.networkmanager.core_network +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the core_network resource, the following permissions are required: + +### Read +```json +networkmanager:GetCoreNetwork, +networkmanager:GetCoreNetworkPolicy +``` + +### Update +```json +networkmanager:UpdateCoreNetwork, +networkmanager:GetCoreNetwork, +networkmanager:ListTagsForResource, +networkmanager:PutCoreNetworkPolicy, +networkmanager:GetCoreNetworkPolicy, +networkmanager:ExecuteCoreNetworkChangeSet, +networkmanager:TagResource, +networkmanager:UntagResource, +ec2:DescribeRegions +``` + +### Delete +```json +networkmanager:DeleteCoreNetwork, +networkmanager:UntagResource, +networkmanager:GetCoreNetwork, +networkmanager:GetCoreNetworkPolicy, +ec2:DescribeRegions +``` + diff --git a/docs/aws-docs/providers/aws/networkmanager/core_networks/index.md b/docs/aws-docs/providers/aws/networkmanager/core_networks/index.md new file mode 100644 index 0000000000..8b3f01dd63 --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/core_networks/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionAWS::NetworkManager::CoreNetwork Resource Type Definition.
Idaws.networkmanager.core_networks
+ +## Fields + + + + + +
NameDatatypeDescription
core_network_idstringThe Id of core network
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +core_network_id +FROM aws.networkmanager.core_networks +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the core_networks resource, the following permissions are required: + +### Create +```json +networkmanager:CreateCoreNetwork, +networkmanager:GetCoreNetwork, +networkmanager:GetCoreNetworkPolicy, +networkmanager:TagResource, +ec2:DescribeRegions +``` + +### List +```json +networkmanager:ListCoreNetworks +``` + diff --git a/docs/aws-docs/providers/aws/networkmanager/customer_gateway_association/index.md b/docs/aws-docs/providers/aws/networkmanager/customer_gateway_association/index.md new file mode 100644 index 0000000000..59cd3171cf --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/customer_gateway_association/index.md @@ -0,0 +1,83 @@ +--- +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
DescriptionThe AWS::NetworkManager::CustomerGatewayAssociation type associates a customer gateway with a device and optionally, with a link.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +global_network_id, +customer_gateway_arn, +device_id, +link_id +FROM aws.networkmanager.customer_gateway_association +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the customer_gateway_association resource, the following permissions are required: + +### Read +```json +networkmanager:GetCustomerGatewayAssociations +``` + +### Delete +```json +networkmanager:DisassociateCustomerGateway +``` + diff --git a/docs/aws-docs/providers/aws/networkmanager/customer_gateway_associations/index.md b/docs/aws-docs/providers/aws/networkmanager/customer_gateway_associations/index.md new file mode 100644 index 0000000000..5029efefdb --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/customer_gateway_associations/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionThe AWS::NetworkManager::CustomerGatewayAssociation type associates a customer gateway with a device and optionally, with a link.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +global_network_id, +customer_gateway_arn +FROM aws.networkmanager.customer_gateway_associations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the customer_gateway_associations resource, the following permissions are required: + +### Create +```json +networkmanager:GetCustomerGatewayAssociations, +networkmanager:AssociateCustomerGateway +``` + +### List +```json +networkmanager:GetCustomerGatewayAssociations +``` + diff --git a/docs/aws-docs/providers/aws/networkmanager/device/index.md b/docs/aws-docs/providers/aws/networkmanager/device/index.md new file mode 100644 index 0000000000..63b7416bae --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/device/index.md @@ -0,0 +1,118 @@ +--- +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
DescriptionThe AWS::NetworkManager::Device type describes a device.
Idaws.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.
aws_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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +device_arn, +device_id, +description, +tags, +global_network_id, +aws_location, +location, +model, +serial_number, +site_id, +type, +vendor, +created_at, +state +FROM aws.networkmanager.device +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the device resource, the following permissions are required: + +### Read +```json +networkmanager:GetDevices +``` + +### Update +```json +networkmanager:UpdateDevice, +networkmanager:ListTagsForResource, +networkmanager:GetDevices, +networkmanager:TagResource, +networkmanager:UntagResource +``` + +### Delete +```json +networkmanager:GetDevices, +networkmanager:DeleteDevice +``` + diff --git a/docs/aws-docs/providers/aws/networkmanager/devices/index.md b/docs/aws-docs/providers/aws/networkmanager/devices/index.md new file mode 100644 index 0000000000..25944a784c --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/devices/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionThe AWS::NetworkManager::Device type describes a device.
Idaws.networkmanager.devices
+ +## Fields + + + + + + +
NameDatatypeDescription
global_network_idstringThe ID of the global network.
device_idstringThe ID of the device.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +global_network_id, +device_id +FROM aws.networkmanager.devices +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the devices resource, the following permissions are required: + +### Create +```json +networkmanager:CreateDevice, +networkmanager:GetDevices, +networkmanager:TagResource +``` + +### List +```json +networkmanager:GetDevices +``` + diff --git a/docs/aws-docs/providers/aws/networkmanager/global_network/index.md b/docs/aws-docs/providers/aws/networkmanager/global_network/index.md new file mode 100644 index 0000000000..1ec71ce8d1 --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/global_network/index.md @@ -0,0 +1,102 @@ +--- +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
DescriptionThe AWS::NetworkManager::GlobalNetwork type specifies a global network of the user's account
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +id, +description, +tags, +created_at, +state +FROM aws.networkmanager.global_network +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the global_network resource, the following permissions are required: + +### Read +```json +networkmanager:DescribeGlobalNetworks +``` + +### Update +```json +networkmanager:UpdateGlobalNetwork, +networkmanager:DescribeGlobalNetworks, +networkmanager:TagResource, +networkmanager:UntagResource, +networkmanager:ListTagsForResource +``` + +### Delete +```json +networkmanager:DeleteGlobalNetwork, +networkmanager:DescribeGlobalNetworks +``` + diff --git a/docs/aws-docs/providers/aws/networkmanager/global_networks/index.md b/docs/aws-docs/providers/aws/networkmanager/global_networks/index.md new file mode 100644 index 0000000000..2be778ae0c --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/global_networks/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionThe AWS::NetworkManager::GlobalNetwork type specifies a global network of the user's account
Idaws.networkmanager.global_networks
+ +## Fields + + + + + +
NameDatatypeDescription
idstringThe ID of the global network.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.networkmanager.global_networks +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the global_networks resource, the following permissions are required: + +### Create +```json +networkmanager:CreateGlobalNetwork, +networkmanager:DescribeGlobalNetworks, +networkmanager:TagResource, +iam:CreateServiceLinkedRole +``` + +### List +```json +networkmanager:DescribeGlobalNetworks +``` + diff --git a/docs/aws-docs/providers/aws/networkmanager/index.md b/docs/aws-docs/providers/aws/networkmanager/index.md new file mode 100644 index 0000000000..217a4f1430 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/networkmanager/link/index.md b/docs/aws-docs/providers/aws/networkmanager/link/index.md new file mode 100644 index 0000000000..88bb9a24f3 --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/link/index.md @@ -0,0 +1,112 @@ +--- +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
DescriptionThe AWS::NetworkManager::Link type describes a link.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +link_arn, +link_id, +global_network_id, +site_id, +bandwidth, +provider, +description, +tags, +type, +created_at, +state +FROM aws.networkmanager.link +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the link resource, the following permissions are required: + +### Read +```json +networkmanager:GetLinks +``` + +### Update +```json +networkmanager:ListTagsForResource, +networkmanager:TagResource, +networkmanager:GetLinks, +networkmanager:UntagResource, +networkmanager:UpdateLink +``` + +### Delete +```json +networkmanager:GetLinks, +networkmanager:DeleteLink +``` + diff --git a/docs/aws-docs/providers/aws/networkmanager/link_association/index.md b/docs/aws-docs/providers/aws/networkmanager/link_association/index.md new file mode 100644 index 0000000000..4303306265 --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/link_association/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionThe AWS::NetworkManager::LinkAssociation type associates a link to a device. The device and link must be in the same global network and the same site.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +global_network_id, +device_id, +link_id +FROM aws.networkmanager.link_association +WHERE data__Identifier = '||'; +``` + +## Permissions + +To operate on the link_association resource, the following permissions are required: + +### Read +```json +networkmanager:GetLinkAssociations +``` + +### Delete +```json +networkmanager:DisassociateLink +``` + diff --git a/docs/aws-docs/providers/aws/networkmanager/link_associations/index.md b/docs/aws-docs/providers/aws/networkmanager/link_associations/index.md new file mode 100644 index 0000000000..eeae576d06 --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/link_associations/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionThe AWS::NetworkManager::LinkAssociation type associates a link to a device. The device and link must be in the same global network and the same site.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +global_network_id, +device_id, +link_id +FROM aws.networkmanager.link_associations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the link_associations resource, the following permissions are required: + +### Create +```json +networkmanager:GetLinkAssociations, +networkmanager:AssociateLink +``` + +### List +```json +networkmanager:GetLinkAssociations +``` + diff --git a/docs/aws-docs/providers/aws/networkmanager/links/index.md b/docs/aws-docs/providers/aws/networkmanager/links/index.md new file mode 100644 index 0000000000..6ed2ce5cb8 --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/links/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionThe AWS::NetworkManager::Link type describes a link.
Idaws.networkmanager.links
+ +## Fields + + + + + + +
NameDatatypeDescription
global_network_idstringThe ID of the global network.
link_idstringThe ID of the link.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +global_network_id, +link_id +FROM aws.networkmanager.links +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the links resource, the following permissions are required: + +### Create +```json +networkmanager:CreateLink, +networkmanager:GetLinks, +networkmanager:TagResource +``` + +### List +```json +networkmanager:GetLinks +``` + diff --git a/docs/aws-docs/providers/aws/networkmanager/site/index.md b/docs/aws-docs/providers/aws/networkmanager/site/index.md new file mode 100644 index 0000000000..8855da9337 --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/site/index.md @@ -0,0 +1,106 @@ +--- +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
DescriptionThe AWS::NetworkManager::Site type describes a site.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +site_arn, +site_id, +description, +tags, +global_network_id, +location, +created_at, +state +FROM aws.networkmanager.site +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the site resource, the following permissions are required: + +### Read +```json +networkmanager:GetSites +``` + +### Update +```json +networkmanager:GetSites, +networkmanager:ListTagsForResource, +networkmanager:TagResource, +networkmanager:UntagResource, +networkmanager:UpdateSite +``` + +### Delete +```json +networkmanager:GetSites, +networkmanager:DeleteSite +``` + diff --git a/docs/aws-docs/providers/aws/networkmanager/site_to_site_vpn_attachment/index.md b/docs/aws-docs/providers/aws/networkmanager/site_to_site_vpn_attachment/index.md new file mode 100644 index 0000000000..99eee7f3f8 --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/site_to_site_vpn_attachment/index.md @@ -0,0 +1,121 @@ +--- +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
DescriptionAWS::NetworkManager::SiteToSiteVpnAttachment Resource Type definition.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.networkmanager.site_to_site_vpn_attachment +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the site_to_site_vpn_attachment resource, the following permissions are required: + +### Read +```json +networkmanager:GetSiteToSiteVpnAttachment +``` + +### Update +```json +networkmanager:GetSiteToSiteVpnAttachment, +networkmanager:ListTagsForResource, +networkmanager:TagResource, +networkmanager:UntagResource, +ec2:DescribeRegions +``` + +### Delete +```json +networkmanager:GetSiteToSiteVpnAttachment, +networkmanager:DeleteAttachment, +ec2:DescribeRegions +``` + diff --git a/docs/aws-docs/providers/aws/networkmanager/site_to_site_vpn_attachments/index.md b/docs/aws-docs/providers/aws/networkmanager/site_to_site_vpn_attachments/index.md new file mode 100644 index 0000000000..f7f11b7113 --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/site_to_site_vpn_attachments/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionAWS::NetworkManager::SiteToSiteVpnAttachment Resource Type definition.
Idaws.networkmanager.site_to_site_vpn_attachments
+ +## Fields + + + + + +
NameDatatypeDescription
attachment_idstringThe ID of the attachment.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +attachment_id +FROM aws.networkmanager.site_to_site_vpn_attachments +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the site_to_site_vpn_attachments resource, the following permissions are required: + +### Create +```json +networkmanager:GetSiteToSiteVpnAttachment, +networkmanager:CreateSiteToSiteVpnAttachment, +ec2:DescribeRegions, +networkmanager:TagResource +``` + +### List +```json +networkmanager:ListAttachments +``` + diff --git a/docs/aws-docs/providers/aws/networkmanager/sites/index.md b/docs/aws-docs/providers/aws/networkmanager/sites/index.md new file mode 100644 index 0000000000..b53338a178 --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/sites/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionThe AWS::NetworkManager::Site type describes a site.
Idaws.networkmanager.sites
+ +## Fields + + + + + + +
NameDatatypeDescription
global_network_idstringThe ID of the global network.
site_idstringThe ID of the site.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +global_network_id, +site_id +FROM aws.networkmanager.sites +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the sites resource, the following permissions are required: + +### Create +```json +networkmanager:CreateSite, +networkmanager:GetSites, +networkmanager:TagResource +``` + +### List +```json +networkmanager:GetSites +``` + diff --git a/docs/aws-docs/providers/aws/networkmanager/transit_gateway_peering/index.md b/docs/aws-docs/providers/aws/networkmanager/transit_gateway_peering/index.md new file mode 100644 index 0000000000..870bf1dba5 --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/transit_gateway_peering/index.md @@ -0,0 +1,116 @@ +--- +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
DescriptionAWS::NetworkManager::TransitGatewayPeering Resoruce Type.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.networkmanager.transit_gateway_peering +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the transit_gateway_peering resource, the following permissions are required: + +### Read +```json +networkmanager:GetTransitGatewayPeering, +networkmanager:TagResource +``` + +### Update +```json +networkmanager:TagResource, +networkmanager:UntagResource, +networkmanager:ListTagsForResource, +networkmanager:GetTransitGatewayPeering, +ec2:DescribeRegions +``` + +### Delete +```json +networkmanager:DeletePeering, +networkmanager:GetTransitGatewayPeering, +ec2:DescribeRegions +``` + diff --git a/docs/aws-docs/providers/aws/networkmanager/transit_gateway_peerings/index.md b/docs/aws-docs/providers/aws/networkmanager/transit_gateway_peerings/index.md new file mode 100644 index 0000000000..b46e33db5b --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/transit_gateway_peerings/index.md @@ -0,0 +1,83 @@ +--- +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
DescriptionAWS::NetworkManager::TransitGatewayPeering Resoruce Type.
Idaws.networkmanager.transit_gateway_peerings
+ +## Fields + + + + + +
NameDatatypeDescription
peering_idstringThe Id of the transit gateway peering
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +peering_id +FROM aws.networkmanager.transit_gateway_peerings +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the transit_gateway_peerings resource, the following permissions are required: + +### Create +```json +networkmanager:CreateTransitGatewayPeering, +networkmanager:TagResource, +networkmanager:GetTransitGatewayPeering, +iam:CreateServiceLinkedRole, +ec2:CreateTransitGatewayPeeringAttachment, +ec2:AcceptTransitGatewayPeeringAttachment, +ec2:DescribeRegions +``` + +### List +```json +networkmanager:ListPeerings +``` + diff --git a/docs/aws-docs/providers/aws/networkmanager/transit_gateway_registration/index.md b/docs/aws-docs/providers/aws/networkmanager/transit_gateway_registration/index.md new file mode 100644 index 0000000000..aa31066304 --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/transit_gateway_registration/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionThe AWS::NetworkManager::TransitGatewayRegistration type registers a transit gateway in your global network. The transit gateway can be in any AWS Region, but it must be owned by the same AWS account that owns the global network. You cannot register a transit gateway in more than one global network.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +global_network_id, +transit_gateway_arn +FROM aws.networkmanager.transit_gateway_registration +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the transit_gateway_registration resource, the following permissions are required: + +### Read +```json +networkmanager:GetTransitGatewayRegistrations +``` + +### Delete +```json +networkmanager:DeregisterTransitGateway, +networkmanager:GetTransitGatewayRegistrations +``` + diff --git a/docs/aws-docs/providers/aws/networkmanager/transit_gateway_registrations/index.md b/docs/aws-docs/providers/aws/networkmanager/transit_gateway_registrations/index.md new file mode 100644 index 0000000000..a571db9428 --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/transit_gateway_registrations/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionThe AWS::NetworkManager::TransitGatewayRegistration type registers a transit gateway in your global network. The transit gateway can be in any AWS Region, but it must be owned by the same AWS account that owns the global network. You cannot register a transit gateway in more than one global network.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +global_network_id, +transit_gateway_arn +FROM aws.networkmanager.transit_gateway_registrations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the transit_gateway_registrations resource, the following permissions are required: + +### Create +```json +networkmanager:RegisterTransitGateway, +networkmanager:GetTransitGatewayRegistrations +``` + +### List +```json +networkmanager:GetTransitGatewayRegistrations +``` + diff --git a/docs/aws-docs/providers/aws/networkmanager/transit_gateway_route_table_attachment/index.md b/docs/aws-docs/providers/aws/networkmanager/transit_gateway_route_table_attachment/index.md new file mode 100644 index 0000000000..4251d8c6a4 --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/transit_gateway_route_table_attachment/index.md @@ -0,0 +1,123 @@ +--- +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
DescriptionAWS::NetworkManager::TransitGatewayRouteTableAttachment Resource Type definition.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.networkmanager.transit_gateway_route_table_attachment +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the transit_gateway_route_table_attachment resource, the following permissions are required: + +### Read +```json +networkmanager:GetTransitGatewayRouteTableAttachment +``` + +### Update +```json +networkmanager:GetTransitGatewayRouteTableAttachment, +networkmanager:ListTagsForResource, +networkmanager:TagResource, +networkmanager:UntagResource, +ec2:DescribeRegions +``` + +### Delete +```json +networkmanager:GetTransitGatewayRouteTableAttachment, +networkmanager:DeleteAttachment, +ec2:DescribeRegions +``` + diff --git a/docs/aws-docs/providers/aws/networkmanager/transit_gateway_route_table_attachments/index.md b/docs/aws-docs/providers/aws/networkmanager/transit_gateway_route_table_attachments/index.md new file mode 100644 index 0000000000..543ac3dbdf --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/transit_gateway_route_table_attachments/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionAWS::NetworkManager::TransitGatewayRouteTableAttachment Resource Type definition.
Idaws.networkmanager.transit_gateway_route_table_attachments
+ +## Fields + + + + + +
NameDatatypeDescription
attachment_idstringThe ID of the attachment.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +attachment_id +FROM aws.networkmanager.transit_gateway_route_table_attachments +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the transit_gateway_route_table_attachments resource, the following permissions are required: + +### Create +```json +networkmanager:CreateTransitGatewayRouteTableAttachment, +networkmanager:GetTransitGatewayRouteTableAttachment, +networkmanager:TagResource, +iam:CreateServiceLinkedRole, +ec2:DescribeRegions +``` + +### List +```json +networkmanager:ListAttachments +``` + diff --git a/docs/aws-docs/providers/aws/networkmanager/vpc_attachment/index.md b/docs/aws-docs/providers/aws/networkmanager/vpc_attachment/index.md new file mode 100644 index 0000000000..8a460ba0a0 --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/vpc_attachment/index.md @@ -0,0 +1,127 @@ +--- +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
DescriptionAWS::NetworkManager::VpcAttachment Resoruce Type
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.networkmanager.vpc_attachment +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the vpc_attachment resource, the following permissions are required: + +### Read +```json +networkmanager:GetVpcAttachment +``` + +### Update +```json +networkmanager:UpdateVpcAttachment, +networkmanager:GetVpcAttachment, +networkmanager:ListTagsForResource, +networkmanager:TagResource, +networkmanager:UntagResource, +ec2:DescribeRegions +``` + +### Delete +```json +networkmanager:DeleteAttachment, +networkmanager:GetVpcAttachment, +networkmanager:UntagResource, +ec2:DescribeRegions +``` + diff --git a/docs/aws-docs/providers/aws/networkmanager/vpc_attachments/index.md b/docs/aws-docs/providers/aws/networkmanager/vpc_attachments/index.md new file mode 100644 index 0000000000..8015d98c87 --- /dev/null +++ b/docs/aws-docs/providers/aws/networkmanager/vpc_attachments/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionAWS::NetworkManager::VpcAttachment Resoruce Type
Idaws.networkmanager.vpc_attachments
+ +## Fields + + + + + +
NameDatatypeDescription
attachment_idstringId of the attachment.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +attachment_id +FROM aws.networkmanager.vpc_attachments +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the vpc_attachments resource, the following permissions are required: + +### Create +```json +networkmanager:CreateVpcAttachment, +networkmanager:GetVpcAttachment, +networkmanager:TagResource, +ec2:DescribeRegions, +iam:CreateServiceLinkedRole +``` + +### List +```json +networkmanager:ListAttachments +``` + diff --git a/docs/aws-docs/providers/aws/nimblestudio/index.md b/docs/aws-docs/providers/aws/nimblestudio/index.md new file mode 100644 index 0000000000..9111552831 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/nimblestudio/launch_profile/index.md b/docs/aws-docs/providers/aws/nimblestudio/launch_profile/index.md new file mode 100644 index 0000000000..319e3e23d4 --- /dev/null +++ b/docs/aws-docs/providers/aws/nimblestudio/launch_profile/index.md @@ -0,0 +1,110 @@ +--- +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
DescriptionRepresents a launch profile which delegates access to a collection of studio components to studio users
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.nimblestudio.launch_profile +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the launch_profile resource, the following permissions are required: + +### Read +```json +nimble:GetLaunchProfile +``` + +### Update +```json +nimble:UpdateLaunchProfile, +nimble:GetLaunchProfile, +ec2:CreateNetworkInterface, +ec2:CreateNetworkInterfacePermission, +ec2:DescribeSubnets, +ec2:RunInstances +``` + +### Delete +```json +nimble:DeleteLaunchProfile, +nimble:GetLaunchProfile, +nimble:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/nimblestudio/launch_profiles/index.md b/docs/aws-docs/providers/aws/nimblestudio/launch_profiles/index.md new file mode 100644 index 0000000000..9902cb3bdc --- /dev/null +++ b/docs/aws-docs/providers/aws/nimblestudio/launch_profiles/index.md @@ -0,0 +1,85 @@ +--- +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
DescriptionRepresents a launch profile which delegates access to a collection of studio components to studio users
Idaws.nimblestudio.launch_profiles
+ +## Fields + + + + + + +
NameDatatypeDescription
launch_profile_idstring
studio_idstring<p>The studio ID. </p>
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +launch_profile_id, +studio_id +FROM aws.nimblestudio.launch_profiles +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the launch_profiles resource, the following permissions are required: + +### Create +```json +nimble:CreateLaunchProfile, +nimble:GetLaunchProfile, +nimble:TagResource, +ec2:CreateNetworkInterface, +ec2:CreateNetworkInterfacePermission, +ec2:RunInstances, +ec2:DescribeSubnets +``` + +### List +```json +nimble:ListLaunchProfiles +``` + diff --git a/docs/aws-docs/providers/aws/nimblestudio/streaming_image/index.md b/docs/aws-docs/providers/aws/nimblestudio/streaming_image/index.md new file mode 100644 index 0000000000..2393eb3b9e --- /dev/null +++ b/docs/aws-docs/providers/aws/nimblestudio/streaming_image/index.md @@ -0,0 +1,119 @@ +--- +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
DescriptionRepresents a streaming session machine image that can be used to launch a streaming session
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +description, +ec2_image_id, +encryption_configuration, +eula_ids, +name, +owner, +platform, +streaming_image_id, +studio_id, +tags +FROM aws.nimblestudio.streaming_image +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the streaming_image resource, the following permissions are required: + +### Read +```json +nimble:GetStreamingImage +``` + +### Update +```json +nimble:UpdateStreamingImage, +nimble:GetStreamingImage, +kms:Encrypt, +kms:Decrypt, +kms:CreateGrant, +kms:ListGrants, +kms:GenerateDataKey +``` + +### Delete +```json +nimble:DeleteStreamingImage, +nimble:GetStreamingImage, +nimble:UntagResource, +ec2:ModifyInstanceAttribute, +ec2:ModifySnapshotAttribute, +ec2:DeregisterImage, +ec2:DeleteSnapshot, +kms:ListGrants, +kms:RetireGrant +``` + diff --git a/docs/aws-docs/providers/aws/nimblestudio/streaming_images/index.md b/docs/aws-docs/providers/aws/nimblestudio/streaming_images/index.md new file mode 100644 index 0000000000..fc9613510f --- /dev/null +++ b/docs/aws-docs/providers/aws/nimblestudio/streaming_images/index.md @@ -0,0 +1,92 @@ +--- +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
DescriptionRepresents a streaming session machine image that can be used to launch a streaming session
Idaws.nimblestudio.streaming_images
+ +## Fields + + + + + + +
NameDatatypeDescription
studio_idstring<p>The studioId. </p>
streaming_image_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +studio_id, +streaming_image_id +FROM aws.nimblestudio.streaming_images +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the streaming_images resource, the following permissions are required: + +### Create +```json +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 +```json +nimble:ListStreamingImages +``` + diff --git a/docs/aws-docs/providers/aws/nimblestudio/studio/index.md b/docs/aws-docs/providers/aws/nimblestudio/studio/index.md new file mode 100644 index 0000000000..78267f4cee --- /dev/null +++ b/docs/aws-docs/providers/aws/nimblestudio/studio/index.md @@ -0,0 +1,125 @@ +--- +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
DescriptionRepresents a studio that contains other Nimble Studio resources
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.nimblestudio.studio +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the studio resource, the following permissions are required: + +### Read +```json +nimble:GetStudio, +kms:Encrypt, +kms:Decrypt, +kms:ListGrants, +kms:GenerateDataKey +``` + +### Update +```json +iam:PassRole, +nimble:UpdateStudio, +nimble:GetStudio, +kms:Encrypt, +kms:Decrypt, +kms:CreateGrant, +kms:ListGrants, +kms:GenerateDataKey +``` + +### Delete +```json +nimble:DeleteStudio, +nimble:GetStudio, +nimble:UntagResource, +kms:Encrypt, +kms:Decrypt, +kms:ListGrants, +kms:RetireGrant, +kms:GenerateDataKey, +sso:DeleteManagedApplicationInstance, +sso:GetManagedApplicationInstance +``` + diff --git a/docs/aws-docs/providers/aws/nimblestudio/studio_component/index.md b/docs/aws-docs/providers/aws/nimblestudio/studio_component/index.md new file mode 100644 index 0000000000..7e884a6765 --- /dev/null +++ b/docs/aws-docs/providers/aws/nimblestudio/studio_component/index.md @@ -0,0 +1,120 @@ +--- +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
DescriptionRepresents a studio component that connects a non-Nimble Studio resource in your account to your studio
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.nimblestudio.studio_component +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the studio_component resource, the following permissions are required: + +### Read +```json +nimble:GetStudioComponent +``` + +### Update +```json +iam:PassRole, +nimble:UpdateStudioComponent, +nimble:GetStudioComponent, +ds:AuthorizeApplication, +ec2:DescribeSecurityGroups, +fsx:DescribeFilesystems, +ds:DescribeDirectories +``` + +### Delete +```json +nimble:DeleteStudioComponent, +nimble:GetStudioComponent, +nimble:UntagResource, +ds:UnauthorizeApplication +``` + diff --git a/docs/aws-docs/providers/aws/nimblestudio/studio_components/index.md b/docs/aws-docs/providers/aws/nimblestudio/studio_components/index.md new file mode 100644 index 0000000000..3b4447a513 --- /dev/null +++ b/docs/aws-docs/providers/aws/nimblestudio/studio_components/index.md @@ -0,0 +1,86 @@ +--- +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
DescriptionRepresents a studio component that connects a non-Nimble Studio resource in your account to your studio
Idaws.nimblestudio.studio_components
+ +## Fields + + + + + + +
NameDatatypeDescription
studio_component_idstring
studio_idstring<p>The studio ID. </p>
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +studio_component_id, +studio_id +FROM aws.nimblestudio.studio_components +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the studio_components resource, the following permissions are required: + +### Create +```json +iam:PassRole, +nimble:CreateStudioComponent, +nimble:GetStudioComponent, +nimble:TagResource, +ds:AuthorizeApplication, +ec2:DescribeSecurityGroups, +fsx:DescribeFilesystems, +ds:DescribeDirectories +``` + +### List +```json +nimble:ListStudioComponents +``` + diff --git a/docs/aws-docs/providers/aws/nimblestudio/studios/index.md b/docs/aws-docs/providers/aws/nimblestudio/studios/index.md new file mode 100644 index 0000000000..b63a3a43d5 --- /dev/null +++ b/docs/aws-docs/providers/aws/nimblestudio/studios/index.md @@ -0,0 +1,86 @@ +--- +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
DescriptionRepresents a studio that contains other Nimble Studio resources
Idaws.nimblestudio.studios
+ +## Fields + + + + + +
NameDatatypeDescription
studio_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +studio_id +FROM aws.nimblestudio.studios +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the studios resource, the following permissions are required: + +### Create +```json +iam:PassRole, +nimble:CreateStudio, +nimble:GetStudio, +nimble:TagResource, +sso:CreateManagedApplicationInstance, +kms:Encrypt, +kms:Decrypt, +kms:CreateGrant, +kms:ListGrants, +kms:GenerateDataKey +``` + +### List +```json +nimble:ListStudios +``` + diff --git a/docs/aws-docs/providers/aws/oam/index.md b/docs/aws-docs/providers/aws/oam/index.md new file mode 100644 index 0000000000..d40351946a --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/oam/link/index.md b/docs/aws-docs/providers/aws/oam/link/index.md new file mode 100644 index 0000000000..8a0c193ba2 --- /dev/null +++ b/docs/aws-docs/providers/aws/oam/link/index.md @@ -0,0 +1,108 @@ +--- +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
DescriptionDefinition of AWS::Oam::Link Resource Type
Idaws.oam.link
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
arnstring
labelstring
label_templatestring
resource_typesarray
sink_identifierstring
link_configurationobject
tagsobjectTags to apply to the link
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +label, +label_template, +resource_types, +sink_identifier, +link_configuration, +tags +FROM aws.oam.link +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the link resource, the following permissions are required: + +### Read +```json +oam:GetLink +``` + +### Update +```json +oam:GetLink, +oam:UpdateLink, +cloudwatch:Link, +logs:Link, +xray:Link, +applicationinsights:Link, +internetmonitor:Link, +oam:TagResource, +oam:UntagResource +``` + +### Delete +```json +oam:DeleteLink, +oam:GetLink +``` + diff --git a/docs/aws-docs/providers/aws/oam/links/index.md b/docs/aws-docs/providers/aws/oam/links/index.md new file mode 100644 index 0000000000..06ea229b14 --- /dev/null +++ b/docs/aws-docs/providers/aws/oam/links/index.md @@ -0,0 +1,83 @@ +--- +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
DescriptionDefinition of AWS::Oam::Link Resource Type
Idaws.oam.links
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.oam.links +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the links resource, the following permissions are required: + +### Create +```json +oam:CreateLink, +oam:GetLink, +cloudwatch:Link, +logs:Link, +xray:Link, +applicationinsights:Link, +internetmonitor:Link +``` + +### List +```json +oam:ListLinks +``` + diff --git a/docs/aws-docs/providers/aws/oam/sink/index.md b/docs/aws-docs/providers/aws/oam/sink/index.md new file mode 100644 index 0000000000..f6161e4ae1 --- /dev/null +++ b/docs/aws-docs/providers/aws/oam/sink/index.md @@ -0,0 +1,100 @@ +--- +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
DescriptionResource Type definition for AWS::Oam::Sink
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +name, +policy, +tags +FROM aws.oam.sink +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the sink resource, the following permissions are required: + +### Delete +```json +oam:DeleteSink, +oam:GetSinkPolicy, +oam:GetSink +``` + +### Read +```json +oam:GetSinkPolicy, +oam:GetSink +``` + +### Update +```json +oam:PutSinkPolicy, +oam:GetSinkPolicy, +oam:GetSink, +oam:TagResource, +oam:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/oam/sinks/index.md b/docs/aws-docs/providers/aws/oam/sinks/index.md new file mode 100644 index 0000000000..091329c77b --- /dev/null +++ b/docs/aws-docs/providers/aws/oam/sinks/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionResource Type definition for AWS::Oam::Sink
Idaws.oam.sinks
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe Amazon resource name (ARN) of the ObservabilityAccessManager Sink
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.oam.sinks +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the sinks resource, the following permissions are required: + +### Create +```json +oam:CreateSink, +oam:PutSinkPolicy, +oam:GetSinkPolicy, +oam:GetSink +``` + +### List +```json +oam:ListSinks +``` + diff --git a/docs/aws-docs/providers/aws/omics/annotation_store/index.md b/docs/aws-docs/providers/aws/omics/annotation_store/index.md new file mode 100644 index 0000000000..17ab5f504a --- /dev/null +++ b/docs/aws-docs/providers/aws/omics/annotation_store/index.md @@ -0,0 +1,118 @@ +--- +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
DescriptionDefinition of AWS::Omics::AnnotationStore Resource Type
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.omics.annotation_store +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the annotation_store resource, the following permissions are required: + +### Read +```json +omics:GetAnnotationStore +``` + +### Update +```json +omics:UpdateAnnotationStore, +omics:TagResource, +omics:UntagResource, +omics:GetAnnotationStore, +omics:ListTagsForResource +``` + +### Delete +```json +omics:DeleteAnnotationStore, +omics:ListAnnotationStores +``` + diff --git a/docs/aws-docs/providers/aws/omics/annotation_stores/index.md b/docs/aws-docs/providers/aws/omics/annotation_stores/index.md new file mode 100644 index 0000000000..814a1afa69 --- /dev/null +++ b/docs/aws-docs/providers/aws/omics/annotation_stores/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionDefinition of AWS::Omics::AnnotationStore Resource Type
Idaws.omics.annotation_stores
+ +## Fields + + + + + +
NameDatatypeDescription
namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.omics.annotation_stores +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the annotation_stores resource, the following permissions are required: + +### Create +```json +omics:CreateAnnotationStore, +omics:TagResource, +kms:DescribeKey, +kms:GenerateDataKey, +kms:CreateGrant, +ram:AcceptResourceShareInvitation, +ram:GetResourceShareInvitations, +omics:GetAnnotationStore +``` + +### List +```json +omics:ListAnnotationStores +``` + diff --git a/docs/aws-docs/providers/aws/omics/index.md b/docs/aws-docs/providers/aws/omics/index.md new file mode 100644 index 0000000000..4fc8cb8be4 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/omics/reference_store/index.md b/docs/aws-docs/providers/aws/omics/reference_store/index.md new file mode 100644 index 0000000000..587cd10212 --- /dev/null +++ b/docs/aws-docs/providers/aws/omics/reference_store/index.md @@ -0,0 +1,90 @@ +--- +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
DescriptionDefinition of AWS::Omics::ReferenceStore Resource Type
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +creation_time, +description, +name, +reference_store_id, +sse_config, +tags +FROM aws.omics.reference_store +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the reference_store resource, the following permissions are required: + +### Read +```json +omics:GetReferenceStore, +omics:ListTagsForResource +``` + +### Delete +```json +omics:DeleteReferenceStore +``` + diff --git a/docs/aws-docs/providers/aws/omics/reference_stores/index.md b/docs/aws-docs/providers/aws/omics/reference_stores/index.md new file mode 100644 index 0000000000..becbdb735a --- /dev/null +++ b/docs/aws-docs/providers/aws/omics/reference_stores/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionDefinition of AWS::Omics::ReferenceStore Resource Type
Idaws.omics.reference_stores
+ +## Fields + + + + + +
NameDatatypeDescription
reference_store_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +reference_store_id +FROM aws.omics.reference_stores +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the reference_stores resource, the following permissions are required: + +### Create +```json +omics:CreateReferenceStore, +omics:TagResource +``` + +### List +```json +omics:ListReferenceStores +``` + diff --git a/docs/aws-docs/providers/aws/omics/run_group/index.md b/docs/aws-docs/providers/aws/omics/run_group/index.md new file mode 100644 index 0000000000..a1729c65be --- /dev/null +++ b/docs/aws-docs/providers/aws/omics/run_group/index.md @@ -0,0 +1,108 @@ +--- +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
DescriptionDefinition of AWS::Omics::RunGroup Resource Type
Idaws.omics.run_group
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
creation_timestring
idstring
max_cpusnumber
max_gpusnumber
max_durationnumber
max_runsnumber
namestring
tagsobject
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +creation_time, +id, +max_cpus, +max_gpus, +max_duration, +max_runs, +name, +tags +FROM aws.omics.run_group +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the run_group resource, the following permissions are required: + +### Read +```json +omics:GetRunGroup +``` + +### Update +```json +omics:UpdateRunGroup, +omics:TagResource, +omics:GetRunGroup, +omics:ListTagsForResource, +omics:UntagResource +``` + +### Delete +```json +omics:DeleteRunGroup, +omics:GetRunGroup +``` + diff --git a/docs/aws-docs/providers/aws/omics/run_groups/index.md b/docs/aws-docs/providers/aws/omics/run_groups/index.md new file mode 100644 index 0000000000..e54e618654 --- /dev/null +++ b/docs/aws-docs/providers/aws/omics/run_groups/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionDefinition of AWS::Omics::RunGroup Resource Type
Idaws.omics.run_groups
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.omics.run_groups +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the run_groups resource, the following permissions are required: + +### Create +```json +omics:CreateRunGroup, +omics:TagResource +``` + +### List +```json +omics:ListRunGroups +``` + diff --git a/docs/aws-docs/providers/aws/omics/sequence_store/index.md b/docs/aws-docs/providers/aws/omics/sequence_store/index.md new file mode 100644 index 0000000000..2dd003b64f --- /dev/null +++ b/docs/aws-docs/providers/aws/omics/sequence_store/index.md @@ -0,0 +1,92 @@ +--- +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
DescriptionDefinition of AWS::Omics::SequenceStore Resource Type
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +creation_time, +description, +name, +fallback_location, +sequence_store_id, +sse_config, +tags +FROM aws.omics.sequence_store +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the sequence_store resource, the following permissions are required: + +### Read +```json +omics:GetSequenceStore, +omics:ListTagsForResource +``` + +### Delete +```json +omics:DeleteSequenceStore +``` + diff --git a/docs/aws-docs/providers/aws/omics/sequence_stores/index.md b/docs/aws-docs/providers/aws/omics/sequence_stores/index.md new file mode 100644 index 0000000000..9afb41eb6a --- /dev/null +++ b/docs/aws-docs/providers/aws/omics/sequence_stores/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionDefinition of AWS::Omics::SequenceStore Resource Type
Idaws.omics.sequence_stores
+ +## Fields + + + + + +
NameDatatypeDescription
sequence_store_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +sequence_store_id +FROM aws.omics.sequence_stores +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the sequence_stores resource, the following permissions are required: + +### Create +```json +omics:CreateSequenceStore, +omics:TagResource +``` + +### List +```json +omics:ListSequenceStores +``` + diff --git a/docs/aws-docs/providers/aws/omics/variant_store/index.md b/docs/aws-docs/providers/aws/omics/variant_store/index.md new file mode 100644 index 0000000000..a132ede60c --- /dev/null +++ b/docs/aws-docs/providers/aws/omics/variant_store/index.md @@ -0,0 +1,114 @@ +--- +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
DescriptionDefinition of AWS::Omics::VariantStore Resource Type
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +creation_time, +description, +id, +name, +reference, +sse_config, +status, +status_message, +store_arn, +store_size_bytes, +tags, +update_time +FROM aws.omics.variant_store +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the variant_store resource, the following permissions are required: + +### Read +```json +omics:GetVariantStore +``` + +### Update +```json +omics:UpdateVariantStore, +omics:TagResource, +omics:UntagResource, +omics:ListTagsForResource, +omics:GetVariantStore +``` + +### Delete +```json +omics:DeleteVariantStore, +omics:ListVariantStores +``` + diff --git a/docs/aws-docs/providers/aws/omics/variant_stores/index.md b/docs/aws-docs/providers/aws/omics/variant_stores/index.md new file mode 100644 index 0000000000..93bdef40ee --- /dev/null +++ b/docs/aws-docs/providers/aws/omics/variant_stores/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionDefinition of AWS::Omics::VariantStore Resource Type
Idaws.omics.variant_stores
+ +## Fields + + + + + +
NameDatatypeDescription
namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.omics.variant_stores +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the variant_stores resource, the following permissions are required: + +### Create +```json +omics:CreateVariantStore, +omics:TagResource, +kms:DescribeKey, +kms:GenerateDataKey, +kms:CreateGrant, +ram:AcceptResourceShareInvitation, +ram:GetResourceShareInvitations, +omics:GetVariantStore +``` + +### List +```json +omics:ListVariantStores +``` + diff --git a/docs/aws-docs/providers/aws/omics/workflow/index.md b/docs/aws-docs/providers/aws/omics/workflow/index.md new file mode 100644 index 0000000000..0a7678a26b --- /dev/null +++ b/docs/aws-docs/providers/aws/omics/workflow/index.md @@ -0,0 +1,118 @@ +--- +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
DescriptionDefinition of AWS::Omics::Workflow Resource Type
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +creation_time, +definition_uri, +description, +engine, +id, +main, +name, +parameter_template, +status, +accelerators, +storage_capacity, +tags, +type +FROM aws.omics.workflow +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the workflow resource, the following permissions are required: + +### Read +```json +omics:GetWorkflow +``` + +### Update +```json +omics:UpdateWorkflow, +omics:GetWorkflow, +omics:TagResource, +omics:ListTagsForResource, +omics:UntagResource +``` + +### Delete +```json +omics:DeleteWorkflow, +omics:GetWorkflow +``` + diff --git a/docs/aws-docs/providers/aws/omics/workflows/index.md b/docs/aws-docs/providers/aws/omics/workflows/index.md new file mode 100644 index 0000000000..0ba6f4b96f --- /dev/null +++ b/docs/aws-docs/providers/aws/omics/workflows/index.md @@ -0,0 +1,89 @@ +--- +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
DescriptionDefinition of AWS::Omics::Workflow Resource Type
Idaws.omics.workflows
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.omics.workflows +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the workflows resource, the following permissions are required: + +### Create +```json +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 +```json +omics:ListWorkflows +``` + diff --git a/docs/aws-docs/providers/aws/opensearchserverless/access_policies/index.md b/docs/aws-docs/providers/aws/opensearchserverless/access_policies/index.md new file mode 100644 index 0000000000..9cd63227b8 --- /dev/null +++ b/docs/aws-docs/providers/aws/opensearchserverless/access_policies/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionAmazon OpenSearchServerless access policy resource
Idaws.opensearchserverless.access_policies
+ +## Fields + + + + + + +
NameDatatypeDescription
typeundefined
namestringThe name of the policy
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +type, +name +FROM aws.opensearchserverless.access_policies +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the access_policies resource, the following permissions are required: + +### Create +```json +aoss:CreateAccessPolicy, +aoss:GetAccessPolicy +``` + +### List +```json +aoss:ListAccessPolicies +``` + diff --git a/docs/aws-docs/providers/aws/opensearchserverless/access_policy/index.md b/docs/aws-docs/providers/aws/opensearchserverless/access_policy/index.md new file mode 100644 index 0000000000..e105ddadc3 --- /dev/null +++ b/docs/aws-docs/providers/aws/opensearchserverless/access_policy/index.md @@ -0,0 +1,95 @@ +--- +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
DescriptionAmazon OpenSearchServerless access policy resource
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +type, +description, +policy +FROM aws.opensearchserverless.access_policy +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the access_policy resource, the following permissions are required: + +### Read +```json +aoss:GetAccessPolicy +``` + +### Update +```json +aoss:UpdateAccessPolicy, +aoss:GetAccessPolicy +``` + +### Delete +```json +aoss:DeleteAccessPolicy, +aoss:GetAccessPolicy +``` + diff --git a/docs/aws-docs/providers/aws/opensearchserverless/collection/index.md b/docs/aws-docs/providers/aws/opensearchserverless/collection/index.md new file mode 100644 index 0000000000..70f6ff08ee --- /dev/null +++ b/docs/aws-docs/providers/aws/opensearchserverless/collection/index.md @@ -0,0 +1,105 @@ +--- +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
DescriptionAmazon OpenSearchServerless collection resource
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +description, +id, +name, +tags, +arn, +collection_endpoint, +dashboard_endpoint, +type, +standby_replicas +FROM aws.opensearchserverless.collection +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the collection resource, the following permissions are required: + +### Delete +```json +aoss:DeleteCollection, +aoss:BatchGetCollection +``` + +### Read +```json +aoss:BatchGetCollection +``` + +### Update +```json +aoss:UpdateCollection, +aoss:BatchGetCollection +``` + diff --git a/docs/aws-docs/providers/aws/opensearchserverless/collections/index.md b/docs/aws-docs/providers/aws/opensearchserverless/collections/index.md new file mode 100644 index 0000000000..f6a708ae23 --- /dev/null +++ b/docs/aws-docs/providers/aws/opensearchserverless/collections/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionAmazon OpenSearchServerless collection resource
Idaws.opensearchserverless.collections
+ +## Fields + + + + + +
NameDatatypeDescription
idstringThe identifier of the collection
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.opensearchserverless.collections +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the collections resource, the following permissions are required: + +### Create +```json +aoss:CreateCollection, +aoss:BatchGetCollection, +iam:CreateServiceLinkedRole +``` + +### List +```json +aoss:ListCollections +``` + diff --git a/docs/aws-docs/providers/aws/opensearchserverless/index.md b/docs/aws-docs/providers/aws/opensearchserverless/index.md new file mode 100644 index 0000000000..4c0a16bccb --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/opensearchserverless/lifecycle_policies/index.md b/docs/aws-docs/providers/aws/opensearchserverless/lifecycle_policies/index.md new file mode 100644 index 0000000000..76ee2214c3 --- /dev/null +++ b/docs/aws-docs/providers/aws/opensearchserverless/lifecycle_policies/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionAmazon OpenSearchServerless lifecycle policy resource
Idaws.opensearchserverless.lifecycle_policies
+ +## Fields + + + + + + +
NameDatatypeDescription
typeundefined
namestringThe name of the policy
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +type, +name +FROM aws.opensearchserverless.lifecycle_policies +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the lifecycle_policies resource, the following permissions are required: + +### Create +```json +aoss:CreateLifecyclePolicy +``` + +### List +```json +aoss:ListLifecyclePolicies +``` + diff --git a/docs/aws-docs/providers/aws/opensearchserverless/lifecycle_policy/index.md b/docs/aws-docs/providers/aws/opensearchserverless/lifecycle_policy/index.md new file mode 100644 index 0000000000..49837a485c --- /dev/null +++ b/docs/aws-docs/providers/aws/opensearchserverless/lifecycle_policy/index.md @@ -0,0 +1,94 @@ +--- +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
DescriptionAmazon OpenSearchServerless lifecycle policy resource
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +type, +description, +policy +FROM aws.opensearchserverless.lifecycle_policy +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the lifecycle_policy resource, the following permissions are required: + +### Read +```json +aoss:BatchGetLifecyclePolicy +``` + +### Update +```json +aoss:UpdateLifecyclePolicy, +aoss:BatchGetLifecyclePolicy +``` + +### Delete +```json +aoss:DeleteLifecyclePolicy +``` + diff --git a/docs/aws-docs/providers/aws/opensearchserverless/security_config/index.md b/docs/aws-docs/providers/aws/opensearchserverless/security_config/index.md new file mode 100644 index 0000000000..7c2cf788e8 --- /dev/null +++ b/docs/aws-docs/providers/aws/opensearchserverless/security_config/index.md @@ -0,0 +1,96 @@ +--- +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
DescriptionAmazon OpenSearchServerless security config resource
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +description, +id, +name, +saml_options, +type +FROM aws.opensearchserverless.security_config +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the security_config resource, the following permissions are required: + +### Read +```json +aoss:GetSecurityConfig +``` + +### Update +```json +aoss:GetSecurityConfig, +aoss:UpdateSecurityConfig +``` + +### Delete +```json +aoss:DeleteSecurityConfig +``` + diff --git a/docs/aws-docs/providers/aws/opensearchserverless/security_configs/index.md b/docs/aws-docs/providers/aws/opensearchserverless/security_configs/index.md new file mode 100644 index 0000000000..2f1b4c78be --- /dev/null +++ b/docs/aws-docs/providers/aws/opensearchserverless/security_configs/index.md @@ -0,0 +1,77 @@ +--- +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
DescriptionAmazon OpenSearchServerless security config resource
Idaws.opensearchserverless.security_configs
+ +## Fields + + + + + +
NameDatatypeDescription
idstringThe identifier of the security config
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.opensearchserverless.security_configs +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the security_configs resource, the following permissions are required: + +### Create +```json +aoss:CreateSecurityConfig +``` + +### List +```json +aoss:ListSecurityConfigs +``` + diff --git a/docs/aws-docs/providers/aws/opensearchserverless/security_policies/index.md b/docs/aws-docs/providers/aws/opensearchserverless/security_policies/index.md new file mode 100644 index 0000000000..78763c20f0 --- /dev/null +++ b/docs/aws-docs/providers/aws/opensearchserverless/security_policies/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionAmazon OpenSearchServerless security policy resource
Idaws.opensearchserverless.security_policies
+ +## Fields + + + + + + +
NameDatatypeDescription
typeundefined
namestringThe name of the policy
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +type, +name +FROM aws.opensearchserverless.security_policies +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the security_policies resource, the following permissions are required: + +### Create +```json +aoss:GetSecurityPolicy, +aoss:CreateSecurityPolicy, +kms:DescribeKey, +kms:CreateGrant +``` + +### List +```json +aoss:ListSecurityPolicies +``` + diff --git a/docs/aws-docs/providers/aws/opensearchserverless/security_policy/index.md b/docs/aws-docs/providers/aws/opensearchserverless/security_policy/index.md new file mode 100644 index 0000000000..13cf2bd9d8 --- /dev/null +++ b/docs/aws-docs/providers/aws/opensearchserverless/security_policy/index.md @@ -0,0 +1,98 @@ +--- +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
DescriptionAmazon OpenSearchServerless security policy resource
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +description, +policy, +name, +type +FROM aws.opensearchserverless.security_policy +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the security_policy resource, the following permissions are required: + +### Update +```json +aoss:GetSecurityPolicy, +aoss:UpdateSecurityPolicy, +kms:DescribeKey, +kms:CreateGrant +``` + +### Delete +```json +aoss:GetSecurityPolicy, +aoss:DeleteSecurityPolicy +``` + +### Read +```json +aoss:GetSecurityPolicy, +kms:DescribeKey +``` + diff --git a/docs/aws-docs/providers/aws/opensearchserverless/vpc_endpoint/index.md b/docs/aws-docs/providers/aws/opensearchserverless/vpc_endpoint/index.md new file mode 100644 index 0000000000..c811dd4555 --- /dev/null +++ b/docs/aws-docs/providers/aws/opensearchserverless/vpc_endpoint/index.md @@ -0,0 +1,129 @@ +--- +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
DescriptionAmazon OpenSearchServerless vpc endpoint resource
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +name, +security_group_ids, +subnet_ids, +vpc_id +FROM aws.opensearchserverless.vpc_endpoint +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the vpc_endpoint resource, the following permissions are required: + +### Read +```json +aoss:BatchGetVpcEndpoint, +ec2:DescribeVpcEndpoints +``` + +### Update +```json +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 +```json +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 +``` + diff --git a/docs/aws-docs/providers/aws/opensearchserverless/vpc_endpoints/index.md b/docs/aws-docs/providers/aws/opensearchserverless/vpc_endpoints/index.md new file mode 100644 index 0000000000..11ca544318 --- /dev/null +++ b/docs/aws-docs/providers/aws/opensearchserverless/vpc_endpoints/index.md @@ -0,0 +1,95 @@ +--- +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
DescriptionAmazon OpenSearchServerless vpc endpoint resource
Idaws.opensearchserverless.vpc_endpoints
+ +## Fields + + + + + +
NameDatatypeDescription
idstringThe identifier of the VPC Endpoint
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.opensearchserverless.vpc_endpoints +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the vpc_endpoints resource, the following permissions are required: + +### Create +```json +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 +```json +aoss:ListVpcEndpoints, +ec2:DescribeVpcEndpoints +``` + diff --git a/docs/aws-docs/providers/aws/opensearchservice/domain/index.md b/docs/aws-docs/providers/aws/opensearchservice/domain/index.md new file mode 100644 index 0000000000..52b7663d88 --- /dev/null +++ b/docs/aws-docs/providers/aws/opensearchservice/domain/index.md @@ -0,0 +1,143 @@ +--- +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
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Idaws.opensearchservice.domain
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
cluster_configobject
domain_namestring
access_policiesobject
ip_address_typestring
engine_versionstring
advanced_optionsobject
log_publishing_optionsobject
snapshot_optionsobject
vpc_optionsobject
node_to_node_encryption_optionsobject
domain_endpoint_optionsobject
cognito_optionsobject
advanced_security_optionsobject
domain_endpointstring
domain_endpoint_v2string
domain_endpointsobject
ebs_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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +cluster_config, +domain_name, +access_policies, +ip_address_type, +engine_version, +advanced_options, +log_publishing_options, +snapshot_options, +vpc_options, +node_to_node_encryption_options, +domain_endpoint_options, +cognito_options, +advanced_security_options, +domain_endpoint, +domain_endpoint_v2, +domain_endpoints, +ebs_options, +id, +arn, +domain_arn, +encryption_at_rest_options, +tags, +service_software_options, +off_peak_window_options, +software_update_options +FROM aws.opensearchservice.domain +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the domain resource, the following permissions are required: + +### Read +```json +es:DescribeDomain, +es:ListTags +``` + +### Update +```json +es:UpdateDomain, +es:UpgradeDomain, +es:DescribeDomain, +es:AddTags, +es:RemoveTags, +es:ListTags, +es:DescribeDomainChangeProgress +``` + +### Delete +```json +es:DeleteDomain, +es:DescribeDomain +``` + diff --git a/docs/aws-docs/providers/aws/opensearchservice/domains/index.md b/docs/aws-docs/providers/aws/opensearchservice/domains/index.md new file mode 100644 index 0000000000..de106698db --- /dev/null +++ b/docs/aws-docs/providers/aws/opensearchservice/domains/index.md @@ -0,0 +1,70 @@ +--- +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
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Idaws.opensearchservice.domains
+ +## Fields + + + + + +
NameDatatypeDescription
domain_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +domain_name +FROM aws.opensearchservice.domains +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the domains resource, the following permissions are required: + +### Create +```json +es:CreateDomain, +es:DescribeDomain, +es:AddTags, +es:ListTags +``` + diff --git a/docs/aws-docs/providers/aws/opensearchservice/index.md b/docs/aws-docs/providers/aws/opensearchservice/index.md new file mode 100644 index 0000000000..d2b61d9006 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/opsworkscm/index.md b/docs/aws-docs/providers/aws/opsworkscm/index.md new file mode 100644 index 0000000000..6c2c702dde --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/opsworkscm/server/index.md b/docs/aws-docs/providers/aws/opsworkscm/server/index.md new file mode 100644 index 0000000000..e6f082dac6 --- /dev/null +++ b/docs/aws-docs/providers/aws/opsworkscm/server/index.md @@ -0,0 +1,135 @@ +--- +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
DescriptionResource Type definition for AWS::OpsWorksCM::Server
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.opsworkscm.server +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the server resource, the following permissions are required: + +### Delete +```json +opsworks-cm:DeleteServer, +opsworks-cm:DescribeServers +``` + +### Update +```json +opsworks-cm:UpdateServer, +opsworks-cm:TagResource, +opsworks-cm:UntagResource, +opsworks-cm:DescribeServers +``` + +### Read +```json +opsworks-cm:DescribeServers +``` + diff --git a/docs/aws-docs/providers/aws/opsworkscm/servers/index.md b/docs/aws-docs/providers/aws/opsworkscm/servers/index.md new file mode 100644 index 0000000000..26eeb44a68 --- /dev/null +++ b/docs/aws-docs/providers/aws/opsworkscm/servers/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionResource Type definition for AWS::OpsWorksCM::Server
Idaws.opsworkscm.servers
+ +## Fields + + + + + +
NameDatatypeDescription
server_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +server_name +FROM aws.opsworkscm.servers +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the servers resource, the following permissions are required: + +### Create +```json +opsworks-cm:CreateServer, +opsworks-cm:DescribeServers, +iam:PassRole +``` + +### List +```json +opsworks-cm:DescribeServers, +opsworks-cm:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/organizations/account/index.md b/docs/aws-docs/providers/aws/organizations/account/index.md new file mode 100644 index 0000000000..2f2061663e --- /dev/null +++ b/docs/aws-docs/providers/aws/organizations/account/index.md @@ -0,0 +1,113 @@ +--- +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
DescriptionYou can use AWS::Organizations::Account to manage accounts in organization.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +account_name, +email, +role_name, +parent_ids, +tags, +account_id, +arn, +joined_method, +joined_timestamp, +status +FROM aws.organizations.account +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the account resource, the following permissions are required: + +### Read +```json +organizations:DescribeAccount, +organizations:ListParents, +organizations:ListTagsForResource +``` + +### Update +```json +organizations:MoveAccount, +organizations:TagResource, +organizations:UntagResource, +organizations:ListRoots, +organizations:DescribeAccount, +organizations:ListParents, +organizations:ListTagsForResource +``` + +### Delete +```json +organizations:CloseAccount +``` + diff --git a/docs/aws-docs/providers/aws/organizations/accounts/index.md b/docs/aws-docs/providers/aws/organizations/accounts/index.md new file mode 100644 index 0000000000..c79c509506 --- /dev/null +++ b/docs/aws-docs/providers/aws/organizations/accounts/index.md @@ -0,0 +1,83 @@ +--- +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
DescriptionYou can use AWS::Organizations::Account to manage accounts in organization.
Idaws.organizations.accounts
+ +## Fields + + + + + +
NameDatatypeDescription
account_idstringIf the account was created successfully, the unique identifier (ID) of the new account.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +account_id +FROM aws.organizations.accounts +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the accounts resource, the following permissions are required: + +### Create +```json +organizations:CreateAccount, +organizations:DescribeCreateAccountStatus, +organizations:MoveAccount, +organizations:ListParents, +organizations:TagResource, +organizations:DescribeAccount, +organizations:ListTagsForResource +``` + +### List +```json +organizations:ListAccounts +``` + diff --git a/docs/aws-docs/providers/aws/organizations/index.md b/docs/aws-docs/providers/aws/organizations/index.md new file mode 100644 index 0000000000..b4c83cf7c8 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/organizations/organization/index.md b/docs/aws-docs/providers/aws/organizations/organization/index.md new file mode 100644 index 0000000000..af63739da0 --- /dev/null +++ b/docs/aws-docs/providers/aws/organizations/organization/index.md @@ -0,0 +1,96 @@ +--- +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
DescriptionResource schema for AWS::Organizations::Organization
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +arn, +feature_set, +management_account_arn, +management_account_id, +management_account_email, +root_id +FROM aws.organizations.organization +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the organization resource, the following permissions are required: + +### Read +```json +organizations:DescribeOrganization, +organizations:ListRoots +``` + +### Delete +```json +organizations:DeleteOrganization, +organizations:DescribeOrganization +``` + diff --git a/docs/aws-docs/providers/aws/organizations/organizational_unit/index.md b/docs/aws-docs/providers/aws/organizations/organizational_unit/index.md new file mode 100644 index 0000000000..321c83b7d9 --- /dev/null +++ b/docs/aws-docs/providers/aws/organizations/organizational_unit/index.md @@ -0,0 +1,102 @@ +--- +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
DescriptionYou can use organizational units (OUs) to group accounts together to administer as a single unit. This greatly simplifies the management of your accounts. For example, you can attach a policy-based control to an OU, and all accounts within the OU automatically inherit the policy. You can create multiple OUs within a single organization, and you can create OUs within other OUs. Each OU can contain multiple accounts, and you can move accounts from one OU to another. However, OU names must be unique within a parent OU or root.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +id, +name, +parent_id, +tags +FROM aws.organizations.organizational_unit +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the organizational_unit resource, the following permissions are required: + +### Read +```json +organizations:DescribeOrganizationalUnit, +organizations:ListParents, +organizations:ListTagsForResource +``` + +### Update +```json +organizations:DescribeOrganizationalUnit, +organizations:ListParents, +organizations:ListTagsForResource, +organizations:TagResource, +organizations:UntagResource, +organizations:UpdateOrganizationalUnit +``` + +### Delete +```json +organizations:DeleteOrganizationalUnit +``` + diff --git a/docs/aws-docs/providers/aws/organizations/organizational_units/index.md b/docs/aws-docs/providers/aws/organizations/organizational_units/index.md new file mode 100644 index 0000000000..f073f5a439 --- /dev/null +++ b/docs/aws-docs/providers/aws/organizations/organizational_units/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionYou can use organizational units (OUs) to group accounts together to administer as a single unit. This greatly simplifies the management of your accounts. For example, you can attach a policy-based control to an OU, and all accounts within the OU automatically inherit the policy. You can create multiple OUs within a single organization, and you can create OUs within other OUs. Each OU can contain multiple accounts, and you can move accounts from one OU to another. However, OU names must be unique within a parent OU or root.
Idaws.organizations.organizational_units
+ +## Fields + + + + + +
NameDatatypeDescription
idstringThe unique identifier (ID) associated with this OU.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.organizations.organizational_units +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the organizational_units resource, the following permissions are required: + +### Create +```json +organizations:CreateOrganizationalUnit, +organizations:DescribeOrganizationalUnit, +organizations:ListParents, +organizations:ListTagsForResource, +organizations:TagResource +``` + +### List +```json +organizations:ListOrganizationalUnitsForParent +``` + diff --git a/docs/aws-docs/providers/aws/organizations/organizations/index.md b/docs/aws-docs/providers/aws/organizations/organizations/index.md new file mode 100644 index 0000000000..31adb94959 --- /dev/null +++ b/docs/aws-docs/providers/aws/organizations/organizations/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionResource schema for AWS::Organizations::Organization
Idaws.organizations.organizations
+ +## Fields + + + + + +
NameDatatypeDescription
idstringThe unique identifier (ID) of an organization.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.organizations.organizations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the organizations resource, the following permissions are required: + +### Create +```json +organizations:CreateOrganization, +organizations:DescribeOrganization, +iam:CreateServiceLinkedRole, +organizations:ListRoots +``` + +### List +```json +organizations:DescribeOrganization +``` + diff --git a/docs/aws-docs/providers/aws/organizations/policies/index.md b/docs/aws-docs/providers/aws/organizations/policies/index.md new file mode 100644 index 0000000000..106ab727e0 --- /dev/null +++ b/docs/aws-docs/providers/aws/organizations/policies/index.md @@ -0,0 +1,82 @@ +--- +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 in AWS Organizations enable you to manage different features of the AWS accounts in your organization. You can use policies when all features are enabled in your organization.
Idaws.organizations.policies
+ +## Fields + + + + + +
NameDatatypeDescription
idstringId of the Policy
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.organizations.policies +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the policies resource, the following permissions are required: + +### Create +```json +organizations:CreatePolicy, +organizations:DescribePolicy, +organizations:AttachPolicy, +organizations:ListTagsForResource, +organizations:ListTargetsForPolicy, +organizations:TagResource +``` + +### List +```json +organizations:ListPolicies +``` + diff --git a/docs/aws-docs/providers/aws/organizations/policy/index.md b/docs/aws-docs/providers/aws/organizations/policy/index.md new file mode 100644 index 0000000000..c1912c1dd3 --- /dev/null +++ b/docs/aws-docs/providers/aws/organizations/policy/index.md @@ -0,0 +1,113 @@ +--- +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
DescriptionPolicies in AWS Organizations enable you to manage different features of the AWS accounts in your organization. You can use policies when all features are enabled in your organization.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +type, +content, +description, +target_ids, +tags, +id, +arn, +aws_managed +FROM aws.organizations.policy +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the policy resource, the following permissions are required: + +### Read +```json +organizations:DescribePolicy, +organizations:ListTargetsForPolicy, +organizations:ListTagsForResource +``` + +### Update +```json +organizations:AttachPolicy, +organizations:DetachPolicy, +organizations:UpdatePolicy, +organizations:ListTagsForResource, +organizations:ListTargetsForPolicy, +organizations:TagResource, +organizations:UntagResource, +organizations:DescribePolicy +``` + +### Delete +```json +organizations:DetachPolicy, +organizations:DeletePolicy +``` + diff --git a/docs/aws-docs/providers/aws/organizations/resource_policies/index.md b/docs/aws-docs/providers/aws/organizations/resource_policies/index.md new file mode 100644 index 0000000000..5689014d08 --- /dev/null +++ b/docs/aws-docs/providers/aws/organizations/resource_policies/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionYou can use AWS::Organizations::ResourcePolicy to delegate policy management for AWS Organizations to specified member accounts to perform policy actions that are by default available only to the management account.
Idaws.organizations.resource_policies
+ +## Fields + + + + + +
NameDatatypeDescription
idstringThe unique identifier (ID) associated with this resource policy.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.organizations.resource_policies +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the resource_policies resource, the following permissions are required: + +### Create +```json +organizations:PutResourcePolicy, +organizations:DescribeResourcePolicy, +organizations:ListTagsForResource, +organizations:TagResource +``` + +### List +```json +organizations:DescribeResourcePolicy +``` + diff --git a/docs/aws-docs/providers/aws/organizations/resource_policy/index.md b/docs/aws-docs/providers/aws/organizations/resource_policy/index.md new file mode 100644 index 0000000000..7c8233c3bb --- /dev/null +++ b/docs/aws-docs/providers/aws/organizations/resource_policy/index.md @@ -0,0 +1,98 @@ +--- +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
DescriptionYou can use AWS::Organizations::ResourcePolicy to delegate policy management for AWS Organizations to specified member accounts to perform policy actions that are by default available only to the management account.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +arn, +content, +tags +FROM aws.organizations.resource_policy +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the resource_policy resource, the following permissions are required: + +### Read +```json +organizations:DescribeResourcePolicy, +organizations:ListTagsForResource +``` + +### Update +```json +organizations:DescribeResourcePolicy, +organizations:PutResourcePolicy, +organizations:ListTagsForResource, +organizations:TagResource, +organizations:UntagResource +``` + +### Delete +```json +organizations:DeleteResourcePolicy +``` + diff --git a/docs/aws-docs/providers/aws/osis/index.md b/docs/aws-docs/providers/aws/osis/index.md new file mode 100644 index 0000000000..14caf5ca30 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/osis/pipeline/index.md b/docs/aws-docs/providers/aws/osis/pipeline/index.md new file mode 100644 index 0000000000..cc5dc83e58 --- /dev/null +++ b/docs/aws-docs/providers/aws/osis/pipeline/index.md @@ -0,0 +1,123 @@ +--- +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
DescriptionAn OpenSearch Ingestion Service Data Prepper pipeline running Data Prepper.
Idaws.osis.pipeline
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
buffer_optionsobject
encryption_at_rest_optionsobject
log_publishing_optionsobject
max_unitsintegerThe maximum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).
min_unitsintegerThe minimum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).
pipeline_configuration_bodystringThe Data Prepper pipeline configuration.
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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.osis.pipeline +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the pipeline resource, the following permissions are required: + +### Read +```json +osis:GetPipeline, +osis:ListTagsForResource +``` + +### Update +```json +osis:UpdatePipeline, +osis:GetPipeline, +osis:ListTagsForResource, +osis:TagResource, +osis:UntagResource, +iam:PassRole, +logs:GetLogDelivery, +logs:UpdateLogDelivery, +logs:ListLogDeliveries, +kms:DescribeKey +``` + +### Delete +```json +osis:DeletePipeline, +osis:GetPipeline, +logs:GetLogDelivery, +logs:DeleteLogDelivery, +logs:ListLogDeliveries +``` + diff --git a/docs/aws-docs/providers/aws/osis/pipelines/index.md b/docs/aws-docs/providers/aws/osis/pipelines/index.md new file mode 100644 index 0000000000..6b9c496faa --- /dev/null +++ b/docs/aws-docs/providers/aws/osis/pipelines/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionAn OpenSearch Ingestion Service Data Prepper pipeline running Data Prepper.
Idaws.osis.pipelines
+ +## Fields + + + + + +
NameDatatypeDescription
pipeline_arnstringThe Amazon Resource Name (ARN) of the pipeline.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +pipeline_arn +FROM aws.osis.pipelines +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the pipelines resource, the following permissions are required: + +### Create +```json +osis:CreatePipeline, +osis:GetPipeline, +osis:TagResource, +osis:ListTagsForResource, +iam:PassRole, +iam:CreateServiceLinkedRole, +logs:CreateLogDelivery, +kms:DescribeKey +``` + +### List +```json +osis:ListPipelines +``` + diff --git a/docs/aws-docs/providers/aws/panorama/application_instance/index.md b/docs/aws-docs/providers/aws/panorama/application_instance/index.md new file mode 100644 index 0000000000..005b9643cf --- /dev/null +++ b/docs/aws-docs/providers/aws/panorama/application_instance/index.md @@ -0,0 +1,137 @@ +--- +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
DescriptionSchema for ApplicationInstance CloudFormation Resource
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.panorama.application_instance +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the application_instance resource, the following permissions are required: + +### Read +```json +panorama:DescribeApplicationInstance, +panorama:DescribeApplicationInstanceDetails, +panorama:ListTagsForResource, +s3:ListObjects, +s3:GetObject, +s3:GetObjectVersion +``` + +### Update +```json +panorama:ListTagsForResource, +panorama:TagResource, +panorama:UntagResource, +panorama:DescribeApplicationInstance, +panorama:DescribeApplicationInstanceDetails, +s3:ListObjects, +s3:GetObject, +s3:GetObjectVersion +``` + +### Delete +```json +panorama:RemoveApplicationInstance, +panorama:DescribeApplicationInstance, +panorama:DescribeApplicationInstanceDetails, +s3:DeleteObject, +s3:DeleteObjectVersion, +s3:DeleteObjectVersionTagging, +s3:ListObjects, +s3:GetObject, +s3:GetObjectVersion +``` + diff --git a/docs/aws-docs/providers/aws/panorama/application_instances/index.md b/docs/aws-docs/providers/aws/panorama/application_instances/index.md new file mode 100644 index 0000000000..b3bcccce59 --- /dev/null +++ b/docs/aws-docs/providers/aws/panorama/application_instances/index.md @@ -0,0 +1,89 @@ +--- +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
DescriptionSchema for ApplicationInstance CloudFormation Resource
Idaws.panorama.application_instances
+ +## Fields + + + + + +
NameDatatypeDescription
application_instance_idundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +application_instance_id +FROM aws.panorama.application_instances +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the application_instances resource, the following permissions are required: + +### Create +```json +panorama:CreateApplicationInstance, +panorama:ListTagsForResource, +panorama:TagResource, +panorama:DescribeApplicationInstance, +panorama:DescribeApplicationInstanceDetails, +iam:PassRole, +s3:ListBucket, +s3:PutObject, +s3:GetObject, +s3:GetObjectVersion +``` + +### List +```json +panorama:ListApplicationInstances, +s3:ListBucket, +s3:GetObject, +s3:GetObjectVersion +``` + diff --git a/docs/aws-docs/providers/aws/panorama/index.md b/docs/aws-docs/providers/aws/panorama/index.md new file mode 100644 index 0000000000..1cf430de92 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/panorama/package/index.md b/docs/aws-docs/providers/aws/panorama/package/index.md new file mode 100644 index 0000000000..516abae7c2 --- /dev/null +++ b/docs/aws-docs/providers/aws/panorama/package/index.md @@ -0,0 +1,117 @@ +--- +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
DescriptionSchema for Package CloudFormation Resource
Idaws.panorama.package
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
package_namestring
package_idstring
arnstring
storage_locationobject
created_timeinteger
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +package_name, +package_id, +arn, +storage_location, +created_time, +tags +FROM aws.panorama.package +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the package resource, the following permissions are required: + +### Read +```json +panorama:DescribePackage, +panorama:ListTagsForResource, +s3:ListBucket, +s3:GetObject, +s3:GetObjectVersion +``` + +### Update +```json +panorama:DescribePackage, +panorama:ListTagsForResource, +panorama:TagResource, +panorama:UntagResource, +s3:PutObject, +s3:ListBucket, +s3:GetObject, +s3:GetObjectVersion +``` + +### Delete +```json +panorama:DeletePackage, +panorama:DescribePackage, +s3:DeleteObject, +s3:DeleteObjectVersion, +s3:DeleteObjectVersionTagging, +s3:ListObjects, +s3:ListObjectsV2, +s3:ListBucket, +s3:GetObject, +s3:GetObjectVersion +``` + diff --git a/docs/aws-docs/providers/aws/panorama/package_version/index.md b/docs/aws-docs/providers/aws/panorama/package_version/index.md new file mode 100644 index 0000000000..2a9652875f --- /dev/null +++ b/docs/aws-docs/providers/aws/panorama/package_version/index.md @@ -0,0 +1,124 @@ +--- +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
DescriptionSchema for PackageVersion Resource Type
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.panorama.package_version +WHERE data__Identifier = '||'; +``` + +## Permissions + +To operate on the package_version resource, the following permissions are required: + +### Read +```json +panorama:DescribePackageVersion, +s3:ListBucket, +s3:GetObject, +s3:GetObjectVersion +``` + +### Update +```json +panorama:DescribePackageVersion, +panorama:RegisterPackageVersion, +s3:ListBucket, +s3:PutObject, +s3:GetObject, +s3:GetObjectVersion +``` + +### Delete +```json +panorama:DeregisterPackageVersion, +panorama:DescribePackageVersion, +s3:DeleteObject, +s3:DeleteObjectVersion, +s3:DeleteObjectVersionTagging, +s3:ListBucket, +s3:GetObject, +s3:GetObjectVersion +``` + diff --git a/docs/aws-docs/providers/aws/panorama/package_versions/index.md b/docs/aws-docs/providers/aws/panorama/package_versions/index.md new file mode 100644 index 0000000000..447437878f --- /dev/null +++ b/docs/aws-docs/providers/aws/panorama/package_versions/index.md @@ -0,0 +1,76 @@ +--- +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
DescriptionSchema for PackageVersion Resource Type
Idaws.panorama.package_versions
+ +## Fields + + + + + + + +
NameDatatypeDescription
package_idundefined
package_versionundefined
patch_versionundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +package_id, +package_version, +patch_version +FROM aws.panorama.package_versions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the package_versions resource, the following permissions are required: + +### Create +```json +panorama:RegisterPackageVersion, +panorama:DescribePackageVersion, +s3:ListBucket, +s3:PutObject, +s3:GetObject, +s3:GetObjectVersion +``` + diff --git a/docs/aws-docs/providers/aws/panorama/packages/index.md b/docs/aws-docs/providers/aws/panorama/packages/index.md new file mode 100644 index 0000000000..73d852e7ab --- /dev/null +++ b/docs/aws-docs/providers/aws/panorama/packages/index.md @@ -0,0 +1,87 @@ +--- +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
DescriptionSchema for Package CloudFormation Resource
Idaws.panorama.packages
+ +## Fields + + + + + +
NameDatatypeDescription
package_idundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +package_id +FROM aws.panorama.packages +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the packages resource, the following permissions are required: + +### Create +```json +panorama:CreatePackage, +panorama:ListTagsForResource, +panorama:TagResource, +panorama:DescribePackage, +s3:ListBucket, +s3:PutObject, +s3:GetObject, +s3:GetObjectVersion +``` + +### List +```json +panorama:ListPackages, +s3:ListBucket, +s3:GetObject, +s3:GetObjectVersion +``` + diff --git a/docs/aws-docs/providers/aws/pcaconnectorad/connector/index.md b/docs/aws-docs/providers/aws/pcaconnectorad/connector/index.md new file mode 100644 index 0000000000..2d560d33ab --- /dev/null +++ b/docs/aws-docs/providers/aws/pcaconnectorad/connector/index.md @@ -0,0 +1,101 @@ +--- +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
DescriptionDefinition of AWS::PCAConnectorAD::Connector Resource Type
Idaws.pcaconnectorad.connector
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
certificate_authority_arnstring
connector_arnstring
directory_idstring
tagsobject
vpc_informationobject
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +certificate_authority_arn, +connector_arn, +directory_id, +tags, +vpc_information +FROM aws.pcaconnectorad.connector +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the connector resource, the following permissions are required: + +### Read +```json +pca-connector-ad:ListTagsForResource, +pca-connector-ad:GetConnector +``` + +### Delete +```json +pca-connector-ad:GetConnector, +pca-connector-ad:DeleteConnector, +ec2:DeleteVpcEndpoints, +ec2:DescribeVpcEndpoints +``` + +### Update +```json +pca-connector-ad:ListTagsForResource, +pca-connector-ad:TagResource, +pca-connector-ad:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/pcaconnectorad/connectors/index.md b/docs/aws-docs/providers/aws/pcaconnectorad/connectors/index.md new file mode 100644 index 0000000000..fa324f15cb --- /dev/null +++ b/docs/aws-docs/providers/aws/pcaconnectorad/connectors/index.md @@ -0,0 +1,86 @@ +--- +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
DescriptionDefinition of AWS::PCAConnectorAD::Connector Resource Type
Idaws.pcaconnectorad.connectors
+ +## Fields + + + + + +
NameDatatypeDescription
connector_arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +connector_arn +FROM aws.pcaconnectorad.connectors +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the connectors resource, the following permissions are required: + +### Create +```json +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 +```json +pca-connector-ad:ListConnectors +``` + diff --git a/docs/aws-docs/providers/aws/pcaconnectorad/directory_registration/index.md b/docs/aws-docs/providers/aws/pcaconnectorad/directory_registration/index.md new file mode 100644 index 0000000000..2019e0606d --- /dev/null +++ b/docs/aws-docs/providers/aws/pcaconnectorad/directory_registration/index.md @@ -0,0 +1,98 @@ +--- +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
DescriptionDefinition of AWS::PCAConnectorAD::DirectoryRegistration Resource Type
Idaws.pcaconnectorad.directory_registration
+ +## Fields + + + + + + + +
NameDatatypeDescription
directory_idstring
directory_registration_arnstring
tagsobject
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +directory_id, +directory_registration_arn, +tags +FROM aws.pcaconnectorad.directory_registration +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the directory_registration resource, the following permissions are required: + +### Read +```json +pca-connector-ad:ListTagsForResource, +pca-connector-ad:GetDirectoryRegistration +``` + +### Delete +```json +pca-connector-ad:GetDirectoryRegistration, +pca-connector-ad:DeleteDirectoryRegistration, +ds:DescribeDirectories, +ds:UnauthorizeApplication, +ds:UpdateAuthorizedApplication +``` + +### Update +```json +pca-connector-ad:ListTagsForResource, +pca-connector-ad:TagResource, +pca-connector-ad:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/pcaconnectorad/directory_registrations/index.md b/docs/aws-docs/providers/aws/pcaconnectorad/directory_registrations/index.md new file mode 100644 index 0000000000..84a9db8bb4 --- /dev/null +++ b/docs/aws-docs/providers/aws/pcaconnectorad/directory_registrations/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionDefinition of AWS::PCAConnectorAD::DirectoryRegistration Resource Type
Idaws.pcaconnectorad.directory_registrations
+ +## Fields + + + + + +
NameDatatypeDescription
directory_registration_arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +directory_registration_arn +FROM aws.pcaconnectorad.directory_registrations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the directory_registrations resource, the following permissions are required: + +### Create +```json +pca-connector-ad:GetDirectoryRegistration, +pca-connector-ad:CreateDirectoryRegistration, +ds:AuthorizeApplication, +ds:DescribeDirectories +``` + +### List +```json +pca-connector-ad:ListDirectoryRegistrations +``` + diff --git a/docs/aws-docs/providers/aws/pcaconnectorad/index.md b/docs/aws-docs/providers/aws/pcaconnectorad/index.md new file mode 100644 index 0000000000..b7dfec0844 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/pcaconnectorad/service_principal_name/index.md b/docs/aws-docs/providers/aws/pcaconnectorad/service_principal_name/index.md new file mode 100644 index 0000000000..a18e8b7bc8 --- /dev/null +++ b/docs/aws-docs/providers/aws/pcaconnectorad/service_principal_name/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionDefinition of AWS::PCAConnectorAD::ServicePrincipalName Resource Type
Idaws.pcaconnectorad.service_principal_name
+ +## Fields + + + + + + +
NameDatatypeDescription
connector_arnstring
directory_registration_arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +connector_arn, +directory_registration_arn +FROM aws.pcaconnectorad.service_principal_name +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the service_principal_name resource, the following permissions are required: + +### Read +```json +pca-connector-ad:GetServicePrincipalName +``` + +### Delete +```json +ds:UpdateAuthorizedApplication, +pca-connector-ad:GetServicePrincipalName, +pca-connector-ad:DeleteServicePrincipalName +``` + diff --git a/docs/aws-docs/providers/aws/pcaconnectorad/service_principal_names/index.md b/docs/aws-docs/providers/aws/pcaconnectorad/service_principal_names/index.md new file mode 100644 index 0000000000..c10b34c24c --- /dev/null +++ b/docs/aws-docs/providers/aws/pcaconnectorad/service_principal_names/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionDefinition of AWS::PCAConnectorAD::ServicePrincipalName Resource Type
Idaws.pcaconnectorad.service_principal_names
+ +## Fields + + + + + + +
NameDatatypeDescription
connector_arnstring
directory_registration_arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +connector_arn, +directory_registration_arn +FROM aws.pcaconnectorad.service_principal_names +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the service_principal_names resource, the following permissions are required: + +### Create +```json +ds:UpdateAuthorizedApplication, +pca-connector-ad:GetServicePrincipalName, +pca-connector-ad:CreateServicePrincipalName +``` + +### List +```json +pca-connector-ad:ListServicePrincipalNames +``` + diff --git a/docs/aws-docs/providers/aws/pcaconnectorad/template/index.md b/docs/aws-docs/providers/aws/pcaconnectorad/template/index.md new file mode 100644 index 0000000000..6746b2e4ae --- /dev/null +++ b/docs/aws-docs/providers/aws/pcaconnectorad/template/index.md @@ -0,0 +1,102 @@ +--- +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
DescriptionRepresents a template that defines certificate configurations, both for issuance and client handling
Idaws.pcaconnectorad.template
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
connector_arnstring
definitionundefined
namestring
reenroll_all_certificate_holdersboolean
tagsobject
template_arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +connector_arn, +definition, +name, +reenroll_all_certificate_holders, +tags, +template_arn +FROM aws.pcaconnectorad.template +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the template resource, the following permissions are required: + +### Read +```json +pca-connector-ad:GetTemplate, +pca-connector-ad:ListTagsForResource +``` + +### Update +```json +pca-connector-ad:ListTagsForResource, +pca-connector-ad:TagResource, +pca-connector-ad:UntagResource, +pca-connector-ad:UpdateTemplate +``` + +### Delete +```json +pca-connector-ad:GetTemplate, +pca-connector-ad:DeleteTemplate +``` + diff --git a/docs/aws-docs/providers/aws/pcaconnectorad/template_group_access_control_entries/index.md b/docs/aws-docs/providers/aws/pcaconnectorad/template_group_access_control_entries/index.md new file mode 100644 index 0000000000..08f065c4c3 --- /dev/null +++ b/docs/aws-docs/providers/aws/pcaconnectorad/template_group_access_control_entries/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionDefinition of AWS::PCAConnectorAD::TemplateGroupAccessControlEntry Resource Type
Idaws.pcaconnectorad.template_group_access_control_entries
+ +## Fields + + + + + + +
NameDatatypeDescription
group_security_identifierstring
template_arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +group_security_identifier, +template_arn +FROM aws.pcaconnectorad.template_group_access_control_entries +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the template_group_access_control_entries resource, the following permissions are required: + +### Create +```json +pca-connector-ad:CreateTemplateGroupAccessControlEntry +``` + +### List +```json +pca-connector-ad:ListTemplateGroupAccessControlEntries +``` + diff --git a/docs/aws-docs/providers/aws/pcaconnectorad/template_group_access_control_entry/index.md b/docs/aws-docs/providers/aws/pcaconnectorad/template_group_access_control_entry/index.md new file mode 100644 index 0000000000..da706e271e --- /dev/null +++ b/docs/aws-docs/providers/aws/pcaconnectorad/template_group_access_control_entry/index.md @@ -0,0 +1,94 @@ +--- +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
DescriptionDefinition of AWS::PCAConnectorAD::TemplateGroupAccessControlEntry Resource Type
Idaws.pcaconnectorad.template_group_access_control_entry
+ +## Fields + + + + + + + + +
NameDatatypeDescription
access_rightsobject
group_display_namestring
group_security_identifierstring
template_arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +access_rights, +group_display_name, +group_security_identifier, +template_arn +FROM aws.pcaconnectorad.template_group_access_control_entry +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the template_group_access_control_entry resource, the following permissions are required: + +### Read +```json +pca-connector-ad:GetTemplateGroupAccessControlEntry +``` + +### Update +```json +pca-connector-ad:UpdateTemplateGroupAccessControlEntry +``` + +### Delete +```json +pca-connector-ad:DeleteTemplateGroupAccessControlEntry, +pca-connector-ad:GetTemplateGroupAccessControlEntry +``` + diff --git a/docs/aws-docs/providers/aws/pcaconnectorad/templates/index.md b/docs/aws-docs/providers/aws/pcaconnectorad/templates/index.md new file mode 100644 index 0000000000..d29e03f97e --- /dev/null +++ b/docs/aws-docs/providers/aws/pcaconnectorad/templates/index.md @@ -0,0 +1,77 @@ +--- +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
DescriptionRepresents a template that defines certificate configurations, both for issuance and client handling
Idaws.pcaconnectorad.templates
+ +## Fields + + + + + +
NameDatatypeDescription
template_arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +template_arn +FROM aws.pcaconnectorad.templates +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the templates resource, the following permissions are required: + +### Create +```json +pca-connector-ad:CreateTemplate +``` + +### List +```json +pca-connector-ad:ListTemplates +``` + diff --git a/docs/aws-docs/providers/aws/personalize/dataset/index.md b/docs/aws-docs/providers/aws/personalize/dataset/index.md new file mode 100644 index 0000000000..1c376c18a0 --- /dev/null +++ b/docs/aws-docs/providers/aws/personalize/dataset/index.md @@ -0,0 +1,101 @@ +--- +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
DescriptionResource schema for AWS::Personalize::Dataset.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +dataset_arn, +dataset_type, +dataset_group_arn, +schema_arn, +dataset_import_job +FROM aws.personalize.dataset +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the dataset resource, the following permissions are required: + +### Read +```json +personalize:DescribeDataset +``` + +### Update +```json +personalize:DescribeDataset, +personalize:CreateDatasetImportJob, +personalize:DescribeDatasetImportJob, +iam:PassRole +``` + +### Delete +```json +personalize:DeleteDataset, +personalize:DescribeDataset +``` + diff --git a/docs/aws-docs/providers/aws/personalize/dataset_group/index.md b/docs/aws-docs/providers/aws/personalize/dataset_group/index.md new file mode 100644 index 0000000000..6f237e51eb --- /dev/null +++ b/docs/aws-docs/providers/aws/personalize/dataset_group/index.md @@ -0,0 +1,86 @@ +--- +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
DescriptionResource Schema for AWS::Personalize::DatasetGroup.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +dataset_group_arn, +name, +kms_key_arn, +role_arn, +domain +FROM aws.personalize.dataset_group +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the dataset_group resource, the following permissions are required: + +### Read +```json +personalize:DescribeDatasetGroup +``` + +### Delete +```json +personalize:DescribeDatasetGroup, +personalize:DeleteDatasetGroup +``` + diff --git a/docs/aws-docs/providers/aws/personalize/dataset_groups/index.md b/docs/aws-docs/providers/aws/personalize/dataset_groups/index.md new file mode 100644 index 0000000000..5c89d0e6b7 --- /dev/null +++ b/docs/aws-docs/providers/aws/personalize/dataset_groups/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource Schema for AWS::Personalize::DatasetGroup.
Idaws.personalize.dataset_groups
+ +## Fields + + + + + +
NameDatatypeDescription
dataset_group_arnstringThe Amazon Resource Name (ARN) of the dataset group.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +dataset_group_arn +FROM aws.personalize.dataset_groups +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the dataset_groups resource, the following permissions are required: + +### Create +```json +personalize:CreateDatasetGroup, +personalize:DescribeDatasetGroup, +iam:PassRole +``` + +### List +```json +personalize:ListDatasetGroups +``` + diff --git a/docs/aws-docs/providers/aws/personalize/datasets/index.md b/docs/aws-docs/providers/aws/personalize/datasets/index.md new file mode 100644 index 0000000000..5f7b389285 --- /dev/null +++ b/docs/aws-docs/providers/aws/personalize/datasets/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionResource schema for AWS::Personalize::Dataset.
Idaws.personalize.datasets
+ +## Fields + + + + + +
NameDatatypeDescription
dataset_arnstringThe ARN of the dataset
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +dataset_arn +FROM aws.personalize.datasets +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the datasets resource, the following permissions are required: + +### Create +```json +personalize:CreateDataset, +personalize:DescribeDataset, +personalize:CreateDatasetImportJob, +personalize:DescribeDatasetImportJob, +iam:PassRole +``` + +### List +```json +personalize:ListDatasets +``` + diff --git a/docs/aws-docs/providers/aws/personalize/index.md b/docs/aws-docs/providers/aws/personalize/index.md new file mode 100644 index 0000000000..2e24b3d6ba --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/personalize/schema/index.md b/docs/aws-docs/providers/aws/personalize/schema/index.md new file mode 100644 index 0000000000..74492ef6e2 --- /dev/null +++ b/docs/aws-docs/providers/aws/personalize/schema/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionResource schema for AWS::Personalize::Schema.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +schema_arn, +schema, +domain +FROM aws.personalize.schema +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the schema resource, the following permissions are required: + +### Read +```json +personalize:DescribeSchema +``` + +### Delete +```json +personalize:DeleteSchema, +personalize:DescribeSchema +``` + diff --git a/docs/aws-docs/providers/aws/personalize/schemata/index.md b/docs/aws-docs/providers/aws/personalize/schemata/index.md new file mode 100644 index 0000000000..b709ca8cc3 --- /dev/null +++ b/docs/aws-docs/providers/aws/personalize/schemata/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionResource schema for AWS::Personalize::Schema.
Idaws.personalize.schemata
+ +## Fields + + + + + +
NameDatatypeDescription
schema_arnstringArn for the schema.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +schema_arn +FROM aws.personalize.schemata +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the schemata resource, the following permissions are required: + +### Create +```json +personalize:CreateSchema, +personalize:DescribeSchema +``` + +### List +```json +personalize:ListSchemas +``` + diff --git a/docs/aws-docs/providers/aws/personalize/solution/index.md b/docs/aws-docs/providers/aws/personalize/solution/index.md new file mode 100644 index 0000000000..64959ad863 --- /dev/null +++ b/docs/aws-docs/providers/aws/personalize/solution/index.md @@ -0,0 +1,92 @@ +--- +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
DescriptionResource schema for AWS::Personalize::Solution.
Idaws.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_hpobooleanWhether 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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +solution_arn, +event_type, +dataset_group_arn, +perform_auto_ml, +perform_hpo, +recipe_arn, +solution_config +FROM aws.personalize.solution +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the solution resource, the following permissions are required: + +### Read +```json +personalize:DescribeSolution +``` + +### Delete +```json +personalize:DeleteSolution, +personalize:DescribeSolution +``` + diff --git a/docs/aws-docs/providers/aws/personalize/solutions/index.md b/docs/aws-docs/providers/aws/personalize/solutions/index.md new file mode 100644 index 0000000000..34dd3969e2 --- /dev/null +++ b/docs/aws-docs/providers/aws/personalize/solutions/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionResource schema for AWS::Personalize::Solution.
Idaws.personalize.solutions
+ +## Fields + + + + + +
NameDatatypeDescription
solution_arnundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +solution_arn +FROM aws.personalize.solutions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the solutions resource, the following permissions are required: + +### Create +```json +personalize:CreateSolution, +personalize:DescribeSolution +``` + +### List +```json +personalize:ListSolutions +``` + diff --git a/docs/aws-docs/providers/aws/pinpoint/in_app_template/index.md b/docs/aws-docs/providers/aws/pinpoint/in_app_template/index.md new file mode 100644 index 0000000000..9f86625b6d --- /dev/null +++ b/docs/aws-docs/providers/aws/pinpoint/in_app_template/index.md @@ -0,0 +1,102 @@ +--- +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
DescriptionResource Type definition for AWS::Pinpoint::InAppTemplate
Idaws.pinpoint.in_app_template
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
arnstring
contentarray
custom_configobject
layoutstring
tagsobject
template_descriptionstring
template_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +content, +custom_config, +layout, +tags, +template_description, +template_name +FROM aws.pinpoint.in_app_template +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the in_app_template resource, the following permissions are required: + +### Delete +```json +mobiletargeting:DeleteInAppTemplate, +mobiletargeting:GetInAppTemplate +``` + +### Read +```json +mobiletargeting:GetInAppTemplate, +mobiletargeting:ListTemplates +``` + +### Update +```json +mobiletargeting:UpdateInAppTemplate, +mobiletargeting:GetInAppTemplate +``` + diff --git a/docs/aws-docs/providers/aws/pinpoint/in_app_templates/index.md b/docs/aws-docs/providers/aws/pinpoint/in_app_templates/index.md new file mode 100644 index 0000000000..8129b0d344 --- /dev/null +++ b/docs/aws-docs/providers/aws/pinpoint/in_app_templates/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionResource Type definition for AWS::Pinpoint::InAppTemplate
Idaws.pinpoint.in_app_templates
+ +## Fields + + + + + +
NameDatatypeDescription
template_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +template_name +FROM aws.pinpoint.in_app_templates +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the in_app_templates resource, the following permissions are required: + +### Create +```json +mobiletargeting:CreateInAppTemplate, +mobiletargeting:GetInAppTemplate, +mobiletargeting:TagResource +``` + +### List +```json +mobiletargeting:GetInAppTemplate, +mobiletargeting:ListTemplates +``` + diff --git a/docs/aws-docs/providers/aws/pinpoint/index.md b/docs/aws-docs/providers/aws/pinpoint/index.md new file mode 100644 index 0000000000..1f0dc42ab9 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/pipes/index.md b/docs/aws-docs/providers/aws/pipes/index.md new file mode 100644 index 0000000000..36c90ad310 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/pipes/pipe/index.md b/docs/aws-docs/providers/aws/pipes/pipe/index.md new file mode 100644 index 0000000000..7c8261aab4 --- /dev/null +++ b/docs/aws-docs/providers/aws/pipes/pipe/index.md @@ -0,0 +1,141 @@ +--- +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
DescriptionDefinition of AWS::Pipes::Pipe Resource Type
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.pipes.pipe +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the pipe resource, the following permissions are required: + +### Read +```json +pipes:DescribePipe +``` + +### Update +```json +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 +```json +pipes:DeletePipe, +pipes:DescribePipe, +logs:CreateLogDelivery, +logs:UpdateLogDelivery, +logs:DeleteLogDelivery, +logs:GetLogDelivery, +logs:ListLogDeliveries +``` + diff --git a/docs/aws-docs/providers/aws/pipes/pipes/index.md b/docs/aws-docs/providers/aws/pipes/pipes/index.md new file mode 100644 index 0000000000..5afc4a6a22 --- /dev/null +++ b/docs/aws-docs/providers/aws/pipes/pipes/index.md @@ -0,0 +1,90 @@ +--- +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
DescriptionDefinition of AWS::Pipes::Pipe Resource Type
Idaws.pipes.pipes
+ +## Fields + + + + + +
NameDatatypeDescription
namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.pipes.pipes +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the pipes resource, the following permissions are required: + +### Create +```json +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 +```json +pipes:ListPipes +``` + diff --git a/docs/aws-docs/providers/aws/proton/environment_account_connection/index.md b/docs/aws-docs/providers/aws/proton/environment_account_connection/index.md new file mode 100644 index 0000000000..6bdcb77c0e --- /dev/null +++ b/docs/aws-docs/providers/aws/proton/environment_account_connection/index.md @@ -0,0 +1,118 @@ +--- +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
DescriptionResource Schema describing various properties for AWS Proton Environment Account Connections resources.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.proton.environment_account_connection +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the environment_account_connection resource, the following permissions are required: + +### Read +```json +proton:GetEnvironmentAccountConnection, +proton:ListTagsForResource, +iam:PassRole, +proton:GetEnvironmentAccountConnection +``` + +### Update +```json +proton:CreateEnvironmentAccountConnection, +proton:ListTagsForResource, +proton:TagResource, +proton:UntagResource, +proton:UpdateEnvironmentAccountConnection, +iam:PassRole, +proton:GetEnvironmentAccountConnection +``` + +### Delete +```json +proton:DeleteEnvironmentAccountConnection, +proton:UntagResource, +iam:PassRole, +proton:ListTagsForResource, +proton:GetEnvironmentAccountConnection +``` + diff --git a/docs/aws-docs/providers/aws/proton/environment_account_connections/index.md b/docs/aws-docs/providers/aws/proton/environment_account_connections/index.md new file mode 100644 index 0000000000..c0a6bfdd74 --- /dev/null +++ b/docs/aws-docs/providers/aws/proton/environment_account_connections/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionResource Schema describing various properties for AWS Proton Environment Account Connections resources.
Idaws.proton.environment_account_connections
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the environment account connection.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.proton.environment_account_connections +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the environment_account_connections resource, the following permissions are required: + +### Create +```json +proton:CreateEnvironmentAccountConnection, +proton:TagResource, +iam:PassRole, +proton:ListTagsForResource, +proton:GetEnvironmentAccountConnection +``` + +### List +```json +proton:ListEnvironmentAccountConnections +``` + diff --git a/docs/aws-docs/providers/aws/proton/environment_template/index.md b/docs/aws-docs/providers/aws/proton/environment_template/index.md new file mode 100644 index 0000000000..422b329e80 --- /dev/null +++ b/docs/aws-docs/providers/aws/proton/environment_template/index.md @@ -0,0 +1,109 @@ +--- +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
DescriptionDefinition of AWS::Proton::EnvironmentTemplate Resource Type
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +description, +display_name, +encryption_key, +name, +provisioning, +tags +FROM aws.proton.environment_template +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the environment_template resource, the following permissions are required: + +### Read +```json +proton:GetEnvironmentTemplate, +proton:ListTagsForResource, +kms:* +``` + +### Update +```json +proton:CreateEnvironmentTemplate, +proton:ListTagsForResource, +proton:TagResource, +proton:UntagResource, +proton:UpdateEnvironmentTemplate, +proton:GetEnvironmentTemplate, +kms:* +``` + +### Delete +```json +proton:DeleteEnvironmentTemplate, +proton:GetEnvironmentTemplate, +kms:* +``` + diff --git a/docs/aws-docs/providers/aws/proton/environment_templates/index.md b/docs/aws-docs/providers/aws/proton/environment_templates/index.md new file mode 100644 index 0000000000..94e40c3728 --- /dev/null +++ b/docs/aws-docs/providers/aws/proton/environment_templates/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionDefinition of AWS::Proton::EnvironmentTemplate Resource Type
Idaws.proton.environment_templates
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring<p>The Amazon Resource Name (ARN) of the environment template.</p>
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.proton.environment_templates +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the environment_templates resource, the following permissions are required: + +### Create +```json +proton:CreateEnvironmentTemplate, +proton:TagResource, +proton:GetEnvironmentTemplate, +kms:* +``` + +### List +```json +proton:ListEnvironmentTemplates +``` + diff --git a/docs/aws-docs/providers/aws/proton/index.md b/docs/aws-docs/providers/aws/proton/index.md new file mode 100644 index 0000000000..9f233897dc --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/proton/service_template/index.md b/docs/aws-docs/providers/aws/proton/service_template/index.md new file mode 100644 index 0000000000..45baae0e1f --- /dev/null +++ b/docs/aws-docs/providers/aws/proton/service_template/index.md @@ -0,0 +1,110 @@ +--- +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
DescriptionDefinition of AWS::Proton::ServiceTemplate Resource Type
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +description, +display_name, +encryption_key, +name, +pipeline_provisioning, +tags +FROM aws.proton.service_template +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the service_template resource, the following permissions are required: + +### Read +```json +proton:GetServiceTemplate, +proton:ListTagsForResource, +kms:* +``` + +### Update +```json +proton:GetServiceTemplate, +proton:CreateServiceTemplate, +proton:ListTagsForResource, +proton:TagResource, +proton:UntagResource, +proton:UpdateServiceTemplate, +kms:* +``` + +### Delete +```json +proton:DeleteServiceTemplate, +proton:UntagResource, +kms:*, +proton:GetServiceTemplate +``` + diff --git a/docs/aws-docs/providers/aws/proton/service_templates/index.md b/docs/aws-docs/providers/aws/proton/service_templates/index.md new file mode 100644 index 0000000000..203ddc16ed --- /dev/null +++ b/docs/aws-docs/providers/aws/proton/service_templates/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionDefinition of AWS::Proton::ServiceTemplate Resource Type
Idaws.proton.service_templates
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring<p>The Amazon Resource Name (ARN) of the service template.</p>
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.proton.service_templates +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the service_templates resource, the following permissions are required: + +### Create +```json +proton:CreateServiceTemplate, +proton:TagResource, +kms:*, +proton:GetServiceTemplate +``` + +### List +```json +proton:ListServiceTemplates +``` + diff --git a/docs/aws-docs/providers/aws/qldb/index.md b/docs/aws-docs/providers/aws/qldb/index.md new file mode 100644 index 0000000000..2f6fe3317e --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/qldb/qldb_stream/index.md b/docs/aws-docs/providers/aws/qldb/qldb_stream/index.md new file mode 100644 index 0000000000..78d9bd7c7a --- /dev/null +++ b/docs/aws-docs/providers/aws/qldb/qldb_stream/index.md @@ -0,0 +1,107 @@ +--- +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
DescriptionResource schema for AWS::QLDB::Stream.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +ledger_name, +stream_name, +role_arn, +inclusive_start_time, +exclusive_end_time, +kinesis_configuration, +tags, +arn, +id +FROM aws.qldb.qldb_stream +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the qldb_stream resource, the following permissions are required: + +### Delete +```json +qldb:CancelJournalKinesisStream, +qldb:DescribeJournalKinesisStream +``` + +### Read +```json +qldb:DescribeJournalKinesisStream, +qldb:ListTagsForResource +``` + +### Update +```json +qldb:DescribeJournalKinesisStream, +qldb:UntagResource, +qldb:TagResource +``` + diff --git a/docs/aws-docs/providers/aws/qldb/streams/index.md b/docs/aws-docs/providers/aws/qldb/streams/index.md new file mode 100644 index 0000000000..e8b06dc264 --- /dev/null +++ b/docs/aws-docs/providers/aws/qldb/streams/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionResource schema for AWS::QLDB::Stream.
Idaws.qldb.streams
+ +## Fields + + + + + + +
NameDatatypeDescription
ledger_namestring
idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +ledger_name, +id +FROM aws.qldb.streams +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the streams resource, the following permissions are required: + +### Create +```json +iam:PassRole, +qldb:StreamJournalToKinesis, +qldb:DescribeJournalKinesisStream +``` + +### List +```json +qldb:listJournalKinesisStreamsForLedger +``` + diff --git a/docs/aws-docs/providers/aws/quicksight/analyses/index.md b/docs/aws-docs/providers/aws/quicksight/analyses/index.md new file mode 100644 index 0000000000..bd8ee82926 --- /dev/null +++ b/docs/aws-docs/providers/aws/quicksight/analyses/index.md @@ -0,0 +1,87 @@ +--- +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
DescriptionDefinition of the AWS::QuickSight::Analysis Resource Type.
Idaws.quicksight.analyses
+ +## Fields + + + + + + +
NameDatatypeDescription
analysis_idstring
aws_account_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +analysis_id, +aws_account_id +FROM aws.quicksight.analyses +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the analyses resource, the following permissions are required: + +### Create +```json +quicksight:DescribeAnalysis, +quicksight:DescribeAnalysisPermissions, +quicksight:CreateAnalysis, +quicksight:DescribeTemplate, +quicksight:DescribeTheme, +quicksight:PassDataSet, +quicksight:TagResource, +quicksight:UntagResource, +quicksight:ListTagsForResource +``` + +### List +```json +quicksight:ListAnalyses +``` + diff --git a/docs/aws-docs/providers/aws/quicksight/analysis/index.md b/docs/aws-docs/providers/aws/quicksight/analysis/index.md new file mode 100644 index 0000000000..3f45d36da8 --- /dev/null +++ b/docs/aws-docs/providers/aws/quicksight/analysis/index.md @@ -0,0 +1,131 @@ +--- +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
DescriptionDefinition of the AWS::QuickSight::Analysis Resource Type.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.quicksight.analysis +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the analysis resource, the following permissions are required: + +### Read +```json +quicksight:DescribeAnalysis, +quicksight:DescribeAnalysisPermissions, +quicksight:ListTagsForResource +``` + +### Update +```json +quicksight:DescribeAnalysis, +quicksight:DescribeAnalysisPermissions, +quicksight:UpdateAnalysis, +quicksight:UpdateAnalysisPermissions, +quicksight:DescribeTemplate, +quicksight:DescribeTheme, +quicksight:PassDataSet, +quicksight:TagResource, +quicksight:UntagResource, +quicksight:ListTagsForResource +``` + +### Delete +```json +quicksight:DescribeAnalysis, +quicksight:DeleteAnalysis +``` + diff --git a/docs/aws-docs/providers/aws/quicksight/dashboard/index.md b/docs/aws-docs/providers/aws/quicksight/dashboard/index.md new file mode 100644 index 0000000000..ec2f323b06 --- /dev/null +++ b/docs/aws-docs/providers/aws/quicksight/dashboard/index.md @@ -0,0 +1,137 @@ +--- +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
DescriptionDefinition of the AWS::QuickSight::Dashboard Resource Type.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.quicksight.dashboard +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the dashboard resource, the following permissions are required: + +### Read +```json +quicksight:DescribeDashboard, +quicksight:DescribeDashboardPermissions, +quicksight:ListTagsForResource +``` + +### Update +```json +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 +```json +quicksight:DescribeDashboard, +quicksight:DeleteDashboard +``` + diff --git a/docs/aws-docs/providers/aws/quicksight/dashboards/index.md b/docs/aws-docs/providers/aws/quicksight/dashboards/index.md new file mode 100644 index 0000000000..8d0be3f1eb --- /dev/null +++ b/docs/aws-docs/providers/aws/quicksight/dashboards/index.md @@ -0,0 +1,87 @@ +--- +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
DescriptionDefinition of the AWS::QuickSight::Dashboard Resource Type.
Idaws.quicksight.dashboards
+ +## Fields + + + + + + +
NameDatatypeDescription
aws_account_idstring
dashboard_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +aws_account_id, +dashboard_id +FROM aws.quicksight.dashboards +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the dashboards resource, the following permissions are required: + +### Create +```json +quicksight:DescribeDashboard, +quicksight:DescribeDashboardPermissions, +quicksight:CreateDashboard, +quicksight:DescribeTemplate, +quicksight:DescribeTheme, +quicksight:PassDataSet, +quicksight:TagResource, +quicksight:UntagResource, +quicksight:ListTagsForResource +``` + +### List +```json +quicksight:ListDashboards +``` + diff --git a/docs/aws-docs/providers/aws/quicksight/data_set/index.md b/docs/aws-docs/providers/aws/quicksight/data_set/index.md new file mode 100644 index 0000000000..66130729b8 --- /dev/null +++ b/docs/aws-docs/providers/aws/quicksight/data_set/index.md @@ -0,0 +1,151 @@ +--- +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
DescriptionDefinition of the AWS::QuickSight::DataSet Resource Type.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.quicksight.data_set +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the data_set resource, the following permissions are required: + +### Read +```json +quicksight:DescribeDataSet, +quicksight:DescribeDataSetPermissions, +quicksight:ListTagsForResource, +quicksight:DescribeDataSetRefreshProperties +``` + +### Update +```json +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 +```json +quicksight:DescribeDataSet, +quicksight:DeleteDataSet, +quicksight:ListTagsForResource, +quicksight:DescribeIngestion, +quicksight:DeleteDataSetRefreshProperties, +quicksight:DescribeDataSetRefreshProperties +``` + diff --git a/docs/aws-docs/providers/aws/quicksight/data_sets/index.md b/docs/aws-docs/providers/aws/quicksight/data_sets/index.md new file mode 100644 index 0000000000..dd532dc816 --- /dev/null +++ b/docs/aws-docs/providers/aws/quicksight/data_sets/index.md @@ -0,0 +1,90 @@ +--- +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
DescriptionDefinition of the AWS::QuickSight::DataSet Resource Type.
Idaws.quicksight.data_sets
+ +## Fields + + + + + + +
NameDatatypeDescription
aws_account_idstring
data_set_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +aws_account_id, +data_set_id +FROM aws.quicksight.data_sets +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the data_sets resource, the following permissions are required: + +### Create +```json +quicksight:DescribeDataSet, +quicksight:DescribeDataSetPermissions, +quicksight:DescribeIngestion, +quicksight:ListIngestions, +quicksight:CreateDataSet, +quicksight:PassDataSource, +quicksight:PassDataSet, +quicksight:TagResource, +quicksight:ListTagsForResource, +quicksight:DescribeDataSetRefreshProperties, +quicksight:PutDataSetRefreshProperties +``` + +### List +```json +quicksight:DescribeDataSet, +quicksight:ListDataSets +``` + diff --git a/docs/aws-docs/providers/aws/quicksight/data_source/index.md b/docs/aws-docs/providers/aws/quicksight/data_source/index.md new file mode 100644 index 0000000000..3f0ca9f801 --- /dev/null +++ b/docs/aws-docs/providers/aws/quicksight/data_source/index.md @@ -0,0 +1,128 @@ +--- +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
DescriptionDefinition of the AWS::QuickSight::DataSource Resource Type.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.quicksight.data_source +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the data_source resource, the following permissions are required: + +### Read +```json +quicksight:DescribeDataSource, +quicksight:DescribeDataSourcePermissions, +quicksight:ListTagsForResource +``` + +### Update +```json +quicksight:DescribeDataSource, +quicksight:DescribeDataSourcePermissions, +quicksight:UpdateDataSource, +quicksight:UpdateDataSourcePermissions, +quicksight:TagResource, +quicksight:UntagResource, +quicksight:ListTagsForResource +``` + +### Delete +```json +quicksight:DescribeDataSource, +quicksight:DescribeDataSourcePermissions, +quicksight:DeleteDataSource, +quicksight:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/quicksight/data_sources/index.md b/docs/aws-docs/providers/aws/quicksight/data_sources/index.md new file mode 100644 index 0000000000..578c5d24b0 --- /dev/null +++ b/docs/aws-docs/providers/aws/quicksight/data_sources/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionDefinition of the AWS::QuickSight::DataSource Resource Type.
Idaws.quicksight.data_sources
+ +## Fields + + + + + + +
NameDatatypeDescription
aws_account_idstring
data_source_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +aws_account_id, +data_source_id +FROM aws.quicksight.data_sources +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the data_sources resource, the following permissions are required: + +### Create +```json +quicksight:CreateDataSource, +quicksight:DescribeDataSource, +quicksight:DescribeDataSourcePermissions, +quicksight:TagResource, +quicksight:ListTagsForResource +``` + +### List +```json +quicksight:DescribeDataSource, +quicksight:ListDataSources +``` + diff --git a/docs/aws-docs/providers/aws/quicksight/index.md b/docs/aws-docs/providers/aws/quicksight/index.md new file mode 100644 index 0000000000..2c489f8b32 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/quicksight/refresh_schedule/index.md b/docs/aws-docs/providers/aws/quicksight/refresh_schedule/index.md new file mode 100644 index 0000000000..987fc727ee --- /dev/null +++ b/docs/aws-docs/providers/aws/quicksight/refresh_schedule/index.md @@ -0,0 +1,95 @@ +--- +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
DescriptionDefinition of the AWS::QuickSight::RefreshSchedule Resource Type.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +aws_account_id, +data_set_id, +schedule +FROM aws.quicksight.refresh_schedule +WHERE data__Identifier = '||'; +``` + +## Permissions + +To operate on the refresh_schedule resource, the following permissions are required: + +### Update +```json +quicksight:UpdateRefreshSchedule, +quicksight:DescribeRefreshSchedule +``` + +### Delete +```json +quicksight:DeleteRefreshSchedule, +quicksight:DescribeRefreshSchedule +``` + +### Read +```json +quicksight:DescribeRefreshSchedule +``` + diff --git a/docs/aws-docs/providers/aws/quicksight/refresh_schedules/index.md b/docs/aws-docs/providers/aws/quicksight/refresh_schedules/index.md new file mode 100644 index 0000000000..88bb8a8524 --- /dev/null +++ b/docs/aws-docs/providers/aws/quicksight/refresh_schedules/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionDefinition of the AWS::QuickSight::RefreshSchedule Resource Type.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +aws_account_id, +data_set_id, +schedule/schedule_id +FROM aws.quicksight.refresh_schedules +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the refresh_schedules resource, the following permissions are required: + +### Create +```json +quicksight:CreateRefreshSchedule, +quicksight:DescribeRefreshSchedule +``` + +### List +```json +quicksight:ListRefreshSchedules +``` + diff --git a/docs/aws-docs/providers/aws/quicksight/template/index.md b/docs/aws-docs/providers/aws/quicksight/template/index.md new file mode 100644 index 0000000000..94d2fe0e8d --- /dev/null +++ b/docs/aws-docs/providers/aws/quicksight/template/index.md @@ -0,0 +1,121 @@ +--- +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
DescriptionDefinition of the AWS::QuickSight::Template Resource Type.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.quicksight.template +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the template resource, the following permissions are required: + +### Read +```json +quicksight:DescribeTemplate, +quicksight:DescribeTemplatePermissions, +quicksight:ListTagsForResource +``` + +### Update +```json +quicksight:DescribeTemplate, +quicksight:DescribeTemplatePermissions, +quicksight:UpdateTemplate, +quicksight:UpdateTemplatePermissions, +quicksight:PassDataSet, +quicksight:TagResource, +quicksight:UntagResource, +quicksight:ListTagsForResource +``` + +### Delete +```json +quicksight:DescribeTemplate, +quicksight:DeleteTemplate +``` + diff --git a/docs/aws-docs/providers/aws/quicksight/templates/index.md b/docs/aws-docs/providers/aws/quicksight/templates/index.md new file mode 100644 index 0000000000..9f261cb505 --- /dev/null +++ b/docs/aws-docs/providers/aws/quicksight/templates/index.md @@ -0,0 +1,85 @@ +--- +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
DescriptionDefinition of the AWS::QuickSight::Template Resource Type.
Idaws.quicksight.templates
+ +## Fields + + + + + + +
NameDatatypeDescription
aws_account_idstring
template_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +aws_account_id, +template_id +FROM aws.quicksight.templates +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the templates resource, the following permissions are required: + +### Create +```json +quicksight:DescribeTemplate, +quicksight:DescribeTemplatePermissions, +quicksight:CreateTemplate, +quicksight:DescribeAnalysis, +quicksight:TagResource, +quicksight:UntagResource, +quicksight:ListTagsForResource +``` + +### List +```json +quicksight:ListTemplates +``` + diff --git a/docs/aws-docs/providers/aws/quicksight/theme/index.md b/docs/aws-docs/providers/aws/quicksight/theme/index.md new file mode 100644 index 0000000000..4eb64d29e5 --- /dev/null +++ b/docs/aws-docs/providers/aws/quicksight/theme/index.md @@ -0,0 +1,120 @@ +--- +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
DescriptionDefinition of the AWS::QuickSight::Theme Resource Type.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.quicksight.theme +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the theme resource, the following permissions are required: + +### Read +```json +quicksight:DescribeTheme, +quicksight:DescribeThemePermissions, +quicksight:ListTagsForResource +``` + +### Update +```json +quicksight:DescribeTheme, +quicksight:DescribeThemePermissions, +quicksight:UpdateTheme, +quicksight:UpdateThemePermissions, +quicksight:TagResource, +quicksight:UntagResource, +quicksight:ListTagsForResource +``` + +### Delete +```json +quicksight:DescribeTheme, +quicksight:DeleteTheme +``` + diff --git a/docs/aws-docs/providers/aws/quicksight/themes/index.md b/docs/aws-docs/providers/aws/quicksight/themes/index.md new file mode 100644 index 0000000000..dd9a827598 --- /dev/null +++ b/docs/aws-docs/providers/aws/quicksight/themes/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionDefinition of the AWS::QuickSight::Theme Resource Type.
Idaws.quicksight.themes
+ +## Fields + + + + + + +
NameDatatypeDescription
theme_idstring
aws_account_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +theme_id, +aws_account_id +FROM aws.quicksight.themes +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the themes resource, the following permissions are required: + +### Create +```json +quicksight:DescribeTheme, +quicksight:DescribeThemePermissions, +quicksight:CreateTheme, +quicksight:TagResource, +quicksight:UntagResource, +quicksight:ListTagsForResource +``` + +### List +```json +quicksight:ListThemes +``` + diff --git a/docs/aws-docs/providers/aws/quicksight/topic/index.md b/docs/aws-docs/providers/aws/quicksight/topic/index.md new file mode 100644 index 0000000000..bec93785b0 --- /dev/null +++ b/docs/aws-docs/providers/aws/quicksight/topic/index.md @@ -0,0 +1,101 @@ +--- +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
DescriptionDefinition of the AWS::QuickSight::Topic Resource Type.
Idaws.quicksight.topic
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
arnstring
aws_account_idstring
data_setsarray
descriptionstring
namestring
topic_idstring
user_experience_versionstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +aws_account_id, +data_sets, +description, +name, +topic_id, +user_experience_version +FROM aws.quicksight.topic +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the topic resource, the following permissions are required: + +### Read +```json +quicksight:DescribeTopic +``` + +### Update +```json +quicksight:UpdateTopic, +quicksight:PassDataSet, +quicksight:DescribeTopicRefresh +``` + +### Delete +```json +quicksight:DeleteTopic +``` + diff --git a/docs/aws-docs/providers/aws/quicksight/topics/index.md b/docs/aws-docs/providers/aws/quicksight/topics/index.md new file mode 100644 index 0000000000..eb61c3f463 --- /dev/null +++ b/docs/aws-docs/providers/aws/quicksight/topics/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionDefinition of the AWS::QuickSight::Topic Resource Type.
Idaws.quicksight.topics
+ +## Fields + + + + + + +
NameDatatypeDescription
aws_account_idstring
topic_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +aws_account_id, +topic_id +FROM aws.quicksight.topics +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the topics resource, the following permissions are required: + +### Create +```json +quicksight:CreateTopic, +quicksight:PassDataSet, +quicksight:DescribeTopicRefresh +``` + +### List +```json +quicksight:ListTopics +``` + diff --git a/docs/aws-docs/providers/aws/quicksight/vpc_connection/index.md b/docs/aws-docs/providers/aws/quicksight/vpc_connection/index.md new file mode 100644 index 0000000000..a09ef89b9b --- /dev/null +++ b/docs/aws-docs/providers/aws/quicksight/vpc_connection/index.md @@ -0,0 +1,124 @@ +--- +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
DescriptionDefinition of the AWS::QuickSight::VPCConnection Resource Type.
Idaws.quicksight.vpc_connection
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
aws_account_idstring
namestring
vpc_connection_idstring
vpc_idstring
security_group_idsarray
subnet_idsarray
dns_resolversarray
statusstring
availability_statusstring
network_interfacesarray
role_arnstring
created_timestring
last_updated_timestring
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +aws_account_id, +name, +vpc_connection_id, +vpc_id, +security_group_ids, +subnet_ids, +dns_resolvers, +status, +availability_status, +network_interfaces, +role_arn, +created_time, +last_updated_time, +tags +FROM aws.quicksight.vpc_connection +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the vpc_connection resource, the following permissions are required: + +### Read +```json +quicksight:DescribeVPCConnection, +quicksight:ListTagsForResource +``` + +### Update +```json +quicksight:DescribeVPCConnection, +quicksight:UpdateVPCConnection, +quicksight:TagResource, +quicksight:UntagResource, +quicksight:ListTagsForResource, +iam:PassRole +``` + +### Delete +```json +quicksight:DescribeVPCConnection, +quicksight:DeleteVPCConnection, +quicksight:ListTagsForResource, +iam:PassRole +``` + diff --git a/docs/aws-docs/providers/aws/quicksight/vpc_connections/index.md b/docs/aws-docs/providers/aws/quicksight/vpc_connections/index.md new file mode 100644 index 0000000000..25bb2856f7 --- /dev/null +++ b/docs/aws-docs/providers/aws/quicksight/vpc_connections/index.md @@ -0,0 +1,83 @@ +--- +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
DescriptionDefinition of the AWS::QuickSight::VPCConnection Resource Type.
Idaws.quicksight.vpc_connections
+ +## Fields + + + + + + +
NameDatatypeDescription
aws_account_idstring
vpc_connection_idundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +aws_account_id, +vpc_connection_id +FROM aws.quicksight.vpc_connections +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the vpc_connections resource, the following permissions are required: + +### Create +```json +quicksight:CreateVPCConnection, +quicksight:DescribeVPCConnection, +quicksight:ListTagsForResource, +quicksight:TagResource, +iam:PassRole +``` + +### List +```json +quicksight:ListVPCConnections +``` + diff --git a/docs/aws-docs/providers/aws/ram/index.md b/docs/aws-docs/providers/aws/ram/index.md new file mode 100644 index 0000000000..601ec7797a --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/ram/permission/index.md b/docs/aws-docs/providers/aws/ram/permission/index.md new file mode 100644 index 0000000000..16be045265 --- /dev/null +++ b/docs/aws-docs/providers/aws/ram/permission/index.md @@ -0,0 +1,110 @@ +--- +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
DescriptionResource type definition for AWS::RAM::Permission
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +name, +version, +is_resource_type_default, +permission_type, +resource_type, +policy_template, +tags +FROM aws.ram.permission +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the permission resource, the following permissions are required: + +### Read +```json +ram:GetPermission +``` + +### Update +```json +ram:CreatePermissionVersion, +ram:DeletePermissionVersion, +ram:SetDefaultPermissionVersion, +ram:GetPermission, +ram:ReplacePermissionAssociations, +ram:ListReplacePermissionAssociationsWork, +ram:ListPermissionVersions, +ram:UntagResource, +ram:TagResource +``` + +### Delete +```json +ram:DeletePermissionVersion, +ram:DeletePermission +``` + diff --git a/docs/aws-docs/providers/aws/ram/permissions/index.md b/docs/aws-docs/providers/aws/ram/permissions/index.md new file mode 100644 index 0000000000..0fec512562 --- /dev/null +++ b/docs/aws-docs/providers/aws/ram/permissions/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource type definition for AWS::RAM::Permission
Idaws.ram.permissions
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.ram.permissions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the permissions resource, the following permissions are required: + +### Create +```json +ram:CreatePermission, +ram:TagResource +``` + +### List +```json +ram:ListPermissions, +ram:ListPermissionVersions +``` + diff --git a/docs/aws-docs/providers/aws/rds/customdb_engine_version/index.md b/docs/aws-docs/providers/aws/rds/customdb_engine_version/index.md new file mode 100644 index 0000000000..c5590172bd --- /dev/null +++ b/docs/aws-docs/providers/aws/rds/customdb_engine_version/index.md @@ -0,0 +1,115 @@ +--- +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
DescriptionThe AWS::RDS::CustomDBEngineVersion resource creates an Amazon RDS custom DB engine version.
Idaws.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.
kms_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.
db_engine_version_arnstringThe ARN of the custom engine version.
source_custom_db_engine_version_identifierstringThe identifier of the source custom engine version.
use_aws_provided_latest_imagebooleanA value that indicates whether AWS provided latest image is applied automatically to the Custom Engine Version. By default, AWS provided latest image is applied automatically. This value is only applied on create.
image_idstringThe identifier of Amazon Machine Image (AMI) used for CEV.
statusstringThe availability status to be assigned to the CEV.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +database_installation_files_s3_bucket_name, +database_installation_files_s3_prefix, +description, +engine, +engine_version, +kms_key_id, +manifest, +db_engine_version_arn, +source_custom_db_engine_version_identifier, +use_aws_provided_latest_image, +image_id, +status, +tags +FROM aws.rds.customdb_engine_version +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the customdb_engine_version resource, the following permissions are required: + +### Read +```json +rds:DescribeDBEngineVersions +``` + +### Update +```json +rds:AddTagsToResource, +rds:DescribeDBEngineVersions, +rds:ModifyCustomDBEngineVersion, +rds:RemoveTagsFromResource +``` + +### Delete +```json +rds:DeleteCustomDBEngineVersion, +rds:DescribeDBEngineVersions +``` + diff --git a/docs/aws-docs/providers/aws/rds/customdb_engine_versions/index.md b/docs/aws-docs/providers/aws/rds/customdb_engine_versions/index.md new file mode 100644 index 0000000000..ff7c1a90a0 --- /dev/null +++ b/docs/aws-docs/providers/aws/rds/customdb_engine_versions/index.md @@ -0,0 +1,99 @@ +--- +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
DescriptionThe AWS::RDS::CustomDBEngineVersion resource creates an Amazon RDS custom DB engine version.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +engine, +engine_version +FROM aws.rds.customdb_engine_versions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the customdb_engine_versions resource, the following permissions are required: + +### Create +```json +ec2:CopySnapshot, +ec2:DeleteSnapshot, +ec2:DescribeSnapshots, +kms:CreateGrant, +kms:Decrypt, +kms:DescribeKey, +kms:GenerateDataKey, +kms:ReEncrypt, +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 +```json +rds:DescribeDBEngineVersions +``` + diff --git a/docs/aws-docs/providers/aws/rds/db_cluster/index.md b/docs/aws-docs/providers/aws/rds/db_cluster/index.md new file mode 100644 index 0000000000..e4780a25f1 --- /dev/null +++ b/docs/aws-docs/providers/aws/rds/db_cluster/index.md @@ -0,0 +1,224 @@ +--- +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
DescriptionThe AWS::RDS::DBCluster resource creates an Amazon Aurora DB cluster.
Idaws.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.
db_cluster_arnstringThe Amazon Resource Name (ARN) for the DB cluster.
db_cluster_instance_classstringThe compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.
db_cluster_resource_idstringThe AWS Region-unique, immutable identifier for the DB cluster.
db_instance_parameter_group_namestringThe name of the DB parameter group to apply to all instances of the DB cluster.
db_system_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.
db_cluster_identifierstringThe DB cluster identifier. This parameter is stored as a lowercase string.
db_cluster_parameter_group_namestringThe name of the DB cluster parameter group to associate with this DB cluster.
db_subnet_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_iam_role_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_iam_database_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_throughputintegerSpecifies the storage throughput value for the DB cluster. This setting applies only to the gp3 storage type.
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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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, +db_cluster_arn, +db_cluster_instance_class, +db_cluster_resource_id, +db_instance_parameter_group_name, +db_system_id, +global_cluster_identifier, +db_cluster_identifier, +db_cluster_parameter_group_name, +db_subnet_group_name, +deletion_protection, +domain, +domain_iam_role_name, +enable_cloudwatch_logs_exports, +enable_global_write_forwarding, +enable_http_endpoint, +enable_iam_database_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_throughput, +storage_type, +tags, +use_latest_restorable_time, +vpc_security_group_ids +FROM aws.rds.db_cluster +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the db_cluster resource, the following permissions are required: + +### Read +```json +rds:DescribeDBClusters +``` + +### Update +```json +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 +```json +rds:CreateDBClusterSnapshot, +rds:DeleteDBCluster, +rds:DeleteDBInstance, +rds:DescribeDBClusters, +rds:DescribeGlobalClusters, +rds:RemoveFromGlobalCluster +``` + diff --git a/docs/aws-docs/providers/aws/rds/db_cluster_parameter_group/index.md b/docs/aws-docs/providers/aws/rds/db_cluster_parameter_group/index.md new file mode 100644 index 0000000000..f1e92a5850 --- /dev/null +++ b/docs/aws-docs/providers/aws/rds/db_cluster_parameter_group/index.md @@ -0,0 +1,106 @@ +--- +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
DescriptionThe AWS::RDS::DBClusterParameterGroup resource creates a new Amazon RDS DB cluster parameter group. For more information, see Managing an Amazon Aurora DB Cluster in the Amazon Aurora User Guide.
Idaws.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.
db_cluster_parameter_group_namestring
tagsarrayThe list of tags for the cluster parameter group.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +description, +family, +parameters, +db_cluster_parameter_group_name, +tags +FROM aws.rds.db_cluster_parameter_group +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the db_cluster_parameter_group resource, the following permissions are required: + +### Read +```json +rds:DescribeDBClusterParameterGroups, +rds:DescribeDBClusterParameters, +rds:DescribeEngineDefaultClusterParameters, +rds:ListTagsForResource +``` + +### Update +```json +rds:AddTagsToResource, +rds:DescribeDBClusterParameterGroups, +rds:DescribeDBClusterParameters, +rds:DescribeDBClusters, +rds:DescribeEngineDefaultClusterParameters, +rds:ListTagsForResource, +rds:ModifyDBClusterParameterGroup, +rds:RemoveTagsFromResource, +rds:ResetDBClusterParameterGroup +``` + +### Delete +```json +rds:DeleteDBClusterParameterGroup +``` + diff --git a/docs/aws-docs/providers/aws/rds/db_cluster_parameter_groups/index.md b/docs/aws-docs/providers/aws/rds/db_cluster_parameter_groups/index.md new file mode 100644 index 0000000000..b0694e8b40 --- /dev/null +++ b/docs/aws-docs/providers/aws/rds/db_cluster_parameter_groups/index.md @@ -0,0 +1,86 @@ +--- +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
DescriptionThe AWS::RDS::DBClusterParameterGroup resource creates a new Amazon RDS DB cluster parameter group. For more information, see Managing an Amazon Aurora DB Cluster in the Amazon Aurora User Guide.
Idaws.rds.db_cluster_parameter_groups
+ +## Fields + + + + + +
NameDatatypeDescription
db_cluster_parameter_group_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +db_cluster_parameter_group_name +FROM aws.rds.db_cluster_parameter_groups +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the db_cluster_parameter_groups resource, the following permissions are required: + +### Create +```json +iam:CreateServiceLinkedRole, +rds:AddTagsToResource, +rds:CreateDBClusterParameterGroup, +rds:DescribeDBClusterParameterGroups, +rds:DescribeDBClusterParameters, +rds:DescribeDBClusters, +rds:DescribeEngineDefaultClusterParameters, +rds:ListTagsForResource, +rds:ModifyDBClusterParameterGroup, +rds:RemoveTagsFromResource +``` + +### List +```json +rds:DescribeDBClusterParameterGroups +``` + diff --git a/docs/aws-docs/providers/aws/rds/db_clusters/index.md b/docs/aws-docs/providers/aws/rds/db_clusters/index.md new file mode 100644 index 0000000000..93013f1d7d --- /dev/null +++ b/docs/aws-docs/providers/aws/rds/db_clusters/index.md @@ -0,0 +1,90 @@ +--- +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
DescriptionThe AWS::RDS::DBCluster resource creates an Amazon Aurora DB cluster.
Idaws.rds.db_clusters
+ +## Fields + + + + + +
NameDatatypeDescription
db_cluster_identifierstringThe DB cluster identifier. This parameter is stored as a lowercase string.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +db_cluster_identifier +FROM aws.rds.db_clusters +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the db_clusters resource, the following permissions are required: + +### Create +```json +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 +```json +rds:DescribeDBClusters +``` + diff --git a/docs/aws-docs/providers/aws/rds/db_instance/index.md b/docs/aws-docs/providers/aws/rds/db_instance/index.md new file mode 100644 index 0000000000..98b4a7f951 --- /dev/null +++ b/docs/aws-docs/providers/aws/rds/db_instance/index.md @@ -0,0 +1,280 @@ +--- +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
DescriptionThe ``AWS::RDS::DBInstance`` resource creates an Amazon DB instance. The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster.<br/> For more information about creating an RDS DB instance, see [Creating an Amazon RDS DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html) in the *Amazon RDS User Guide*.<br/> For more information about creating a DB instance in an Aurora DB cluster, see [Creating an Amazon Aurora DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.CreateInstance.html) in the *Amazon Aurora User Guide*.<br/> If you import an existing DB instance, and the template configuration doesn't match the actual configuration of the DB instance, AWS CloudFormation applies the changes in the template during the import operation.<br/> If a DB instance is deleted or replaced during an update, AWS CloudFormation deletes all automated snapshots. However, it retains manual DB snapshots. During an
Idaws.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
ca_certificate_identifierstringThe identifier of the CA certificate for this DB instance.<br/> For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide*.
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_iam_instance_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*.
db_cluster_identifierstringThe identifier of the DB cluster that the instance will belong to.
db_cluster_snapshot_identifierstringThe identifier for the RDS for MySQL 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.<br/> + Can't be the identifier of an RDS for PostgreSQL Multi-AZ DB cluster snapshot.
db_instance_arnstring
db_instance_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/).
db_instance_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
db_namestringThe 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
db_parameter_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.
db_security_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/> +
db_snapshot_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
db_subnet_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.
db_system_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_iam_role_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_iam_database_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_kms_key_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.
vpc_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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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, +ca_certificate_identifier, +certificate_details, +certificate_rotation_restart, +character_set_name, +copy_tags_to_snapshot, +custom_iam_instance_profile, +db_cluster_identifier, +db_cluster_snapshot_identifier, +db_instance_arn, +db_instance_class, +db_instance_identifier, +dbi_resource_id, +db_name, +db_parameter_group_name, +db_security_groups, +db_snapshot_identifier, +db_subnet_group_name, +db_system_id, +dedicated_log_volume, +delete_automated_backups, +deletion_protection, +domain, +domain_auth_secret_arn, +domain_dns_ips, +domain_fqdn, +domain_iam_role_name, +domain_ou, +enable_cloudwatch_logs_exports, +enable_iam_database_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_kms_key_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, +vpc_security_groups +FROM aws.rds.db_instance +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the db_instance resource, the following permissions are required: + +### Read +```json +ec2:DescribeAccountAttributes, +ec2:DescribeAvailabilityZones, +ec2:DescribeInternetGateways, +ec2:DescribeSecurityGroups, +ec2:DescribeSubnets, +ec2:DescribeVpcAttribute, +ec2:DescribeVpcs, +rds:DescribeDBInstances +``` + +### Update +```json +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 +```json +rds:CreateDBSnapshot, +rds:DeleteDBInstance, +rds:DescribeDBInstances +``` + diff --git a/docs/aws-docs/providers/aws/rds/db_instances/index.md b/docs/aws-docs/providers/aws/rds/db_instances/index.md new file mode 100644 index 0000000000..97954355e8 --- /dev/null +++ b/docs/aws-docs/providers/aws/rds/db_instances/index.md @@ -0,0 +1,106 @@ +--- +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
DescriptionThe ``AWS::RDS::DBInstance`` resource creates an Amazon DB instance. The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster.<br/> For more information about creating an RDS DB instance, see [Creating an Amazon RDS DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html) in the *Amazon RDS User Guide*.<br/> For more information about creating a DB instance in an Aurora DB cluster, see [Creating an Amazon Aurora DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.CreateInstance.html) in the *Amazon Aurora User Guide*.<br/> If you import an existing DB instance, and the template configuration doesn't match the actual configuration of the DB instance, AWS CloudFormation applies the changes in the template during the import operation.<br/> If a DB instance is deleted or replaced during an update, AWS CloudFormation deletes all automated snapshots. However, it retains manual DB snapshots. During an
Idaws.rds.db_instances
+ +## Fields + + + + + +
NameDatatypeDescription
db_instance_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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +db_instance_identifier +FROM aws.rds.db_instances +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the db_instances resource, the following permissions are required: + +### Create +```json +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 +```json +rds:DescribeDBInstances +``` + diff --git a/docs/aws-docs/providers/aws/rds/db_parameter_group/index.md b/docs/aws-docs/providers/aws/rds/db_parameter_group/index.md new file mode 100644 index 0000000000..bdb6407096 --- /dev/null +++ b/docs/aws-docs/providers/aws/rds/db_parameter_group/index.md @@ -0,0 +1,105 @@ +--- +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
DescriptionThe ``AWS::RDS::DBParameterGroup`` resource creates a custom parameter group for an RDS database family.<br/> This type can be declared in a template and referenced in the ``DBParameterGroupName`` property of an ``AWS::RDS::DBInstance`` resource.<br/> For information about configuring parameters for Amazon RDS DB instances, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*.<br/> For information about configuring parameters for Amazon Aurora DB instances, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.<br/> Applying a parameter group to a DB instance may require the DB instance to reboot, resulting in a database outage for the duration of the reboot.
Idaws.rds.db_parameter_group
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
db_parameter_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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +db_parameter_group_name, +description, +family, +parameters, +tags +FROM aws.rds.db_parameter_group +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the db_parameter_group resource, the following permissions are required: + +### Read +```json +rds:DescribeDBParameterGroups, +rds:DescribeDBParameters, +rds:DescribeEngineDefaultParameters, +rds:ListTagsForResource +``` + +### Update +```json +rds:AddTagsToResource, +rds:DescribeDBParameterGroups, +rds:DescribeDBParameters, +rds:DescribeEngineDefaultParameters, +rds:ListTagsForResource, +rds:ModifyDBParameterGroup, +rds:ResetDBParameterGroup, +rds:RemoveTagsFromResource +``` + +### Delete +```json +rds:DeleteDBParameterGroup +``` + diff --git a/docs/aws-docs/providers/aws/rds/db_parameter_groups/index.md b/docs/aws-docs/providers/aws/rds/db_parameter_groups/index.md new file mode 100644 index 0000000000..e95c4840f1 --- /dev/null +++ b/docs/aws-docs/providers/aws/rds/db_parameter_groups/index.md @@ -0,0 +1,85 @@ +--- +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
DescriptionThe ``AWS::RDS::DBParameterGroup`` resource creates a custom parameter group for an RDS database family.<br/> This type can be declared in a template and referenced in the ``DBParameterGroupName`` property of an ``AWS::RDS::DBInstance`` resource.<br/> For information about configuring parameters for Amazon RDS DB instances, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*.<br/> For information about configuring parameters for Amazon Aurora DB instances, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.<br/> Applying a parameter group to a DB instance may require the DB instance to reboot, resulting in a database outage for the duration of the reboot.
Idaws.rds.db_parameter_groups
+ +## Fields + + + + + +
NameDatatypeDescription
db_parameter_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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +db_parameter_group_name +FROM aws.rds.db_parameter_groups +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the db_parameter_groups resource, the following permissions are required: + +### Create +```json +iam:CreateServiceLinkedRole, +rds:AddTagsToResource, +rds:CreateDBParameterGroup, +rds:DescribeDBParameterGroups, +rds:DescribeDBParameters, +rds:DescribeEngineDefaultParameters, +rds:ListTagsForResource, +rds:ModifyDBParameterGroup, +rds:RemoveTagsFromResource +``` + +### List +```json +rds:DescribeDBParameterGroups +``` + diff --git a/docs/aws-docs/providers/aws/rds/db_proxies/index.md b/docs/aws-docs/providers/aws/rds/db_proxies/index.md new file mode 100644 index 0000000000..236aee4104 --- /dev/null +++ b/docs/aws-docs/providers/aws/rds/db_proxies/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource schema for AWS::RDS::DBProxy
Idaws.rds.db_proxies
+ +## Fields + + + + + +
NameDatatypeDescription
db_proxy_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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +db_proxy_name +FROM aws.rds.db_proxies +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the db_proxies resource, the following permissions are required: + +### Create +```json +rds:CreateDBProxy, +rds:DescribeDBProxies, +iam:PassRole +``` + +### List +```json +rds:DescribeDBProxies +``` + diff --git a/docs/aws-docs/providers/aws/rds/db_proxy/index.md b/docs/aws-docs/providers/aws/rds/db_proxy/index.md new file mode 100644 index 0000000000..11c974ef04 --- /dev/null +++ b/docs/aws-docs/providers/aws/rds/db_proxy/index.md @@ -0,0 +1,115 @@ +--- +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
DescriptionResource schema for AWS::RDS::DBProxy
Idaws.rds.db_proxy
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
autharrayThe authorization mechanism that the proxy uses.
db_proxy_arnstringThe Amazon Resource Name (ARN) for the proxy.
db_proxy_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_tlsbooleanA 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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +auth, +db_proxy_arn, +db_proxy_name, +debug_logging, +endpoint, +engine_family, +idle_client_timeout, +require_tls, +role_arn, +tags, +vpc_id, +vpc_security_group_ids, +vpc_subnet_ids +FROM aws.rds.db_proxy +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the db_proxy resource, the following permissions are required: + +### Read +```json +rds:DescribeDBProxies +``` + +### Update +```json +rds:ModifyDBProxy, +rds:AddTagsToResource, +rds:RemoveTagsFromResource, +iam:PassRole +``` + +### Delete +```json +rds:DescribeDBProxies, +rds:DeleteDBProxy +``` + diff --git a/docs/aws-docs/providers/aws/rds/db_proxy_endpoint/index.md b/docs/aws-docs/providers/aws/rds/db_proxy_endpoint/index.md new file mode 100644 index 0000000000..3a61799002 --- /dev/null +++ b/docs/aws-docs/providers/aws/rds/db_proxy_endpoint/index.md @@ -0,0 +1,109 @@ +--- +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
DescriptionResource schema for AWS::RDS::DBProxyEndpoint.
Idaws.rds.db_proxy_endpoint
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
db_proxy_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.
db_proxy_endpoint_arnstringThe Amazon Resource Name (ARN) for the DB proxy endpoint.
db_proxy_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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +db_proxy_endpoint_name, +db_proxy_endpoint_arn, +db_proxy_name, +vpc_id, +vpc_security_group_ids, +vpc_subnet_ids, +endpoint, +target_role, +is_default, +tags +FROM aws.rds.db_proxy_endpoint +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the db_proxy_endpoint resource, the following permissions are required: + +### Read +```json +rds:DescribeDBProxyEndpoints, +rds:ListTagsForResource +``` + +### Update +```json +rds:ModifyDBProxyEndpoint, +rds:AddTagsToResource, +rds:RemoveTagsFromResource +``` + +### Delete +```json +rds:DescribeDBProxyEndpoints, +rds:DeleteDBProxyEndpoint +``` + diff --git a/docs/aws-docs/providers/aws/rds/db_proxy_endpoints/index.md b/docs/aws-docs/providers/aws/rds/db_proxy_endpoints/index.md new file mode 100644 index 0000000000..58084c4a70 --- /dev/null +++ b/docs/aws-docs/providers/aws/rds/db_proxy_endpoints/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionResource schema for AWS::RDS::DBProxyEndpoint.
Idaws.rds.db_proxy_endpoints
+ +## Fields + + + + + +
NameDatatypeDescription
db_proxy_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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +db_proxy_endpoint_name +FROM aws.rds.db_proxy_endpoints +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the db_proxy_endpoints resource, the following permissions are required: + +### Create +```json +rds:CreateDBProxyEndpoint, +rds:DescribeDBProxyEndpoints +``` + +### List +```json +rds:DescribeDBProxyEndpoints +``` + diff --git a/docs/aws-docs/providers/aws/rds/db_proxy_target_group/index.md b/docs/aws-docs/providers/aws/rds/db_proxy_target_group/index.md new file mode 100644 index 0000000000..22029ed816 --- /dev/null +++ b/docs/aws-docs/providers/aws/rds/db_proxy_target_group/index.md @@ -0,0 +1,101 @@ +--- +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
DescriptionResource schema for AWS::RDS::DBProxyTargetGroup
Idaws.rds.db_proxy_target_group
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
db_proxy_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
db_instance_identifiersarray
db_cluster_identifiersarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +db_proxy_name, +target_group_arn, +target_group_name, +connection_pool_configuration_info, +db_instance_identifiers, +db_cluster_identifiers +FROM aws.rds.db_proxy_target_group +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the db_proxy_target_group resource, the following permissions are required: + +### Read +```json +rds:DescribeDBProxyTargetGroups, +rds:DescribeDBProxyTargets +``` + +### Update +```json +rds:DescribeDBProxyTargetGroups, +rds:ModifyDBProxyTargetGroup, +rds:RegisterDBProxyTargets, +rds:DeregisterDBProxyTargets +``` + +### Delete +```json +rds:DeregisterDBProxyTargets +``` + diff --git a/docs/aws-docs/providers/aws/rds/db_proxy_target_groups/index.md b/docs/aws-docs/providers/aws/rds/db_proxy_target_groups/index.md new file mode 100644 index 0000000000..845f69beef --- /dev/null +++ b/docs/aws-docs/providers/aws/rds/db_proxy_target_groups/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionResource schema for AWS::RDS::DBProxyTargetGroup
Idaws.rds.db_proxy_target_groups
+ +## Fields + + + + + +
NameDatatypeDescription
target_group_arnstringThe Amazon Resource Name (ARN) representing the target group.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +target_group_arn +FROM aws.rds.db_proxy_target_groups +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the db_proxy_target_groups resource, the following permissions are required: + +### Create +```json +rds:DescribeDBProxies, +rds:DescribeDBProxyTargetGroups, +rds:ModifyDBProxyTargetGroup, +rds:RegisterDBProxyTargets +``` + +### List +```json +rds:DescribeDBProxyTargetGroups +``` + diff --git a/docs/aws-docs/providers/aws/rds/db_subnet_group/index.md b/docs/aws-docs/providers/aws/rds/db_subnet_group/index.md new file mode 100644 index 0000000000..31890c5c40 --- /dev/null +++ b/docs/aws-docs/providers/aws/rds/db_subnet_group/index.md @@ -0,0 +1,100 @@ +--- +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
DescriptionThe ``AWS::RDS::DBSubnetGroup`` resource creates a database subnet group. Subnet groups must contain at least two subnets in two different Availability Zones in the same region. <br/> For more information, see [Working with DB subnet groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html#USER_VPC.Subnets) in the *Amazon RDS User Guide*.
Idaws.rds.db_subnet_group
+ +## Fields + + + + + + + + +
NameDatatypeDescription
db_subnet_group_descriptionstringThe description for the DB subnet group.
db_subnet_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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +db_subnet_group_description, +db_subnet_group_name, +subnet_ids, +tags +FROM aws.rds.db_subnet_group +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the db_subnet_group resource, the following permissions are required: + +### Read +```json +rds:DescribeDBSubnetGroups, +rds:ListTagsForResource +``` + +### Update +```json +rds:ModifyDBSubnetGroup, +rds:DescribeDBSubnetGroups, +rds:AddTagsToResource, +rds:RemoveTagsFromResource, +rds:ListTagsForResource +``` + +### Delete +```json +rds:DeleteDBSubnetGroup, +rds:DescribeDBSubnetGroups, +rds:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/rds/db_subnet_groups/index.md b/docs/aws-docs/providers/aws/rds/db_subnet_groups/index.md new file mode 100644 index 0000000000..f8057bfffe --- /dev/null +++ b/docs/aws-docs/providers/aws/rds/db_subnet_groups/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionThe ``AWS::RDS::DBSubnetGroup`` resource creates a database subnet group. Subnet groups must contain at least two subnets in two different Availability Zones in the same region. <br/> For more information, see [Working with DB subnet groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html#USER_VPC.Subnets) in the *Amazon RDS User Guide*.
Idaws.rds.db_subnet_groups
+ +## Fields + + + + + +
NameDatatypeDescription
db_subnet_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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +db_subnet_group_name +FROM aws.rds.db_subnet_groups +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the db_subnet_groups resource, the following permissions are required: + +### Create +```json +iam:CreateServiceLinkedRole, +rds:CreateDBSubnetGroup, +rds:DescribeDBSubnetGroups, +rds:AddTagsToResource, +rds:RemoveTagsFromResource, +rds:ListTagsForResource +``` + +### List +```json +rds:DescribeDBSubnetGroups +``` + diff --git a/docs/aws-docs/providers/aws/rds/event_subscription/index.md b/docs/aws-docs/providers/aws/rds/event_subscription/index.md new file mode 100644 index 0000000000..832102bfa5 --- /dev/null +++ b/docs/aws-docs/providers/aws/rds/event_subscription/index.md @@ -0,0 +1,107 @@ +--- +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
DescriptionThe AWS::RDS::EventSubscription resource allows you to receive notifications for Amazon Relational Database Service events through the Amazon Simple Notification Service (Amazon SNS). For more information, see Using Amazon RDS Event Notification in the Amazon RDS User Guide.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +tags, +subscription_name, +enabled, +event_categories, +sns_topic_arn, +source_ids, +source_type +FROM aws.rds.event_subscription +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the event_subscription resource, the following permissions are required: + +### Read +```json +rds:DescribeEventSubscriptions, +rds:ListTagsForResource +``` + +### Update +```json +rds:ModifyEventSubscription, +rds:AddSourceIdentifierToSubscription, +rds:RemoveSourceIdentifierFromSubscription, +rds:DescribeEventSubscriptions, +rds:ListTagsForResource, +rds:AddTagsToResource, +rds:RemoveTagsFromResource +``` + +### Delete +```json +rds:DeleteEventSubscription, +rds:DescribeEventSubscriptions +``` + diff --git a/docs/aws-docs/providers/aws/rds/event_subscriptions/index.md b/docs/aws-docs/providers/aws/rds/event_subscriptions/index.md new file mode 100644 index 0000000000..9104e8abf6 --- /dev/null +++ b/docs/aws-docs/providers/aws/rds/event_subscriptions/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionThe AWS::RDS::EventSubscription resource allows you to receive notifications for Amazon Relational Database Service events through the Amazon Simple Notification Service (Amazon SNS). For more information, see Using Amazon RDS Event Notification in the Amazon RDS User Guide.
Idaws.rds.event_subscriptions
+ +## Fields + + + + + +
NameDatatypeDescription
subscription_namestringThe name of the subscription.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +subscription_name +FROM aws.rds.event_subscriptions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the event_subscriptions resource, the following permissions are required: + +### Create +```json +iam:CreateServiceLinkedRole, +rds:CreateEventSubscription, +rds:DescribeEventSubscriptions, +rds:ListTagsForResource, +rds:AddTagsToResource, +rds:RemoveTagsFromResource +``` + +### List +```json +rds:DescribeEventSubscriptions +``` + diff --git a/docs/aws-docs/providers/aws/rds/global_cluster/index.md b/docs/aws-docs/providers/aws/rds/global_cluster/index.md new file mode 100644 index 0000000000..0da81985f1 --- /dev/null +++ b/docs/aws-docs/providers/aws/rds/global_cluster/index.md @@ -0,0 +1,101 @@ +--- +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
DescriptionResource Type definition for AWS::RDS::GlobalCluster
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +engine, +engine_version, +deletion_protection, +global_cluster_identifier, +source_db_cluster_identifier, +storage_encrypted +FROM aws.rds.global_cluster +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the global_cluster resource, the following permissions are required: + +### Read +```json +rds:DescribeGlobalClusters +``` + +### Update +```json +rds:ModifyGlobalCluster, +rds:DescribeGlobalClusters +``` + +### Delete +```json +rds:DescribeGlobalClusters, +rds:DeleteGlobalCluster, +rds:RemoveFromGlobalCluster, +rds:DescribeDBClusters +``` + diff --git a/docs/aws-docs/providers/aws/rds/global_clusters/index.md b/docs/aws-docs/providers/aws/rds/global_clusters/index.md new file mode 100644 index 0000000000..04d4ea444a --- /dev/null +++ b/docs/aws-docs/providers/aws/rds/global_clusters/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource Type definition for AWS::RDS::GlobalCluster
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +global_cluster_identifier +FROM aws.rds.global_clusters +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the global_clusters resource, the following permissions are required: + +### Create +```json +rds:CreateGlobalCluster, +rds:DescribeDBClusters, +rds:DescribeGlobalClusters +``` + +### List +```json +rds:DescribeGlobalClusters +``` + diff --git a/docs/aws-docs/providers/aws/rds/index.md b/docs/aws-docs/providers/aws/rds/index.md new file mode 100644 index 0000000000..9aaf4e4619 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/rds/integration/index.md b/docs/aws-docs/providers/aws/rds/integration/index.md new file mode 100644 index 0000000000..f7e160042f --- /dev/null +++ b/docs/aws-docs/providers/aws/rds/integration/index.md @@ -0,0 +1,109 @@ +--- +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
DescriptionCreates a zero-ETL integration with Amazon Redshift.
Idaws.rds.integration
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
integration_namestringThe name of the integration.
descriptionstringThe description of the integration.
tagsarrayAn array of key-value pairs to apply to this resource.
data_filterstringThe data filter for the integration.
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.
kms_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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +integration_name, +description, +tags, +data_filter, +source_arn, +target_arn, +integration_arn, +kms_key_id, +additional_encryption_context, +create_time +FROM aws.rds.integration +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the integration resource, the following permissions are required: + +### Read +```json +rds:DescribeIntegrations +``` + +### Update +```json +rds:DescribeIntegrations, +rds:AddTagsToResource, +rds:RemoveTagsFromResource, +rds:ModifyIntegration +``` + +### Delete +```json +rds:DeleteIntegration, +rds:DescribeIntegrations +``` + diff --git a/docs/aws-docs/providers/aws/rds/integrations/index.md b/docs/aws-docs/providers/aws/rds/integrations/index.md new file mode 100644 index 0000000000..e58b544588 --- /dev/null +++ b/docs/aws-docs/providers/aws/rds/integrations/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionCreates a zero-ETL integration with Amazon Redshift.
Idaws.rds.integrations
+ +## Fields + + + + + +
NameDatatypeDescription
integration_arnstringThe ARN of the integration.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +integration_arn +FROM aws.rds.integrations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the integrations resource, the following permissions are required: + +### Create +```json +rds:CreateIntegration, +rds:DescribeIntegrations, +rds:AddTagsToResource, +kms:CreateGrant, +kms:DescribeKey, +redshift:CreateInboundIntegration +``` + +### List +```json +rds:DescribeIntegrations +``` + diff --git a/docs/aws-docs/providers/aws/rds/option_group/index.md b/docs/aws-docs/providers/aws/rds/option_group/index.md new file mode 100644 index 0000000000..9ced6e5cc8 --- /dev/null +++ b/docs/aws-docs/providers/aws/rds/option_group/index.md @@ -0,0 +1,105 @@ +--- +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
DescriptionThe AWS::RDS::OptionGroup resource creates an option group, to enable and configure features that are specific to a particular DB engine.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +option_group_name, +option_group_description, +engine_name, +major_engine_version, +option_configurations, +tags +FROM aws.rds.option_group +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the option_group resource, the following permissions are required: + +### Read +```json +rds:DescribeOptionGroups, +rds:ListTagsForResource +``` + +### Update +```json +rds:AddTagsToResource, +rds:DescribeOptionGroups, +rds:ListTagsForResource, +rds:ModifyOptionGroup, +rds:RemoveTagsFromResource +``` + +### Delete +```json +rds:DeleteOptionGroup, +rds:DescribeOptionGroups, +rds:ListTagsForResource, +rds:RemoveTagsFromResource +``` + diff --git a/docs/aws-docs/providers/aws/rds/option_groups/index.md b/docs/aws-docs/providers/aws/rds/option_groups/index.md new file mode 100644 index 0000000000..2fd486314f --- /dev/null +++ b/docs/aws-docs/providers/aws/rds/option_groups/index.md @@ -0,0 +1,83 @@ +--- +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
DescriptionThe AWS::RDS::OptionGroup resource creates an option group, to enable and configure features that are specific to a particular DB engine.
Idaws.rds.option_groups
+ +## Fields + + + + + +
NameDatatypeDescription
option_group_namestringSpecifies the name of the option group.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +option_group_name +FROM aws.rds.option_groups +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the option_groups resource, the following permissions are required: + +### Create +```json +iam:CreateServiceLinkedRole, +rds:AddTagsToResource, +rds:CreateOptionGroup, +rds:DescribeOptionGroups, +rds:ListTagsForResource, +rds:ModifyOptionGroup, +rds:RemoveTagsFromResource +``` + +### List +```json +rds:DescribeOptionGroups +``` + diff --git a/docs/aws-docs/providers/aws/redshift/cluster/index.md b/docs/aws-docs/providers/aws/redshift/cluster/index.md new file mode 100644 index 0000000000..647aa09558 --- /dev/null +++ b/docs/aws-docs/providers/aws/redshift/cluster/index.md @@ -0,0 +1,228 @@ +--- +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
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Idaws.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.
db_namestringThe 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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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, +db_name, +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 aws.redshift.cluster +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the cluster resource, the following permissions are required: + +### Read +```json +redshift:DescribeClusters, +redshift:DescribeLoggingStatus, +redshift:DescribeSnapshotCopyGrant, +redshift:DescribeClusterDbRevisions, +redshift:DescribeTags, +redshift:GetResourcePolicy +``` + +### Update +```json +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 +```json +redshift:DescribeTags, +redshift:DescribeClusters, +redshift:DeleteCluster +``` + diff --git a/docs/aws-docs/providers/aws/redshift/cluster_parameter_group/index.md b/docs/aws-docs/providers/aws/redshift/cluster_parameter_group/index.md new file mode 100644 index 0000000000..3c2836755f --- /dev/null +++ b/docs/aws-docs/providers/aws/redshift/cluster_parameter_group/index.md @@ -0,0 +1,109 @@ +--- +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
DescriptionResource Type definition for AWS::Redshift::ClusterParameterGroup
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +parameter_group_name, +description, +parameter_group_family, +parameters, +tags +FROM aws.redshift.cluster_parameter_group +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the cluster_parameter_group resource, the following permissions are required: + +### Read +```json +redshift:DescribeClusterParameterGroups, +initech:DescribeReport, +redshift:DescribeClusterParameters, +redshift:DescribeTags +``` + +### Update +```json +redshift:DescribeClusterParameterGroups, +redshift:ResetClusterParameterGroup, +redshift:ModifyClusterParameterGroup, +redshift:DescribeClusterParameters, +redshift:DescribeTags, +redshift:CreateTags, +redshift:DeleteTags, +initech:UpdateReport +``` + +### Delete +```json +redshift:DescribeTags, +redshift:DescribeClusterParameterGroups, +redshift:DeleteClusterParameterGroup, +redshift:DescribeClusterParameters, +initech:DeleteReport +``` + diff --git a/docs/aws-docs/providers/aws/redshift/cluster_parameter_groups/index.md b/docs/aws-docs/providers/aws/redshift/cluster_parameter_groups/index.md new file mode 100644 index 0000000000..d6e85d802b --- /dev/null +++ b/docs/aws-docs/providers/aws/redshift/cluster_parameter_groups/index.md @@ -0,0 +1,95 @@ +--- +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
DescriptionResource Type definition for AWS::Redshift::ClusterParameterGroup
Idaws.redshift.cluster_parameter_groups
+ +## Fields + + + + + +
NameDatatypeDescription
parameter_group_namestringThe name of the cluster parameter group.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +parameter_group_name +FROM aws.redshift.cluster_parameter_groups +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the cluster_parameter_groups resource, the following permissions are required: + +### Create +```json +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 +```json +redshift:DescribeTags, +redshift:DescribeClusterParameterGroups, +redshift:DescribeClusterParameters, +initech:ListReports +``` + diff --git a/docs/aws-docs/providers/aws/redshift/cluster_subnet_group/index.md b/docs/aws-docs/providers/aws/redshift/cluster_subnet_group/index.md new file mode 100644 index 0000000000..e8b45a806f --- /dev/null +++ b/docs/aws-docs/providers/aws/redshift/cluster_subnet_group/index.md @@ -0,0 +1,130 @@ +--- +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
DescriptionSpecifies an Amazon Redshift subnet group.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +description, +subnet_ids, +tags, +cluster_subnet_group_name +FROM aws.redshift.cluster_subnet_group +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the cluster_subnet_group resource, the following permissions are required: + +### Read +```json +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 +```json +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 +```json +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 +``` + diff --git a/docs/aws-docs/providers/aws/redshift/cluster_subnet_groups/index.md b/docs/aws-docs/providers/aws/redshift/cluster_subnet_groups/index.md new file mode 100644 index 0000000000..9b17238586 --- /dev/null +++ b/docs/aws-docs/providers/aws/redshift/cluster_subnet_groups/index.md @@ -0,0 +1,101 @@ +--- +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
DescriptionSpecifies an Amazon Redshift subnet group.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +cluster_subnet_group_name +FROM aws.redshift.cluster_subnet_groups +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the cluster_subnet_groups resource, the following permissions are required: + +### Create +```json +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 +```json +redshift:DescribeClusterSubnetGroups, +redshift:DescribeTags, +ec2:AllocateAddress, +ec2:AssociateAddress, +ec2:AttachNetworkInterface, +ec2:DescribeAccountAttributes, +ec2:DescribeAddresses, +ec2:DescribeAvailabilityZones, +ec2:DescribeInternetGateways, +ec2:DescribeSecurityGroups, +ec2:DescribeSubnets, +ec2:DescribeVpcs +``` + diff --git a/docs/aws-docs/providers/aws/redshift/clusters/index.md b/docs/aws-docs/providers/aws/redshift/clusters/index.md new file mode 100644 index 0000000000..8ce2a9d5b6 --- /dev/null +++ b/docs/aws-docs/providers/aws/redshift/clusters/index.md @@ -0,0 +1,109 @@ +--- +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
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +cluster_identifier +FROM aws.redshift.clusters +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the clusters resource, the following permissions are required: + +### Create +```json +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 +```json +redshift:DescribeTags, +redshift:DescribeClusters +``` + diff --git a/docs/aws-docs/providers/aws/redshift/endpoint_access/index.md b/docs/aws-docs/providers/aws/redshift/endpoint_access/index.md new file mode 100644 index 0000000000..0617d9cf69 --- /dev/null +++ b/docs/aws-docs/providers/aws/redshift/endpoint_access/index.md @@ -0,0 +1,131 @@ +--- +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
DescriptionResource schema for a Redshift-managed VPC endpoint.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.redshift.endpoint_access +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the endpoint_access resource, the following permissions are required: + +### Read +```json +redshift:DescribeEndpointAccess, +ec2:DescribeClientVpnEndpoints, +ec2:DescribeVpcEndpoint, +ec2:DescribeVpcAttribute, +ec2:DescribeSecurityGroups, +ec2:DescribeAddresses, +ec2:DescribeInternetGateways, +ec2:DescribeSubnets +``` + +### Update +```json +redshift:DescribeEndpointAccess, +redshift:ModifyEndpointAccess, +ec2:ModifyClientVpnEndpoint, +ec2:ModifyVpcEndpoint, +ec2:DescribeVpcAttribute, +ec2:DescribeSecurityGroups, +ec2:DescribeAddresses, +ec2:DescribeInternetGateways, +ec2:DescribeSubnets +``` + +### Delete +```json +redshift:DeleteEndpointAccess, +redshift:DescribeEndpointAccess, +ec2:DeleteClientVpnEndpoint, +ec2:DeleteVpcEndpoint, +ec2:DescribeVpcAttribute, +ec2:DescribeSecurityGroups, +ec2:DescribeAddresses, +ec2:DescribeInternetGateways, +ec2:DescribeSubnets, +ec2:DescribeVpcEndpoint +``` + diff --git a/docs/aws-docs/providers/aws/redshift/endpoint_accesses/index.md b/docs/aws-docs/providers/aws/redshift/endpoint_accesses/index.md new file mode 100644 index 0000000000..4c65001306 --- /dev/null +++ b/docs/aws-docs/providers/aws/redshift/endpoint_accesses/index.md @@ -0,0 +1,92 @@ +--- +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
DescriptionResource schema for a Redshift-managed VPC endpoint.
Idaws.redshift.endpoint_accesses
+ +## Fields + + + + + +
NameDatatypeDescription
endpoint_namestringThe name of the endpoint.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +endpoint_name +FROM aws.redshift.endpoint_accesses +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the endpoint_accesses resource, the following permissions are required: + +### Create +```json +redshift:CreateEndpointAccess, +redshift:DescribeEndpointAccess, +ec2:CreateClientVpnEndpoint, +ec2:CreateVpcEndpoint, +ec2:DescribeVpcAttribute, +ec2:DescribeSecurityGroups, +ec2:DescribeAddresses, +ec2:DescribeInternetGateways, +ec2:DescribeSubnets +``` + +### List +```json +redshift:DescribeEndpointAccess, +ec2:DescribeClientVpnEndpoints, +ec2:DescribeVpcEndpoints, +ec2:DescribeVpcAttribute, +ec2:DescribeSecurityGroups, +ec2:DescribeAddresses, +ec2:DescribeInternetGateways, +ec2:DescribeSubnets +``` + diff --git a/docs/aws-docs/providers/aws/redshift/endpoint_authorization/index.md b/docs/aws-docs/providers/aws/redshift/endpoint_authorization/index.md new file mode 100644 index 0000000000..40b0d5ebe0 --- /dev/null +++ b/docs/aws-docs/providers/aws/redshift/endpoint_authorization/index.md @@ -0,0 +1,119 @@ +--- +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
DescriptionDescribes an endpoint authorization for authorizing Redshift-managed VPC endpoint access to a cluster across AWS accounts.
Idaws.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_vpcsbooleanIndicates whether all VPCs in the grantee account are allowed access to the cluster.
allowed_vpcsarrayThe 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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +grantor, +grantee, +cluster_identifier, +authorize_time, +cluster_status, +status, +allowed_all_vpcs, +allowed_vpcs, +endpoint_count, +account, +vpc_ids, +force +FROM aws.redshift.endpoint_authorization +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the endpoint_authorization resource, the following permissions are required: + +### Read +```json +redshift:DescribeEndpointAuthorization +``` + +### Update +```json +redshift:AuthorizeEndpointAccess, +redshift:DescribeEndpointAuthorization, +redshift:RevokeEndpointAccess +``` + +### Delete +```json +redshift:RevokeEndpointAccess, +redshift:DeleteEndpointAccess, +redshift:DescribeEndpointAuthorization, +ec2:DeleteClientVpnEndpoint, +ec2:DescribeVpcAttribute, +ec2:DescribeSecurityGroups, +ec2:DescribeAddresses, +ec2:DescribeInternetGateways, +ec2:DescribeSubnets +``` + diff --git a/docs/aws-docs/providers/aws/redshift/endpoint_authorizations/index.md b/docs/aws-docs/providers/aws/redshift/endpoint_authorizations/index.md new file mode 100644 index 0000000000..5a512ab8b7 --- /dev/null +++ b/docs/aws-docs/providers/aws/redshift/endpoint_authorizations/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionDescribes an endpoint authorization for authorizing Redshift-managed VPC endpoint access to a cluster across AWS accounts.
Idaws.redshift.endpoint_authorizations
+ +## Fields + + + + + + +
NameDatatypeDescription
cluster_identifierstringThe cluster identifier.
accountundefinedThe target AWS account ID to grant or revoke access for.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +cluster_identifier, +account +FROM aws.redshift.endpoint_authorizations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the endpoint_authorizations resource, the following permissions are required: + +### Create +```json +redshift:AuthorizeEndpointAccess, +redshift:DescribeEndpointAuthorization +``` + +### List +```json +redshift:DescribeEndpointAuthorization +``` + diff --git a/docs/aws-docs/providers/aws/redshift/event_subscription/index.md b/docs/aws-docs/providers/aws/redshift/event_subscription/index.md new file mode 100644 index 0000000000..8d1d434058 --- /dev/null +++ b/docs/aws-docs/providers/aws/redshift/event_subscription/index.md @@ -0,0 +1,121 @@ +--- +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
DescriptionThe `AWS::Redshift::EventSubscription` resource creates an Amazon Redshift Event Subscription.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.redshift.event_subscription +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the event_subscription resource, the following permissions are required: + +### Read +```json +redshift:DescribeEventSubscriptions, +redshift:DescribeTags +``` + +### Update +```json +redshift:ModifyEventSubscription, +redshift:CreateTags, +redshift:DescribeTags, +redshift:DescribeEventSubscriptions, +redshift:DeleteTags +``` + +### Delete +```json +redshift:DescribeEventSubscriptions, +redshift:DeleteEventSubscription, +redshift:DescribeTags, +redshift:DeleteTags +``` + diff --git a/docs/aws-docs/providers/aws/redshift/event_subscriptions/index.md b/docs/aws-docs/providers/aws/redshift/event_subscriptions/index.md new file mode 100644 index 0000000000..933df5684d --- /dev/null +++ b/docs/aws-docs/providers/aws/redshift/event_subscriptions/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionThe `AWS::Redshift::EventSubscription` resource creates an Amazon Redshift Event Subscription.
Idaws.redshift.event_subscriptions
+ +## Fields + + + + + +
NameDatatypeDescription
subscription_namestringThe name of the Amazon Redshift event notification subscription
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +subscription_name +FROM aws.redshift.event_subscriptions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the event_subscriptions resource, the following permissions are required: + +### Create +```json +redshift:CreateEventSubscription, +redshift:CreateTags, +redshift:DescribeTags, +redshift:DescribeEventSubscriptions +``` + +### List +```json +redshift:DescribeTags, +redshift:DescribeEventSubscriptions +``` + diff --git a/docs/aws-docs/providers/aws/redshift/index.md b/docs/aws-docs/providers/aws/redshift/index.md new file mode 100644 index 0000000000..2d20fbcf2c --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/redshift/scheduled_action/index.md b/docs/aws-docs/providers/aws/redshift/scheduled_action/index.md new file mode 100644 index 0000000000..7d8de62e77 --- /dev/null +++ b/docs/aws-docs/providers/aws/redshift/scheduled_action/index.md @@ -0,0 +1,114 @@ +--- +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
DescriptionThe `AWS::Redshift::ScheduledAction` resource creates an Amazon Redshift Scheduled Action.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +scheduled_action_name, +target_action, +schedule, +iam_role, +scheduled_action_description, +start_time, +end_time, +enable, +state, +next_invocations +FROM aws.redshift.scheduled_action +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the scheduled_action resource, the following permissions are required: + +### Read +```json +redshift:DescribeScheduledActions, +redshift:DescribeTags +``` + +### Update +```json +redshift:DescribeScheduledActions, +redshift:ModifyScheduledAction, +redshift:PauseCluster, +redshift:ResumeCluster, +redshift:ResizeCluster, +redshift:DescribeTags, +iam:PassRole +``` + +### Delete +```json +redshift:DescribeTags, +redshift:DescribeScheduledActions, +redshift:DeleteScheduledAction +``` + diff --git a/docs/aws-docs/providers/aws/redshift/scheduled_actions/index.md b/docs/aws-docs/providers/aws/redshift/scheduled_actions/index.md new file mode 100644 index 0000000000..6ec2d352d1 --- /dev/null +++ b/docs/aws-docs/providers/aws/redshift/scheduled_actions/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionThe `AWS::Redshift::ScheduledAction` resource creates an Amazon Redshift Scheduled Action.
Idaws.redshift.scheduled_actions
+ +## Fields + + + + + +
NameDatatypeDescription
scheduled_action_namestringThe name of the scheduled action. The name must be unique within an account.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +scheduled_action_name +FROM aws.redshift.scheduled_actions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the scheduled_actions resource, the following permissions are required: + +### Create +```json +redshift:CreateScheduledAction, +redshift:DescribeScheduledActions, +redshift:DescribeTags, +redshift:PauseCluster, +redshift:ResumeCluster, +redshift:ResizeCluster, +iam:PassRole +``` + +### List +```json +redshift:DescribeTags, +redshift:DescribeScheduledActions +``` + diff --git a/docs/aws-docs/providers/aws/redshiftserverless/index.md b/docs/aws-docs/providers/aws/redshiftserverless/index.md new file mode 100644 index 0000000000..5229288282 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/redshiftserverless/namespace/index.md b/docs/aws-docs/providers/aws/redshiftserverless/namespace/index.md new file mode 100644 index 0000000000..7362dcf31a --- /dev/null +++ b/docs/aws-docs/providers/aws/redshiftserverless/namespace/index.md @@ -0,0 +1,156 @@ +--- +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
DescriptionDefinition of AWS::RedshiftServerless::Namespace Resource Type
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.redshiftserverless.namespace +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the namespace resource, the following permissions are required: + +### Read +```json +iam:PassRole, +redshift-serverless:GetNamespace, +redshift:GetResourcePolicy, +redshift-serverless:ListSnapshotCopyConfigurations +``` + +### Update +```json +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 +```json +iam:PassRole, +redshift-serverless:DeleteNamespace, +redshift-serverless:GetNamespace, +kms:RetireGrant, +secretsmanager:DescribeSecret, +secretsmanager:DeleteSecret, +redshift:DeleteResourcePolicy +``` + diff --git a/docs/aws-docs/providers/aws/redshiftserverless/namespaces/index.md b/docs/aws-docs/providers/aws/redshiftserverless/namespaces/index.md new file mode 100644 index 0000000000..39b9775f3a --- /dev/null +++ b/docs/aws-docs/providers/aws/redshiftserverless/namespaces/index.md @@ -0,0 +1,101 @@ +--- +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
DescriptionDefinition of AWS::RedshiftServerless::Namespace Resource Type
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +namespace_name +FROM aws.redshiftserverless.namespaces +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the namespaces resource, the following permissions are required: + +### Create +```json +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 +```json +iam:PassRole, +redshift-serverless:ListNamespaces +``` + diff --git a/docs/aws-docs/providers/aws/redshiftserverless/workgroup/index.md b/docs/aws-docs/providers/aws/redshiftserverless/workgroup/index.md new file mode 100644 index 0000000000..f5b9543d90 --- /dev/null +++ b/docs/aws-docs/providers/aws/redshiftserverless/workgroup/index.md @@ -0,0 +1,135 @@ +--- +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
DescriptionDefinition of AWS::RedshiftServerless::Workgroup Resource Type
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.redshiftserverless.workgroup +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the workgroup resource, the following permissions are required: + +### Read +```json +ec2:DescribeVpcAttribute, +ec2:DescribeSecurityGroups, +ec2:DescribeAddresses, +ec2:DescribeInternetGateways, +ec2:DescribeSubnets, +ec2:DescribeAccountAttributes, +ec2:DescribeAvailabilityZones, +redshift-serverless:GetWorkgroup +``` + +### Update +```json +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 +```json +ec2:DescribeVpcAttribute, +ec2:DescribeSecurityGroups, +ec2:DescribeAddresses, +ec2:DescribeInternetGateways, +ec2:DescribeSubnets, +ec2:DescribeAccountAttributes, +ec2:DescribeAvailabilityZones, +redshift-serverless:GetWorkgroup, +redshift-serverless:DeleteWorkgroup +``` + diff --git a/docs/aws-docs/providers/aws/redshiftserverless/workgroups/index.md b/docs/aws-docs/providers/aws/redshiftserverless/workgroups/index.md new file mode 100644 index 0000000000..3ff1095b0a --- /dev/null +++ b/docs/aws-docs/providers/aws/redshiftserverless/workgroups/index.md @@ -0,0 +1,93 @@ +--- +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
DescriptionDefinition of AWS::RedshiftServerless::Workgroup Resource Type
Idaws.redshiftserverless.workgroups
+ +## Fields + + + + + +
NameDatatypeDescription
workgroup_namestringThe name of the workgroup.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +workgroup_name +FROM aws.redshiftserverless.workgroups +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the workgroups resource, the following permissions are required: + +### Create +```json +ec2:DescribeVpcAttribute, +ec2:DescribeSecurityGroups, +ec2:DescribeAddresses, +ec2:DescribeInternetGateways, +ec2:DescribeSubnets, +ec2:DescribeAccountAttributes, +ec2:DescribeAvailabilityZones, +redshift-serverless:CreateNamespace, +redshift-serverless:CreateWorkgroup, +redshift-serverless:GetWorkgroup +``` + +### List +```json +ec2:DescribeVpcAttribute, +ec2:DescribeSecurityGroups, +ec2:DescribeAddresses, +ec2:DescribeInternetGateways, +ec2:DescribeSubnets, +ec2:DescribeAccountAttributes, +ec2:DescribeAvailabilityZones, +redshift-serverless:ListWorkgroups +``` + diff --git a/docs/aws-docs/providers/aws/refactorspaces/application/index.md b/docs/aws-docs/providers/aws/refactorspaces/application/index.md new file mode 100644 index 0000000000..268a05e16d --- /dev/null +++ b/docs/aws-docs/providers/aws/refactorspaces/application/index.md @@ -0,0 +1,119 @@ +--- +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
DescriptionDefinition of AWS::RefactorSpaces::Application Resource Type
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.refactorspaces.application +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the application resource, the following permissions are required: + +### Read +```json +refactor-spaces:GetApplication, +refactor-spaces:ListTagsForResource +``` + +### Delete +```json +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* +``` + diff --git a/docs/aws-docs/providers/aws/refactorspaces/applications/index.md b/docs/aws-docs/providers/aws/refactorspaces/applications/index.md new file mode 100644 index 0000000000..ffcaf76db6 --- /dev/null +++ b/docs/aws-docs/providers/aws/refactorspaces/applications/index.md @@ -0,0 +1,105 @@ +--- +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
DescriptionDefinition of AWS::RefactorSpaces::Application Resource Type
Idaws.refactorspaces.applications
+ +## Fields + + + + + + +
NameDatatypeDescription
environment_identifierstring
application_identifierstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +environment_identifier, +application_identifier +FROM aws.refactorspaces.applications +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the applications resource, the following permissions are required: + +### Create +```json +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 +```json +refactor-spaces:ListApplications, +refactor-spaces:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/refactorspaces/environment/index.md b/docs/aws-docs/providers/aws/refactorspaces/environment/index.md new file mode 100644 index 0000000000..0de458f8e1 --- /dev/null +++ b/docs/aws-docs/providers/aws/refactorspaces/environment/index.md @@ -0,0 +1,99 @@ +--- +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
DescriptionDefinition of AWS::RefactorSpaces::Environment Resource Type
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +description, +environment_identifier, +name, +network_fabric_type, +arn, +transit_gateway_id, +tags +FROM aws.refactorspaces.environment +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the environment resource, the following permissions are required: + +### Read +```json +refactor-spaces:GetEnvironment, +refactor-spaces:ListTagsForResource +``` + +### Delete +```json +refactor-spaces:GetEnvironment, +refactor-spaces:DeleteEnvironment, +refactor-spaces:UntagResource, +ec2:DescribeTransitGateways, +ec2:DescribeTransitGatewayVpcAttachments, +ec2:DeleteTransitGateway, +ec2:DeleteTransitGatewayVpcAttachment, +ec2:DeleteTags, +ram:GetResourceShareAssociations, +ram:DeleteResourceShare +``` + diff --git a/docs/aws-docs/providers/aws/refactorspaces/environments/index.md b/docs/aws-docs/providers/aws/refactorspaces/environments/index.md new file mode 100644 index 0000000000..719a344451 --- /dev/null +++ b/docs/aws-docs/providers/aws/refactorspaces/environments/index.md @@ -0,0 +1,104 @@ +--- +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
DescriptionDefinition of AWS::RefactorSpaces::Environment Resource Type
Idaws.refactorspaces.environments
+ +## Fields + + + + + +
NameDatatypeDescription
environment_identifierstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +environment_identifier +FROM aws.refactorspaces.environments +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the environments resource, the following permissions are required: + +### Create +```json +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 +```json +refactor-spaces:ListEnvironments, +refactor-spaces:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/refactorspaces/index.md b/docs/aws-docs/providers/aws/refactorspaces/index.md new file mode 100644 index 0000000000..f760c86921 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/refactorspaces/route/index.md b/docs/aws-docs/providers/aws/refactorspaces/route/index.md new file mode 100644 index 0000000000..de3ed1cc2a --- /dev/null +++ b/docs/aws-docs/providers/aws/refactorspaces/route/index.md @@ -0,0 +1,152 @@ +--- +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
DescriptionDefinition of AWS::RefactorSpaces::Route Resource Type
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.refactorspaces.route +WHERE data__Identifier = '||'; +``` + +## Permissions + +To operate on the route resource, the following permissions are required: + +### Read +```json +refactor-spaces:GetRoute, +refactor-spaces:ListTagsForResource +``` + +### Delete +```json +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 +```json +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 +``` + diff --git a/docs/aws-docs/providers/aws/refactorspaces/routes/index.md b/docs/aws-docs/providers/aws/refactorspaces/routes/index.md new file mode 100644 index 0000000000..3250ad37c6 --- /dev/null +++ b/docs/aws-docs/providers/aws/refactorspaces/routes/index.md @@ -0,0 +1,103 @@ +--- +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
DescriptionDefinition of AWS::RefactorSpaces::Route Resource Type
Idaws.refactorspaces.routes
+ +## Fields + + + + + + + +
NameDatatypeDescription
environment_identifierstring
application_identifierstring
route_identifierstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +environment_identifier, +application_identifier, +route_identifier +FROM aws.refactorspaces.routes +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the routes resource, the following permissions are required: + +### Create +```json +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 +```json +refactor-spaces:ListRoutes, +refactor-spaces:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/refactorspaces/service/index.md b/docs/aws-docs/providers/aws/refactorspaces/service/index.md new file mode 100644 index 0000000000..237bd95746 --- /dev/null +++ b/docs/aws-docs/providers/aws/refactorspaces/service/index.md @@ -0,0 +1,110 @@ +--- +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
DescriptionDefinition of AWS::RefactorSpaces::Service Resource Type
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +application_identifier, +description, +endpoint_type, +environment_identifier, +lambda_endpoint, +name, +service_identifier, +url_endpoint, +vpc_id, +tags +FROM aws.refactorspaces.service +WHERE data__Identifier = '||'; +``` + +## Permissions + +To operate on the service resource, the following permissions are required: + +### Read +```json +refactor-spacess:GetService, +refactor-spaces:ListTagsForResource +``` + +### Delete +```json +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 +``` + diff --git a/docs/aws-docs/providers/aws/refactorspaces/services/index.md b/docs/aws-docs/providers/aws/refactorspaces/services/index.md new file mode 100644 index 0000000000..6b08c49efc --- /dev/null +++ b/docs/aws-docs/providers/aws/refactorspaces/services/index.md @@ -0,0 +1,94 @@ +--- +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
DescriptionDefinition of AWS::RefactorSpaces::Service Resource Type
Idaws.refactorspaces.services
+ +## Fields + + + + + + + +
NameDatatypeDescription
environment_identifierstring
application_identifierstring
service_identifierstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +environment_identifier, +application_identifier, +service_identifier +FROM aws.refactorspaces.services +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the services resource, the following permissions are required: + +### Create +```json +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 +```json +refactor-spaces:ListServices, +refactor-spaces:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/rekognition/collection/index.md b/docs/aws-docs/providers/aws/rekognition/collection/index.md new file mode 100644 index 0000000000..ce5ae7cef0 --- /dev/null +++ b/docs/aws-docs/providers/aws/rekognition/collection/index.md @@ -0,0 +1,95 @@ +--- +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
DescriptionThe AWS::Rekognition::Collection type creates an Amazon Rekognition Collection. A collection is a logical grouping of information about detected faces which can later be referenced for searches on the group
Idaws.rekognition.collection
+ +## Fields + + + + + + + +
NameDatatypeDescription
arnstring
collection_idstring
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +collection_id, +tags +FROM aws.rekognition.collection +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the collection resource, the following permissions are required: + +### Read +```json +rekognition:DescribeCollection, +rekognition:ListTagsForResource +``` + +### Update +```json +rekognition:TagResource, +rekognition:UntagResource, +rekognition:DescribeCollection, +rekognition:ListTagsForResource +``` + +### Delete +```json +rekognition:DeleteCollection +``` + diff --git a/docs/aws-docs/providers/aws/rekognition/collections/index.md b/docs/aws-docs/providers/aws/rekognition/collections/index.md new file mode 100644 index 0000000000..3b36e09b3c --- /dev/null +++ b/docs/aws-docs/providers/aws/rekognition/collections/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionThe AWS::Rekognition::Collection type creates an Amazon Rekognition Collection. A collection is a logical grouping of information about detected faces which can later be referenced for searches on the group
Idaws.rekognition.collections
+ +## Fields + + + + + +
NameDatatypeDescription
collection_idundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +collection_id +FROM aws.rekognition.collections +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the collections resource, the following permissions are required: + +### Create +```json +rekognition:CreateCollection, +rekognition:DescribeCollection, +rekognition:ListTagsForResource, +rekognition:TagResource +``` + +### List +```json +rekognition:ListCollections +``` + diff --git a/docs/aws-docs/providers/aws/rekognition/index.md b/docs/aws-docs/providers/aws/rekognition/index.md new file mode 100644 index 0000000000..40c4ebea81 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/rekognition/project/index.md b/docs/aws-docs/providers/aws/rekognition/project/index.md new file mode 100644 index 0000000000..28c6ef96fd --- /dev/null +++ b/docs/aws-docs/providers/aws/rekognition/project/index.md @@ -0,0 +1,85 @@ +--- +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
DescriptionThe AWS::Rekognition::Project type creates an Amazon Rekognition CustomLabels Project. A project is a grouping of the resources needed to create and manage Dataset and ProjectVersions.
Idaws.rekognition.project
+ +## Fields + + + + + + +
NameDatatypeDescription
arnstring
project_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +project_name +FROM aws.rekognition.project +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the project resource, the following permissions are required: + +### Read +```json +rekognition:DescribeProjects +``` + +### Delete +```json +rekognition:DescribeProjects, +rekognition:DeleteProject +``` + diff --git a/docs/aws-docs/providers/aws/rekognition/projects/index.md b/docs/aws-docs/providers/aws/rekognition/projects/index.md new file mode 100644 index 0000000000..52f8c460b3 --- /dev/null +++ b/docs/aws-docs/providers/aws/rekognition/projects/index.md @@ -0,0 +1,77 @@ +--- +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
DescriptionThe AWS::Rekognition::Project type creates an Amazon Rekognition CustomLabels Project. A project is a grouping of the resources needed to create and manage Dataset and ProjectVersions.
Idaws.rekognition.projects
+ +## Fields + + + + + +
NameDatatypeDescription
project_nameundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +project_name +FROM aws.rekognition.projects +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the projects resource, the following permissions are required: + +### Create +```json +rekognition:CreateProject +``` + +### List +```json +rekognition:DescribeProjects +``` + diff --git a/docs/aws-docs/providers/aws/rekognition/stream_processor/index.md b/docs/aws-docs/providers/aws/rekognition/stream_processor/index.md new file mode 100644 index 0000000000..ac1fb585c6 --- /dev/null +++ b/docs/aws-docs/providers/aws/rekognition/stream_processor/index.md @@ -0,0 +1,121 @@ +--- +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
DescriptionThe AWS::Rekognition::StreamProcessor type is used to create an Amazon Rekognition StreamProcessor that you can use to analyze streaming videos.<br/><br/>
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.rekognition.stream_processor +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the stream_processor resource, the following permissions are required: + +### Read +```json +rekognition:DescribeStreamProcessor, +rekognition:ListTagsForResource +``` + +### Update +```json +rekognition:TagResource, +rekognition:UntagResource, +rekognition:ListTagsForResource, +rekognition:DescribeStreamProcessor +``` + +### Delete +```json +rekognition:DeleteStreamProcessor +``` + diff --git a/docs/aws-docs/providers/aws/rekognition/stream_processors/index.md b/docs/aws-docs/providers/aws/rekognition/stream_processors/index.md new file mode 100644 index 0000000000..aa8bf8fac7 --- /dev/null +++ b/docs/aws-docs/providers/aws/rekognition/stream_processors/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionThe AWS::Rekognition::StreamProcessor type is used to create an Amazon Rekognition StreamProcessor that you can use to analyze streaming videos.<br/><br/>
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.rekognition.stream_processors +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the stream_processors resource, the following permissions are required: + +### Create +```json +rekognition:CreateStreamProcessor, +iam:PassRole, +rekognition:DescribeStreamProcessor, +rekognition:ListTagsForResource, +rekognition:TagResource +``` + +### List +```json +rekognition:ListStreamProcessors +``` + diff --git a/docs/aws-docs/providers/aws/resiliencehub/app/index.md b/docs/aws-docs/providers/aws/resiliencehub/app/index.md new file mode 100644 index 0000000000..923837f337 --- /dev/null +++ b/docs/aws-docs/providers/aws/resiliencehub/app/index.md @@ -0,0 +1,131 @@ +--- +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
DescriptionResource Type Definition for AWS::ResilienceHub::App.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.resiliencehub.app +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the app resource, the following permissions are required: + +### Read +```json +resiliencehub:DescribeApp, +resiliencehub:DescribeAppVersionTemplate, +resiliencehub:ListAppVersionResourceMappings, +resiliencehub:ListTagsForResource +``` + +### Update +```json +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 +```json +resiliencehub:DeleteApp, +resiliencehub:UntagResource, +resiliencehub:ListApps +``` + diff --git a/docs/aws-docs/providers/aws/resiliencehub/apps/index.md b/docs/aws-docs/providers/aws/resiliencehub/apps/index.md new file mode 100644 index 0000000000..420ec91062 --- /dev/null +++ b/docs/aws-docs/providers/aws/resiliencehub/apps/index.md @@ -0,0 +1,96 @@ +--- +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
DescriptionResource Type Definition for AWS::ResilienceHub::App.
Idaws.resiliencehub.apps
+ +## Fields + + + + + +
NameDatatypeDescription
app_arnstringAmazon Resource Name (ARN) of the App.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +app_arn +FROM aws.resiliencehub.apps +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the apps resource, the following permissions are required: + +### Create +```json +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 +```json +resiliencehub:ListApps +``` + diff --git a/docs/aws-docs/providers/aws/resiliencehub/index.md b/docs/aws-docs/providers/aws/resiliencehub/index.md new file mode 100644 index 0000000000..ce8503dc29 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/resiliencehub/resiliency_policies/index.md b/docs/aws-docs/providers/aws/resiliencehub/resiliency_policies/index.md new file mode 100644 index 0000000000..5bc9f03622 --- /dev/null +++ b/docs/aws-docs/providers/aws/resiliencehub/resiliency_policies/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource Type Definition for Resiliency Policy.
Idaws.resiliencehub.resiliency_policies
+ +## Fields + + + + + +
NameDatatypeDescription
policy_arnstringAmazon Resource Name (ARN) of the Resiliency Policy.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +policy_arn +FROM aws.resiliencehub.resiliency_policies +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the resiliency_policies resource, the following permissions are required: + +### Create +```json +resiliencehub:CreateResiliencyPolicy, +resiliencehub:DescribeResiliencyPolicy, +resiliencehub:TagResource +``` + +### List +```json +resiliencehub:ListResiliencyPolicies +``` + diff --git a/docs/aws-docs/providers/aws/resiliencehub/resiliency_policy/index.md b/docs/aws-docs/providers/aws/resiliencehub/resiliency_policy/index.md new file mode 100644 index 0000000000..21f69f86c7 --- /dev/null +++ b/docs/aws-docs/providers/aws/resiliencehub/resiliency_policy/index.md @@ -0,0 +1,105 @@ +--- +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
DescriptionResource Type Definition for Resiliency Policy.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +policy_name, +policy_description, +data_location_constraint, +tier, +policy, +policy_arn, +tags +FROM aws.resiliencehub.resiliency_policy +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the resiliency_policy resource, the following permissions are required: + +### Update +```json +resiliencehub:DescribeResiliencyPolicy, +resiliencehub:UpdateResiliencyPolicy, +resiliencehub:TagResource, +resiliencehub:UntagResource, +resiliencehub:ListTagsForResource +``` + +### Read +```json +resiliencehub:DescribeResiliencyPolicy, +resiliencehub:ListTagsForResource +``` + +### Delete +```json +resiliencehub:DeleteResiliencyPolicy, +resiliencehub:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/resourceexplorer2/default_view_association/index.md b/docs/aws-docs/providers/aws/resourceexplorer2/default_view_association/index.md new file mode 100644 index 0000000000..1b0d0e87c2 --- /dev/null +++ b/docs/aws-docs/providers/aws/resourceexplorer2/default_view_association/index.md @@ -0,0 +1,91 @@ +--- +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
DescriptionDefinition of AWS::ResourceExplorer2::DefaultViewAssociation Resource Type
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +view_arn, +associated_aws_principal +FROM aws.resourceexplorer2.default_view_association +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the default_view_association resource, the following permissions are required: + +### Update +```json +resource-explorer-2:GetDefaultView, +resource-explorer-2:AssociateDefaultView +``` + +### Read +```json +resource-explorer-2:GetDefaultView +``` + +### Delete +```json +resource-explorer-2:GetDefaultView, +resource-explorer-2:DisassociateDefaultView +``` + diff --git a/docs/aws-docs/providers/aws/resourceexplorer2/default_view_associations/index.md b/docs/aws-docs/providers/aws/resourceexplorer2/default_view_associations/index.md new file mode 100644 index 0000000000..a44dd198f9 --- /dev/null +++ b/docs/aws-docs/providers/aws/resourceexplorer2/default_view_associations/index.md @@ -0,0 +1,68 @@ +--- +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
DescriptionDefinition of AWS::ResourceExplorer2::DefaultViewAssociation Resource Type
Idaws.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 + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +associated_aws_principal +FROM aws.resourceexplorer2.default_view_associations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the default_view_associations resource, the following permissions are required: + +### Create +```json +resource-explorer-2:GetDefaultView, +resource-explorer-2:AssociateDefaultView +``` + diff --git a/docs/aws-docs/providers/aws/resourceexplorer2/index.md b/docs/aws-docs/providers/aws/resourceexplorer2/index.md new file mode 100644 index 0000000000..f4f81860ef --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/resourceexplorer2/index/index.md b/docs/aws-docs/providers/aws/resourceexplorer2/index/index.md new file mode 100644 index 0000000000..87cfcaf0b8 --- /dev/null +++ b/docs/aws-docs/providers/aws/resourceexplorer2/index/index.md @@ -0,0 +1,99 @@ +--- +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
DescriptionDefinition of AWS::ResourceExplorer2::Index Resource Type
Idaws.resourceexplorer2.index
+ +## Fields + + + + + + + + +
NameDatatypeDescription
arnstring
tagsobject
typestring
index_statestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +tags, +type, +index_state +FROM aws.resourceexplorer2.index +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the index resource, the following permissions are required: + +### Update +```json +resource-explorer-2:GetIndex, +resource-explorer-2:UpdateIndexType, +resource-explorer-2:TagResource, +resource-explorer-2:UntagResource, +resource-explorer-2:ListTagsForResource +``` + +### Delete +```json +resource-explorer-2:DeleteIndex, +resource-explorer-2:GetIndex, +resource-explorer-2:UntagResource +``` + +### Read +```json +resource-explorer-2:GetIndex +``` + diff --git a/docs/aws-docs/providers/aws/resourceexplorer2/indices/index.md b/docs/aws-docs/providers/aws/resourceexplorer2/indices/index.md new file mode 100644 index 0000000000..70f8978e26 --- /dev/null +++ b/docs/aws-docs/providers/aws/resourceexplorer2/indices/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionDefinition of AWS::ResourceExplorer2::Index Resource Type
Idaws.resourceexplorer2.indices
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.resourceexplorer2.indices +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the indices resource, the following permissions are required: + +### Create +```json +resource-explorer-2:CreateIndex, +resource-explorer-2:GetIndex, +resource-explorer-2:TagResource, +resource-explorer-2:UpdateIndexType, +resource-explorer-2:DeleteIndex, +iam:CreateServiceLinkedRole +``` + +### List +```json +resource-explorer-2:ListIndexes +``` + diff --git a/docs/aws-docs/providers/aws/resourceexplorer2/view/index.md b/docs/aws-docs/providers/aws/resourceexplorer2/view/index.md new file mode 100644 index 0000000000..c08f24607e --- /dev/null +++ b/docs/aws-docs/providers/aws/resourceexplorer2/view/index.md @@ -0,0 +1,102 @@ +--- +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
DescriptionDefinition of AWS::ResourceExplorer2::View Resource Type
Idaws.resourceexplorer2.view
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
filtersobject
included_propertiesarray
scopestring
tagsobject
view_arnstring
view_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +filters, +included_properties, +scope, +tags, +view_arn, +view_name +FROM aws.resourceexplorer2.view +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the view resource, the following permissions are required: + +### Read +```json +resource-explorer-2:GetView +``` + +### Update +```json +resource-explorer-2:UpdateView, +resource-explorer-2:TagResource, +resource-explorer-2:UntagResource, +resource-explorer-2:ListTagsForResource +``` + +### Delete +```json +resource-explorer-2:DeleteView, +resource-explorer-2:GetView, +resource-explorer-2:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/resourceexplorer2/views/index.md b/docs/aws-docs/providers/aws/resourceexplorer2/views/index.md new file mode 100644 index 0000000000..97ffc87b29 --- /dev/null +++ b/docs/aws-docs/providers/aws/resourceexplorer2/views/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionDefinition of AWS::ResourceExplorer2::View Resource Type
Idaws.resourceexplorer2.views
+ +## Fields + + + + + +
NameDatatypeDescription
view_arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +view_arn +FROM aws.resourceexplorer2.views +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the views resource, the following permissions are required: + +### Create +```json +resource-explorer-2:CreateView, +resource-explorer-2:TagResource +``` + +### List +```json +resource-explorer-2:ListViews +``` + diff --git a/docs/aws-docs/providers/aws/resourcegroups/group/index.md b/docs/aws-docs/providers/aws/resourcegroups/group/index.md new file mode 100644 index 0000000000..fea6f870be --- /dev/null +++ b/docs/aws-docs/providers/aws/resourcegroups/group/index.md @@ -0,0 +1,114 @@ +--- +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
DescriptionSchema for ResourceGroups::Group
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +description, +resource_query, +tags, +arn, +configuration, +resources +FROM aws.resourcegroups.group +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the group resource, the following permissions are required: + +### Read +```json +resource-groups:GetGroup, +resource-groups:GetGroupQuery, +resource-groups:GetTags, +resource-groups:GetGroupConfiguration, +resource-groups:ListGroupResources +``` + +### Update +```json +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 +```json +resource-groups:DeleteGroup, +resource-groups:UnGroupResources +``` + diff --git a/docs/aws-docs/providers/aws/resourcegroups/groups/index.md b/docs/aws-docs/providers/aws/resourcegroups/groups/index.md new file mode 100644 index 0000000000..55476c2296 --- /dev/null +++ b/docs/aws-docs/providers/aws/resourcegroups/groups/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionSchema for ResourceGroups::Group
Idaws.resourcegroups.groups
+ +## Fields + + + + + +
NameDatatypeDescription
namestringThe name of the resource group
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.resourcegroups.groups +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the groups resource, the following permissions are required: + +### Create +```json +resource-groups:CreateGroup, +resource-groups:Tag, +cloudformation:DescribeStacks, +cloudformation:ListStackResources, +resource-groups:ListGroupResources, +resource-groups:GroupResources +``` + +### List +```json +resource-groups:ListGroups +``` + diff --git a/docs/aws-docs/providers/aws/resourcegroups/index.md b/docs/aws-docs/providers/aws/resourcegroups/index.md new file mode 100644 index 0000000000..0639cc35ee --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/robomaker/fleet/index.md b/docs/aws-docs/providers/aws/robomaker/fleet/index.md new file mode 100644 index 0000000000..b64e2af1a4 --- /dev/null +++ b/docs/aws-docs/providers/aws/robomaker/fleet/index.md @@ -0,0 +1,92 @@ +--- +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
DescriptionAWS::RoboMaker::Fleet resource creates an AWS RoboMaker fleet. Fleets contain robots and can receive deployments.
Idaws.robomaker.fleet
+ +## Fields + + + + + + + +
NameDatatypeDescription
arnstring
tagsobject
namestringThe name of the fleet.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +tags, +name +FROM aws.robomaker.fleet +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the fleet resource, the following permissions are required: + +### Read +```json +robomaker:DescribeFleet +``` + +### Delete +```json +robomaker:DeleteFleet +``` + +### Update +```json +robomaker:TagResource, +robomaker:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/robomaker/fleets/index.md b/docs/aws-docs/providers/aws/robomaker/fleets/index.md new file mode 100644 index 0000000000..3b806121f6 --- /dev/null +++ b/docs/aws-docs/providers/aws/robomaker/fleets/index.md @@ -0,0 +1,77 @@ +--- +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
DescriptionAWS::RoboMaker::Fleet resource creates an AWS RoboMaker fleet. Fleets contain robots and can receive deployments.
Idaws.robomaker.fleets
+ +## Fields + + + + + +
NameDatatypeDescription
arnundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.robomaker.fleets +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the fleets resource, the following permissions are required: + +### Create +```json +robomaker:CreateFleet +``` + +### List +```json +robomaker:ListFleets +``` + diff --git a/docs/aws-docs/providers/aws/robomaker/index.md b/docs/aws-docs/providers/aws/robomaker/index.md new file mode 100644 index 0000000000..a8ed0d88d6 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/robomaker/robot/index.md b/docs/aws-docs/providers/aws/robomaker/robot/index.md new file mode 100644 index 0000000000..aa5bf60f02 --- /dev/null +++ b/docs/aws-docs/providers/aws/robomaker/robot/index.md @@ -0,0 +1,100 @@ +--- +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
DescriptionAWS::RoboMaker::Robot resource creates an AWS RoboMaker Robot.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +fleet, +architecture, +greengrass_group_id, +tags, +name +FROM aws.robomaker.robot +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the robot resource, the following permissions are required: + +### Read +```json +robomaker:DescribeRobot +``` + +### Delete +```json +robomaker:DescribeRobot, +robomaker:DeleteRobot, +robomaker:DeregisterRobot +``` + +### Update +```json +robomaker:TagResource, +robomaker:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/robomaker/robot_application/index.md b/docs/aws-docs/providers/aws/robomaker/robot_application/index.md new file mode 100644 index 0000000000..3baeb7ee5d --- /dev/null +++ b/docs/aws-docs/providers/aws/robomaker/robot_application/index.md @@ -0,0 +1,106 @@ +--- +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
DescriptionThis schema is for testing purpose only.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +sources, +environment, +robot_software_suite, +current_revision_id, +arn, +tags +FROM aws.robomaker.robot_application +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the robot_application resource, the following permissions are required: + +### Read +```json +robomaker:DescribeRobotApplication +``` + +### Update +```json +robomaker:TagResource, +robomaker:UntagResource, +robomaker:UpdateRobotApplication, +ecr:BatchGetImage, +ecr:GetAuthorizationToken, +ecr:BatchCheckLayerAvailability, +ecr-public:GetAuthorizationToken +``` + +### Delete +```json +robomaker:DescribeRobotApplication, +robomaker:DeleteRobotApplication +``` + diff --git a/docs/aws-docs/providers/aws/robomaker/robot_application_version/index.md b/docs/aws-docs/providers/aws/robomaker/robot_application_version/index.md new file mode 100644 index 0000000000..ca8c750901 --- /dev/null +++ b/docs/aws-docs/providers/aws/robomaker/robot_application_version/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionAWS::RoboMaker::RobotApplicationVersion resource creates an AWS RoboMaker RobotApplicationVersion. This helps you control which code your robot uses.
Idaws.robomaker.robot_application_version
+ +## Fields + + + + + + + + +
NameDatatypeDescription
applicationstring
current_revision_idstringThe revision ID of robot application.
application_versionstring
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +application, +current_revision_id, +application_version, +arn +FROM aws.robomaker.robot_application_version +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the robot_application_version resource, the following permissions are required: + +### Delete +```json +robomaker:DeleteRobotApplication, +robomaker:DescribeRobotApplication +``` + +### Read +```json +robomaker:DescribeRobotApplication +``` + diff --git a/docs/aws-docs/providers/aws/robomaker/robot_application_versions/index.md b/docs/aws-docs/providers/aws/robomaker/robot_application_versions/index.md new file mode 100644 index 0000000000..bdaf32eed4 --- /dev/null +++ b/docs/aws-docs/providers/aws/robomaker/robot_application_versions/index.md @@ -0,0 +1,73 @@ +--- +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
DescriptionAWS::RoboMaker::RobotApplicationVersion resource creates an AWS RoboMaker RobotApplicationVersion. This helps you control which code your robot uses.
Idaws.robomaker.robot_application_versions
+ +## Fields + + + + + +
NameDatatypeDescription
arnundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.robomaker.robot_application_versions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the robot_application_versions resource, the following permissions are required: + +### Create +```json +robomaker:CreateRobotApplicationVersion, +s3:GetObject, +ecr:BatchGetImage, +ecr:GetAuthorizationToken, +ecr:BatchCheckLayerAvailability, +ecr-public:GetAuthorizationToken, +sts:GetServiceBearerToken +``` + diff --git a/docs/aws-docs/providers/aws/robomaker/robot_applications/index.md b/docs/aws-docs/providers/aws/robomaker/robot_applications/index.md new file mode 100644 index 0000000000..d4a69969b0 --- /dev/null +++ b/docs/aws-docs/providers/aws/robomaker/robot_applications/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionThis schema is for testing purpose only.
Idaws.robomaker.robot_applications
+ +## Fields + + + + + +
NameDatatypeDescription
arnundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.robomaker.robot_applications +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the robot_applications resource, the following permissions are required: + +### Create +```json +robomaker:CreateRobotApplication, +robomaker:TagResource, +robomaker:UntagResource, +ecr:BatchGetImage, +ecr:GetAuthorizationToken, +ecr:BatchCheckLayerAvailability, +ecr-public:GetAuthorizationToken, +sts:GetServiceBearerToken +``` + +### List +```json +robomaker:ListRobotApplications +``` + diff --git a/docs/aws-docs/providers/aws/robomaker/robots/index.md b/docs/aws-docs/providers/aws/robomaker/robots/index.md new file mode 100644 index 0000000000..769982e5c9 --- /dev/null +++ b/docs/aws-docs/providers/aws/robomaker/robots/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionAWS::RoboMaker::Robot resource creates an AWS RoboMaker Robot.
Idaws.robomaker.robots
+ +## Fields + + + + + +
NameDatatypeDescription
arnundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.robomaker.robots +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the robots resource, the following permissions are required: + +### Create +```json +robomaker:CreateRobot, +robomaker:RegisterRobot +``` + +### List +```json +robomaker:ListRobots +``` + diff --git a/docs/aws-docs/providers/aws/robomaker/simulation_application/index.md b/docs/aws-docs/providers/aws/robomaker/simulation_application/index.md new file mode 100644 index 0000000000..73f08cca24 --- /dev/null +++ b/docs/aws-docs/providers/aws/robomaker/simulation_application/index.md @@ -0,0 +1,110 @@ +--- +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
DescriptionThis schema is for testing purpose only.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +name, +current_revision_id, +rendering_engine, +robot_software_suite, +simulation_software_suite, +sources, +environment, +tags +FROM aws.robomaker.simulation_application +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the simulation_application resource, the following permissions are required: + +### Read +```json +robomaker:DescribeSimulationApplication +``` + +### Update +```json +robomaker:TagResource, +robomaker:UntagResource, +robomaker:UpdateSimulationApplication, +ecr:BatchGetImage, +ecr:GetAuthorizationToken, +ecr:BatchCheckLayerAvailability, +ecr-public:GetAuthorizationToken +``` + +### Delete +```json +robomaker:DescribeSimulationApplication, +robomaker:DeleteSimulationApplication +``` + diff --git a/docs/aws-docs/providers/aws/robomaker/simulation_application_version/index.md b/docs/aws-docs/providers/aws/robomaker/simulation_application_version/index.md new file mode 100644 index 0000000000..2283e9de19 --- /dev/null +++ b/docs/aws-docs/providers/aws/robomaker/simulation_application_version/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionAWS::RoboMaker::SimulationApplicationVersion resource creates an AWS RoboMaker SimulationApplicationVersion. This helps you control which code your simulation uses.
Idaws.robomaker.simulation_application_version
+ +## Fields + + + + + + + + +
NameDatatypeDescription
applicationstring
current_revision_idstringThe revision ID of robot application.
application_versionstring
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +application, +current_revision_id, +application_version, +arn +FROM aws.robomaker.simulation_application_version +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the simulation_application_version resource, the following permissions are required: + +### Delete +```json +robomaker:DeleteSimulationApplication, +robomaker:DescribeSimulationApplication +``` + +### Read +```json +robomaker:DescribeSimulationApplication +``` + diff --git a/docs/aws-docs/providers/aws/robomaker/simulation_application_versions/index.md b/docs/aws-docs/providers/aws/robomaker/simulation_application_versions/index.md new file mode 100644 index 0000000000..91874f6411 --- /dev/null +++ b/docs/aws-docs/providers/aws/robomaker/simulation_application_versions/index.md @@ -0,0 +1,73 @@ +--- +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
DescriptionAWS::RoboMaker::SimulationApplicationVersion resource creates an AWS RoboMaker SimulationApplicationVersion. This helps you control which code your simulation uses.
Idaws.robomaker.simulation_application_versions
+ +## Fields + + + + + +
NameDatatypeDescription
arnundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.robomaker.simulation_application_versions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the simulation_application_versions resource, the following permissions are required: + +### Create +```json +robomaker:CreateSimulationApplicationVersion, +s3:GetObject, +ecr:BatchGetImage, +ecr:GetAuthorizationToken, +ecr:BatchCheckLayerAvailability, +ecr-public:GetAuthorizationToken, +sts:GetServiceBearerToken +``` + diff --git a/docs/aws-docs/providers/aws/robomaker/simulation_applications/index.md b/docs/aws-docs/providers/aws/robomaker/simulation_applications/index.md new file mode 100644 index 0000000000..c6d58820b8 --- /dev/null +++ b/docs/aws-docs/providers/aws/robomaker/simulation_applications/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionThis schema is for testing purpose only.
Idaws.robomaker.simulation_applications
+ +## Fields + + + + + +
NameDatatypeDescription
arnundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.robomaker.simulation_applications +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the simulation_applications resource, the following permissions are required: + +### Create +```json +robomaker:CreateSimulationApplication, +robomaker:TagResource, +robomaker:UntagResource, +ecr:BatchGetImage, +ecr:GetAuthorizationToken, +ecr:BatchCheckLayerAvailability, +ecr-public:GetAuthorizationToken, +sts:GetServiceBearerToken +``` + +### List +```json +robomaker:ListSimulationApplications +``` + diff --git a/docs/aws-docs/providers/aws/rolesanywhere/crl/index.md b/docs/aws-docs/providers/aws/rolesanywhere/crl/index.md new file mode 100644 index 0000000000..f8ddea940a --- /dev/null +++ b/docs/aws-docs/providers/aws/rolesanywhere/crl/index.md @@ -0,0 +1,103 @@ +--- +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
DescriptionDefinition of AWS::RolesAnywhere::CRL Resource Type
Idaws.rolesanywhere.crl
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
crl_datastring
crl_idstring
enabledboolean
namestring
trust_anchor_arnstring
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +crl_data, +crl_id, +enabled, +name, +trust_anchor_arn, +tags +FROM aws.rolesanywhere.crl +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the crl resource, the following permissions are required: + +### Read +```json +rolesanywhere:GetCrl, +rolesanywhere:ListTagsForResource +``` + +### Update +```json +rolesanywhere:EnableCrl, +rolesanywhere:DisableCrl, +rolesanywhere:UpdateCrl, +rolesanywhere:TagResource, +rolesanywhere:UntagResource, +rolesanywhere:ListTagsForResource +``` + +### Delete +```json +rolesanywhere:DeleteCrl +``` + diff --git a/docs/aws-docs/providers/aws/rolesanywhere/crls/index.md b/docs/aws-docs/providers/aws/rolesanywhere/crls/index.md new file mode 100644 index 0000000000..64551cea62 --- /dev/null +++ b/docs/aws-docs/providers/aws/rolesanywhere/crls/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionDefinition of AWS::RolesAnywhere::CRL Resource Type
Idaws.rolesanywhere.crls
+ +## Fields + + + + + +
NameDatatypeDescription
crl_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +crl_id +FROM aws.rolesanywhere.crls +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the crls resource, the following permissions are required: + +### Create +```json +rolesanywhere:ImportCrl, +rolesanywhere:TagResource, +rolesanywhere:ListTagsForResource +``` + +### List +```json +rolesanywhere:ListCrls, +rolesanywhere:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/rolesanywhere/index.md b/docs/aws-docs/providers/aws/rolesanywhere/index.md new file mode 100644 index 0000000000..d65f0f1ee2 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/rolesanywhere/profile/index.md b/docs/aws-docs/providers/aws/rolesanywhere/profile/index.md new file mode 100644 index 0000000000..6aa607275b --- /dev/null +++ b/docs/aws-docs/providers/aws/rolesanywhere/profile/index.md @@ -0,0 +1,114 @@ +--- +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
DescriptionDefinition of AWS::RolesAnywhere::Profile Resource Type
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +duration_seconds, +enabled, +managed_policy_arns, +name, +profile_arn, +profile_id, +require_instance_properties, +role_arns, +session_policy, +tags +FROM aws.rolesanywhere.profile +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the profile resource, the following permissions are required: + +### Read +```json +rolesanywhere:GetProfile, +rolesanywhere:ListTagsForResource +``` + +### Update +```json +iam:GetRole, +iam:GetPolicy, +iam:PassRole, +rolesanywhere:UpdateProfile, +rolesanywhere:EnableProfile, +rolesanywhere:DisableProfile, +rolesanywhere:TagResource, +rolesanywhere:UntagResource, +rolesanywhere:ListTagsForResource +``` + +### Delete +```json +rolesanywhere:DeleteProfile +``` + diff --git a/docs/aws-docs/providers/aws/rolesanywhere/profiles/index.md b/docs/aws-docs/providers/aws/rolesanywhere/profiles/index.md new file mode 100644 index 0000000000..b3bf5cfb02 --- /dev/null +++ b/docs/aws-docs/providers/aws/rolesanywhere/profiles/index.md @@ -0,0 +1,83 @@ +--- +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
DescriptionDefinition of AWS::RolesAnywhere::Profile Resource Type
Idaws.rolesanywhere.profiles
+ +## Fields + + + + + +
NameDatatypeDescription
profile_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +profile_id +FROM aws.rolesanywhere.profiles +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the profiles resource, the following permissions are required: + +### Create +```json +iam:GetRole, +iam:GetPolicy, +iam:PassRole, +rolesanywhere:CreateProfile, +rolesanywhere:TagResource, +rolesanywhere:ListTagsForResource +``` + +### List +```json +rolesanywhere:ListProfiles, +rolesanywhere:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/rolesanywhere/trust_anchor/index.md b/docs/aws-docs/providers/aws/rolesanywhere/trust_anchor/index.md new file mode 100644 index 0000000000..4fbda55ed0 --- /dev/null +++ b/docs/aws-docs/providers/aws/rolesanywhere/trust_anchor/index.md @@ -0,0 +1,109 @@ +--- +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
DescriptionDefinition of AWS::RolesAnywhere::TrustAnchor Resource Type.
Idaws.rolesanywhere.trust_anchor
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
enabledboolean
namestring
notification_settingsarray
sourceobject
tagsarray
trust_anchor_idstring
trust_anchor_arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +enabled, +name, +notification_settings, +source, +tags, +trust_anchor_id, +trust_anchor_arn +FROM aws.rolesanywhere.trust_anchor +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the trust_anchor resource, the following permissions are required: + +### Read +```json +rolesanywhere:GetTrustAnchor, +rolesanywhere:ListTagsForResource +``` + +### Update +```json +acm-pca:GetCertificateAuthorityCertificate, +rolesanywhere:ListTagsForResource, +rolesanywhere:TagResource, +rolesanywhere:UntagResource, +rolesanywhere:EnableTrustAnchor, +rolesanywhere:DisableTrustAnchor, +rolesanywhere:UpdateTrustAnchor, +rolesanywhere:GetTrustAnchor, +rolesanywhere:PutNotificationSettings, +rolesanywhere:ResetNotificationSettings +``` + +### Delete +```json +rolesanywhere:DeleteTrustAnchor +``` + diff --git a/docs/aws-docs/providers/aws/rolesanywhere/trust_anchors/index.md b/docs/aws-docs/providers/aws/rolesanywhere/trust_anchors/index.md new file mode 100644 index 0000000000..d56cb5c4aa --- /dev/null +++ b/docs/aws-docs/providers/aws/rolesanywhere/trust_anchors/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionDefinition of AWS::RolesAnywhere::TrustAnchor Resource Type.
Idaws.rolesanywhere.trust_anchors
+ +## Fields + + + + + +
NameDatatypeDescription
trust_anchor_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +trust_anchor_id +FROM aws.rolesanywhere.trust_anchors +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the trust_anchors resource, the following permissions are required: + +### Create +```json +iam:CreateServiceLinkedRole, +rolesanywhere:CreateTrustAnchor, +rolesanywhere:TagResource, +rolesanywhere:ListTagsForResource +``` + +### List +```json +rolesanywhere:ListTrustAnchors, +rolesanywhere:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/route53/cidr_collection/index.md b/docs/aws-docs/providers/aws/route53/cidr_collection/index.md new file mode 100644 index 0000000000..56bcbed663 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53/cidr_collection/index.md @@ -0,0 +1,95 @@ +--- +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
DescriptionResource schema for AWS::Route53::CidrCollection.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +name, +arn, +locations +FROM aws.route53.cidr_collection +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the cidr_collection resource, the following permissions are required: + +### Read +```json +route53:ListCidrCollections, +route53:ListCidrBlocks +``` + +### Update +```json +route53:ChangeCidrCollection +``` + +### Delete +```json +route53:DeleteCidrCollection, +route53:ChangeCidrCollection +``` + diff --git a/docs/aws-docs/providers/aws/route53/cidr_collections/index.md b/docs/aws-docs/providers/aws/route53/cidr_collections/index.md new file mode 100644 index 0000000000..94efabc7fb --- /dev/null +++ b/docs/aws-docs/providers/aws/route53/cidr_collections/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource schema for AWS::Route53::CidrCollection.
Idaws.route53.cidr_collections
+ +## Fields + + + + + +
NameDatatypeDescription
idstringUUID of the CIDR collection.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.route53.cidr_collections + +``` + +## Permissions + +To operate on the cidr_collections resource, the following permissions are required: + +### Create +```json +route53:CreateCidrCollection, +route53:ChangeCidrCollection +``` + +### List +```json +route53:ListCidrCollections, +route53:ListCidrBlocks +``` + diff --git a/docs/aws-docs/providers/aws/route53/dnssec/index.md b/docs/aws-docs/providers/aws/route53/dnssec/index.md new file mode 100644 index 0000000000..1eba6a9c58 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53/dnssec/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionResource used to control (enable/disable) DNSSEC in a specific hosted zone.
Idaws.route53.dnssec
+ +## Fields + + + + + +
NameDatatypeDescription
hosted_zone_idstringThe unique string (ID) used to identify a hosted zone.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +hosted_zone_id +FROM aws.route53.dnssec +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the dnssec resource, the following permissions are required: + +### Read +```json +route53:GetDNSSEC +``` + +### Delete +```json +route53:GetDNSSEC, +route53:DisableHostedZoneDNSSEC, +kms:DescribeKey, +kms:GetPublicKey, +kms:Sign, +kms:CreateGrant +``` + diff --git a/docs/aws-docs/providers/aws/route53/dnssecs/index.md b/docs/aws-docs/providers/aws/route53/dnssecs/index.md new file mode 100644 index 0000000000..bf233f8f77 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53/dnssecs/index.md @@ -0,0 +1,83 @@ +--- +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
DescriptionResource used to control (enable/disable) DNSSEC in a specific hosted zone.
Idaws.route53.dnssecs
+ +## Fields + + + + + +
NameDatatypeDescription
hosted_zone_idstringThe unique string (ID) used to identify a hosted zone.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +hosted_zone_id +FROM aws.route53.dnssecs + +``` + +## Permissions + +To operate on the dnssecs resource, the following permissions are required: + +### Create +```json +route53:GetDNSSEC, +route53:EnableHostedZoneDNSSEC, +kms:DescribeKey, +kms:GetPublicKey, +kms:Sign, +kms:CreateGrant +``` + +### List +```json +route53:GetDNSSEC, +route53:ListHostedZones +``` + diff --git a/docs/aws-docs/providers/aws/route53/health_check/index.md b/docs/aws-docs/providers/aws/route53/health_check/index.md new file mode 100644 index 0000000000..7e308f317f --- /dev/null +++ b/docs/aws-docs/providers/aws/route53/health_check/index.md @@ -0,0 +1,95 @@ +--- +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
DescriptionResource schema for AWS::Route53::HealthCheck.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +health_check_id, +health_check_config, +health_check_tags +FROM aws.route53.health_check +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the health_check resource, the following permissions are required: + +### Read +```json +route53:GetHealthCheck, +route53:ListTagsForResource +``` + +### Update +```json +route53:UpdateHealthCheck, +route53:ChangeTagsForResource, +route53:ListTagsForResource, +cloudwatch:DescribeAlarms +``` + +### Delete +```json +route53:DeleteHealthCheck +``` + diff --git a/docs/aws-docs/providers/aws/route53/health_checks/index.md b/docs/aws-docs/providers/aws/route53/health_checks/index.md new file mode 100644 index 0000000000..71a4064892 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53/health_checks/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionResource schema for AWS::Route53::HealthCheck.
Idaws.route53.health_checks
+ +## Fields + + + + + +
NameDatatypeDescription
health_check_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +health_check_id +FROM aws.route53.health_checks + +``` + +## Permissions + +To operate on the health_checks resource, the following permissions are required: + +### Create +```json +route53:CreateHealthCheck, +route53:ChangeTagsForResource, +cloudwatch:DescribeAlarms, +route53-recovery-control-config:DescribeRoutingControl +``` + +### List +```json +route53:ListHealthChecks, +route53:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/route53/hosted_zone/index.md b/docs/aws-docs/providers/aws/route53/hosted_zone/index.md new file mode 100644 index 0000000000..bd36ec9dcc --- /dev/null +++ b/docs/aws-docs/providers/aws/route53/hosted_zone/index.md @@ -0,0 +1,112 @@ +--- +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
DescriptionCreates a new public or private hosted zone. You create records in a public hosted zone to define how you want to route traffic on the internet for a domain, such as example.com, and its subdomains (apex.example.com, acme.example.com). You create records in a private hosted zone to define how you want to route traffic for a domain and its subdomains within one or more Amazon Virtual Private Clouds (Amazon VPCs). <br/> You can't convert a public hosted zone to a private hosted zone or vice versa. Instead, you must create a new hosted zone with the same name and create new resource record sets.<br/> For more information about charges for hosted zones, see [Amazon Route 53 Pricing](https://docs.aws.amazon.com/route53/pricing/).<br/> Note the following:<br/> + You can't create a hosted zone for a top-level domain (TLD) such as .com.<br/> + If your domain is registered with a registrar other than Route 53, you must update the name servers with your registrar to make Route 53 the DNS service for the domain. For more information, see [Migrating DNS Service for an Existing Domain to Amazon Route 53](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/MigratingDNS.html) in the *Amazon Route 53 Developer Guide*. <br/> <br/> When you submit a ``CreateHostedZone`` request, the initial status of the hosted zone is ``PENDING``. For public hosted zones, this means that the NS and SOA records are not yet available on all Route 53 DNS servers. When the NS and SOA records are available, the status of the zone changes to ``INSYNC``.<br/> The ``CreateHostedZone`` request requires the caller to have an ``ec2:DescribeVpcs`` permission.<br/> When creating private hosted zones, the Amazon VPC must belong to the same partition where the hosted zone is created. A partition is a group of AWS-Regions. Each AWS-account is scoped to one partition.<br/> The following are the supported partitions:<br/> + ``aws`` - AWS-Regions <br/> + ``aws-cn`` - China Regions<br/> + ``aws-us-gov`` - govcloud-us-region <br/> <br/> For more information, see [Access Management](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*.
Idaws.route53.hosted_zone
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
idstring
hosted_zone_configobjectA complex type that contains an optional comment.<br/> If you don't want to specify a comment, omit the ``HostedZoneConfig`` and ``Comment`` elements.
hosted_zone_tagsarrayAdds, edits, or deletes tags for a health check or a hosted zone.<br/> For information about using tags for cost allocation, see [Using Cost Allocation Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) in the *User Guide*.
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/> 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_configobjectCreates a configuration for DNS query logging. After you create a query logging configuration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs log group.<br/> DNS query logs contain information about the queries that Route 53 receives for a specified public hosted zone, such as the following:<br/> + Route 53 edge location that responded to the DNS query<br/> + Domain or subdomain that was requested<br/> + DNS record type, such as A or AAAA<br/> + DNS response code, such as ``NoError`` or ``ServFail`` <br/> <br/> + Log Group and Resource Policy Before you create a query logging configuration, perform the following operations. If you create a query logging configuration using the Route 53 console, Route 53 performs these operations automatically. Create a CloudWatch Logs log group, and make note of the ARN, which you specify when you create a query logging configuration. Note the following: You must create the log group in the us-east-1 region. You must use the same to create the log group and the hosted zone that you want to configure query logging for. When you create log groups for query logging, we recommend that you use a consistent prefix, for example: /aws/route53/hosted zone name In the next step, you'll create a resource policy, which controls access to one or more log groups and the associated resources, such as Route 53 hosted zones. There's a limit on the number of resource policies that you can create, so we recommend that you use a consistent prefix so you can use the same resource policy for all the log groups that you create for query logging. Create a CloudWatch Logs resource policy, and give it the permissions that Route 53 needs to create log streams and to send query logs to log streams. For the value of Resource, specify the ARN for the log group that you created in the previous step. To use the same resource policy for all the CloudWatch Logs log groups that you created for query logging configurations, replace the hosted zone name with *, for example: arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/* To avoid the confused deputy problem, a security issue where an entity without a permission for an action can coerce a more-privileged entity to perform it, you can optionally limit the permissions that a service has to a resource in a resource-based policy by supplying the following values: For aws:SourceArn, supply the hosted zone ARN used in creating the query logging configuration. For example, aws:SourceArn: arn:aws:route53:::hostedzone/hosted zone ID. For aws:SourceAccount, supply the account ID for the account that creates the query logging configuration. For example, aws:SourceAccount:111111111111. For more information, see The confused deputy problem in the IAM User Guide. You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the SDKs, or the . + Log Streams and Edge Locations When Route 53 finishes creating the configuration for DNS query logging, it does the following: Creates a log stream for an edge location the first time that the edge location responds to DNS queries for the specified hosted zone. That log stream is used to log all queries that Route 53 responds to for that edge location. Begins to send query logs to the applicable log stream. The name of each log stream is in the following format: hosted zone ID/edge location code The edge location code is a three-letter code and an arbitrarily assigned number, for example, DFW3. The three-letter code typically corresponds with the International Air Transport Association airport code for an airport near the edge location. (These abbreviations might change in the future.) For a list of edge locations, see "The Route 53 Global Network" on the Route 53 Product Details page. + Queries That Are Logged Query logs contain only the queries that DNS resolvers forward to Route 53. If a DNS resolver has already cached the response to a query (such as the IP address for a load balancer for example.com), the resolver will continue to return the cached response. It doesn't forward another query to Route 53 until the TTL for the corresponding resource record set expires. Depending on how many DNS queries are submitted for a resource record set, and depending on the TTL for that resource record set, query logs might contain information about only one query out of every several thousand queries that are submitted to DNS. For more information about how DNS works, see Routing Internet Traffic to Your Website or Web Application in the Amazon Route 53 Developer Guide. + Log File Format For a list of the values in each query log and the format of each value, see Logging DNS Queries in the Amazon Route 53 Developer Guide. + Pricing For information about charges for query logs, see Amazon CloudWatch Pricing. + How to Stop Logging If you want Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see DeleteQueryLoggingConfig.
vpcsarray*Private hosted zones:* A complex type that contains information about the VPCs that are associated with the specified hosted zone.<br/> For public hosted zones, omit ``VPCs``, ``VPCId``, and ``VPCRegion``.
name_serversarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +hosted_zone_config, +hosted_zone_tags, +name, +query_logging_config, +vpcs, +name_servers +FROM aws.route53.hosted_zone +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the hosted_zone resource, the following permissions are required: + +### Read +```json +route53:GetHostedZone, +route53:ListTagsForResource, +route53:ListQueryLoggingConfigs +``` + +### Update +```json +route53:GetChange, +route53:ListTagsForResource, +route53:UpdateHostedZoneComment, +route53:ChangeTagsForResource, +route53:AssociateVPCWithHostedZone, +route53:DisassociateVPCFromHostedZone, +route53:CreateQueryLoggingConfig, +route53:DeleteQueryLoggingConfig, +ec2:DescribeVpcs +``` + +### Delete +```json +route53:DeleteHostedZone, +route53:DeleteQueryLoggingConfig, +route53:ListQueryLoggingConfigs, +route53:GetChange +``` + diff --git a/docs/aws-docs/providers/aws/route53/hosted_zones/index.md b/docs/aws-docs/providers/aws/route53/hosted_zones/index.md new file mode 100644 index 0000000000..5b939c3011 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53/hosted_zones/index.md @@ -0,0 +1,86 @@ +--- +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
DescriptionCreates a new public or private hosted zone. You create records in a public hosted zone to define how you want to route traffic on the internet for a domain, such as example.com, and its subdomains (apex.example.com, acme.example.com). You create records in a private hosted zone to define how you want to route traffic for a domain and its subdomains within one or more Amazon Virtual Private Clouds (Amazon VPCs). <br/> You can't convert a public hosted zone to a private hosted zone or vice versa. Instead, you must create a new hosted zone with the same name and create new resource record sets.<br/> For more information about charges for hosted zones, see [Amazon Route 53 Pricing](https://docs.aws.amazon.com/route53/pricing/).<br/> Note the following:<br/> + You can't create a hosted zone for a top-level domain (TLD) such as .com.<br/> + If your domain is registered with a registrar other than Route 53, you must update the name servers with your registrar to make Route 53 the DNS service for the domain. For more information, see [Migrating DNS Service for an Existing Domain to Amazon Route 53](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/MigratingDNS.html) in the *Amazon Route 53 Developer Guide*. <br/> <br/> When you submit a ``CreateHostedZone`` request, the initial status of the hosted zone is ``PENDING``. For public hosted zones, this means that the NS and SOA records are not yet available on all Route 53 DNS servers. When the NS and SOA records are available, the status of the zone changes to ``INSYNC``.<br/> The ``CreateHostedZone`` request requires the caller to have an ``ec2:DescribeVpcs`` permission.<br/> When creating private hosted zones, the Amazon VPC must belong to the same partition where the hosted zone is created. A partition is a group of AWS-Regions. Each AWS-account is scoped to one partition.<br/> The following are the supported partitions:<br/> + ``aws`` - AWS-Regions <br/> + ``aws-cn`` - China Regions<br/> + ``aws-us-gov`` - govcloud-us-region <br/> <br/> For more information, see [Access Management](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*.
Idaws.route53.hosted_zones
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.route53.hosted_zones + +``` + +## Permissions + +To operate on the hosted_zones resource, the following permissions are required: + +### Create +```json +route53:CreateHostedZone, +route53:CreateQueryLoggingConfig, +route53:ChangeTagsForResource, +route53:GetChange, +route53:AssociateVPCWithHostedZone, +ec2:DescribeVpcs +``` + +### List +```json +route53:GetHostedZone, +route53:ListHostedZones, +route53:ListHostedZonesByName, +route53:ListQueryLoggingConfigs, +route53:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/route53/index.md b/docs/aws-docs/providers/aws/route53/index.md new file mode 100644 index 0000000000..ccc4b4616f --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/route53/key_signing_key/index.md b/docs/aws-docs/providers/aws/route53/key_signing_key/index.md new file mode 100644 index 0000000000..4117778e82 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53/key_signing_key/index.md @@ -0,0 +1,104 @@ +--- +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
DescriptionRepresents a key signing key (KSK) associated with a hosted zone. You can only have two KSKs per hosted zone.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +hosted_zone_id, +status, +name, +key_management_service_arn +FROM aws.route53.key_signing_key +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the key_signing_key resource, the following permissions are required: + +### Read +```json +route53:GetDNSSEC +``` + +### Update +```json +route53:GetDNSSEC, +route53:ActivateKeySigningKey, +route53:DeactivateKeySigningKey, +kms:DescribeKey, +kms:GetPublicKey, +kms:Sign, +kms:CreateGrant +``` + +### Delete +```json +route53:DeactivateKeySigningKey, +route53:DeleteKeySigningKey, +kms:DescribeKey, +kms:GetPublicKey, +kms:Sign, +kms:CreateGrant +``` + diff --git a/docs/aws-docs/providers/aws/route53/key_signing_keys/index.md b/docs/aws-docs/providers/aws/route53/key_signing_keys/index.md new file mode 100644 index 0000000000..6c743e7aa1 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53/key_signing_keys/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionRepresents a key signing key (KSK) associated with a hosted zone. You can only have two KSKs per hosted zone.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +hosted_zone_id, +name +FROM aws.route53.key_signing_keys + +``` + +## Permissions + +To operate on the key_signing_keys resource, the following permissions are required: + +### Create +```json +route53:CreateKeySigningKey, +kms:DescribeKey, +kms:GetPublicKey, +kms:Sign, +kms:CreateGrant +``` + +### List +```json +route53:GetDNSSEC, +route53:ListHostedZones +``` + diff --git a/docs/aws-docs/providers/aws/route53recoverycontrol/cluster/index.md b/docs/aws-docs/providers/aws/route53recoverycontrol/cluster/index.md new file mode 100644 index 0000000000..fb6317a23e --- /dev/null +++ b/docs/aws-docs/providers/aws/route53recoverycontrol/cluster/index.md @@ -0,0 +1,87 @@ +--- +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
DescriptionAWS Route53 Recovery Control Cluster resource schema
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +cluster_arn, +status, +cluster_endpoints, +tags +FROM aws.route53recoverycontrol.cluster +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the cluster resource, the following permissions are required: + +### Read +```json +route53-recovery-control-config:DescribeCluster, +route53-recovery-control-config:ListTagsForResource +``` + +### Delete +```json +route53-recovery-control-config:DescribeCluster, +route53-recovery-control-config:DeleteCluster +``` + diff --git a/docs/aws-docs/providers/aws/route53recoverycontrol/clusters/index.md b/docs/aws-docs/providers/aws/route53recoverycontrol/clusters/index.md new file mode 100644 index 0000000000..396cd343c6 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53recoverycontrol/clusters/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionAWS Route53 Recovery Control Cluster resource schema
Idaws.route53recoverycontrol.clusters
+ +## Fields + + + + + +
NameDatatypeDescription
cluster_arnstringThe Amazon Resource Name (ARN) of the cluster.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +cluster_arn +FROM aws.route53recoverycontrol.clusters +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the clusters resource, the following permissions are required: + +### Create +```json +route53-recovery-control-config:CreateCluster, +route53-recovery-control-config:DescribeCluster, +route53-recovery-control-config:ListTagsForResource, +route53-recovery-control-config:TagResource +``` + +### List +```json +route53-recovery-control-config:ListClusters +``` + diff --git a/docs/aws-docs/providers/aws/route53recoverycontrol/control_panel/index.md b/docs/aws-docs/providers/aws/route53recoverycontrol/control_panel/index.md new file mode 100644 index 0000000000..7e5734f3ee --- /dev/null +++ b/docs/aws-docs/providers/aws/route53recoverycontrol/control_panel/index.md @@ -0,0 +1,105 @@ +--- +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
DescriptionAWS Route53 Recovery Control Control Panel resource schema .
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +cluster_arn, +control_panel_arn, +name, +status, +default_control_panel, +routing_control_count, +tags +FROM aws.route53recoverycontrol.control_panel +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the control_panel resource, the following permissions are required: + +### Read +```json +route53-recovery-control-config:DescribeControlPanel, +route53-recovery-control-config:ListTagsForResource +``` + +### Update +```json +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 +```json +route53-recovery-control-config:DeleteControlPanel, +route53-recovery-control-config:DescribeControlPanel +``` + diff --git a/docs/aws-docs/providers/aws/route53recoverycontrol/control_panels/index.md b/docs/aws-docs/providers/aws/route53recoverycontrol/control_panels/index.md new file mode 100644 index 0000000000..116f2370db --- /dev/null +++ b/docs/aws-docs/providers/aws/route53recoverycontrol/control_panels/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionAWS Route53 Recovery Control Control Panel resource schema .
Idaws.route53recoverycontrol.control_panels
+ +## Fields + + + + + +
NameDatatypeDescription
control_panel_arnstringThe Amazon Resource Name (ARN) of the cluster.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +control_panel_arn +FROM aws.route53recoverycontrol.control_panels +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the control_panels resource, the following permissions are required: + +### Create +```json +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 +```json +route53-recovery-control-config:ListControlPanels +``` + diff --git a/docs/aws-docs/providers/aws/route53recoverycontrol/index.md b/docs/aws-docs/providers/aws/route53recoverycontrol/index.md new file mode 100644 index 0000000000..48d9cb950f --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/route53recoverycontrol/routing_control/index.md b/docs/aws-docs/providers/aws/route53recoverycontrol/routing_control/index.md new file mode 100644 index 0000000000..226c73c657 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53recoverycontrol/routing_control/index.md @@ -0,0 +1,98 @@ +--- +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
DescriptionAWS Route53 Recovery Control Routing Control resource schema .
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +routing_control_arn, +control_panel_arn, +name, +status, +cluster_arn +FROM aws.route53recoverycontrol.routing_control +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the routing_control resource, the following permissions are required: + +### Read +```json +route53-recovery-control-config:DescribeRoutingControl +``` + +### Update +```json +route53-recovery-control-config:UpdateRoutingControl, +route53-recovery-control-config:DescribeRoutingControl, +route53-recovery-control-config:DescribeControlPanel +``` + +### Delete +```json +route53-recovery-control-config:DescribeRoutingControl, +route53-recovery-control-config:DeleteRoutingControl +``` + diff --git a/docs/aws-docs/providers/aws/route53recoverycontrol/routing_controls/index.md b/docs/aws-docs/providers/aws/route53recoverycontrol/routing_controls/index.md new file mode 100644 index 0000000000..62b8ab1827 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53recoverycontrol/routing_controls/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionAWS Route53 Recovery Control Routing Control resource schema .
Idaws.route53recoverycontrol.routing_controls
+ +## Fields + + + + + +
NameDatatypeDescription
routing_control_arnstringThe Amazon Resource Name (ARN) of the routing control.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +routing_control_arn +FROM aws.route53recoverycontrol.routing_controls +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the routing_controls resource, the following permissions are required: + +### Create +```json +route53-recovery-control-config:CreateRoutingControl, +route53-recovery-control-config:DescribeRoutingControl, +route53-recovery-control-config:DescribeControlPanel, +route53-recovery-control-config:DescribeCluster +``` + +### List +```json +route53-recovery-control-config:ListRoutingControls +``` + diff --git a/docs/aws-docs/providers/aws/route53recoverycontrol/safety_rule/index.md b/docs/aws-docs/providers/aws/route53recoverycontrol/safety_rule/index.md new file mode 100644 index 0000000000..8f9406b246 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53recoverycontrol/safety_rule/index.md @@ -0,0 +1,107 @@ +--- +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
DescriptionResource schema for AWS Route53 Recovery Control basic constructs and validation rules.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +assertion_rule, +gating_rule, +name, +safety_rule_arn, +control_panel_arn, +status, +rule_config, +tags +FROM aws.route53recoverycontrol.safety_rule +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the safety_rule resource, the following permissions are required: + +### Read +```json +route53-recovery-control-config:DescribeSafetyRule, +route53-recovery-control-config:ListTagsForResource +``` + +### Update +```json +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 +```json +route53-recovery-control-config:DescribeSafetyRule, +route53-recovery-control-config:DeleteSafetyRule +``` + diff --git a/docs/aws-docs/providers/aws/route53recoverycontrol/safety_rules/index.md b/docs/aws-docs/providers/aws/route53recoverycontrol/safety_rules/index.md new file mode 100644 index 0000000000..05048a31f9 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53recoverycontrol/safety_rules/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionResource schema for AWS Route53 Recovery Control basic constructs and validation rules.
Idaws.route53recoverycontrol.safety_rules
+ +## Fields + + + + + +
NameDatatypeDescription
safety_rule_arnstringThe Amazon Resource Name (ARN) of the safety rule.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +safety_rule_arn +FROM aws.route53recoverycontrol.safety_rules +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the safety_rules resource, the following permissions are required: + +### Create +```json +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 +```json +route53-recovery-control-config:ListSafetyRules +``` + diff --git a/docs/aws-docs/providers/aws/route53recoveryreadiness/cell/index.md b/docs/aws-docs/providers/aws/route53recoveryreadiness/cell/index.md new file mode 100644 index 0000000000..18e542276a --- /dev/null +++ b/docs/aws-docs/providers/aws/route53recoveryreadiness/cell/index.md @@ -0,0 +1,101 @@ +--- +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
DescriptionThe API Schema for AWS Route53 Recovery Readiness Cells.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +cell_name, +cell_arn, +cells, +parent_readiness_scopes, +tags +FROM aws.route53recoveryreadiness.cell +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the cell resource, the following permissions are required: + +### Read +```json +route53-recovery-readiness:GetCell, +route53-recovery-readiness:ListTagsForResources +``` + +### Update +```json +route53-recovery-readiness:GetCell, +route53-recovery-readiness:ListTagsForResources, +route53-recovery-readiness:TagResource, +route53-recovery-readiness:UntagResource, +route53-recovery-readiness:UpdateCell +``` + +### Delete +```json +route53-recovery-readiness:DeleteCell, +route53-recovery-readiness:GetCell +``` + diff --git a/docs/aws-docs/providers/aws/route53recoveryreadiness/cells/index.md b/docs/aws-docs/providers/aws/route53recoveryreadiness/cells/index.md new file mode 100644 index 0000000000..e408c105ee --- /dev/null +++ b/docs/aws-docs/providers/aws/route53recoveryreadiness/cells/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionThe API Schema for AWS Route53 Recovery Readiness Cells.
Idaws.route53recoveryreadiness.cells
+ +## Fields + + + + + +
NameDatatypeDescription
cell_namestringThe name of the cell to create.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +cell_name +FROM aws.route53recoveryreadiness.cells +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the cells resource, the following permissions are required: + +### Create +```json +route53-recovery-readiness:CreateCell, +route53-recovery-readiness:GetCell, +route53-recovery-readiness:ListTagsForResources, +route53-recovery-readiness:TagResource +``` + +### List +```json +route53-recovery-readiness:ListCells +``` + diff --git a/docs/aws-docs/providers/aws/route53recoveryreadiness/index.md b/docs/aws-docs/providers/aws/route53recoveryreadiness/index.md new file mode 100644 index 0000000000..6a4d136f50 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/route53recoveryreadiness/readiness_check/index.md b/docs/aws-docs/providers/aws/route53recoveryreadiness/readiness_check/index.md new file mode 100644 index 0000000000..40bbf46a6c --- /dev/null +++ b/docs/aws-docs/providers/aws/route53recoveryreadiness/readiness_check/index.md @@ -0,0 +1,100 @@ +--- +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
DescriptionAws Route53 Recovery Readiness Check Schema and API specification.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +resource_set_name, +readiness_check_name, +readiness_check_arn, +tags +FROM aws.route53recoveryreadiness.readiness_check +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the readiness_check resource, the following permissions are required: + +### Read +```json +route53-recovery-readiness:GetReadinessCheck, +route53-recovery-readiness:ListTagsForResources +``` + +### Update +```json +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 +```json +route53-recovery-readiness:DeleteReadinessCheck, +route53-recovery-readiness:GetReadinessCheck +``` + diff --git a/docs/aws-docs/providers/aws/route53recoveryreadiness/readiness_checks/index.md b/docs/aws-docs/providers/aws/route53recoveryreadiness/readiness_checks/index.md new file mode 100644 index 0000000000..560338ae9b --- /dev/null +++ b/docs/aws-docs/providers/aws/route53recoveryreadiness/readiness_checks/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionAws Route53 Recovery Readiness Check Schema and API specification.
Idaws.route53recoveryreadiness.readiness_checks
+ +## Fields + + + + + +
NameDatatypeDescription
readiness_check_namestringName of the ReadinessCheck to create.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +readiness_check_name +FROM aws.route53recoveryreadiness.readiness_checks +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the readiness_checks resource, the following permissions are required: + +### Create +```json +route53-recovery-readiness:CreateReadinessCheck, +route53-recovery-readiness:GetResourceSet, +route53-recovery-readiness:GetReadinessCheck, +route53-recovery-readiness:ListTagsForResources, +route53-recovery-readiness:TagResource +``` + +### List +```json +route53-recovery-readiness:ListReadinessChecks, +route53-recovery-readiness:GetReadinessChecks +``` + diff --git a/docs/aws-docs/providers/aws/route53recoveryreadiness/recovery_group/index.md b/docs/aws-docs/providers/aws/route53recoveryreadiness/recovery_group/index.md new file mode 100644 index 0000000000..441399970e --- /dev/null +++ b/docs/aws-docs/providers/aws/route53recoveryreadiness/recovery_group/index.md @@ -0,0 +1,100 @@ +--- +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
DescriptionAWS Route53 Recovery Readiness Recovery Group Schema and API specifications.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +recovery_group_name, +cells, +recovery_group_arn, +tags +FROM aws.route53recoveryreadiness.recovery_group +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the recovery_group resource, the following permissions are required: + +### Read +```json +route53-recovery-readiness:GetRecoveryGroup, +route53-recovery-readiness:ListTagsForResources +``` + +### Update +```json +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 +```json +route53-recovery-readiness:DeleteRecoveryGroup, +route53-recovery-readiness:GetRecoveryGroup +``` + diff --git a/docs/aws-docs/providers/aws/route53recoveryreadiness/recovery_groups/index.md b/docs/aws-docs/providers/aws/route53recoveryreadiness/recovery_groups/index.md new file mode 100644 index 0000000000..772e7ad234 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53recoveryreadiness/recovery_groups/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionAWS Route53 Recovery Readiness Recovery Group Schema and API specifications.
Idaws.route53recoveryreadiness.recovery_groups
+ +## Fields + + + + + +
NameDatatypeDescription
recovery_group_namestringThe name of the recovery group to create.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +recovery_group_name +FROM aws.route53recoveryreadiness.recovery_groups +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the recovery_groups resource, the following permissions are required: + +### Create +```json +route53-recovery-readiness:CreateRecoveryGroup, +route53-recovery-readiness:GetRecoveryGroup, +route53-recovery-readiness:GetCell, +route53-recovery-readiness:ListTagsForResources, +route53-recovery-readiness:TagResource +``` + +### List +```json +route53-recovery-readiness:ListRecoveryGroups +``` + diff --git a/docs/aws-docs/providers/aws/route53recoveryreadiness/resource_set/index.md b/docs/aws-docs/providers/aws/route53recoveryreadiness/resource_set/index.md new file mode 100644 index 0000000000..409b7e5548 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53recoveryreadiness/resource_set/index.md @@ -0,0 +1,103 @@ +--- +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
DescriptionSchema for the AWS Route53 Recovery Readiness ResourceSet Resource and API.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +resource_set_name, +resources, +resource_set_arn, +resource_set_type, +tags +FROM aws.route53recoveryreadiness.resource_set +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the resource_set resource, the following permissions are required: + +### Read +```json +route53-recovery-readiness:GetResourceSet, +route53-recovery-readiness:ListTagsForResources +``` + +### Update +```json +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 +```json +route53-recovery-readiness:DeleteResourceSet, +route53-recovery-readiness:GetResourceSet +``` + diff --git a/docs/aws-docs/providers/aws/route53recoveryreadiness/resource_sets/index.md b/docs/aws-docs/providers/aws/route53recoveryreadiness/resource_sets/index.md new file mode 100644 index 0000000000..78360d76b5 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53recoveryreadiness/resource_sets/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionSchema for the AWS Route53 Recovery Readiness ResourceSet Resource and API.
Idaws.route53recoveryreadiness.resource_sets
+ +## Fields + + + + + +
NameDatatypeDescription
resource_set_namestringThe name of the resource set to create.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +resource_set_name +FROM aws.route53recoveryreadiness.resource_sets +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the resource_sets resource, the following permissions are required: + +### Create +```json +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 +```json +route53-recovery-readiness:ListResourceSets +``` + diff --git a/docs/aws-docs/providers/aws/route53resolver/firewall_domain_list/index.md b/docs/aws-docs/providers/aws/route53resolver/firewall_domain_list/index.md new file mode 100644 index 0000000000..52cf87c6a7 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53resolver/firewall_domain_list/index.md @@ -0,0 +1,126 @@ +--- +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
DescriptionResource schema for AWS::Route53Resolver::FirewallDomainList.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.route53resolver.firewall_domain_list +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the firewall_domain_list resource, the following permissions are required: + +### Read +```json +route53resolver:*, +ec2:*, +logs:*, +iam:*, +lambda:*, +s3:* +``` + +### Delete +```json +route53resolver:*, +ec2:*, +logs:*, +iam:*, +lambda:*, +s3:* +``` + +### Update +```json +route53resolver:*, +ec2:*, +logs:*, +iam:*, +lambda:*, +s3:* +``` + diff --git a/docs/aws-docs/providers/aws/route53resolver/firewall_domain_lists/index.md b/docs/aws-docs/providers/aws/route53resolver/firewall_domain_lists/index.md new file mode 100644 index 0000000000..79009e3e70 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53resolver/firewall_domain_lists/index.md @@ -0,0 +1,87 @@ +--- +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
DescriptionResource schema for AWS::Route53Resolver::FirewallDomainList.
Idaws.route53resolver.firewall_domain_lists
+ +## Fields + + + + + +
NameDatatypeDescription
idstringResourceId
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.route53resolver.firewall_domain_lists +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the firewall_domain_lists resource, the following permissions are required: + +### Create +```json +route53resolver:*, +ec2:*, +logs:*, +iam:*, +lambda:*, +s3:* +``` + +### List +```json +route53resolver:*, +ec2:*, +logs:*, +iam:*, +lambda:*, +s3:* +``` + diff --git a/docs/aws-docs/providers/aws/route53resolver/firewall_rule_group/index.md b/docs/aws-docs/providers/aws/route53resolver/firewall_rule_group/index.md new file mode 100644 index 0000000000..e246258d85 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53resolver/firewall_rule_group/index.md @@ -0,0 +1,126 @@ +--- +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
DescriptionResource schema for AWS::Route53Resolver::FirewallRuleGroup.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.route53resolver.firewall_rule_group +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the firewall_rule_group resource, the following permissions are required: + +### Read +```json +route53resolver:*, +ec2:*, +logs:*, +iam:*, +lambda:*, +s3:* +``` + +### Delete +```json +route53resolver:*, +ec2:*, +logs:*, +iam:*, +lambda:*, +s3:* +``` + +### Update +```json +route53resolver:*, +ec2:*, +logs:*, +iam:*, +lambda:*, +s3:* +``` + diff --git a/docs/aws-docs/providers/aws/route53resolver/firewall_rule_group_association/index.md b/docs/aws-docs/providers/aws/route53resolver/firewall_rule_group_association/index.md new file mode 100644 index 0000000000..af1dff5041 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53resolver/firewall_rule_group_association/index.md @@ -0,0 +1,128 @@ +--- +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
DescriptionResource schema for AWS::Route53Resolver::FirewallRuleGroupAssociation.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.route53resolver.firewall_rule_group_association +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the firewall_rule_group_association resource, the following permissions are required: + +### Read +```json +route53resolver:*, +ec2:*, +logs:*, +iam:*, +lambda:*, +s3:* +``` + +### Delete +```json +route53resolver:*, +ec2:*, +logs:*, +iam:*, +lambda:*, +s3:* +``` + +### Update +```json +route53resolver:*, +ec2:*, +logs:*, +iam:*, +lambda:*, +s3:* +``` + diff --git a/docs/aws-docs/providers/aws/route53resolver/firewall_rule_group_associations/index.md b/docs/aws-docs/providers/aws/route53resolver/firewall_rule_group_associations/index.md new file mode 100644 index 0000000000..152a59dd28 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53resolver/firewall_rule_group_associations/index.md @@ -0,0 +1,87 @@ +--- +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
DescriptionResource schema for AWS::Route53Resolver::FirewallRuleGroupAssociation.
Idaws.route53resolver.firewall_rule_group_associations
+ +## Fields + + + + + +
NameDatatypeDescription
idstringId
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.route53resolver.firewall_rule_group_associations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the firewall_rule_group_associations resource, the following permissions are required: + +### Create +```json +route53resolver:*, +ec2:*, +logs:*, +iam:*, +lambda:*, +s3:* +``` + +### List +```json +route53resolver:*, +ec2:*, +logs:*, +iam:*, +lambda:*, +s3:* +``` + diff --git a/docs/aws-docs/providers/aws/route53resolver/firewall_rule_groups/index.md b/docs/aws-docs/providers/aws/route53resolver/firewall_rule_groups/index.md new file mode 100644 index 0000000000..c94f5c4a40 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53resolver/firewall_rule_groups/index.md @@ -0,0 +1,87 @@ +--- +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
DescriptionResource schema for AWS::Route53Resolver::FirewallRuleGroup.
Idaws.route53resolver.firewall_rule_groups
+ +## Fields + + + + + +
NameDatatypeDescription
idstringResourceId
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.route53resolver.firewall_rule_groups +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the firewall_rule_groups resource, the following permissions are required: + +### Create +```json +route53resolver:*, +ec2:*, +logs:*, +iam:*, +lambda:*, +s3:* +``` + +### List +```json +route53resolver:*, +ec2:*, +logs:*, +iam:*, +lambda:*, +s3:* +``` + diff --git a/docs/aws-docs/providers/aws/route53resolver/index.md b/docs/aws-docs/providers/aws/route53resolver/index.md new file mode 100644 index 0000000000..ba92133aae --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/route53resolver/outpost_resolver/index.md b/docs/aws-docs/providers/aws/route53resolver/outpost_resolver/index.md new file mode 100644 index 0000000000..c1c2adf628 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53resolver/outpost_resolver/index.md @@ -0,0 +1,117 @@ +--- +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
DescriptionResource schema for AWS::Route53Resolver::OutpostResolver.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.route53resolver.outpost_resolver +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the outpost_resolver resource, the following permissions are required: + +### Read +```json +route53resolver:GetOutpostResolver, +route53resolver:ListTagsForResource +``` + +### Update +```json +route53resolver:UpdateOutpostResolver, +route53resolver:GetOutpostResolver, +route53resolver:UntagResource, +route53resolver:TagResource, +route53resolver:ListTagsForResource +``` + +### Delete +```json +route53resolver:DeleteOutpostResolver, +route53resolver:GetOutpostResolver, +route53resolver:ListOutpostResolvers, +route53resolver:ListResolverEndpoints +``` + diff --git a/docs/aws-docs/providers/aws/route53resolver/outpost_resolvers/index.md b/docs/aws-docs/providers/aws/route53resolver/outpost_resolvers/index.md new file mode 100644 index 0000000000..d74d908db2 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53resolver/outpost_resolvers/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionResource schema for AWS::Route53Resolver::OutpostResolver.
Idaws.route53resolver.outpost_resolvers
+ +## Fields + + + + + +
NameDatatypeDescription
idstringId
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.route53resolver.outpost_resolvers +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the outpost_resolvers resource, the following permissions are required: + +### Create +```json +route53resolver:CreateOutpostResolver, +route53resolver:GetOutpostResolver, +route53resolver:ListTagsForResource, +outposts:GetOutpost +``` + +### List +```json +route53resolver:ListOutpostResolvers, +route53resolver:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/route53resolver/resolver_config/index.md b/docs/aws-docs/providers/aws/route53resolver/resolver_config/index.md new file mode 100644 index 0000000000..521d26be51 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53resolver/resolver_config/index.md @@ -0,0 +1,88 @@ +--- +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
DescriptionResource schema for AWS::Route53Resolver::ResolverConfig.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +owner_id, +resource_id, +autodefined_reverse, +autodefined_reverse_flag +FROM aws.route53resolver.resolver_config +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the resolver_config resource, the following permissions are required: + +### Read +```json +route53resolver:GetResolverConfig, +ec2:DescribeVpcs +``` + +### Delete +```json +route53resolver:UpdateResolverConfig, +route53resolver:ListResolverConfigs, +ec2:DescribeVpcs +``` + diff --git a/docs/aws-docs/providers/aws/route53resolver/resolver_configs/index.md b/docs/aws-docs/providers/aws/route53resolver/resolver_configs/index.md new file mode 100644 index 0000000000..fa0fbc1933 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53resolver/resolver_configs/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionResource schema for AWS::Route53Resolver::ResolverConfig.
Idaws.route53resolver.resolver_configs
+ +## Fields + + + + + +
NameDatatypeDescription
resource_idstringResourceId
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +resource_id +FROM aws.route53resolver.resolver_configs +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the resolver_configs resource, the following permissions are required: + +### Create +```json +route53resolver:UpdateResolverConfig, +route53resolver:GetResolverConfig, +ec2:DescribeVpcs +``` + +### List +```json +route53resolver:ListResolverConfigs, +ec2:DescribeVpcs +``` + diff --git a/docs/aws-docs/providers/aws/route53resolver/resolver_query_logging_config/index.md b/docs/aws-docs/providers/aws/route53resolver/resolver_query_logging_config/index.md new file mode 100644 index 0000000000..5988e430d4 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53resolver/resolver_query_logging_config/index.md @@ -0,0 +1,99 @@ +--- +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
DescriptionResource schema for AWS::Route53Resolver::ResolverQueryLoggingConfig.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +owner_id, +status, +share_status, +association_count, +arn, +name, +creator_request_id, +destination_arn, +creation_time +FROM aws.route53resolver.resolver_query_logging_config +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the resolver_query_logging_config resource, the following permissions are required: + +### Read +```json +resolverquerylogging:GetConfig, +route53resolver:GetResolverQueryLogConfig +``` + +### Delete +```json +resolverquerylogging:DeleteConfig, +resolverquerylogging:ListConfig, +route53resolver:DeleteResolverQueryLogConfig, +route53resolver:ListResolverQueryLogConfigs +``` + diff --git a/docs/aws-docs/providers/aws/route53resolver/resolver_query_logging_config_association/index.md b/docs/aws-docs/providers/aws/route53resolver/resolver_query_logging_config_association/index.md new file mode 100644 index 0000000000..c5a8f1e7fc --- /dev/null +++ b/docs/aws-docs/providers/aws/route53resolver/resolver_query_logging_config_association/index.md @@ -0,0 +1,94 @@ +--- +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
DescriptionResource schema for AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +resolver_query_log_config_id, +resource_id, +status, +error, +error_message, +creation_time +FROM aws.route53resolver.resolver_query_logging_config_association +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the resolver_query_logging_config_association resource, the following permissions are required: + +### Read +```json +resolverquerylogging:GetConfigAssociation, +route53resolver:GetResolverQueryLogConfigAssociation +``` + +### Delete +```json +resolverquerylogging:DisassociateConfig, +resolverquerylogging:ListConfigAssociation, +route53resolver:DisassociateResolverQueryLogConfig, +route53resolver:ListResolverQueryLogConfigAssociations, +route53resolver:GetResolverQueryLogConfigAssociation +``` + diff --git a/docs/aws-docs/providers/aws/route53resolver/resolver_query_logging_config_associations/index.md b/docs/aws-docs/providers/aws/route53resolver/resolver_query_logging_config_associations/index.md new file mode 100644 index 0000000000..72d3ea99e2 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53resolver/resolver_query_logging_config_associations/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionResource schema for AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation.
Idaws.route53resolver.resolver_query_logging_config_associations
+ +## Fields + + + + + +
NameDatatypeDescription
idstringId
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.route53resolver.resolver_query_logging_config_associations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the resolver_query_logging_config_associations resource, the following permissions are required: + +### Create +```json +resolverquerylogging:AssociateConfig, +resolverquerylogging:GetConfigAssociation, +route53resolver:AssociateResolverQueryLogConfig, +ec2:DescribeVpcs, +route53resolver:GetResolverQueryLogConfigAssociation +``` + +### List +```json +resolverquerylogging:ListConfigAssociations, +route53resolver:ListResolverQueryLogConfigAssociations +``` + diff --git a/docs/aws-docs/providers/aws/route53resolver/resolver_query_logging_configs/index.md b/docs/aws-docs/providers/aws/route53resolver/resolver_query_logging_configs/index.md new file mode 100644 index 0000000000..dee9cc68f0 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53resolver/resolver_query_logging_configs/index.md @@ -0,0 +1,90 @@ +--- +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
DescriptionResource schema for AWS::Route53Resolver::ResolverQueryLoggingConfig.
Idaws.route53resolver.resolver_query_logging_configs
+ +## Fields + + + + + +
NameDatatypeDescription
idstringResourceId
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.route53resolver.resolver_query_logging_configs +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the resolver_query_logging_configs resource, the following permissions are required: + +### Create +```json +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 +```json +resolverquerylogging:ListConfig, +route53resolver:ListResolverQueryLogConfigs +``` + diff --git a/docs/aws-docs/providers/aws/route53resolver/resolver_rule/index.md b/docs/aws-docs/providers/aws/route53resolver/resolver_rule/index.md new file mode 100644 index 0000000000..a61e252104 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53resolver/resolver_rule/index.md @@ -0,0 +1,107 @@ +--- +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
DescriptionResource Type definition for AWS::Route53Resolver::ResolverRule
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +resolver_endpoint_id, +domain_name, +name, +rule_type, +tags, +target_ips, +arn, +resolver_rule_id +FROM aws.route53resolver.resolver_rule +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the resolver_rule resource, the following permissions are required: + +### Read +```json +route53resolver:GetResolverRule, +route53resolver:ListTagsForResource +``` + +### Update +```json +route53resolver:UpdateResolverRule, +route53resolver:GetResolverRule, +route53resolver:ListTagsForResource, +route53resolver:TagResource, +route53resolver:UntagResource +``` + +### Delete +```json +route53resolver:DeleteResolverRule, +route53resolver:GetResolverRule +``` + diff --git a/docs/aws-docs/providers/aws/route53resolver/resolver_rule_association/index.md b/docs/aws-docs/providers/aws/route53resolver/resolver_rule_association/index.md new file mode 100644 index 0000000000..ba8d16b52b --- /dev/null +++ b/docs/aws-docs/providers/aws/route53resolver/resolver_rule_association/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionIn the response to an [AssociateResolverRule](https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_AssociateResolverRule.html), [DisassociateResolverRule](https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DisassociateResolverRule.html), or [ListResolverRuleAssociations](https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRuleAssociations.html) request, provides information about an association between a resolver rule and a VPC. The association determines which DNS queries that originate in the VPC are forwarded to your network.
Idaws.route53resolver.resolver_rule_association
+ +## Fields + + + + + + + + +
NameDatatypeDescription
vpc_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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +vpc_id, +resolver_rule_id, +resolver_rule_association_id, +name +FROM aws.route53resolver.resolver_rule_association +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the resolver_rule_association resource, the following permissions are required: + +### Read +```json +route53resolver:GetResolverRuleAssociation +``` + +### Delete +```json +route53resolver:DisassociateResolverRule, +route53resolver:GetResolverRuleAssociation +``` + diff --git a/docs/aws-docs/providers/aws/route53resolver/resolver_rule_associations/index.md b/docs/aws-docs/providers/aws/route53resolver/resolver_rule_associations/index.md new file mode 100644 index 0000000000..02c62103a5 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53resolver/resolver_rule_associations/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionIn the response to an [AssociateResolverRule](https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_AssociateResolverRule.html), [DisassociateResolverRule](https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DisassociateResolverRule.html), or [ListResolverRuleAssociations](https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRuleAssociations.html) request, provides information about an association between a resolver rule and a VPC. The association determines which DNS queries that originate in the VPC are forwarded to your network.
Idaws.route53resolver.resolver_rule_associations
+ +## Fields + + + + + +
NameDatatypeDescription
resolver_rule_association_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +resolver_rule_association_id +FROM aws.route53resolver.resolver_rule_associations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the resolver_rule_associations resource, the following permissions are required: + +### Create +```json +route53resolver:AssociateResolverRule, +route53resolver:GetResolverRuleAssociation, +ec2:DescribeVpcs +``` + +### List +```json +route53resolver:ListResolverRuleAssociations +``` + diff --git a/docs/aws-docs/providers/aws/route53resolver/resolver_rules/index.md b/docs/aws-docs/providers/aws/route53resolver/resolver_rules/index.md new file mode 100644 index 0000000000..4306076e44 --- /dev/null +++ b/docs/aws-docs/providers/aws/route53resolver/resolver_rules/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionResource Type definition for AWS::Route53Resolver::ResolverRule
Idaws.route53resolver.resolver_rules
+ +## Fields + + + + + +
NameDatatypeDescription
resolver_rule_idstringThe ID of the endpoint that the rule is associated with.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +resolver_rule_id +FROM aws.route53resolver.resolver_rules +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the resolver_rules resource, the following permissions are required: + +### Create +```json +route53resolver:CreateResolverRule, +route53resolver:GetResolverRule, +route53resolver:ListTagsForResource, +route53resolver:TagResource +``` + +### List +```json +route53resolver:ListResolverRules +``` + diff --git a/docs/aws-docs/providers/aws/route53resolver/resolverdnssec_config/index.md b/docs/aws-docs/providers/aws/route53resolver/resolverdnssec_config/index.md new file mode 100644 index 0000000000..f4b43c248b --- /dev/null +++ b/docs/aws-docs/providers/aws/route53resolver/resolverdnssec_config/index.md @@ -0,0 +1,87 @@ +--- +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
DescriptionResource schema for AWS::Route53Resolver::ResolverDNSSECConfig.
Idaws.route53resolver.resolverdnssec_config
+ +## Fields + + + + + + + + +
NameDatatypeDescription
idstringId
owner_idstringAccountId
resource_idstringResourceId
validation_statusstringResolverDNSSECValidationStatus, possible values are ENABLING, ENABLED, DISABLING AND DISABLED.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +owner_id, +resource_id, +validation_status +FROM aws.route53resolver.resolverdnssec_config +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the resolverdnssec_config resource, the following permissions are required: + +### Read +```json +resolverdnssec:GetConfig, +route53resolver:ListResolverDnssecConfigs +``` + +### Delete +```json +resolverdnssec:DeleteConfig, +route53resolver:UpdateResolverDnssecConfig, +route53resolver:ListResolverDnssecConfigs, +ec2:DescribeVpcs +``` + diff --git a/docs/aws-docs/providers/aws/route53resolver/resolverdnssec_configs/index.md b/docs/aws-docs/providers/aws/route53resolver/resolverdnssec_configs/index.md new file mode 100644 index 0000000000..20707ebe1e --- /dev/null +++ b/docs/aws-docs/providers/aws/route53resolver/resolverdnssec_configs/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionResource schema for AWS::Route53Resolver::ResolverDNSSECConfig.
Idaws.route53resolver.resolverdnssec_configs
+ +## Fields + + + + + +
NameDatatypeDescription
idstringId
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.route53resolver.resolverdnssec_configs +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the resolverdnssec_configs resource, the following permissions are required: + +### Create +```json +resolverdnssec:CreateConfig, +route53resolver:UpdateResolverDnssecConfig, +route53resolver:GetResolverDnssecConfig, +ec2:DescribeVpcs +``` + +### List +```json +resolverdnssec:ListConfig, +route53resolver:ListResolverDnssecConfigs +``` + diff --git a/docs/aws-docs/providers/aws/rum/app_monitor/index.md b/docs/aws-docs/providers/aws/rum/app_monitor/index.md new file mode 100644 index 0000000000..6f84919624 --- /dev/null +++ b/docs/aws-docs/providers/aws/rum/app_monitor/index.md @@ -0,0 +1,142 @@ +--- +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
DescriptionResource Type definition for AWS::RUM::AppMonitor
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +name, +domain, +cw_log_enabled, +tags, +app_monitor_configuration, +custom_events +FROM aws.rum.app_monitor +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the app_monitor resource, the following permissions are required: + +### Read +```json +rum:GetAppMonitor, +dynamodb:GetItem, +s3:GetObject, +s3:DoesObjectExist, +s3:GetObjectAcl, +rum:ListTagsForResource, +rum:ListRumMetricsDestinations, +rum:BatchGetRumMetricDefinitions +``` + +### Update +```json +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 +```json +rum:DeleteAppMonitor, +dynamodb:DeleteItem, +dynamodb:Query, +logs:DeleteLogDelivery, +s3:DeleteObject, +s3:DoesObjectExist, +rum:UntagResource, +rum:DeleteRumMetricsDestination, +rum:BatchDeleteRumMetricDefinitions +``` + diff --git a/docs/aws-docs/providers/aws/rum/app_monitors/index.md b/docs/aws-docs/providers/aws/rum/app_monitors/index.md new file mode 100644 index 0000000000..dde4905158 --- /dev/null +++ b/docs/aws-docs/providers/aws/rum/app_monitors/index.md @@ -0,0 +1,107 @@ +--- +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
DescriptionResource Type definition for AWS::RUM::AppMonitor
Idaws.rum.app_monitors
+ +## Fields + + + + + +
NameDatatypeDescription
namestringA name for the app monitor
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.rum.app_monitors +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the app_monitors resource, the following permissions are required: + +### Create +```json +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 +```json +rum:ListAppMonitors, +dynamodb:DescribeTable, +rum:GetAppMonitor, +dynamodb:GetItem, +dynamodb:BatchGetItem, +dynamodb:Query, +s3:GetObject, +s3:DoesObjectExist, +s3:GetObjectAcl, +logs:DescribeLogGroups, +rum:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/rum/index.md b/docs/aws-docs/providers/aws/rum/index.md new file mode 100644 index 0000000000..5e25995af9 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/s3/access_grant/index.md b/docs/aws-docs/providers/aws/s3/access_grant/index.md new file mode 100644 index 0000000000..a849a96a7a --- /dev/null +++ b/docs/aws-docs/providers/aws/s3/access_grant/index.md @@ -0,0 +1,105 @@ +--- +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
DescriptionThe AWS::S3::AccessGrant resource is an Amazon S3 resource type representing permissions to a specific S3 bucket or prefix hosted in an S3 Access Grants instance.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.s3.access_grant +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the access_grant resource, the following permissions are required: + +### Read +```json +s3:GetAccessGrant +``` + +### Delete +```json +s3:DeleteAccessGrant +``` + +### Update +```json +s3:TagResource +``` + diff --git a/docs/aws-docs/providers/aws/s3/access_grants/index.md b/docs/aws-docs/providers/aws/s3/access_grants/index.md new file mode 100644 index 0000000000..7f903aadb2 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3/access_grants/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionThe AWS::S3::AccessGrant resource is an Amazon S3 resource type representing permissions to a specific S3 bucket or prefix hosted in an S3 Access Grants instance.
Idaws.s3.access_grants
+ +## Fields + + + + + +
NameDatatypeDescription
access_grant_idstringThe ID assigned to this access grant.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +access_grant_id +FROM aws.s3.access_grants +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the access_grants resource, the following permissions are required: + +### Create +```json +s3:CreateAccessGrant, +s3:TagResource +``` + +### List +```json +s3:ListAccessGrants +``` + diff --git a/docs/aws-docs/providers/aws/s3/access_grants_instance/index.md b/docs/aws-docs/providers/aws/s3/access_grants_instance/index.md new file mode 100644 index 0000000000..59d5e0f1bb --- /dev/null +++ b/docs/aws-docs/providers/aws/s3/access_grants_instance/index.md @@ -0,0 +1,93 @@ +--- +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
DescriptionThe AWS::S3::AccessGrantsInstance resource is an Amazon S3 resource type that hosts Access Grants and their associated locations
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +access_grants_instance_arn, +identity_center_arn, +access_grants_instance_id, +tags +FROM aws.s3.access_grants_instance +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the access_grants_instance resource, the following permissions are required: + +### Read +```json +s3:GetAccessGrantsInstance +``` + +### Delete +```json +s3:DeleteAccessGrantsInstance +``` + +### Update +```json +s3:TagResource +``` + diff --git a/docs/aws-docs/providers/aws/s3/access_grants_instances/index.md b/docs/aws-docs/providers/aws/s3/access_grants_instances/index.md new file mode 100644 index 0000000000..269486ad13 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3/access_grants_instances/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionThe AWS::S3::AccessGrantsInstance resource is an Amazon S3 resource type that hosts Access Grants and their associated locations
Idaws.s3.access_grants_instances
+ +## Fields + + + + + +
NameDatatypeDescription
access_grants_instance_arnundefinedThe Amazon Resource Name (ARN) of the specified Access Grants instance.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +access_grants_instance_arn +FROM aws.s3.access_grants_instances +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the access_grants_instances resource, the following permissions are required: + +### Create +```json +s3:CreateAccessGrantsInstance, +s3:TagResource +``` + +### List +```json +s3:ListAccessGrantsInstances +``` + diff --git a/docs/aws-docs/providers/aws/s3/access_grants_location/index.md b/docs/aws-docs/providers/aws/s3/access_grants_location/index.md new file mode 100644 index 0000000000..b49c4241b1 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3/access_grants_location/index.md @@ -0,0 +1,97 @@ +--- +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
DescriptionThe AWS::S3::AccessGrantsLocation resource is an Amazon S3 resource type hosted in an access grants instance which can be the target of S3 access grants.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +access_grants_location_arn, +access_grants_location_id, +iam_role_arn, +location_scope, +tags +FROM aws.s3.access_grants_location +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the access_grants_location resource, the following permissions are required: + +### Read +```json +s3:GetAccessGrantsLocation +``` + +### Delete +```json +s3:DeleteAccessGrantsLocation +``` + +### Update +```json +s3:UpdateAccessGrantsLocation, +s3:TagResource, +iam:PassRole +``` + diff --git a/docs/aws-docs/providers/aws/s3/access_grants_locations/index.md b/docs/aws-docs/providers/aws/s3/access_grants_locations/index.md new file mode 100644 index 0000000000..71d0106d0a --- /dev/null +++ b/docs/aws-docs/providers/aws/s3/access_grants_locations/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionThe AWS::S3::AccessGrantsLocation resource is an Amazon S3 resource type hosted in an access grants instance which can be the target of S3 access grants.
Idaws.s3.access_grants_locations
+ +## Fields + + + + + +
NameDatatypeDescription
access_grants_location_idstringThe unique identifier for the specified Access Grants location.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +access_grants_location_id +FROM aws.s3.access_grants_locations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the access_grants_locations resource, the following permissions are required: + +### Create +```json +s3:CreateAccessGrantsLocation, +iam:PassRole, +s3:TagResource +``` + +### List +```json +s3:ListAccessGrantsLocations +``` + diff --git a/docs/aws-docs/providers/aws/s3/access_point/index.md b/docs/aws-docs/providers/aws/s3/access_point/index.md new file mode 100644 index 0000000000..a47de1f1cf --- /dev/null +++ b/docs/aws-docs/providers/aws/s3/access_point/index.md @@ -0,0 +1,109 @@ +--- +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
DescriptionThe AWS::S3::AccessPoint resource is an Amazon S3 resource type that you can use to access buckets.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +alias, +bucket, +bucket_account_id, +vpc_configuration, +public_access_block_configuration, +policy, +network_origin, +arn +FROM aws.s3.access_point +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the access_point resource, the following permissions are required: + +### Read +```json +s3:GetAccessPoint, +s3:GetAccessPointPolicy +``` + +### Update +```json +s3:PutAccessPointPolicy, +s3:PutAccessPointPublicAccessBlock, +s3:DeleteAccessPointPolicy, +s3:GetAccessPoint, +s3:GetAccessPointPolicy +``` + +### Delete +```json +s3:DeleteAccessPointPolicy, +s3:DeleteAccessPoint +``` + diff --git a/docs/aws-docs/providers/aws/s3/access_points/index.md b/docs/aws-docs/providers/aws/s3/access_points/index.md new file mode 100644 index 0000000000..07d7865f1d --- /dev/null +++ b/docs/aws-docs/providers/aws/s3/access_points/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionThe AWS::S3::AccessPoint resource is an Amazon S3 resource type that you can use to access buckets.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.s3.access_points +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the access_points resource, the following permissions are required: + +### Create +```json +s3:CreateAccessPoint, +s3:PutAccessPointPolicy, +s3:PutAccessPointPublicAccessBlock +``` + +### List +```json +s3:ListAccessPoints +``` + diff --git a/docs/aws-docs/providers/aws/s3/bucket/index.md b/docs/aws-docs/providers/aws/s3/bucket/index.md new file mode 100644 index 0000000000..0eb5850a7b --- /dev/null +++ b/docs/aws-docs/providers/aws/s3/bucket/index.md @@ -0,0 +1,182 @@ +--- +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
DescriptionThe ``AWS::S3::Bucket`` resource creates an Amazon S3 bucket in the same AWS Region where you create the AWS CloudFormation stack.<br/> To control how AWS CloudFormation handles the bucket when the stack is deleted, you can set a deletion policy for your bucket. You can choose to *retain* the bucket or to *delete* the bucket. For more information, see [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html).<br/> You can only delete empty buckets. Deletion fails for buckets that have contents.
Idaws.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).
arnstring
domain_namestring
dual_stack_domain_namestring
regional_domain_namestring
website_urlstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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_url +FROM aws.s3.bucket +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the bucket resource, the following permissions are required: + +### Read +```json +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 +```json +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 +```json +s3:DeleteBucket, +s3:ListBucket +``` + diff --git a/docs/aws-docs/providers/aws/s3/bucket_accelerate_configurations/index.md b/docs/aws-docs/providers/aws/s3/bucket_accelerate_configurations/index.md deleted file mode 100644 index 7436f49587..0000000000 --- a/docs/aws-docs/providers/aws/s3/bucket_accelerate_configurations/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: bucket_accelerate_configurations -hide_title: false -hide_table_of_contents: false -keywords: - - bucket_accelerate_configurations - - 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 ---- - - - -## Overview - - - - -
Namebucket_accelerate_configurations
TypeResource
Idaws.s3.bucket_accelerate_configurations
- -## Fields -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `bucket_accelerate_configurations_Get` | `SELECT` | `bucket, region` | <p>This implementation of the GET action uses the <code>accelerate</code> subresource to return the Transfer Acceleration state of a bucket, which is either <code>Enabled</code> or <code>Suspended</code>. Amazon S3 Transfer Acceleration is a bucket-level feature that enables you to perform faster data transfers to and from Amazon S3.</p> <p>To use this operation, you must have permission to perform the <code>s3:GetAccelerateConfiguration</code> action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to your Amazon S3 Resources</a> in the <i>Amazon S3 User Guide</i>.</p> <p>You set the Transfer Acceleration state of an existing bucket to <code>Enabled</code> or <code>Suspended</code> by using the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAccelerateConfiguration.html">PutBucketAccelerateConfiguration</a> operation. </p> <p>A GET <code>accelerate</code> request does not return a state value for a bucket that has no transfer acceleration state. A bucket has no Transfer Acceleration state if a state has never been set on the bucket. </p> <p>For more information about transfer acceleration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html">Transfer Acceleration</a> in the Amazon S3 User Guide.</p> <p class="title"> <b>Related Resources</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAccelerateConfiguration.html">PutBucketAccelerateConfiguration</a> </p> </li> </ul> | -| `bucket_accelerate_configurations_Put` | `EXEC` | `bucket, region` | <p>Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration is a bucket-level feature that enables you to perform faster data transfers to Amazon S3.</p> <p> To use this operation, you must have permission to perform the <code>s3:PutAccelerateConfiguration</code> action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p> The Transfer Acceleration state of a bucket can be set to one of the following two values:</p> <ul> <li> <p> Enabled – Enables accelerated data transfers to the bucket.</p> </li> <li> <p> Suspended – Disables accelerated data transfers to the bucket.</p> </li> </ul> <p>The <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAccelerateConfiguration.html">GetBucketAccelerateConfiguration</a> action returns the transfer acceleration state of a bucket.</p> <p>After setting the Transfer Acceleration state of a bucket to Enabled, it might take up to thirty minutes before the data transfer rates to the bucket increase.</p> <p> The name of the bucket used for Transfer Acceleration must be DNS-compliant and must not contain periods (".").</p> <p> For more information about transfer acceleration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html">Transfer Acceleration</a>.</p> <p>The following operations are related to <code>PutBucketAccelerateConfiguration</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAccelerateConfiguration.html">GetBucketAccelerateConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a> </p> </li> </ul> | diff --git a/docs/aws-docs/providers/aws/s3/bucket_acls/index.md b/docs/aws-docs/providers/aws/s3/bucket_acls/index.md deleted file mode 100644 index a2fb331798..0000000000 --- a/docs/aws-docs/providers/aws/s3/bucket_acls/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: bucket_acls -hide_title: false -hide_table_of_contents: false -keywords: - - bucket_acls - - 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 ---- - - - -## Overview - - - - -
Namebucket_acls
TypeResource
Idaws.s3.bucket_acls
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `AccessControlList` | `array` | A list of grants. | -| `Owner` | `object` | Container for the owner's display name and ID. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `bucket_acls_Get` | `SELECT` | `bucket, region` | <p>This implementation of the <code>GET</code> action uses the <code>acl</code> subresource to return the access control list (ACL) of a bucket. To use <code>GET</code> to return the ACL of the bucket, you must have <code>READ_ACP</code> access to the bucket. If <code>READ_ACP</code> permission is granted to the anonymous user, you can return the ACL of the bucket without using an authorization header.</p> <note> <p>If your bucket uses the bucket owner enforced setting for S3 Object Ownership, requests to read ACLs are still supported and return the <code>bucket-owner-full-control</code> ACL with the owner being the account that created the bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html"> Controlling object ownership and disabling ACLs</a> in the <i>Amazon S3 User Guide</i>.</p> </note> <p class="title"> <b>Related Resources</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html">ListObjects</a> </p> </li> </ul> | -| `bucket_acls_Put` | `EXEC` | `bucket, region` | <p>Sets the permissions on an existing bucket using access control lists (ACL). For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html">Using ACLs</a>. To set the ACL of a bucket, you must have <code>WRITE_ACP</code> permission.</p> <p>You can use one of the following two ways to set a bucket's permissions:</p> <ul> <li> <p>Specify the ACL in the request body</p> </li> <li> <p>Specify permissions using request headers</p> </li> </ul> <note> <p>You cannot specify access permission using both the body and the request headers.</p> </note> <p>Depending on your application needs, you may choose to set the ACL on a bucket using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, then you can continue to use that approach.</p> <important> <p>If your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. You must use policies to grant access to your bucket and the objects in it. Requests to set ACLs or update ACLs fail and return the <code>AccessControlListNotSupported</code> error code. Requests to read ACLs are still supported. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">Controlling object ownership</a> in the <i>Amazon S3 User Guide</i>.</p> </important> <p> <b>Access Permissions</b> </p> <p>You can set access permissions using one of the following methods:</p> <ul> <li> <p>Specify a canned ACL with the <code>x-amz-acl</code> request header. Amazon S3 supports a set of predefined ACLs, known as <i>canned ACLs</i>. Each canned ACL has a predefined set of grantees and permissions. Specify the canned ACL name as the value of <code>x-amz-acl</code>. If you use this header, you cannot use other access control-specific headers in your request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL">Canned ACL</a>.</p> </li> <li> <p>Specify access permissions explicitly with the <code>x-amz-grant-read</code>, <code>x-amz-grant-read-acp</code>, <code>x-amz-grant-write-acp</code>, and <code>x-amz-grant-full-control</code> headers. When using these headers, you specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who will receive the permission. If you use these ACL-specific headers, you cannot use the <code>x-amz-acl</code> header to set a canned ACL. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access Control List (ACL) Overview</a>.</p> <p>You specify each grantee as a type=value pair, where the type is one of the following:</p> <ul> <li> <p> <code>id</code> – if the value specified is the canonical user ID of an Amazon Web Services account</p> </li> <li> <p> <code>uri</code> – if you are granting permissions to a predefined group</p> </li> <li> <p> <code>emailAddress</code> – if the value specified is the email address of an Amazon Web Services account</p> <note> <p>Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions: </p> <ul> <li> <p>US East (N. Virginia)</p> </li> <li> <p>US West (N. California)</p> </li> <li> <p> US West (Oregon)</p> </li> <li> <p> Asia Pacific (Singapore)</p> </li> <li> <p>Asia Pacific (Sydney)</p> </li> <li> <p>Asia Pacific (Tokyo)</p> </li> <li> <p>Europe (Ireland)</p> </li> <li> <p>South America (São Paulo)</p> </li> </ul> <p>For a list of all the Amazon S3 supported Regions and endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region">Regions and Endpoints</a> in the Amazon Web Services General Reference.</p> </note> </li> </ul> <p>For example, the following <code>x-amz-grant-write</code> header grants create, overwrite, and delete objects permission to LogDelivery group predefined by Amazon S3 and two Amazon Web Services accounts identified by their email addresses.</p> <p> <code>x-amz-grant-write: uri="http://acs.amazonaws.com/groups/s3/LogDelivery", id="111122223333", id="555566667777" </code> </p> </li> </ul> <p>You can use either a canned ACL or specify access permissions explicitly. You cannot do both.</p> <p> <b>Grantee Values</b> </p> <p>You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:</p> <ul> <li> <p>By the person's ID:</p> <p> <code><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee></code> </p> <p>DisplayName is optional and ignored in the request</p> </li> <li> <p>By URI:</p> <p> <code><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee></code> </p> </li> <li> <p>By Email address:</p> <p> <code><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress>lt;/Grantee></code> </p> <p>The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser. </p> <note> <p>Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions: </p> <ul> <li> <p>US East (N. Virginia)</p> </li> <li> <p>US West (N. California)</p> </li> <li> <p> US West (Oregon)</p> </li> <li> <p> Asia Pacific (Singapore)</p> </li> <li> <p>Asia Pacific (Sydney)</p> </li> <li> <p>Asia Pacific (Tokyo)</p> </li> <li> <p>Europe (Ireland)</p> </li> <li> <p>South America (São Paulo)</p> </li> </ul> <p>For a list of all the Amazon S3 supported Regions and endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region">Regions and Endpoints</a> in the Amazon Web Services General Reference.</p> </note> </li> </ul> <p class="title"> <b>Related Resources</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html">DeleteBucket</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html">GetObjectAcl</a> </p> </li> </ul> | diff --git a/docs/aws-docs/providers/aws/s3/bucket_analytics_configurations/index.md b/docs/aws-docs/providers/aws/s3/bucket_analytics_configurations/index.md deleted file mode 100644 index b8133475a2..0000000000 --- a/docs/aws-docs/providers/aws/s3/bucket_analytics_configurations/index.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: bucket_analytics_configurations -hide_title: false -hide_table_of_contents: false -keywords: - - bucket_analytics_configurations - - 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 ---- - - - -## Overview - - - - -
Namebucket_analytics_configurations
TypeResource
Idaws.s3.bucket_analytics_configurations
- -## Fields -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `bucket_analytics_configurations_Get` | `SELECT` | `id, bucket, region` | <p>This implementation of the GET action returns an analytics configuration (identified by the analytics configuration ID) from the bucket.</p> <p>To use this operation, you must have permissions to perform the <code>s3:GetAnalyticsConfiguration</code> action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources"> Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3 Resources</a> in the <i>Amazon S3 User Guide</i>. </p> <p>For information about Amazon S3 analytics feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html">Amazon S3 Analytics – Storage Class Analysis</a> in the <i>Amazon S3 User Guide</i>.</p> <p class="title"> <b>Related Resources</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html">DeleteBucketAnalyticsConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html">ListBucketAnalyticsConfigurations</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAnalyticsConfiguration.html">PutBucketAnalyticsConfiguration</a> </p> </li> </ul> | -| `bucket_analytics_configurations_List` | `SELECT` | `bucket, region` | <p>Lists the analytics configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.</p> <p>This action supports list pagination and does not return more than 100 configurations at a time. You should always check the <code>IsTruncated</code> element in the response. If there are no more configurations to list, <code>IsTruncated</code> is set to false. If there are more configurations to list, <code>IsTruncated</code> is set to true, and there will be a value in <code>NextContinuationToken</code>. You use the <code>NextContinuationToken</code> value to continue the pagination of the list by passing the value in continuation-token in the request to <code>GET</code> the next page.</p> <p>To use this operation, you must have permissions to perform the <code>s3:GetAnalyticsConfiguration</code> action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p>For information about Amazon S3 analytics feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html">Amazon S3 Analytics – Storage Class Analysis</a>. </p> <p>The following operations are related to <code>ListBucketAnalyticsConfigurations</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html">GetBucketAnalyticsConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html">DeleteBucketAnalyticsConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAnalyticsConfiguration.html">PutBucketAnalyticsConfiguration</a> </p> </li> </ul> | -| `bucket_analytics_configurations_Delete` | `DELETE` | `id, bucket, region` | <p>Deletes an analytics configuration for the bucket (specified by the analytics configuration ID).</p> <p>To use this operation, you must have permissions to perform the <code>s3:PutAnalyticsConfiguration</code> action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p>For information about the Amazon S3 analytics feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html">Amazon S3 Analytics – Storage Class Analysis</a>. </p> <p>The following operations are related to <code>DeleteBucketAnalyticsConfiguration</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html">GetBucketAnalyticsConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html">ListBucketAnalyticsConfigurations</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAnalyticsConfiguration.html">PutBucketAnalyticsConfiguration</a> </p> </li> </ul> | -| `bucket_analytics_configurations_Put` | `EXEC` | `id, bucket, region` | <p>Sets an analytics configuration for the bucket (specified by the analytics configuration ID). You can have up to 1,000 analytics configurations per bucket.</p> <p>You can choose to have storage class analysis export analysis reports sent to a comma-separated values (CSV) flat file. See the <code>DataExport</code> request element. Reports are updated daily and are based on the object filters that you configure. When selecting data export, you specify a destination bucket and an optional destination prefix where the file is written. You can export the data to a destination bucket in a different account. However, the destination bucket must be in the same Region as the bucket that you are making the PUT analytics configuration to. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html">Amazon S3 Analytics – Storage Class Analysis</a>. </p> <important> <p>You must create a bucket policy on the destination bucket where the exported file is written to grant permissions to Amazon S3 to write objects to the bucket. For an example policy, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html#example-bucket-policies-use-case-9">Granting Permissions for Amazon S3 Inventory and Storage Class Analysis</a>.</p> </important> <p>To use this operation, you must have permissions to perform the <code>s3:PutAnalyticsConfiguration</code> action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p class="title"> <b>Special Errors</b> </p> <ul> <li> <ul> <li> <p> <i>HTTP Error: HTTP 400 Bad Request</i> </p> </li> <li> <p> <i>Code: InvalidArgument</i> </p> </li> <li> <p> <i>Cause: Invalid argument.</i> </p> </li> </ul> </li> <li> <ul> <li> <p> <i>HTTP Error: HTTP 400 Bad Request</i> </p> </li> <li> <p> <i>Code: TooManyConfigurations</i> </p> </li> <li> <p> <i>Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.</i> </p> </li> </ul> </li> <li> <ul> <li> <p> <i>HTTP Error: HTTP 403 Forbidden</i> </p> </li> <li> <p> <i>Code: AccessDenied</i> </p> </li> <li> <p> <i>Cause: You are not the owner of the specified bucket, or you do not have the s3:PutAnalyticsConfiguration bucket permission to set the configuration on the bucket.</i> </p> </li> </ul> </li> </ul> <p class="title"> <b>Related Resources</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html">GetBucketAnalyticsConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html">DeleteBucketAnalyticsConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html">ListBucketAnalyticsConfigurations</a> </p> </li> </ul> | diff --git a/docs/aws-docs/providers/aws/s3/bucket_cors/index.md b/docs/aws-docs/providers/aws/s3/bucket_cors/index.md deleted file mode 100644 index 7fb92494d3..0000000000 --- a/docs/aws-docs/providers/aws/s3/bucket_cors/index.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: bucket_cors -hide_title: false -hide_table_of_contents: false -keywords: - - bucket_cors - - 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 ---- - - - -## Overview - - - - -
Namebucket_cors
TypeResource
Idaws.s3.bucket_cors
- -## Fields -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `bucket_cors_Get` | `SELECT` | `bucket, region` | <p>Returns the Cross-Origin Resource Sharing (CORS) configuration information set for the bucket.</p> <p> To use this operation, you must have permission to perform the <code>s3:GetBucketCORS</code> action. By default, the bucket owner has this permission and can grant it to others.</p> <p> For more information about CORS, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html"> Enabling Cross-Origin Resource Sharing</a>.</p> <p>The following operations are related to <code>GetBucketCors</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketCors.html">PutBucketCors</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketCors.html">DeleteBucketCors</a> </p> </li> </ul> | -| `bucket_cors_Delete` | `DELETE` | `bucket, region` | <p>Deletes the <code>cors</code> configuration information set for the bucket.</p> <p>To use this operation, you must have permission to perform the <code>s3:PutBucketCORS</code> action. The bucket owner has this permission by default and can grant this permission to others. </p> <p>For information about <code>cors</code>, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html">Enabling Cross-Origin Resource Sharing</a> in the <i>Amazon S3 User Guide</i>.</p> <p class="title"> <b>Related Resources:</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketCors.html">PutBucketCors</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTOPTIONSobject.html">RESTOPTIONSobject</a> </p> </li> </ul> | -| `bucket_cors_Put` | `EXEC` | `bucket, region` | <p>Sets the <code>cors</code> configuration for your bucket. If the configuration exists, Amazon S3 replaces it.</p> <p>To use this operation, you must be allowed to perform the <code>s3:PutBucketCORS</code> action. By default, the bucket owner has this permission and can grant it to others.</p> <p>You set this configuration on a bucket so that the bucket can service cross-origin requests. For example, you might want to enable a request whose origin is <code>http://www.example.com</code> to access your Amazon S3 bucket at <code>my.example.bucket.com</code> by using the browser's <code>XMLHttpRequest</code> capability.</p> <p>To enable cross-origin resource sharing (CORS) on a bucket, you add the <code>cors</code> subresource to the bucket. The <code>cors</code> subresource is an XML document in which you configure rules that identify origins and the HTTP methods that can be executed on your bucket. The document is limited to 64 KB in size. </p> <p>When Amazon S3 receives a cross-origin request (or a pre-flight OPTIONS request) against a bucket, it evaluates the <code>cors</code> configuration on the bucket and uses the first <code>CORSRule</code> rule that matches the incoming browser request to enable a cross-origin request. For a rule to match, the following conditions must be met:</p> <ul> <li> <p>The request's <code>Origin</code> header must match <code>AllowedOrigin</code> elements.</p> </li> <li> <p>The request method (for example, GET, PUT, HEAD, and so on) or the <code>Access-Control-Request-Method</code> header in case of a pre-flight <code>OPTIONS</code> request must be one of the <code>AllowedMethod</code> elements. </p> </li> <li> <p>Every header specified in the <code>Access-Control-Request-Headers</code> request header of a pre-flight request must match an <code>AllowedHeader</code> element. </p> </li> </ul> <p> For more information about CORS, go to <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html">Enabling Cross-Origin Resource Sharing</a> in the <i>Amazon S3 User Guide</i>.</p> <p class="title"> <b>Related Resources</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketCors.html">GetBucketCors</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketCors.html">DeleteBucketCors</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTOPTIONSobject.html">RESTOPTIONSobject</a> </p> </li> </ul> | diff --git a/docs/aws-docs/providers/aws/s3/bucket_encryptions/index.md b/docs/aws-docs/providers/aws/s3/bucket_encryptions/index.md deleted file mode 100644 index 962f8f90db..0000000000 --- a/docs/aws-docs/providers/aws/s3/bucket_encryptions/index.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: bucket_encryptions -hide_title: false -hide_table_of_contents: false -keywords: - - bucket_encryptions - - 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 ---- - - - -## Overview - - - - -
Namebucket_encryptions
TypeResource
Idaws.s3.bucket_encryptions
- -## Fields -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `bucket_encryptions_Get` | `SELECT` | `bucket, region` | <p>Returns the default encryption configuration for an Amazon S3 bucket. If the bucket does not have a default encryption configuration, GetBucketEncryption returns <code>ServerSideEncryptionConfigurationNotFoundError</code>. </p> <p>For information about the Amazon S3 default encryption feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html">Amazon S3 Default Bucket Encryption</a>.</p> <p> To use this operation, you must have permission to perform the <code>s3:GetEncryptionConfiguration</code> action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p>The following operations are related to <code>GetBucketEncryption</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketEncryption.html">PutBucketEncryption</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html">DeleteBucketEncryption</a> </p> </li> </ul> | -| `bucket_encryptions_Delete` | `DELETE` | `bucket, region` | <p>This implementation of the DELETE action removes default encryption from the bucket. For information about the Amazon S3 default encryption feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html">Amazon S3 Default Bucket Encryption</a> in the <i>Amazon S3 User Guide</i>.</p> <p>To use this operation, you must have permissions to perform the <code>s3:PutEncryptionConfiguration</code> action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to your Amazon S3 Resources</a> in the <i>Amazon S3 User Guide</i>.</p> <p class="title"> <b>Related Resources</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketEncryption.html">PutBucketEncryption</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html">GetBucketEncryption</a> </p> </li> </ul> | -| `bucket_encryptions_Put` | `EXEC` | `bucket, region` | <p>This action uses the <code>encryption</code> subresource to configure default encryption and Amazon S3 Bucket Key for an existing bucket.</p> <p>Default encryption for a bucket can use server-side encryption with Amazon S3-managed keys (SSE-S3) or customer managed keys (SSE-KMS). If you specify default encryption using SSE-KMS, you can also configure Amazon S3 Bucket Key. When the default encryption is SSE-KMS, if you upload an object to the bucket and do not specify the KMS key to use for encryption, Amazon S3 uses the default Amazon Web Services managed KMS key for your account. For information about default encryption, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html">Amazon S3 default bucket encryption</a> in the <i>Amazon S3 User Guide</i>. For more information about S3 Bucket Keys, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html">Amazon S3 Bucket Keys</a> in the <i>Amazon S3 User Guide</i>.</p> <important> <p>This action requires Amazon Web Services Signature Version 4. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html"> Authenticating Requests (Amazon Web Services Signature Version 4)</a>. </p> </important> <p>To use this operation, you must have permissions to perform the <code>s3:PutEncryptionConfiguration</code> action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3 Resources</a> in the Amazon S3 User Guide. </p> <p class="title"> <b>Related Resources</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html">GetBucketEncryption</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html">DeleteBucketEncryption</a> </p> </li> </ul> | diff --git a/docs/aws-docs/providers/aws/s3/bucket_intelligent_tiering_configurations/index.md b/docs/aws-docs/providers/aws/s3/bucket_intelligent_tiering_configurations/index.md deleted file mode 100644 index a6cf06f452..0000000000 --- a/docs/aws-docs/providers/aws/s3/bucket_intelligent_tiering_configurations/index.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: bucket_intelligent_tiering_configurations -hide_title: false -hide_table_of_contents: false -keywords: - - bucket_intelligent_tiering_configurations - - 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 ---- - - - -## Overview - - - - -
Namebucket_intelligent_tiering_configurations
TypeResource
Idaws.s3.bucket_intelligent_tiering_configurations
- -## Fields -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `bucket_intelligent_tiering_configurations_Get` | `SELECT` | `id, bucket, region` | <p>Gets the S3 Intelligent-Tiering configuration from the specified bucket.</p> <p>The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.</p> <p>The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access">Storage class for automatically optimizing frequently and infrequently accessed objects</a>.</p> <p>Operations related to <code>GetBucketIntelligentTieringConfiguration</code> include: </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketIntelligentTieringConfiguration.html">DeleteBucketIntelligentTieringConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketIntelligentTieringConfiguration.html">PutBucketIntelligentTieringConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketIntelligentTieringConfigurations.html">ListBucketIntelligentTieringConfigurations</a> </p> </li> </ul> | -| `bucket_intelligent_tiering_configurations_List` | `SELECT` | `bucket, region` | <p>Lists the S3 Intelligent-Tiering configuration from the specified bucket.</p> <p>The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.</p> <p>The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access">Storage class for automatically optimizing frequently and infrequently accessed objects</a>.</p> <p>Operations related to <code>ListBucketIntelligentTieringConfigurations</code> include: </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketIntelligentTieringConfiguration.html">DeleteBucketIntelligentTieringConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketIntelligentTieringConfiguration.html">PutBucketIntelligentTieringConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketIntelligentTieringConfiguration.html">GetBucketIntelligentTieringConfiguration</a> </p> </li> </ul> | -| `bucket_intelligent_tiering_configurations_Delete` | `DELETE` | `id, bucket, region` | <p>Deletes the S3 Intelligent-Tiering configuration from the specified bucket.</p> <p>The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.</p> <p>The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access">Storage class for automatically optimizing frequently and infrequently accessed objects</a>.</p> <p>Operations related to <code>DeleteBucketIntelligentTieringConfiguration</code> include: </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketIntelligentTieringConfiguration.html">GetBucketIntelligentTieringConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketIntelligentTieringConfiguration.html">PutBucketIntelligentTieringConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketIntelligentTieringConfigurations.html">ListBucketIntelligentTieringConfigurations</a> </p> </li> </ul> | -| `bucket_intelligent_tiering_configurations_Put` | `EXEC` | `id, bucket, region` | <p>Puts a S3 Intelligent-Tiering configuration to the specified bucket. You can have up to 1,000 S3 Intelligent-Tiering configurations per bucket.</p> <p>The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.</p> <p>The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access">Storage class for automatically optimizing frequently and infrequently accessed objects</a>.</p> <p>Operations related to <code>PutBucketIntelligentTieringConfiguration</code> include: </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketIntelligentTieringConfiguration.html">DeleteBucketIntelligentTieringConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketIntelligentTieringConfiguration.html">GetBucketIntelligentTieringConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketIntelligentTieringConfigurations.html">ListBucketIntelligentTieringConfigurations</a> </p> </li> </ul> <note> <p>You only need S3 Intelligent-Tiering enabled on a bucket if you want to automatically move objects stored in the S3 Intelligent-Tiering storage class to the Archive Access or Deep Archive Access tier.</p> </note> <p class="title"> <b>Special Errors</b> </p> <ul> <li> <p class="title"> <b>HTTP 400 Bad Request Error</b> </p> <ul> <li> <p> <i>Code:</i> InvalidArgument</p> </li> <li> <p> <i>Cause:</i> Invalid Argument</p> </li> </ul> </li> <li> <p class="title"> <b>HTTP 400 Bad Request Error</b> </p> <ul> <li> <p> <i>Code:</i> TooManyConfigurations</p> </li> <li> <p> <i>Cause:</i> You are attempting to create a new configuration but have already reached the 1,000-configuration limit. </p> </li> </ul> </li> <li> <p class="title"> <b>HTTP 403 Forbidden Error</b> </p> <ul> <li> <p> <i>Code:</i> AccessDenied</p> </li> <li> <p> <i>Cause:</i> You are not the owner of the specified bucket, or you do not have the <code>s3:PutIntelligentTieringConfiguration</code> bucket permission to set the configuration on the bucket. </p> </li> </ul> </li> </ul> | diff --git a/docs/aws-docs/providers/aws/s3/bucket_inventory_configurations/index.md b/docs/aws-docs/providers/aws/s3/bucket_inventory_configurations/index.md deleted file mode 100644 index 40ce3e5e4d..0000000000 --- a/docs/aws-docs/providers/aws/s3/bucket_inventory_configurations/index.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: bucket_inventory_configurations -hide_title: false -hide_table_of_contents: false -keywords: - - bucket_inventory_configurations - - 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 ---- - - - -## Overview - - - - -
Namebucket_inventory_configurations
TypeResource
Idaws.s3.bucket_inventory_configurations
- -## Fields -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `bucket_inventory_configurations_Get` | `SELECT` | `id, bucket, region` | <p>Returns an inventory configuration (identified by the inventory configuration ID) from the bucket.</p> <p>To use this operation, you must have permissions to perform the <code>s3:GetInventoryConfiguration</code> action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p>For information about the Amazon S3 inventory feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html">Amazon S3 Inventory</a>.</p> <p>The following operations are related to <code>GetBucketInventoryConfiguration</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html">DeleteBucketInventoryConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html">ListBucketInventoryConfigurations</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketInventoryConfiguration.html">PutBucketInventoryConfiguration</a> </p> </li> </ul> | -| `bucket_inventory_configurations_List` | `SELECT` | `bucket, region` | <p>Returns a list of inventory configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.</p> <p>This action supports list pagination and does not return more than 100 configurations at a time. Always check the <code>IsTruncated</code> element in the response. If there are no more configurations to list, <code>IsTruncated</code> is set to false. If there are more configurations to list, <code>IsTruncated</code> is set to true, and there is a value in <code>NextContinuationToken</code>. You use the <code>NextContinuationToken</code> value to continue the pagination of the list by passing the value in continuation-token in the request to <code>GET</code> the next page.</p> <p> To use this operation, you must have permissions to perform the <code>s3:GetInventoryConfiguration</code> action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p>For information about the Amazon S3 inventory feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html">Amazon S3 Inventory</a> </p> <p>The following operations are related to <code>ListBucketInventoryConfigurations</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html">GetBucketInventoryConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html">DeleteBucketInventoryConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketInventoryConfiguration.html">PutBucketInventoryConfiguration</a> </p> </li> </ul> | -| `bucket_inventory_configurations_Delete` | `DELETE` | `id, bucket, region` | <p>Deletes an inventory configuration (identified by the inventory ID) from the bucket.</p> <p>To use this operation, you must have permissions to perform the <code>s3:PutInventoryConfiguration</code> action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p>For information about the Amazon S3 inventory feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html">Amazon S3 Inventory</a>.</p> <p>Operations related to <code>DeleteBucketInventoryConfiguration</code> include: </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html">GetBucketInventoryConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketInventoryConfiguration.html">PutBucketInventoryConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html">ListBucketInventoryConfigurations</a> </p> </li> </ul> | -| `bucket_inventory_configurations_Put` | `EXEC` | `id, bucket, region` | <p>This implementation of the <code>PUT</code> action adds an inventory configuration (identified by the inventory ID) to the bucket. You can have up to 1,000 inventory configurations per bucket. </p> <p>Amazon S3 inventory generates inventories of the objects in the bucket on a daily or weekly basis, and the results are published to a flat file. The bucket that is inventoried is called the <i>source</i> bucket, and the bucket where the inventory flat file is stored is called the <i>destination</i> bucket. The <i>destination</i> bucket must be in the same Amazon Web Services Region as the <i>source</i> bucket. </p> <p>When you configure an inventory for a <i>source</i> bucket, you specify the <i>destination</i> bucket where you want the inventory to be stored, and whether to generate the inventory daily or weekly. You can also configure what object metadata to include and whether to inventory all object versions or only current versions. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html">Amazon S3 Inventory</a> in the Amazon S3 User Guide.</p> <important> <p>You must create a bucket policy on the <i>destination</i> bucket to grant permissions to Amazon S3 to write objects to the bucket in the defined location. For an example policy, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html#example-bucket-policies-use-case-9"> Granting Permissions for Amazon S3 Inventory and Storage Class Analysis</a>.</p> </important> <p>To use this operation, you must have permissions to perform the <code>s3:PutInventoryConfiguration</code> action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3 Resources</a> in the Amazon S3 User Guide.</p> <p class="title"> <b>Special Errors</b> </p> <ul> <li> <p class="title"> <b>HTTP 400 Bad Request Error</b> </p> <ul> <li> <p> <i>Code:</i> InvalidArgument</p> </li> <li> <p> <i>Cause:</i> Invalid Argument</p> </li> </ul> </li> <li> <p class="title"> <b>HTTP 400 Bad Request Error</b> </p> <ul> <li> <p> <i>Code:</i> TooManyConfigurations</p> </li> <li> <p> <i>Cause:</i> You are attempting to create a new configuration but have already reached the 1,000-configuration limit. </p> </li> </ul> </li> <li> <p class="title"> <b>HTTP 403 Forbidden Error</b> </p> <ul> <li> <p> <i>Code:</i> AccessDenied</p> </li> <li> <p> <i>Cause:</i> You are not the owner of the specified bucket, or you do not have the <code>s3:PutInventoryConfiguration</code> bucket permission to set the configuration on the bucket. </p> </li> </ul> </li> </ul> <p class="title"> <b>Related Resources</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html">GetBucketInventoryConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html">DeleteBucketInventoryConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html">ListBucketInventoryConfigurations</a> </p> </li> </ul> | diff --git a/docs/aws-docs/providers/aws/s3/bucket_lifecycle_configurations/index.md b/docs/aws-docs/providers/aws/s3/bucket_lifecycle_configurations/index.md deleted file mode 100644 index 395698e5d3..0000000000 --- a/docs/aws-docs/providers/aws/s3/bucket_lifecycle_configurations/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: bucket_lifecycle_configurations -hide_title: false -hide_table_of_contents: false -keywords: - - bucket_lifecycle_configurations - - 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 ---- - - - -## Overview - - - - -
Namebucket_lifecycle_configurations
TypeResource
Idaws.s3.bucket_lifecycle_configurations
- -## Fields -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `bucket_lifecycle_configurations_Get` | `SELECT` | `bucket, region` | <note> <p>Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The response describes the new filter element that you can use to specify a filter to select a subset of objects to which the rule applies. If you are using a previous version of the lifecycle configuration, it still works. For the earlier action, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html">GetBucketLifecycle</a>.</p> </note> <p>Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html">Object Lifecycle Management</a>.</p> <p>To use this operation, you must have permission to perform the <code>s3:GetLifecycleConfiguration</code> action. The bucket owner has this permission, by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p> <code>GetBucketLifecycleConfiguration</code> has the following special error:</p> <ul> <li> <p>Error code: <code>NoSuchLifecycleConfiguration</code> </p> <ul> <li> <p>Description: The lifecycle configuration does not exist.</p> </li> <li> <p>HTTP Status Code: 404 Not Found</p> </li> <li> <p>SOAP Fault Code Prefix: Client</p> </li> </ul> </li> </ul> <p>The following operations are related to <code>GetBucketLifecycleConfiguration</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html">GetBucketLifecycle</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html">PutBucketLifecycle</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html">DeleteBucketLifecycle</a> </p> </li> </ul> | -| `bucket_lifecycle_configurations_Put` | `EXEC` | `bucket, region` | <p>Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. Keep in mind that this will overwrite an existing lifecycle configuration, so if you want to retain any configuration details, they must be included in the new lifecycle configuration. For information about lifecycle configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html">Managing your storage lifecycle</a>.</p> <note> <p>Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The previous version of the API supported filtering based only on an object key name prefix, which is supported for backward compatibility. For the related API description, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html">PutBucketLifecycle</a>.</p> </note> <p> <b>Rules</b> </p> <p>You specify the lifecycle configuration in your request body. The lifecycle configuration is specified as XML consisting of one or more rules. An Amazon S3 Lifecycle configuration can have up to 1,000 rules. This limit is not adjustable. Each rule consists of the following:</p> <ul> <li> <p>Filter identifying a subset of objects to which the rule applies. The filter can be based on a key name prefix, object tags, or a combination of both.</p> </li> <li> <p>Status whether the rule is in effect.</p> </li> <li> <p>One or more lifecycle transition and expiration actions that you want Amazon S3 to perform on the objects identified by the filter. If the state of your bucket is versioning-enabled or versioning-suspended, you can have many versions of the same object (one current version and zero or more noncurrent versions). Amazon S3 provides predefined actions that you can specify for current and noncurrent object versions.</p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html">Object Lifecycle Management</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html">Lifecycle Configuration Elements</a>.</p> <p> <b>Permissions</b> </p> <p>By default, all Amazon S3 resources are private, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration). Only the resource owner (that is, the Amazon Web Services account that created it) can access the resource. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, a user must get the <code>s3:PutLifecycleConfiguration</code> permission.</p> <p>You can also explicitly deny permissions. Explicit deny also supersedes any other permissions. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions:</p> <ul> <li> <p> <code>s3:DeleteObject</code> </p> </li> <li> <p> <code>s3:DeleteObjectVersion</code> </p> </li> <li> <p> <code>s3:PutLifecycleConfiguration</code> </p> </li> </ul> <p>For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p>The following are related to <code>PutBucketLifecycleConfiguration</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-configuration-examples.html">Examples of Lifecycle Configuration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html">GetBucketLifecycleConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html">DeleteBucketLifecycle</a> </p> </li> </ul> | diff --git a/docs/aws-docs/providers/aws/s3/bucket_lifecycles/index.md b/docs/aws-docs/providers/aws/s3/bucket_lifecycles/index.md deleted file mode 100644 index 90768ca371..0000000000 --- a/docs/aws-docs/providers/aws/s3/bucket_lifecycles/index.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: bucket_lifecycles -hide_title: false -hide_table_of_contents: false -keywords: - - bucket_lifecycles - - 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 ---- - - - -## Overview - - - - -
Namebucket_lifecycles
TypeResource
Idaws.s3.bucket_lifecycles
- -## Fields -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `bucket_lifecycles_Get` | `SELECT` | `bucket, region` | <important> <p>For an updated version of this API, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html">GetBucketLifecycleConfiguration</a>. If you configured a bucket lifecycle using the <code>filter</code> element, you should see the updated version of this topic. This topic is provided for backward compatibility.</p> </important> <p>Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html">Object Lifecycle Management</a>.</p> <p> To use this operation, you must have permission to perform the <code>s3:GetLifecycleConfiguration</code> action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p> <code>GetBucketLifecycle</code> has the following special error:</p> <ul> <li> <p>Error code: <code>NoSuchLifecycleConfiguration</code> </p> <ul> <li> <p>Description: The lifecycle configuration does not exist.</p> </li> <li> <p>HTTP Status Code: 404 Not Found</p> </li> <li> <p>SOAP Fault Code Prefix: Client</p> </li> </ul> </li> </ul> <p>The following operations are related to <code>GetBucketLifecycle</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html">GetBucketLifecycleConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html">PutBucketLifecycle</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html">DeleteBucketLifecycle</a> </p> </li> </ul> | -| `bucket_lifecycles_Delete` | `DELETE` | `bucket, region` | <p>Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration.</p> <p>To use this operation, you must have permission to perform the <code>s3:PutLifecycleConfiguration</code> action. By default, the bucket owner has this permission and the bucket owner can grant this permission to others.</p> <p>There is usually some time lag before lifecycle configuration deletion is fully propagated to all the Amazon S3 systems.</p> <p>For more information about the object expiration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#intro-lifecycle-rules-actions">Elements to Describe Lifecycle Actions</a>.</p> <p>Related actions include:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html">GetBucketLifecycleConfiguration</a> </p> </li> </ul> | -| `bucket_lifecycles_Put` | `EXEC` | `bucket, region` | <important> <p>For an updated version of this API, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a>. This version has been deprecated. Existing lifecycle configurations will work. For new lifecycle configurations, use the updated API. </p> </important> <p>Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. For information about lifecycle configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html">Object Lifecycle Management</a> in the <i>Amazon S3 User Guide</i>. </p> <p>By default, all Amazon S3 resources, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration) are private. Only the resource owner, the Amazon Web Services account that created the resource, can access it. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, users must get the <code>s3:PutLifecycleConfiguration</code> permission.</p> <p>You can also explicitly deny permissions. Explicit denial also supersedes any other permissions. If you want to prevent users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions: </p> <ul> <li> <p> <code>s3:DeleteObject</code> </p> </li> <li> <p> <code>s3:DeleteObjectVersion</code> </p> </li> <li> <p> <code>s3:PutLifecycleConfiguration</code> </p> </li> </ul> <p>For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to your Amazon S3 Resources</a> in the <i>Amazon S3 User Guide</i>.</p> <p>For more examples of transitioning objects to storage classes such as STANDARD_IA or ONEZONE_IA, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#lifecycle-configuration-examples">Examples of Lifecycle Configuration</a>.</p> <p class="title"> <b>Related Resources</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html">GetBucketLifecycle</a>(Deprecated)</p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html">GetBucketLifecycleConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html">RestoreObject</a> </p> </li> <li> <p>By default, a resource owner—in this case, a bucket owner, which is the Amazon Web Services account that created the bucket—can perform any of the operations. A resource owner can also grant others permission to perform the operation. For more information, see the following topics in the Amazon S3 User Guide: </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in a Policy</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to your Amazon S3 Resources</a> </p> </li> </ul> </li> </ul> | diff --git a/docs/aws-docs/providers/aws/s3/bucket_locations/index.md b/docs/aws-docs/providers/aws/s3/bucket_locations/index.md deleted file mode 100644 index 25ecd4605f..0000000000 --- a/docs/aws-docs/providers/aws/s3/bucket_locations/index.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: bucket_locations -hide_title: false -hide_table_of_contents: false -keywords: - - bucket_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 ---- - - - -## Overview - - - - -
Namebucket_locations
TypeResource
Idaws.s3.bucket_locations
- -## Fields -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `bucket_locations_Get` | `SELECT` | `bucket, region` | diff --git a/docs/aws-docs/providers/aws/s3/bucket_loggings/index.md b/docs/aws-docs/providers/aws/s3/bucket_loggings/index.md deleted file mode 100644 index 6f82bea99a..0000000000 --- a/docs/aws-docs/providers/aws/s3/bucket_loggings/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: bucket_loggings -hide_title: false -hide_table_of_contents: false -keywords: - - bucket_loggings - - 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 ---- - - - -## Overview - - - - -
Namebucket_loggings
TypeResource
Idaws.s3.bucket_loggings
- -## Fields -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `bucket_loggings_Get` | `SELECT` | `bucket, region` | <p>Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the bucket owner.</p> <p>The following operations are related to <code>GetBucketLogging</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLogging.html">PutBucketLogging</a> </p> </li> </ul> | -| `bucket_loggings_Put` | `EXEC` | `bucket, region` | <p>Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. All logs are saved to buckets in the same Amazon Web Services Region as the source bucket. To set the logging status of a bucket, you must be the bucket owner.</p> <p>The bucket owner is automatically granted FULL_CONTROL to all logs. You use the <code>Grantee</code> request element to grant access to other people. The <code>Permissions</code> request element specifies the kind of access the grantee has to the logs.</p> <important> <p>If the target bucket for log delivery uses the bucket owner enforced setting for S3 Object Ownership, you can't use the <code>Grantee</code> request element to grant access to others. Permissions can only be granted using policies. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-server-access-logging.html#grant-log-delivery-permissions-general">Permissions for server access log delivery</a> in the <i>Amazon S3 User Guide</i>.</p> </important> <p> <b>Grantee Values</b> </p> <p>You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:</p> <ul> <li> <p>By the person's ID:</p> <p> <code><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee></code> </p> <p>DisplayName is optional and ignored in the request.</p> </li> <li> <p>By Email address:</p> <p> <code> <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee></code> </p> <p>The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.</p> </li> <li> <p>By URI:</p> <p> <code><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee></code> </p> </li> </ul> <p>To enable logging, you use LoggingEnabled and its children request elements. To disable logging, you use an empty BucketLoggingStatus request element:</p> <p> <code><BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" /></code> </p> <p>For more information about server access logging, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerLogs.html">Server Access Logging</a> in the <i>Amazon S3 User Guide</i>. </p> <p>For more information about creating a bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a>. For more information about returning the logging status of a bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLogging.html">GetBucketLogging</a>.</p> <p>The following operations are related to <code>PutBucketLogging</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html">DeleteBucket</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLogging.html">GetBucketLogging</a> </p> </li> </ul> | diff --git a/docs/aws-docs/providers/aws/s3/bucket_metrics_configurations/index.md b/docs/aws-docs/providers/aws/s3/bucket_metrics_configurations/index.md deleted file mode 100644 index 0a80aa8feb..0000000000 --- a/docs/aws-docs/providers/aws/s3/bucket_metrics_configurations/index.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: bucket_metrics_configurations -hide_title: false -hide_table_of_contents: false -keywords: - - bucket_metrics_configurations - - 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 ---- - - - -## Overview - - - - -
Namebucket_metrics_configurations
TypeResource
Idaws.s3.bucket_metrics_configurations
- -## Fields -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `bucket_metrics_configurations_Get` | `SELECT` | `id, bucket, region` | <p>Gets a metrics configuration (specified by the metrics configuration ID) from the bucket. Note that this doesn't include the daily storage metrics.</p> <p> To use this operation, you must have permissions to perform the <code>s3:GetMetricsConfiguration</code> action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p> For information about CloudWatch request metrics for Amazon S3, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring Metrics with Amazon CloudWatch</a>.</p> <p>The following operations are related to <code>GetBucketMetricsConfiguration</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html">PutBucketMetricsConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html">DeleteBucketMetricsConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketMetricsConfigurations.html">ListBucketMetricsConfigurations</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring Metrics with Amazon CloudWatch</a> </p> </li> </ul> | -| `bucket_metrics_configurations_List` | `SELECT` | `bucket, region` | <p>Lists the metrics configurations for the bucket. The metrics configurations are only for the request metrics of the bucket and do not provide information on daily storage metrics. You can have up to 1,000 configurations per bucket.</p> <p>This action supports list pagination and does not return more than 100 configurations at a time. Always check the <code>IsTruncated</code> element in the response. If there are no more configurations to list, <code>IsTruncated</code> is set to false. If there are more configurations to list, <code>IsTruncated</code> is set to true, and there is a value in <code>NextContinuationToken</code>. You use the <code>NextContinuationToken</code> value to continue the pagination of the list by passing the value in <code>continuation-token</code> in the request to <code>GET</code> the next page.</p> <p>To use this operation, you must have permissions to perform the <code>s3:GetMetricsConfiguration</code> action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p>For more information about metrics configurations and CloudWatch request metrics, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring Metrics with Amazon CloudWatch</a>.</p> <p>The following operations are related to <code>ListBucketMetricsConfigurations</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html">PutBucketMetricsConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html">GetBucketMetricsConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html">DeleteBucketMetricsConfiguration</a> </p> </li> </ul> | -| `bucket_metrics_configurations_Delete` | `DELETE` | `id, bucket, region` | <p>Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified by the metrics configuration ID) from the bucket. Note that this doesn't include the daily storage metrics.</p> <p> To use this operation, you must have permissions to perform the <code>s3:PutMetricsConfiguration</code> action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p>For information about CloudWatch request metrics for Amazon S3, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring Metrics with Amazon CloudWatch</a>. </p> <p>The following operations are related to <code>DeleteBucketMetricsConfiguration</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html">GetBucketMetricsConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html">PutBucketMetricsConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketMetricsConfigurations.html">ListBucketMetricsConfigurations</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring Metrics with Amazon CloudWatch</a> </p> </li> </ul> | -| `bucket_metrics_configurations_Put` | `EXEC` | `id, bucket, region` | <p>Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. You can have up to 1,000 metrics configurations per 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.</p> <p>To use this operation, you must have permissions to perform the <code>s3:PutMetricsConfiguration</code> action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p>For information about CloudWatch request metrics for Amazon S3, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring Metrics with Amazon CloudWatch</a>.</p> <p>The following operations are related to <code>PutBucketMetricsConfiguration</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html">DeleteBucketMetricsConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html">GetBucketMetricsConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketMetricsConfigurations.html">ListBucketMetricsConfigurations</a> </p> </li> </ul> <p> <code>GetBucketLifecycle</code> has the following special error:</p> <ul> <li> <p>Error code: <code>TooManyConfigurations</code> </p> <ul> <li> <p>Description: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.</p> </li> <li> <p>HTTP Status Code: HTTP 400 Bad Request</p> </li> </ul> </li> </ul> | diff --git a/docs/aws-docs/providers/aws/s3/bucket_notification_configurations/index.md b/docs/aws-docs/providers/aws/s3/bucket_notification_configurations/index.md deleted file mode 100644 index 0996b5be9f..0000000000 --- a/docs/aws-docs/providers/aws/s3/bucket_notification_configurations/index.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: bucket_notification_configurations -hide_title: false -hide_table_of_contents: false -keywords: - - bucket_notification_configurations - - 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 ---- - - - -## Overview - - - - -
Namebucket_notification_configurations
TypeResource
Idaws.s3.bucket_notification_configurations
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `CloudFunctionConfiguration` | `array` | Describes the Lambda functions to invoke and the events for which to invoke them. | -| `EventBridgeConfiguration` | `object` | A container for specifying the configuration for Amazon EventBridge. | -| `QueueConfiguration` | `array` | The Amazon Simple Queue Service queues to publish messages to and the events for which to publish messages. | -| `TopicConfiguration` | `array` | The topic to which notifications are sent and the events for which notifications are generated. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `bucket_notification_configurations_Get` | `SELECT` | `bucket, region` | <p>Returns the notification configuration of a bucket.</p> <p>If notifications are not enabled on the bucket, the action returns an empty <code>NotificationConfiguration</code> element.</p> <p>By default, you must be the bucket owner to read the notification configuration of a bucket. However, the bucket owner can use a bucket policy to grant permission to other users to read this configuration with the <code>s3:GetBucketNotification</code> permission.</p> <p>For more information about setting and reading the notification configuration on a bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Setting Up Notification of Bucket Events</a>. For more information about bucket policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html">Using Bucket Policies</a>.</p> <p>The following action is related to <code>GetBucketNotification</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketNotification.html">PutBucketNotification</a> </p> </li> </ul> | -| `bucket_notification_configurations_Put` | `EXEC` | `bucket, region` | <p>Enables notifications of specified events for a bucket. For more information about event notifications, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Configuring Event Notifications</a>.</p> <p>Using this API, you can replace an existing notification configuration. The configuration is an XML file that defines the event types that you want Amazon S3 to publish and the destination where you want Amazon S3 to publish an event notification when it detects an event of the specified type.</p> <p>By default, your bucket has no event notifications configured. That is, the notification configuration will be an empty <code>NotificationConfiguration</code>.</p> <p> <code><NotificationConfiguration></code> </p> <p> <code></NotificationConfiguration></code> </p> <p>This action replaces the existing notification configuration with the configuration you include in the request body.</p> <p>After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and that the bucket owner has permission to publish to it by sending a test notification. In the case of Lambda destinations, Amazon S3 verifies that the Lambda function permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Configuring Notifications for Amazon S3 Events</a>.</p> <p>You can disable notifications by adding the empty NotificationConfiguration element.</p> <p>For more information about the number of event notification configurations that you can create per bucket, see <a href="https://docs.aws.amazon.com/general/latest/gr/s3.html#limits_s3">Amazon S3 service quotas</a> in <i>Amazon Web Services General Reference</i>.</p> <p>By default, only the bucket owner can configure notifications on a bucket. However, bucket owners can use a bucket policy to grant permission to other users to set this configuration with <code>s3:PutBucketNotification</code> permission.</p> <note> <p>The PUT notification is an atomic operation. For example, suppose your notification configuration includes SNS topic, SQS queue, and Lambda function configurations. When you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS topic. If the message fails, the entire PUT action will fail, and Amazon S3 will not add the configuration to your bucket.</p> </note> <p> <b>Responses</b> </p> <p>If the configuration in the request body includes only one <code>TopicConfiguration</code> specifying only the <code>s3:ReducedRedundancyLostObject</code> event type, the response will also include the <code>x-amz-sns-test-message-id</code> header containing the message ID of the test notification sent to the topic.</p> <p>The following action is related to <code>PutBucketNotificationConfiguration</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketNotificationConfiguration.html">GetBucketNotificationConfiguration</a> </p> </li> </ul> | diff --git a/docs/aws-docs/providers/aws/s3/bucket_notifications/index.md b/docs/aws-docs/providers/aws/s3/bucket_notifications/index.md deleted file mode 100644 index 6534e2967e..0000000000 --- a/docs/aws-docs/providers/aws/s3/bucket_notifications/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: bucket_notifications -hide_title: false -hide_table_of_contents: false -keywords: - - bucket_notifications - - 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 ---- - - - -## Overview - - - - -
Namebucket_notifications
TypeResource
Idaws.s3.bucket_notifications
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `CloudFunctionConfiguration` | `object` | Container for specifying the Lambda notification configuration. | -| `QueueConfiguration` | `object` | This data type is deprecated. Use <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_QueueConfiguration.html">QueueConfiguration</a> for the same purposes. This data type specifies the configuration for publishing messages to an Amazon Simple Queue Service (Amazon SQS) queue when Amazon S3 detects specified events. | -| `TopicConfiguration` | `object` | A container for specifying the configuration for publication of messages to an Amazon Simple Notification Service (Amazon SNS) topic when Amazon S3 detects specified events. This data type is deprecated. Use <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_TopicConfiguration.html">TopicConfiguration</a> instead. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `bucket_notifications_Get` | `SELECT` | `bucket, region` | No longer used, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketNotificationConfiguration.html">GetBucketNotificationConfiguration</a>. | -| `bucket_notifications_Put` | `EXEC` | `bucket, region` | No longer used, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketNotificationConfiguration.html">PutBucketNotificationConfiguration</a> operation. | diff --git a/docs/aws-docs/providers/aws/s3/bucket_ownership_controls/index.md b/docs/aws-docs/providers/aws/s3/bucket_ownership_controls/index.md deleted file mode 100644 index 8152a76f85..0000000000 --- a/docs/aws-docs/providers/aws/s3/bucket_ownership_controls/index.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: bucket_ownership_controls -hide_title: false -hide_table_of_contents: false -keywords: - - bucket_ownership_controls - - 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 ---- - - - -## Overview - - - - -
Namebucket_ownership_controls
TypeResource
Idaws.s3.bucket_ownership_controls
- -## Fields -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `bucket_ownership_controls_Get` | `SELECT` | `bucket, region` | <p>Retrieves <code>OwnershipControls</code> for an Amazon S3 bucket. To use this operation, you must have the <code>s3:GetBucketOwnershipControls</code> permission. For more information about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html">Specifying permissions in a policy</a>. </p> <p>For information about Amazon S3 Object Ownership, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">Using Object Ownership</a>. </p> <p>The following operations are related to <code>GetBucketOwnershipControls</code>:</p> <ul> <li> <p> <a>PutBucketOwnershipControls</a> </p> </li> <li> <p> <a>DeleteBucketOwnershipControls</a> </p> </li> </ul> | -| `bucket_ownership_controls_Delete` | `DELETE` | `bucket, region` | <p>Removes <code>OwnershipControls</code> for an Amazon S3 bucket. To use this operation, you must have the <code>s3:PutBucketOwnershipControls</code> permission. For more information about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in a Policy</a>.</p> <p>For information about Amazon S3 Object Ownership, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/about-object-ownership.html">Using Object Ownership</a>. </p> <p>The following operations are related to <code>DeleteBucketOwnershipControls</code>:</p> <ul> <li> <p> <a>GetBucketOwnershipControls</a> </p> </li> <li> <p> <a>PutBucketOwnershipControls</a> </p> </li> </ul> | -| `bucket_ownership_controls_Put` | `EXEC` | `bucket, region` | <p>Creates or modifies <code>OwnershipControls</code> for an Amazon S3 bucket. To use this operation, you must have the <code>s3:PutBucketOwnershipControls</code> permission. For more information about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/user-guide/using-with-s3-actions.html">Specifying permissions in a policy</a>. </p> <p>For information about Amazon S3 Object Ownership, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/user-guide/about-object-ownership.html">Using object ownership</a>. </p> <p>The following operations are related to <code>PutBucketOwnershipControls</code>:</p> <ul> <li> <p> <a>GetBucketOwnershipControls</a> </p> </li> <li> <p> <a>DeleteBucketOwnershipControls</a> </p> </li> </ul> | diff --git a/docs/aws-docs/providers/aws/s3/bucket_policies/index.md b/docs/aws-docs/providers/aws/s3/bucket_policies/index.md index c71ce4e02a..a41c8d51c8 100644 --- a/docs/aws-docs/providers/aws/s3/bucket_policies/index.md +++ b/docs/aws-docs/providers/aws/s3/bucket_policies/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - bucket_policies - s3 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,20 +14,66 @@ description: Query, deploy 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
DescriptionApplies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than the root user of the AWS-account that owns the bucket, the calling identity must have the ``PutBucketPolicy`` permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.<br/> If you don't have ``PutBucketPolicy`` permissions, Amazon S3 returns a ``403 Access Denied`` error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a ``405 Method Not Allowed`` error.<br/> As a security precaution, the root user of the AWS-account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action. <br/> For more information, see [Bucket policy examples](https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html).<br/> The following operations are related to ``PutBucketPolicy``:<br/> + [CreateBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) <br/> + [DeleteBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html)
Idaws.s3.bucket_policies
## Fields + + + + + +
NameDatatypeDescription
bucketstringThe name of the Amazon S3 bucket to which the policy applies.
regionstringAWS region.
+ ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `bucket_policies_Get` | `SELECT` | `bucket, region` | <p>Returns the policy of a specified bucket. If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the <code>GetBucketPolicy</code> permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.</p> <p>If you don't have <code>GetBucketPolicy</code> permissions, Amazon S3 returns a <code>403 Access Denied</code> error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a <code>405 Method Not Allowed</code> error.</p> <important> <p>As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.</p> </important> <p>For more information about bucket policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html">Using Bucket Policies and User Policies</a>.</p> <p>The following action is related to <code>GetBucketPolicy</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a> </p> </li> </ul> | -| `bucket_policies_Delete` | `DELETE` | `bucket, region` | <p>This implementation of the DELETE action uses the policy subresource to delete the policy of a specified bucket. If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the <code>DeleteBucketPolicy</code> permissions on the specified bucket and belong to the bucket owner's account to use this operation. </p> <p>If you don't have <code>DeleteBucketPolicy</code> permissions, Amazon S3 returns a <code>403 Access Denied</code> error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a <code>405 Method Not Allowed</code> error. </p> <important> <p>As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.</p> </important> <p>For more information about bucket policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html">Using Bucket Policies and UserPolicies</a>. </p> <p>The following operations are related to <code>DeleteBucketPolicy</code> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html">DeleteObject</a> </p> </li> </ul> | -| `bucket_policies_Put` | `EXEC` | `bucket, region` | <p>Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the <code>PutBucketPolicy</code> permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.</p> <p>If you don't have <code>PutBucketPolicy</code> permissions, Amazon S3 returns a <code>403 Access Denied</code> error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a <code>405 Method Not Allowed</code> error.</p> <important> <p> As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action. </p> </important> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html">Bucket policy examples</a>.</p> <p>The following operations are related to <code>PutBucketPolicy</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html">DeleteBucket</a> </p> </li> </ul> | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +bucket +FROM aws.s3.bucket_policies +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the bucket_policies resource, the following permissions are required: + +### Create +```json +s3:GetBucketPolicy, +s3:PutBucketPolicy +``` + +### List +```json +s3:GetBucketPolicy, +s3:ListAllMyBuckets +``` + diff --git a/docs/aws-docs/providers/aws/s3/bucket_policy/index.md b/docs/aws-docs/providers/aws/s3/bucket_policy/index.md new file mode 100644 index 0000000000..217b06eac2 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3/bucket_policy/index.md @@ -0,0 +1,91 @@ +--- +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
DescriptionApplies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than the root user of the AWS-account that owns the bucket, the calling identity must have the ``PutBucketPolicy`` permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.<br/> If you don't have ``PutBucketPolicy`` permissions, Amazon S3 returns a ``403 Access Denied`` error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a ``405 Method Not Allowed`` error.<br/> As a security precaution, the root user of the AWS-account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action. <br/> For more information, see [Bucket policy examples](https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html).<br/> The following operations are related to ``PutBucketPolicy``:<br/> + [CreateBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) <br/> + [DeleteBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html)
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +bucket, +policy_document +FROM aws.s3.bucket_policy +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the bucket_policy resource, the following permissions are required: + +### Read +```json +s3:GetBucketPolicy +``` + +### Update +```json +s3:GetBucketPolicy, +s3:PutBucketPolicy +``` + +### Delete +```json +s3:GetBucketPolicy, +s3:DeleteBucketPolicy +``` + diff --git a/docs/aws-docs/providers/aws/s3/bucket_policy_status/index.md b/docs/aws-docs/providers/aws/s3/bucket_policy_status/index.md deleted file mode 100644 index 128556dd38..0000000000 --- a/docs/aws-docs/providers/aws/s3/bucket_policy_status/index.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: bucket_policy_status -hide_title: false -hide_table_of_contents: false -keywords: - - bucket_policy_status - - 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 ---- - - - -## Overview - - - - -
Namebucket_policy_status
TypeResource
Idaws.s3.bucket_policy_status
- -## Fields -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `bucket_policy_status_Get` | `SELECT` | `bucket, region` | diff --git a/docs/aws-docs/providers/aws/s3/bucket_replications/index.md b/docs/aws-docs/providers/aws/s3/bucket_replications/index.md deleted file mode 100644 index 2d4ea086dc..0000000000 --- a/docs/aws-docs/providers/aws/s3/bucket_replications/index.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: bucket_replications -hide_title: false -hide_table_of_contents: false -keywords: - - bucket_replications - - 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 ---- - - - -## Overview - - - - -
Namebucket_replications
TypeResource
Idaws.s3.bucket_replications
- -## Fields -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `bucket_replications_Get` | `SELECT` | `bucket, region` | <p>Returns the replication configuration of a bucket.</p> <note> <p> It can take a while to propagate the put or delete a replication configuration to all Amazon S3 systems. Therefore, a get request soon after put or delete can return a wrong result. </p> </note> <p> For information about replication configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html">Replication</a> in the <i>Amazon S3 User Guide</i>.</p> <p>This action requires permissions for the <code>s3:GetReplicationConfiguration</code> action. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html">Using Bucket Policies and User Policies</a>.</p> <p>If you include the <code>Filter</code> element in a replication configuration, you must also include the <code>DeleteMarkerReplication</code> and <code>Priority</code> elements. The response also returns those elements.</p> <p>For information about <code>GetBucketReplication</code> errors, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ReplicationErrorCodeList">List of replication-related error codes</a> </p> <p>The following operations are related to <code>GetBucketReplication</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketReplication.html">PutBucketReplication</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketReplication.html">DeleteBucketReplication</a> </p> </li> </ul> | -| `bucket_replications_Delete` | `DELETE` | `bucket, region` | <p> Deletes the replication configuration from the bucket.</p> <p>To use this operation, you must have permissions to perform the <code>s3:PutReplicationConfiguration</code> action. The bucket owner has these permissions by default and can grant it to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3 Resources</a>. </p> <note> <p>It can take a while for the deletion of a replication configuration to fully propagate.</p> </note> <p> For information about replication configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html">Replication</a> in the <i>Amazon S3 User Guide</i>.</p> <p>The following operations are related to <code>DeleteBucketReplication</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketReplication.html">PutBucketReplication</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketReplication.html">GetBucketReplication</a> </p> </li> </ul> | -| `bucket_replications_Put` | `EXEC` | `bucket, region` | <p> Creates a replication configuration or replaces an existing one. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html">Replication</a> in the <i>Amazon S3 User Guide</i>. </p> <p>Specify the replication configuration in the request body. In the replication configuration, you provide the name of the destination bucket or buckets where you want Amazon S3 to replicate objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, and other relevant information.</p> <p>A replication configuration must include at least one rule, and can contain a maximum of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects in the source bucket. To choose additional subsets of objects to replicate, add a rule for each subset.</p> <p>To specify a subset of the objects in the source bucket to apply a replication rule to, add the Filter element as a child of the Rule element. You can filter objects based on an object key prefix, one or more object tags, or both. When you add the Filter element in the configuration, you must also add the following elements: <code>DeleteMarkerReplication</code>, <code>Status</code>, and <code>Priority</code>.</p> <note> <p>If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations">Backward Compatibility</a>.</p> </note> <p>For information about enabling versioning on a bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html">Using Versioning</a>.</p> <p> <b>Handling Replication of Encrypted Objects</b> </p> <p>By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side encryption with KMS keys. To replicate Amazon Web Services KMS-encrypted objects, add the following: <code>SourceSelectionCriteria</code>, <code>SseKmsEncryptedObjects</code>, <code>Status</code>, <code>EncryptionConfiguration</code>, and <code>ReplicaKmsKeyID</code>. For information about replication configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-config-for-kms-objects.html">Replicating Objects Created with SSE Using KMS keys</a>.</p> <p>For information on <code>PutBucketReplication</code> errors, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ReplicationErrorCodeList">List of replication-related error codes</a> </p> <p> <b>Permissions</b> </p> <p>To create a <code>PutBucketReplication</code> request, you must have <code>s3:PutReplicationConfiguration</code> permissions for the bucket. </p> <p>By default, a resource owner, in this case the Amazon Web Services account that created the bucket, can perform this operation. The resource owner can also grant others permissions to perform the operation. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in a Policy</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <note> <p>To perform this operation, the user or role performing the action must have the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html">iam:PassRole</a> permission.</p> </note> <p>The following operations are related to <code>PutBucketReplication</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketReplication.html">GetBucketReplication</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketReplication.html">DeleteBucketReplication</a> </p> </li> </ul> | diff --git a/docs/aws-docs/providers/aws/s3/bucket_request_payments/index.md b/docs/aws-docs/providers/aws/s3/bucket_request_payments/index.md deleted file mode 100644 index 2bf5ab94ca..0000000000 --- a/docs/aws-docs/providers/aws/s3/bucket_request_payments/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: bucket_request_payments -hide_title: false -hide_table_of_contents: false -keywords: - - bucket_request_payments - - 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 ---- - - - -## Overview - - - - -
Namebucket_request_payments
TypeResource
Idaws.s3.bucket_request_payments
- -## Fields -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `bucket_request_payments_Get` | `SELECT` | `bucket, region` | <p>Returns the request payment configuration of a bucket. To use this version of the operation, you must be the bucket owner. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html">Requester Pays Buckets</a>.</p> <p>The following operations are related to <code>GetBucketRequestPayment</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html">ListObjects</a> </p> </li> </ul> | -| `bucket_request_payments_Put` | `EXEC` | `bucket, region` | <p>Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the download. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html">Requester Pays Buckets</a>.</p> <p>The following operations are related to <code>PutBucketRequestPayment</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketRequestPayment.html">GetBucketRequestPayment</a> </p> </li> </ul> | diff --git a/docs/aws-docs/providers/aws/s3/bucket_taggings/index.md b/docs/aws-docs/providers/aws/s3/bucket_taggings/index.md deleted file mode 100644 index 39b9b9e34c..0000000000 --- a/docs/aws-docs/providers/aws/s3/bucket_taggings/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: bucket_taggings -hide_title: false -hide_table_of_contents: false -keywords: - - bucket_taggings - - 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 ---- - - - -## Overview - - - - -
Namebucket_taggings
TypeResource
Idaws.s3.bucket_taggings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `Key` | `string` | Name of the object key. | -| `Value` | `string` | Value of the tag. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `bucket_taggings_Get` | `SELECT` | `bucket, region` | <p>Returns the tag set associated with the bucket.</p> <p>To use this operation, you must have permission to perform the <code>s3:GetBucketTagging</code> action. By default, the bucket owner has this permission and can grant this permission to others.</p> <p> <code>GetBucketTagging</code> has the following special error:</p> <ul> <li> <p>Error code: <code>NoSuchTagSet</code> </p> <ul> <li> <p>Description: There is no tag set associated with the bucket.</p> </li> </ul> </li> </ul> <p>The following operations are related to <code>GetBucketTagging</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html">PutBucketTagging</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html">DeleteBucketTagging</a> </p> </li> </ul> | -| `bucket_taggings_Delete` | `DELETE` | `bucket, region` | <p>Deletes the tags from the bucket.</p> <p>To use this operation, you must have permission to perform the <code>s3:PutBucketTagging</code> action. By default, the bucket owner has this permission and can grant this permission to others. </p> <p>The following operations are related to <code>DeleteBucketTagging</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html">GetBucketTagging</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html">PutBucketTagging</a> </p> </li> </ul> | -| `bucket_taggings_Put` | `EXEC` | `bucket, region` | <p>Sets the tags for a bucket.</p> <p>Use tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this, sign up to get your Amazon Web Services account bill with tag key values included. Then, to see the cost of combined resources, organize your billing information according to resources with the same tag key values. For example, you can tag several resources with a specific application name, and then organize your billing information to see the total cost of that application across several services. For more information, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html">Cost Allocation and Tagging</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/CostAllocTagging.html">Using Cost Allocation in Amazon S3 Bucket Tags</a>.</p> <note> <p> When this operation sets the tags for a bucket, it will overwrite any current tags the bucket already has. You cannot use this operation to add tags to an existing list of tags.</p> </note> <p>To use this operation, you must have permissions to perform the <code>s3:PutBucketTagging</code> action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p> <code>PutBucketTagging</code> has the following special errors:</p> <ul> <li> <p>Error code: <code>InvalidTagError</code> </p> <ul> <li> <p>Description: The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For information about tag restrictions, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html">User-Defined Tag Restrictions</a> and <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/aws-tag-restrictions.html">Amazon Web Services-Generated Cost Allocation Tag Restrictions</a>.</p> </li> </ul> </li> <li> <p>Error code: <code>MalformedXMLError</code> </p> <ul> <li> <p>Description: The XML provided does not match the schema.</p> </li> </ul> </li> <li> <p>Error code: <code>OperationAbortedError </code> </p> <ul> <li> <p>Description: A conflicting conditional action is currently in progress against this resource. Please try again.</p> </li> </ul> </li> <li> <p>Error code: <code>InternalError</code> </p> <ul> <li> <p>Description: The service was unable to apply the provided tag to the bucket.</p> </li> </ul> </li> </ul> <p>The following operations are related to <code>PutBucketTagging</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html">GetBucketTagging</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html">DeleteBucketTagging</a> </p> </li> </ul> | diff --git a/docs/aws-docs/providers/aws/s3/bucket_versionings/index.md b/docs/aws-docs/providers/aws/s3/bucket_versionings/index.md deleted file mode 100644 index 12e94ffe98..0000000000 --- a/docs/aws-docs/providers/aws/s3/bucket_versionings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: bucket_versionings -hide_title: false -hide_table_of_contents: false -keywords: - - bucket_versionings - - 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 ---- - - - -## Overview - - - - -
Namebucket_versionings
TypeResource
Idaws.s3.bucket_versionings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `MfaDelete` | `string` | Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only returned if the bucket has been configured with MFA delete. If the bucket has never been so configured, this element is not returned. | -| `Status` | `string` | The versioning state of the bucket. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `bucket_versionings_Get` | `SELECT` | `bucket, region` | <p>Returns the versioning state of a bucket.</p> <p>To retrieve the versioning state of a bucket, you must be the bucket owner.</p> <p>This implementation also returns the MFA Delete status of the versioning state. If the MFA Delete status is <code>enabled</code>, the bucket owner must use an authentication device to change the versioning state of the bucket.</p> <p>The following operations are related to <code>GetBucketVersioning</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html">DeleteObject</a> </p> </li> </ul> | -| `bucket_versionings_Put` | `EXEC` | `bucket, region` | <p>Sets the versioning state of an existing bucket.</p> <p>You can set the versioning state with one of the following values:</p> <p> <b>Enabled</b>—Enables versioning for the objects in the bucket. All objects added to the bucket receive a unique version ID.</p> <p> <b>Suspended</b>—Disables versioning for the objects in the bucket. All objects added to the bucket receive the version ID null.</p> <p>If the versioning state has never been set on a bucket, it has no versioning state; a <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html">GetBucketVersioning</a> request does not return a versioning state value.</p> <p>In order to enable MFA Delete, you must be the bucket owner. If you are the bucket owner and want to enable MFA Delete in the bucket versioning configuration, you must include the <code>x-amz-mfa request</code> header and the <code>Status</code> and the <code>MfaDelete</code> request elements in a request to set the versioning state of the bucket.</p> <important> <p>If you have an object expiration lifecycle policy in your non-versioned bucket and you want to maintain the same permanent delete behavior when you enable versioning, you must add a noncurrent expiration policy. The noncurrent expiration lifecycle policy will manage the deletes of the noncurrent object versions in the version-enabled bucket. (A version-enabled bucket maintains one current and zero or more noncurrent object versions.) For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html#lifecycle-and-other-bucket-config">Lifecycle and Versioning</a>.</p> </important> <p class="title"> <b>Related Resources</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html">DeleteBucket</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html">GetBucketVersioning</a> </p> </li> </ul> | diff --git a/docs/aws-docs/providers/aws/s3/bucket_websites/index.md b/docs/aws-docs/providers/aws/s3/bucket_websites/index.md deleted file mode 100644 index 620e411674..0000000000 --- a/docs/aws-docs/providers/aws/s3/bucket_websites/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: bucket_websites -hide_title: false -hide_table_of_contents: false -keywords: - - bucket_websites - - 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 ---- - - - -## Overview - - - - -
Namebucket_websites
TypeResource
Idaws.s3.bucket_websites
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `ErrorDocument` | `object` | The error information. | -| `IndexDocument` | `object` | Container for the <code>Suffix</code> element. | -| `RedirectAllRequestsTo` | `object` | Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket. | -| `RoutingRules` | `array` | Rules that define when a redirect is applied and the redirect behavior. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `bucket_websites_Get` | `SELECT` | `bucket, region` | <p>Returns the website configuration for a bucket. To host website on Amazon S3, you can configure a bucket as website by adding a website configuration. For more information about hosting websites, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html">Hosting Websites on Amazon S3</a>. </p> <p>This GET action requires the <code>S3:GetBucketWebsite</code> permission. By default, only the bucket owner can read the bucket website configuration. However, bucket owners can allow other users to read the website configuration by writing a bucket policy granting them the <code>S3:GetBucketWebsite</code> permission.</p> <p>The following operations are related to <code>DeleteBucketWebsite</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketWebsite.html">DeleteBucketWebsite</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketWebsite.html">PutBucketWebsite</a> </p> </li> </ul> | -| `bucket_websites_Delete` | `DELETE` | `bucket, region` | <p>This action removes the website configuration for a bucket. Amazon S3 returns a <code>200 OK</code> response upon successfully deleting a website configuration on the specified bucket. You will get a <code>200 OK</code> response if the website configuration you are trying to delete does not exist on the bucket. Amazon S3 returns a <code>404</code> response if the bucket specified in the request does not exist.</p> <p>This DELETE action requires the <code>S3:DeleteBucketWebsite</code> permission. By default, only the bucket owner can delete the website configuration attached to a bucket. However, bucket owners can grant other users permission to delete the website configuration by writing a bucket policy granting them the <code>S3:DeleteBucketWebsite</code> permission. </p> <p>For more information about hosting websites, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html">Hosting Websites on Amazon S3</a>. </p> <p>The following operations are related to <code>DeleteBucketWebsite</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketWebsite.html">GetBucketWebsite</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketWebsite.html">PutBucketWebsite</a> </p> </li> </ul> | -| `bucket_websites_Put` | `EXEC` | `bucket, region` | <p>Sets the configuration of the website that is specified in the <code>website</code> subresource. To configure a bucket as a website, you can add this subresource on the bucket with website configuration information such as the file name of the index document and any redirect rules. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html">Hosting Websites on Amazon S3</a>.</p> <p>This PUT action requires the <code>S3:PutBucketWebsite</code> permission. By default, only the bucket owner can configure the website attached to a bucket; however, bucket owners can allow other users to set the website configuration by writing a bucket policy that grants them the <code>S3:PutBucketWebsite</code> permission.</p> <p>To redirect all website requests sent to the bucket's website endpoint, you add a website configuration with the following elements. Because all requests are sent to another website, you don't need to provide index document name for the bucket.</p> <ul> <li> <p> <code>WebsiteConfiguration</code> </p> </li> <li> <p> <code>RedirectAllRequestsTo</code> </p> </li> <li> <p> <code>HostName</code> </p> </li> <li> <p> <code>Protocol</code> </p> </li> </ul> <p>If you want granular control over redirects, you can use the following elements to add routing rules that describe conditions for redirecting requests and information about the redirect destination. In this case, the website configuration must provide an index document for the bucket, because some requests might not be redirected. </p> <ul> <li> <p> <code>WebsiteConfiguration</code> </p> </li> <li> <p> <code>IndexDocument</code> </p> </li> <li> <p> <code>Suffix</code> </p> </li> <li> <p> <code>ErrorDocument</code> </p> </li> <li> <p> <code>Key</code> </p> </li> <li> <p> <code>RoutingRules</code> </p> </li> <li> <p> <code>RoutingRule</code> </p> </li> <li> <p> <code>Condition</code> </p> </li> <li> <p> <code>HttpErrorCodeReturnedEquals</code> </p> </li> <li> <p> <code>KeyPrefixEquals</code> </p> </li> <li> <p> <code>Redirect</code> </p> </li> <li> <p> <code>Protocol</code> </p> </li> <li> <p> <code>HostName</code> </p> </li> <li> <p> <code>ReplaceKeyPrefixWith</code> </p> </li> <li> <p> <code>ReplaceKeyWith</code> </p> </li> <li> <p> <code>HttpRedirectCode</code> </p> </li> </ul> <p>Amazon S3 has a limitation of 50 routing rules per website configuration. If you require more than 50 routing rules, you can use object redirect. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html">Configuring an Object Redirect</a> in the <i>Amazon S3 User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/s3/buckets/index.md b/docs/aws-docs/providers/aws/s3/buckets/index.md index a47bc6e95e..f7c5b55beb 100644 --- a/docs/aws-docs/providers/aws/s3/buckets/index.md +++ b/docs/aws-docs/providers/aws/s3/buckets/index.md @@ -5,7 +5,7 @@ hide_table_of_contents: false keywords: - buckets - s3 - - aws + - aws - stackql - infrastructure-as-code - configuration-as-data @@ -14,24 +14,88 @@ description: Query, deploy 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
DescriptionThe ``AWS::S3::Bucket`` resource creates an Amazon S3 bucket in the same AWS Region where you create the AWS CloudFormation stack.<br/> To control how AWS CloudFormation handles the bucket when the stack is deleted, you can set a deletion policy for your bucket. You can choose to *retain* the bucket or to *delete* the bucket. For more information, see [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html).<br/> You can only delete empty buckets. Deletion fails for buckets that have contents.
Idaws.s3.buckets
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `CreationDate` | `string` | Date the bucket was created. This date can change when making changes to your bucket, such as editing its bucket policy. | -| `Name` | `string` | The name of the bucket. | + + + + + +
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 -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `buckets_List` | `SELECT` | `bucket, region` | Returns a list of all buckets owned by the authenticated sender of the request. To use this operation, you must have the <code>s3:ListAllMyBuckets</code> permission. | -| `buckets_Create` | `INSERT` | `bucket, region` | <p>Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and have a valid Amazon Web Services Access Key ID to authenticate requests. Anonymous requests are never allowed to create buckets. By creating the bucket, you become the bucket owner.</p> <p>Not every string is an acceptable bucket name. For information about bucket naming restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html">Bucket naming rules</a>.</p> <p>If you want to create an Amazon S3 on Outposts bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html">Create Bucket</a>. </p> <p>By default, the bucket is created in the US East (N. Virginia) Region. You can optionally specify a Region in the request body. You might choose a Region to optimize latency, minimize costs, or address regulatory requirements. For example, if you reside in Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) Region. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro">Accessing a bucket</a>.</p> <note> <p>If you send your create bucket request to the <code>s3.amazonaws.com</code> endpoint, the request goes to the us-east-1 Region. Accordingly, the signature calculations in Signature Version 4 must use us-east-1 as the Region, even if the location constraint in the request specifies another Region where the bucket is to be created. If you create a bucket in a Region other than US East (N. Virginia), your application must be able to handle 307 redirect. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html">Virtual hosting of buckets</a>.</p> </note> <p> <b>Access control lists (ACLs)</b> </p> <p>When creating a bucket using this operation, you can optionally configure the bucket ACL to specify the accounts or groups that should be granted specific permissions on the bucket.</p> <important> <p>If your CreateBucket request sets bucket owner enforced for S3 Object Ownership and specifies a bucket ACL that provides access to an external Amazon Web Services account, your request fails with a <code>400</code> error and returns the <code>InvalidBucketAclWithObjectOwnership</code> error code. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">Controlling object ownership</a> in the <i>Amazon S3 User Guide</i>.</p> </important> <p>There are two ways to grant the appropriate permissions using the request headers.</p> <ul> <li> <p>Specify a canned ACL using the <code>x-amz-acl</code> request header. Amazon S3 supports a set of predefined ACLs, known as <i>canned ACLs</i>. Each canned ACL has a predefined set of grantees and permissions. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL">Canned ACL</a>.</p> </li> <li> <p>Specify access permissions explicitly using the <code>x-amz-grant-read</code>, <code>x-amz-grant-write</code>, <code>x-amz-grant-read-acp</code>, <code>x-amz-grant-write-acp</code>, and <code>x-amz-grant-full-control</code> headers. These headers map to the set of permissions Amazon S3 supports in an ACL. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html">Access control list (ACL) overview</a>.</p> <p>You specify each grantee as a type=value pair, where the type is one of the following:</p> <ul> <li> <p> <code>id</code> – if the value specified is the canonical user ID of an Amazon Web Services account</p> </li> <li> <p> <code>uri</code> – if you are granting permissions to a predefined group</p> </li> <li> <p> <code>emailAddress</code> – if the value specified is the email address of an Amazon Web Services account</p> <note> <p>Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions: </p> <ul> <li> <p>US East (N. Virginia)</p> </li> <li> <p>US West (N. California)</p> </li> <li> <p> US West (Oregon)</p> </li> <li> <p> Asia Pacific (Singapore)</p> </li> <li> <p>Asia Pacific (Sydney)</p> </li> <li> <p>Asia Pacific (Tokyo)</p> </li> <li> <p>Europe (Ireland)</p> </li> <li> <p>South America (São Paulo)</p> </li> </ul> <p>For a list of all the Amazon S3 supported Regions and endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region">Regions and Endpoints</a> in the Amazon Web Services General Reference.</p> </note> </li> </ul> <p>For example, the following <code>x-amz-grant-read</code> header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:</p> <p> <code>x-amz-grant-read: id="11112222333", id="444455556666" </code> </p> </li> </ul> <note> <p>You can use either a canned ACL or specify access permissions explicitly. You cannot do both.</p> </note> <p> <b>Permissions</b> </p> <p>In addition to <code>s3:CreateBucket</code>, the following permissions are required when your CreateBucket includes specific headers:</p> <ul> <li> <p> <b>ACLs</b> - If your <code>CreateBucket</code> request specifies ACL permissions and the ACL is public-read, public-read-write, authenticated-read, or if you specify access permissions explicitly through any other ACL, both <code>s3:CreateBucket</code> and <code>s3:PutBucketAcl</code> permissions are needed. If the ACL the <code>CreateBucket</code> request is private or doesn't specify any ACLs, only <code>s3:CreateBucket</code> permission is needed. </p> </li> <li> <p> <b>Object Lock</b> - If <code>ObjectLockEnabledForBucket</code> is set to true in your <code>CreateBucket</code> request, <code>s3:PutBucketObjectLockConfiguration</code> and <code>s3:PutBucketVersioning</code> permissions are required.</p> </li> <li> <p> <b>S3 Object Ownership</b> - If your CreateBucket request includes the the <code>x-amz-object-ownership</code> header, <code>s3:PutBucketOwnershipControls</code> permission is required.</p> </li> </ul> <p>The following operations are related to <code>CreateBucket</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html">DeleteBucket</a> </p> </li> </ul> | -| `buckets_Delete` | `DELETE` | `bucket, region` | <p>Deletes the S3 bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted.</p> <p class="title"> <b>Related Resources</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html">DeleteObject</a> </p> </li> </ul> | + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +bucket_name +FROM aws.s3.buckets +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the buckets resource, the following permissions are required: + +### Create +```json +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 +```json +s3:ListAllMyBuckets +``` + diff --git a/docs/aws-docs/providers/aws/s3/get_object_responses/index.md b/docs/aws-docs/providers/aws/s3/get_object_responses/index.md deleted file mode 100644 index 395f605bf7..0000000000 --- a/docs/aws-docs/providers/aws/s3/get_object_responses/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: get_object_responses -hide_title: false -hide_table_of_contents: false -keywords: - - get_object_responses - - 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 ---- - - - -## Overview - - - - -
Nameget_object_responses
TypeResource
Idaws.s3.get_object_responses
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `get_object_responses_Write` | `EXEC` | `x-amz-request-route, x-amz-request-token, bucket, region` | diff --git a/docs/aws-docs/providers/aws/s3/index.md b/docs/aws-docs/providers/aws/s3/index.md index 9958db6483..dc91f363f8 100644 --- a/docs/aws-docs/providers/aws/s3/index.md +++ b/docs/aws-docs/providers/aws/s3/index.md @@ -13,72 +13,44 @@ description: Query, deploy and manage AWS resources using SQL custom_edit_url: null image: /img/providers/aws/stackql-aws-provider-featured-image.png --- -s3 - + +The s3 service documentation. + :::info Service Summary
-total resources: 39
-total selectable resources: 32
-total methods: 93
+total resources: 19
+total selectable resources: 19
+total methods: 19
::: -## Overview - - - - - - -
Nameaws.s3
TypeService
Titles3
Descriptions3
Ids3:v24.03.00220
- ## Resources
-bucket_accelerate_configurations
-bucket_acls
-bucket_analytics_configurations
-bucket_cors
-bucket_encryptions
-bucket_intelligent_tiering_configurations
-bucket_inventory_configurations
-bucket_lifecycle_configurations
-bucket_lifecycles
-bucket_locations
-bucket_loggings
-bucket_metrics_configurations
-bucket_notification_configurations
-bucket_notifications
-bucket_ownership_controls
-bucket_policies
-bucket_policy_status
-bucket_replications
-bucket_request_payments
-bucket_taggings
+access_grant
+access_grants
+access_grants_instance
+access_grants_instances
+access_grants_location
+access_grants_locations
+access_point
+access_points
+bucket
+bucket_policies
-bucket_versionings
-bucket_websites
+bucket_policy
buckets
-get_object_responses
-multipart_uploads
-object_acls
-object_attributes
-object_contents
-object_legal_holds
-object_lock_configurations
-object_retentions
-object_taggings
-object_torrents
-object_versions
-objects
-objects_v2s
-part_copies
-parts
-public_access_blocks
-
+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/aws-docs/providers/aws/s3/multi_region_access_point/index.md b/docs/aws-docs/providers/aws/s3/multi_region_access_point/index.md new file mode 100644 index 0000000000..2c42de2740 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3/multi_region_access_point/index.md @@ -0,0 +1,87 @@ +--- +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
DescriptionAWS::S3::MultiRegionAccessPoint is an Amazon S3 resource type that dynamically routes S3 requests to easily satisfy geographic compliance requirements based on customer-defined routing policies.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +alias, +created_at, +public_access_block_configuration, +regions +FROM aws.s3.multi_region_access_point +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the multi_region_access_point resource, the following permissions are required: + +### Read +```json +s3:GetMultiRegionAccessPoint +``` + +### Delete +```json +s3:DeleteMultiRegionAccessPoint, +s3:DescribeMultiRegionAccessPointOperation, +s3:GetMultiRegionAccessPoint +``` + diff --git a/docs/aws-docs/providers/aws/s3/multi_region_access_point_policies/index.md b/docs/aws-docs/providers/aws/s3/multi_region_access_point_policies/index.md new file mode 100644 index 0000000000..3eb0ac21b7 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3/multi_region_access_point_policies/index.md @@ -0,0 +1,73 @@ +--- +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
DescriptionThe policy to be attached to a Multi Region Access Point
Idaws.s3.multi_region_access_point_policies
+ +## Fields + + + + + +
NameDatatypeDescription
mrap_namestringThe name of the Multi Region Access Point to apply policy
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +mrap_name +FROM aws.s3.multi_region_access_point_policies +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the multi_region_access_point_policies resource, the following permissions are required: + +### Create +```json +s3:PutMultiRegionAccessPointPolicy, +s3:DescribeMultiRegionAccessPointOperation +``` + diff --git a/docs/aws-docs/providers/aws/s3/multi_region_access_point_policy/index.md b/docs/aws-docs/providers/aws/s3/multi_region_access_point_policy/index.md new file mode 100644 index 0000000000..e263f7eb74 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3/multi_region_access_point_policy/index.md @@ -0,0 +1,94 @@ +--- +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
DescriptionThe policy to be attached to a Multi Region Access Point
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +mrap_name, +policy, +policy_status +FROM aws.s3.multi_region_access_point_policy +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the multi_region_access_point_policy resource, the following permissions are required: + +### Update +```json +s3:PutMultiRegionAccessPointPolicy, +s3:DescribeMultiRegionAccessPointOperation +``` + +### Read +```json +s3:GetMultiRegionAccessPointPolicy, +s3:GetMultiRegionAccessPointPolicyStatus +``` + +### Delete +```json +s3:GetMultiRegionAccessPointPolicy, +s3:GetMultiRegionAccessPoint +``` + diff --git a/docs/aws-docs/providers/aws/s3/multi_region_access_points/index.md b/docs/aws-docs/providers/aws/s3/multi_region_access_points/index.md new file mode 100644 index 0000000000..a9e042e466 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3/multi_region_access_points/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionAWS::S3::MultiRegionAccessPoint is an Amazon S3 resource type that dynamically routes S3 requests to easily satisfy geographic compliance requirements based on customer-defined routing policies.
Idaws.s3.multi_region_access_points
+ +## Fields + + + + + +
NameDatatypeDescription
namestringThe name you want to assign to this Multi Region Access Point.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.s3.multi_region_access_points +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the multi_region_access_points resource, the following permissions are required: + +### Create +```json +s3:CreateMultiRegionAccessPoint, +s3:DescribeMultiRegionAccessPointOperation, +s3:GetMultiRegionAccessPoint +``` + +### List +```json +s3:ListMultiRegionAccessPoints +``` + diff --git a/docs/aws-docs/providers/aws/s3/multipart_uploads/index.md b/docs/aws-docs/providers/aws/s3/multipart_uploads/index.md deleted file mode 100644 index 571ebd61c4..0000000000 --- a/docs/aws-docs/providers/aws/s3/multipart_uploads/index.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: multipart_uploads -hide_title: false -hide_table_of_contents: false -keywords: - - multipart_uploads - - 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 ---- - - - -## Overview - - - - -
Namemultipart_uploads
TypeResource
Idaws.s3.multipart_uploads
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `multipart_uploads_Create` | `INSERT` | `Key, bucket, region` | <p>This action initiates a multipart upload and returns an upload ID. This upload ID is used to associate all of the parts in the specific multipart upload. You specify this upload ID in each of your subsequent upload part requests (see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a>). You also include this upload ID in the final request to either complete or abort the multipart upload request.</p> <p>For more information about multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html">Multipart Upload Overview</a>.</p> <p>If you have configured a lifecycle rule to abort incomplete multipart uploads, the upload must complete within the number of days specified in the bucket lifecycle configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort action and Amazon S3 aborts the multipart upload. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config">Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy</a>.</p> <p>For information about the permissions required to use the multipart upload API, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart Upload and Permissions</a>.</p> <p>For request signing, multipart upload is just a series of regular requests. You initiate a multipart upload, send one or more requests to upload parts, and then complete the multipart upload process. You sign each request individually. There is nothing special about signing multipart upload requests. For more information about signing, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html">Authenticating Requests (Amazon Web Services Signature Version 4)</a>.</p> <note> <p> After you initiate a multipart upload and upload one or more parts, to stop being charged for storing the uploaded parts, you must either complete or abort the multipart upload. Amazon S3 frees up the space used to store the parts and stop charging you for storing them only after you either complete or abort a multipart upload. </p> </note> <p>You can optionally request server-side encryption. For server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. You can provide your own encryption key, or use Amazon Web Services KMS keys or Amazon S3-managed encryption keys. If you choose to provide your own encryption key, the request headers you provide in <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html">UploadPartCopy</a> requests must match the headers you used in the request to initiate the upload by using <code>CreateMultipartUpload</code>. </p> <p>To perform a multipart upload with encryption using an Amazon Web Services KMS key, the requester must have permission to the <code>kms:Decrypt</code> and <code>kms:GenerateDataKey*</code> actions on the key. These permissions are required because Amazon S3 must decrypt and read data from the encrypted file parts before it completes the multipart upload. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html#mpuAndPermissions">Multipart upload API and permissions</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If your Identity and Access Management (IAM) user or role is in the same Amazon Web Services account as the KMS key, then you must have these permissions on the key policy. If your IAM user or role belongs to a different account than the key, then you must have the permissions on both the key policy and your IAM user or role.</p> <p> For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html">Protecting Data Using Server-Side Encryption</a>.</p> <dl> <dt>Access Permissions</dt> <dd> <p>When copying an object, you can optionally specify the accounts or groups that should be granted specific permissions on the new object. There are two ways to grant the permissions using the request headers:</p> <ul> <li> <p>Specify a canned ACL with the <code>x-amz-acl</code> request header. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL">Canned ACL</a>.</p> </li> <li> <p>Specify access permissions explicitly with the <code>x-amz-grant-read</code>, <code>x-amz-grant-read-acp</code>, <code>x-amz-grant-write-acp</code>, and <code>x-amz-grant-full-control</code> headers. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access Control List (ACL) Overview</a>.</p> </li> </ul> <p>You can use either a canned ACL or specify access permissions explicitly. You cannot do both.</p> </dd> <dt>Server-Side- Encryption-Specific Request Headers</dt> <dd> <p>You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. The option you use depends on whether you want to use Amazon Web Services managed encryption keys or provide your own encryption key. </p> <ul> <li> <p>Use encryption keys managed by Amazon S3 or customer managed key stored in Amazon Web Services Key Management Service (Amazon Web Services KMS) – If you want Amazon Web Services to manage the keys used to encrypt data, specify the following headers in the request.</p> <ul> <li> <p> <code>x-amz-server-side-encryption</code> </p> </li> <li> <p> <code>x-amz-server-side-encryption-aws-kms-key-id</code> </p> </li> <li> <p> <code>x-amz-server-side-encryption-context</code> </p> </li> </ul> <note> <p>If you specify <code>x-amz-server-side-encryption:aws:kms</code>, but don't provide <code>x-amz-server-side-encryption-aws-kms-key-id</code>, Amazon S3 uses the Amazon Web Services managed key in Amazon Web Services KMS to protect the data.</p> </note> <important> <p>All GET and PUT requests for an object protected by Amazon Web Services KMS fail if you don't make them with SSL or by using SigV4.</p> </important> <p>For more information about server-side encryption with KMS key (SSE-KMS), see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html">Protecting Data Using Server-Side Encryption with KMS keys</a>.</p> </li> <li> <p>Use customer-provided encryption keys – If you want to manage your own encryption keys, provide all the following headers in the request.</p> <ul> <li> <p> <code>x-amz-server-side-encryption-customer-algorithm</code> </p> </li> <li> <p> <code>x-amz-server-side-encryption-customer-key</code> </p> </li> <li> <p> <code>x-amz-server-side-encryption-customer-key-MD5</code> </p> </li> </ul> <p>For more information about server-side encryption with KMS keys (SSE-KMS), see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html">Protecting Data Using Server-Side Encryption with KMS keys</a>.</p> </li> </ul> </dd> <dt>Access-Control-List (ACL)-Specific Request Headers</dt> <dd> <p>You also can use the following access control–related headers with this operation. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the access control list (ACL) on the object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html">Using ACLs</a>. With this operation, you can grant access permissions using one of the following two methods:</p> <ul> <li> <p>Specify a canned ACL (<code>x-amz-acl</code>) — Amazon S3 supports a set of predefined ACLs, known as <i>canned ACLs</i>. Each canned ACL has a predefined set of grantees and permissions. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL">Canned ACL</a>.</p> </li> <li> <p>Specify access permissions explicitly — To explicitly grant access permissions to specific Amazon Web Services accounts or groups, use the following headers. Each header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access Control List (ACL) Overview</a>. In the header, you specify a list of grantees who get the specific permission. To grant permissions explicitly, use:</p> <ul> <li> <p> <code>x-amz-grant-read</code> </p> </li> <li> <p> <code>x-amz-grant-write</code> </p> </li> <li> <p> <code>x-amz-grant-read-acp</code> </p> </li> <li> <p> <code>x-amz-grant-write-acp</code> </p> </li> <li> <p> <code>x-amz-grant-full-control</code> </p> </li> </ul> <p>You specify each grantee as a type=value pair, where the type is one of the following:</p> <ul> <li> <p> <code>id</code> – if the value specified is the canonical user ID of an Amazon Web Services account</p> </li> <li> <p> <code>uri</code> – if you are granting permissions to a predefined group</p> </li> <li> <p> <code>emailAddress</code> – if the value specified is the email address of an Amazon Web Services account</p> <note> <p>Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions: </p> <ul> <li> <p>US East (N. Virginia)</p> </li> <li> <p>US West (N. California)</p> </li> <li> <p> US West (Oregon)</p> </li> <li> <p> Asia Pacific (Singapore)</p> </li> <li> <p>Asia Pacific (Sydney)</p> </li> <li> <p>Asia Pacific (Tokyo)</p> </li> <li> <p>Europe (Ireland)</p> </li> <li> <p>South America (São Paulo)</p> </li> </ul> <p>For a list of all the Amazon S3 supported Regions and endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region">Regions and Endpoints</a> in the Amazon Web Services General Reference.</p> </note> </li> </ul> <p>For example, the following <code>x-amz-grant-read</code> header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:</p> <p> <code>x-amz-grant-read: id="11112222333", id="444455556666" </code> </p> </li> </ul> </dd> </dl> <p>The following operations are related to <code>CreateMultipartUpload</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html">CompleteMultipartUpload</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html">AbortMultipartUpload</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html">ListParts</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html">ListMultipartUploads</a> </p> </li> </ul> | -| `multipart_uploads_Complete` | `EXEC` | `Key, uploadId, bucket, region` | <p>Completes a multipart upload by assembling previously uploaded parts.</p> <p>You first initiate the multipart upload and then upload all parts using the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a> operation. After successfully uploading all relevant parts of an upload, you call this action to complete the upload. Upon receiving this request, Amazon S3 concatenates all the parts in ascending order by part number to create a new object. In the Complete Multipart Upload request, you must provide the parts list. You must ensure that the parts list is complete. This action concatenates the parts that you provide in the list. For each part in the list, you must provide the part number and the <code>ETag</code> value, returned after that part was uploaded.</p> <p>Processing of a Complete Multipart Upload request could take several minutes to complete. After Amazon S3 begins processing the request, it sends an HTTP response header that specifies a 200 OK response. While processing is in progress, Amazon S3 periodically sends white space characters to keep the connection from timing out. Because a request could fail after the initial 200 OK response has been sent, it is important that you check the response body to determine whether the request succeeded.</p> <p>Note that if <code>CompleteMultipartUpload</code> fails, applications should be prepared to retry the failed requests. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ErrorBestPractices.html">Amazon S3 Error Best Practices</a>.</p> <important> <p>You cannot use <code>Content-Type: application/x-www-form-urlencoded</code> with Complete Multipart Upload requests. Also, if you do not provide a <code>Content-Type</code> header, <code>CompleteMultipartUpload</code> returns a 200 OK response.</p> </important> <p>For more information about multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html">Uploading Objects Using Multipart Upload</a>.</p> <p>For information about permissions required to use the multipart upload API, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart Upload and Permissions</a>.</p> <p> <code>CompleteMultipartUpload</code> has the following special errors:</p> <ul> <li> <p>Error code: <code>EntityTooSmall</code> </p> <ul> <li> <p>Description: Your proposed upload is smaller than the minimum allowed object size. Each part must be at least 5 MB in size, except the last part.</p> </li> <li> <p>400 Bad Request</p> </li> </ul> </li> <li> <p>Error code: <code>InvalidPart</code> </p> <ul> <li> <p>Description: One or more of the specified parts could not be found. The part might not have been uploaded, or the specified entity tag might not have matched the part's entity tag.</p> </li> <li> <p>400 Bad Request</p> </li> </ul> </li> <li> <p>Error code: <code>InvalidPartOrder</code> </p> <ul> <li> <p>Description: The list of parts was not in ascending order. The parts list must be specified in order by part number.</p> </li> <li> <p>400 Bad Request</p> </li> </ul> </li> <li> <p>Error code: <code>NoSuchUpload</code> </p> <ul> <li> <p>Description: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.</p> </li> <li> <p>404 Not Found</p> </li> </ul> </li> </ul> <p>The following operations are related to <code>CompleteMultipartUpload</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html">AbortMultipartUpload</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html">ListParts</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html">ListMultipartUploads</a> </p> </li> </ul> | -| `multipart_uploads_List` | `EXEC` | `bucket, region` | <p>This action lists in-progress multipart uploads. An in-progress multipart upload is a multipart upload that has been initiated using the Initiate Multipart Upload request, but has not yet been completed or aborted.</p> <p>This action returns at most 1,000 multipart uploads in the response. 1,000 multipart uploads is the maximum number of uploads a response can include, which is also the default value. You can further limit the number of uploads in a response by specifying the <code>max-uploads</code> parameter in the response. If additional multipart uploads satisfy the list criteria, the response will contain an <code>IsTruncated</code> element with the value true. To list the additional multipart uploads, use the <code>key-marker</code> and <code>upload-id-marker</code> request parameters.</p> <p>In the response, the uploads are sorted by key. If your application has initiated more than one multipart upload using the same object key, then uploads in the response are first sorted by key. Additionally, uploads are sorted in ascending order within each key by the upload initiation time.</p> <p>For more information on multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html">Uploading Objects Using Multipart Upload</a>.</p> <p>For information on permissions required to use the multipart upload API, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart Upload and Permissions</a>.</p> <p>The following operations are related to <code>ListMultipartUploads</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html">CompleteMultipartUpload</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html">ListParts</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html">AbortMultipartUpload</a> </p> </li> </ul> | diff --git a/docs/aws-docs/providers/aws/s3/object_acls/index.md b/docs/aws-docs/providers/aws/s3/object_acls/index.md deleted file mode 100644 index 1d37547c57..0000000000 --- a/docs/aws-docs/providers/aws/s3/object_acls/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: object_acls -hide_title: false -hide_table_of_contents: false -keywords: - - object_acls - - 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 ---- - - - -## Overview - - - - -
Nameobject_acls
TypeResource
Idaws.s3.object_acls
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `AccessControlList` | `array` | A list of grants. | -| `Owner` | `object` | Container for the owner's display name and ID. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `object_acls_Get` | `SELECT` | `Key, bucket, region` | <p>Returns the access control list (ACL) of an object. To use this operation, you must have <code>s3:GetObjectAcl</code> permissions or <code>READ_ACP</code> access to the object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#acl-access-policy-permission-mapping">Mapping of ACL permissions and access policy permissions</a> in the <i>Amazon S3 User Guide</i> </p> <p>This action is not supported by Amazon S3 on Outposts.</p> <p> <b>Versioning</b> </p> <p>By default, GET returns ACL information about the current version of an object. To return ACL information about a different version, use the versionId subresource.</p> <note> <p>If your bucket uses the bucket owner enforced setting for S3 Object Ownership, requests to read ACLs are still supported and return the <code>bucket-owner-full-control</code> ACL with the owner being the account that created the bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html"> Controlling object ownership and disabling ACLs</a> in the <i>Amazon S3 User Guide</i>.</p> </note> <p>The following operations are related to <code>GetObjectAcl</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html">GetObjectAttributes</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html">DeleteObject</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a> </p> </li> </ul> | -| `object_acls_Put` | `EXEC` | `Key, bucket, region` | <p>Uses the <code>acl</code> subresource to set the access control list (ACL) permissions for a new or existing object in an S3 bucket. You must have <code>WRITE_ACP</code> permission to set the ACL of an object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#permissions">What permissions can I grant?</a> in the <i>Amazon S3 User Guide</i>.</p> <p>This action is not supported by Amazon S3 on Outposts.</p> <p>Depending on your application needs, you can choose to set the ACL on an object using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, you can continue to use that approach. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access Control List (ACL) Overview</a> in the <i>Amazon S3 User Guide</i>.</p> <important> <p>If your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. You must use policies to grant access to your bucket and the objects in it. Requests to set ACLs or update ACLs fail and return the <code>AccessControlListNotSupported</code> error code. Requests to read ACLs are still supported. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">Controlling object ownership</a> in the <i>Amazon S3 User Guide</i>.</p> </important> <p> <b>Access Permissions</b> </p> <p>You can set access permissions using one of the following methods:</p> <ul> <li> <p>Specify a canned ACL with the <code>x-amz-acl</code> request header. Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. Specify the canned ACL name as the value of <code>x-amz-ac</code>l. If you use this header, you cannot use other access control-specific headers in your request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL">Canned ACL</a>.</p> </li> <li> <p>Specify access permissions explicitly with the <code>x-amz-grant-read</code>, <code>x-amz-grant-read-acp</code>, <code>x-amz-grant-write-acp</code>, and <code>x-amz-grant-full-control</code> headers. When using these headers, you specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who will receive the permission. If you use these ACL-specific headers, you cannot use <code>x-amz-acl</code> header to set a canned ACL. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access Control List (ACL) Overview</a>.</p> <p>You specify each grantee as a type=value pair, where the type is one of the following:</p> <ul> <li> <p> <code>id</code> – if the value specified is the canonical user ID of an Amazon Web Services account</p> </li> <li> <p> <code>uri</code> – if you are granting permissions to a predefined group</p> </li> <li> <p> <code>emailAddress</code> – if the value specified is the email address of an Amazon Web Services account</p> <note> <p>Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions: </p> <ul> <li> <p>US East (N. Virginia)</p> </li> <li> <p>US West (N. California)</p> </li> <li> <p> US West (Oregon)</p> </li> <li> <p> Asia Pacific (Singapore)</p> </li> <li> <p>Asia Pacific (Sydney)</p> </li> <li> <p>Asia Pacific (Tokyo)</p> </li> <li> <p>Europe (Ireland)</p> </li> <li> <p>South America (São Paulo)</p> </li> </ul> <p>For a list of all the Amazon S3 supported Regions and endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region">Regions and Endpoints</a> in the Amazon Web Services General Reference.</p> </note> </li> </ul> <p>For example, the following <code>x-amz-grant-read</code> header grants list objects permission to the two Amazon Web Services accounts identified by their email addresses.</p> <p> <code>x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" </code> </p> </li> </ul> <p>You can use either a canned ACL or specify access permissions explicitly. You cannot do both.</p> <p> <b>Grantee Values</b> </p> <p>You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:</p> <ul> <li> <p>By the person's ID:</p> <p> <code><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee></code> </p> <p>DisplayName is optional and ignored in the request.</p> </li> <li> <p>By URI:</p> <p> <code><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee></code> </p> </li> <li> <p>By Email address:</p> <p> <code><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress>lt;/Grantee></code> </p> <p>The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.</p> <note> <p>Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions: </p> <ul> <li> <p>US East (N. Virginia)</p> </li> <li> <p>US West (N. California)</p> </li> <li> <p> US West (Oregon)</p> </li> <li> <p> Asia Pacific (Singapore)</p> </li> <li> <p>Asia Pacific (Sydney)</p> </li> <li> <p>Asia Pacific (Tokyo)</p> </li> <li> <p>Europe (Ireland)</p> </li> <li> <p>South America (São Paulo)</p> </li> </ul> <p>For a list of all the Amazon S3 supported Regions and endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region">Regions and Endpoints</a> in the Amazon Web Services General Reference.</p> </note> </li> </ul> <p> <b>Versioning</b> </p> <p>The ACL of an object is set at the object version level. By default, PUT sets the ACL of the current version of an object. To set the ACL of a different version, use the <code>versionId</code> subresource.</p> <p class="title"> <b>Related Resources</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html">CopyObject</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a> </p> </li> </ul> | diff --git a/docs/aws-docs/providers/aws/s3/object_attributes/index.md b/docs/aws-docs/providers/aws/s3/object_attributes/index.md deleted file mode 100644 index eedd84c17e..0000000000 --- a/docs/aws-docs/providers/aws/s3/object_attributes/index.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: object_attributes -hide_title: false -hide_table_of_contents: false -keywords: - - object_attributes - - 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 ---- - - - -## Overview - - - - -
Nameobject_attributes
TypeResource
Idaws.s3.object_attributes
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `Checksum` | `object` | Contains all the possible checksum or digest values for an object. | -| `ETag` | `string` | An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL. | -| `ObjectParts` | `object` | A collection of parts associated with a multipart upload. | -| `ObjectSize` | `integer` | The size of the object in bytes. | -| `StorageClass` | `string` | <p>Provides the storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage Classes</a>.</p> | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `object_attributes_Get` | `SELECT` | `Key, x-amz-object-attributes, bucket, region` | diff --git a/docs/aws-docs/providers/aws/s3/object_contents/index.md b/docs/aws-docs/providers/aws/s3/object_contents/index.md deleted file mode 100644 index be6f020d43..0000000000 --- a/docs/aws-docs/providers/aws/s3/object_contents/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: object_contents -hide_title: false -hide_table_of_contents: false -keywords: - - object_contents - - 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 ---- - - - -## Overview - - - - -
Nameobject_contents
TypeResource
Idaws.s3.object_contents
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `object_contents_Select` | `EXEC` | `Key, select-type, bucket, region` | diff --git a/docs/aws-docs/providers/aws/s3/object_legal_holds/index.md b/docs/aws-docs/providers/aws/s3/object_legal_holds/index.md deleted file mode 100644 index 1ebb2a12f2..0000000000 --- a/docs/aws-docs/providers/aws/s3/object_legal_holds/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: object_legal_holds -hide_title: false -hide_table_of_contents: false -keywords: - - object_legal_holds - - 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 ---- - - - -## Overview - - - - -
Nameobject_legal_holds
TypeResource
Idaws.s3.object_legal_holds
- -## Fields -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `object_legal_holds_Get` | `SELECT` | `Key, bucket, region` | <p>Gets an object's current legal hold status. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Locking Objects</a>.</p> <p>This action is not supported by Amazon S3 on Outposts.</p> <p>The following action is related to <code>GetObjectLegalHold</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html">GetObjectAttributes</a> </p> </li> </ul> | -| `object_legal_holds_Put` | `EXEC` | `Key, bucket, region` | <p>Applies a legal hold configuration to the specified object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Locking Objects</a>.</p> <p>This action is not supported by Amazon S3 on Outposts.</p> | diff --git a/docs/aws-docs/providers/aws/s3/object_lock_configurations/index.md b/docs/aws-docs/providers/aws/s3/object_lock_configurations/index.md deleted file mode 100644 index bb5b32eba3..0000000000 --- a/docs/aws-docs/providers/aws/s3/object_lock_configurations/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: object_lock_configurations -hide_title: false -hide_table_of_contents: false -keywords: - - object_lock_configurations - - 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 ---- - - - -## Overview - - - - -
Nameobject_lock_configurations
TypeResource
Idaws.s3.object_lock_configurations
- -## Fields -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `object_lock_configurations_Get` | `SELECT` | `bucket, region` | <p>Gets the Object Lock configuration for a 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Locking Objects</a>.</p> <p>The following action is related to <code>GetObjectLockConfiguration</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html">GetObjectAttributes</a> </p> </li> </ul> | -| `object_lock_configurations_Put` | `EXEC` | `bucket, region` | <p>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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Locking Objects</a>. </p> <note> <ul> <li> <p>The <code>DefaultRetention</code> settings require both a mode and a period.</p> </li> <li> <p>The <code>DefaultRetention</code> period can be either <code>Days</code> or <code>Years</code> but you must select one. You cannot specify <code>Days</code> and <code>Years</code> at the same time.</p> </li> <li> <p>You can only enable Object Lock for new buckets. If you want to turn on Object Lock for an existing bucket, contact Amazon Web Services Support.</p> </li> </ul> </note> | diff --git a/docs/aws-docs/providers/aws/s3/object_retentions/index.md b/docs/aws-docs/providers/aws/s3/object_retentions/index.md deleted file mode 100644 index 6fb147e1a1..0000000000 --- a/docs/aws-docs/providers/aws/s3/object_retentions/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: object_retentions -hide_title: false -hide_table_of_contents: false -keywords: - - object_retentions - - 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 ---- - - - -## Overview - - - - -
Nameobject_retentions
TypeResource
Idaws.s3.object_retentions
- -## Fields -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `object_retentions_Get` | `SELECT` | `Key, bucket, region` | <p>Retrieves an object's retention settings. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Locking Objects</a>.</p> <p>This action is not supported by Amazon S3 on Outposts.</p> <p>The following action is related to <code>GetObjectRetention</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html">GetObjectAttributes</a> </p> </li> </ul> | -| `object_retentions_Put` | `EXEC` | `Key, bucket, region` | <p>Places an Object Retention configuration on an object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Locking Objects</a>. Users or accounts require the <code>s3:PutObjectRetention</code> permission in order to place an Object Retention configuration on objects. Bypassing a Governance Retention configuration requires the <code>s3:BypassGovernanceRetention</code> permission. </p> <p>This action is not supported by Amazon S3 on Outposts.</p> | diff --git a/docs/aws-docs/providers/aws/s3/object_taggings/index.md b/docs/aws-docs/providers/aws/s3/object_taggings/index.md deleted file mode 100644 index e4aa474c61..0000000000 --- a/docs/aws-docs/providers/aws/s3/object_taggings/index.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: object_taggings -hide_title: false -hide_table_of_contents: false -keywords: - - object_taggings - - 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 ---- - - - -## Overview - - - - -
Nameobject_taggings
TypeResource
Idaws.s3.object_taggings
- -## Fields -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `object_taggings_Get` | `SELECT` | `Key, bucket, region` | <p>Returns the tag-set of an object. You send the GET request against the tagging subresource associated with the object.</p> <p>To use this operation, you must have permission to perform the <code>s3:GetObjectTagging</code> action. By default, the GET action returns information about current version of an object. For a versioned bucket, you can have multiple versions of an object in your bucket. To retrieve tags of any other version, use the versionId query parameter. You also need permission for the <code>s3:GetObjectVersionTagging</code> action.</p> <p> By default, the bucket owner has this permission and can grant this permission to others.</p> <p> For information about the Amazon S3 object tagging feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html">Object Tagging</a>.</p> <p>The following actions are related to <code>GetObjectTagging</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjectTagging.html">DeleteObjectTagging</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html">GetObjectAttributes</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObjectTagging.html">PutObjectTagging</a> </p> </li> </ul> | -| `object_taggings_Delete` | `DELETE` | `Key, bucket, region` | <p>Removes the entire tag set from the specified object. For more information about managing object tags, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html"> Object Tagging</a>.</p> <p>To use this operation, you must have permission to perform the <code>s3:DeleteObjectTagging</code> action.</p> <p>To delete tags of a specific object version, add the <code>versionId</code> query parameter in the request. You will need permission for the <code>s3:DeleteObjectVersionTagging</code> action.</p> <p>The following operations are related to <code>DeleteBucketMetricsConfiguration</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObjectTagging.html">PutObjectTagging</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html">GetObjectTagging</a> </p> </li> </ul> | -| `object_taggings_Put` | `EXEC` | `Key, bucket, region` | <p>Sets the supplied tag-set to an object that already exists in a bucket.</p> <p>A tag is a key-value pair. You can associate tags with an object by sending a PUT request against the tagging subresource that is associated with the object. You can retrieve tags by sending a GET request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html">GetObjectTagging</a>.</p> <p>For tagging-related restrictions related to characters and encodings, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html">Tag Restrictions</a>. Note that Amazon S3 limits the maximum number of tags to 10 tags per object.</p> <p>To use this operation, you must have permission to perform the <code>s3:PutObjectTagging</code> action. By default, the bucket owner has this permission and can grant this permission to others.</p> <p>To put tags of any other version, use the <code>versionId</code> query parameter. You also need permission for the <code>s3:PutObjectVersionTagging</code> action.</p> <p>For information about the Amazon S3 object tagging feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html">Object Tagging</a>.</p> <p class="title"> <b>Special Errors</b> </p> <ul> <li> <ul> <li> <p> <i>Code: InvalidTagError </i> </p> </li> <li> <p> <i>Cause: The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html">Object Tagging</a>.</i> </p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code: MalformedXMLError </i> </p> </li> <li> <p> <i>Cause: The XML provided does not match the schema.</i> </p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code: OperationAbortedError </i> </p> </li> <li> <p> <i>Cause: A conflicting conditional action is currently in progress against this resource. Please try again.</i> </p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code: InternalError</i> </p> </li> <li> <p> <i>Cause: The service was unable to apply the provided tag to the object.</i> </p> </li> </ul> </li> </ul> <p class="title"> <b>Related Resources</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html">GetObjectTagging</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjectTagging.html">DeleteObjectTagging</a> </p> </li> </ul> | diff --git a/docs/aws-docs/providers/aws/s3/object_torrents/index.md b/docs/aws-docs/providers/aws/s3/object_torrents/index.md deleted file mode 100644 index 08b503fbaf..0000000000 --- a/docs/aws-docs/providers/aws/s3/object_torrents/index.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: object_torrents -hide_title: false -hide_table_of_contents: false -keywords: - - object_torrents - - 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 ---- - - - -## Overview - - - - -
Nameobject_torrents
TypeResource
Idaws.s3.object_torrents
- -## Fields -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `object_torrents_Get` | `SELECT` | `Key, bucket, region` | diff --git a/docs/aws-docs/providers/aws/s3/object_versions/index.md b/docs/aws-docs/providers/aws/s3/object_versions/index.md deleted file mode 100644 index dadc98839d..0000000000 --- a/docs/aws-docs/providers/aws/s3/object_versions/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: object_versions -hide_title: false -hide_table_of_contents: false -keywords: - - object_versions - - 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 ---- - - - -## Overview - - - - -
Nameobject_versions
TypeResource
Idaws.s3.object_versions
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `object_versions_List` | `EXEC` | `bucket, region` | diff --git a/docs/aws-docs/providers/aws/s3/objects/index.md b/docs/aws-docs/providers/aws/s3/objects/index.md deleted file mode 100644 index eb4097c101..0000000000 --- a/docs/aws-docs/providers/aws/s3/objects/index.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: objects -hide_title: false -hide_table_of_contents: false -keywords: - - objects - - 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 ---- - - - -## Overview - - - - -
Nameobjects
TypeResource
Idaws.s3.objects
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `ChecksumAlgorithm` | `array` | The algorithm that was used to create a checksum of the object. | -| `ETag` | `string` | <p>The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata. The ETag may or may not be an MD5 digest of the object data. Whether or not it is depends on how the object was created and how it is encrypted as described below:</p> <ul> <li> <p>Objects created by the PUT Object, POST Object, or Copy operation, or through the Amazon Web Services Management Console, and are encrypted by SSE-S3 or plaintext, have ETags that are an MD5 digest of their object data.</p> </li> <li> <p>Objects created by the PUT Object, POST Object, or Copy operation, or through the Amazon Web Services Management Console, and are encrypted by SSE-C or SSE-KMS, have ETags that are not an MD5 digest of their object data.</p> </li> <li> <p>If an object is created by either the Multipart Upload or Part Copy operation, the ETag is not an MD5 digest, regardless of the method of encryption. If an object is larger than 16 MB, the Amazon Web Services Management Console will upload or copy that object as a Multipart Upload, and therefore the ETag will not be an MD5 digest.</p> </li> </ul> | -| `Key` | `string` | The name that you assign to an object. You use the object key to retrieve the object. | -| `LastModified` | `string` | Creation date of the object. | -| `Owner` | `object` | Container for the owner's display name and ID. | -| `Size` | `integer` | Size in bytes of the object | -| `StorageClass` | `string` | The class of storage used to store the object. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `objects_Get` | `SELECT` | `Key, bucket, region` | <p>Retrieves objects from Amazon S3. To use <code>GET</code>, you must have <code>READ</code> access to the object. If you grant <code>READ</code> access to the anonymous user, you can return the object without using an authorization header.</p> <p>An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer file system. You can, however, create a logical hierarchy by using object key names that imply a folder structure. For example, instead of naming an object <code>sample.jpg</code>, you can name it <code>photos/2006/February/sample.jpg</code>.</p> <p>To get an object from such a logical hierarchy, specify the full key name for the object in the <code>GET</code> operation. For a virtual hosted-style request example, if you have the object <code>photos/2006/February/sample.jpg</code>, specify the resource as <code>/photos/2006/February/sample.jpg</code>. For a path-style request example, if you have the object <code>photos/2006/February/sample.jpg</code> in the bucket named <code>examplebucket</code>, specify the resource as <code>/examplebucket/photos/2006/February/sample.jpg</code>. For more information about request types, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html#VirtualHostingSpecifyBucket">HTTP Host Header Bucket Specification</a>.</p> <p>For more information about returning the ACL of an object, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html">GetObjectAcl</a>.</p> <p>If the object you are retrieving is stored in the S3 Glacier or S3 Glacier Deep Archive storage class, or S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive tiers, before you can retrieve the object you must first restore a copy using <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html">RestoreObject</a>. Otherwise, this action returns an <code>InvalidObjectStateError</code> error. For information about restoring archived objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html">Restoring Archived Objects</a>.</p> <p>Encryption request headers, like <code>x-amz-server-side-encryption</code>, should not be sent for GET requests if your object uses server-side encryption with KMS keys (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error.</p> <p>If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers:</p> <ul> <li> <p>x-amz-server-side-encryption-customer-algorithm</p> </li> <li> <p>x-amz-server-side-encryption-customer-key</p> </li> <li> <p>x-amz-server-side-encryption-customer-key-MD5</p> </li> </ul> <p>For more information about SSE-C, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side Encryption (Using Customer-Provided Encryption Keys)</a>.</p> <p>Assuming you have the relevant permission to read object tags, the response also returns the <code>x-amz-tagging-count</code> header that provides the count of number of tags associated with the object. You can use <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html">GetObjectTagging</a> to retrieve the tag set associated with an object.</p> <p> <b>Permissions</b> </p> <p>You need the relevant read object (or version) permission for this operation. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in a Policy</a>. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the <code>s3:ListBucket</code> permission.</p> <ul> <li> <p>If you have the <code>s3:ListBucket</code> permission on the bucket, Amazon S3 will return an HTTP status code 404 ("no such key") error.</p> </li> <li> <p>If you don’t have the <code>s3:ListBucket</code> permission, Amazon S3 will return an HTTP status code 403 ("access denied") error.</p> </li> </ul> <p> <b>Versioning</b> </p> <p>By default, the GET action returns the current version of an object. To return a different version, use the <code>versionId</code> subresource.</p> <note> <ul> <li> <p> If you supply a <code>versionId</code>, you need the <code>s3:GetObjectVersion</code> permission to access a specific version of an object. If you request a specific version, you do not need to have the <code>s3:GetObject</code> permission. </p> </li> <li> <p>If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes <code>x-amz-delete-marker: true</code> in the response.</p> </li> </ul> </note> <p>For more information about versioning, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketVersioning.html">PutBucketVersioning</a>. </p> <p> <b>Overriding Response Header Values</b> </p> <p>There are times when you want to override certain response header values in a GET response. For example, you might override the <code>Content-Disposition</code> response header value in your GET request.</p> <p>You can override values for a set of response headers using the following query parameters. These response header values are sent only on a successful request, that is, when status code 200 OK is returned. The set of headers you can override using these parameters is a subset of the headers that Amazon S3 accepts when you create an object. The response headers that you can override for the GET response are <code>Content-Type</code>, <code>Content-Language</code>, <code>Expires</code>, <code>Cache-Control</code>, <code>Content-Disposition</code>, and <code>Content-Encoding</code>. To override these header values in the GET response, you use the following request parameters.</p> <note> <p>You must sign the request, either using an Authorization header or a presigned URL, when using these parameters. They cannot be used with an unsigned (anonymous) request.</p> </note> <ul> <li> <p> <code>response-content-type</code> </p> </li> <li> <p> <code>response-content-language</code> </p> </li> <li> <p> <code>response-expires</code> </p> </li> <li> <p> <code>response-cache-control</code> </p> </li> <li> <p> <code>response-content-disposition</code> </p> </li> <li> <p> <code>response-content-encoding</code> </p> </li> </ul> <p> <b>Additional Considerations about Request Headers</b> </p> <p>If both of the <code>If-Match</code> and <code>If-Unmodified-Since</code> headers are present in the request as follows: <code>If-Match</code> condition evaluates to <code>true</code>, and; <code>If-Unmodified-Since</code> condition evaluates to <code>false</code>; then, S3 returns 200 OK and the data requested. </p> <p>If both of the <code>If-None-Match</code> and <code>If-Modified-Since</code> headers are present in the request as follows:<code> If-None-Match</code> condition evaluates to <code>false</code>, and; <code>If-Modified-Since</code> condition evaluates to <code>true</code>; then, S3 returns 304 Not Modified response code.</p> <p>For more information about conditional requests, see <a href="https://tools.ietf.org/html/rfc7232">RFC 7232</a>.</p> <p>The following operations are related to <code>GetObject</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html">ListBuckets</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html">GetObjectAcl</a> </p> </li> </ul> | -| `objects_List` | `SELECT` | `bucket, region` | <p>Returns some or all (up to 1,000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK response can contain valid or invalid XML. Be sure to design your application to parse the contents of the response and handle it appropriately.</p> <important> <p>This action has been revised. We recommend that you use the newer version, <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html">ListObjectsV2</a>, when developing applications. For backward compatibility, Amazon S3 continues to support <code>ListObjects</code>.</p> </important> <p>The following operations are related to <code>ListObjects</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html">ListObjectsV2</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html">ListBuckets</a> </p> </li> </ul> | -| `objects_Delete` | `DELETE` | `bucket, region` | <p>This action enables you to delete multiple objects from a bucket using a single HTTP request. If you know the object keys that you want to delete, then this action provides a suitable alternative to sending individual delete requests, reducing per-request overhead.</p> <p>The request contains a list of up to 1000 keys that you want to delete. In the XML, you provide the object key names, and optionally, version IDs if you want to delete a specific version of the object from a versioning-enabled bucket. For each key, Amazon S3 performs a delete action and returns the result of that delete, success, or failure, in the response. Note that if the object specified in the request is not found, Amazon S3 returns the result as deleted.</p> <p> The action supports two modes for the response: verbose and quiet. By default, the action uses verbose mode in which the response includes the result of deletion of each key in your request. In quiet mode the response includes only keys where the delete action encountered an error. For a successful deletion, the action does not return any information about the delete in the response body.</p> <p>When performing this action on an MFA Delete enabled bucket, that attempts to delete any versioned objects, you must include an MFA token. If you do not provide one, the entire request will fail, even if there are non-versioned objects you are trying to delete. If you provide an invalid token, whether there are versioned keys in the request or not, the entire Multi-Object Delete request will fail. For information about MFA Delete, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html#MultiFactorAuthenticationDelete"> MFA Delete</a>.</p> <p>Finally, the Content-MD5 header is required for all Multi-Object Delete requests. Amazon S3 uses the header value to ensure that your request body has not been altered in transit.</p> <p>The following operations are related to <code>DeleteObjects</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html">CompleteMultipartUpload</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html">ListParts</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html">AbortMultipartUpload</a> </p> </li> </ul> | -| `objects_Copy` | `EXEC` | `Key, x-amz-copy-source, bucket, region` | <p>Creates a copy of an object that is already stored in Amazon S3.</p> <note> <p>You can store individual objects of up to 5 TB in Amazon S3. You create a copy of your object up to 5 GB in size in a single atomic action using this API. However, to copy an object greater than 5 GB, you must use the multipart upload Upload Part - Copy (UploadPartCopy) API. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjctsUsingRESTMPUapi.html">Copy Object Using the REST Multipart Upload API</a>.</p> </note> <p>All copy requests must be authenticated. Additionally, you must have <i>read</i> access to the source object and <i>write</i> access to the destination bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html">REST Authentication</a>. Both the Region that you want to copy the object from and the Region that you want to copy the object to must be enabled for your account.</p> <p>A copy request might return an error when Amazon S3 receives the copy request or while Amazon S3 is copying the files. If the error occurs before the copy action starts, you receive a standard Amazon S3 error. If the error occurs during the copy operation, the error response is embedded in the <code>200 OK</code> response. This means that a <code>200 OK</code> response can contain either a success or an error. Design your application to parse the contents of the response and handle it appropriately.</p> <p>If the copy is successful, you receive a response with information about the copied object.</p> <note> <p>If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, it would not contain the content-length, and you would need to read the entire body.</p> </note> <p>The copy request charge is based on the storage class and Region that you specify for the destination object. For pricing information, see <a href="http://aws.amazon.com/s3/pricing/">Amazon S3 pricing</a>.</p> <important> <p>Amazon S3 transfer acceleration does not support cross-Region copies. If you request a cross-Region copy using a transfer acceleration endpoint, you get a 400 <code>Bad Request</code> error. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html">Transfer Acceleration</a>.</p> </important> <p> <b>Metadata</b> </p> <p>When copying an object, you can preserve all metadata (default) or specify new metadata. However, the ACL is not preserved and is set to private for the user making the request. To override the default ACL setting, specify a new ACL when generating a copy request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html">Using ACLs</a>. </p> <p>To specify whether you want the object metadata copied from the source object or replaced with metadata provided in the request, you can optionally add the <code>x-amz-metadata-directive</code> header. When you grant permissions, you can use the <code>s3:x-amz-metadata-directive</code> condition key to enforce certain metadata behavior when objects are uploaded. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/amazon-s3-policy-keys.html">Specifying Conditions in a Policy</a> in the <i>Amazon S3 User Guide</i>. For a complete list of Amazon S3-specific condition keys, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/list_amazons3.html">Actions, Resources, and Condition Keys for Amazon S3</a>.</p> <p> <b>x-amz-copy-source-if Headers</b> </p> <p>To only copy an object under certain conditions, such as whether the <code>Etag</code> matches or whether the object was modified before or after a specified date, use the following request parameters:</p> <ul> <li> <p> <code>x-amz-copy-source-if-match</code> </p> </li> <li> <p> <code>x-amz-copy-source-if-none-match</code> </p> </li> <li> <p> <code>x-amz-copy-source-if-unmodified-since</code> </p> </li> <li> <p> <code>x-amz-copy-source-if-modified-since</code> </p> </li> </ul> <p> If both the <code>x-amz-copy-source-if-match</code> and <code>x-amz-copy-source-if-unmodified-since</code> headers are present in the request and evaluate as follows, Amazon S3 returns <code>200 OK</code> and copies the data:</p> <ul> <li> <p> <code>x-amz-copy-source-if-match</code> condition evaluates to true</p> </li> <li> <p> <code>x-amz-copy-source-if-unmodified-since</code> condition evaluates to false</p> </li> </ul> <p>If both the <code>x-amz-copy-source-if-none-match</code> and <code>x-amz-copy-source-if-modified-since</code> headers are present in the request and evaluate as follows, Amazon S3 returns the <code>412 Precondition Failed</code> response code:</p> <ul> <li> <p> <code>x-amz-copy-source-if-none-match</code> condition evaluates to false</p> </li> <li> <p> <code>x-amz-copy-source-if-modified-since</code> condition evaluates to true</p> </li> </ul> <note> <p>All headers with the <code>x-amz-</code> prefix, including <code>x-amz-copy-source</code>, must be signed.</p> </note> <p> <b>Server-side encryption</b> </p> <p>When you perform a CopyObject operation, you can optionally use the appropriate encryption-related headers to encrypt the object using server-side encryption with Amazon Web Services managed encryption keys (SSE-S3 or SSE-KMS) or a customer-provided encryption key. With server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts the data when you access it. For more information about server-side encryption, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html">Using Server-Side Encryption</a>.</p> <p>If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html">Amazon S3 Bucket Keys</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Access Control List (ACL)-Specific Request Headers</b> </p> <p>When copying an object, you can optionally use headers to grant ACL-based permissions. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access Control List (ACL) Overview</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html">Managing ACLs Using the REST API</a>. </p> <p>If the bucket that you're copying objects to uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept PUT requests that don't specify an ACL or PUT requests that specify bucket owner full control ACLs, such as the <code>bucket-owner-full-control</code> canned ACL or an equivalent form of this ACL expressed in the XML format.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html"> Controlling ownership of objects and disabling ACLs</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>If your bucket uses the bucket owner enforced setting for Object Ownership, all objects written to the bucket by any account will be owned by the bucket owner.</p> </note> <p> <b>Checksums</b> </p> <p>When copying an object, if it has a checksum, that checksum will be copied to the new object by default. When you copy the object over, you may optionally specify a different checksum algorithm to use with the <code>x-amz-checksum-algorithm</code> header.</p> <p> <b>Storage Class Options</b> </p> <p>You can use the <code>CopyObject</code> action to change the storage class of an object that is already stored in Amazon S3 using the <code>StorageClass</code> parameter. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage Classes</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Versioning</b> </p> <p>By default, <code>x-amz-copy-source</code> identifies the current version of an object to copy. If the current version is a delete marker, Amazon S3 behaves as if the object was deleted. To copy a different version, use the <code>versionId</code> subresource.</p> <p>If you enable versioning on the target bucket, Amazon S3 generates a unique version ID for the object being copied. This version ID is different from the version ID of the source object. Amazon S3 returns the version ID of the copied object in the <code>x-amz-version-id</code> response header in the response.</p> <p>If you do not enable versioning or suspend it on the target bucket, the version ID that Amazon S3 generates is always null.</p> <p>If the source object's storage class is GLACIER, you must restore a copy of this object before you can use it as a source object for the copy operation. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html">RestoreObject</a>.</p> <p>The following operations are related to <code>CopyObject</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a> </p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjectsExamples.html">Copying Objects</a>.</p> | -| `objects_Put` | `EXEC` | `Key, bucket, region` | <p>Adds an object to a bucket. You must have WRITE permissions on a bucket to add an object to it.</p> <p>Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the entire object to the bucket.</p> <p>Amazon S3 is a distributed system. If it receives multiple write requests for the same object simultaneously, it overwrites all but the last object written. Amazon S3 does not provide object locking; if you need this, make sure to build it into your application layer or use versioning instead.</p> <p>To ensure that data is not corrupted traversing the network, use the <code>Content-MD5</code> header. When you use this header, Amazon S3 checks the object against the provided MD5 value and, if they do not match, returns an error. Additionally, you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to the calculated MD5 value.</p> <note> <ul> <li> <p>To successfully complete the <code>PutObject</code> request, you must have the <code>s3:PutObject</code> in your IAM permissions.</p> </li> <li> <p>To successfully change the objects acl of your <code>PutObject</code> request, you must have the <code>s3:PutObjectAcl</code> in your IAM permissions.</p> </li> <li> <p> The <code>Content-MD5</code> header is required for any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more information about Amazon S3 Object Lock, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.html">Amazon S3 Object Lock Overview</a> in the <i>Amazon S3 User Guide</i>. </p> </li> </ul> </note> <p> <b>Server-side Encryption</b> </p> <p>You can optionally request server-side encryption. With server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts the data when you access it. You have the option to provide your own encryption key or use Amazon Web Services managed encryption keys (SSE-S3 or SSE-KMS). For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html">Using Server-Side Encryption</a>.</p> <p>If you request server-side encryption using Amazon Web Services Key Management Service (SSE-KMS), you can enable an S3 Bucket Key at the object-level. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html">Amazon S3 Bucket Keys</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Access Control List (ACL)-Specific Request Headers</b> </p> <p>You can use headers to grant ACL- based permissions. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access Control List (ACL) Overview</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html">Managing ACLs Using the REST API</a>. </p> <p>If the bucket that you're uploading objects to uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept PUT requests that don't specify an ACL or PUT requests that specify bucket owner full control ACLs, such as the <code>bucket-owner-full-control</code> canned ACL or an equivalent form of this ACL expressed in the XML format. PUT requests that contain other ACLs (for example, custom grants to certain Amazon Web Services accounts) fail and return a <code>400</code> error with the error code <code>AccessControlListNotSupported</code>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html"> Controlling ownership of objects and disabling ACLs</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>If your bucket uses the bucket owner enforced setting for Object Ownership, all objects written to the bucket by any account will be owned by the bucket owner.</p> </note> <p> <b>Storage Class Options</b> </p> <p>By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage Classes</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Versioning</b> </p> <p>If you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID for the object being stored. Amazon S3 returns this ID in the response. When you enable versioning for a bucket, if Amazon S3 receives multiple write requests for the same object simultaneously, it stores all of the objects.</p> <p>For more information about versioning, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/AddingObjectstoVersioningEnabledBuckets.html">Adding Objects to Versioning Enabled Buckets</a>. For information about returning the versioning state of a bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html">GetBucketVersioning</a>. </p> <p class="title"> <b>Related Resources</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html">CopyObject</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html">DeleteObject</a> </p> </li> </ul> | -| `objects_Restore` | `EXEC` | `Key, bucket, region` | <p>Restores an archived copy of an object back into Amazon S3</p> <p>This action is not supported by Amazon S3 on Outposts.</p> <p>This action performs the following types of requests: </p> <ul> <li> <p> <code>select</code> - Perform a select query on an archived object</p> </li> <li> <p> <code>restore an archive</code> - Restore an archived object</p> </li> </ul> <p>To use this operation, you must have permissions to perform the <code>s3:RestoreObject</code> action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3 Resources</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Querying Archives with Select Requests</b> </p> <p>You use a select type of request to perform SQL queries on archived objects. The archived objects that are being queried by the select request must be formatted as uncompressed comma-separated values (CSV) files. You can run queries and custom analytics on your archived data without having to restore your data to a hotter Amazon S3 tier. For an overview about select requests, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/querying-glacier-archives.html">Querying Archived Objects</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When making a select request, do the following:</p> <ul> <li> <p>Define an output location for the select query's output. This must be an Amazon S3 bucket in the same Amazon Web Services Region as the bucket that contains the archive object that is being queried. The Amazon Web Services account that initiates the job must have permissions to write to the S3 bucket. You can specify the storage class and encryption for the output objects stored in the bucket. For more information about output, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/querying-glacier-archives.html">Querying Archived Objects</a> in the <i>Amazon S3 User Guide</i>.</p> <p>For more information about the <code>S3</code> structure in the request body, see the following:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html">Managing Access with ACLs</a> in the <i>Amazon S3 User Guide</i> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html">Protecting Data Using Server-Side Encryption</a> in the <i>Amazon S3 User Guide</i> </p> </li> </ul> </li> <li> <p>Define the SQL expression for the <code>SELECT</code> type of restoration for your query in the request body's <code>SelectParameters</code> structure. You can use expressions like the following examples.</p> <ul> <li> <p>The following expression returns all records from the specified object.</p> <p> <code>SELECT * FROM Object</code> </p> </li> <li> <p>Assuming that you are not using any headers for data stored in the object, you can specify columns with positional headers.</p> <p> <code>SELECT s._1, s._2 FROM Object s WHERE s._3 > 100</code> </p> </li> <li> <p>If you have headers and you set the <code>fileHeaderInfo</code> in the <code>CSV</code> structure in the request body to <code>USE</code>, you can specify headers in the query. (If you set the <code>fileHeaderInfo</code> field to <code>IGNORE</code>, the first row is skipped for the query.) You cannot mix ordinal positions with header column names. </p> <p> <code>SELECT s.Id, s.FirstName, s.SSN FROM S3Object s</code> </p> </li> </ul> </li> </ul> <p>For more information about using SQL with S3 Glacier Select restore, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-glacier-select-sql-reference.html">SQL Reference for Amazon S3 Select and S3 Glacier Select</a> in the <i>Amazon S3 User Guide</i>. </p> <p>When making a select request, you can also do the following:</p> <ul> <li> <p>To expedite your queries, specify the <code>Expedited</code> tier. For more information about tiers, see "Restoring Archives," later in this topic.</p> </li> <li> <p>Specify details about the data serialization format of both the input object that is being queried and the serialization of the CSV-encoded query results.</p> </li> </ul> <p>The following are additional important facts about the select feature:</p> <ul> <li> <p>The output results are new Amazon S3 objects. Unlike archive retrievals, they are stored until explicitly deleted-manually or through a lifecycle policy.</p> </li> <li> <p>You can issue more than one select request on the same Amazon S3 object. Amazon S3 doesn't deduplicate requests, so avoid issuing duplicate requests.</p> </li> <li> <p> Amazon S3 accepts a select request even if the object has already been restored. A select request doesn’t return error response <code>409</code>.</p> </li> </ul> <p> <b>Restoring objects</b> </p> <p>Objects that you archive to the S3 Glacier or S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive tiers are not accessible in real time. For objects in Archive Access or Deep Archive Access tiers you must first initiate a restore request, and then wait until the object is moved into the Frequent Access tier. For objects in S3 Glacier or S3 Glacier Deep Archive storage classes you must first initiate a restore request, and then wait until a temporary copy of the object is available. To access an archived object, you must restore the object for the duration (number of days) that you specify.</p> <p>To restore a specific object version, you can provide a version ID. If you don't provide a version ID, Amazon S3 restores the current version.</p> <p>When restoring an archived object (or using a select request), you can specify one of the following data access tier options in the <code>Tier</code> element of the request body: </p> <ul> <li> <p> <code>Expedited</code> - Expedited retrievals allow you to quickly access your data stored in the S3 Glacier storage class or S3 Intelligent-Tiering Archive tier when occasional urgent requests for a subset of archives are required. For all but the largest archived objects (250 MB+), data accessed using Expedited retrievals is typically made available within 1–5 minutes. Provisioned capacity ensures that retrieval capacity for Expedited retrievals is available when you need it. Expedited retrievals and provisioned capacity are not available for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier.</p> </li> <li> <p> <code>Standard</code> - Standard retrievals allow you to access any of your archived objects within several hours. This is the default option for retrieval requests that do not specify the retrieval option. Standard retrievals typically finish within 3–5 hours for objects stored in the S3 Glacier storage class or S3 Intelligent-Tiering Archive tier. They typically finish within 12 hours for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier. Standard retrievals are free for objects stored in S3 Intelligent-Tiering.</p> </li> <li> <p> <code>Bulk</code> - Bulk retrievals are the lowest-cost retrieval option in S3 Glacier, enabling you to retrieve large amounts, even petabytes, of data inexpensively. Bulk retrievals typically finish within 5–12 hours for objects stored in the S3 Glacier storage class or S3 Intelligent-Tiering Archive tier. They typically finish within 48 hours for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier. Bulk retrievals are free for objects stored in S3 Intelligent-Tiering.</p> </li> </ul> <p>For more information about archive retrieval options and provisioned capacity for <code>Expedited</code> data access, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html">Restoring Archived Objects</a> in the <i>Amazon S3 User Guide</i>. </p> <p>You can use Amazon S3 restore speed upgrade to change the restore speed to a faster speed while it is in progress. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html#restoring-objects-upgrade-tier.title.html"> Upgrading the speed of an in-progress restore</a> in the <i>Amazon S3 User Guide</i>. </p> <p>To get the status of object restoration, you can send a <code>HEAD</code> request. Operations return the <code>x-amz-restore</code> header, which provides information about the restoration status, in the response. You can use Amazon S3 event notifications to notify you when a restore is initiated or completed. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Configuring Amazon S3 Event Notifications</a> in the <i>Amazon S3 User Guide</i>.</p> <p>After restoring an archived object, you can update the restoration period by reissuing the request with a new period. Amazon S3 updates the restoration period relative to the current time and charges only for the request-there are no data transfer charges. You cannot update the restoration period when Amazon S3 is actively processing your current restore request for the object.</p> <p>If your bucket has a lifecycle configuration with a rule that includes an expiration action, the object expiration overrides the life span that you specify in a restore request. For example, if you restore an object copy for 10 days, but the object is scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days. For more information about lifecycle configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html">Object Lifecycle Management</a> in <i>Amazon S3 User Guide</i>.</p> <p> <b>Responses</b> </p> <p>A successful action returns either the <code>200 OK</code> or <code>202 Accepted</code> status code. </p> <ul> <li> <p>If the object is not previously restored, then Amazon S3 returns <code>202 Accepted</code> in the response. </p> </li> <li> <p>If the object is previously restored, Amazon S3 returns <code>200 OK</code> in the response. </p> </li> </ul> <p class="title"> <b>Special Errors</b> </p> <ul> <li> <ul> <li> <p> <i>Code: RestoreAlreadyInProgress</i> </p> </li> <li> <p> <i>Cause: Object restore is already in progress. (This error does not apply to SELECT type requests.)</i> </p> </li> <li> <p> <i>HTTP Status Code: 409 Conflict</i> </p> </li> <li> <p> <i>SOAP Fault Code Prefix: Client</i> </p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code: GlacierExpeditedRetrievalNotAvailable</i> </p> </li> <li> <p> <i>Cause: expedited retrievals are currently not available. Try again later. (Returned if there is insufficient capacity to process the Expedited request. This error applies only to Expedited retrievals and not to S3 Standard or Bulk retrievals.)</i> </p> </li> <li> <p> <i>HTTP Status Code: 503</i> </p> </li> <li> <p> <i>SOAP Fault Code Prefix: N/A</i> </p> </li> </ul> </li> </ul> <p class="title"> <b>Related Resources</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketNotificationConfiguration.html">GetBucketNotificationConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-glacier-select-sql-reference.html">SQL Reference for Amazon S3 Select and S3 Glacier Select </a> in the <i>Amazon S3 User Guide</i> </p> </li> </ul> | diff --git a/docs/aws-docs/providers/aws/s3/objects_v2s/index.md b/docs/aws-docs/providers/aws/s3/objects_v2s/index.md deleted file mode 100644 index 34b767c58e..0000000000 --- a/docs/aws-docs/providers/aws/s3/objects_v2s/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: objects_v2s -hide_title: false -hide_table_of_contents: false -keywords: - - objects_v2s - - 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 ---- - - - -## Overview - - - - -
Nameobjects_v2s
TypeResource
Idaws.s3.objects_v2s
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `objects_v2s_List` | `EXEC` | `list-type, bucket, region` | diff --git a/docs/aws-docs/providers/aws/s3/part_copies/index.md b/docs/aws-docs/providers/aws/s3/part_copies/index.md deleted file mode 100644 index 52f9c5ff93..0000000000 --- a/docs/aws-docs/providers/aws/s3/part_copies/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: part_copies -hide_title: false -hide_table_of_contents: false -keywords: - - part_copies - - 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 ---- - - - -## Overview - - - - -
Namepart_copies
TypeResource
Idaws.s3.part_copies
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `part_copies_Upload` | `EXEC` | `Key, partNumber, uploadId, x-amz-copy-source, bucket, region` | diff --git a/docs/aws-docs/providers/aws/s3/parts/index.md b/docs/aws-docs/providers/aws/s3/parts/index.md deleted file mode 100644 index 47033605f6..0000000000 --- a/docs/aws-docs/providers/aws/s3/parts/index.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: parts -hide_title: false -hide_table_of_contents: false -keywords: - - parts - - 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 ---- - - - -## Overview - - - - -
Nameparts
TypeResource
Idaws.s3.parts
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `parts_List` | `EXEC` | `Key, uploadId, bucket, region` | <p>Lists the parts that have been uploaded for a specific multipart upload. This operation must include the upload ID, which you obtain by sending the initiate multipart upload request (see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a>). This request returns a maximum of 1,000 uploaded parts. The default number of parts returned is 1,000 parts. You can restrict the number of parts returned by specifying the <code>max-parts</code> request parameter. If your multipart upload consists of more than 1,000 parts, the response returns an <code>IsTruncated</code> field with the value of true, and a <code>NextPartNumberMarker</code> element. In subsequent <code>ListParts</code> requests you can include the part-number-marker query string parameter and set its value to the <code>NextPartNumberMarker</code> field value from the previous response.</p> <p>If the upload was created using a checksum algorithm, you will need to have permission to the <code>kms:Decrypt</code> action for the request to succeed. </p> <p>For more information on multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html">Uploading Objects Using Multipart Upload</a>.</p> <p>For information on permissions required to use the multipart upload API, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart Upload and Permissions</a>.</p> <p>The following operations are related to <code>ListParts</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html">CompleteMultipartUpload</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html">AbortMultipartUpload</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html">GetObjectAttributes</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html">ListMultipartUploads</a> </p> </li> </ul> | -| `parts_Upload` | `EXEC` | `Key, partNumber, uploadId, bucket, region` | <p>Uploads a part in a multipart upload.</p> <note> <p>In this operation, you provide part data in your request. However, you have an option to specify your existing Amazon S3 object as a data source for the part you are uploading. To upload a part from an existing object, you use the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html">UploadPartCopy</a> operation. </p> </note> <p>You must initiate a multipart upload (see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a>) before you can upload any part. In response to your initiate request, Amazon S3 returns an upload ID, a unique identifier, that you must include in your upload part request.</p> <p>Part numbers can be any number from 1 to 10,000, inclusive. A part number uniquely identifies a part and also defines its position within the object being created. If you upload a new part using the same part number that was used with a previous part, the previously uploaded part is overwritten.</p> <p>For information about maximum and minimum part sizes and other multipart upload specifications, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/qfacts.html">Multipart upload limits</a> in the <i>Amazon S3 User Guide</i>.</p> <p>To ensure that data is not corrupted when traversing the network, specify the <code>Content-MD5</code> header in the upload part request. Amazon S3 checks the part data against the provided MD5 value. If they do not match, Amazon S3 returns an error. </p> <p>If the upload request is signed with Signature Version 4, then Amazon Web Services S3 uses the <code>x-amz-content-sha256</code> header as a checksum instead of <code>Content-MD5</code>. For more information see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-auth-using-authorization-header.html">Authenticating Requests: Using the Authorization Header (Amazon Web Services Signature Version 4)</a>. </p> <p> <b>Note:</b> After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.</p> <p>For more information on multipart uploads, go to <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html">Multipart Upload Overview</a> in the <i>Amazon S3 User Guide </i>.</p> <p>For information on the permissions required to use the multipart upload API, go to <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart Upload and Permissions</a> in the <i>Amazon S3 User Guide</i>.</p> <p>You can optionally request server-side encryption where Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it for you when you access it. You have the option of providing your own encryption key, or you can use the Amazon Web Services managed encryption keys. If you choose to provide your own encryption key, the request headers you provide in the request must match the headers you used in the request to initiate the upload by using <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a>. For more information, go to <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html">Using Server-Side Encryption</a> in the <i>Amazon S3 User Guide</i>.</p> <p>Server-side encryption is supported by the S3 Multipart Upload actions. Unless you are using a customer-provided encryption key, you don't need to specify the encryption parameters in each UploadPart request. Instead, you only need to specify the server-side encryption parameters in the initial Initiate Multipart request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a>.</p> <p>If you requested server-side encryption using a customer-provided encryption key in your initiate multipart upload request, you must provide identical encryption information in each part upload using the following headers.</p> <ul> <li> <p>x-amz-server-side-encryption-customer-algorithm</p> </li> <li> <p>x-amz-server-side-encryption-customer-key</p> </li> <li> <p>x-amz-server-side-encryption-customer-key-MD5</p> </li> </ul> <p class="title"> <b>Special Errors</b> </p> <ul> <li> <ul> <li> <p> <i>Code: NoSuchUpload</i> </p> </li> <li> <p> <i>Cause: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.</i> </p> </li> <li> <p> <i> HTTP Status Code: 404 Not Found </i> </p> </li> <li> <p> <i>SOAP Fault Code Prefix: Client</i> </p> </li> </ul> </li> </ul> <p class="title"> <b>Related Resources</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html">CompleteMultipartUpload</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html">AbortMultipartUpload</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html">ListParts</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html">ListMultipartUploads</a> </p> </li> </ul> | diff --git a/docs/aws-docs/providers/aws/s3/public_access_blocks/index.md b/docs/aws-docs/providers/aws/s3/public_access_blocks/index.md deleted file mode 100644 index a9e6f4ef05..0000000000 --- a/docs/aws-docs/providers/aws/s3/public_access_blocks/index.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: public_access_blocks -hide_title: false -hide_table_of_contents: false -keywords: - - public_access_blocks - - 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 ---- - - - -## Overview - - - - -
Namepublic_access_blocks
TypeResource
Idaws.s3.public_access_blocks
- -## Fields -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `public_access_blocks_Get` | `SELECT` | `bucket, region` | <p>Retrieves the <code>PublicAccessBlock</code> configuration for an Amazon S3 bucket. To use this operation, you must have the <code>s3:GetBucketPublicAccessBlock</code> permission. For more information about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in a Policy</a>.</p> <important> <p>When Amazon S3 evaluates the <code>PublicAccessBlock</code> configuration for a bucket or an object, it checks the <code>PublicAccessBlock</code> configuration for both the bucket (or the bucket that contains the object) and the bucket owner's account. If the <code>PublicAccessBlock</code> settings are different between the bucket and the account, Amazon S3 uses the most restrictive combination of the bucket-level and account-level settings.</p> </important> <p>For more information about when Amazon S3 considers a bucket or an object public, see <a href="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"</a>.</p> <p>The following operations are related to <code>GetPublicAccessBlock</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html">Using Amazon S3 Block Public Access</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutPublicAccessBlock.html">PutPublicAccessBlock</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html">GetPublicAccessBlock</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html">DeletePublicAccessBlock</a> </p> </li> </ul> | -| `public_access_blocks_Delete` | `DELETE` | `bucket, region` | <p>Removes the <code>PublicAccessBlock</code> configuration for an Amazon S3 bucket. To use this operation, you must have the <code>s3:PutBucketPublicAccessBlock</code> permission. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p>The following operations are related to <code>DeletePublicAccessBlock</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html">Using Amazon S3 Block Public Access</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html">GetPublicAccessBlock</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutPublicAccessBlock.html">PutPublicAccessBlock</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketPolicyStatus.html">GetBucketPolicyStatus</a> </p> </li> </ul> | -| `public_access_blocks_Put` | `EXEC` | `bucket, region` | <p>Creates or modifies the <code>PublicAccessBlock</code> configuration for an Amazon S3 bucket. To use this operation, you must have the <code>s3:PutBucketPublicAccessBlock</code> permission. For more information about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in a Policy</a>.</p> <important> <p>When Amazon S3 evaluates the <code>PublicAccessBlock</code> configuration for a bucket or an object, it checks the <code>PublicAccessBlock</code> configuration for both the bucket (or the bucket that contains the object) and the bucket owner's account. If the <code>PublicAccessBlock</code> configurations are different between the bucket and the account, Amazon S3 uses the most restrictive combination of the bucket-level and account-level settings.</p> </important> <p>For more information about when Amazon S3 considers a bucket or an object public, see <a href="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"</a>.</p> <p class="title"> <b>Related Resources</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html">GetPublicAccessBlock</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html">DeletePublicAccessBlock</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketPolicyStatus.html">GetBucketPolicyStatus</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html">Using Amazon S3 Block Public Access</a> </p> </li> </ul> | diff --git a/docs/aws-docs/providers/aws/s3/storage_lens/index.md b/docs/aws-docs/providers/aws/s3/storage_lens/index.md new file mode 100644 index 0000000000..d1a972f98e --- /dev/null +++ b/docs/aws-docs/providers/aws/s3/storage_lens/index.md @@ -0,0 +1,99 @@ +--- +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
DescriptionThe AWS::S3::StorageLens resource is an Amazon S3 resource type that you can use to create Storage Lens configurations.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +storage_lens_configuration, +tags +FROM aws.s3.storage_lens +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the storage_lens resource, the following permissions are required: + +### Read +```json +s3:GetStorageLensConfiguration, +s3:GetStorageLensConfigurationTagging +``` + +### Update +```json +s3:PutStorageLensConfiguration, +s3:PutStorageLensConfigurationTagging, +s3:GetStorageLensConfiguration, +s3:GetStorageLensConfigurationTagging, +organizations:DescribeOrganization, +organizations:ListAccounts, +organizations:ListAWSServiceAccessForOrganization, +organizations:ListDelegatedAdministrators, +iam:CreateServiceLinkedRole +``` + +### Delete +```json +s3:DeleteStorageLensConfiguration, +s3:DeleteStorageLensConfigurationTagging +``` + diff --git a/docs/aws-docs/providers/aws/s3/storage_lens_group/index.md b/docs/aws-docs/providers/aws/s3/storage_lens_group/index.md new file mode 100644 index 0000000000..ebd35d5c39 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3/storage_lens_group/index.md @@ -0,0 +1,98 @@ +--- +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
DescriptionThe AWS::S3::StorageLensGroup resource is an Amazon S3 resource type that you can use to create Storage Lens Group.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +filter, +storage_lens_group_arn, +tags +FROM aws.s3.storage_lens_group +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the storage_lens_group resource, the following permissions are required: + +### Read +```json +s3:GetStorageLensGroup, +s3:ListTagsForResource +``` + +### Update +```json +s3:GetStorageLensGroup, +s3:UpdateStorageLensGroup, +s3:TagResource, +s3:UntagResource, +s3:ListTagsForResource +``` + +### Delete +```json +s3:DeleteStorageLensGroup +``` + diff --git a/docs/aws-docs/providers/aws/s3/storage_lens_groups/index.md b/docs/aws-docs/providers/aws/s3/storage_lens_groups/index.md new file mode 100644 index 0000000000..feaf50b2df --- /dev/null +++ b/docs/aws-docs/providers/aws/s3/storage_lens_groups/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionThe AWS::S3::StorageLensGroup resource is an Amazon S3 resource type that you can use to create Storage Lens Group.
Idaws.s3.storage_lens_groups
+ +## Fields + + + + + +
NameDatatypeDescription
nameundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.s3.storage_lens_groups +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the storage_lens_groups resource, the following permissions are required: + +### Create +```json +s3:CreateStorageLensGroup, +s3:GetStorageLensGroup, +s3:TagResource, +s3:ListTagsForResource +``` + +### List +```json +s3:ListStorageLensGroups +``` + diff --git a/docs/aws-docs/providers/aws/s3_api/bucket_accelerate_configurations/index.md b/docs/aws-docs/providers/aws/s3_api/bucket_accelerate_configurations/index.md new file mode 100644 index 0000000000..75d206cd16 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3_api/bucket_accelerate_configurations/index.md @@ -0,0 +1,32 @@ +--- +title: bucket_accelerate_configurations +hide_title: false +hide_table_of_contents: false +keywords: + - bucket_accelerate_configurations + - s3_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namebucket_accelerate_configurations
TypeResource
Idaws.s3_api.bucket_accelerate_configurations
+ +## Fields +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `bucket_accelerate_configurations_Get` | `SELECT` | `bucket, region` | <p>This implementation of the GET action uses the <code>accelerate</code> subresource to return the Transfer Acceleration state of a bucket, which is either <code>Enabled</code> or <code>Suspended</code>. Amazon S3 Transfer Acceleration is a bucket-level feature that enables you to perform faster data transfers to and from Amazon S3.</p> <p>To use this operation, you must have permission to perform the <code>s3:GetAccelerateConfiguration</code> action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to your Amazon S3 Resources</a> in the <i>Amazon S3 User Guide</i>.</p> <p>You set the Transfer Acceleration state of an existing bucket to <code>Enabled</code> or <code>Suspended</code> by using the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAccelerateConfiguration.html">PutBucketAccelerateConfiguration</a> operation. </p> <p>A GET <code>accelerate</code> request does not return a state value for a bucket that has no transfer acceleration state. A bucket has no Transfer Acceleration state if a state has never been set on the bucket. </p> <p>For more information about transfer acceleration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html">Transfer Acceleration</a> in the Amazon S3 User Guide.</p> <p class="title"> <b>Related Resources</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAccelerateConfiguration.html">PutBucketAccelerateConfiguration</a> </p> </li> </ul> | +| `bucket_accelerate_configurations_Put` | `EXEC` | `bucket, region` | <p>Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration is a bucket-level feature that enables you to perform faster data transfers to Amazon S3.</p> <p> To use this operation, you must have permission to perform the <code>s3:PutAccelerateConfiguration</code> action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p> The Transfer Acceleration state of a bucket can be set to one of the following two values:</p> <ul> <li> <p> Enabled – Enables accelerated data transfers to the bucket.</p> </li> <li> <p> Suspended – Disables accelerated data transfers to the bucket.</p> </li> </ul> <p>The <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAccelerateConfiguration.html">GetBucketAccelerateConfiguration</a> action returns the transfer acceleration state of a bucket.</p> <p>After setting the Transfer Acceleration state of a bucket to Enabled, it might take up to thirty minutes before the data transfer rates to the bucket increase.</p> <p> The name of the bucket used for Transfer Acceleration must be DNS-compliant and must not contain periods (".").</p> <p> For more information about transfer acceleration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html">Transfer Acceleration</a>.</p> <p>The following operations are related to <code>PutBucketAccelerateConfiguration</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAccelerateConfiguration.html">GetBucketAccelerateConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a> </p> </li> </ul> | diff --git a/docs/aws-docs/providers/aws/s3_api/bucket_acls/index.md b/docs/aws-docs/providers/aws/s3_api/bucket_acls/index.md new file mode 100644 index 0000000000..bc0c7b60de --- /dev/null +++ b/docs/aws-docs/providers/aws/s3_api/bucket_acls/index.md @@ -0,0 +1,36 @@ +--- +title: bucket_acls +hide_title: false +hide_table_of_contents: false +keywords: + - bucket_acls + - s3_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namebucket_acls
TypeResource
Idaws.s3_api.bucket_acls
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `AccessControlList` | `array` | A list of grants. | +| `Owner` | `object` | Container for the owner's display name and ID. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `bucket_acls_Get` | `SELECT` | `bucket, region` | <p>This implementation of the <code>GET</code> action uses the <code>acl</code> subresource to return the access control list (ACL) of a bucket. To use <code>GET</code> to return the ACL of the bucket, you must have <code>READ_ACP</code> access to the bucket. If <code>READ_ACP</code> permission is granted to the anonymous user, you can return the ACL of the bucket without using an authorization header.</p> <note> <p>If your bucket uses the bucket owner enforced setting for S3 Object Ownership, requests to read ACLs are still supported and return the <code>bucket-owner-full-control</code> ACL with the owner being the account that created the bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html"> Controlling object ownership and disabling ACLs</a> in the <i>Amazon S3 User Guide</i>.</p> </note> <p class="title"> <b>Related Resources</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html">ListObjects</a> </p> </li> </ul> | +| `bucket_acls_Put` | `EXEC` | `bucket, region` | <p>Sets the permissions on an existing bucket using access control lists (ACL). For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html">Using ACLs</a>. To set the ACL of a bucket, you must have <code>WRITE_ACP</code> permission.</p> <p>You can use one of the following two ways to set a bucket's permissions:</p> <ul> <li> <p>Specify the ACL in the request body</p> </li> <li> <p>Specify permissions using request headers</p> </li> </ul> <note> <p>You cannot specify access permission using both the body and the request headers.</p> </note> <p>Depending on your application needs, you may choose to set the ACL on a bucket using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, then you can continue to use that approach.</p> <important> <p>If your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. You must use policies to grant access to your bucket and the objects in it. Requests to set ACLs or update ACLs fail and return the <code>AccessControlListNotSupported</code> error code. Requests to read ACLs are still supported. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">Controlling object ownership</a> in the <i>Amazon S3 User Guide</i>.</p> </important> <p> <b>Access Permissions</b> </p> <p>You can set access permissions using one of the following methods:</p> <ul> <li> <p>Specify a canned ACL with the <code>x-amz-acl</code> request header. Amazon S3 supports a set of predefined ACLs, known as <i>canned ACLs</i>. Each canned ACL has a predefined set of grantees and permissions. Specify the canned ACL name as the value of <code>x-amz-acl</code>. If you use this header, you cannot use other access control-specific headers in your request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL">Canned ACL</a>.</p> </li> <li> <p>Specify access permissions explicitly with the <code>x-amz-grant-read</code>, <code>x-amz-grant-read-acp</code>, <code>x-amz-grant-write-acp</code>, and <code>x-amz-grant-full-control</code> headers. When using these headers, you specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who will receive the permission. If you use these ACL-specific headers, you cannot use the <code>x-amz-acl</code> header to set a canned ACL. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access Control List (ACL) Overview</a>.</p> <p>You specify each grantee as a type=value pair, where the type is one of the following:</p> <ul> <li> <p> <code>id</code> – if the value specified is the canonical user ID of an Amazon Web Services account</p> </li> <li> <p> <code>uri</code> – if you are granting permissions to a predefined group</p> </li> <li> <p> <code>emailAddress</code> – if the value specified is the email address of an Amazon Web Services account</p> <note> <p>Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions: </p> <ul> <li> <p>US East (N. Virginia)</p> </li> <li> <p>US West (N. California)</p> </li> <li> <p> US West (Oregon)</p> </li> <li> <p> Asia Pacific (Singapore)</p> </li> <li> <p>Asia Pacific (Sydney)</p> </li> <li> <p>Asia Pacific (Tokyo)</p> </li> <li> <p>Europe (Ireland)</p> </li> <li> <p>South America (São Paulo)</p> </li> </ul> <p>For a list of all the Amazon S3 supported Regions and endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region">Regions and Endpoints</a> in the Amazon Web Services General Reference.</p> </note> </li> </ul> <p>For example, the following <code>x-amz-grant-write</code> header grants create, overwrite, and delete objects permission to LogDelivery group predefined by Amazon S3 and two Amazon Web Services accounts identified by their email addresses.</p> <p> <code>x-amz-grant-write: uri="http://acs.amazonaws.com/groups/s3/LogDelivery", id="111122223333", id="555566667777" </code> </p> </li> </ul> <p>You can use either a canned ACL or specify access permissions explicitly. You cannot do both.</p> <p> <b>Grantee Values</b> </p> <p>You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:</p> <ul> <li> <p>By the person's ID:</p> <p> <code><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee></code> </p> <p>DisplayName is optional and ignored in the request</p> </li> <li> <p>By URI:</p> <p> <code><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee></code> </p> </li> <li> <p>By Email address:</p> <p> <code><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress>lt;/Grantee></code> </p> <p>The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser. </p> <note> <p>Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions: </p> <ul> <li> <p>US East (N. Virginia)</p> </li> <li> <p>US West (N. California)</p> </li> <li> <p> US West (Oregon)</p> </li> <li> <p> Asia Pacific (Singapore)</p> </li> <li> <p>Asia Pacific (Sydney)</p> </li> <li> <p>Asia Pacific (Tokyo)</p> </li> <li> <p>Europe (Ireland)</p> </li> <li> <p>South America (São Paulo)</p> </li> </ul> <p>For a list of all the Amazon S3 supported Regions and endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region">Regions and Endpoints</a> in the Amazon Web Services General Reference.</p> </note> </li> </ul> <p class="title"> <b>Related Resources</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html">DeleteBucket</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html">GetObjectAcl</a> </p> </li> </ul> | diff --git a/docs/aws-docs/providers/aws/s3_api/bucket_analytics_configurations/index.md b/docs/aws-docs/providers/aws/s3_api/bucket_analytics_configurations/index.md new file mode 100644 index 0000000000..6c70cb0dfa --- /dev/null +++ b/docs/aws-docs/providers/aws/s3_api/bucket_analytics_configurations/index.md @@ -0,0 +1,34 @@ +--- +title: bucket_analytics_configurations +hide_title: false +hide_table_of_contents: false +keywords: + - bucket_analytics_configurations + - s3_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namebucket_analytics_configurations
TypeResource
Idaws.s3_api.bucket_analytics_configurations
+ +## Fields +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `bucket_analytics_configurations_Get` | `SELECT` | `id, bucket, region` | <p>This implementation of the GET action returns an analytics configuration (identified by the analytics configuration ID) from the bucket.</p> <p>To use this operation, you must have permissions to perform the <code>s3:GetAnalyticsConfiguration</code> action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources"> Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3 Resources</a> in the <i>Amazon S3 User Guide</i>. </p> <p>For information about Amazon S3 analytics feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html">Amazon S3 Analytics – Storage Class Analysis</a> in the <i>Amazon S3 User Guide</i>.</p> <p class="title"> <b>Related Resources</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html">DeleteBucketAnalyticsConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html">ListBucketAnalyticsConfigurations</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAnalyticsConfiguration.html">PutBucketAnalyticsConfiguration</a> </p> </li> </ul> | +| `bucket_analytics_configurations_List` | `SELECT` | `bucket, region` | <p>Lists the analytics configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.</p> <p>This action supports list pagination and does not return more than 100 configurations at a time. You should always check the <code>IsTruncated</code> element in the response. If there are no more configurations to list, <code>IsTruncated</code> is set to false. If there are more configurations to list, <code>IsTruncated</code> is set to true, and there will be a value in <code>NextContinuationToken</code>. You use the <code>NextContinuationToken</code> value to continue the pagination of the list by passing the value in continuation-token in the request to <code>GET</code> the next page.</p> <p>To use this operation, you must have permissions to perform the <code>s3:GetAnalyticsConfiguration</code> action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p>For information about Amazon S3 analytics feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html">Amazon S3 Analytics – Storage Class Analysis</a>. </p> <p>The following operations are related to <code>ListBucketAnalyticsConfigurations</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html">GetBucketAnalyticsConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html">DeleteBucketAnalyticsConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAnalyticsConfiguration.html">PutBucketAnalyticsConfiguration</a> </p> </li> </ul> | +| `bucket_analytics_configurations_Delete` | `DELETE` | `id, bucket, region` | <p>Deletes an analytics configuration for the bucket (specified by the analytics configuration ID).</p> <p>To use this operation, you must have permissions to perform the <code>s3:PutAnalyticsConfiguration</code> action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p>For information about the Amazon S3 analytics feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html">Amazon S3 Analytics – Storage Class Analysis</a>. </p> <p>The following operations are related to <code>DeleteBucketAnalyticsConfiguration</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html">GetBucketAnalyticsConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html">ListBucketAnalyticsConfigurations</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAnalyticsConfiguration.html">PutBucketAnalyticsConfiguration</a> </p> </li> </ul> | +| `bucket_analytics_configurations_Put` | `EXEC` | `id, bucket, region` | <p>Sets an analytics configuration for the bucket (specified by the analytics configuration ID). You can have up to 1,000 analytics configurations per bucket.</p> <p>You can choose to have storage class analysis export analysis reports sent to a comma-separated values (CSV) flat file. See the <code>DataExport</code> request element. Reports are updated daily and are based on the object filters that you configure. When selecting data export, you specify a destination bucket and an optional destination prefix where the file is written. You can export the data to a destination bucket in a different account. However, the destination bucket must be in the same Region as the bucket that you are making the PUT analytics configuration to. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html">Amazon S3 Analytics – Storage Class Analysis</a>. </p> <important> <p>You must create a bucket policy on the destination bucket where the exported file is written to grant permissions to Amazon S3 to write objects to the bucket. For an example policy, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html#example-bucket-policies-use-case-9">Granting Permissions for Amazon S3 Inventory and Storage Class Analysis</a>.</p> </important> <p>To use this operation, you must have permissions to perform the <code>s3:PutAnalyticsConfiguration</code> action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p class="title"> <b>Special Errors</b> </p> <ul> <li> <ul> <li> <p> <i>HTTP Error: HTTP 400 Bad Request</i> </p> </li> <li> <p> <i>Code: InvalidArgument</i> </p> </li> <li> <p> <i>Cause: Invalid argument.</i> </p> </li> </ul> </li> <li> <ul> <li> <p> <i>HTTP Error: HTTP 400 Bad Request</i> </p> </li> <li> <p> <i>Code: TooManyConfigurations</i> </p> </li> <li> <p> <i>Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.</i> </p> </li> </ul> </li> <li> <ul> <li> <p> <i>HTTP Error: HTTP 403 Forbidden</i> </p> </li> <li> <p> <i>Code: AccessDenied</i> </p> </li> <li> <p> <i>Cause: You are not the owner of the specified bucket, or you do not have the s3:PutAnalyticsConfiguration bucket permission to set the configuration on the bucket.</i> </p> </li> </ul> </li> </ul> <p class="title"> <b>Related Resources</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html">GetBucketAnalyticsConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html">DeleteBucketAnalyticsConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html">ListBucketAnalyticsConfigurations</a> </p> </li> </ul> | diff --git a/docs/aws-docs/providers/aws/s3_api/bucket_cors/index.md b/docs/aws-docs/providers/aws/s3_api/bucket_cors/index.md new file mode 100644 index 0000000000..2fc776aea0 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3_api/bucket_cors/index.md @@ -0,0 +1,33 @@ +--- +title: bucket_cors +hide_title: false +hide_table_of_contents: false +keywords: + - bucket_cors + - s3_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namebucket_cors
TypeResource
Idaws.s3_api.bucket_cors
+ +## Fields +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `bucket_cors_Get` | `SELECT` | `bucket, region` | <p>Returns the Cross-Origin Resource Sharing (CORS) configuration information set for the bucket.</p> <p> To use this operation, you must have permission to perform the <code>s3:GetBucketCORS</code> action. By default, the bucket owner has this permission and can grant it to others.</p> <p> For more information about CORS, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html"> Enabling Cross-Origin Resource Sharing</a>.</p> <p>The following operations are related to <code>GetBucketCors</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketCors.html">PutBucketCors</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketCors.html">DeleteBucketCors</a> </p> </li> </ul> | +| `bucket_cors_Delete` | `DELETE` | `bucket, region` | <p>Deletes the <code>cors</code> configuration information set for the bucket.</p> <p>To use this operation, you must have permission to perform the <code>s3:PutBucketCORS</code> action. The bucket owner has this permission by default and can grant this permission to others. </p> <p>For information about <code>cors</code>, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html">Enabling Cross-Origin Resource Sharing</a> in the <i>Amazon S3 User Guide</i>.</p> <p class="title"> <b>Related Resources:</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketCors.html">PutBucketCors</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTOPTIONSobject.html">RESTOPTIONSobject</a> </p> </li> </ul> | +| `bucket_cors_Put` | `EXEC` | `bucket, region` | <p>Sets the <code>cors</code> configuration for your bucket. If the configuration exists, Amazon S3 replaces it.</p> <p>To use this operation, you must be allowed to perform the <code>s3:PutBucketCORS</code> action. By default, the bucket owner has this permission and can grant it to others.</p> <p>You set this configuration on a bucket so that the bucket can service cross-origin requests. For example, you might want to enable a request whose origin is <code>http://www.example.com</code> to access your Amazon S3 bucket at <code>my.example.bucket.com</code> by using the browser's <code>XMLHttpRequest</code> capability.</p> <p>To enable cross-origin resource sharing (CORS) on a bucket, you add the <code>cors</code> subresource to the bucket. The <code>cors</code> subresource is an XML document in which you configure rules that identify origins and the HTTP methods that can be executed on your bucket. The document is limited to 64 KB in size. </p> <p>When Amazon S3 receives a cross-origin request (or a pre-flight OPTIONS request) against a bucket, it evaluates the <code>cors</code> configuration on the bucket and uses the first <code>CORSRule</code> rule that matches the incoming browser request to enable a cross-origin request. For a rule to match, the following conditions must be met:</p> <ul> <li> <p>The request's <code>Origin</code> header must match <code>AllowedOrigin</code> elements.</p> </li> <li> <p>The request method (for example, GET, PUT, HEAD, and so on) or the <code>Access-Control-Request-Method</code> header in case of a pre-flight <code>OPTIONS</code> request must be one of the <code>AllowedMethod</code> elements. </p> </li> <li> <p>Every header specified in the <code>Access-Control-Request-Headers</code> request header of a pre-flight request must match an <code>AllowedHeader</code> element. </p> </li> </ul> <p> For more information about CORS, go to <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html">Enabling Cross-Origin Resource Sharing</a> in the <i>Amazon S3 User Guide</i>.</p> <p class="title"> <b>Related Resources</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketCors.html">GetBucketCors</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketCors.html">DeleteBucketCors</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTOPTIONSobject.html">RESTOPTIONSobject</a> </p> </li> </ul> | diff --git a/docs/aws-docs/providers/aws/s3_api/bucket_encryptions/index.md b/docs/aws-docs/providers/aws/s3_api/bucket_encryptions/index.md new file mode 100644 index 0000000000..7cdae114c3 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3_api/bucket_encryptions/index.md @@ -0,0 +1,33 @@ +--- +title: bucket_encryptions +hide_title: false +hide_table_of_contents: false +keywords: + - bucket_encryptions + - s3_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namebucket_encryptions
TypeResource
Idaws.s3_api.bucket_encryptions
+ +## Fields +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `bucket_encryptions_Get` | `SELECT` | `bucket, region` | <p>Returns the default encryption configuration for an Amazon S3 bucket. If the bucket does not have a default encryption configuration, GetBucketEncryption returns <code>ServerSideEncryptionConfigurationNotFoundError</code>. </p> <p>For information about the Amazon S3 default encryption feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html">Amazon S3 Default Bucket Encryption</a>.</p> <p> To use this operation, you must have permission to perform the <code>s3:GetEncryptionConfiguration</code> action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p>The following operations are related to <code>GetBucketEncryption</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketEncryption.html">PutBucketEncryption</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html">DeleteBucketEncryption</a> </p> </li> </ul> | +| `bucket_encryptions_Delete` | `DELETE` | `bucket, region` | <p>This implementation of the DELETE action removes default encryption from the bucket. For information about the Amazon S3 default encryption feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html">Amazon S3 Default Bucket Encryption</a> in the <i>Amazon S3 User Guide</i>.</p> <p>To use this operation, you must have permissions to perform the <code>s3:PutEncryptionConfiguration</code> action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to your Amazon S3 Resources</a> in the <i>Amazon S3 User Guide</i>.</p> <p class="title"> <b>Related Resources</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketEncryption.html">PutBucketEncryption</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html">GetBucketEncryption</a> </p> </li> </ul> | +| `bucket_encryptions_Put` | `EXEC` | `bucket, region` | <p>This action uses the <code>encryption</code> subresource to configure default encryption and Amazon S3 Bucket Key for an existing bucket.</p> <p>Default encryption for a bucket can use server-side encryption with Amazon S3-managed keys (SSE-S3) or customer managed keys (SSE-KMS). If you specify default encryption using SSE-KMS, you can also configure Amazon S3 Bucket Key. When the default encryption is SSE-KMS, if you upload an object to the bucket and do not specify the KMS key to use for encryption, Amazon S3 uses the default Amazon Web Services managed KMS key for your account. For information about default encryption, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html">Amazon S3 default bucket encryption</a> in the <i>Amazon S3 User Guide</i>. For more information about S3 Bucket Keys, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html">Amazon S3 Bucket Keys</a> in the <i>Amazon S3 User Guide</i>.</p> <important> <p>This action requires Amazon Web Services Signature Version 4. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html"> Authenticating Requests (Amazon Web Services Signature Version 4)</a>. </p> </important> <p>To use this operation, you must have permissions to perform the <code>s3:PutEncryptionConfiguration</code> action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3 Resources</a> in the Amazon S3 User Guide. </p> <p class="title"> <b>Related Resources</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html">GetBucketEncryption</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html">DeleteBucketEncryption</a> </p> </li> </ul> | diff --git a/docs/aws-docs/providers/aws/s3_api/bucket_intelligent_tiering_configurations/index.md b/docs/aws-docs/providers/aws/s3_api/bucket_intelligent_tiering_configurations/index.md new file mode 100644 index 0000000000..146e5f6407 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3_api/bucket_intelligent_tiering_configurations/index.md @@ -0,0 +1,34 @@ +--- +title: bucket_intelligent_tiering_configurations +hide_title: false +hide_table_of_contents: false +keywords: + - bucket_intelligent_tiering_configurations + - s3_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namebucket_intelligent_tiering_configurations
TypeResource
Idaws.s3_api.bucket_intelligent_tiering_configurations
+ +## Fields +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `bucket_intelligent_tiering_configurations_Get` | `SELECT` | `id, bucket, region` | <p>Gets the S3 Intelligent-Tiering configuration from the specified bucket.</p> <p>The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.</p> <p>The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access">Storage class for automatically optimizing frequently and infrequently accessed objects</a>.</p> <p>Operations related to <code>GetBucketIntelligentTieringConfiguration</code> include: </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketIntelligentTieringConfiguration.html">DeleteBucketIntelligentTieringConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketIntelligentTieringConfiguration.html">PutBucketIntelligentTieringConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketIntelligentTieringConfigurations.html">ListBucketIntelligentTieringConfigurations</a> </p> </li> </ul> | +| `bucket_intelligent_tiering_configurations_List` | `SELECT` | `bucket, region` | <p>Lists the S3 Intelligent-Tiering configuration from the specified bucket.</p> <p>The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.</p> <p>The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access">Storage class for automatically optimizing frequently and infrequently accessed objects</a>.</p> <p>Operations related to <code>ListBucketIntelligentTieringConfigurations</code> include: </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketIntelligentTieringConfiguration.html">DeleteBucketIntelligentTieringConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketIntelligentTieringConfiguration.html">PutBucketIntelligentTieringConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketIntelligentTieringConfiguration.html">GetBucketIntelligentTieringConfiguration</a> </p> </li> </ul> | +| `bucket_intelligent_tiering_configurations_Delete` | `DELETE` | `id, bucket, region` | <p>Deletes the S3 Intelligent-Tiering configuration from the specified bucket.</p> <p>The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.</p> <p>The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access">Storage class for automatically optimizing frequently and infrequently accessed objects</a>.</p> <p>Operations related to <code>DeleteBucketIntelligentTieringConfiguration</code> include: </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketIntelligentTieringConfiguration.html">GetBucketIntelligentTieringConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketIntelligentTieringConfiguration.html">PutBucketIntelligentTieringConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketIntelligentTieringConfigurations.html">ListBucketIntelligentTieringConfigurations</a> </p> </li> </ul> | +| `bucket_intelligent_tiering_configurations_Put` | `EXEC` | `id, bucket, region` | <p>Puts a S3 Intelligent-Tiering configuration to the specified bucket. You can have up to 1,000 S3 Intelligent-Tiering configurations per bucket.</p> <p>The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.</p> <p>The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access">Storage class for automatically optimizing frequently and infrequently accessed objects</a>.</p> <p>Operations related to <code>PutBucketIntelligentTieringConfiguration</code> include: </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketIntelligentTieringConfiguration.html">DeleteBucketIntelligentTieringConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketIntelligentTieringConfiguration.html">GetBucketIntelligentTieringConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketIntelligentTieringConfigurations.html">ListBucketIntelligentTieringConfigurations</a> </p> </li> </ul> <note> <p>You only need S3 Intelligent-Tiering enabled on a bucket if you want to automatically move objects stored in the S3 Intelligent-Tiering storage class to the Archive Access or Deep Archive Access tier.</p> </note> <p class="title"> <b>Special Errors</b> </p> <ul> <li> <p class="title"> <b>HTTP 400 Bad Request Error</b> </p> <ul> <li> <p> <i>Code:</i> InvalidArgument</p> </li> <li> <p> <i>Cause:</i> Invalid Argument</p> </li> </ul> </li> <li> <p class="title"> <b>HTTP 400 Bad Request Error</b> </p> <ul> <li> <p> <i>Code:</i> TooManyConfigurations</p> </li> <li> <p> <i>Cause:</i> You are attempting to create a new configuration but have already reached the 1,000-configuration limit. </p> </li> </ul> </li> <li> <p class="title"> <b>HTTP 403 Forbidden Error</b> </p> <ul> <li> <p> <i>Code:</i> AccessDenied</p> </li> <li> <p> <i>Cause:</i> You are not the owner of the specified bucket, or you do not have the <code>s3:PutIntelligentTieringConfiguration</code> bucket permission to set the configuration on the bucket. </p> </li> </ul> </li> </ul> | diff --git a/docs/aws-docs/providers/aws/s3_api/bucket_inventory_configurations/index.md b/docs/aws-docs/providers/aws/s3_api/bucket_inventory_configurations/index.md new file mode 100644 index 0000000000..b0a5b690ca --- /dev/null +++ b/docs/aws-docs/providers/aws/s3_api/bucket_inventory_configurations/index.md @@ -0,0 +1,34 @@ +--- +title: bucket_inventory_configurations +hide_title: false +hide_table_of_contents: false +keywords: + - bucket_inventory_configurations + - s3_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namebucket_inventory_configurations
TypeResource
Idaws.s3_api.bucket_inventory_configurations
+ +## Fields +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `bucket_inventory_configurations_Get` | `SELECT` | `id, bucket, region` | <p>Returns an inventory configuration (identified by the inventory configuration ID) from the bucket.</p> <p>To use this operation, you must have permissions to perform the <code>s3:GetInventoryConfiguration</code> action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p>For information about the Amazon S3 inventory feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html">Amazon S3 Inventory</a>.</p> <p>The following operations are related to <code>GetBucketInventoryConfiguration</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html">DeleteBucketInventoryConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html">ListBucketInventoryConfigurations</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketInventoryConfiguration.html">PutBucketInventoryConfiguration</a> </p> </li> </ul> | +| `bucket_inventory_configurations_List` | `SELECT` | `bucket, region` | <p>Returns a list of inventory configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.</p> <p>This action supports list pagination and does not return more than 100 configurations at a time. Always check the <code>IsTruncated</code> element in the response. If there are no more configurations to list, <code>IsTruncated</code> is set to false. If there are more configurations to list, <code>IsTruncated</code> is set to true, and there is a value in <code>NextContinuationToken</code>. You use the <code>NextContinuationToken</code> value to continue the pagination of the list by passing the value in continuation-token in the request to <code>GET</code> the next page.</p> <p> To use this operation, you must have permissions to perform the <code>s3:GetInventoryConfiguration</code> action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p>For information about the Amazon S3 inventory feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html">Amazon S3 Inventory</a> </p> <p>The following operations are related to <code>ListBucketInventoryConfigurations</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html">GetBucketInventoryConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html">DeleteBucketInventoryConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketInventoryConfiguration.html">PutBucketInventoryConfiguration</a> </p> </li> </ul> | +| `bucket_inventory_configurations_Delete` | `DELETE` | `id, bucket, region` | <p>Deletes an inventory configuration (identified by the inventory ID) from the bucket.</p> <p>To use this operation, you must have permissions to perform the <code>s3:PutInventoryConfiguration</code> action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p>For information about the Amazon S3 inventory feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html">Amazon S3 Inventory</a>.</p> <p>Operations related to <code>DeleteBucketInventoryConfiguration</code> include: </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html">GetBucketInventoryConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketInventoryConfiguration.html">PutBucketInventoryConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html">ListBucketInventoryConfigurations</a> </p> </li> </ul> | +| `bucket_inventory_configurations_Put` | `EXEC` | `id, bucket, region` | <p>This implementation of the <code>PUT</code> action adds an inventory configuration (identified by the inventory ID) to the bucket. You can have up to 1,000 inventory configurations per bucket. </p> <p>Amazon S3 inventory generates inventories of the objects in the bucket on a daily or weekly basis, and the results are published to a flat file. The bucket that is inventoried is called the <i>source</i> bucket, and the bucket where the inventory flat file is stored is called the <i>destination</i> bucket. The <i>destination</i> bucket must be in the same Amazon Web Services Region as the <i>source</i> bucket. </p> <p>When you configure an inventory for a <i>source</i> bucket, you specify the <i>destination</i> bucket where you want the inventory to be stored, and whether to generate the inventory daily or weekly. You can also configure what object metadata to include and whether to inventory all object versions or only current versions. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html">Amazon S3 Inventory</a> in the Amazon S3 User Guide.</p> <important> <p>You must create a bucket policy on the <i>destination</i> bucket to grant permissions to Amazon S3 to write objects to the bucket in the defined location. For an example policy, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html#example-bucket-policies-use-case-9"> Granting Permissions for Amazon S3 Inventory and Storage Class Analysis</a>.</p> </important> <p>To use this operation, you must have permissions to perform the <code>s3:PutInventoryConfiguration</code> action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3 Resources</a> in the Amazon S3 User Guide.</p> <p class="title"> <b>Special Errors</b> </p> <ul> <li> <p class="title"> <b>HTTP 400 Bad Request Error</b> </p> <ul> <li> <p> <i>Code:</i> InvalidArgument</p> </li> <li> <p> <i>Cause:</i> Invalid Argument</p> </li> </ul> </li> <li> <p class="title"> <b>HTTP 400 Bad Request Error</b> </p> <ul> <li> <p> <i>Code:</i> TooManyConfigurations</p> </li> <li> <p> <i>Cause:</i> You are attempting to create a new configuration but have already reached the 1,000-configuration limit. </p> </li> </ul> </li> <li> <p class="title"> <b>HTTP 403 Forbidden Error</b> </p> <ul> <li> <p> <i>Code:</i> AccessDenied</p> </li> <li> <p> <i>Cause:</i> You are not the owner of the specified bucket, or you do not have the <code>s3:PutInventoryConfiguration</code> bucket permission to set the configuration on the bucket. </p> </li> </ul> </li> </ul> <p class="title"> <b>Related Resources</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html">GetBucketInventoryConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html">DeleteBucketInventoryConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html">ListBucketInventoryConfigurations</a> </p> </li> </ul> | diff --git a/docs/aws-docs/providers/aws/s3_api/bucket_lifecycle_configurations/index.md b/docs/aws-docs/providers/aws/s3_api/bucket_lifecycle_configurations/index.md new file mode 100644 index 0000000000..792cf4d0eb --- /dev/null +++ b/docs/aws-docs/providers/aws/s3_api/bucket_lifecycle_configurations/index.md @@ -0,0 +1,32 @@ +--- +title: bucket_lifecycle_configurations +hide_title: false +hide_table_of_contents: false +keywords: + - bucket_lifecycle_configurations + - s3_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namebucket_lifecycle_configurations
TypeResource
Idaws.s3_api.bucket_lifecycle_configurations
+ +## Fields +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `bucket_lifecycle_configurations_Get` | `SELECT` | `bucket, region` | <note> <p>Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The response describes the new filter element that you can use to specify a filter to select a subset of objects to which the rule applies. If you are using a previous version of the lifecycle configuration, it still works. For the earlier action, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html">GetBucketLifecycle</a>.</p> </note> <p>Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html">Object Lifecycle Management</a>.</p> <p>To use this operation, you must have permission to perform the <code>s3:GetLifecycleConfiguration</code> action. The bucket owner has this permission, by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p> <code>GetBucketLifecycleConfiguration</code> has the following special error:</p> <ul> <li> <p>Error code: <code>NoSuchLifecycleConfiguration</code> </p> <ul> <li> <p>Description: The lifecycle configuration does not exist.</p> </li> <li> <p>HTTP Status Code: 404 Not Found</p> </li> <li> <p>SOAP Fault Code Prefix: Client</p> </li> </ul> </li> </ul> <p>The following operations are related to <code>GetBucketLifecycleConfiguration</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html">GetBucketLifecycle</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html">PutBucketLifecycle</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html">DeleteBucketLifecycle</a> </p> </li> </ul> | +| `bucket_lifecycle_configurations_Put` | `EXEC` | `bucket, region` | <p>Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. Keep in mind that this will overwrite an existing lifecycle configuration, so if you want to retain any configuration details, they must be included in the new lifecycle configuration. For information about lifecycle configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html">Managing your storage lifecycle</a>.</p> <note> <p>Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The previous version of the API supported filtering based only on an object key name prefix, which is supported for backward compatibility. For the related API description, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html">PutBucketLifecycle</a>.</p> </note> <p> <b>Rules</b> </p> <p>You specify the lifecycle configuration in your request body. The lifecycle configuration is specified as XML consisting of one or more rules. An Amazon S3 Lifecycle configuration can have up to 1,000 rules. This limit is not adjustable. Each rule consists of the following:</p> <ul> <li> <p>Filter identifying a subset of objects to which the rule applies. The filter can be based on a key name prefix, object tags, or a combination of both.</p> </li> <li> <p>Status whether the rule is in effect.</p> </li> <li> <p>One or more lifecycle transition and expiration actions that you want Amazon S3 to perform on the objects identified by the filter. If the state of your bucket is versioning-enabled or versioning-suspended, you can have many versions of the same object (one current version and zero or more noncurrent versions). Amazon S3 provides predefined actions that you can specify for current and noncurrent object versions.</p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html">Object Lifecycle Management</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html">Lifecycle Configuration Elements</a>.</p> <p> <b>Permissions</b> </p> <p>By default, all Amazon S3 resources are private, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration). Only the resource owner (that is, the Amazon Web Services account that created it) can access the resource. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, a user must get the <code>s3:PutLifecycleConfiguration</code> permission.</p> <p>You can also explicitly deny permissions. Explicit deny also supersedes any other permissions. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions:</p> <ul> <li> <p> <code>s3:DeleteObject</code> </p> </li> <li> <p> <code>s3:DeleteObjectVersion</code> </p> </li> <li> <p> <code>s3:PutLifecycleConfiguration</code> </p> </li> </ul> <p>For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p>The following are related to <code>PutBucketLifecycleConfiguration</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-configuration-examples.html">Examples of Lifecycle Configuration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html">GetBucketLifecycleConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html">DeleteBucketLifecycle</a> </p> </li> </ul> | diff --git a/docs/aws-docs/providers/aws/s3_api/bucket_lifecycles/index.md b/docs/aws-docs/providers/aws/s3_api/bucket_lifecycles/index.md new file mode 100644 index 0000000000..24b1c28923 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3_api/bucket_lifecycles/index.md @@ -0,0 +1,33 @@ +--- +title: bucket_lifecycles +hide_title: false +hide_table_of_contents: false +keywords: + - bucket_lifecycles + - s3_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namebucket_lifecycles
TypeResource
Idaws.s3_api.bucket_lifecycles
+ +## Fields +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `bucket_lifecycles_Get` | `SELECT` | `bucket, region` | <important> <p>For an updated version of this API, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html">GetBucketLifecycleConfiguration</a>. If you configured a bucket lifecycle using the <code>filter</code> element, you should see the updated version of this topic. This topic is provided for backward compatibility.</p> </important> <p>Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html">Object Lifecycle Management</a>.</p> <p> To use this operation, you must have permission to perform the <code>s3:GetLifecycleConfiguration</code> action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p> <code>GetBucketLifecycle</code> has the following special error:</p> <ul> <li> <p>Error code: <code>NoSuchLifecycleConfiguration</code> </p> <ul> <li> <p>Description: The lifecycle configuration does not exist.</p> </li> <li> <p>HTTP Status Code: 404 Not Found</p> </li> <li> <p>SOAP Fault Code Prefix: Client</p> </li> </ul> </li> </ul> <p>The following operations are related to <code>GetBucketLifecycle</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html">GetBucketLifecycleConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html">PutBucketLifecycle</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html">DeleteBucketLifecycle</a> </p> </li> </ul> | +| `bucket_lifecycles_Delete` | `DELETE` | `bucket, region` | <p>Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration.</p> <p>To use this operation, you must have permission to perform the <code>s3:PutLifecycleConfiguration</code> action. By default, the bucket owner has this permission and the bucket owner can grant this permission to others.</p> <p>There is usually some time lag before lifecycle configuration deletion is fully propagated to all the Amazon S3 systems.</p> <p>For more information about the object expiration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#intro-lifecycle-rules-actions">Elements to Describe Lifecycle Actions</a>.</p> <p>Related actions include:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html">GetBucketLifecycleConfiguration</a> </p> </li> </ul> | +| `bucket_lifecycles_Put` | `EXEC` | `bucket, region` | <important> <p>For an updated version of this API, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a>. This version has been deprecated. Existing lifecycle configurations will work. For new lifecycle configurations, use the updated API. </p> </important> <p>Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. For information about lifecycle configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html">Object Lifecycle Management</a> in the <i>Amazon S3 User Guide</i>. </p> <p>By default, all Amazon S3 resources, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration) are private. Only the resource owner, the Amazon Web Services account that created the resource, can access it. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, users must get the <code>s3:PutLifecycleConfiguration</code> permission.</p> <p>You can also explicitly deny permissions. Explicit denial also supersedes any other permissions. If you want to prevent users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions: </p> <ul> <li> <p> <code>s3:DeleteObject</code> </p> </li> <li> <p> <code>s3:DeleteObjectVersion</code> </p> </li> <li> <p> <code>s3:PutLifecycleConfiguration</code> </p> </li> </ul> <p>For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to your Amazon S3 Resources</a> in the <i>Amazon S3 User Guide</i>.</p> <p>For more examples of transitioning objects to storage classes such as STANDARD_IA or ONEZONE_IA, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#lifecycle-configuration-examples">Examples of Lifecycle Configuration</a>.</p> <p class="title"> <b>Related Resources</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html">GetBucketLifecycle</a>(Deprecated)</p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html">GetBucketLifecycleConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html">RestoreObject</a> </p> </li> <li> <p>By default, a resource owner—in this case, a bucket owner, which is the Amazon Web Services account that created the bucket—can perform any of the operations. A resource owner can also grant others permission to perform the operation. For more information, see the following topics in the Amazon S3 User Guide: </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in a Policy</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to your Amazon S3 Resources</a> </p> </li> </ul> </li> </ul> | diff --git a/docs/aws-docs/providers/aws/s3_api/bucket_locations/index.md b/docs/aws-docs/providers/aws/s3_api/bucket_locations/index.md new file mode 100644 index 0000000000..7afba05491 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3_api/bucket_locations/index.md @@ -0,0 +1,31 @@ +--- +title: bucket_locations +hide_title: false +hide_table_of_contents: false +keywords: + - bucket_locations + - s3_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namebucket_locations
TypeResource
Idaws.s3_api.bucket_locations
+ +## Fields +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `bucket_locations_Get` | `SELECT` | `bucket, region` | diff --git a/docs/aws-docs/providers/aws/s3_api/bucket_loggings/index.md b/docs/aws-docs/providers/aws/s3_api/bucket_loggings/index.md new file mode 100644 index 0000000000..fe7f026de1 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3_api/bucket_loggings/index.md @@ -0,0 +1,32 @@ +--- +title: bucket_loggings +hide_title: false +hide_table_of_contents: false +keywords: + - bucket_loggings + - s3_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namebucket_loggings
TypeResource
Idaws.s3_api.bucket_loggings
+ +## Fields +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `bucket_loggings_Get` | `SELECT` | `bucket, region` | <p>Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the bucket owner.</p> <p>The following operations are related to <code>GetBucketLogging</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLogging.html">PutBucketLogging</a> </p> </li> </ul> | +| `bucket_loggings_Put` | `EXEC` | `bucket, region` | <p>Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. All logs are saved to buckets in the same Amazon Web Services Region as the source bucket. To set the logging status of a bucket, you must be the bucket owner.</p> <p>The bucket owner is automatically granted FULL_CONTROL to all logs. You use the <code>Grantee</code> request element to grant access to other people. The <code>Permissions</code> request element specifies the kind of access the grantee has to the logs.</p> <important> <p>If the target bucket for log delivery uses the bucket owner enforced setting for S3 Object Ownership, you can't use the <code>Grantee</code> request element to grant access to others. Permissions can only be granted using policies. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-server-access-logging.html#grant-log-delivery-permissions-general">Permissions for server access log delivery</a> in the <i>Amazon S3 User Guide</i>.</p> </important> <p> <b>Grantee Values</b> </p> <p>You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:</p> <ul> <li> <p>By the person's ID:</p> <p> <code><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee></code> </p> <p>DisplayName is optional and ignored in the request.</p> </li> <li> <p>By Email address:</p> <p> <code> <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee></code> </p> <p>The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.</p> </li> <li> <p>By URI:</p> <p> <code><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee></code> </p> </li> </ul> <p>To enable logging, you use LoggingEnabled and its children request elements. To disable logging, you use an empty BucketLoggingStatus request element:</p> <p> <code><BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" /></code> </p> <p>For more information about server access logging, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerLogs.html">Server Access Logging</a> in the <i>Amazon S3 User Guide</i>. </p> <p>For more information about creating a bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a>. For more information about returning the logging status of a bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLogging.html">GetBucketLogging</a>.</p> <p>The following operations are related to <code>PutBucketLogging</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html">DeleteBucket</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLogging.html">GetBucketLogging</a> </p> </li> </ul> | diff --git a/docs/aws-docs/providers/aws/s3_api/bucket_metrics_configurations/index.md b/docs/aws-docs/providers/aws/s3_api/bucket_metrics_configurations/index.md new file mode 100644 index 0000000000..ce9298b467 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3_api/bucket_metrics_configurations/index.md @@ -0,0 +1,34 @@ +--- +title: bucket_metrics_configurations +hide_title: false +hide_table_of_contents: false +keywords: + - bucket_metrics_configurations + - s3_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namebucket_metrics_configurations
TypeResource
Idaws.s3_api.bucket_metrics_configurations
+ +## Fields +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `bucket_metrics_configurations_Get` | `SELECT` | `id, bucket, region` | <p>Gets a metrics configuration (specified by the metrics configuration ID) from the bucket. Note that this doesn't include the daily storage metrics.</p> <p> To use this operation, you must have permissions to perform the <code>s3:GetMetricsConfiguration</code> action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p> For information about CloudWatch request metrics for Amazon S3, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring Metrics with Amazon CloudWatch</a>.</p> <p>The following operations are related to <code>GetBucketMetricsConfiguration</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html">PutBucketMetricsConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html">DeleteBucketMetricsConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketMetricsConfigurations.html">ListBucketMetricsConfigurations</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring Metrics with Amazon CloudWatch</a> </p> </li> </ul> | +| `bucket_metrics_configurations_List` | `SELECT` | `bucket, region` | <p>Lists the metrics configurations for the bucket. The metrics configurations are only for the request metrics of the bucket and do not provide information on daily storage metrics. You can have up to 1,000 configurations per bucket.</p> <p>This action supports list pagination and does not return more than 100 configurations at a time. Always check the <code>IsTruncated</code> element in the response. If there are no more configurations to list, <code>IsTruncated</code> is set to false. If there are more configurations to list, <code>IsTruncated</code> is set to true, and there is a value in <code>NextContinuationToken</code>. You use the <code>NextContinuationToken</code> value to continue the pagination of the list by passing the value in <code>continuation-token</code> in the request to <code>GET</code> the next page.</p> <p>To use this operation, you must have permissions to perform the <code>s3:GetMetricsConfiguration</code> action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p>For more information about metrics configurations and CloudWatch request metrics, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring Metrics with Amazon CloudWatch</a>.</p> <p>The following operations are related to <code>ListBucketMetricsConfigurations</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html">PutBucketMetricsConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html">GetBucketMetricsConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html">DeleteBucketMetricsConfiguration</a> </p> </li> </ul> | +| `bucket_metrics_configurations_Delete` | `DELETE` | `id, bucket, region` | <p>Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified by the metrics configuration ID) from the bucket. Note that this doesn't include the daily storage metrics.</p> <p> To use this operation, you must have permissions to perform the <code>s3:PutMetricsConfiguration</code> action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p>For information about CloudWatch request metrics for Amazon S3, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring Metrics with Amazon CloudWatch</a>. </p> <p>The following operations are related to <code>DeleteBucketMetricsConfiguration</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html">GetBucketMetricsConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html">PutBucketMetricsConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketMetricsConfigurations.html">ListBucketMetricsConfigurations</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring Metrics with Amazon CloudWatch</a> </p> </li> </ul> | +| `bucket_metrics_configurations_Put` | `EXEC` | `id, bucket, region` | <p>Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. You can have up to 1,000 metrics configurations per 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.</p> <p>To use this operation, you must have permissions to perform the <code>s3:PutMetricsConfiguration</code> action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p>For information about CloudWatch request metrics for Amazon S3, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring Metrics with Amazon CloudWatch</a>.</p> <p>The following operations are related to <code>PutBucketMetricsConfiguration</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html">DeleteBucketMetricsConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html">GetBucketMetricsConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketMetricsConfigurations.html">ListBucketMetricsConfigurations</a> </p> </li> </ul> <p> <code>GetBucketLifecycle</code> has the following special error:</p> <ul> <li> <p>Error code: <code>TooManyConfigurations</code> </p> <ul> <li> <p>Description: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.</p> </li> <li> <p>HTTP Status Code: HTTP 400 Bad Request</p> </li> </ul> </li> </ul> | diff --git a/docs/aws-docs/providers/aws/s3_api/bucket_notification_configurations/index.md b/docs/aws-docs/providers/aws/s3_api/bucket_notification_configurations/index.md new file mode 100644 index 0000000000..9bd58af864 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3_api/bucket_notification_configurations/index.md @@ -0,0 +1,38 @@ +--- +title: bucket_notification_configurations +hide_title: false +hide_table_of_contents: false +keywords: + - bucket_notification_configurations + - s3_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namebucket_notification_configurations
TypeResource
Idaws.s3_api.bucket_notification_configurations
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `CloudFunctionConfiguration` | `array` | Describes the Lambda functions to invoke and the events for which to invoke them. | +| `EventBridgeConfiguration` | `object` | A container for specifying the configuration for Amazon EventBridge. | +| `QueueConfiguration` | `array` | The Amazon Simple Queue Service queues to publish messages to and the events for which to publish messages. | +| `TopicConfiguration` | `array` | The topic to which notifications are sent and the events for which notifications are generated. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `bucket_notification_configurations_Get` | `SELECT` | `bucket, region` | <p>Returns the notification configuration of a bucket.</p> <p>If notifications are not enabled on the bucket, the action returns an empty <code>NotificationConfiguration</code> element.</p> <p>By default, you must be the bucket owner to read the notification configuration of a bucket. However, the bucket owner can use a bucket policy to grant permission to other users to read this configuration with the <code>s3:GetBucketNotification</code> permission.</p> <p>For more information about setting and reading the notification configuration on a bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Setting Up Notification of Bucket Events</a>. For more information about bucket policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html">Using Bucket Policies</a>.</p> <p>The following action is related to <code>GetBucketNotification</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketNotification.html">PutBucketNotification</a> </p> </li> </ul> | +| `bucket_notification_configurations_Put` | `EXEC` | `bucket, region` | <p>Enables notifications of specified events for a bucket. For more information about event notifications, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Configuring Event Notifications</a>.</p> <p>Using this API, you can replace an existing notification configuration. The configuration is an XML file that defines the event types that you want Amazon S3 to publish and the destination where you want Amazon S3 to publish an event notification when it detects an event of the specified type.</p> <p>By default, your bucket has no event notifications configured. That is, the notification configuration will be an empty <code>NotificationConfiguration</code>.</p> <p> <code><NotificationConfiguration></code> </p> <p> <code></NotificationConfiguration></code> </p> <p>This action replaces the existing notification configuration with the configuration you include in the request body.</p> <p>After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and that the bucket owner has permission to publish to it by sending a test notification. In the case of Lambda destinations, Amazon S3 verifies that the Lambda function permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Configuring Notifications for Amazon S3 Events</a>.</p> <p>You can disable notifications by adding the empty NotificationConfiguration element.</p> <p>For more information about the number of event notification configurations that you can create per bucket, see <a href="https://docs.aws.amazon.com/general/latest/gr/s3.html#limits_s3">Amazon S3 service quotas</a> in <i>Amazon Web Services General Reference</i>.</p> <p>By default, only the bucket owner can configure notifications on a bucket. However, bucket owners can use a bucket policy to grant permission to other users to set this configuration with <code>s3:PutBucketNotification</code> permission.</p> <note> <p>The PUT notification is an atomic operation. For example, suppose your notification configuration includes SNS topic, SQS queue, and Lambda function configurations. When you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS topic. If the message fails, the entire PUT action will fail, and Amazon S3 will not add the configuration to your bucket.</p> </note> <p> <b>Responses</b> </p> <p>If the configuration in the request body includes only one <code>TopicConfiguration</code> specifying only the <code>s3:ReducedRedundancyLostObject</code> event type, the response will also include the <code>x-amz-sns-test-message-id</code> header containing the message ID of the test notification sent to the topic.</p> <p>The following action is related to <code>PutBucketNotificationConfiguration</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketNotificationConfiguration.html">GetBucketNotificationConfiguration</a> </p> </li> </ul> | diff --git a/docs/aws-docs/providers/aws/s3_api/bucket_notifications/index.md b/docs/aws-docs/providers/aws/s3_api/bucket_notifications/index.md new file mode 100644 index 0000000000..26ecc4b6ed --- /dev/null +++ b/docs/aws-docs/providers/aws/s3_api/bucket_notifications/index.md @@ -0,0 +1,37 @@ +--- +title: bucket_notifications +hide_title: false +hide_table_of_contents: false +keywords: + - bucket_notifications + - s3_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namebucket_notifications
TypeResource
Idaws.s3_api.bucket_notifications
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `CloudFunctionConfiguration` | `object` | Container for specifying the Lambda notification configuration. | +| `QueueConfiguration` | `object` | This data type is deprecated. Use <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_QueueConfiguration.html">QueueConfiguration</a> for the same purposes. This data type specifies the configuration for publishing messages to an Amazon Simple Queue Service (Amazon SQS) queue when Amazon S3 detects specified events. | +| `TopicConfiguration` | `object` | A container for specifying the configuration for publication of messages to an Amazon Simple Notification Service (Amazon SNS) topic when Amazon S3 detects specified events. This data type is deprecated. Use <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_TopicConfiguration.html">TopicConfiguration</a> instead. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `bucket_notifications_Get` | `SELECT` | `bucket, region` | No longer used, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketNotificationConfiguration.html">GetBucketNotificationConfiguration</a>. | +| `bucket_notifications_Put` | `EXEC` | `bucket, region` | No longer used, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketNotificationConfiguration.html">PutBucketNotificationConfiguration</a> operation. | diff --git a/docs/aws-docs/providers/aws/s3_api/bucket_ownership_controls/index.md b/docs/aws-docs/providers/aws/s3_api/bucket_ownership_controls/index.md new file mode 100644 index 0000000000..579599cb53 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3_api/bucket_ownership_controls/index.md @@ -0,0 +1,33 @@ +--- +title: bucket_ownership_controls +hide_title: false +hide_table_of_contents: false +keywords: + - bucket_ownership_controls + - s3_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namebucket_ownership_controls
TypeResource
Idaws.s3_api.bucket_ownership_controls
+ +## Fields +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `bucket_ownership_controls_Get` | `SELECT` | `bucket, region` | <p>Retrieves <code>OwnershipControls</code> for an Amazon S3 bucket. To use this operation, you must have the <code>s3:GetBucketOwnershipControls</code> permission. For more information about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html">Specifying permissions in a policy</a>. </p> <p>For information about Amazon S3 Object Ownership, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">Using Object Ownership</a>. </p> <p>The following operations are related to <code>GetBucketOwnershipControls</code>:</p> <ul> <li> <p> <a>PutBucketOwnershipControls</a> </p> </li> <li> <p> <a>DeleteBucketOwnershipControls</a> </p> </li> </ul> | +| `bucket_ownership_controls_Delete` | `DELETE` | `bucket, region` | <p>Removes <code>OwnershipControls</code> for an Amazon S3 bucket. To use this operation, you must have the <code>s3:PutBucketOwnershipControls</code> permission. For more information about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in a Policy</a>.</p> <p>For information about Amazon S3 Object Ownership, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/about-object-ownership.html">Using Object Ownership</a>. </p> <p>The following operations are related to <code>DeleteBucketOwnershipControls</code>:</p> <ul> <li> <p> <a>GetBucketOwnershipControls</a> </p> </li> <li> <p> <a>PutBucketOwnershipControls</a> </p> </li> </ul> | +| `bucket_ownership_controls_Put` | `EXEC` | `bucket, region` | <p>Creates or modifies <code>OwnershipControls</code> for an Amazon S3 bucket. To use this operation, you must have the <code>s3:PutBucketOwnershipControls</code> permission. For more information about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/user-guide/using-with-s3-actions.html">Specifying permissions in a policy</a>. </p> <p>For information about Amazon S3 Object Ownership, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/user-guide/about-object-ownership.html">Using object ownership</a>. </p> <p>The following operations are related to <code>PutBucketOwnershipControls</code>:</p> <ul> <li> <p> <a>GetBucketOwnershipControls</a> </p> </li> <li> <p> <a>DeleteBucketOwnershipControls</a> </p> </li> </ul> | diff --git a/docs/aws-docs/providers/aws/s3_api/bucket_policies/index.md b/docs/aws-docs/providers/aws/s3_api/bucket_policies/index.md new file mode 100644 index 0000000000..f910dfc206 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3_api/bucket_policies/index.md @@ -0,0 +1,33 @@ +--- +title: bucket_policies +hide_title: false +hide_table_of_contents: false +keywords: + - bucket_policies + - s3_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namebucket_policies
TypeResource
Idaws.s3_api.bucket_policies
+ +## Fields +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `bucket_policies_Get` | `SELECT` | `bucket, region` | <p>Returns the policy of a specified bucket. If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the <code>GetBucketPolicy</code> permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.</p> <p>If you don't have <code>GetBucketPolicy</code> permissions, Amazon S3 returns a <code>403 Access Denied</code> error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a <code>405 Method Not Allowed</code> error.</p> <important> <p>As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.</p> </important> <p>For more information about bucket policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html">Using Bucket Policies and User Policies</a>.</p> <p>The following action is related to <code>GetBucketPolicy</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a> </p> </li> </ul> | +| `bucket_policies_Delete` | `DELETE` | `bucket, region` | <p>This implementation of the DELETE action uses the policy subresource to delete the policy of a specified bucket. If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the <code>DeleteBucketPolicy</code> permissions on the specified bucket and belong to the bucket owner's account to use this operation. </p> <p>If you don't have <code>DeleteBucketPolicy</code> permissions, Amazon S3 returns a <code>403 Access Denied</code> error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a <code>405 Method Not Allowed</code> error. </p> <important> <p>As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.</p> </important> <p>For more information about bucket policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html">Using Bucket Policies and UserPolicies</a>. </p> <p>The following operations are related to <code>DeleteBucketPolicy</code> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html">DeleteObject</a> </p> </li> </ul> | +| `bucket_policies_Put` | `EXEC` | `bucket, region` | <p>Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the <code>PutBucketPolicy</code> permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.</p> <p>If you don't have <code>PutBucketPolicy</code> permissions, Amazon S3 returns a <code>403 Access Denied</code> error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a <code>405 Method Not Allowed</code> error.</p> <important> <p> As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action. </p> </important> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html">Bucket policy examples</a>.</p> <p>The following operations are related to <code>PutBucketPolicy</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html">DeleteBucket</a> </p> </li> </ul> | diff --git a/docs/aws-docs/providers/aws/s3_api/bucket_policy_status/index.md b/docs/aws-docs/providers/aws/s3_api/bucket_policy_status/index.md new file mode 100644 index 0000000000..2efc37b932 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3_api/bucket_policy_status/index.md @@ -0,0 +1,31 @@ +--- +title: bucket_policy_status +hide_title: false +hide_table_of_contents: false +keywords: + - bucket_policy_status + - s3_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namebucket_policy_status
TypeResource
Idaws.s3_api.bucket_policy_status
+ +## Fields +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `bucket_policy_status_Get` | `SELECT` | `bucket, region` | diff --git a/docs/aws-docs/providers/aws/s3_api/bucket_replications/index.md b/docs/aws-docs/providers/aws/s3_api/bucket_replications/index.md new file mode 100644 index 0000000000..b8cfb643ef --- /dev/null +++ b/docs/aws-docs/providers/aws/s3_api/bucket_replications/index.md @@ -0,0 +1,33 @@ +--- +title: bucket_replications +hide_title: false +hide_table_of_contents: false +keywords: + - bucket_replications + - s3_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namebucket_replications
TypeResource
Idaws.s3_api.bucket_replications
+ +## Fields +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `bucket_replications_Get` | `SELECT` | `bucket, region` | <p>Returns the replication configuration of a bucket.</p> <note> <p> It can take a while to propagate the put or delete a replication configuration to all Amazon S3 systems. Therefore, a get request soon after put or delete can return a wrong result. </p> </note> <p> For information about replication configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html">Replication</a> in the <i>Amazon S3 User Guide</i>.</p> <p>This action requires permissions for the <code>s3:GetReplicationConfiguration</code> action. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html">Using Bucket Policies and User Policies</a>.</p> <p>If you include the <code>Filter</code> element in a replication configuration, you must also include the <code>DeleteMarkerReplication</code> and <code>Priority</code> elements. The response also returns those elements.</p> <p>For information about <code>GetBucketReplication</code> errors, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ReplicationErrorCodeList">List of replication-related error codes</a> </p> <p>The following operations are related to <code>GetBucketReplication</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketReplication.html">PutBucketReplication</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketReplication.html">DeleteBucketReplication</a> </p> </li> </ul> | +| `bucket_replications_Delete` | `DELETE` | `bucket, region` | <p> Deletes the replication configuration from the bucket.</p> <p>To use this operation, you must have permissions to perform the <code>s3:PutReplicationConfiguration</code> action. The bucket owner has these permissions by default and can grant it to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3 Resources</a>. </p> <note> <p>It can take a while for the deletion of a replication configuration to fully propagate.</p> </note> <p> For information about replication configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html">Replication</a> in the <i>Amazon S3 User Guide</i>.</p> <p>The following operations are related to <code>DeleteBucketReplication</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketReplication.html">PutBucketReplication</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketReplication.html">GetBucketReplication</a> </p> </li> </ul> | +| `bucket_replications_Put` | `EXEC` | `bucket, region` | <p> Creates a replication configuration or replaces an existing one. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html">Replication</a> in the <i>Amazon S3 User Guide</i>. </p> <p>Specify the replication configuration in the request body. In the replication configuration, you provide the name of the destination bucket or buckets where you want Amazon S3 to replicate objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, and other relevant information.</p> <p>A replication configuration must include at least one rule, and can contain a maximum of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects in the source bucket. To choose additional subsets of objects to replicate, add a rule for each subset.</p> <p>To specify a subset of the objects in the source bucket to apply a replication rule to, add the Filter element as a child of the Rule element. You can filter objects based on an object key prefix, one or more object tags, or both. When you add the Filter element in the configuration, you must also add the following elements: <code>DeleteMarkerReplication</code>, <code>Status</code>, and <code>Priority</code>.</p> <note> <p>If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations">Backward Compatibility</a>.</p> </note> <p>For information about enabling versioning on a bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html">Using Versioning</a>.</p> <p> <b>Handling Replication of Encrypted Objects</b> </p> <p>By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side encryption with KMS keys. To replicate Amazon Web Services KMS-encrypted objects, add the following: <code>SourceSelectionCriteria</code>, <code>SseKmsEncryptedObjects</code>, <code>Status</code>, <code>EncryptionConfiguration</code>, and <code>ReplicaKmsKeyID</code>. For information about replication configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-config-for-kms-objects.html">Replicating Objects Created with SSE Using KMS keys</a>.</p> <p>For information on <code>PutBucketReplication</code> errors, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ReplicationErrorCodeList">List of replication-related error codes</a> </p> <p> <b>Permissions</b> </p> <p>To create a <code>PutBucketReplication</code> request, you must have <code>s3:PutReplicationConfiguration</code> permissions for the bucket. </p> <p>By default, a resource owner, in this case the Amazon Web Services account that created the bucket, can perform this operation. The resource owner can also grant others permissions to perform the operation. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in a Policy</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <note> <p>To perform this operation, the user or role performing the action must have the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html">iam:PassRole</a> permission.</p> </note> <p>The following operations are related to <code>PutBucketReplication</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketReplication.html">GetBucketReplication</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketReplication.html">DeleteBucketReplication</a> </p> </li> </ul> | diff --git a/docs/aws-docs/providers/aws/s3_api/bucket_request_payments/index.md b/docs/aws-docs/providers/aws/s3_api/bucket_request_payments/index.md new file mode 100644 index 0000000000..c5d4250b40 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3_api/bucket_request_payments/index.md @@ -0,0 +1,32 @@ +--- +title: bucket_request_payments +hide_title: false +hide_table_of_contents: false +keywords: + - bucket_request_payments + - s3_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namebucket_request_payments
TypeResource
Idaws.s3_api.bucket_request_payments
+ +## Fields +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `bucket_request_payments_Get` | `SELECT` | `bucket, region` | <p>Returns the request payment configuration of a bucket. To use this version of the operation, you must be the bucket owner. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html">Requester Pays Buckets</a>.</p> <p>The following operations are related to <code>GetBucketRequestPayment</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html">ListObjects</a> </p> </li> </ul> | +| `bucket_request_payments_Put` | `EXEC` | `bucket, region` | <p>Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the download. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html">Requester Pays Buckets</a>.</p> <p>The following operations are related to <code>PutBucketRequestPayment</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketRequestPayment.html">GetBucketRequestPayment</a> </p> </li> </ul> | diff --git a/docs/aws-docs/providers/aws/s3_api/bucket_taggings/index.md b/docs/aws-docs/providers/aws/s3_api/bucket_taggings/index.md new file mode 100644 index 0000000000..5724c27350 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3_api/bucket_taggings/index.md @@ -0,0 +1,37 @@ +--- +title: bucket_taggings +hide_title: false +hide_table_of_contents: false +keywords: + - bucket_taggings + - s3_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namebucket_taggings
TypeResource
Idaws.s3_api.bucket_taggings
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `Key` | `string` | Name of the object key. | +| `Value` | `string` | Value of the tag. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `bucket_taggings_Get` | `SELECT` | `bucket, region` | <p>Returns the tag set associated with the bucket.</p> <p>To use this operation, you must have permission to perform the <code>s3:GetBucketTagging</code> action. By default, the bucket owner has this permission and can grant this permission to others.</p> <p> <code>GetBucketTagging</code> has the following special error:</p> <ul> <li> <p>Error code: <code>NoSuchTagSet</code> </p> <ul> <li> <p>Description: There is no tag set associated with the bucket.</p> </li> </ul> </li> </ul> <p>The following operations are related to <code>GetBucketTagging</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html">PutBucketTagging</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html">DeleteBucketTagging</a> </p> </li> </ul> | +| `bucket_taggings_Delete` | `DELETE` | `bucket, region` | <p>Deletes the tags from the bucket.</p> <p>To use this operation, you must have permission to perform the <code>s3:PutBucketTagging</code> action. By default, the bucket owner has this permission and can grant this permission to others. </p> <p>The following operations are related to <code>DeleteBucketTagging</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html">GetBucketTagging</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html">PutBucketTagging</a> </p> </li> </ul> | +| `bucket_taggings_Put` | `EXEC` | `bucket, region` | <p>Sets the tags for a bucket.</p> <p>Use tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this, sign up to get your Amazon Web Services account bill with tag key values included. Then, to see the cost of combined resources, organize your billing information according to resources with the same tag key values. For example, you can tag several resources with a specific application name, and then organize your billing information to see the total cost of that application across several services. For more information, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html">Cost Allocation and Tagging</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/CostAllocTagging.html">Using Cost Allocation in Amazon S3 Bucket Tags</a>.</p> <note> <p> When this operation sets the tags for a bucket, it will overwrite any current tags the bucket already has. You cannot use this operation to add tags to an existing list of tags.</p> </note> <p>To use this operation, you must have permissions to perform the <code>s3:PutBucketTagging</code> action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p> <code>PutBucketTagging</code> has the following special errors:</p> <ul> <li> <p>Error code: <code>InvalidTagError</code> </p> <ul> <li> <p>Description: The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For information about tag restrictions, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html">User-Defined Tag Restrictions</a> and <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/aws-tag-restrictions.html">Amazon Web Services-Generated Cost Allocation Tag Restrictions</a>.</p> </li> </ul> </li> <li> <p>Error code: <code>MalformedXMLError</code> </p> <ul> <li> <p>Description: The XML provided does not match the schema.</p> </li> </ul> </li> <li> <p>Error code: <code>OperationAbortedError </code> </p> <ul> <li> <p>Description: A conflicting conditional action is currently in progress against this resource. Please try again.</p> </li> </ul> </li> <li> <p>Error code: <code>InternalError</code> </p> <ul> <li> <p>Description: The service was unable to apply the provided tag to the bucket.</p> </li> </ul> </li> </ul> <p>The following operations are related to <code>PutBucketTagging</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html">GetBucketTagging</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html">DeleteBucketTagging</a> </p> </li> </ul> | diff --git a/docs/aws-docs/providers/aws/s3_api/bucket_versionings/index.md b/docs/aws-docs/providers/aws/s3_api/bucket_versionings/index.md new file mode 100644 index 0000000000..cf76d5497d --- /dev/null +++ b/docs/aws-docs/providers/aws/s3_api/bucket_versionings/index.md @@ -0,0 +1,36 @@ +--- +title: bucket_versionings +hide_title: false +hide_table_of_contents: false +keywords: + - bucket_versionings + - s3_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namebucket_versionings
TypeResource
Idaws.s3_api.bucket_versionings
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `MfaDelete` | `string` | Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only returned if the bucket has been configured with MFA delete. If the bucket has never been so configured, this element is not returned. | +| `Status` | `string` | The versioning state of the bucket. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `bucket_versionings_Get` | `SELECT` | `bucket, region` | <p>Returns the versioning state of a bucket.</p> <p>To retrieve the versioning state of a bucket, you must be the bucket owner.</p> <p>This implementation also returns the MFA Delete status of the versioning state. If the MFA Delete status is <code>enabled</code>, the bucket owner must use an authentication device to change the versioning state of the bucket.</p> <p>The following operations are related to <code>GetBucketVersioning</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html">DeleteObject</a> </p> </li> </ul> | +| `bucket_versionings_Put` | `EXEC` | `bucket, region` | <p>Sets the versioning state of an existing bucket.</p> <p>You can set the versioning state with one of the following values:</p> <p> <b>Enabled</b>—Enables versioning for the objects in the bucket. All objects added to the bucket receive a unique version ID.</p> <p> <b>Suspended</b>—Disables versioning for the objects in the bucket. All objects added to the bucket receive the version ID null.</p> <p>If the versioning state has never been set on a bucket, it has no versioning state; a <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html">GetBucketVersioning</a> request does not return a versioning state value.</p> <p>In order to enable MFA Delete, you must be the bucket owner. If you are the bucket owner and want to enable MFA Delete in the bucket versioning configuration, you must include the <code>x-amz-mfa request</code> header and the <code>Status</code> and the <code>MfaDelete</code> request elements in a request to set the versioning state of the bucket.</p> <important> <p>If you have an object expiration lifecycle policy in your non-versioned bucket and you want to maintain the same permanent delete behavior when you enable versioning, you must add a noncurrent expiration policy. The noncurrent expiration lifecycle policy will manage the deletes of the noncurrent object versions in the version-enabled bucket. (A version-enabled bucket maintains one current and zero or more noncurrent object versions.) For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html#lifecycle-and-other-bucket-config">Lifecycle and Versioning</a>.</p> </important> <p class="title"> <b>Related Resources</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html">DeleteBucket</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html">GetBucketVersioning</a> </p> </li> </ul> | diff --git a/docs/aws-docs/providers/aws/s3_api/bucket_websites/index.md b/docs/aws-docs/providers/aws/s3_api/bucket_websites/index.md new file mode 100644 index 0000000000..4f3372783d --- /dev/null +++ b/docs/aws-docs/providers/aws/s3_api/bucket_websites/index.md @@ -0,0 +1,39 @@ +--- +title: bucket_websites +hide_title: false +hide_table_of_contents: false +keywords: + - bucket_websites + - s3_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namebucket_websites
TypeResource
Idaws.s3_api.bucket_websites
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `ErrorDocument` | `object` | The error information. | +| `IndexDocument` | `object` | Container for the <code>Suffix</code> element. | +| `RedirectAllRequestsTo` | `object` | Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket. | +| `RoutingRules` | `array` | Rules that define when a redirect is applied and the redirect behavior. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `bucket_websites_Get` | `SELECT` | `bucket, region` | <p>Returns the website configuration for a bucket. To host website on Amazon S3, you can configure a bucket as website by adding a website configuration. For more information about hosting websites, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html">Hosting Websites on Amazon S3</a>. </p> <p>This GET action requires the <code>S3:GetBucketWebsite</code> permission. By default, only the bucket owner can read the bucket website configuration. However, bucket owners can allow other users to read the website configuration by writing a bucket policy granting them the <code>S3:GetBucketWebsite</code> permission.</p> <p>The following operations are related to <code>DeleteBucketWebsite</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketWebsite.html">DeleteBucketWebsite</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketWebsite.html">PutBucketWebsite</a> </p> </li> </ul> | +| `bucket_websites_Delete` | `DELETE` | `bucket, region` | <p>This action removes the website configuration for a bucket. Amazon S3 returns a <code>200 OK</code> response upon successfully deleting a website configuration on the specified bucket. You will get a <code>200 OK</code> response if the website configuration you are trying to delete does not exist on the bucket. Amazon S3 returns a <code>404</code> response if the bucket specified in the request does not exist.</p> <p>This DELETE action requires the <code>S3:DeleteBucketWebsite</code> permission. By default, only the bucket owner can delete the website configuration attached to a bucket. However, bucket owners can grant other users permission to delete the website configuration by writing a bucket policy granting them the <code>S3:DeleteBucketWebsite</code> permission. </p> <p>For more information about hosting websites, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html">Hosting Websites on Amazon S3</a>. </p> <p>The following operations are related to <code>DeleteBucketWebsite</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketWebsite.html">GetBucketWebsite</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketWebsite.html">PutBucketWebsite</a> </p> </li> </ul> | +| `bucket_websites_Put` | `EXEC` | `bucket, region` | <p>Sets the configuration of the website that is specified in the <code>website</code> subresource. To configure a bucket as a website, you can add this subresource on the bucket with website configuration information such as the file name of the index document and any redirect rules. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html">Hosting Websites on Amazon S3</a>.</p> <p>This PUT action requires the <code>S3:PutBucketWebsite</code> permission. By default, only the bucket owner can configure the website attached to a bucket; however, bucket owners can allow other users to set the website configuration by writing a bucket policy that grants them the <code>S3:PutBucketWebsite</code> permission.</p> <p>To redirect all website requests sent to the bucket's website endpoint, you add a website configuration with the following elements. Because all requests are sent to another website, you don't need to provide index document name for the bucket.</p> <ul> <li> <p> <code>WebsiteConfiguration</code> </p> </li> <li> <p> <code>RedirectAllRequestsTo</code> </p> </li> <li> <p> <code>HostName</code> </p> </li> <li> <p> <code>Protocol</code> </p> </li> </ul> <p>If you want granular control over redirects, you can use the following elements to add routing rules that describe conditions for redirecting requests and information about the redirect destination. In this case, the website configuration must provide an index document for the bucket, because some requests might not be redirected. </p> <ul> <li> <p> <code>WebsiteConfiguration</code> </p> </li> <li> <p> <code>IndexDocument</code> </p> </li> <li> <p> <code>Suffix</code> </p> </li> <li> <p> <code>ErrorDocument</code> </p> </li> <li> <p> <code>Key</code> </p> </li> <li> <p> <code>RoutingRules</code> </p> </li> <li> <p> <code>RoutingRule</code> </p> </li> <li> <p> <code>Condition</code> </p> </li> <li> <p> <code>HttpErrorCodeReturnedEquals</code> </p> </li> <li> <p> <code>KeyPrefixEquals</code> </p> </li> <li> <p> <code>Redirect</code> </p> </li> <li> <p> <code>Protocol</code> </p> </li> <li> <p> <code>HostName</code> </p> </li> <li> <p> <code>ReplaceKeyPrefixWith</code> </p> </li> <li> <p> <code>ReplaceKeyWith</code> </p> </li> <li> <p> <code>HttpRedirectCode</code> </p> </li> </ul> <p>Amazon S3 has a limitation of 50 routing rules per website configuration. If you require more than 50 routing rules, you can use object redirect. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html">Configuring an Object Redirect</a> in the <i>Amazon S3 User Guide</i>.</p> | diff --git a/docs/aws-docs/providers/aws/s3_api/buckets/index.md b/docs/aws-docs/providers/aws/s3_api/buckets/index.md new file mode 100644 index 0000000000..0b8b0520e6 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3_api/buckets/index.md @@ -0,0 +1,37 @@ +--- +title: buckets +hide_title: false +hide_table_of_contents: false +keywords: + - buckets + - s3_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namebuckets
TypeResource
Idaws.s3_api.buckets
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `CreationDate` | `string` | Date the bucket was created. This date can change when making changes to your bucket, such as editing its bucket policy. | +| `Name` | `string` | The name of the bucket. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `buckets_List` | `SELECT` | `bucket, region` | Returns a list of all buckets owned by the authenticated sender of the request. To use this operation, you must have the <code>s3:ListAllMyBuckets</code> permission. | +| `buckets_Create` | `INSERT` | `bucket, region` | <p>Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and have a valid Amazon Web Services Access Key ID to authenticate requests. Anonymous requests are never allowed to create buckets. By creating the bucket, you become the bucket owner.</p> <p>Not every string is an acceptable bucket name. For information about bucket naming restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html">Bucket naming rules</a>.</p> <p>If you want to create an Amazon S3 on Outposts bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html">Create Bucket</a>. </p> <p>By default, the bucket is created in the US East (N. Virginia) Region. You can optionally specify a Region in the request body. You might choose a Region to optimize latency, minimize costs, or address regulatory requirements. For example, if you reside in Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) Region. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro">Accessing a bucket</a>.</p> <note> <p>If you send your create bucket request to the <code>s3.amazonaws.com</code> endpoint, the request goes to the us-east-1 Region. Accordingly, the signature calculations in Signature Version 4 must use us-east-1 as the Region, even if the location constraint in the request specifies another Region where the bucket is to be created. If you create a bucket in a Region other than US East (N. Virginia), your application must be able to handle 307 redirect. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html">Virtual hosting of buckets</a>.</p> </note> <p> <b>Access control lists (ACLs)</b> </p> <p>When creating a bucket using this operation, you can optionally configure the bucket ACL to specify the accounts or groups that should be granted specific permissions on the bucket.</p> <important> <p>If your CreateBucket request sets bucket owner enforced for S3 Object Ownership and specifies a bucket ACL that provides access to an external Amazon Web Services account, your request fails with a <code>400</code> error and returns the <code>InvalidBucketAclWithObjectOwnership</code> error code. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">Controlling object ownership</a> in the <i>Amazon S3 User Guide</i>.</p> </important> <p>There are two ways to grant the appropriate permissions using the request headers.</p> <ul> <li> <p>Specify a canned ACL using the <code>x-amz-acl</code> request header. Amazon S3 supports a set of predefined ACLs, known as <i>canned ACLs</i>. Each canned ACL has a predefined set of grantees and permissions. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL">Canned ACL</a>.</p> </li> <li> <p>Specify access permissions explicitly using the <code>x-amz-grant-read</code>, <code>x-amz-grant-write</code>, <code>x-amz-grant-read-acp</code>, <code>x-amz-grant-write-acp</code>, and <code>x-amz-grant-full-control</code> headers. These headers map to the set of permissions Amazon S3 supports in an ACL. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html">Access control list (ACL) overview</a>.</p> <p>You specify each grantee as a type=value pair, where the type is one of the following:</p> <ul> <li> <p> <code>id</code> – if the value specified is the canonical user ID of an Amazon Web Services account</p> </li> <li> <p> <code>uri</code> – if you are granting permissions to a predefined group</p> </li> <li> <p> <code>emailAddress</code> – if the value specified is the email address of an Amazon Web Services account</p> <note> <p>Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions: </p> <ul> <li> <p>US East (N. Virginia)</p> </li> <li> <p>US West (N. California)</p> </li> <li> <p> US West (Oregon)</p> </li> <li> <p> Asia Pacific (Singapore)</p> </li> <li> <p>Asia Pacific (Sydney)</p> </li> <li> <p>Asia Pacific (Tokyo)</p> </li> <li> <p>Europe (Ireland)</p> </li> <li> <p>South America (São Paulo)</p> </li> </ul> <p>For a list of all the Amazon S3 supported Regions and endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region">Regions and Endpoints</a> in the Amazon Web Services General Reference.</p> </note> </li> </ul> <p>For example, the following <code>x-amz-grant-read</code> header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:</p> <p> <code>x-amz-grant-read: id="11112222333", id="444455556666" </code> </p> </li> </ul> <note> <p>You can use either a canned ACL or specify access permissions explicitly. You cannot do both.</p> </note> <p> <b>Permissions</b> </p> <p>In addition to <code>s3:CreateBucket</code>, the following permissions are required when your CreateBucket includes specific headers:</p> <ul> <li> <p> <b>ACLs</b> - If your <code>CreateBucket</code> request specifies ACL permissions and the ACL is public-read, public-read-write, authenticated-read, or if you specify access permissions explicitly through any other ACL, both <code>s3:CreateBucket</code> and <code>s3:PutBucketAcl</code> permissions are needed. If the ACL the <code>CreateBucket</code> request is private or doesn't specify any ACLs, only <code>s3:CreateBucket</code> permission is needed. </p> </li> <li> <p> <b>Object Lock</b> - If <code>ObjectLockEnabledForBucket</code> is set to true in your <code>CreateBucket</code> request, <code>s3:PutBucketObjectLockConfiguration</code> and <code>s3:PutBucketVersioning</code> permissions are required.</p> </li> <li> <p> <b>S3 Object Ownership</b> - If your CreateBucket request includes the the <code>x-amz-object-ownership</code> header, <code>s3:PutBucketOwnershipControls</code> permission is required.</p> </li> </ul> <p>The following operations are related to <code>CreateBucket</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html">DeleteBucket</a> </p> </li> </ul> | +| `buckets_Delete` | `DELETE` | `bucket, region` | <p>Deletes the S3 bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted.</p> <p class="title"> <b>Related Resources</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html">DeleteObject</a> </p> </li> </ul> | diff --git a/docs/aws-docs/providers/aws/s3_api/get_object_responses/index.md b/docs/aws-docs/providers/aws/s3_api/get_object_responses/index.md new file mode 100644 index 0000000000..23161ad5d2 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3_api/get_object_responses/index.md @@ -0,0 +1,32 @@ +--- +title: get_object_responses +hide_title: false +hide_table_of_contents: false +keywords: + - get_object_responses + - s3_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameget_object_responses
TypeResource
Idaws.s3_api.get_object_responses
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `get_object_responses_Write` | `EXEC` | `x-amz-request-route, x-amz-request-token, bucket, region` | diff --git a/docs/aws-docs/providers/aws/s3_api/index.md b/docs/aws-docs/providers/aws/s3_api/index.md new file mode 100644 index 0000000000..a8198247c7 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3_api/index.md @@ -0,0 +1,84 @@ +--- +title: s3_api +hide_title: false +hide_table_of_contents: false +keywords: + - s3_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +s3_api + +:::info Service Summary + +
+
+total resources: 39
+total selectable resources: 32
+total methods: 93
+
+
+ +::: + +## Overview + + + + + + +
Nameaws.s3_api
TypeService
Titles3_api
Descriptions3_api
Ids3_api:v00.00.00000
+ +## Resources +
+
+bucket_accelerate_configurations
+bucket_acls
+bucket_analytics_configurations
+bucket_cors
+bucket_encryptions
+bucket_intelligent_tiering_configurations
+bucket_inventory_configurations
+bucket_lifecycle_configurations
+bucket_lifecycles
+bucket_locations
+bucket_loggings
+bucket_metrics_configurations
+bucket_notification_configurations
+bucket_notifications
+bucket_ownership_controls
+bucket_policies
+bucket_policy_status
+bucket_replications
+bucket_request_payments
+bucket_taggings
+
+
+bucket_versionings
+bucket_websites
+buckets
+get_object_responses
+multipart_uploads
+object_acls
+object_attributes
+object_contents
+object_legal_holds
+object_lock_configurations
+object_retentions
+object_taggings
+object_torrents
+object_versions
+objects
+objects_v2s
+part_copies
+parts
+public_access_blocks
+
+
diff --git a/docs/aws-docs/providers/aws/s3_api/multipart_uploads/index.md b/docs/aws-docs/providers/aws/s3_api/multipart_uploads/index.md new file mode 100644 index 0000000000..1e535244cb --- /dev/null +++ b/docs/aws-docs/providers/aws/s3_api/multipart_uploads/index.md @@ -0,0 +1,34 @@ +--- +title: multipart_uploads +hide_title: false +hide_table_of_contents: false +keywords: + - multipart_uploads + - s3_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namemultipart_uploads
TypeResource
Idaws.s3_api.multipart_uploads
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `multipart_uploads_Create` | `INSERT` | `Key, bucket, region` | <p>This action initiates a multipart upload and returns an upload ID. This upload ID is used to associate all of the parts in the specific multipart upload. You specify this upload ID in each of your subsequent upload part requests (see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a>). You also include this upload ID in the final request to either complete or abort the multipart upload request.</p> <p>For more information about multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html">Multipart Upload Overview</a>.</p> <p>If you have configured a lifecycle rule to abort incomplete multipart uploads, the upload must complete within the number of days specified in the bucket lifecycle configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort action and Amazon S3 aborts the multipart upload. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config">Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy</a>.</p> <p>For information about the permissions required to use the multipart upload API, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart Upload and Permissions</a>.</p> <p>For request signing, multipart upload is just a series of regular requests. You initiate a multipart upload, send one or more requests to upload parts, and then complete the multipart upload process. You sign each request individually. There is nothing special about signing multipart upload requests. For more information about signing, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html">Authenticating Requests (Amazon Web Services Signature Version 4)</a>.</p> <note> <p> After you initiate a multipart upload and upload one or more parts, to stop being charged for storing the uploaded parts, you must either complete or abort the multipart upload. Amazon S3 frees up the space used to store the parts and stop charging you for storing them only after you either complete or abort a multipart upload. </p> </note> <p>You can optionally request server-side encryption. For server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. You can provide your own encryption key, or use Amazon Web Services KMS keys or Amazon S3-managed encryption keys. If you choose to provide your own encryption key, the request headers you provide in <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html">UploadPartCopy</a> requests must match the headers you used in the request to initiate the upload by using <code>CreateMultipartUpload</code>. </p> <p>To perform a multipart upload with encryption using an Amazon Web Services KMS key, the requester must have permission to the <code>kms:Decrypt</code> and <code>kms:GenerateDataKey*</code> actions on the key. These permissions are required because Amazon S3 must decrypt and read data from the encrypted file parts before it completes the multipart upload. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html#mpuAndPermissions">Multipart upload API and permissions</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If your Identity and Access Management (IAM) user or role is in the same Amazon Web Services account as the KMS key, then you must have these permissions on the key policy. If your IAM user or role belongs to a different account than the key, then you must have the permissions on both the key policy and your IAM user or role.</p> <p> For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html">Protecting Data Using Server-Side Encryption</a>.</p> <dl> <dt>Access Permissions</dt> <dd> <p>When copying an object, you can optionally specify the accounts or groups that should be granted specific permissions on the new object. There are two ways to grant the permissions using the request headers:</p> <ul> <li> <p>Specify a canned ACL with the <code>x-amz-acl</code> request header. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL">Canned ACL</a>.</p> </li> <li> <p>Specify access permissions explicitly with the <code>x-amz-grant-read</code>, <code>x-amz-grant-read-acp</code>, <code>x-amz-grant-write-acp</code>, and <code>x-amz-grant-full-control</code> headers. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access Control List (ACL) Overview</a>.</p> </li> </ul> <p>You can use either a canned ACL or specify access permissions explicitly. You cannot do both.</p> </dd> <dt>Server-Side- Encryption-Specific Request Headers</dt> <dd> <p>You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. The option you use depends on whether you want to use Amazon Web Services managed encryption keys or provide your own encryption key. </p> <ul> <li> <p>Use encryption keys managed by Amazon S3 or customer managed key stored in Amazon Web Services Key Management Service (Amazon Web Services KMS) – If you want Amazon Web Services to manage the keys used to encrypt data, specify the following headers in the request.</p> <ul> <li> <p> <code>x-amz-server-side-encryption</code> </p> </li> <li> <p> <code>x-amz-server-side-encryption-aws-kms-key-id</code> </p> </li> <li> <p> <code>x-amz-server-side-encryption-context</code> </p> </li> </ul> <note> <p>If you specify <code>x-amz-server-side-encryption:aws:kms</code>, but don't provide <code>x-amz-server-side-encryption-aws-kms-key-id</code>, Amazon S3 uses the Amazon Web Services managed key in Amazon Web Services KMS to protect the data.</p> </note> <important> <p>All GET and PUT requests for an object protected by Amazon Web Services KMS fail if you don't make them with SSL or by using SigV4.</p> </important> <p>For more information about server-side encryption with KMS key (SSE-KMS), see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html">Protecting Data Using Server-Side Encryption with KMS keys</a>.</p> </li> <li> <p>Use customer-provided encryption keys – If you want to manage your own encryption keys, provide all the following headers in the request.</p> <ul> <li> <p> <code>x-amz-server-side-encryption-customer-algorithm</code> </p> </li> <li> <p> <code>x-amz-server-side-encryption-customer-key</code> </p> </li> <li> <p> <code>x-amz-server-side-encryption-customer-key-MD5</code> </p> </li> </ul> <p>For more information about server-side encryption with KMS keys (SSE-KMS), see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html">Protecting Data Using Server-Side Encryption with KMS keys</a>.</p> </li> </ul> </dd> <dt>Access-Control-List (ACL)-Specific Request Headers</dt> <dd> <p>You also can use the following access control–related headers with this operation. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the access control list (ACL) on the object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html">Using ACLs</a>. With this operation, you can grant access permissions using one of the following two methods:</p> <ul> <li> <p>Specify a canned ACL (<code>x-amz-acl</code>) — Amazon S3 supports a set of predefined ACLs, known as <i>canned ACLs</i>. Each canned ACL has a predefined set of grantees and permissions. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL">Canned ACL</a>.</p> </li> <li> <p>Specify access permissions explicitly — To explicitly grant access permissions to specific Amazon Web Services accounts or groups, use the following headers. Each header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access Control List (ACL) Overview</a>. In the header, you specify a list of grantees who get the specific permission. To grant permissions explicitly, use:</p> <ul> <li> <p> <code>x-amz-grant-read</code> </p> </li> <li> <p> <code>x-amz-grant-write</code> </p> </li> <li> <p> <code>x-amz-grant-read-acp</code> </p> </li> <li> <p> <code>x-amz-grant-write-acp</code> </p> </li> <li> <p> <code>x-amz-grant-full-control</code> </p> </li> </ul> <p>You specify each grantee as a type=value pair, where the type is one of the following:</p> <ul> <li> <p> <code>id</code> – if the value specified is the canonical user ID of an Amazon Web Services account</p> </li> <li> <p> <code>uri</code> – if you are granting permissions to a predefined group</p> </li> <li> <p> <code>emailAddress</code> – if the value specified is the email address of an Amazon Web Services account</p> <note> <p>Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions: </p> <ul> <li> <p>US East (N. Virginia)</p> </li> <li> <p>US West (N. California)</p> </li> <li> <p> US West (Oregon)</p> </li> <li> <p> Asia Pacific (Singapore)</p> </li> <li> <p>Asia Pacific (Sydney)</p> </li> <li> <p>Asia Pacific (Tokyo)</p> </li> <li> <p>Europe (Ireland)</p> </li> <li> <p>South America (São Paulo)</p> </li> </ul> <p>For a list of all the Amazon S3 supported Regions and endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region">Regions and Endpoints</a> in the Amazon Web Services General Reference.</p> </note> </li> </ul> <p>For example, the following <code>x-amz-grant-read</code> header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:</p> <p> <code>x-amz-grant-read: id="11112222333", id="444455556666" </code> </p> </li> </ul> </dd> </dl> <p>The following operations are related to <code>CreateMultipartUpload</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html">CompleteMultipartUpload</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html">AbortMultipartUpload</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html">ListParts</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html">ListMultipartUploads</a> </p> </li> </ul> | +| `multipart_uploads_Complete` | `EXEC` | `Key, uploadId, bucket, region` | <p>Completes a multipart upload by assembling previously uploaded parts.</p> <p>You first initiate the multipart upload and then upload all parts using the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a> operation. After successfully uploading all relevant parts of an upload, you call this action to complete the upload. Upon receiving this request, Amazon S3 concatenates all the parts in ascending order by part number to create a new object. In the Complete Multipart Upload request, you must provide the parts list. You must ensure that the parts list is complete. This action concatenates the parts that you provide in the list. For each part in the list, you must provide the part number and the <code>ETag</code> value, returned after that part was uploaded.</p> <p>Processing of a Complete Multipart Upload request could take several minutes to complete. After Amazon S3 begins processing the request, it sends an HTTP response header that specifies a 200 OK response. While processing is in progress, Amazon S3 periodically sends white space characters to keep the connection from timing out. Because a request could fail after the initial 200 OK response has been sent, it is important that you check the response body to determine whether the request succeeded.</p> <p>Note that if <code>CompleteMultipartUpload</code> fails, applications should be prepared to retry the failed requests. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ErrorBestPractices.html">Amazon S3 Error Best Practices</a>.</p> <important> <p>You cannot use <code>Content-Type: application/x-www-form-urlencoded</code> with Complete Multipart Upload requests. Also, if you do not provide a <code>Content-Type</code> header, <code>CompleteMultipartUpload</code> returns a 200 OK response.</p> </important> <p>For more information about multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html">Uploading Objects Using Multipart Upload</a>.</p> <p>For information about permissions required to use the multipart upload API, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart Upload and Permissions</a>.</p> <p> <code>CompleteMultipartUpload</code> has the following special errors:</p> <ul> <li> <p>Error code: <code>EntityTooSmall</code> </p> <ul> <li> <p>Description: Your proposed upload is smaller than the minimum allowed object size. Each part must be at least 5 MB in size, except the last part.</p> </li> <li> <p>400 Bad Request</p> </li> </ul> </li> <li> <p>Error code: <code>InvalidPart</code> </p> <ul> <li> <p>Description: One or more of the specified parts could not be found. The part might not have been uploaded, or the specified entity tag might not have matched the part's entity tag.</p> </li> <li> <p>400 Bad Request</p> </li> </ul> </li> <li> <p>Error code: <code>InvalidPartOrder</code> </p> <ul> <li> <p>Description: The list of parts was not in ascending order. The parts list must be specified in order by part number.</p> </li> <li> <p>400 Bad Request</p> </li> </ul> </li> <li> <p>Error code: <code>NoSuchUpload</code> </p> <ul> <li> <p>Description: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.</p> </li> <li> <p>404 Not Found</p> </li> </ul> </li> </ul> <p>The following operations are related to <code>CompleteMultipartUpload</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html">AbortMultipartUpload</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html">ListParts</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html">ListMultipartUploads</a> </p> </li> </ul> | +| `multipart_uploads_List` | `EXEC` | `bucket, region` | <p>This action lists in-progress multipart uploads. An in-progress multipart upload is a multipart upload that has been initiated using the Initiate Multipart Upload request, but has not yet been completed or aborted.</p> <p>This action returns at most 1,000 multipart uploads in the response. 1,000 multipart uploads is the maximum number of uploads a response can include, which is also the default value. You can further limit the number of uploads in a response by specifying the <code>max-uploads</code> parameter in the response. If additional multipart uploads satisfy the list criteria, the response will contain an <code>IsTruncated</code> element with the value true. To list the additional multipart uploads, use the <code>key-marker</code> and <code>upload-id-marker</code> request parameters.</p> <p>In the response, the uploads are sorted by key. If your application has initiated more than one multipart upload using the same object key, then uploads in the response are first sorted by key. Additionally, uploads are sorted in ascending order within each key by the upload initiation time.</p> <p>For more information on multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html">Uploading Objects Using Multipart Upload</a>.</p> <p>For information on permissions required to use the multipart upload API, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart Upload and Permissions</a>.</p> <p>The following operations are related to <code>ListMultipartUploads</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html">CompleteMultipartUpload</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html">ListParts</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html">AbortMultipartUpload</a> </p> </li> </ul> | diff --git a/docs/aws-docs/providers/aws/s3_api/object_acls/index.md b/docs/aws-docs/providers/aws/s3_api/object_acls/index.md new file mode 100644 index 0000000000..9555dc1aa7 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3_api/object_acls/index.md @@ -0,0 +1,36 @@ +--- +title: object_acls +hide_title: false +hide_table_of_contents: false +keywords: + - object_acls + - s3_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameobject_acls
TypeResource
Idaws.s3_api.object_acls
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `AccessControlList` | `array` | A list of grants. | +| `Owner` | `object` | Container for the owner's display name and ID. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `object_acls_Get` | `SELECT` | `Key, bucket, region` | <p>Returns the access control list (ACL) of an object. To use this operation, you must have <code>s3:GetObjectAcl</code> permissions or <code>READ_ACP</code> access to the object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#acl-access-policy-permission-mapping">Mapping of ACL permissions and access policy permissions</a> in the <i>Amazon S3 User Guide</i> </p> <p>This action is not supported by Amazon S3 on Outposts.</p> <p> <b>Versioning</b> </p> <p>By default, GET returns ACL information about the current version of an object. To return ACL information about a different version, use the versionId subresource.</p> <note> <p>If your bucket uses the bucket owner enforced setting for S3 Object Ownership, requests to read ACLs are still supported and return the <code>bucket-owner-full-control</code> ACL with the owner being the account that created the bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html"> Controlling object ownership and disabling ACLs</a> in the <i>Amazon S3 User Guide</i>.</p> </note> <p>The following operations are related to <code>GetObjectAcl</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html">GetObjectAttributes</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html">DeleteObject</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a> </p> </li> </ul> | +| `object_acls_Put` | `EXEC` | `Key, bucket, region` | <p>Uses the <code>acl</code> subresource to set the access control list (ACL) permissions for a new or existing object in an S3 bucket. You must have <code>WRITE_ACP</code> permission to set the ACL of an object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#permissions">What permissions can I grant?</a> in the <i>Amazon S3 User Guide</i>.</p> <p>This action is not supported by Amazon S3 on Outposts.</p> <p>Depending on your application needs, you can choose to set the ACL on an object using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, you can continue to use that approach. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access Control List (ACL) Overview</a> in the <i>Amazon S3 User Guide</i>.</p> <important> <p>If your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. You must use policies to grant access to your bucket and the objects in it. Requests to set ACLs or update ACLs fail and return the <code>AccessControlListNotSupported</code> error code. Requests to read ACLs are still supported. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">Controlling object ownership</a> in the <i>Amazon S3 User Guide</i>.</p> </important> <p> <b>Access Permissions</b> </p> <p>You can set access permissions using one of the following methods:</p> <ul> <li> <p>Specify a canned ACL with the <code>x-amz-acl</code> request header. Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. Specify the canned ACL name as the value of <code>x-amz-ac</code>l. If you use this header, you cannot use other access control-specific headers in your request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL">Canned ACL</a>.</p> </li> <li> <p>Specify access permissions explicitly with the <code>x-amz-grant-read</code>, <code>x-amz-grant-read-acp</code>, <code>x-amz-grant-write-acp</code>, and <code>x-amz-grant-full-control</code> headers. When using these headers, you specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who will receive the permission. If you use these ACL-specific headers, you cannot use <code>x-amz-acl</code> header to set a canned ACL. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access Control List (ACL) Overview</a>.</p> <p>You specify each grantee as a type=value pair, where the type is one of the following:</p> <ul> <li> <p> <code>id</code> – if the value specified is the canonical user ID of an Amazon Web Services account</p> </li> <li> <p> <code>uri</code> – if you are granting permissions to a predefined group</p> </li> <li> <p> <code>emailAddress</code> – if the value specified is the email address of an Amazon Web Services account</p> <note> <p>Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions: </p> <ul> <li> <p>US East (N. Virginia)</p> </li> <li> <p>US West (N. California)</p> </li> <li> <p> US West (Oregon)</p> </li> <li> <p> Asia Pacific (Singapore)</p> </li> <li> <p>Asia Pacific (Sydney)</p> </li> <li> <p>Asia Pacific (Tokyo)</p> </li> <li> <p>Europe (Ireland)</p> </li> <li> <p>South America (São Paulo)</p> </li> </ul> <p>For a list of all the Amazon S3 supported Regions and endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region">Regions and Endpoints</a> in the Amazon Web Services General Reference.</p> </note> </li> </ul> <p>For example, the following <code>x-amz-grant-read</code> header grants list objects permission to the two Amazon Web Services accounts identified by their email addresses.</p> <p> <code>x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" </code> </p> </li> </ul> <p>You can use either a canned ACL or specify access permissions explicitly. You cannot do both.</p> <p> <b>Grantee Values</b> </p> <p>You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:</p> <ul> <li> <p>By the person's ID:</p> <p> <code><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee></code> </p> <p>DisplayName is optional and ignored in the request.</p> </li> <li> <p>By URI:</p> <p> <code><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee></code> </p> </li> <li> <p>By Email address:</p> <p> <code><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress>lt;/Grantee></code> </p> <p>The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.</p> <note> <p>Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions: </p> <ul> <li> <p>US East (N. Virginia)</p> </li> <li> <p>US West (N. California)</p> </li> <li> <p> US West (Oregon)</p> </li> <li> <p> Asia Pacific (Singapore)</p> </li> <li> <p>Asia Pacific (Sydney)</p> </li> <li> <p>Asia Pacific (Tokyo)</p> </li> <li> <p>Europe (Ireland)</p> </li> <li> <p>South America (São Paulo)</p> </li> </ul> <p>For a list of all the Amazon S3 supported Regions and endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region">Regions and Endpoints</a> in the Amazon Web Services General Reference.</p> </note> </li> </ul> <p> <b>Versioning</b> </p> <p>The ACL of an object is set at the object version level. By default, PUT sets the ACL of the current version of an object. To set the ACL of a different version, use the <code>versionId</code> subresource.</p> <p class="title"> <b>Related Resources</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html">CopyObject</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a> </p> </li> </ul> | diff --git a/docs/aws-docs/providers/aws/s3_api/object_attributes/index.md b/docs/aws-docs/providers/aws/s3_api/object_attributes/index.md new file mode 100644 index 0000000000..817ee4a038 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3_api/object_attributes/index.md @@ -0,0 +1,38 @@ +--- +title: object_attributes +hide_title: false +hide_table_of_contents: false +keywords: + - object_attributes + - s3_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameobject_attributes
TypeResource
Idaws.s3_api.object_attributes
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `Checksum` | `object` | Contains all the possible checksum or digest values for an object. | +| `ETag` | `string` | An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL. | +| `ObjectParts` | `object` | A collection of parts associated with a multipart upload. | +| `ObjectSize` | `integer` | The size of the object in bytes. | +| `StorageClass` | `string` | <p>Provides the storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage Classes</a>.</p> | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `object_attributes_Get` | `SELECT` | `Key, x-amz-object-attributes, bucket, region` | diff --git a/docs/aws-docs/providers/aws/s3_api/object_contents/index.md b/docs/aws-docs/providers/aws/s3_api/object_contents/index.md new file mode 100644 index 0000000000..0af66210b8 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3_api/object_contents/index.md @@ -0,0 +1,32 @@ +--- +title: object_contents +hide_title: false +hide_table_of_contents: false +keywords: + - object_contents + - s3_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameobject_contents
TypeResource
Idaws.s3_api.object_contents
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `object_contents_Select` | `EXEC` | `Key, select-type, bucket, region` | diff --git a/docs/aws-docs/providers/aws/s3_api/object_legal_holds/index.md b/docs/aws-docs/providers/aws/s3_api/object_legal_holds/index.md new file mode 100644 index 0000000000..095c6b8e92 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3_api/object_legal_holds/index.md @@ -0,0 +1,32 @@ +--- +title: object_legal_holds +hide_title: false +hide_table_of_contents: false +keywords: + - object_legal_holds + - s3_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameobject_legal_holds
TypeResource
Idaws.s3_api.object_legal_holds
+ +## Fields +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `object_legal_holds_Get` | `SELECT` | `Key, bucket, region` | <p>Gets an object's current legal hold status. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Locking Objects</a>.</p> <p>This action is not supported by Amazon S3 on Outposts.</p> <p>The following action is related to <code>GetObjectLegalHold</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html">GetObjectAttributes</a> </p> </li> </ul> | +| `object_legal_holds_Put` | `EXEC` | `Key, bucket, region` | <p>Applies a legal hold configuration to the specified object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Locking Objects</a>.</p> <p>This action is not supported by Amazon S3 on Outposts.</p> | diff --git a/docs/aws-docs/providers/aws/s3_api/object_lock_configurations/index.md b/docs/aws-docs/providers/aws/s3_api/object_lock_configurations/index.md new file mode 100644 index 0000000000..60eae03f99 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3_api/object_lock_configurations/index.md @@ -0,0 +1,32 @@ +--- +title: object_lock_configurations +hide_title: false +hide_table_of_contents: false +keywords: + - object_lock_configurations + - s3_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameobject_lock_configurations
TypeResource
Idaws.s3_api.object_lock_configurations
+ +## Fields +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `object_lock_configurations_Get` | `SELECT` | `bucket, region` | <p>Gets the Object Lock configuration for a 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Locking Objects</a>.</p> <p>The following action is related to <code>GetObjectLockConfiguration</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html">GetObjectAttributes</a> </p> </li> </ul> | +| `object_lock_configurations_Put` | `EXEC` | `bucket, region` | <p>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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Locking Objects</a>. </p> <note> <ul> <li> <p>The <code>DefaultRetention</code> settings require both a mode and a period.</p> </li> <li> <p>The <code>DefaultRetention</code> period can be either <code>Days</code> or <code>Years</code> but you must select one. You cannot specify <code>Days</code> and <code>Years</code> at the same time.</p> </li> <li> <p>You can only enable Object Lock for new buckets. If you want to turn on Object Lock for an existing bucket, contact Amazon Web Services Support.</p> </li> </ul> </note> | diff --git a/docs/aws-docs/providers/aws/s3_api/object_retentions/index.md b/docs/aws-docs/providers/aws/s3_api/object_retentions/index.md new file mode 100644 index 0000000000..34792d1cf2 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3_api/object_retentions/index.md @@ -0,0 +1,32 @@ +--- +title: object_retentions +hide_title: false +hide_table_of_contents: false +keywords: + - object_retentions + - s3_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameobject_retentions
TypeResource
Idaws.s3_api.object_retentions
+ +## Fields +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `object_retentions_Get` | `SELECT` | `Key, bucket, region` | <p>Retrieves an object's retention settings. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Locking Objects</a>.</p> <p>This action is not supported by Amazon S3 on Outposts.</p> <p>The following action is related to <code>GetObjectRetention</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html">GetObjectAttributes</a> </p> </li> </ul> | +| `object_retentions_Put` | `EXEC` | `Key, bucket, region` | <p>Places an Object Retention configuration on an object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Locking Objects</a>. Users or accounts require the <code>s3:PutObjectRetention</code> permission in order to place an Object Retention configuration on objects. Bypassing a Governance Retention configuration requires the <code>s3:BypassGovernanceRetention</code> permission. </p> <p>This action is not supported by Amazon S3 on Outposts.</p> | diff --git a/docs/aws-docs/providers/aws/s3_api/object_taggings/index.md b/docs/aws-docs/providers/aws/s3_api/object_taggings/index.md new file mode 100644 index 0000000000..6e90396c5c --- /dev/null +++ b/docs/aws-docs/providers/aws/s3_api/object_taggings/index.md @@ -0,0 +1,33 @@ +--- +title: object_taggings +hide_title: false +hide_table_of_contents: false +keywords: + - object_taggings + - s3_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameobject_taggings
TypeResource
Idaws.s3_api.object_taggings
+ +## Fields +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `object_taggings_Get` | `SELECT` | `Key, bucket, region` | <p>Returns the tag-set of an object. You send the GET request against the tagging subresource associated with the object.</p> <p>To use this operation, you must have permission to perform the <code>s3:GetObjectTagging</code> action. By default, the GET action returns information about current version of an object. For a versioned bucket, you can have multiple versions of an object in your bucket. To retrieve tags of any other version, use the versionId query parameter. You also need permission for the <code>s3:GetObjectVersionTagging</code> action.</p> <p> By default, the bucket owner has this permission and can grant this permission to others.</p> <p> For information about the Amazon S3 object tagging feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html">Object Tagging</a>.</p> <p>The following actions are related to <code>GetObjectTagging</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjectTagging.html">DeleteObjectTagging</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html">GetObjectAttributes</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObjectTagging.html">PutObjectTagging</a> </p> </li> </ul> | +| `object_taggings_Delete` | `DELETE` | `Key, bucket, region` | <p>Removes the entire tag set from the specified object. For more information about managing object tags, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html"> Object Tagging</a>.</p> <p>To use this operation, you must have permission to perform the <code>s3:DeleteObjectTagging</code> action.</p> <p>To delete tags of a specific object version, add the <code>versionId</code> query parameter in the request. You will need permission for the <code>s3:DeleteObjectVersionTagging</code> action.</p> <p>The following operations are related to <code>DeleteBucketMetricsConfiguration</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObjectTagging.html">PutObjectTagging</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html">GetObjectTagging</a> </p> </li> </ul> | +| `object_taggings_Put` | `EXEC` | `Key, bucket, region` | <p>Sets the supplied tag-set to an object that already exists in a bucket.</p> <p>A tag is a key-value pair. You can associate tags with an object by sending a PUT request against the tagging subresource that is associated with the object. You can retrieve tags by sending a GET request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html">GetObjectTagging</a>.</p> <p>For tagging-related restrictions related to characters and encodings, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html">Tag Restrictions</a>. Note that Amazon S3 limits the maximum number of tags to 10 tags per object.</p> <p>To use this operation, you must have permission to perform the <code>s3:PutObjectTagging</code> action. By default, the bucket owner has this permission and can grant this permission to others.</p> <p>To put tags of any other version, use the <code>versionId</code> query parameter. You also need permission for the <code>s3:PutObjectVersionTagging</code> action.</p> <p>For information about the Amazon S3 object tagging feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html">Object Tagging</a>.</p> <p class="title"> <b>Special Errors</b> </p> <ul> <li> <ul> <li> <p> <i>Code: InvalidTagError </i> </p> </li> <li> <p> <i>Cause: The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html">Object Tagging</a>.</i> </p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code: MalformedXMLError </i> </p> </li> <li> <p> <i>Cause: The XML provided does not match the schema.</i> </p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code: OperationAbortedError </i> </p> </li> <li> <p> <i>Cause: A conflicting conditional action is currently in progress against this resource. Please try again.</i> </p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code: InternalError</i> </p> </li> <li> <p> <i>Cause: The service was unable to apply the provided tag to the object.</i> </p> </li> </ul> </li> </ul> <p class="title"> <b>Related Resources</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html">GetObjectTagging</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjectTagging.html">DeleteObjectTagging</a> </p> </li> </ul> | diff --git a/docs/aws-docs/providers/aws/s3_api/object_torrents/index.md b/docs/aws-docs/providers/aws/s3_api/object_torrents/index.md new file mode 100644 index 0000000000..9d4d0a6ce6 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3_api/object_torrents/index.md @@ -0,0 +1,31 @@ +--- +title: object_torrents +hide_title: false +hide_table_of_contents: false +keywords: + - object_torrents + - s3_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameobject_torrents
TypeResource
Idaws.s3_api.object_torrents
+ +## Fields +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `object_torrents_Get` | `SELECT` | `Key, bucket, region` | diff --git a/docs/aws-docs/providers/aws/s3_api/object_versions/index.md b/docs/aws-docs/providers/aws/s3_api/object_versions/index.md new file mode 100644 index 0000000000..acd4761f25 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3_api/object_versions/index.md @@ -0,0 +1,32 @@ +--- +title: object_versions +hide_title: false +hide_table_of_contents: false +keywords: + - object_versions + - s3_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameobject_versions
TypeResource
Idaws.s3_api.object_versions
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `object_versions_List` | `EXEC` | `bucket, region` | diff --git a/docs/aws-docs/providers/aws/s3_api/objects/index.md b/docs/aws-docs/providers/aws/s3_api/objects/index.md new file mode 100644 index 0000000000..7732e0279f --- /dev/null +++ b/docs/aws-docs/providers/aws/s3_api/objects/index.md @@ -0,0 +1,45 @@ +--- +title: objects +hide_title: false +hide_table_of_contents: false +keywords: + - objects + - s3_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameobjects
TypeResource
Idaws.s3_api.objects
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `ChecksumAlgorithm` | `array` | The algorithm that was used to create a checksum of the object. | +| `ETag` | `string` | <p>The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata. The ETag may or may not be an MD5 digest of the object data. Whether or not it is depends on how the object was created and how it is encrypted as described below:</p> <ul> <li> <p>Objects created by the PUT Object, POST Object, or Copy operation, or through the Amazon Web Services Management Console, and are encrypted by SSE-S3 or plaintext, have ETags that are an MD5 digest of their object data.</p> </li> <li> <p>Objects created by the PUT Object, POST Object, or Copy operation, or through the Amazon Web Services Management Console, and are encrypted by SSE-C or SSE-KMS, have ETags that are not an MD5 digest of their object data.</p> </li> <li> <p>If an object is created by either the Multipart Upload or Part Copy operation, the ETag is not an MD5 digest, regardless of the method of encryption. If an object is larger than 16 MB, the Amazon Web Services Management Console will upload or copy that object as a Multipart Upload, and therefore the ETag will not be an MD5 digest.</p> </li> </ul> | +| `Key` | `string` | The name that you assign to an object. You use the object key to retrieve the object. | +| `LastModified` | `string` | Creation date of the object. | +| `Owner` | `object` | Container for the owner's display name and ID. | +| `Size` | `integer` | Size in bytes of the object | +| `StorageClass` | `string` | The class of storage used to store the object. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `objects_Get` | `SELECT` | `Key, bucket, region` | <p>Retrieves objects from Amazon S3. To use <code>GET</code>, you must have <code>READ</code> access to the object. If you grant <code>READ</code> access to the anonymous user, you can return the object without using an authorization header.</p> <p>An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer file system. You can, however, create a logical hierarchy by using object key names that imply a folder structure. For example, instead of naming an object <code>sample.jpg</code>, you can name it <code>photos/2006/February/sample.jpg</code>.</p> <p>To get an object from such a logical hierarchy, specify the full key name for the object in the <code>GET</code> operation. For a virtual hosted-style request example, if you have the object <code>photos/2006/February/sample.jpg</code>, specify the resource as <code>/photos/2006/February/sample.jpg</code>. For a path-style request example, if you have the object <code>photos/2006/February/sample.jpg</code> in the bucket named <code>examplebucket</code>, specify the resource as <code>/examplebucket/photos/2006/February/sample.jpg</code>. For more information about request types, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html#VirtualHostingSpecifyBucket">HTTP Host Header Bucket Specification</a>.</p> <p>For more information about returning the ACL of an object, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html">GetObjectAcl</a>.</p> <p>If the object you are retrieving is stored in the S3 Glacier or S3 Glacier Deep Archive storage class, or S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive tiers, before you can retrieve the object you must first restore a copy using <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html">RestoreObject</a>. Otherwise, this action returns an <code>InvalidObjectStateError</code> error. For information about restoring archived objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html">Restoring Archived Objects</a>.</p> <p>Encryption request headers, like <code>x-amz-server-side-encryption</code>, should not be sent for GET requests if your object uses server-side encryption with KMS keys (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error.</p> <p>If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers:</p> <ul> <li> <p>x-amz-server-side-encryption-customer-algorithm</p> </li> <li> <p>x-amz-server-side-encryption-customer-key</p> </li> <li> <p>x-amz-server-side-encryption-customer-key-MD5</p> </li> </ul> <p>For more information about SSE-C, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side Encryption (Using Customer-Provided Encryption Keys)</a>.</p> <p>Assuming you have the relevant permission to read object tags, the response also returns the <code>x-amz-tagging-count</code> header that provides the count of number of tags associated with the object. You can use <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html">GetObjectTagging</a> to retrieve the tag set associated with an object.</p> <p> <b>Permissions</b> </p> <p>You need the relevant read object (or version) permission for this operation. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in a Policy</a>. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the <code>s3:ListBucket</code> permission.</p> <ul> <li> <p>If you have the <code>s3:ListBucket</code> permission on the bucket, Amazon S3 will return an HTTP status code 404 ("no such key") error.</p> </li> <li> <p>If you don’t have the <code>s3:ListBucket</code> permission, Amazon S3 will return an HTTP status code 403 ("access denied") error.</p> </li> </ul> <p> <b>Versioning</b> </p> <p>By default, the GET action returns the current version of an object. To return a different version, use the <code>versionId</code> subresource.</p> <note> <ul> <li> <p> If you supply a <code>versionId</code>, you need the <code>s3:GetObjectVersion</code> permission to access a specific version of an object. If you request a specific version, you do not need to have the <code>s3:GetObject</code> permission. </p> </li> <li> <p>If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes <code>x-amz-delete-marker: true</code> in the response.</p> </li> </ul> </note> <p>For more information about versioning, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketVersioning.html">PutBucketVersioning</a>. </p> <p> <b>Overriding Response Header Values</b> </p> <p>There are times when you want to override certain response header values in a GET response. For example, you might override the <code>Content-Disposition</code> response header value in your GET request.</p> <p>You can override values for a set of response headers using the following query parameters. These response header values are sent only on a successful request, that is, when status code 200 OK is returned. The set of headers you can override using these parameters is a subset of the headers that Amazon S3 accepts when you create an object. The response headers that you can override for the GET response are <code>Content-Type</code>, <code>Content-Language</code>, <code>Expires</code>, <code>Cache-Control</code>, <code>Content-Disposition</code>, and <code>Content-Encoding</code>. To override these header values in the GET response, you use the following request parameters.</p> <note> <p>You must sign the request, either using an Authorization header or a presigned URL, when using these parameters. They cannot be used with an unsigned (anonymous) request.</p> </note> <ul> <li> <p> <code>response-content-type</code> </p> </li> <li> <p> <code>response-content-language</code> </p> </li> <li> <p> <code>response-expires</code> </p> </li> <li> <p> <code>response-cache-control</code> </p> </li> <li> <p> <code>response-content-disposition</code> </p> </li> <li> <p> <code>response-content-encoding</code> </p> </li> </ul> <p> <b>Additional Considerations about Request Headers</b> </p> <p>If both of the <code>If-Match</code> and <code>If-Unmodified-Since</code> headers are present in the request as follows: <code>If-Match</code> condition evaluates to <code>true</code>, and; <code>If-Unmodified-Since</code> condition evaluates to <code>false</code>; then, S3 returns 200 OK and the data requested. </p> <p>If both of the <code>If-None-Match</code> and <code>If-Modified-Since</code> headers are present in the request as follows:<code> If-None-Match</code> condition evaluates to <code>false</code>, and; <code>If-Modified-Since</code> condition evaluates to <code>true</code>; then, S3 returns 304 Not Modified response code.</p> <p>For more information about conditional requests, see <a href="https://tools.ietf.org/html/rfc7232">RFC 7232</a>.</p> <p>The following operations are related to <code>GetObject</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html">ListBuckets</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html">GetObjectAcl</a> </p> </li> </ul> | +| `objects_List` | `SELECT` | `bucket, region` | <p>Returns some or all (up to 1,000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK response can contain valid or invalid XML. Be sure to design your application to parse the contents of the response and handle it appropriately.</p> <important> <p>This action has been revised. We recommend that you use the newer version, <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html">ListObjectsV2</a>, when developing applications. For backward compatibility, Amazon S3 continues to support <code>ListObjects</code>.</p> </important> <p>The following operations are related to <code>ListObjects</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html">ListObjectsV2</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html">ListBuckets</a> </p> </li> </ul> | +| `objects_Delete` | `DELETE` | `bucket, region` | <p>This action enables you to delete multiple objects from a bucket using a single HTTP request. If you know the object keys that you want to delete, then this action provides a suitable alternative to sending individual delete requests, reducing per-request overhead.</p> <p>The request contains a list of up to 1000 keys that you want to delete. In the XML, you provide the object key names, and optionally, version IDs if you want to delete a specific version of the object from a versioning-enabled bucket. For each key, Amazon S3 performs a delete action and returns the result of that delete, success, or failure, in the response. Note that if the object specified in the request is not found, Amazon S3 returns the result as deleted.</p> <p> The action supports two modes for the response: verbose and quiet. By default, the action uses verbose mode in which the response includes the result of deletion of each key in your request. In quiet mode the response includes only keys where the delete action encountered an error. For a successful deletion, the action does not return any information about the delete in the response body.</p> <p>When performing this action on an MFA Delete enabled bucket, that attempts to delete any versioned objects, you must include an MFA token. If you do not provide one, the entire request will fail, even if there are non-versioned objects you are trying to delete. If you provide an invalid token, whether there are versioned keys in the request or not, the entire Multi-Object Delete request will fail. For information about MFA Delete, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html#MultiFactorAuthenticationDelete"> MFA Delete</a>.</p> <p>Finally, the Content-MD5 header is required for all Multi-Object Delete requests. Amazon S3 uses the header value to ensure that your request body has not been altered in transit.</p> <p>The following operations are related to <code>DeleteObjects</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html">CompleteMultipartUpload</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html">ListParts</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html">AbortMultipartUpload</a> </p> </li> </ul> | +| `objects_Copy` | `EXEC` | `Key, x-amz-copy-source, bucket, region` | <p>Creates a copy of an object that is already stored in Amazon S3.</p> <note> <p>You can store individual objects of up to 5 TB in Amazon S3. You create a copy of your object up to 5 GB in size in a single atomic action using this API. However, to copy an object greater than 5 GB, you must use the multipart upload Upload Part - Copy (UploadPartCopy) API. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjctsUsingRESTMPUapi.html">Copy Object Using the REST Multipart Upload API</a>.</p> </note> <p>All copy requests must be authenticated. Additionally, you must have <i>read</i> access to the source object and <i>write</i> access to the destination bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html">REST Authentication</a>. Both the Region that you want to copy the object from and the Region that you want to copy the object to must be enabled for your account.</p> <p>A copy request might return an error when Amazon S3 receives the copy request or while Amazon S3 is copying the files. If the error occurs before the copy action starts, you receive a standard Amazon S3 error. If the error occurs during the copy operation, the error response is embedded in the <code>200 OK</code> response. This means that a <code>200 OK</code> response can contain either a success or an error. Design your application to parse the contents of the response and handle it appropriately.</p> <p>If the copy is successful, you receive a response with information about the copied object.</p> <note> <p>If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, it would not contain the content-length, and you would need to read the entire body.</p> </note> <p>The copy request charge is based on the storage class and Region that you specify for the destination object. For pricing information, see <a href="http://aws.amazon.com/s3/pricing/">Amazon S3 pricing</a>.</p> <important> <p>Amazon S3 transfer acceleration does not support cross-Region copies. If you request a cross-Region copy using a transfer acceleration endpoint, you get a 400 <code>Bad Request</code> error. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html">Transfer Acceleration</a>.</p> </important> <p> <b>Metadata</b> </p> <p>When copying an object, you can preserve all metadata (default) or specify new metadata. However, the ACL is not preserved and is set to private for the user making the request. To override the default ACL setting, specify a new ACL when generating a copy request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html">Using ACLs</a>. </p> <p>To specify whether you want the object metadata copied from the source object or replaced with metadata provided in the request, you can optionally add the <code>x-amz-metadata-directive</code> header. When you grant permissions, you can use the <code>s3:x-amz-metadata-directive</code> condition key to enforce certain metadata behavior when objects are uploaded. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/amazon-s3-policy-keys.html">Specifying Conditions in a Policy</a> in the <i>Amazon S3 User Guide</i>. For a complete list of Amazon S3-specific condition keys, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/list_amazons3.html">Actions, Resources, and Condition Keys for Amazon S3</a>.</p> <p> <b>x-amz-copy-source-if Headers</b> </p> <p>To only copy an object under certain conditions, such as whether the <code>Etag</code> matches or whether the object was modified before or after a specified date, use the following request parameters:</p> <ul> <li> <p> <code>x-amz-copy-source-if-match</code> </p> </li> <li> <p> <code>x-amz-copy-source-if-none-match</code> </p> </li> <li> <p> <code>x-amz-copy-source-if-unmodified-since</code> </p> </li> <li> <p> <code>x-amz-copy-source-if-modified-since</code> </p> </li> </ul> <p> If both the <code>x-amz-copy-source-if-match</code> and <code>x-amz-copy-source-if-unmodified-since</code> headers are present in the request and evaluate as follows, Amazon S3 returns <code>200 OK</code> and copies the data:</p> <ul> <li> <p> <code>x-amz-copy-source-if-match</code> condition evaluates to true</p> </li> <li> <p> <code>x-amz-copy-source-if-unmodified-since</code> condition evaluates to false</p> </li> </ul> <p>If both the <code>x-amz-copy-source-if-none-match</code> and <code>x-amz-copy-source-if-modified-since</code> headers are present in the request and evaluate as follows, Amazon S3 returns the <code>412 Precondition Failed</code> response code:</p> <ul> <li> <p> <code>x-amz-copy-source-if-none-match</code> condition evaluates to false</p> </li> <li> <p> <code>x-amz-copy-source-if-modified-since</code> condition evaluates to true</p> </li> </ul> <note> <p>All headers with the <code>x-amz-</code> prefix, including <code>x-amz-copy-source</code>, must be signed.</p> </note> <p> <b>Server-side encryption</b> </p> <p>When you perform a CopyObject operation, you can optionally use the appropriate encryption-related headers to encrypt the object using server-side encryption with Amazon Web Services managed encryption keys (SSE-S3 or SSE-KMS) or a customer-provided encryption key. With server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts the data when you access it. For more information about server-side encryption, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html">Using Server-Side Encryption</a>.</p> <p>If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html">Amazon S3 Bucket Keys</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Access Control List (ACL)-Specific Request Headers</b> </p> <p>When copying an object, you can optionally use headers to grant ACL-based permissions. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access Control List (ACL) Overview</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html">Managing ACLs Using the REST API</a>. </p> <p>If the bucket that you're copying objects to uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept PUT requests that don't specify an ACL or PUT requests that specify bucket owner full control ACLs, such as the <code>bucket-owner-full-control</code> canned ACL or an equivalent form of this ACL expressed in the XML format.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html"> Controlling ownership of objects and disabling ACLs</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>If your bucket uses the bucket owner enforced setting for Object Ownership, all objects written to the bucket by any account will be owned by the bucket owner.</p> </note> <p> <b>Checksums</b> </p> <p>When copying an object, if it has a checksum, that checksum will be copied to the new object by default. When you copy the object over, you may optionally specify a different checksum algorithm to use with the <code>x-amz-checksum-algorithm</code> header.</p> <p> <b>Storage Class Options</b> </p> <p>You can use the <code>CopyObject</code> action to change the storage class of an object that is already stored in Amazon S3 using the <code>StorageClass</code> parameter. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage Classes</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Versioning</b> </p> <p>By default, <code>x-amz-copy-source</code> identifies the current version of an object to copy. If the current version is a delete marker, Amazon S3 behaves as if the object was deleted. To copy a different version, use the <code>versionId</code> subresource.</p> <p>If you enable versioning on the target bucket, Amazon S3 generates a unique version ID for the object being copied. This version ID is different from the version ID of the source object. Amazon S3 returns the version ID of the copied object in the <code>x-amz-version-id</code> response header in the response.</p> <p>If you do not enable versioning or suspend it on the target bucket, the version ID that Amazon S3 generates is always null.</p> <p>If the source object's storage class is GLACIER, you must restore a copy of this object before you can use it as a source object for the copy operation. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html">RestoreObject</a>.</p> <p>The following operations are related to <code>CopyObject</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a> </p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjectsExamples.html">Copying Objects</a>.</p> | +| `objects_Put` | `EXEC` | `Key, bucket, region` | <p>Adds an object to a bucket. You must have WRITE permissions on a bucket to add an object to it.</p> <p>Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the entire object to the bucket.</p> <p>Amazon S3 is a distributed system. If it receives multiple write requests for the same object simultaneously, it overwrites all but the last object written. Amazon S3 does not provide object locking; if you need this, make sure to build it into your application layer or use versioning instead.</p> <p>To ensure that data is not corrupted traversing the network, use the <code>Content-MD5</code> header. When you use this header, Amazon S3 checks the object against the provided MD5 value and, if they do not match, returns an error. Additionally, you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to the calculated MD5 value.</p> <note> <ul> <li> <p>To successfully complete the <code>PutObject</code> request, you must have the <code>s3:PutObject</code> in your IAM permissions.</p> </li> <li> <p>To successfully change the objects acl of your <code>PutObject</code> request, you must have the <code>s3:PutObjectAcl</code> in your IAM permissions.</p> </li> <li> <p> The <code>Content-MD5</code> header is required for any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more information about Amazon S3 Object Lock, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.html">Amazon S3 Object Lock Overview</a> in the <i>Amazon S3 User Guide</i>. </p> </li> </ul> </note> <p> <b>Server-side Encryption</b> </p> <p>You can optionally request server-side encryption. With server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts the data when you access it. You have the option to provide your own encryption key or use Amazon Web Services managed encryption keys (SSE-S3 or SSE-KMS). For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html">Using Server-Side Encryption</a>.</p> <p>If you request server-side encryption using Amazon Web Services Key Management Service (SSE-KMS), you can enable an S3 Bucket Key at the object-level. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html">Amazon S3 Bucket Keys</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Access Control List (ACL)-Specific Request Headers</b> </p> <p>You can use headers to grant ACL- based permissions. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access Control List (ACL) Overview</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html">Managing ACLs Using the REST API</a>. </p> <p>If the bucket that you're uploading objects to uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept PUT requests that don't specify an ACL or PUT requests that specify bucket owner full control ACLs, such as the <code>bucket-owner-full-control</code> canned ACL or an equivalent form of this ACL expressed in the XML format. PUT requests that contain other ACLs (for example, custom grants to certain Amazon Web Services accounts) fail and return a <code>400</code> error with the error code <code>AccessControlListNotSupported</code>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html"> Controlling ownership of objects and disabling ACLs</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>If your bucket uses the bucket owner enforced setting for Object Ownership, all objects written to the bucket by any account will be owned by the bucket owner.</p> </note> <p> <b>Storage Class Options</b> </p> <p>By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage Classes</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Versioning</b> </p> <p>If you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID for the object being stored. Amazon S3 returns this ID in the response. When you enable versioning for a bucket, if Amazon S3 receives multiple write requests for the same object simultaneously, it stores all of the objects.</p> <p>For more information about versioning, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/AddingObjectstoVersioningEnabledBuckets.html">Adding Objects to Versioning Enabled Buckets</a>. For information about returning the versioning state of a bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html">GetBucketVersioning</a>. </p> <p class="title"> <b>Related Resources</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html">CopyObject</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html">DeleteObject</a> </p> </li> </ul> | +| `objects_Restore` | `EXEC` | `Key, bucket, region` | <p>Restores an archived copy of an object back into Amazon S3</p> <p>This action is not supported by Amazon S3 on Outposts.</p> <p>This action performs the following types of requests: </p> <ul> <li> <p> <code>select</code> - Perform a select query on an archived object</p> </li> <li> <p> <code>restore an archive</code> - Restore an archived object</p> </li> </ul> <p>To use this operation, you must have permissions to perform the <code>s3:RestoreObject</code> action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3 Resources</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Querying Archives with Select Requests</b> </p> <p>You use a select type of request to perform SQL queries on archived objects. The archived objects that are being queried by the select request must be formatted as uncompressed comma-separated values (CSV) files. You can run queries and custom analytics on your archived data without having to restore your data to a hotter Amazon S3 tier. For an overview about select requests, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/querying-glacier-archives.html">Querying Archived Objects</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When making a select request, do the following:</p> <ul> <li> <p>Define an output location for the select query's output. This must be an Amazon S3 bucket in the same Amazon Web Services Region as the bucket that contains the archive object that is being queried. The Amazon Web Services account that initiates the job must have permissions to write to the S3 bucket. You can specify the storage class and encryption for the output objects stored in the bucket. For more information about output, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/querying-glacier-archives.html">Querying Archived Objects</a> in the <i>Amazon S3 User Guide</i>.</p> <p>For more information about the <code>S3</code> structure in the request body, see the following:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html">Managing Access with ACLs</a> in the <i>Amazon S3 User Guide</i> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html">Protecting Data Using Server-Side Encryption</a> in the <i>Amazon S3 User Guide</i> </p> </li> </ul> </li> <li> <p>Define the SQL expression for the <code>SELECT</code> type of restoration for your query in the request body's <code>SelectParameters</code> structure. You can use expressions like the following examples.</p> <ul> <li> <p>The following expression returns all records from the specified object.</p> <p> <code>SELECT * FROM Object</code> </p> </li> <li> <p>Assuming that you are not using any headers for data stored in the object, you can specify columns with positional headers.</p> <p> <code>SELECT s._1, s._2 FROM Object s WHERE s._3 > 100</code> </p> </li> <li> <p>If you have headers and you set the <code>fileHeaderInfo</code> in the <code>CSV</code> structure in the request body to <code>USE</code>, you can specify headers in the query. (If you set the <code>fileHeaderInfo</code> field to <code>IGNORE</code>, the first row is skipped for the query.) You cannot mix ordinal positions with header column names. </p> <p> <code>SELECT s.Id, s.FirstName, s.SSN FROM S3Object s</code> </p> </li> </ul> </li> </ul> <p>For more information about using SQL with S3 Glacier Select restore, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-glacier-select-sql-reference.html">SQL Reference for Amazon S3 Select and S3 Glacier Select</a> in the <i>Amazon S3 User Guide</i>. </p> <p>When making a select request, you can also do the following:</p> <ul> <li> <p>To expedite your queries, specify the <code>Expedited</code> tier. For more information about tiers, see "Restoring Archives," later in this topic.</p> </li> <li> <p>Specify details about the data serialization format of both the input object that is being queried and the serialization of the CSV-encoded query results.</p> </li> </ul> <p>The following are additional important facts about the select feature:</p> <ul> <li> <p>The output results are new Amazon S3 objects. Unlike archive retrievals, they are stored until explicitly deleted-manually or through a lifecycle policy.</p> </li> <li> <p>You can issue more than one select request on the same Amazon S3 object. Amazon S3 doesn't deduplicate requests, so avoid issuing duplicate requests.</p> </li> <li> <p> Amazon S3 accepts a select request even if the object has already been restored. A select request doesn’t return error response <code>409</code>.</p> </li> </ul> <p> <b>Restoring objects</b> </p> <p>Objects that you archive to the S3 Glacier or S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive tiers are not accessible in real time. For objects in Archive Access or Deep Archive Access tiers you must first initiate a restore request, and then wait until the object is moved into the Frequent Access tier. For objects in S3 Glacier or S3 Glacier Deep Archive storage classes you must first initiate a restore request, and then wait until a temporary copy of the object is available. To access an archived object, you must restore the object for the duration (number of days) that you specify.</p> <p>To restore a specific object version, you can provide a version ID. If you don't provide a version ID, Amazon S3 restores the current version.</p> <p>When restoring an archived object (or using a select request), you can specify one of the following data access tier options in the <code>Tier</code> element of the request body: </p> <ul> <li> <p> <code>Expedited</code> - Expedited retrievals allow you to quickly access your data stored in the S3 Glacier storage class or S3 Intelligent-Tiering Archive tier when occasional urgent requests for a subset of archives are required. For all but the largest archived objects (250 MB+), data accessed using Expedited retrievals is typically made available within 1–5 minutes. Provisioned capacity ensures that retrieval capacity for Expedited retrievals is available when you need it. Expedited retrievals and provisioned capacity are not available for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier.</p> </li> <li> <p> <code>Standard</code> - Standard retrievals allow you to access any of your archived objects within several hours. This is the default option for retrieval requests that do not specify the retrieval option. Standard retrievals typically finish within 3–5 hours for objects stored in the S3 Glacier storage class or S3 Intelligent-Tiering Archive tier. They typically finish within 12 hours for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier. Standard retrievals are free for objects stored in S3 Intelligent-Tiering.</p> </li> <li> <p> <code>Bulk</code> - Bulk retrievals are the lowest-cost retrieval option in S3 Glacier, enabling you to retrieve large amounts, even petabytes, of data inexpensively. Bulk retrievals typically finish within 5–12 hours for objects stored in the S3 Glacier storage class or S3 Intelligent-Tiering Archive tier. They typically finish within 48 hours for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier. Bulk retrievals are free for objects stored in S3 Intelligent-Tiering.</p> </li> </ul> <p>For more information about archive retrieval options and provisioned capacity for <code>Expedited</code> data access, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html">Restoring Archived Objects</a> in the <i>Amazon S3 User Guide</i>. </p> <p>You can use Amazon S3 restore speed upgrade to change the restore speed to a faster speed while it is in progress. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html#restoring-objects-upgrade-tier.title.html"> Upgrading the speed of an in-progress restore</a> in the <i>Amazon S3 User Guide</i>. </p> <p>To get the status of object restoration, you can send a <code>HEAD</code> request. Operations return the <code>x-amz-restore</code> header, which provides information about the restoration status, in the response. You can use Amazon S3 event notifications to notify you when a restore is initiated or completed. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Configuring Amazon S3 Event Notifications</a> in the <i>Amazon S3 User Guide</i>.</p> <p>After restoring an archived object, you can update the restoration period by reissuing the request with a new period. Amazon S3 updates the restoration period relative to the current time and charges only for the request-there are no data transfer charges. You cannot update the restoration period when Amazon S3 is actively processing your current restore request for the object.</p> <p>If your bucket has a lifecycle configuration with a rule that includes an expiration action, the object expiration overrides the life span that you specify in a restore request. For example, if you restore an object copy for 10 days, but the object is scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days. For more information about lifecycle configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html">Object Lifecycle Management</a> in <i>Amazon S3 User Guide</i>.</p> <p> <b>Responses</b> </p> <p>A successful action returns either the <code>200 OK</code> or <code>202 Accepted</code> status code. </p> <ul> <li> <p>If the object is not previously restored, then Amazon S3 returns <code>202 Accepted</code> in the response. </p> </li> <li> <p>If the object is previously restored, Amazon S3 returns <code>200 OK</code> in the response. </p> </li> </ul> <p class="title"> <b>Special Errors</b> </p> <ul> <li> <ul> <li> <p> <i>Code: RestoreAlreadyInProgress</i> </p> </li> <li> <p> <i>Cause: Object restore is already in progress. (This error does not apply to SELECT type requests.)</i> </p> </li> <li> <p> <i>HTTP Status Code: 409 Conflict</i> </p> </li> <li> <p> <i>SOAP Fault Code Prefix: Client</i> </p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code: GlacierExpeditedRetrievalNotAvailable</i> </p> </li> <li> <p> <i>Cause: expedited retrievals are currently not available. Try again later. (Returned if there is insufficient capacity to process the Expedited request. This error applies only to Expedited retrievals and not to S3 Standard or Bulk retrievals.)</i> </p> </li> <li> <p> <i>HTTP Status Code: 503</i> </p> </li> <li> <p> <i>SOAP Fault Code Prefix: N/A</i> </p> </li> </ul> </li> </ul> <p class="title"> <b>Related Resources</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketNotificationConfiguration.html">GetBucketNotificationConfiguration</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-glacier-select-sql-reference.html">SQL Reference for Amazon S3 Select and S3 Glacier Select </a> in the <i>Amazon S3 User Guide</i> </p> </li> </ul> | diff --git a/docs/aws-docs/providers/aws/s3_api/objects_v2s/index.md b/docs/aws-docs/providers/aws/s3_api/objects_v2s/index.md new file mode 100644 index 0000000000..7bebd29ca9 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3_api/objects_v2s/index.md @@ -0,0 +1,32 @@ +--- +title: objects_v2s +hide_title: false +hide_table_of_contents: false +keywords: + - objects_v2s + - s3_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameobjects_v2s
TypeResource
Idaws.s3_api.objects_v2s
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `objects_v2s_List` | `EXEC` | `list-type, bucket, region` | diff --git a/docs/aws-docs/providers/aws/s3_api/part_copies/index.md b/docs/aws-docs/providers/aws/s3_api/part_copies/index.md new file mode 100644 index 0000000000..1a8b15c635 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3_api/part_copies/index.md @@ -0,0 +1,32 @@ +--- +title: part_copies +hide_title: false +hide_table_of_contents: false +keywords: + - part_copies + - s3_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namepart_copies
TypeResource
Idaws.s3_api.part_copies
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `part_copies_Upload` | `EXEC` | `Key, partNumber, uploadId, x-amz-copy-source, bucket, region` | diff --git a/docs/aws-docs/providers/aws/s3_api/parts/index.md b/docs/aws-docs/providers/aws/s3_api/parts/index.md new file mode 100644 index 0000000000..c18bacaf2a --- /dev/null +++ b/docs/aws-docs/providers/aws/s3_api/parts/index.md @@ -0,0 +1,33 @@ +--- +title: parts +hide_title: false +hide_table_of_contents: false +keywords: + - parts + - s3_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameparts
TypeResource
Idaws.s3_api.parts
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `parts_List` | `EXEC` | `Key, uploadId, bucket, region` | <p>Lists the parts that have been uploaded for a specific multipart upload. This operation must include the upload ID, which you obtain by sending the initiate multipart upload request (see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a>). This request returns a maximum of 1,000 uploaded parts. The default number of parts returned is 1,000 parts. You can restrict the number of parts returned by specifying the <code>max-parts</code> request parameter. If your multipart upload consists of more than 1,000 parts, the response returns an <code>IsTruncated</code> field with the value of true, and a <code>NextPartNumberMarker</code> element. In subsequent <code>ListParts</code> requests you can include the part-number-marker query string parameter and set its value to the <code>NextPartNumberMarker</code> field value from the previous response.</p> <p>If the upload was created using a checksum algorithm, you will need to have permission to the <code>kms:Decrypt</code> action for the request to succeed. </p> <p>For more information on multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html">Uploading Objects Using Multipart Upload</a>.</p> <p>For information on permissions required to use the multipart upload API, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart Upload and Permissions</a>.</p> <p>The following operations are related to <code>ListParts</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html">CompleteMultipartUpload</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html">AbortMultipartUpload</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html">GetObjectAttributes</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html">ListMultipartUploads</a> </p> </li> </ul> | +| `parts_Upload` | `EXEC` | `Key, partNumber, uploadId, bucket, region` | <p>Uploads a part in a multipart upload.</p> <note> <p>In this operation, you provide part data in your request. However, you have an option to specify your existing Amazon S3 object as a data source for the part you are uploading. To upload a part from an existing object, you use the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html">UploadPartCopy</a> operation. </p> </note> <p>You must initiate a multipart upload (see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a>) before you can upload any part. In response to your initiate request, Amazon S3 returns an upload ID, a unique identifier, that you must include in your upload part request.</p> <p>Part numbers can be any number from 1 to 10,000, inclusive. A part number uniquely identifies a part and also defines its position within the object being created. If you upload a new part using the same part number that was used with a previous part, the previously uploaded part is overwritten.</p> <p>For information about maximum and minimum part sizes and other multipart upload specifications, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/qfacts.html">Multipart upload limits</a> in the <i>Amazon S3 User Guide</i>.</p> <p>To ensure that data is not corrupted when traversing the network, specify the <code>Content-MD5</code> header in the upload part request. Amazon S3 checks the part data against the provided MD5 value. If they do not match, Amazon S3 returns an error. </p> <p>If the upload request is signed with Signature Version 4, then Amazon Web Services S3 uses the <code>x-amz-content-sha256</code> header as a checksum instead of <code>Content-MD5</code>. For more information see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-auth-using-authorization-header.html">Authenticating Requests: Using the Authorization Header (Amazon Web Services Signature Version 4)</a>. </p> <p> <b>Note:</b> After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.</p> <p>For more information on multipart uploads, go to <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html">Multipart Upload Overview</a> in the <i>Amazon S3 User Guide </i>.</p> <p>For information on the permissions required to use the multipart upload API, go to <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart Upload and Permissions</a> in the <i>Amazon S3 User Guide</i>.</p> <p>You can optionally request server-side encryption where Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it for you when you access it. You have the option of providing your own encryption key, or you can use the Amazon Web Services managed encryption keys. If you choose to provide your own encryption key, the request headers you provide in the request must match the headers you used in the request to initiate the upload by using <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a>. For more information, go to <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html">Using Server-Side Encryption</a> in the <i>Amazon S3 User Guide</i>.</p> <p>Server-side encryption is supported by the S3 Multipart Upload actions. Unless you are using a customer-provided encryption key, you don't need to specify the encryption parameters in each UploadPart request. Instead, you only need to specify the server-side encryption parameters in the initial Initiate Multipart request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a>.</p> <p>If you requested server-side encryption using a customer-provided encryption key in your initiate multipart upload request, you must provide identical encryption information in each part upload using the following headers.</p> <ul> <li> <p>x-amz-server-side-encryption-customer-algorithm</p> </li> <li> <p>x-amz-server-side-encryption-customer-key</p> </li> <li> <p>x-amz-server-side-encryption-customer-key-MD5</p> </li> </ul> <p class="title"> <b>Special Errors</b> </p> <ul> <li> <ul> <li> <p> <i>Code: NoSuchUpload</i> </p> </li> <li> <p> <i>Cause: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.</i> </p> </li> <li> <p> <i> HTTP Status Code: 404 Not Found </i> </p> </li> <li> <p> <i>SOAP Fault Code Prefix: Client</i> </p> </li> </ul> </li> </ul> <p class="title"> <b>Related Resources</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html">CompleteMultipartUpload</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html">AbortMultipartUpload</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html">ListParts</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html">ListMultipartUploads</a> </p> </li> </ul> | diff --git a/docs/aws-docs/providers/aws/s3_api/public_access_blocks/index.md b/docs/aws-docs/providers/aws/s3_api/public_access_blocks/index.md new file mode 100644 index 0000000000..33a3fde0d1 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3_api/public_access_blocks/index.md @@ -0,0 +1,33 @@ +--- +title: public_access_blocks +hide_title: false +hide_table_of_contents: false +keywords: + - public_access_blocks + - s3_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Namepublic_access_blocks
TypeResource
Idaws.s3_api.public_access_blocks
+ +## Fields +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `public_access_blocks_Get` | `SELECT` | `bucket, region` | <p>Retrieves the <code>PublicAccessBlock</code> configuration for an Amazon S3 bucket. To use this operation, you must have the <code>s3:GetBucketPublicAccessBlock</code> permission. For more information about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in a Policy</a>.</p> <important> <p>When Amazon S3 evaluates the <code>PublicAccessBlock</code> configuration for a bucket or an object, it checks the <code>PublicAccessBlock</code> configuration for both the bucket (or the bucket that contains the object) and the bucket owner's account. If the <code>PublicAccessBlock</code> settings are different between the bucket and the account, Amazon S3 uses the most restrictive combination of the bucket-level and account-level settings.</p> </important> <p>For more information about when Amazon S3 considers a bucket or an object public, see <a href="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"</a>.</p> <p>The following operations are related to <code>GetPublicAccessBlock</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html">Using Amazon S3 Block Public Access</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutPublicAccessBlock.html">PutPublicAccessBlock</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html">GetPublicAccessBlock</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html">DeletePublicAccessBlock</a> </p> </li> </ul> | +| `public_access_blocks_Delete` | `DELETE` | `bucket, region` | <p>Removes the <code>PublicAccessBlock</code> configuration for an Amazon S3 bucket. To use this operation, you must have the <code>s3:PutBucketPublicAccessBlock</code> permission. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p>The following operations are related to <code>DeletePublicAccessBlock</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html">Using Amazon S3 Block Public Access</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html">GetPublicAccessBlock</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutPublicAccessBlock.html">PutPublicAccessBlock</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketPolicyStatus.html">GetBucketPolicyStatus</a> </p> </li> </ul> | +| `public_access_blocks_Put` | `EXEC` | `bucket, region` | <p>Creates or modifies the <code>PublicAccessBlock</code> configuration for an Amazon S3 bucket. To use this operation, you must have the <code>s3:PutBucketPublicAccessBlock</code> permission. For more information about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in a Policy</a>.</p> <important> <p>When Amazon S3 evaluates the <code>PublicAccessBlock</code> configuration for a bucket or an object, it checks the <code>PublicAccessBlock</code> configuration for both the bucket (or the bucket that contains the object) and the bucket owner's account. If the <code>PublicAccessBlock</code> configurations are different between the bucket and the account, Amazon S3 uses the most restrictive combination of the bucket-level and account-level settings.</p> </important> <p>For more information about when Amazon S3 considers a bucket or an object public, see <a href="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"</a>.</p> <p class="title"> <b>Related Resources</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html">GetPublicAccessBlock</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html">DeletePublicAccessBlock</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketPolicyStatus.html">GetBucketPolicyStatus</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html">Using Amazon S3 Block Public Access</a> </p> </li> </ul> | diff --git a/docs/aws-docs/providers/aws/s3express/bucket_policies/index.md b/docs/aws-docs/providers/aws/s3express/bucket_policies/index.md new file mode 100644 index 0000000000..073509d0e8 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3express/bucket_policies/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource Type definition for AWS::S3Express::BucketPolicy.
Idaws.s3express.bucket_policies
+ +## Fields + + + + + +
NameDatatypeDescription
bucketstringThe name of the S3 directory bucket to which the policy applies.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +bucket +FROM aws.s3express.bucket_policies +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the bucket_policies resource, the following permissions are required: + +### Create +```json +s3express:GetBucketPolicy, +s3express:PutBucketPolicy +``` + +### List +```json +s3express:GetBucketPolicy, +s3express:ListAllMyDirectoryBuckets +``` + diff --git a/docs/aws-docs/providers/aws/s3express/bucket_policy/index.md b/docs/aws-docs/providers/aws/s3express/bucket_policy/index.md new file mode 100644 index 0000000000..98d5e28040 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3express/bucket_policy/index.md @@ -0,0 +1,91 @@ +--- +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
DescriptionResource Type definition for AWS::S3Express::BucketPolicy.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +bucket, +policy_document +FROM aws.s3express.bucket_policy +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the bucket_policy resource, the following permissions are required: + +### Read +```json +s3express:GetBucketPolicy +``` + +### Update +```json +s3express:GetBucketPolicy, +s3express:PutBucketPolicy +``` + +### Delete +```json +s3express:GetBucketPolicy, +s3express:DeleteBucketPolicy +``` + diff --git a/docs/aws-docs/providers/aws/s3express/directory_bucket/index.md b/docs/aws-docs/providers/aws/s3express/directory_bucket/index.md new file mode 100644 index 0000000000..af01fc9d48 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3express/directory_bucket/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionResource Type definition for AWS::S3Express::DirectoryBucket.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +bucket_name, +location_name, +data_redundancy, +arn +FROM aws.s3express.directory_bucket +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the directory_bucket resource, the following permissions are required: + +### Read +```json +s3express:ListAllMyDirectoryBuckets +``` + +### Delete +```json +s3express:DeleteBucket, +s3express:ListAllMyDirectoryBuckets +``` + diff --git a/docs/aws-docs/providers/aws/s3express/directory_buckets/index.md b/docs/aws-docs/providers/aws/s3express/directory_buckets/index.md new file mode 100644 index 0000000000..5e8db1aaf2 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3express/directory_buckets/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionResource Type definition for AWS::S3Express::DirectoryBucket.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +bucket_name +FROM aws.s3express.directory_buckets +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the directory_buckets resource, the following permissions are required: + +### Create +```json +s3express:CreateBucket, +s3express:ListAllMyDirectoryBuckets +``` + +### List +```json +s3express:ListAllMyDirectoryBuckets +``` + diff --git a/docs/aws-docs/providers/aws/s3express/index.md b/docs/aws-docs/providers/aws/s3express/index.md new file mode 100644 index 0000000000..d96dcc0958 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/s3objectlambda/access_point/index.md b/docs/aws-docs/providers/aws/s3objectlambda/access_point/index.md new file mode 100644 index 0000000000..7be9052ec8 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3objectlambda/access_point/index.md @@ -0,0 +1,104 @@ +--- +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
DescriptionThe AWS::S3ObjectLambda::AccessPoint resource is an Amazon S3ObjectLambda resource type that you can use to add computation to S3 actions
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +alias, +arn, +creation_date, +public_access_block_configuration, +policy_status, +object_lambda_configuration +FROM aws.s3objectlambda.access_point +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the access_point resource, the following permissions are required: + +### Read +```json +s3:GetAccessPointForObjectLambda, +s3:GetAccessPointPolicyStatusForObjectLambda, +s3:GetAccessPointConfigurationForObjectLambda +``` + +### Update +```json +s3:PutAccessPointConfigurationForObjectLambda, +s3:GetAccessPointForObjectLambda, +s3:GetAccessPointPolicyStatusForObjectLambda, +s3:GetAccessPointConfigurationForObjectLambda +``` + +### Delete +```json +s3:DeleteAccessPointForObjectLambda +``` + diff --git a/docs/aws-docs/providers/aws/s3objectlambda/access_point_policies/index.md b/docs/aws-docs/providers/aws/s3objectlambda/access_point_policies/index.md new file mode 100644 index 0000000000..b86faaaa31 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3objectlambda/access_point_policies/index.md @@ -0,0 +1,68 @@ +--- +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
DescriptionAWS::S3ObjectLambda::AccessPointPolicy resource is an Amazon S3ObjectLambda policy type that you can use to control permissions for your S3ObjectLambda
Idaws.s3objectlambda.access_point_policies
+ +## Fields + + + + + +
NameDatatypeDescription
object_lambda_access_pointstringThe name of the Amazon S3 ObjectLambdaAccessPoint to which the policy applies.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +object_lambda_access_point +FROM aws.s3objectlambda.access_point_policies +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the access_point_policies resource, the following permissions are required: + +### Create +```json +s3:PutAccessPointPolicyForObjectLambda, +s3:GetAccessPointPolicyForObjectLambda +``` + diff --git a/docs/aws-docs/providers/aws/s3objectlambda/access_point_policy/index.md b/docs/aws-docs/providers/aws/s3objectlambda/access_point_policy/index.md new file mode 100644 index 0000000000..358c69c01e --- /dev/null +++ b/docs/aws-docs/providers/aws/s3objectlambda/access_point_policy/index.md @@ -0,0 +1,91 @@ +--- +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
DescriptionAWS::S3ObjectLambda::AccessPointPolicy resource is an Amazon S3ObjectLambda policy type that you can use to control permissions for your S3ObjectLambda
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +object_lambda_access_point, +policy_document +FROM aws.s3objectlambda.access_point_policy +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the access_point_policy resource, the following permissions are required: + +### Read +```json +s3:GetAccessPointPolicyForObjectLambda +``` + +### Update +```json +s3:PutAccessPointPolicyForObjectLambda, +s3:GetAccessPointPolicyForObjectLambda +``` + +### Delete +```json +s3:DeleteAccessPointPolicyForObjectLambda, +s3:GetAccessPointPolicyForObjectLambda +``` + diff --git a/docs/aws-docs/providers/aws/s3objectlambda/access_points/index.md b/docs/aws-docs/providers/aws/s3objectlambda/access_points/index.md new file mode 100644 index 0000000000..ccd6c346e3 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3objectlambda/access_points/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionThe AWS::S3ObjectLambda::AccessPoint resource is an Amazon S3ObjectLambda resource type that you can use to add computation to S3 actions
Idaws.s3objectlambda.access_points
+ +## Fields + + + + + +
NameDatatypeDescription
namestringThe name you want to assign to this Object lambda Access Point.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.s3objectlambda.access_points +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the access_points resource, the following permissions are required: + +### Create +```json +s3:CreateAccessPointForObjectLambda, +s3:PutAccessPointConfigurationForObjectLambda, +s3:GetAccessPointForObjectLambda, +s3:GetAccessPointPolicyStatusForObjectLambda, +s3:GetAccessPointConfigurationForObjectLambda +``` + +### List +```json +s3:ListAccessPointsForObjectLambda +``` + diff --git a/docs/aws-docs/providers/aws/s3objectlambda/index.md b/docs/aws-docs/providers/aws/s3objectlambda/index.md new file mode 100644 index 0000000000..8f0fe483f3 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/s3outposts/access_point/index.md b/docs/aws-docs/providers/aws/s3outposts/access_point/index.md new file mode 100644 index 0000000000..19872edb98 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3outposts/access_point/index.md @@ -0,0 +1,100 @@ +--- +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
DescriptionResource Type Definition for AWS::S3Outposts::AccessPoint
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +bucket, +name, +vpc_configuration, +policy +FROM aws.s3outposts.access_point +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the access_point resource, the following permissions are required: + +### Read +```json +s3-outposts:GetAccessPoint, +s3-outposts:GetAccessPointPolicy +``` + +### Update +```json +s3-outposts:GetAccessPoint, +s3-outposts:PutAccessPointPolicy, +s3-outposts:GetAccessPointPolicy, +s3-outposts:DeleteAccessPointPolicy +``` + +### Delete +```json +s3-outposts:DeleteAccessPoint, +s3-outposts:DeleteAccessPointPolicy +``` + diff --git a/docs/aws-docs/providers/aws/s3outposts/access_points/index.md b/docs/aws-docs/providers/aws/s3outposts/access_points/index.md new file mode 100644 index 0000000000..eac44b0667 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3outposts/access_points/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionResource Type Definition for AWS::S3Outposts::AccessPoint
Idaws.s3outposts.access_points
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the specified AccessPoint.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.s3outposts.access_points +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the access_points resource, the following permissions are required: + +### Create +```json +s3-outposts:CreateAccessPoint, +s3-outposts:GetAccessPoint, +s3-outposts:PutAccessPointPolicy, +s3-outposts:GetAccessPointPolicy +``` + +### List +```json +s3-outposts:ListAccessPoints +``` + diff --git a/docs/aws-docs/providers/aws/s3outposts/bucket/index.md b/docs/aws-docs/providers/aws/s3outposts/bucket/index.md new file mode 100644 index 0000000000..ddc3f078cc --- /dev/null +++ b/docs/aws-docs/providers/aws/s3outposts/bucket/index.md @@ -0,0 +1,99 @@ +--- +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
DescriptionResource Type Definition for AWS::S3Outposts::Bucket
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +bucket_name, +outpost_id, +tags, +lifecycle_configuration +FROM aws.s3outposts.bucket +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the bucket resource, the following permissions are required: + +### Read +```json +s3-outposts:GetBucket, +s3-outposts:GetBucketTagging, +s3-outposts:GetLifecycleConfiguration +``` + +### Update +```json +s3-outposts:PutBucketTagging, +s3-outposts:DeleteBucketTagging, +s3-outposts:PutLifecycleConfiguration +``` + +### Delete +```json +s3-outposts:DeleteBucket +``` + diff --git a/docs/aws-docs/providers/aws/s3outposts/bucket_policies/index.md b/docs/aws-docs/providers/aws/s3outposts/bucket_policies/index.md new file mode 100644 index 0000000000..82fbf6bc23 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3outposts/bucket_policies/index.md @@ -0,0 +1,68 @@ +--- +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
DescriptionResource Type Definition for AWS::S3Outposts::BucketPolicy
Idaws.s3outposts.bucket_policies
+ +## Fields + + + + + +
NameDatatypeDescription
bucketstringThe Amazon Resource Name (ARN) of the specified bucket.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +bucket +FROM aws.s3outposts.bucket_policies +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the bucket_policies resource, the following permissions are required: + +### Create +```json +s3-outposts:PutBucketPolicy, +s3-outposts:GetBucketPolicy +``` + diff --git a/docs/aws-docs/providers/aws/s3outposts/bucket_policy/index.md b/docs/aws-docs/providers/aws/s3outposts/bucket_policy/index.md new file mode 100644 index 0000000000..001917819b --- /dev/null +++ b/docs/aws-docs/providers/aws/s3outposts/bucket_policy/index.md @@ -0,0 +1,91 @@ +--- +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
DescriptionResource Type Definition for AWS::S3Outposts::BucketPolicy
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +bucket, +policy_document +FROM aws.s3outposts.bucket_policy +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the bucket_policy resource, the following permissions are required: + +### Read +```json +s3-outposts:GetBucketPolicy +``` + +### Update +```json +s3-outposts:PutBucketPolicy, +s3-outposts:GetBucketPolicy +``` + +### Delete +```json +s3-outposts:DeleteBucketPolicy, +s3-outposts:GetBucketPolicy +``` + diff --git a/docs/aws-docs/providers/aws/s3outposts/buckets/index.md b/docs/aws-docs/providers/aws/s3outposts/buckets/index.md new file mode 100644 index 0000000000..56272ef00a --- /dev/null +++ b/docs/aws-docs/providers/aws/s3outposts/buckets/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource Type Definition for AWS::S3Outposts::Bucket
Idaws.s3outposts.buckets
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the specified bucket.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.s3outposts.buckets +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the buckets resource, the following permissions are required: + +### Create +```json +s3-outposts:CreateBucket, +s3-outposts:PutBucketTagging, +s3-outposts:PutLifecycleConfiguration +``` + +### List +```json +s3-outposts:ListRegionalBuckets +``` + diff --git a/docs/aws-docs/providers/aws/s3outposts/endpoint/index.md b/docs/aws-docs/providers/aws/s3outposts/endpoint/index.md new file mode 100644 index 0000000000..4ad744dba3 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3outposts/endpoint/index.md @@ -0,0 +1,99 @@ +--- +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
DescriptionResource Type Definition for AWS::S3Outposts::Endpoint
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.s3outposts.endpoint +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the endpoint resource, the following permissions are required: + +### Read +```json +s3-outposts:ListEndpoints +``` + +### Delete +```json +s3-outposts:DeleteEndpoint +``` + diff --git a/docs/aws-docs/providers/aws/s3outposts/endpoints/index.md b/docs/aws-docs/providers/aws/s3outposts/endpoints/index.md new file mode 100644 index 0000000000..8896087152 --- /dev/null +++ b/docs/aws-docs/providers/aws/s3outposts/endpoints/index.md @@ -0,0 +1,77 @@ +--- +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
DescriptionResource Type Definition for AWS::S3Outposts::Endpoint
Idaws.s3outposts.endpoints
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the endpoint.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.s3outposts.endpoints +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the endpoints resource, the following permissions are required: + +### Create +```json +s3-outposts:CreateEndpoint +``` + +### List +```json +s3-outposts:ListEndpoints +``` + diff --git a/docs/aws-docs/providers/aws/s3outposts/index.md b/docs/aws-docs/providers/aws/s3outposts/index.md new file mode 100644 index 0000000000..51c06ac3ab --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/sagemaker/app/index.md b/docs/aws-docs/providers/aws/sagemaker/app/index.md new file mode 100644 index 0000000000..26c848b058 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/app/index.md @@ -0,0 +1,91 @@ +--- +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
DescriptionResource Type definition for AWS::SageMaker::App
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +app_arn, +app_name, +app_type, +domain_id, +resource_spec, +tags, +user_profile_name +FROM aws.sagemaker.app +WHERE data__Identifier = '|||'; +``` + +## Permissions + +To operate on the app resource, the following permissions are required: + +### Read +```json +sagemaker:DescribeApp, +sagemaker:DescribeApp +``` + +### Delete +```json +sagemaker:DeleteApp, +sagemaker:DescribeApp +``` + diff --git a/docs/aws-docs/providers/aws/sagemaker/app_image_config/index.md b/docs/aws-docs/providers/aws/sagemaker/app_image_config/index.md new file mode 100644 index 0000000000..5ec63c4c96 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/app_image_config/index.md @@ -0,0 +1,99 @@ +--- +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
DescriptionResource Type definition for AWS::SageMaker::AppImageConfig
Idaws.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.
code_editor_app_image_configobjectThe CodeEditorAppImageConfig.
tagsarrayA list of tags to apply to the AppImageConfig.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +app_image_config_arn, +app_image_config_name, +kernel_gateway_image_config, +jupyter_lab_app_image_config, +code_editor_app_image_config, +tags +FROM aws.sagemaker.app_image_config +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the app_image_config resource, the following permissions are required: + +### Read +```json +sagemaker:DescribeAppImageConfig +``` + +### Update +```json +sagemaker:UpdateAppImageConfig, +sagemaker:DescribeAppImageConfig +``` + +### Delete +```json +sagemaker:DeleteAppImageConfig, +sagemaker:DescribeAppImageConfig +``` + diff --git a/docs/aws-docs/providers/aws/sagemaker/app_image_configs/index.md b/docs/aws-docs/providers/aws/sagemaker/app_image_configs/index.md new file mode 100644 index 0000000000..07ab7c3650 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/app_image_configs/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionResource Type definition for AWS::SageMaker::AppImageConfig
Idaws.sagemaker.app_image_configs
+ +## Fields + + + + + +
NameDatatypeDescription
app_image_config_namestringThe Name of the AppImageConfig.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +app_image_config_name +FROM aws.sagemaker.app_image_configs +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the app_image_configs resource, the following permissions are required: + +### Create +```json +sagemaker:CreateAppImageConfig, +sagemaker:DescribeAppImageConfig +``` + +### List +```json +sagemaker:ListAppImageConfigs +``` + diff --git a/docs/aws-docs/providers/aws/sagemaker/apps/index.md b/docs/aws-docs/providers/aws/sagemaker/apps/index.md new file mode 100644 index 0000000000..40360e33c7 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/apps/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionResource Type definition for AWS::SageMaker::App
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +app_name, +app_type, +domain_id, +user_profile_name +FROM aws.sagemaker.apps +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the apps resource, the following permissions are required: + +### Create +```json +sagemaker:CreateApp, +sagemaker:DescribeApp +``` + +### List +```json +sagemaker:ListApps +``` + diff --git a/docs/aws-docs/providers/aws/sagemaker/data_quality_job_definition/index.md b/docs/aws-docs/providers/aws/sagemaker/data_quality_job_definition/index.md new file mode 100644 index 0000000000..417a2108b5 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/data_quality_job_definition/index.md @@ -0,0 +1,101 @@ +--- +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
DescriptionResource Type definition for AWS::SageMaker::DataQualityJobDefinition
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.sagemaker.data_quality_job_definition +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the data_quality_job_definition resource, the following permissions are required: + +### Delete +```json +sagemaker:DeleteDataQualityJobDefinition +``` + +### Read +```json +sagemaker:DescribeDataQualityJobDefinition +``` + diff --git a/docs/aws-docs/providers/aws/sagemaker/data_quality_job_definitions/index.md b/docs/aws-docs/providers/aws/sagemaker/data_quality_job_definitions/index.md new file mode 100644 index 0000000000..3652d59b2c --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/data_quality_job_definitions/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionResource Type definition for AWS::SageMaker::DataQualityJobDefinition
Idaws.sagemaker.data_quality_job_definitions
+ +## Fields + + + + + +
NameDatatypeDescription
job_definition_arnstringThe Amazon Resource Name (ARN) of job definition.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +job_definition_arn +FROM aws.sagemaker.data_quality_job_definitions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the data_quality_job_definitions resource, the following permissions are required: + +### Create +```json +sagemaker:CreateDataQualityJobDefinition, +sagemaker:DescribeDataQualityJobDefinition, +sagemaker:AddTags, +iam:PassRole +``` + +### List +```json +sagemaker:ListDataQualityJobDefinitions, +sagemaker:ListTags +``` + diff --git a/docs/aws-docs/providers/aws/sagemaker/device/index.md b/docs/aws-docs/providers/aws/sagemaker/device/index.md new file mode 100644 index 0000000000..ad071f4d41 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/device/index.md @@ -0,0 +1,91 @@ +--- +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
DescriptionResource schema for AWS::SageMaker::Device
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +device_fleet_name, +device, +tags +FROM aws.sagemaker.device +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the device resource, the following permissions are required: + +### Read +```json +sagemaker:DescribeDevice +``` + +### Update +```json +sagemaker:UpdateDevices +``` + +### Delete +```json +sagemaker:DeregisterDevices +``` + diff --git a/docs/aws-docs/providers/aws/sagemaker/device_fleet/index.md b/docs/aws-docs/providers/aws/sagemaker/device_fleet/index.md new file mode 100644 index 0000000000..9c41351812 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/device_fleet/index.md @@ -0,0 +1,96 @@ +--- +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
DescriptionResource schema for AWS::SageMaker::DeviceFleet
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +description, +device_fleet_name, +output_config, +role_arn, +tags +FROM aws.sagemaker.device_fleet +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the device_fleet resource, the following permissions are required: + +### Read +```json +sagemaker:DescribeDeviceFleet +``` + +### Update +```json +sagemaker:UpdateDeviceFleet, +iam:PassRole +``` + +### Delete +```json +sagemaker:DeleteDeviceFleet +``` + diff --git a/docs/aws-docs/providers/aws/sagemaker/device_fleets/index.md b/docs/aws-docs/providers/aws/sagemaker/device_fleets/index.md new file mode 100644 index 0000000000..18a1b6b480 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/device_fleets/index.md @@ -0,0 +1,68 @@ +--- +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
DescriptionResource schema for AWS::SageMaker::DeviceFleet
Idaws.sagemaker.device_fleets
+ +## Fields + + + + + +
NameDatatypeDescription
device_fleet_namestringThe name of the edge device fleet
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +device_fleet_name +FROM aws.sagemaker.device_fleets +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the device_fleets resource, the following permissions are required: + +### Create +```json +sagemaker:CreateDeviceFleet, +iam:PassRole +``` + diff --git a/docs/aws-docs/providers/aws/sagemaker/devices/index.md b/docs/aws-docs/providers/aws/sagemaker/devices/index.md new file mode 100644 index 0000000000..9230fff346 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/devices/index.md @@ -0,0 +1,67 @@ +--- +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
DescriptionResource schema for AWS::SageMaker::Device
Idaws.sagemaker.devices
+ +## Fields + + + + + +
NameDatatypeDescription
device/device_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +device/device_name +FROM aws.sagemaker.devices +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the devices resource, the following permissions are required: + +### Create +```json +sagemaker:RegisterDevices +``` + diff --git a/docs/aws-docs/providers/aws/sagemaker/feature_group/index.md b/docs/aws-docs/providers/aws/sagemaker/feature_group/index.md new file mode 100644 index 0000000000..ed8d73bdd4 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/feature_group/index.md @@ -0,0 +1,115 @@ +--- +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
DescriptionResource Type definition for AWS::SageMaker::FeatureGroup
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.sagemaker.feature_group +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the feature_group resource, the following permissions are required: + +### Update +```json +sagemaker:UpdateFeatureGroup, +sagemaker:DescribeFeatureGroup, +sagemaker:AddTags, +sagemaker:ListTags, +sagemaker:DeleteTags +``` + +### Read +```json +sagemaker:DescribeFeatureGroup, +sagemaker:ListTags +``` + +### Delete +```json +sagemaker:DeleteFeatureGroup, +sagemaker:DescribeFeatureGroup +``` + diff --git a/docs/aws-docs/providers/aws/sagemaker/feature_groups/index.md b/docs/aws-docs/providers/aws/sagemaker/feature_groups/index.md new file mode 100644 index 0000000000..38ca0fbcf7 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/feature_groups/index.md @@ -0,0 +1,87 @@ +--- +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
DescriptionResource Type definition for AWS::SageMaker::FeatureGroup
Idaws.sagemaker.feature_groups
+ +## Fields + + + + + +
NameDatatypeDescription
feature_group_namestringThe Name of the FeatureGroup.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +feature_group_name +FROM aws.sagemaker.feature_groups +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the feature_groups resource, the following permissions are required: + +### Create +```json +iam:PassRole, +kms:CreateGrant, +kms:DescribeKey, +glue:CreateTable, +glue:GetTable, +glue:CreateDatabase, +glue:GetDatabase, +sagemaker:CreateFeatureGroup, +sagemaker:DescribeFeatureGroup, +sagemaker:AddTags, +sagemaker:ListTags +``` + +### List +```json +sagemaker:ListFeatureGroups +``` + diff --git a/docs/aws-docs/providers/aws/sagemaker/image/index.md b/docs/aws-docs/providers/aws/sagemaker/image/index.md new file mode 100644 index 0000000000..d42a04ba06 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/image/index.md @@ -0,0 +1,104 @@ +--- +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
DescriptionResource Type definition for AWS::SageMaker::Image
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +image_name, +image_arn, +image_role_arn, +image_display_name, +image_description, +tags +FROM aws.sagemaker.image +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the image resource, the following permissions are required: + +### Read +```json +sagemaker:DescribeImage, +sagemaker:ListTags +``` + +### Update +```json +sagemaker:UpdateImage, +sagemaker:DescribeImage, +sagemaker:ListTags, +sagemaker:AddTags, +sagemaker:DeleteTags, +iam:PassRole +``` + +### Delete +```json +sagemaker:DeleteImage, +sagemaker:DescribeImage +``` + diff --git a/docs/aws-docs/providers/aws/sagemaker/image_version/index.md b/docs/aws-docs/providers/aws/sagemaker/image_version/index.md new file mode 100644 index 0000000000..0d2822d6bf --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/image_version/index.md @@ -0,0 +1,118 @@ +--- +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
DescriptionResource Type definition for AWS::SageMaker::ImageVersion
Idaws.sagemaker.image_version
+ +## Fields + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
image_namestring
image_arnstring
image_version_arnstring
base_imagestring
container_imagestring
versioninteger
aliasstring
aliasesarray
vendor_guidancestring
job_typestring
ml_frameworkstring
programming_langstring
processorstring
horovodboolean
release_notesstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +image_name, +image_arn, +image_version_arn, +base_image, +container_image, +version, +alias, +aliases, +vendor_guidance, +job_type, +ml_framework, +programming_lang, +processor, +horovod, +release_notes +FROM aws.sagemaker.image_version +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the image_version resource, the following permissions are required: + +### Read +```json +sagemaker:DescribeImageVersion +``` + +### Update +```json +sagemaker:UpdateImageVersion, +sagemaker:DescribeImageVersion, +sagemaker:ListAliases +``` + +### Delete +```json +sagemaker:DeleteImageVersion, +sagemaker:DescribeImageVersion +``` + diff --git a/docs/aws-docs/providers/aws/sagemaker/image_versions/index.md b/docs/aws-docs/providers/aws/sagemaker/image_versions/index.md new file mode 100644 index 0000000000..0dca51def1 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/image_versions/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionResource Type definition for AWS::SageMaker::ImageVersion
Idaws.sagemaker.image_versions
+ +## Fields + + + + + +
NameDatatypeDescription
image_version_arnundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +image_version_arn +FROM aws.sagemaker.image_versions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the image_versions resource, the following permissions are required: + +### Create +```json +sagemaker:CreateImageVersion, +sagemaker:DescribeImageVersion +``` + +### List +```json +sagemaker:ListImageVersions +``` + diff --git a/docs/aws-docs/providers/aws/sagemaker/images/index.md b/docs/aws-docs/providers/aws/sagemaker/images/index.md new file mode 100644 index 0000000000..dcda4280d4 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/images/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionResource Type definition for AWS::SageMaker::Image
Idaws.sagemaker.images
+ +## Fields + + + + + +
NameDatatypeDescription
image_arnundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +image_arn +FROM aws.sagemaker.images +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the images resource, the following permissions are required: + +### Create +```json +sagemaker:CreateImage, +sagemaker:DescribeImage, +iam:PassRole, +sagemaker:AddTags, +sagemaker:ListTags +``` + +### List +```json +sagemaker:ListImages +``` + diff --git a/docs/aws-docs/providers/aws/sagemaker/index.md b/docs/aws-docs/providers/aws/sagemaker/index.md new file mode 100644 index 0000000000..57769d9abd --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/sagemaker/inference_component/index.md b/docs/aws-docs/providers/aws/sagemaker/inference_component/index.md new file mode 100644 index 0000000000..4a2336d6d5 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/inference_component/index.md @@ -0,0 +1,117 @@ +--- +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
DescriptionResource Type definition for AWS::SageMaker::InferenceComponent
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.sagemaker.inference_component +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the inference_component resource, the following permissions are required: + +### Update +```json +sagemaker:UpdateInferenceComponent, +sagemaker:UpdateInferenceComponentRuntimeConfig, +sagemaker:DescribeInferenceComponent, +sagemaker:AddTags, +sagemaker:ListTags, +sagemaker:DeleteTags +``` + +### Delete +```json +sagemaker:DescribeInferenceComponent, +sagemaker:DeleteInferenceComponent, +sagemaker:DeleteTags +``` + +### Read +```json +sagemaker:DescribeInferenceComponent, +sagemaker:ListTags +``` + diff --git a/docs/aws-docs/providers/aws/sagemaker/inference_components/index.md b/docs/aws-docs/providers/aws/sagemaker/inference_components/index.md new file mode 100644 index 0000000000..312e49b052 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/inference_components/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionResource Type definition for AWS::SageMaker::InferenceComponent
Idaws.sagemaker.inference_components
+ +## Fields + + + + + +
NameDatatypeDescription
inference_component_arnundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +inference_component_arn +FROM aws.sagemaker.inference_components +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the inference_components resource, the following permissions are required: + +### Create +```json +sagemaker:AddTags, +sagemaker:ListTags, +sagemaker:CreateInferenceComponent, +sagemaker:DescribeInferenceComponent +``` + +### List +```json +sagemaker:ListInferenceComponents, +sagemaker:DescribeInferenceComponent, +sagemaker:ListTags +``` + diff --git a/docs/aws-docs/providers/aws/sagemaker/inference_experiment/index.md b/docs/aws-docs/providers/aws/sagemaker/inference_experiment/index.md new file mode 100644 index 0000000000..caab609721 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/inference_experiment/index.md @@ -0,0 +1,131 @@ +--- +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
DescriptionResource Type definition for AWS::SageMaker::InferenceExperiment
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.sagemaker.inference_experiment +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the inference_experiment resource, the following permissions are required: + +### Delete +```json +sagemaker:DeleteInferenceExperiment, +sagemaker:DescribeInferenceExperiment, +sagemaker:StopInferenceExperiment, +sagemaker:ListTags +``` + +### Read +```json +sagemaker:DescribeInferenceExperiment, +sagemaker:ListTags +``` + +### Update +```json +sagemaker:UpdateInferenceExperiment, +sagemaker:StartInferenceExperiment, +sagemaker:StopInferenceExperiment, +sagemaker:DescribeInferenceExperiment, +sagemaker:AddTags, +sagemaker:DeleteTags, +sagemaker:ListTags +``` + diff --git a/docs/aws-docs/providers/aws/sagemaker/inference_experiments/index.md b/docs/aws-docs/providers/aws/sagemaker/inference_experiments/index.md new file mode 100644 index 0000000000..931dcfb8ca --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/inference_experiments/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionResource Type definition for AWS::SageMaker::InferenceExperiment
Idaws.sagemaker.inference_experiments
+ +## Fields + + + + + +
NameDatatypeDescription
namestringThe name for the inference experiment.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.sagemaker.inference_experiments +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the inference_experiments resource, the following permissions are required: + +### Create +```json +sagemaker:CreateInferenceExperiment, +sagemaker:DescribeInferenceExperiment, +sagemaker:AddTags, +sagemaker:ListTags, +iam:PassRole +``` + +### List +```json +sagemaker:ListInferenceExperiments +``` + diff --git a/docs/aws-docs/providers/aws/sagemaker/model_bias_job_definition/index.md b/docs/aws-docs/providers/aws/sagemaker/model_bias_job_definition/index.md new file mode 100644 index 0000000000..74de093965 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/model_bias_job_definition/index.md @@ -0,0 +1,101 @@ +--- +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
DescriptionResource Type definition for AWS::SageMaker::ModelBiasJobDefinition
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.sagemaker.model_bias_job_definition +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the model_bias_job_definition resource, the following permissions are required: + +### Delete +```json +sagemaker:DeleteModelBiasJobDefinition +``` + +### Read +```json +sagemaker:DescribeModelBiasJobDefinition +``` + diff --git a/docs/aws-docs/providers/aws/sagemaker/model_bias_job_definitions/index.md b/docs/aws-docs/providers/aws/sagemaker/model_bias_job_definitions/index.md new file mode 100644 index 0000000000..d2b104261b --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/model_bias_job_definitions/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionResource Type definition for AWS::SageMaker::ModelBiasJobDefinition
Idaws.sagemaker.model_bias_job_definitions
+ +## Fields + + + + + +
NameDatatypeDescription
job_definition_arnstringThe Amazon Resource Name (ARN) of job definition.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +job_definition_arn +FROM aws.sagemaker.model_bias_job_definitions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the model_bias_job_definitions resource, the following permissions are required: + +### Create +```json +sagemaker:CreateModelBiasJobDefinition, +sagemaker:DescribeModelBiasJobDefinition, +iam:PassRole, +sagemaker:AddTags +``` + +### List +```json +sagemaker:ListModelBiasJobDefinitions, +sagemaker:ListTags +``` + diff --git a/docs/aws-docs/providers/aws/sagemaker/model_card/index.md b/docs/aws-docs/providers/aws/sagemaker/model_card/index.md new file mode 100644 index 0000000000..f673f6dd34 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/model_card/index.md @@ -0,0 +1,128 @@ +--- +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
DescriptionResource Type definition for AWS::SageMaker::ModelCard.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.sagemaker.model_card +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the model_card resource, the following permissions are required: + +### Read +```json +sagemaker:DescribeModelCard, +sagemaker:DescribeModelPackageGroup, +sagemaker:DescribeModelPackage, +kms:Decrypt, +sagemaker:ListTags +``` + +### Update +```json +sagemaker:UpdateModelCard, +sagemaker:DescribeModelCard, +kms:GenerateDataKey, +kms:Decrypt, +sagemaker:DescribeModelPackageGroup, +sagemaker:DescribeModelPackage, +sagemaker:ListTags, +sagemaker:AddTags, +sagemaker:DeleteTags +``` + +### Delete +```json +sagemaker:DescribeModelCard, +sagemaker:DeleteModelCard, +sagemaker:DescribeModelPackageGroup, +sagemaker:DescribeModelPackage, +kms:RetireGrant, +kms:Decrypt, +sagemaker:ListTags, +sagemaker:DeleteTags +``` + diff --git a/docs/aws-docs/providers/aws/sagemaker/model_cards/index.md b/docs/aws-docs/providers/aws/sagemaker/model_cards/index.md new file mode 100644 index 0000000000..c40ef198e4 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/model_cards/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionResource Type definition for AWS::SageMaker::ModelCard.
Idaws.sagemaker.model_cards
+ +## Fields + + + + + +
NameDatatypeDescription
model_card_namestringThe unique name of the model card.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +model_card_name +FROM aws.sagemaker.model_cards +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the model_cards resource, the following permissions are required: + +### Create +```json +sagemaker:CreateModelCard, +kms:DescribeKey, +kms:GenerateDataKey, +kms:CreateGrant, +sagemaker:DescribeModelPackageGroup, +sagemaker:DescribeModelPackage, +sagemaker:AddTags +``` + +### List +```json +sagemaker:ListModelCards, +sagemaker:ListModelCardVersions +``` + diff --git a/docs/aws-docs/providers/aws/sagemaker/model_explainability_job_definition/index.md b/docs/aws-docs/providers/aws/sagemaker/model_explainability_job_definition/index.md new file mode 100644 index 0000000000..e0c6b77c62 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/model_explainability_job_definition/index.md @@ -0,0 +1,101 @@ +--- +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
DescriptionResource Type definition for AWS::SageMaker::ModelExplainabilityJobDefinition
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.sagemaker.model_explainability_job_definition +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the model_explainability_job_definition resource, the following permissions are required: + +### Delete +```json +sagemaker:DeleteModelExplainabilityJobDefinition +``` + +### Read +```json +sagemaker:DescribeModelExplainabilityJobDefinition +``` + diff --git a/docs/aws-docs/providers/aws/sagemaker/model_explainability_job_definitions/index.md b/docs/aws-docs/providers/aws/sagemaker/model_explainability_job_definitions/index.md new file mode 100644 index 0000000000..10701a5a44 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/model_explainability_job_definitions/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionResource Type definition for AWS::SageMaker::ModelExplainabilityJobDefinition
Idaws.sagemaker.model_explainability_job_definitions
+ +## Fields + + + + + +
NameDatatypeDescription
job_definition_arnstringThe Amazon Resource Name (ARN) of job definition.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +job_definition_arn +FROM aws.sagemaker.model_explainability_job_definitions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the model_explainability_job_definitions resource, the following permissions are required: + +### Create +```json +sagemaker:CreateModelExplainabilityJobDefinition, +sagemaker:DescribeModelExplainabilityJobDefinition, +iam:PassRole, +sagemaker:AddTags +``` + +### List +```json +sagemaker:ListModelExplainabilityJobDefinitions, +sagemaker:ListTags +``` + diff --git a/docs/aws-docs/providers/aws/sagemaker/model_package/index.md b/docs/aws-docs/providers/aws/sagemaker/model_package/index.md new file mode 100644 index 0000000000..d44f104959 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/model_package/index.md @@ -0,0 +1,145 @@ +--- +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
DescriptionResource Type definition for AWS::SageMaker::ModelPackage
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.sagemaker.model_package +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the model_package resource, the following permissions are required: + +### Read +```json +sagemaker:DescribeModelPackage, +sagemaker:ListTags +``` + +### Update +```json +sagemaker:UpdateModelPackage, +sagemaker:DescribeModelPackage, +sagemaker:ListTags, +sagemaker:AddTags, +sagemaker:DeleteTags +``` + +### Delete +```json +sagemaker:DeleteModelPackage, +sagemaker:DescribeModelPackage +``` + diff --git a/docs/aws-docs/providers/aws/sagemaker/model_package_group/index.md b/docs/aws-docs/providers/aws/sagemaker/model_package_group/index.md new file mode 100644 index 0000000000..525eea87cc --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/model_package_group/index.md @@ -0,0 +1,111 @@ +--- +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
DescriptionResource Type definition for AWS::SageMaker::ModelPackageGroup
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.sagemaker.model_package_group +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the model_package_group resource, the following permissions are required: + +### Delete +```json +sagemaker:DeleteModelPackageGroup, +sagemaker:DescribeModelPackageGroup, +sagemaker:GetModelPackageGroupPolicy, +sagemaker:DeleteModelPackageGroupPolicy +``` + +### Read +```json +sagemaker:DescribeModelPackageGroup, +sagemaker:GetModelPackageGroupPolicy, +sagemaker:PutModelPackageGroupPolicy, +sagemaker:ListTags +``` + +### Update +```json +sagemaker:DescribeModelPackageGroup, +sagemaker:GetModelPackageGroupPolicy, +sagemaker:DeleteModelPackageGroupPolicy, +sagemaker:PutModelPackageGroupPolicy, +sagemaker:ListTags, +sagemaker:AddTags, +sagemaker:DeleteTags +``` + diff --git a/docs/aws-docs/providers/aws/sagemaker/model_package_groups/index.md b/docs/aws-docs/providers/aws/sagemaker/model_package_groups/index.md new file mode 100644 index 0000000000..206ef29a94 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/model_package_groups/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionResource Type definition for AWS::SageMaker::ModelPackageGroup
Idaws.sagemaker.model_package_groups
+ +## Fields + + + + + +
NameDatatypeDescription
model_package_group_arnundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +model_package_group_arn +FROM aws.sagemaker.model_package_groups +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the model_package_groups resource, the following permissions are required: + +### Create +```json +sagemaker:CreateModelPackageGroup, +sagemaker:DescribeModelPackageGroup, +sagemaker:GetModelPackageGroupPolicy, +sagemaker:PutModelPackageGroupPolicy, +sagemaker:ListTags, +sagemaker:AddTags +``` + +### List +```json +sagemaker:ListModelPackageGroups +``` + diff --git a/docs/aws-docs/providers/aws/sagemaker/model_packages/index.md b/docs/aws-docs/providers/aws/sagemaker/model_packages/index.md new file mode 100644 index 0000000000..0b8c9946ec --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/model_packages/index.md @@ -0,0 +1,90 @@ +--- +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
DescriptionResource Type definition for AWS::SageMaker::ModelPackage
Idaws.sagemaker.model_packages
+ +## Fields + + + + + +
NameDatatypeDescription
model_package_arnundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +model_package_arn +FROM aws.sagemaker.model_packages +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the model_packages resource, the following permissions are required: + +### Create +```json +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 +```json +sagemaker:ListModelPackages +``` + diff --git a/docs/aws-docs/providers/aws/sagemaker/model_quality_job_definition/index.md b/docs/aws-docs/providers/aws/sagemaker/model_quality_job_definition/index.md new file mode 100644 index 0000000000..9386fb2183 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/model_quality_job_definition/index.md @@ -0,0 +1,101 @@ +--- +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
DescriptionResource Type definition for AWS::SageMaker::ModelQualityJobDefinition
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.sagemaker.model_quality_job_definition +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the model_quality_job_definition resource, the following permissions are required: + +### Delete +```json +sagemaker:DeleteModelQualityJobDefinition +``` + +### Read +```json +sagemaker:DescribeModelQualityJobDefinition +``` + diff --git a/docs/aws-docs/providers/aws/sagemaker/model_quality_job_definitions/index.md b/docs/aws-docs/providers/aws/sagemaker/model_quality_job_definitions/index.md new file mode 100644 index 0000000000..a3306d313a --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/model_quality_job_definitions/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionResource Type definition for AWS::SageMaker::ModelQualityJobDefinition
Idaws.sagemaker.model_quality_job_definitions
+ +## Fields + + + + + +
NameDatatypeDescription
job_definition_arnstringThe Amazon Resource Name (ARN) of job definition.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +job_definition_arn +FROM aws.sagemaker.model_quality_job_definitions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the model_quality_job_definitions resource, the following permissions are required: + +### Create +```json +sagemaker:CreateModelQualityJobDefinition, +sagemaker:DescribeModelQualityJobDefinition, +sagemaker:AddTags, +iam:PassRole +``` + +### List +```json +sagemaker:ListModelQualityJobDefinitions, +sagemaker:ListTags +``` + diff --git a/docs/aws-docs/providers/aws/sagemaker/monitoring_schedule/index.md b/docs/aws-docs/providers/aws/sagemaker/monitoring_schedule/index.md new file mode 100644 index 0000000000..be2da2df28 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/monitoring_schedule/index.md @@ -0,0 +1,107 @@ +--- +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
DescriptionResource Type definition for AWS::SageMaker::MonitoringSchedule
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.sagemaker.monitoring_schedule +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the monitoring_schedule resource, the following permissions are required: + +### Delete +```json +sagemaker:DeleteMonitoringSchedule, +sagemaker:DescribeMonitoringSchedule +``` + +### Read +```json +sagemaker:DescribeMonitoringSchedule +``` + +### Update +```json +sagemaker:UpdateMonitoringSchedule, +sagemaker:DescribeMonitoringSchedule +``` + diff --git a/docs/aws-docs/providers/aws/sagemaker/monitoring_schedules/index.md b/docs/aws-docs/providers/aws/sagemaker/monitoring_schedules/index.md new file mode 100644 index 0000000000..a23a2976bd --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/monitoring_schedules/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource Type definition for AWS::SageMaker::MonitoringSchedule
Idaws.sagemaker.monitoring_schedules
+ +## Fields + + + + + +
NameDatatypeDescription
monitoring_schedule_arnstringThe Amazon Resource Name (ARN) of the monitoring schedule.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +monitoring_schedule_arn +FROM aws.sagemaker.monitoring_schedules +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the monitoring_schedules resource, the following permissions are required: + +### Create +```json +sagemaker:CreateMonitoringSchedule, +sagemaker:DescribeMonitoringSchedule, +iam:PassRole +``` + +### List +```json +sagemaker:ListMonitoringSchedule +``` + diff --git a/docs/aws-docs/providers/aws/sagemaker/pipeline/index.md b/docs/aws-docs/providers/aws/sagemaker/pipeline/index.md new file mode 100644 index 0000000000..d15c0b78ce --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/pipeline/index.md @@ -0,0 +1,106 @@ +--- +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
DescriptionResource Type definition for AWS::SageMaker::Pipeline
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +pipeline_name, +pipeline_display_name, +pipeline_description, +pipeline_definition, +role_arn, +tags, +parallelism_configuration +FROM aws.sagemaker.pipeline +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the pipeline resource, the following permissions are required: + +### Read +```json +sagemaker:DescribePipeline, +sagemaker:ListTags +``` + +### Update +```json +iam:PassRole, +s3:GetObject, +sagemaker:UpdatePipeline, +sagemaker:DescribePipeline, +sagemaker:AddTags, +sagemaker:DeleteTags, +sagemaker:ListTags +``` + +### Delete +```json +sagemaker:DeletePipeline +``` + diff --git a/docs/aws-docs/providers/aws/sagemaker/pipelines/index.md b/docs/aws-docs/providers/aws/sagemaker/pipelines/index.md new file mode 100644 index 0000000000..a9bdd642b5 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/pipelines/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionResource Type definition for AWS::SageMaker::Pipeline
Idaws.sagemaker.pipelines
+ +## Fields + + + + + +
NameDatatypeDescription
pipeline_namestringThe name of the Pipeline.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +pipeline_name +FROM aws.sagemaker.pipelines +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the pipelines resource, the following permissions are required: + +### Create +```json +iam:PassRole, +s3:GetObject, +sagemaker:CreatePipeline, +sagemaker:DescribePipeline, +sagemaker:AddTags, +sagemaker:ListTags +``` + +### List +```json +sagemaker:ListPipelines +``` + diff --git a/docs/aws-docs/providers/aws/sagemaker/project/index.md b/docs/aws-docs/providers/aws/sagemaker/project/index.md new file mode 100644 index 0000000000..f39b7673c0 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/project/index.md @@ -0,0 +1,110 @@ +--- +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
DescriptionResource Type definition for AWS::SageMaker::Project
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.sagemaker.project +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the project resource, the following permissions are required: + +### Read +```json +sagemaker:DescribeProject, +sagemaker:ListTags +``` + +### Update +```json +sagemaker:DescribeProject, +sagemaker:ListTags, +sagemaker:AddTags, +sagemaker:DeleteTags +``` + +### Delete +```json +sagemaker:DeleteProject, +sagemaker:DescribeProject, +servicecatalog:TerminateProvisionedProduct, +servicecatalog:DescribeRecord +``` + diff --git a/docs/aws-docs/providers/aws/sagemaker/projects/index.md b/docs/aws-docs/providers/aws/sagemaker/projects/index.md new file mode 100644 index 0000000000..7b9d33accc --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/projects/index.md @@ -0,0 +1,85 @@ +--- +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
DescriptionResource Type definition for AWS::SageMaker::Project
Idaws.sagemaker.projects
+ +## Fields + + + + + +
NameDatatypeDescription
project_arnundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +project_arn +FROM aws.sagemaker.projects +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the projects resource, the following permissions are required: + +### Create +```json +sagemaker:AddTags, +sagemaker:CreateProject, +sagemaker:DescribeProject, +sagemaker:ListTags, +servicecatalog:DescribeProduct, +servicecatalog:DescribeProvisioningArtifact, +servicecatalog:ProvisionProduct, +servicecatalog:DescribeProvisionedProduct, +servicecatalog:TerminateProvisionedProduct +``` + +### List +```json +sagemaker:ListProjects +``` + diff --git a/docs/aws-docs/providers/aws/sagemaker/space/index.md b/docs/aws-docs/providers/aws/sagemaker/space/index.md new file mode 100644 index 0000000000..a14d5ad787 --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/space/index.md @@ -0,0 +1,105 @@ +--- +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
DescriptionResource Type definition for AWS::SageMaker::Space
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +space_arn, +domain_id, +space_name, +space_settings, +tags, +ownership_settings, +space_sharing_settings, +space_display_name, +url +FROM aws.sagemaker.space +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the space resource, the following permissions are required: + +### Read +```json +sagemaker:DescribeSpace +``` + +### Update +```json +sagemaker:UpdateSpace, +sagemaker:DescribeSpace +``` + +### Delete +```json +sagemaker:DeleteSpace, +sagemaker:DescribeSpace +``` + diff --git a/docs/aws-docs/providers/aws/sagemaker/spaces/index.md b/docs/aws-docs/providers/aws/sagemaker/spaces/index.md new file mode 100644 index 0000000000..795aa079af --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/spaces/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionResource Type definition for AWS::SageMaker::Space
Idaws.sagemaker.spaces
+ +## Fields + + + + + + +
NameDatatypeDescription
domain_idstringThe ID of the associated Domain.
space_namestringA name for the Space.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +domain_id, +space_name +FROM aws.sagemaker.spaces +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the spaces resource, the following permissions are required: + +### Create +```json +sagemaker:CreateSpace, +sagemaker:DescribeSpace +``` + +### List +```json +sagemaker:ListSpaces +``` + diff --git a/docs/aws-docs/providers/aws/sagemaker/user_profile/index.md b/docs/aws-docs/providers/aws/sagemaker/user_profile/index.md new file mode 100644 index 0000000000..34fcf77c5e --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/user_profile/index.md @@ -0,0 +1,104 @@ +--- +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
DescriptionResource Type definition for AWS::SageMaker::UserProfile
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.sagemaker.user_profile +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the user_profile resource, the following permissions are required: + +### Read +```json +sagemaker:DescribeUserProfile +``` + +### Update +```json +sagemaker:UpdateUserProfile, +sagemaker:DescribeUserProfile, +sagemaker:DescribeImage, +sagemaker:DescribeImageVersion, +iam:PassRole +``` + +### Delete +```json +sagemaker:DeleteUserProfile, +sagemaker:DescribeUserProfile +``` + diff --git a/docs/aws-docs/providers/aws/sagemaker/user_profiles/index.md b/docs/aws-docs/providers/aws/sagemaker/user_profiles/index.md new file mode 100644 index 0000000000..22a026efeb --- /dev/null +++ b/docs/aws-docs/providers/aws/sagemaker/user_profiles/index.md @@ -0,0 +1,83 @@ +--- +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
DescriptionResource Type definition for AWS::SageMaker::UserProfile
Idaws.sagemaker.user_profiles
+ +## Fields + + + + + + +
NameDatatypeDescription
user_profile_namestringA name for the UserProfile.
domain_idstringThe ID of the associated Domain.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +user_profile_name, +domain_id +FROM aws.sagemaker.user_profiles +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the user_profiles resource, the following permissions are required: + +### Create +```json +sagemaker:CreateUserProfile, +sagemaker:DescribeUserProfile, +sagemaker:DescribeImage, +sagemaker:DescribeImageVersion, +iam:PassRole +``` + +### List +```json +sagemaker:ListUserProfiles +``` + diff --git a/docs/aws-docs/providers/aws/scheduler/index.md b/docs/aws-docs/providers/aws/scheduler/index.md new file mode 100644 index 0000000000..8ddeacc154 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/scheduler/schedule/index.md b/docs/aws-docs/providers/aws/scheduler/schedule/index.md new file mode 100644 index 0000000000..32a08eb409 --- /dev/null +++ b/docs/aws-docs/providers/aws/scheduler/schedule/index.md @@ -0,0 +1,112 @@ +--- +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
DescriptionDefinition of AWS::Scheduler::Schedule Resource Type
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.scheduler.schedule +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the schedule resource, the following permissions are required: + +### Read +```json +scheduler:GetSchedule +``` + +### Update +```json +scheduler:UpdateSchedule, +scheduler:GetSchedule, +iam:PassRole +``` + +### Delete +```json +scheduler:DeleteSchedule, +scheduler:GetSchedule +``` + diff --git a/docs/aws-docs/providers/aws/scheduler/schedule_group/index.md b/docs/aws-docs/providers/aws/scheduler/schedule_group/index.md new file mode 100644 index 0000000000..cc713a51a7 --- /dev/null +++ b/docs/aws-docs/providers/aws/scheduler/schedule_group/index.md @@ -0,0 +1,103 @@ +--- +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
DescriptionDefinition of AWS::Scheduler::ScheduleGroup Resource Type
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +creation_date, +last_modification_date, +name, +state, +tags +FROM aws.scheduler.schedule_group +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the schedule_group resource, the following permissions are required: + +### Read +```json +scheduler:GetScheduleGroup, +scheduler:ListTagsForResource +``` + +### Update +```json +scheduler:TagResource, +scheduler:UntagResource, +scheduler:ListTagsForResource, +scheduler:GetScheduleGroup +``` + +### Delete +```json +scheduler:DeleteScheduleGroup, +scheduler:GetScheduleGroup, +scheduler:DeleteSchedule +``` + diff --git a/docs/aws-docs/providers/aws/scheduler/schedule_groups/index.md b/docs/aws-docs/providers/aws/scheduler/schedule_groups/index.md new file mode 100644 index 0000000000..50bf75c47d --- /dev/null +++ b/docs/aws-docs/providers/aws/scheduler/schedule_groups/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionDefinition of AWS::Scheduler::ScheduleGroup Resource Type
Idaws.scheduler.schedule_groups
+ +## Fields + + + + + +
NameDatatypeDescription
namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.scheduler.schedule_groups +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the schedule_groups resource, the following permissions are required: + +### Create +```json +scheduler:TagResource, +scheduler:CreateScheduleGroup, +scheduler:GetScheduleGroup, +scheduler:ListTagsForResource +``` + +### List +```json +scheduler:ListScheduleGroups +``` + diff --git a/docs/aws-docs/providers/aws/scheduler/schedules/index.md b/docs/aws-docs/providers/aws/scheduler/schedules/index.md new file mode 100644 index 0000000000..658c7ade7b --- /dev/null +++ b/docs/aws-docs/providers/aws/scheduler/schedules/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionDefinition of AWS::Scheduler::Schedule Resource Type
Idaws.scheduler.schedules
+ +## Fields + + + + + +
NameDatatypeDescription
namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.scheduler.schedules +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the schedules resource, the following permissions are required: + +### Create +```json +scheduler:CreateSchedule, +scheduler:GetSchedule, +iam:PassRole +``` + +### List +```json +scheduler:ListSchedules +``` + diff --git a/docs/aws-docs/providers/aws/secretsmanager/index.md b/docs/aws-docs/providers/aws/secretsmanager/index.md new file mode 100644 index 0000000000..6616000ad2 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/secretsmanager/secret/index.md b/docs/aws-docs/providers/aws/secretsmanager/secret/index.md new file mode 100644 index 0000000000..c83268b55e --- /dev/null +++ b/docs/aws-docs/providers/aws/secretsmanager/secret/index.md @@ -0,0 +1,110 @@ +--- +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
DescriptionCreates a new secret. A *secret* can be a password, a set of credentials such as a user name and password, an OAuth token, or other secret information that you store in an encrypted form in Secrets Manager.<br/> For RDS master user credentials, see [AWS::RDS::DBCluster MasterUserSecret](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-masterusersecret.html).<br/> To retrieve a secret in a CFNshort template, use a *dynamic reference*. For more information, see [Retrieve a secret in an resource](https://docs.aws.amazon.com/secretsmanager/latest/userguide/cfn-example_reference-secret.html).<br/> A common scenario is to first create a secret with ``GenerateSecretString``, which generates a password, and then use a dynamic reference to retrieve the username and password from the secret to use as credentials for a new database. See the example *Creating a Redshift cluster and a secret for the admin credentials*.<br/> For information about creating a secret in the console, see [Create a secret](https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_create-basic-secret.html). For information about creating a secret using the CLI or SDK, see [CreateSecret](https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_CreateSecret.html).<br/> For information about retrieving a secret in code, see [Retrieve secrets from Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieving-secrets.html).
Idaws.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.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#auth-and-access_tags2).<br/> For information about how to format a JSON parameter for the various command line tool environments, see [Using JSON for Parameters](https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json). If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.<br/> The following restrictions apply to tags:<br/> + Maximum number of tags per secret: 50<br/> + Maximum key length: 127 Unicode characters in UTF-8<br/> + Maximum value length: 255 Unicode characters in UTF-8<br/> + Tag keys and values are case sensitive.<br/> + Do not use the ``aws:`` prefix in your tag names or values because AWS reserves it for AWS use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.<br/> + If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +description, +kms_key_id, +secret_string, +generate_secret_string, +replica_regions, +id, +tags, +name +FROM aws.secretsmanager.secret +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the secret resource, the following permissions are required: + +### Delete +```json +secretsmanager:DeleteSecret, +secretsmanager:DescribeSecret, +secretsmanager:RemoveRegionsFromReplication +``` + +### Read +```json +secretsmanager:DescribeSecret, +secretsmanager:GetSecretValue +``` + +### Update +```json +secretsmanager:UpdateSecret, +secretsmanager:TagResource, +secretsmanager:UntagResource, +secretsmanager:GetRandomPassword, +secretsmanager:GetSecretValue, +secretsmanager:ReplicateSecretToRegions, +secretsmanager:RemoveRegionsFromReplication +``` + diff --git a/docs/aws-docs/providers/aws/secretsmanager/secrets/index.md b/docs/aws-docs/providers/aws/secretsmanager/secrets/index.md new file mode 100644 index 0000000000..adcbd050da --- /dev/null +++ b/docs/aws-docs/providers/aws/secretsmanager/secrets/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionCreates a new secret. A *secret* can be a password, a set of credentials such as a user name and password, an OAuth token, or other secret information that you store in an encrypted form in Secrets Manager.<br/> For RDS master user credentials, see [AWS::RDS::DBCluster MasterUserSecret](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-masterusersecret.html).<br/> To retrieve a secret in a CFNshort template, use a *dynamic reference*. For more information, see [Retrieve a secret in an resource](https://docs.aws.amazon.com/secretsmanager/latest/userguide/cfn-example_reference-secret.html).<br/> A common scenario is to first create a secret with ``GenerateSecretString``, which generates a password, and then use a dynamic reference to retrieve the username and password from the secret to use as credentials for a new database. See the example *Creating a Redshift cluster and a secret for the admin credentials*.<br/> For information about creating a secret in the console, see [Create a secret](https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_create-basic-secret.html). For information about creating a secret using the CLI or SDK, see [CreateSecret](https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_CreateSecret.html).<br/> For information about retrieving a secret in code, see [Retrieve secrets from Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieving-secrets.html).
Idaws.secretsmanager.secrets
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.secretsmanager.secrets +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the secrets resource, the following permissions are required: + +### Create +```json +secretsmanager:DescribeSecret, +secretsmanager:GetRandomPassword, +secretsmanager:CreateSecret, +secretsmanager:TagResource +``` + +### List +```json +secretsmanager:ListSecrets +``` + diff --git a/docs/aws-docs/providers/aws/securityhub/automation_rule/index.md b/docs/aws-docs/providers/aws/securityhub/automation_rule/index.md new file mode 100644 index 0000000000..d342795080 --- /dev/null +++ b/docs/aws-docs/providers/aws/securityhub/automation_rule/index.md @@ -0,0 +1,115 @@ +--- +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
DescriptionThe ``AWS::SecurityHub::AutomationRule`` resource specifies an automation rule based on input parameters. For more information, see [Automation rules](https://docs.aws.amazon.com/securityhub/latest/userguide/automation-rules.html) in the *User Guide*.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.securityhub.automation_rule +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the automation_rule resource, the following permissions are required: + +### Read +```json +securityhub:ListAutomationRules, +securityhub:BatchGetAutomationRules, +securityhub:ListTagsForResource +``` + +### Update +```json +securityhub:BatchUpdateAutomationRules, +securityhub:TagResource, +securityhub:UntagResource, +securityhub:ListTagsForResource +``` + +### Delete +```json +securityhub:BatchDeleteAutomationRules, +securityhub:BatchGetAutomationRules +``` + diff --git a/docs/aws-docs/providers/aws/securityhub/automation_rules/index.md b/docs/aws-docs/providers/aws/securityhub/automation_rules/index.md new file mode 100644 index 0000000000..77d0fe9b5b --- /dev/null +++ b/docs/aws-docs/providers/aws/securityhub/automation_rules/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionThe ``AWS::SecurityHub::AutomationRule`` resource specifies an automation rule based on input parameters. For more information, see [Automation rules](https://docs.aws.amazon.com/securityhub/latest/userguide/automation-rules.html) in the *User Guide*.
Idaws.securityhub.automation_rules
+ +## Fields + + + + + +
NameDatatypeDescription
rule_arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +rule_arn +FROM aws.securityhub.automation_rules +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the automation_rules resource, the following permissions are required: + +### Create +```json +securityhub:CreateAutomationRule, +securityhub:TagResource, +securityhub:ListTagsForResource +``` + +### List +```json +securityhub:ListAutomationRules, +securityhub:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/securityhub/delegated_admin/index.md b/docs/aws-docs/providers/aws/securityhub/delegated_admin/index.md new file mode 100644 index 0000000000..4ba58f6f95 --- /dev/null +++ b/docs/aws-docs/providers/aws/securityhub/delegated_admin/index.md @@ -0,0 +1,83 @@ +--- +title: delegated_admin +hide_title: false +hide_table_of_contents: false +keywords: + - delegated_admin + - 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 delegated_admin resource + +## Overview + + + + + +
Namedelegated_admin
TypeResource
DescriptionThe AWS::SecurityHub::DelegatedAdmin resource represents the AWS Security Hub delegated admin account in your organization. One delegated admin resource is allowed to create for the organization in each region in which you configure the AdminAccountId.
Idaws.securityhub.delegated_admin
+ +## Fields + + + + + + + +
NameDatatypeDescription
delegated_admin_identifierstringThe identifier of the DelegatedAdmin being created and assigned as the unique identifier
admin_account_idstringThe Amazon Web Services account identifier of the account to designate as the Security Hub administrator account
statusstringThe current status of the Security Hub administrator account. Indicates whether the account is currently enabled as a Security Hub administrator
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +delegated_admin_identifier, +admin_account_id, +status +FROM aws.securityhub.delegated_admin +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the delegated_admin resource, the following permissions are required: + +### Read +```json +securityhub:ListOrganizationAdminAccounts, +organizations:DescribeOrganization +``` + +### Delete +```json +securityhub:DisableOrganizationAdminAccount, +organizations:DescribeOrganization +``` + diff --git a/docs/aws-docs/providers/aws/securityhub/delegated_admins/index.md b/docs/aws-docs/providers/aws/securityhub/delegated_admins/index.md new file mode 100644 index 0000000000..ccafd0c9a9 --- /dev/null +++ b/docs/aws-docs/providers/aws/securityhub/delegated_admins/index.md @@ -0,0 +1,81 @@ +--- +title: delegated_admins +hide_title: false +hide_table_of_contents: false +keywords: + - delegated_admins + - 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 delegated_admins in a region + +## Overview + + + + + +
Namedelegated_admins
TypeResource
DescriptionThe AWS::SecurityHub::DelegatedAdmin resource represents the AWS Security Hub delegated admin account in your organization. One delegated admin resource is allowed to create for the organization in each region in which you configure the AdminAccountId.
Idaws.securityhub.delegated_admins
+ +## Fields + + + + + +
NameDatatypeDescription
delegated_admin_identifierstringThe identifier of the DelegatedAdmin being created and assigned as the unique identifier
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +delegated_admin_identifier +FROM aws.securityhub.delegated_admins +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the delegated_admins resource, the following permissions are required: + +### Create +```json +securityhub:EnableOrganizationAdminAccount, +organizations:DescribeOrganization, +organizations:EnableAWSServiceAccess, +organizations:RegisterDelegatedAdministrator +``` + +### List +```json +securityhub:ListOrganizationAdminAccounts, +organizations:DescribeOrganization +``` + diff --git a/docs/aws-docs/providers/aws/securityhub/hub/index.md b/docs/aws-docs/providers/aws/securityhub/hub/index.md new file mode 100644 index 0000000000..9ff2c7b636 --- /dev/null +++ b/docs/aws-docs/providers/aws/securityhub/hub/index.md @@ -0,0 +1,102 @@ +--- +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
DescriptionThe AWS::SecurityHub::Hub resource represents the implementation of the AWS Security Hub service in your account. One hub resource is created for each Region in which you enable Security Hub.<br/><br/>
Idaws.securityhub.hub
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
arnstringAn 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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +enable_default_standards, +control_finding_generator, +auto_enable_controls, +tags, +subscribed_at +FROM aws.securityhub.hub +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the hub resource, the following permissions are required: + +### Read +```json +securityhub:DescribeHub, +securityhub:ListTagsForResource +``` + +### Update +```json +securityhub:DescribeHub, +securityhub:UpdateSecurityHubConfiguration, +securityhub:TagResource, +securityhub:UntagResource, +securityhub:ListTagsForResource +``` + +### Delete +```json +securityhub:DisableSecurityHub +``` + diff --git a/docs/aws-docs/providers/aws/securityhub/hubs/index.md b/docs/aws-docs/providers/aws/securityhub/hubs/index.md new file mode 100644 index 0000000000..78af717c64 --- /dev/null +++ b/docs/aws-docs/providers/aws/securityhub/hubs/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionThe AWS::SecurityHub::Hub resource represents the implementation of the AWS Security Hub service in your account. One hub resource is created for each Region in which you enable Security Hub.<br/><br/>
Idaws.securityhub.hubs
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringAn ARN is automatically created for the customer.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.securityhub.hubs +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the hubs resource, the following permissions are required: + +### Create +```json +securityhub:EnableSecurityHub, +securityhub:UpdateSecurityHubConfiguration, +securityhub:TagResource, +securityhub:ListTagsForResource +``` + +### List +```json +securityhub:DescribeHub, +securityhub:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/securityhub/index.md b/docs/aws-docs/providers/aws/securityhub/index.md new file mode 100644 index 0000000000..dab09e0f47 --- /dev/null +++ b/docs/aws-docs/providers/aws/securityhub/index.md @@ -0,0 +1,49 @@ +--- +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: 12
+total selectable resources: 12
+total methods: 12
+
+
+ +::: + +## Resources +
+
+automation_rule
+automation_rules
+delegated_admin
+delegated_admins
+hub
+hubs +
+
+insight
+insights
+product_subscription
+product_subscriptions
+standard
+standards +
+
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/securityhub/insight/index.md b/docs/aws-docs/providers/aws/securityhub/insight/index.md new file mode 100644 index 0000000000..4267036d10 --- /dev/null +++ b/docs/aws-docs/providers/aws/securityhub/insight/index.md @@ -0,0 +1,94 @@ +--- +title: insight +hide_title: false +hide_table_of_contents: false +keywords: + - insight + - 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 insight resource + +## Overview + + + + + +
Nameinsight
TypeResource
DescriptionThe AWS::SecurityHub::Insight resource represents the AWS Security Hub Insight in your account. An AWS Security Hub insight is a collection of related findings.
Idaws.securityhub.insight
+ +## Fields + + + + + + + + +
NameDatatypeDescription
insight_arnstringThe ARN of a Security Hub insight
namestringThe name of a Security Hub insight
filtersobjectOne or more attributes used to filter the findings included in the insight
group_by_attributestringThe grouping attribute for the insight's findings
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +insight_arn, +name, +filters, +group_by_attribute +FROM aws.securityhub.insight +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the insight resource, the following permissions are required: + +### Read +```json +securityhub:GetInsights +``` + +### Update +```json +securityhub:UpdateInsight +``` + +### Delete +```json +securityhub:GetInsights, +securityhub:DeleteInsight +``` + diff --git a/docs/aws-docs/providers/aws/securityhub/insights/index.md b/docs/aws-docs/providers/aws/securityhub/insights/index.md new file mode 100644 index 0000000000..26c6a430ed --- /dev/null +++ b/docs/aws-docs/providers/aws/securityhub/insights/index.md @@ -0,0 +1,77 @@ +--- +title: insights +hide_title: false +hide_table_of_contents: false +keywords: + - insights + - 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 insights in a region + +## Overview + + + + + +
Nameinsights
TypeResource
DescriptionThe AWS::SecurityHub::Insight resource represents the AWS Security Hub Insight in your account. An AWS Security Hub insight is a collection of related findings.
Idaws.securityhub.insights
+ +## Fields + + + + + +
NameDatatypeDescription
insight_arnstringThe ARN of a Security Hub insight
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +insight_arn +FROM aws.securityhub.insights +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the insights resource, the following permissions are required: + +### Create +```json +securityhub:CreateInsight +``` + +### List +```json +securityhub:GetInsights +``` + diff --git a/docs/aws-docs/providers/aws/securityhub/product_subscription/index.md b/docs/aws-docs/providers/aws/securityhub/product_subscription/index.md new file mode 100644 index 0000000000..6b7994e2cd --- /dev/null +++ b/docs/aws-docs/providers/aws/securityhub/product_subscription/index.md @@ -0,0 +1,80 @@ +--- +title: product_subscription +hide_title: false +hide_table_of_contents: false +keywords: + - product_subscription + - 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 product_subscription resource + +## Overview + + + + + +
Nameproduct_subscription
TypeResource
DescriptionThe AWS::SecurityHub::ProductSubscription resource represents a subscription to a service that is allowed to generate findings for your Security Hub account. One product subscription resource is created for each product enabled.
Idaws.securityhub.product_subscription
+ +## Fields + + + + + + +
NameDatatypeDescription
product_arnstringThe generic ARN of the product being subscribed to
product_subscription_arnstringThe ARN of the product subscription for the account
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +product_arn, +product_subscription_arn +FROM aws.securityhub.product_subscription +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the product_subscription resource, the following permissions are required: + +### Read +```json +securityhub:ListEnabledProductsForImport +``` + +### Delete +```json +securityhub:ListEnabledProductsForImport, +securityhub:DisableImportFindingsForProduct +``` + diff --git a/docs/aws-docs/providers/aws/securityhub/product_subscriptions/index.md b/docs/aws-docs/providers/aws/securityhub/product_subscriptions/index.md new file mode 100644 index 0000000000..d08e51783b --- /dev/null +++ b/docs/aws-docs/providers/aws/securityhub/product_subscriptions/index.md @@ -0,0 +1,77 @@ +--- +title: product_subscriptions +hide_title: false +hide_table_of_contents: false +keywords: + - product_subscriptions + - 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 product_subscriptions in a region + +## Overview + + + + + +
Nameproduct_subscriptions
TypeResource
DescriptionThe AWS::SecurityHub::ProductSubscription resource represents a subscription to a service that is allowed to generate findings for your Security Hub account. One product subscription resource is created for each product enabled.
Idaws.securityhub.product_subscriptions
+ +## Fields + + + + + +
NameDatatypeDescription
product_subscription_arnstringThe ARN of the product subscription for the account
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +product_subscription_arn +FROM aws.securityhub.product_subscriptions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the product_subscriptions resource, the following permissions are required: + +### Create +```json +securityhub:EnableImportFindingsForProduct +``` + +### List +```json +securityhub:ListEnabledProductsForImport +``` + diff --git a/docs/aws-docs/providers/aws/securityhub/standard/index.md b/docs/aws-docs/providers/aws/securityhub/standard/index.md new file mode 100644 index 0000000000..46a99a0545 --- /dev/null +++ b/docs/aws-docs/providers/aws/securityhub/standard/index.md @@ -0,0 +1,94 @@ +--- +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
DescriptionThe ``AWS::SecurityHub::Standard`` resource specifies the enablement of a security standard. The standard is identified by the ``StandardsArn`` property. To view a list of ASH standards and their Amazon Resource Names (ARNs), use the [DescribeStandards](https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_DescribeStandards.html) API operation.<br/> You must create a separate ``AWS::SecurityHub::Standard`` resource for each standard that you want to enable.<br/> For more information about ASH standards, see [standards reference](https://docs.aws.amazon.com/securityhub/latest/userguide/standards-reference.html) in the *User Guide*.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +standards_subscription_arn, +standards_arn, +disabled_standards_controls +FROM aws.securityhub.standard +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the standard resource, the following permissions are required: + +### Read +```json +securityhub:GetEnabledStandards, +securityhub:DescribeStandardsControls +``` + +### Update +```json +securityhub:GetEnabledStandards, +securityhub:UpdateStandardsControl +``` + +### Delete +```json +securityhub:GetEnabledStandards, +securityhub:BatchDisableStandards +``` + diff --git a/docs/aws-docs/providers/aws/securityhub/standards/index.md b/docs/aws-docs/providers/aws/securityhub/standards/index.md new file mode 100644 index 0000000000..25d8856b6b --- /dev/null +++ b/docs/aws-docs/providers/aws/securityhub/standards/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionThe ``AWS::SecurityHub::Standard`` resource specifies the enablement of a security standard. The standard is identified by the ``StandardsArn`` property. To view a list of ASH standards and their Amazon Resource Names (ARNs), use the [DescribeStandards](https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_DescribeStandards.html) API operation.<br/> You must create a separate ``AWS::SecurityHub::Standard`` resource for each standard that you want to enable.<br/> For more information about ASH standards, see [standards reference](https://docs.aws.amazon.com/securityhub/latest/userguide/standards-reference.html) in the *User Guide*.
Idaws.securityhub.standards
+ +## Fields + + + + + +
NameDatatypeDescription
standards_subscription_arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +standards_subscription_arn +FROM aws.securityhub.standards +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the standards resource, the following permissions are required: + +### Create +```json +securityhub:GetEnabledStandards, +securityhub:BatchEnableStandards, +securityhub:UpdateStandardsControl +``` + +### List +```json +securityhub:GetEnabledStandards +``` + diff --git a/docs/aws-docs/providers/aws/securitylake/data_lake/index.md b/docs/aws-docs/providers/aws/securitylake/data_lake/index.md new file mode 100644 index 0000000000..097cce64cc --- /dev/null +++ b/docs/aws-docs/providers/aws/securitylake/data_lake/index.md @@ -0,0 +1,117 @@ +--- +title: data_lake +hide_title: false +hide_table_of_contents: false +keywords: + - data_lake + - securitylake + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual data_lake resource + +## Overview + + + + + +
Namedata_lake
TypeResource
DescriptionResource Type definition for AWS::SecurityLake::DataLake
Idaws.securitylake.data_lake
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
encryption_configurationobject
lifecycle_configurationobject
replication_configurationobject
meta_store_manager_role_arnstringThe Amazon Resource Name (ARN) used to index AWS Glue table partitions that are generated by the ingestion and normalization of AWS log sources and custom sources.
tagsarray
arnstringThe Amazon Resource Name (ARN) created by you to provide to the subscriber.
s3_bucket_arnstringThe ARN for the Amazon Security Lake Amazon S3 bucket.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +encryption_configuration, +lifecycle_configuration, +replication_configuration, +meta_store_manager_role_arn, +tags, +arn, +s3_bucket_arn +FROM aws.securitylake.data_lake +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the data_lake resource, the following permissions are required: + +### Update +```json +events:*, +iam:CreateServiceLinkedRole, +iam:DeleteRolePolicy, +iam:GetRole, +iam:PassRole, +iam:PutRolePolicy, +kms:DescribeKey, +kms:CreateGrant, +lakeformation:*, +lambda:*, +organizations:*, +s3:*, +securitylake:List*, +securitylake:TagResource, +securitylake:UntagResource, +securitylake:UpdateDataLake, +sqs:* +``` + +### Delete +```json +organizations:*, +securitylake:DeleteDataLake, +securitylake:List* +``` + +### Read +```json +securitylake:List* +``` + diff --git a/docs/aws-docs/providers/aws/securitylake/data_lakes/index.md b/docs/aws-docs/providers/aws/securitylake/data_lakes/index.md new file mode 100644 index 0000000000..6eb7eb235a --- /dev/null +++ b/docs/aws-docs/providers/aws/securitylake/data_lakes/index.md @@ -0,0 +1,93 @@ +--- +title: data_lakes +hide_title: false +hide_table_of_contents: false +keywords: + - data_lakes + - securitylake + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Retrieves a list of data_lakes in a region + +## Overview + + + + + +
Namedata_lakes
TypeResource
DescriptionResource Type definition for AWS::SecurityLake::DataLake
Idaws.securitylake.data_lakes
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) created by you to provide to the subscriber.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.securitylake.data_lakes +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the data_lakes resource, the following permissions are required: + +### Create +```json +events:*, +iam:CreateServiceLinkedRole, +iam:GetRole, +iam:ListAttachedRolePolicies, +iam:PutRolePolicy, +iam:PassRole, +glue:*, +organizations:*, +kms:DescribeKey, +kms:CreateGrant, +lakeformation:*, +lambda:*, +s3:*, +securitylake:CreateDataLake, +securitylake:TagResource, +securitylake:List*, +sqs:* +``` + +### List +```json +securitylake:List* +``` + diff --git a/docs/aws-docs/providers/aws/securitylake/index.md b/docs/aws-docs/providers/aws/securitylake/index.md new file mode 100644 index 0000000000..158ce28ce9 --- /dev/null +++ b/docs/aws-docs/providers/aws/securitylake/index.md @@ -0,0 +1,41 @@ +--- +title: securitylake +hide_title: false +hide_table_of_contents: false +keywords: + - securitylake + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- + +The securitylake service documentation. + +:::info Service Summary + +
+
+total resources: 4
+total selectable resources: 4
+total methods: 4
+
+
+ +::: + +## Resources +
+
+data_lake
+data_lakes +
+
+subscriber
+subscribers +
+
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/securitylake/subscriber/index.md b/docs/aws-docs/providers/aws/securitylake/subscriber/index.md new file mode 100644 index 0000000000..82e865e102 --- /dev/null +++ b/docs/aws-docs/providers/aws/securitylake/subscriber/index.md @@ -0,0 +1,162 @@ +--- +title: subscriber +hide_title: false +hide_table_of_contents: false +keywords: + - subscriber + - securitylake + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Gets an individual subscriber resource + +## Overview + + + + + +
Namesubscriber
TypeResource
DescriptionResource Type definition for AWS::SecurityLake::Subscriber
Idaws.securitylake.subscriber
+ +## Fields + + + + + + + + + + + + + + + + +
NameDatatypeDescription
access_typesarray
data_lake_arnstringThe ARN for the data lake.
subscriber_identityobjectThe AWS identity used to access your data.
subscriber_namestringThe name of your Security Lake subscriber account.
subscriber_descriptionstringThe description for your subscriber account in Security Lake.
tagsarrayAn array of objects, one for each tag to associate with the subscriber. For each tag, you must specify both a tag key and a tag value. A tag value cannot be null, but it can be an empty string.
sourcesarrayThe supported AWS services from which logs and events are collected.
resource_share_arnstring
resource_share_namestring
subscriber_role_arnstring
s3_bucket_arnstring
subscriber_arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +access_types, +data_lake_arn, +subscriber_identity, +subscriber_name, +subscriber_description, +tags, +sources, +resource_share_arn, +resource_share_name, +subscriber_role_arn, +s3_bucket_arn, +subscriber_arn +FROM aws.securitylake.subscriber +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the subscriber resource, the following permissions are required: + +### Read +```json +securitylake:GetSubscriber, +securitylake:ListTagsForResource +``` + +### Update +```json +securitylake:UpdateSubscriber, +securitylake:GetSubscriber, +securitylake:TagResource, +securitylake:UntagResource, +securitylake:ListTagsForResource, +glue:GetDatabase, +glue:GetTable, +lakeformation:ListPermissions, +lakeformation:GrantPermissions, +lakeformation:RevokePermissions, +ram:CreateResourceShare, +ram:GetResourceShares, +ram:GetResourceShareAssociations, +ram:UpdateResourceShare, +ram:DeleteResourceShare, +iam:CreateRole, +iam:GetRole, +iam:DeleteRole, +iam:PutRolePolicy, +iam:DeleteRolePolicy, +iam:ListRolePolicies, +events:CreateApiDestination, +events:CreateConnection, +events:ListApiDestinations, +events:ListConnections, +events:PutRule, +events:UpdateApiDestination, +events:UpdateConnection, +events:DeleteApiDestination, +events:DeleteConnection, +events:DeleteRule, +events:RemoveTargets, +events:ListTargetsByRule, +events:DescribeRule, +events:PutTargets +``` + +### Delete +```json +securitylake:DeleteSubscriber, +iam:GetRole, +iam:ListRolePolicies, +iam:DeleteRole, +iam:DeleteRolePolicy, +glue:GetTable, +lakeformation:RevokePermissions, +lakeformation:ListPermissions, +ram:GetResourceShares, +ram:DeleteResourceShare, +events:DeleteApiDestination, +events:DeleteConnection, +events:DeleteRule, +events:ListApiDestinations, +events:ListTargetsByRule, +events:DescribeRule, +events:RemoveTargets, +sqs:DeleteQueue, +sqs:GetQueueUrl +``` + diff --git a/docs/aws-docs/providers/aws/securitylake/subscribers/index.md b/docs/aws-docs/providers/aws/securitylake/subscribers/index.md new file mode 100644 index 0000000000..ed5b90fa93 --- /dev/null +++ b/docs/aws-docs/providers/aws/securitylake/subscribers/index.md @@ -0,0 +1,97 @@ +--- +title: subscribers +hide_title: false +hide_table_of_contents: false +keywords: + - subscribers + - securitylake + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +Retrieves a list of subscribers in a region + +## Overview + + + + + +
Namesubscribers
TypeResource
DescriptionResource Type definition for AWS::SecurityLake::Subscriber
Idaws.securitylake.subscribers
+ +## Fields + + + + + +
NameDatatypeDescription
subscriber_arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +subscriber_arn +FROM aws.securitylake.subscribers +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the subscribers resource, the following permissions are required: + +### Create +```json +securitylake:CreateSubscriber, +securitylake:CreateCustomLogSource, +securitylake:CreateDataLake, +securitylake:TagResource, +securitylake:GetSubscriber, +securitylake:ListTagsForResource, +iam:GetRole, +iam:GetRolePolicy, +iam:PutRolePolicy, +iam:CreateRole, +iam:CreateServiceLinkedRole, +glue:GetDatabase, +glue:GetTable, +lakeformation:RegisterResource, +lakeformation:GrantPermissions, +lakeformation:RevokePermissions, +lakeformation:ListPermissions, +ram:GetResourceShareAssociations, +ram:CreateResourceShare, +ram:UpdateResourceShare, +ram:GetResourceShares +``` + +### List +```json +securitylake:ListSubscribers +``` + diff --git a/docs/aws-docs/providers/aws/servicecatalog/cloud_formation_provisioned_product/index.md b/docs/aws-docs/providers/aws/servicecatalog/cloud_formation_provisioned_product/index.md new file mode 100644 index 0000000000..af24bee115 --- /dev/null +++ b/docs/aws-docs/providers/aws/servicecatalog/cloud_formation_provisioned_product/index.md @@ -0,0 +1,117 @@ +--- +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
DescriptionResource Schema for AWS::ServiceCatalog::CloudFormationProvisionedProduct
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.servicecatalog.cloud_formation_provisioned_product +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the cloud_formation_provisioned_product resource, the following permissions are required: + +### Read +```json +* +``` + +### Update +```json +* +``` + +### Delete +```json +* +``` + diff --git a/docs/aws-docs/providers/aws/servicecatalog/cloud_formation_provisioned_products/index.md b/docs/aws-docs/providers/aws/servicecatalog/cloud_formation_provisioned_products/index.md new file mode 100644 index 0000000000..3bf12135f7 --- /dev/null +++ b/docs/aws-docs/providers/aws/servicecatalog/cloud_formation_provisioned_products/index.md @@ -0,0 +1,67 @@ +--- +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
DescriptionResource Schema for AWS::ServiceCatalog::CloudFormationProvisionedProduct
Idaws.servicecatalog.cloud_formation_provisioned_products
+ +## Fields + + + + + +
NameDatatypeDescription
provisioned_product_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +provisioned_product_id +FROM aws.servicecatalog.cloud_formation_provisioned_products +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the cloud_formation_provisioned_products resource, the following permissions are required: + +### Create +```json +* +``` + diff --git a/docs/aws-docs/providers/aws/servicecatalog/index.md b/docs/aws-docs/providers/aws/servicecatalog/index.md new file mode 100644 index 0000000000..eca857c1b6 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/servicecatalog/service_action/index.md b/docs/aws-docs/providers/aws/servicecatalog/service_action/index.md new file mode 100644 index 0000000000..a28ff06e1d --- /dev/null +++ b/docs/aws-docs/providers/aws/servicecatalog/service_action/index.md @@ -0,0 +1,99 @@ +--- +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
DescriptionResource Schema for AWS::ServiceCatalog::ServiceAction
Idaws.servicecatalog.service_action
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
accept_languagestring
namestring
definition_typestring
definitionarray
descriptionstring
idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +accept_language, +name, +definition_type, +definition, +description, +id +FROM aws.servicecatalog.service_action +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the service_action resource, the following permissions are required: + +### Read +```json +servicecatalog:DescribeServiceAction +``` + +### Update +```json +servicecatalog:UpdateServiceAction, +iam:GetRole, +ssm:DescribeDocument +``` + +### Delete +```json +servicecatalog:DeleteServiceAction +``` + diff --git a/docs/aws-docs/providers/aws/servicecatalog/service_action_association/index.md b/docs/aws-docs/providers/aws/servicecatalog/service_action_association/index.md new file mode 100644 index 0000000000..55cc197b72 --- /dev/null +++ b/docs/aws-docs/providers/aws/servicecatalog/service_action_association/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionResource Schema for AWS::ServiceCatalog::ServiceActionAssociation
Idaws.servicecatalog.service_action_association
+ +## Fields + + + + + + + +
NameDatatypeDescription
product_idstring
provisioning_artifact_idstring
service_action_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +product_id, +provisioning_artifact_id, +service_action_id +FROM aws.servicecatalog.service_action_association +WHERE data__Identifier = '||'; +``` + +## Permissions + +To operate on the service_action_association resource, the following permissions are required: + +### Read +```json +servicecatalog:ListServiceActionsForProvisioningArtifact +``` + +### Delete +```json +servicecatalog:DisassociateServiceActionFromProvisioningArtifact, +servicecatalog:ListServiceActionsForProvisioningArtifact +``` + diff --git a/docs/aws-docs/providers/aws/servicecatalog/service_action_associations/index.md b/docs/aws-docs/providers/aws/servicecatalog/service_action_associations/index.md new file mode 100644 index 0000000000..b4edce0a4f --- /dev/null +++ b/docs/aws-docs/providers/aws/servicecatalog/service_action_associations/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionResource Schema for AWS::ServiceCatalog::ServiceActionAssociation
Idaws.servicecatalog.service_action_associations
+ +## Fields + + + + + + + +
NameDatatypeDescription
product_idstring
provisioning_artifact_idstring
service_action_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +product_id, +provisioning_artifact_id, +service_action_id +FROM aws.servicecatalog.service_action_associations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the service_action_associations resource, the following permissions are required: + +### Create +```json +servicecatalog:AssociateServiceActionWithProvisioningArtifact, +servicecatalog:ListServiceActionsForProvisioningArtifact +``` + +### List +```json +servicecatalog:ListServiceActionsForProvisioningArtifact +``` + diff --git a/docs/aws-docs/providers/aws/servicecatalog/service_actions/index.md b/docs/aws-docs/providers/aws/servicecatalog/service_actions/index.md new file mode 100644 index 0000000000..043d117456 --- /dev/null +++ b/docs/aws-docs/providers/aws/servicecatalog/service_actions/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource Schema for AWS::ServiceCatalog::ServiceAction
Idaws.servicecatalog.service_actions
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.servicecatalog.service_actions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the service_actions resource, the following permissions are required: + +### Create +```json +servicecatalog:CreateServiceAction, +ssm:DescribeDocument, +iam:GetRole +``` + +### List +```json +servicecatalog:ListServiceActions +``` + diff --git a/docs/aws-docs/providers/aws/servicecatalogappregistry/application/index.md b/docs/aws-docs/providers/aws/servicecatalogappregistry/application/index.md new file mode 100644 index 0000000000..b0b5d4bea3 --- /dev/null +++ b/docs/aws-docs/providers/aws/servicecatalogappregistry/application/index.md @@ -0,0 +1,106 @@ +--- +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
DescriptionResource Schema for AWS::ServiceCatalogAppRegistry::Application
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +arn, +name, +description, +tags, +application_tag_key, +application_tag_value, +application_name +FROM aws.servicecatalogappregistry.application +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the application resource, the following permissions are required: + +### Read +```json +servicecatalog:GetApplication +``` + +### Update +```json +servicecatalog:GetApplication, +servicecatalog:ListTagsForResource, +servicecatalog:TagResource, +servicecatalog:UntagResource, +servicecatalog:UpdateApplication, +iam:CreateServiceLinkedRole +``` + +### Delete +```json +servicecatalog:DeleteApplication +``` + diff --git a/docs/aws-docs/providers/aws/servicecatalogappregistry/applications/index.md b/docs/aws-docs/providers/aws/servicecatalogappregistry/applications/index.md new file mode 100644 index 0000000000..8a88934465 --- /dev/null +++ b/docs/aws-docs/providers/aws/servicecatalogappregistry/applications/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource Schema for AWS::ServiceCatalogAppRegistry::Application
Idaws.servicecatalogappregistry.applications
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.servicecatalogappregistry.applications +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the applications resource, the following permissions are required: + +### Create +```json +servicecatalog:CreateApplication, +servicecatalog:TagResource, +iam:CreateServiceLinkedRole +``` + +### List +```json +servicecatalog:ListApplications +``` + diff --git a/docs/aws-docs/providers/aws/servicecatalogappregistry/attribute_group/index.md b/docs/aws-docs/providers/aws/servicecatalogappregistry/attribute_group/index.md new file mode 100644 index 0000000000..5c48810ce5 --- /dev/null +++ b/docs/aws-docs/providers/aws/servicecatalogappregistry/attribute_group/index.md @@ -0,0 +1,101 @@ +--- +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
DescriptionResource Schema for AWS::ServiceCatalogAppRegistry::AttributeGroup.
Idaws.servicecatalogappregistry.attribute_group
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
idstring
arnstring
namestringThe name of the attribute group.
descriptionstringThe description of the attribute group.
attributesobject
tagsobject
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +arn, +name, +description, +attributes, +tags +FROM aws.servicecatalogappregistry.attribute_group +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the attribute_group resource, the following permissions are required: + +### Read +```json +servicecatalog:GetAttributeGroup +``` + +### Update +```json +servicecatalog:GetAttributeGroup, +servicecatalog:UpdateAttributeGroup, +servicecatalog:ListTagsForResource, +servicecatalog:TagResource, +servicecatalog:UntagResource +``` + +### Delete +```json +servicecatalog:DeleteAttributeGroup +``` + diff --git a/docs/aws-docs/providers/aws/servicecatalogappregistry/attribute_group_association/index.md b/docs/aws-docs/providers/aws/servicecatalogappregistry/attribute_group_association/index.md new file mode 100644 index 0000000000..04f818a8b3 --- /dev/null +++ b/docs/aws-docs/providers/aws/servicecatalogappregistry/attribute_group_association/index.md @@ -0,0 +1,83 @@ +--- +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
DescriptionResource Schema for AWS::ServiceCatalogAppRegistry::AttributeGroupAssociation.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +application, +attribute_group, +application_arn, +attribute_group_arn +FROM aws.servicecatalogappregistry.attribute_group_association +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the attribute_group_association resource, the following permissions are required: + +### Read +```json +servicecatalog:ListAttributeGroupsForApplication +``` + +### Delete +```json +servicecatalog:DisassociateAttributeGroup +``` + diff --git a/docs/aws-docs/providers/aws/servicecatalogappregistry/attribute_group_associations/index.md b/docs/aws-docs/providers/aws/servicecatalogappregistry/attribute_group_associations/index.md new file mode 100644 index 0000000000..3934b726f8 --- /dev/null +++ b/docs/aws-docs/providers/aws/servicecatalogappregistry/attribute_group_associations/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource Schema for AWS::ServiceCatalogAppRegistry::AttributeGroupAssociation.
Idaws.servicecatalogappregistry.attribute_group_associations
+ +## Fields + + + + + + +
NameDatatypeDescription
application_arnstring
attribute_group_arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +application_arn, +attribute_group_arn +FROM aws.servicecatalogappregistry.attribute_group_associations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the attribute_group_associations resource, the following permissions are required: + +### Create +```json +servicecatalog:AssociateAttributeGroup +``` + +### List +```json +servicecatalog:ListAttributeGroupsForApplication +``` + diff --git a/docs/aws-docs/providers/aws/servicecatalogappregistry/attribute_groups/index.md b/docs/aws-docs/providers/aws/servicecatalogappregistry/attribute_groups/index.md new file mode 100644 index 0000000000..e3e8ca8d9b --- /dev/null +++ b/docs/aws-docs/providers/aws/servicecatalogappregistry/attribute_groups/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionResource Schema for AWS::ServiceCatalogAppRegistry::AttributeGroup.
Idaws.servicecatalogappregistry.attribute_groups
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.servicecatalogappregistry.attribute_groups +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the attribute_groups resource, the following permissions are required: + +### Create +```json +servicecatalog:CreateAttributeGroup, +servicecatalog:TagResource +``` + +### List +```json +servicecatalog:ListAttributeGroups +``` + diff --git a/docs/aws-docs/providers/aws/servicecatalogappregistry/index.md b/docs/aws-docs/providers/aws/servicecatalogappregistry/index.md new file mode 100644 index 0000000000..63680265a5 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/servicecatalogappregistry/resource_association/index.md b/docs/aws-docs/providers/aws/servicecatalogappregistry/resource_association/index.md new file mode 100644 index 0000000000..54c094dd6d --- /dev/null +++ b/docs/aws-docs/providers/aws/servicecatalogappregistry/resource_association/index.md @@ -0,0 +1,85 @@ +--- +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 Schema for AWS::ServiceCatalogAppRegistry::ResourceAssociation
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +application, +resource, +resource_type, +application_arn, +resource_arn +FROM aws.servicecatalogappregistry.resource_association +WHERE data__Identifier = '||'; +``` + +## Permissions + +To operate on the resource_association resource, the following permissions are required: + +### Read +```json +servicecatalog:ListAssociatedResources +``` + +### Delete +```json +servicecatalog:DisassociateResource +``` + diff --git a/docs/aws-docs/providers/aws/servicecatalogappregistry/resource_associations/index.md b/docs/aws-docs/providers/aws/servicecatalogappregistry/resource_associations/index.md new file mode 100644 index 0000000000..59b699b071 --- /dev/null +++ b/docs/aws-docs/providers/aws/servicecatalogappregistry/resource_associations/index.md @@ -0,0 +1,82 @@ +--- +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 Schema for AWS::ServiceCatalogAppRegistry::ResourceAssociation
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +application_arn, +resource_arn, +resource_type +FROM aws.servicecatalogappregistry.resource_associations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the resource_associations resource, the following permissions are required: + +### Create +```json +servicecatalog:AssociateResource, +cloudformation:DescribeStacks +``` + +### List +```json +servicecatalog:ListAssociatedResources +``` + diff --git a/docs/aws-docs/providers/aws/ses/configuration_set/index.md b/docs/aws-docs/providers/aws/ses/configuration_set/index.md new file mode 100644 index 0000000000..dd0e83eb29 --- /dev/null +++ b/docs/aws-docs/providers/aws/ses/configuration_set/index.md @@ -0,0 +1,105 @@ +--- +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
DescriptionResource schema for AWS::SES::ConfigurationSet.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +tracking_options, +delivery_options, +reputation_options, +sending_options, +suppression_options, +vdm_options +FROM aws.ses.configuration_set +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the configuration_set resource, the following permissions are required: + +### Read +```json +ses:GetConfigurationSet, +ses:DescribeConfigurationSet +``` + +### Update +```json +ses:PutConfigurationSetTrackingOptions, +ses:PutConfigurationSetDeliveryOptions, +ses:PutConfigurationSetReputationOptions, +ses:PutConfigurationSetSendingOptions, +ses:PutConfigurationSetSuppressionOptions, +ses:PutConfigurationSetVdmOptions +``` + +### Delete +```json +ses:DeleteConfigurationSet +``` + diff --git a/docs/aws-docs/providers/aws/ses/configuration_set_event_destination/index.md b/docs/aws-docs/providers/aws/ses/configuration_set_event_destination/index.md new file mode 100644 index 0000000000..acfd51ad49 --- /dev/null +++ b/docs/aws-docs/providers/aws/ses/configuration_set_event_destination/index.md @@ -0,0 +1,93 @@ +--- +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
DescriptionResource Type definition for AWS::SES::ConfigurationSetEventDestination
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +configuration_set_name, +event_destination +FROM aws.ses.configuration_set_event_destination +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the configuration_set_event_destination resource, the following permissions are required: + +### Update +```json +ses:UpdateConfigurationSetEventDestination, +ses:GetConfigurationSetEventDestinations +``` + +### Delete +```json +ses:DeleteConfigurationSetEventDestination +``` + +### Read +```json +ses:GetConfigurationSetEventDestinations, +ses:DescribeConfigurationSet +``` + diff --git a/docs/aws-docs/providers/aws/ses/configuration_set_event_destinations/index.md b/docs/aws-docs/providers/aws/ses/configuration_set_event_destinations/index.md new file mode 100644 index 0000000000..c0a5a38683 --- /dev/null +++ b/docs/aws-docs/providers/aws/ses/configuration_set_event_destinations/index.md @@ -0,0 +1,69 @@ +--- +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
DescriptionResource Type definition for AWS::SES::ConfigurationSetEventDestination
Idaws.ses.configuration_set_event_destinations
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.ses.configuration_set_event_destinations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the configuration_set_event_destinations resource, the following permissions are required: + +### Create +```json +ses:CreateConfigurationSetEventDestination, +ses:GetConfigurationSetEventDestinations, +ses:DescribeConfigurationSet +``` + diff --git a/docs/aws-docs/providers/aws/ses/configuration_sets/index.md b/docs/aws-docs/providers/aws/ses/configuration_sets/index.md new file mode 100644 index 0000000000..6c9ab621ce --- /dev/null +++ b/docs/aws-docs/providers/aws/ses/configuration_sets/index.md @@ -0,0 +1,77 @@ +--- +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
DescriptionResource schema for AWS::SES::ConfigurationSet.
Idaws.ses.configuration_sets
+ +## Fields + + + + + +
NameDatatypeDescription
namestringThe name of the configuration set.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.ses.configuration_sets +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the configuration_sets resource, the following permissions are required: + +### Create +```json +ses:CreateConfigurationSet +``` + +### List +```json +ses:ListConfigurationSets +``` + diff --git a/docs/aws-docs/providers/aws/ses/contact_list/index.md b/docs/aws-docs/providers/aws/ses/contact_list/index.md new file mode 100644 index 0000000000..7072f0c9ce --- /dev/null +++ b/docs/aws-docs/providers/aws/ses/contact_list/index.md @@ -0,0 +1,95 @@ +--- +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
DescriptionResource schema for AWS::SES::ContactList.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +contact_list_name, +description, +topics, +tags +FROM aws.ses.contact_list +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the contact_list resource, the following permissions are required: + +### Read +```json +ses:GetContactList +``` + +### Update +```json +ses:UpdateContactList, +ses:UntagResource, +ses:TagResource +``` + +### Delete +```json +ses:DeleteContactList +``` + diff --git a/docs/aws-docs/providers/aws/ses/contact_lists/index.md b/docs/aws-docs/providers/aws/ses/contact_lists/index.md new file mode 100644 index 0000000000..d75b48bf30 --- /dev/null +++ b/docs/aws-docs/providers/aws/ses/contact_lists/index.md @@ -0,0 +1,77 @@ +--- +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
DescriptionResource schema for AWS::SES::ContactList.
Idaws.ses.contact_lists
+ +## Fields + + + + + +
NameDatatypeDescription
contact_list_namestringThe name of the contact list.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +contact_list_name +FROM aws.ses.contact_lists +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the contact_lists resource, the following permissions are required: + +### Create +```json +ses:CreateContactList +``` + +### List +```json +ses:ListContactLists +``` + diff --git a/docs/aws-docs/providers/aws/ses/dedicated_ip_pool/index.md b/docs/aws-docs/providers/aws/ses/dedicated_ip_pool/index.md new file mode 100644 index 0000000000..1a1a6a50cb --- /dev/null +++ b/docs/aws-docs/providers/aws/ses/dedicated_ip_pool/index.md @@ -0,0 +1,91 @@ +--- +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
DescriptionResource Type definition for AWS::SES::DedicatedIpPool
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +pool_name, +scaling_mode +FROM aws.ses.dedicated_ip_pool +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the dedicated_ip_pool resource, the following permissions are required: + +### Read +```json +ses:GetDedicatedIpPool, +ses:GetDedicatedIps +``` + +### Update +```json +ses:PutDedicatedIpPoolScalingAttributes, +ses:GetDedicatedIpPool +``` + +### Delete +```json +ses:DeleteDedicatedIpPool +``` + diff --git a/docs/aws-docs/providers/aws/ses/dedicated_ip_pools/index.md b/docs/aws-docs/providers/aws/ses/dedicated_ip_pools/index.md new file mode 100644 index 0000000000..6ddcf6157c --- /dev/null +++ b/docs/aws-docs/providers/aws/ses/dedicated_ip_pools/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource Type definition for AWS::SES::DedicatedIpPool
Idaws.ses.dedicated_ip_pools
+ +## Fields + + + + + +
NameDatatypeDescription
pool_namestringThe name of the dedicated IP pool.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +pool_name +FROM aws.ses.dedicated_ip_pools +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the dedicated_ip_pools resource, the following permissions are required: + +### Create +```json +ses:CreateDedicatedIpPool, +ses:GetDedicatedIpPool, +ses:GetDedicatedIps +``` + +### List +```json +ses:ListDedicatedIpPools +``` + diff --git a/docs/aws-docs/providers/aws/ses/email_identities/index.md b/docs/aws-docs/providers/aws/ses/email_identities/index.md new file mode 100644 index 0000000000..2fe0dddbdf --- /dev/null +++ b/docs/aws-docs/providers/aws/ses/email_identities/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionResource Type definition for AWS::SES::EmailIdentity
Idaws.ses.email_identities
+ +## Fields + + + + + +
NameDatatypeDescription
email_identitystringThe email address or domain to verify.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +email_identity +FROM aws.ses.email_identities +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the email_identities resource, the following permissions are required: + +### Create +```json +ses:CreateEmailIdentity, +ses:PutEmailIdentityMailFromAttributes, +ses:PutEmailIdentityFeedbackAttributes, +ses:PutEmailIdentityDkimAttributes, +ses:GetEmailIdentity +``` + +### List +```json +ses:ListEmailIdentities +``` + diff --git a/docs/aws-docs/providers/aws/ses/email_identity/index.md b/docs/aws-docs/providers/aws/ses/email_identity/index.md new file mode 100644 index 0000000000..7ed038742e --- /dev/null +++ b/docs/aws-docs/providers/aws/ses/email_identity/index.md @@ -0,0 +1,114 @@ +--- +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
DescriptionResource Type definition for AWS::SES::EmailIdentity
Idaws.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_dns_token_name1string
dkim_dns_token_name2string
dkim_dns_token_name3string
dkim_dns_token_value1string
dkim_dns_token_value2string
dkim_dns_token_value3string
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +email_identity, +configuration_set_attributes, +dkim_signing_attributes, +dkim_attributes, +mail_from_attributes, +feedback_attributes, +dkim_dns_token_name1, +dkim_dns_token_name2, +dkim_dns_token_name3, +dkim_dns_token_value1, +dkim_dns_token_value2, +dkim_dns_token_value3 +FROM aws.ses.email_identity +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the email_identity resource, the following permissions are required: + +### Read +```json +ses:GetEmailIdentity +``` + +### Update +```json +ses:PutEmailIdentityMailFromAttributes, +ses:PutEmailIdentityFeedbackAttributes, +ses:PutEmailIdentityConfigurationSetAttributes, +ses:PutEmailIdentityDkimSigningAttributes, +ses:PutEmailIdentityDkimAttributes, +ses:GetEmailIdentity +``` + +### Delete +```json +ses:DeleteEmailIdentity +``` + diff --git a/docs/aws-docs/providers/aws/ses/index.md b/docs/aws-docs/providers/aws/ses/index.md new file mode 100644 index 0000000000..8d5a14c85c --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/ses/template/index.md b/docs/aws-docs/providers/aws/ses/template/index.md new file mode 100644 index 0000000000..818570309f --- /dev/null +++ b/docs/aws-docs/providers/aws/ses/template/index.md @@ -0,0 +1,94 @@ +--- +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
DescriptionResource Type definition for AWS::SES::Template
Idaws.ses.template
+ +## Fields + + + + + + +
NameDatatypeDescription
idstring
templateobject
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +id, +template +FROM aws.ses.template +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the template resource, the following permissions are required: + +### Read +```json +ses:GetEmailTemplate, +ses:GetTemplate +``` + +### Delete +```json +ses:DeleteEmailTemplate, +ses:DeleteTemplate +``` + +### Update +```json +ses:GetEmailTemplate, +ses:UpdateEmailTemplate, +ses:GetTemplate, +ses:UpdateTemplate +``` + diff --git a/docs/aws-docs/providers/aws/ses/templates/index.md b/docs/aws-docs/providers/aws/ses/templates/index.md new file mode 100644 index 0000000000..38b13371a8 --- /dev/null +++ b/docs/aws-docs/providers/aws/ses/templates/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionResource Type definition for AWS::SES::Template
Idaws.ses.templates
+ +## Fields + + + + + +
NameDatatypeDescription
idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.ses.templates +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the templates resource, the following permissions are required: + +### Create +```json +ses:CreateEmailTemplate, +ses:GetEmailTemplate, +ses:CreateTemplate, +ses:GetTemplate +``` + +### List +```json +ses:ListEmailTemplates, +ses:ListTemplates +``` + diff --git a/docs/aws-docs/providers/aws/ses/vdm_attributes/index.md b/docs/aws-docs/providers/aws/ses/vdm_attributes/index.md new file mode 100644 index 0000000000..2cb29bc2b6 --- /dev/null +++ b/docs/aws-docs/providers/aws/ses/vdm_attributes/index.md @@ -0,0 +1,93 @@ +--- +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
DescriptionResource Type definition for AWS::SES::VdmAttributes
Idaws.ses.vdm_attributes
+ +## Fields + + + + + + + +
NameDatatypeDescription
vdm_attributes_resource_idstringUnique identifier for this resource
dashboard_attributesobject
guardian_attributesobject
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +vdm_attributes_resource_id, +dashboard_attributes, +guardian_attributes +FROM aws.ses.vdm_attributes +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the vdm_attributes resource, the following permissions are required: + +### Read +```json +ses:GetAccount +``` + +### Update +```json +ses:PutAccountVdmAttributes, +ses:GetAccount +``` + +### Delete +```json +ses:PutAccountVdmAttributes, +ses:GetAccount +``` + diff --git a/docs/aws-docs/providers/aws/shield/drt_access/index.md b/docs/aws-docs/providers/aws/shield/drt_access/index.md new file mode 100644 index 0000000000..aa88078f3d --- /dev/null +++ b/docs/aws-docs/providers/aws/shield/drt_access/index.md @@ -0,0 +1,109 @@ +--- +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
DescriptionConfig the role and list of Amazon S3 log buckets used by the Shield Response Team (SRT) to access your AWS account while assisting with attack mitigation.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +account_id, +log_bucket_list, +role_arn +FROM aws.shield.drt_access +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the drt_access resource, the following permissions are required: + +### Delete +```json +shield:DescribeDRTAccess, +shield:DisassociateDRTLogBucket, +shield:DisassociateDRTRole, +iam:PassRole, +iam:GetRole, +iam:ListAttachedRolePolicies, +s3:GetBucketPolicy, +s3:PutBucketPolicy, +s3:DeleteBucketPolicy +``` + +### Read +```json +shield:DescribeDRTAccess +``` + +### Update +```json +shield:DescribeDRTAccess, +shield:AssociateDRTLogBucket, +shield:AssociateDRTRole, +shield:DisassociateDRTLogBucket, +shield:DisassociateDRTRole, +iam:PassRole, +iam:GetRole, +iam:ListAttachedRolePolicies, +s3:GetBucketPolicy, +s3:PutBucketPolicy, +s3:DeleteBucketPolicy +``` + diff --git a/docs/aws-docs/providers/aws/shield/drt_accesses/index.md b/docs/aws-docs/providers/aws/shield/drt_accesses/index.md new file mode 100644 index 0000000000..eb65ee739b --- /dev/null +++ b/docs/aws-docs/providers/aws/shield/drt_accesses/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionConfig the role and list of Amazon S3 log buckets used by the Shield Response Team (SRT) to access your AWS account while assisting with attack mitigation.
Idaws.shield.drt_accesses
+ +## Fields + + + + + +
NameDatatypeDescription
account_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +account_id +FROM aws.shield.drt_accesses + +``` + +## Permissions + +To operate on the drt_accesses resource, the following permissions are required: + +### Create +```json +shield:DescribeDRTAccess, +shield:AssociateDRTLogBucket, +shield:AssociateDRTRole, +iam:PassRole, +iam:GetRole, +iam:ListAttachedRolePolicies, +s3:GetBucketPolicy, +s3:PutBucketPolicy +``` + diff --git a/docs/aws-docs/providers/aws/shield/index.md b/docs/aws-docs/providers/aws/shield/index.md new file mode 100644 index 0000000000..59687665d9 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/shield/proactive_engagement/index.md b/docs/aws-docs/providers/aws/shield/proactive_engagement/index.md new file mode 100644 index 0000000000..c495ee0347 --- /dev/null +++ b/docs/aws-docs/providers/aws/shield/proactive_engagement/index.md @@ -0,0 +1,99 @@ +--- +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
DescriptionAuthorizes the Shield Response Team (SRT) to use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +account_id, +proactive_engagement_status, +emergency_contact_list +FROM aws.shield.proactive_engagement +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the proactive_engagement resource, the following permissions are required: + +### Delete +```json +shield:DescribeSubscription, +shield:DescribeEmergencyContactSettings, +shield:UpdateEmergencyContactSettings, +shield:DisableProactiveEngagement +``` + +### Read +```json +shield:DescribeSubscription, +shield:DescribeEmergencyContactSettings +``` + +### Update +```json +shield:DescribeSubscription, +shield:DescribeEmergencyContactSettings, +shield:UpdateEmergencyContactSettings, +shield:EnableProactiveEngagement, +shield:DisableProactiveEngagement +``` + diff --git a/docs/aws-docs/providers/aws/shield/proactive_engagements/index.md b/docs/aws-docs/providers/aws/shield/proactive_engagements/index.md new file mode 100644 index 0000000000..1ed33168c1 --- /dev/null +++ b/docs/aws-docs/providers/aws/shield/proactive_engagements/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionAuthorizes the Shield Response Team (SRT) to use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.
Idaws.shield.proactive_engagements
+ +## Fields + + + + + +
NameDatatypeDescription
account_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +account_id +FROM aws.shield.proactive_engagements + +``` + +## Permissions + +To operate on the proactive_engagements resource, the following permissions are required: + +### Create +```json +shield:DescribeSubscription, +shield:DescribeEmergencyContactSettings, +shield:AssociateProactiveEngagementDetails, +shield:UpdateEmergencyContactSettings, +shield:EnableProactiveEngagement +``` + +### List +```json +shield:DescribeSubscription, +shield:DescribeEmergencyContactSettings +``` + diff --git a/docs/aws-docs/providers/aws/shield/protection/index.md b/docs/aws-docs/providers/aws/shield/protection/index.md new file mode 100644 index 0000000000..77ac2b8dd5 --- /dev/null +++ b/docs/aws-docs/providers/aws/shield/protection/index.md @@ -0,0 +1,114 @@ +--- +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
DescriptionEnables AWS Shield Advanced for a specific AWS resource. The resource can be an Amazon CloudFront distribution, Amazon Route 53 hosted zone, AWS Global Accelerator standard accelerator, Elastic IP Address, Application Load Balancer, or a Classic Load Balancer. You can protect Amazon EC2 instances and Network Load Balancers by association with protected Amazon EC2 Elastic IP addresses.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +protection_id, +protection_arn, +name, +resource_arn, +health_check_arns, +application_layer_automatic_response_configuration, +tags +FROM aws.shield.protection +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the protection resource, the following permissions are required: + +### Delete +```json +shield:DeleteProtection, +shield:UntagResource +``` + +### Read +```json +shield:DescribeProtection, +shield:ListTagsForResource +``` + +### Update +```json +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 +``` + diff --git a/docs/aws-docs/providers/aws/shield/protection_group/index.md b/docs/aws-docs/providers/aws/shield/protection_group/index.md new file mode 100644 index 0000000000..f69ce40fe4 --- /dev/null +++ b/docs/aws-docs/providers/aws/shield/protection_group/index.md @@ -0,0 +1,104 @@ +--- +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
DescriptionA grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +protection_group_id, +protection_group_arn, +aggregation, +pattern, +members, +resource_type, +tags +FROM aws.shield.protection_group +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the protection_group resource, the following permissions are required: + +### Delete +```json +shield:DeleteProtectionGroup, +shield:UntagResource +``` + +### Read +```json +shield:DescribeProtectionGroup, +shield:ListTagsForResource +``` + +### Update +```json +shield:UpdateProtectionGroup, +shield:ListTagsForResource, +shield:TagResource, +shield:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/shield/protection_groups/index.md b/docs/aws-docs/providers/aws/shield/protection_groups/index.md new file mode 100644 index 0000000000..a812daa329 --- /dev/null +++ b/docs/aws-docs/providers/aws/shield/protection_groups/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionA grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives.
Idaws.shield.protection_groups
+ +## Fields + + + + + +
NameDatatypeDescription
protection_group_arnstringThe ARN (Amazon Resource Name) of the protection group.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +protection_group_arn +FROM aws.shield.protection_groups + +``` + +## Permissions + +To operate on the protection_groups resource, the following permissions are required: + +### Create +```json +shield:CreateProtectionGroup, +shield:TagResource +``` + +### List +```json +shield:ListProtectionGroups +``` + diff --git a/docs/aws-docs/providers/aws/shield/protections/index.md b/docs/aws-docs/providers/aws/shield/protections/index.md new file mode 100644 index 0000000000..676b1b1f35 --- /dev/null +++ b/docs/aws-docs/providers/aws/shield/protections/index.md @@ -0,0 +1,90 @@ +--- +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
DescriptionEnables AWS Shield Advanced for a specific AWS resource. The resource can be an Amazon CloudFront distribution, Amazon Route 53 hosted zone, AWS Global Accelerator standard accelerator, Elastic IP Address, Application Load Balancer, or a Classic Load Balancer. You can protect Amazon EC2 instances and Network Load Balancers by association with protected Amazon EC2 Elastic IP addresses.
Idaws.shield.protections
+ +## Fields + + + + + +
NameDatatypeDescription
protection_arnstringThe ARN (Amazon Resource Name) of the protection.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +protection_arn +FROM aws.shield.protections + +``` + +## Permissions + +To operate on the protections resource, the following permissions are required: + +### Create +```json +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 +```json +shield:ListProtections +``` + diff --git a/docs/aws-docs/providers/aws/signer/index.md b/docs/aws-docs/providers/aws/signer/index.md new file mode 100644 index 0000000000..660e384f84 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/signer/profile_permission/index.md b/docs/aws-docs/providers/aws/signer/profile_permission/index.md new file mode 100644 index 0000000000..5db1ebb74c --- /dev/null +++ b/docs/aws-docs/providers/aws/signer/profile_permission/index.md @@ -0,0 +1,86 @@ +--- +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
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Idaws.signer.profile_permission
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
profile_namestring
profile_versionstring
actionstring
principalstring
statement_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +profile_name, +profile_version, +action, +principal, +statement_id +FROM aws.signer.profile_permission +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the profile_permission resource, the following permissions are required: + +### Read +```json +signer:ListProfilePermissions +``` + +### Delete +```json +signer:RemoveProfilePermission, +signer:ListProfilePermissions +``` + diff --git a/docs/aws-docs/providers/aws/signer/profile_permissions/index.md b/docs/aws-docs/providers/aws/signer/profile_permissions/index.md new file mode 100644 index 0000000000..aa17065746 --- /dev/null +++ b/docs/aws-docs/providers/aws/signer/profile_permissions/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Idaws.signer.profile_permissions
+ +## Fields + + + + + + +
NameDatatypeDescription
statement_idstring
profile_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +statement_id, +profile_name +FROM aws.signer.profile_permissions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the profile_permissions resource, the following permissions are required: + +### Create +```json +signer:AddProfilePermission, +signer:ListProfilePermissions +``` + +### List +```json +signer:ListProfilePermissions, +signer:GetSigningProfile +``` + diff --git a/docs/aws-docs/providers/aws/signer/signing_profile/index.md b/docs/aws-docs/providers/aws/signer/signing_profile/index.md new file mode 100644 index 0000000000..2233292b39 --- /dev/null +++ b/docs/aws-docs/providers/aws/signer/signing_profile/index.md @@ -0,0 +1,102 @@ +--- +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
DescriptionA signing profile is a signing template that can be used to carry out a pre-defined signing job.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +profile_name, +profile_version, +arn, +profile_version_arn, +signature_validity_period, +platform_id, +tags +FROM aws.signer.signing_profile +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the signing_profile resource, the following permissions are required: + +### Read +```json +signer:GetSigningProfile +``` + +### Delete +```json +signer:CancelSigningProfile, +signer:GetSigningProfile +``` + +### Update +```json +signer:TagResource, +signer:UntagResource, +signer:GetSigningProfile +``` + diff --git a/docs/aws-docs/providers/aws/signer/signing_profiles/index.md b/docs/aws-docs/providers/aws/signer/signing_profiles/index.md new file mode 100644 index 0000000000..1031f42b4c --- /dev/null +++ b/docs/aws-docs/providers/aws/signer/signing_profiles/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionA signing profile is a signing template that can be used to carry out a pre-defined signing job.
Idaws.signer.signing_profiles
+ +## Fields + + + + + +
NameDatatypeDescription
arnundefinedThe Amazon Resource Name (ARN) of the specified signing profile.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.signer.signing_profiles +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the signing_profiles resource, the following permissions are required: + +### Create +```json +signer:PutSigningProfile, +signer:TagResource +``` + +### List +```json +signer:ListSigningProfiles +``` + diff --git a/docs/aws-docs/providers/aws/simspaceweaver/index.md b/docs/aws-docs/providers/aws/simspaceweaver/index.md new file mode 100644 index 0000000000..622a9d4810 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/simspaceweaver/simulation/index.md b/docs/aws-docs/providers/aws/simspaceweaver/simulation/index.md new file mode 100644 index 0000000000..8c9b9cc00f --- /dev/null +++ b/docs/aws-docs/providers/aws/simspaceweaver/simulation/index.md @@ -0,0 +1,102 @@ +--- +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
DescriptionAWS::SimSpaceWeaver::Simulation resource creates an AWS Simulation.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +role_arn, +schema_s3_location, +describe_payload, +maximum_duration, +snapshot_s3_location +FROM aws.simspaceweaver.simulation +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the simulation resource, the following permissions are required: + +### Read +```json +simspaceweaver:DescribeSimulation +``` + +### Update +```json +simspaceweaver:StartSimulation, +simspaceweaver:StopSimulation, +simspaceweaver:DeleteSimulation, +simspaceweaver:DescribeSimulation +``` + +### Delete +```json +simspaceweaver:StopSimulation, +simspaceweaver:DeleteSimulation, +simspaceweaver:DescribeSimulation +``` + diff --git a/docs/aws-docs/providers/aws/simspaceweaver/simulations/index.md b/docs/aws-docs/providers/aws/simspaceweaver/simulations/index.md new file mode 100644 index 0000000000..3a51bc0208 --- /dev/null +++ b/docs/aws-docs/providers/aws/simspaceweaver/simulations/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionAWS::SimSpaceWeaver::Simulation resource creates an AWS Simulation.
Idaws.simspaceweaver.simulations
+ +## Fields + + + + + +
NameDatatypeDescription
namestringThe name of the simulation.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.simspaceweaver.simulations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the simulations resource, the following permissions are required: + +### Create +```json +simspaceweaver:StartSimulation, +simspaceweaver:DescribeSimulation, +iam:GetRole, +iam:PassRole +``` + +### List +```json +simspaceweaver:ListSimulations +``` + diff --git a/docs/aws-docs/providers/aws/sns/index.md b/docs/aws-docs/providers/aws/sns/index.md new file mode 100644 index 0000000000..9eb402ac99 --- /dev/null +++ b/docs/aws-docs/providers/aws/sns/index.md @@ -0,0 +1,41 @@ +--- +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: 4
+total selectable resources: 4
+total methods: 4
+
+
+ +::: + +## Resources +
+
+topic
+topic_inline_policies +
+
+topic_inline_policy
+topics +
+
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/sns/topic/index.md b/docs/aws-docs/providers/aws/sns/topic/index.md new file mode 100644 index 0000000000..97892d9966 --- /dev/null +++ b/docs/aws-docs/providers/aws/sns/topic/index.md @@ -0,0 +1,126 @@ +--- +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
DescriptionThe ``AWS::SNS::Topic`` resource creates a topic to which notifications can be published.<br/> One account can create a maximum of 100,000 standard topics and 1,000 FIFO topics. For more information, see [endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/sns.html) in the *General Reference*.<br/> The structure of ``AUTHPARAMS`` depends on the .signature of the API request. For more information, see [Examples of the complete Signature Version 4 signing process](https://docs.aws.amazon.com/general/latest/gr/sigv4-signed-request-examples.html) in the *General Reference*.
Idaws.sns.topic
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
display_namestringThe display name to use for an SNS topic with SMS subscriptions. The display name must be maximum 100 characters long, including hyphens (-), underscores (_), spaces, and tabs.
kms_master_key_idstringThe ID of an AWS managed customer master key (CMK) for SNS or a custom CMK. For more information, see [Key terms](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms). For more examples, see ``KeyId`` in the *API Reference*.<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/> You can only add one policy per topic.<br/> The policy must be in JSON string format.<br/> Length Constraints: Maximum length of 30,720.
subscriptionarrayThe SNS subscriptions (endpoints) for this topic.<br/> If you specify the ``Subscription`` property in the ``AWS::SNS::Topic`` resource and it creates an associated subscription resource, the associated subscription is not deleted when the ``AWS::SNS::Topic`` resource is deleted.
fifo_topicbooleanSet to true to create a FIFO topic.
content_based_deduplicationbooleanEnables content-based deduplication for FIFO topics.<br/> + By default, ``ContentBasedDeduplication`` is set to ``false``. If you create a FIFO topic and this attribute is ``false``, you must specify a value for the ``MessageDeduplicationId`` parameter for the [Publish](https://docs.aws.amazon.com/sns/latest/api/API_Publish.html) action. <br/> + When you set ``ContentBasedDeduplication`` to ``true``, SNS uses a SHA-256 hash to generate the ``MessageDeduplicationId`` using the body of the message (but not the attributes of the message).<br/> (Optional) To override the generated value, you can specify a value for the the ``MessageDeduplicationId`` parameter for the ``Publish`` action.
archive_policyobjectThe archive policy determines the number of days SNS retains messages. You can set a retention period from 1 to 365 days.
tagsarrayThe list of tags to add to a new topic.<br/> To be able to tag a topic on creation, you must have the ``sns:CreateTopic`` and ``sns:TagResource`` permissions.
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/> If you don't specify a name, CFN generates a unique physical ID and uses that ID for the topic name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).<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.
topic_arnstring
signature_versionstringThe signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, ``SignatureVersion`` is set to ``1``.
tracing_configstringTracing mode of an SNS topic. By default ``TracingConfig`` is set to ``PassThrough``, and the topic passes through the tracing header it receives from an SNS publisher to its subscriptions. If set to ``Active``, SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true.
delivery_status_loggingarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.sns.topic +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the topic resource, the following permissions are required: + +### Read +```json +sns:GetTopicAttributes, +sns:ListTagsForResource, +sns:ListSubscriptionsByTopic, +sns:GetDataProtectionPolicy +``` + +### Update +```json +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 +```json +sns:GetTopicAttributes, +sns:DeleteTopic +``` + diff --git a/docs/aws-docs/providers/aws/sns/topic_inline_policies/index.md b/docs/aws-docs/providers/aws/sns/topic_inline_policies/index.md new file mode 100644 index 0000000000..86e6a77a40 --- /dev/null +++ b/docs/aws-docs/providers/aws/sns/topic_inline_policies/index.md @@ -0,0 +1,68 @@ +--- +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
DescriptionSchema for AWS::SNS::TopicInlinePolicy
Idaws.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 + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +topic_arn +FROM aws.sns.topic_inline_policies +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the topic_inline_policies resource, the following permissions are required: + +### Create +```json +sns:SetTopicAttributes, +sns:GetTopicAttributes +``` + diff --git a/docs/aws-docs/providers/aws/sns/topic_inline_policy/index.md b/docs/aws-docs/providers/aws/sns/topic_inline_policy/index.md new file mode 100644 index 0000000000..afcff72580 --- /dev/null +++ b/docs/aws-docs/providers/aws/sns/topic_inline_policy/index.md @@ -0,0 +1,91 @@ +--- +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
DescriptionSchema for AWS::SNS::TopicInlinePolicy
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +policy_document, +topic_arn +FROM aws.sns.topic_inline_policy +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the topic_inline_policy resource, the following permissions are required: + +### Read +```json +sns:GetTopicAttributes +``` + +### Delete +```json +sns:SetTopicAttributes, +sns:GetTopicAttributes +``` + +### Update +```json +sns:SetTopicAttributes, +sns:GetTopicAttributes +``` + diff --git a/docs/aws-docs/providers/aws/sns/topics/index.md b/docs/aws-docs/providers/aws/sns/topics/index.md new file mode 100644 index 0000000000..438993c300 --- /dev/null +++ b/docs/aws-docs/providers/aws/sns/topics/index.md @@ -0,0 +1,83 @@ +--- +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
DescriptionThe ``AWS::SNS::Topic`` resource creates a topic to which notifications can be published.<br/> One account can create a maximum of 100,000 standard topics and 1,000 FIFO topics. For more information, see [endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/sns.html) in the *General Reference*.<br/> The structure of ``AUTHPARAMS`` depends on the .signature of the API request. For more information, see [Examples of the complete Signature Version 4 signing process](https://docs.aws.amazon.com/general/latest/gr/sigv4-signed-request-examples.html) in the *General Reference*.
Idaws.sns.topics
+ +## Fields + + + + + +
NameDatatypeDescription
topic_arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +topic_arn +FROM aws.sns.topics +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the topics resource, the following permissions are required: + +### Create +```json +sns:CreateTopic, +sns:TagResource, +sns:Subscribe, +sns:GetTopicAttributes, +sns:PutDataProtectionPolicy, +iam:GetRole, +iam:PassRole +``` + +### List +```json +sns:ListTopics +``` + diff --git a/docs/aws-docs/providers/aws/sqs/index.md b/docs/aws-docs/providers/aws/sqs/index.md new file mode 100644 index 0000000000..30ecf908b5 --- /dev/null +++ b/docs/aws-docs/providers/aws/sqs/index.md @@ -0,0 +1,41 @@ +--- +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: 4
+total selectable resources: 4
+total methods: 4
+
+
+ +::: + +## Resources +
+
+queue
+queue_inline_policies +
+
+queue_inline_policy
+queues +
+
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/sqs/queue/index.md b/docs/aws-docs/providers/aws/sqs/queue/index.md new file mode 100644 index 0000000000..69c7c34e9c --- /dev/null +++ b/docs/aws-docs/providers/aws/sqs/queue/index.md @@ -0,0 +1,127 @@ +--- +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
DescriptionThe ``AWS::SQS::Queue`` resource creates an SQS standard or FIFO queue.<br/> Keep the following caveats in mind:<br/> + If you don't specify the ``FifoQueue`` property, SQS creates a standard queue.<br/> You can't change the queue type after you create it and you can't convert an existing standard queue into a FIFO queue. You must either create a new FIFO queue for your application or delete your existing standard queue and recreate it as a FIFO queue. For more information, see [Moving from a standard queue to a FIFO queue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-moving.html) in the *Developer Guide*. <br/> + If you don't provide a value for a property, the queue is created with the default value for the property.<br/> + If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.<br/> + To successfully create a new queue, you must provide a queue name that adheres to the [limits related to queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-queues.html) and is unique within the scope of your queues.<br/> <br/> For more information about creating FIFO (first-in-first-out) queues, see [Creating an queue ()](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/screate-queue-cloudformation.html) in the *Developer Guide*.
Idaws.sqs.queue
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
queue_urlstring
arnstring
content_based_deduplicationbooleanFor first-in-first-out (FIFO) queues, specifies whether to enable content-based deduplication. During the deduplication interval, SQS treats messages that are sent with identical content as duplicates and delivers only one copy of the message. For more information, see the ``ContentBasedDeduplication`` attribute for the ``CreateQueue`` action in the *API Reference*.
deduplication_scopestringFor high throughput for FIFO queues, specifies whether message deduplication occurs at the message group or queue level. Valid values are ``messageGroup`` and ``queue``.<br/> To enable high throughput for a FIFO queue, set this attribute to ``messageGroup`` *and* set the ``FifoThroughputLimit`` attribute to ``perMessageGroupId``. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see [High throughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Developer Guide*.
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, SQS creates a standard queue. For more information, see [FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) in the *Developer Guide*.
fifo_throughput_limitstringFor high throughput for FIFO queues, specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are ``perQueue`` and ``perMessageGroupId``.<br/> To enable high throughput for a FIFO queue, set this attribute to ``perMessageGroupId`` *and* set the ``DeduplicationScope`` attribute to ``messageGroup``. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see [High throughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Developer Guide*.
kms_data_key_reuse_period_secondsintegerThe length of time in seconds for which SQS can reuse a data key to encrypt or decrypt messages before calling KMS again. The value must be an integer between 60 (1 minute) and 86,400 (24 hours). The default is 300 (5 minutes).<br/> A shorter time period provides better security, but results in more calls to KMS, which might incur charges after Free Tier. For more information, see [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work) in the *Developer Guide*.
kms_master_key_idstringThe ID of an AWS Key Management Service (KMS) for SQS, or a custom KMS. To use the AWS managed KMS for SQS, specify a (default) alias ARN, alias name (e.g. ``alias/aws/sqs``), key ARN, or key ID. For more information, see the following:<br/> + [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html) in the *Developer Guide* <br/> + [CreateQueue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html) in the *API Reference* <br/> + [Request Parameters](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) in the *Key Management Service API Reference* <br/> + The Key Management Service (KMS) section of the [Best Practices](https://docs.aws.amazon.com/https://d0.awsstatic.com/whitepapers/aws-kms-best-practices.pdf) whitepaper
sqs_managed_sse_enabledbooleanEnables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (for example, [SSE-KMS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html) or [SSE-SQS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html)). When ``SqsManagedSseEnabled`` is not defined, ``SSE-SQS`` encryption is enabled by default.
maximum_message_sizeintegerThe limit of how many bytes that a message can contain before SQS rejects it. You can specify an integer value from ``1,024`` bytes (1 KiB) to ``262,144`` bytes (256 KiB). The default value is ``262,144`` (256 KiB).
message_retention_periodintegerThe number of seconds that SQS retains a message. You can specify an integer value from ``60`` seconds (1 minute) to ``1,209,600`` seconds (14 days). The default value is ``345,600`` seconds (4 days).
queue_namestringA name for the queue. To create a FIFO queue, the name of your FIFO queue must end with the ``.fifo`` suffix. For more information, see [FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) in the *Developer Guide*.<br/> If you don't specify a name, CFN generates a unique physical ID and uses that ID for the queue name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) in the *User Guide*. <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.
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. For more information, see [Consuming messages using long polling](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-short-and-long-polling.html#sqs-long-polling) in the *Developer Guide*.
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. The parameters are as follows:<br/> + ``redrivePermission``: The permission type that defines which source queues can specify the current queue as the dead-letter queue. Valid values are:<br/> + ``allowAll``: (Default) Any source queues in this AWS account in the same Region can specify this queue as the dead-letter queue.<br/> + ``denyAll``: No source queues can specify this queue as the dead-letter queue.<br/> + ``byQueue``: Only queues specified by the ``sourceQueueArns`` parameter can specify this queue as the dead-letter queue.<br/> <br/> + ``sourceQueueArns``: The Amazon Resource Names (ARN)s of the source queues that can specify this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the ``redrivePermission`` parameter is set to ``byQueue``. You can specify up to 10 source queue ARNs. To allow more than 10 source queues to specify dead-letter queues, set the ``redrivePermission`` parameter to ``allowAll``.
redrive_policyobjectThe string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. The parameters are as follows:<br/> + ``deadLetterTargetArn``: The Amazon Resource Name (ARN) of the dead-letter queue to which SQS moves messages after the value of ``maxReceiveCount`` is exceeded.<br/> + ``maxReceiveCount``: The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ``ReceiveCount`` for a message exceeds the ``maxReceiveCount`` for a queue, SQS moves the message to the dead-letter-queue.<br/> <br/> The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.<br/> *JSON* <br/> ``{ "deadLetterTargetArn" : String, "maxReceiveCount" : Integer }`` <br/> *YAML* <br/> ``deadLetterTargetArn : String`` <br/> ``maxReceiveCount : Integer``
tagsarrayThe tags that you attach to this queue. For more information, see [Resource tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) in the *User Guide*.
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.<br/> 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.<br/> For more information about SQS queue visibility timeouts, see [Visibility timeout](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) in the *Developer Guide*.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.sqs.queue +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the queue resource, the following permissions are required: + +### Read +```json +sqs:GetQueueAttributes, +sqs:ListQueueTags +``` + +### Update +```json +sqs:SetQueueAttributes, +sqs:GetQueueAttributes, +sqs:ListQueueTags, +sqs:TagQueue, +sqs:UntagQueue +``` + +### Delete +```json +sqs:DeleteQueue, +sqs:GetQueueAttributes +``` + diff --git a/docs/aws-docs/providers/aws/sqs/queue_inline_policies/index.md b/docs/aws-docs/providers/aws/sqs/queue_inline_policies/index.md new file mode 100644 index 0000000000..71b0285a2c --- /dev/null +++ b/docs/aws-docs/providers/aws/sqs/queue_inline_policies/index.md @@ -0,0 +1,69 @@ +--- +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
DescriptionSchema for SQS QueueInlinePolicy
Idaws.sqs.queue_inline_policies
+ +## Fields + + + + + +
NameDatatypeDescription
queuestringThe URL of the SQS queue.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +queue +FROM aws.sqs.queue_inline_policies +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the queue_inline_policies resource, the following permissions are required: + +### Create +```json +sqs:SetQueueAttributes, +sqs:GetQueueAttributes, +sqs:GetQueueUrl +``` + diff --git a/docs/aws-docs/providers/aws/sqs/queue_inline_policy/index.md b/docs/aws-docs/providers/aws/sqs/queue_inline_policy/index.md new file mode 100644 index 0000000000..58bb61fefc --- /dev/null +++ b/docs/aws-docs/providers/aws/sqs/queue_inline_policy/index.md @@ -0,0 +1,93 @@ +--- +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
DescriptionSchema for SQS QueueInlinePolicy
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +policy_document, +queue +FROM aws.sqs.queue_inline_policy +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the queue_inline_policy resource, the following permissions are required: + +### Read +```json +sqs:GetQueueAttributes, +sqs:GetQueueUrl +``` + +### Delete +```json +sqs:SetQueueAttributes, +sqs:GetQueueAttributes +``` + +### Update +```json +sqs:SetQueueAttributes, +sqs:GetQueueAttributes, +sqs:GetQueueUrl +``` + diff --git a/docs/aws-docs/providers/aws/sqs/queues/index.md b/docs/aws-docs/providers/aws/sqs/queues/index.md new file mode 100644 index 0000000000..d9c7b151e2 --- /dev/null +++ b/docs/aws-docs/providers/aws/sqs/queues/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionThe ``AWS::SQS::Queue`` resource creates an SQS standard or FIFO queue.<br/> Keep the following caveats in mind:<br/> + If you don't specify the ``FifoQueue`` property, SQS creates a standard queue.<br/> You can't change the queue type after you create it and you can't convert an existing standard queue into a FIFO queue. You must either create a new FIFO queue for your application or delete your existing standard queue and recreate it as a FIFO queue. For more information, see [Moving from a standard queue to a FIFO queue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-moving.html) in the *Developer Guide*. <br/> + If you don't provide a value for a property, the queue is created with the default value for the property.<br/> + If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.<br/> + To successfully create a new queue, you must provide a queue name that adheres to the [limits related to queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-queues.html) and is unique within the scope of your queues.<br/> <br/> For more information about creating FIFO (first-in-first-out) queues, see [Creating an queue ()](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/screate-queue-cloudformation.html) in the *Developer Guide*.
Idaws.sqs.queues
+ +## Fields + + + + + +
NameDatatypeDescription
queue_urlstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +queue_url +FROM aws.sqs.queues +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the queues resource, the following permissions are required: + +### Create +```json +sqs:CreateQueue, +sqs:GetQueueUrl, +sqs:GetQueueAttributes, +sqs:ListQueueTags, +sqs:TagQueue +``` + +### List +```json +sqs:ListQueues +``` + diff --git a/docs/aws-docs/providers/aws/ssm/association/index.md b/docs/aws-docs/providers/aws/ssm/association/index.md new file mode 100644 index 0000000000..8128f72658 --- /dev/null +++ b/docs/aws-docs/providers/aws/ssm/association/index.md @@ -0,0 +1,126 @@ +--- +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
DescriptionThe AWS::SSM::Association resource associates an SSM document in AWS Systems Manager with EC2 instances that contain a configuration agent to process the document.
Idaws.ssm.association
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
association_namestringThe name of the association.
calendar_namesarray
schedule_expressionstringA Cron or Rate expression that specifies when the association is applied to the target.
max_errorsstring
parametersobjectParameter values that the SSM document uses at runtime.
instance_idstringThe ID of the instance that the SSM document is associated with.
wait_for_success_timeout_secondsinteger
max_concurrencystring
compliance_severitystring
targetsarrayThe targets that the SSM document sends commands to.
sync_compliancestring
output_locationobject
schedule_offsetinteger
namestringThe name of the SSM document.
apply_only_at_cron_intervalboolean
document_versionstringThe version of the SSM document to associate with the target.
association_idstringUnique identifier of the association.
automation_target_parameter_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +association_name, +calendar_names, +schedule_expression, +max_errors, +parameters, +instance_id, +wait_for_success_timeout_seconds, +max_concurrency, +compliance_severity, +targets, +sync_compliance, +output_location, +schedule_offset, +name, +apply_only_at_cron_interval, +document_version, +association_id, +automation_target_parameter_name +FROM aws.ssm.association +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the association resource, the following permissions are required: + +### Read +```json +ssm:DescribeAssociation, +resource-groups:GetGroupQuery, +resource-groups:ListGroups, +resource-groups:ListGroupResources +``` + +### Update +```json +iam:PassRole, +ssm:UpdateAssociation, +ssm:GetCalendarState +``` + +### Delete +```json +ssm:DeleteAssociation +``` + diff --git a/docs/aws-docs/providers/aws/ssm/associations/index.md b/docs/aws-docs/providers/aws/ssm/associations/index.md new file mode 100644 index 0000000000..1dbdc80f75 --- /dev/null +++ b/docs/aws-docs/providers/aws/ssm/associations/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionThe AWS::SSM::Association resource associates an SSM document in AWS Systems Manager with EC2 instances that contain a configuration agent to process the document.
Idaws.ssm.associations
+ +## Fields + + + + + +
NameDatatypeDescription
association_idstringUnique identifier of the association.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +association_id +FROM aws.ssm.associations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the associations resource, the following permissions are required: + +### Create +```json +ec2:DescribeInstanceStatus, +iam:PassRole, +iam:CreateServiceLinkedRole, +ssm:CreateAssociation, +ssm:DescribeAssociation, +ssm:GetCalendarState +``` + +### List +```json +ssm:ListAssociations +``` + diff --git a/docs/aws-docs/providers/aws/ssm/document/index.md b/docs/aws-docs/providers/aws/ssm/document/index.md new file mode 100644 index 0000000000..8d13a7448e --- /dev/null +++ b/docs/aws-docs/providers/aws/ssm/document/index.md @@ -0,0 +1,114 @@ +--- +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
DescriptionThe AWS::SSM::Document resource is an SSM document in AWS Systems Manager that defines the actions that Systems Manager performs, which can be used to set up and run commands on your instances.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +content, +attachments, +name, +version_name, +document_type, +document_format, +target_type, +tags, +requires, +update_method +FROM aws.ssm.document +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the document resource, the following permissions are required: + +### Read +```json +ssm:GetDocument, +ssm:ListTagsForResource +``` + +### Update +```json +ssm:UpdateDocument, +s3:GetObject, +ssm:AddTagsToResource, +ssm:RemoveTagsFromResource, +ssm:ListTagsForResource, +iam:PassRole, +ssm:UpdateDocumentDefaultVersion, +ssm:DescribeDocument +``` + +### Delete +```json +ssm:DeleteDocument, +ssm:GetDocument +``` + diff --git a/docs/aws-docs/providers/aws/ssm/documents/index.md b/docs/aws-docs/providers/aws/ssm/documents/index.md new file mode 100644 index 0000000000..7c0ef2aaa6 --- /dev/null +++ b/docs/aws-docs/providers/aws/ssm/documents/index.md @@ -0,0 +1,82 @@ +--- +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
DescriptionThe AWS::SSM::Document resource is an SSM document in AWS Systems Manager that defines the actions that Systems Manager performs, which can be used to set up and run commands on your instances.
Idaws.ssm.documents
+ +## Fields + + + + + +
NameDatatypeDescription
namestringA name for the Systems Manager document.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.ssm.documents +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the documents resource, the following permissions are required: + +### Create +```json +ssm:CreateDocument, +ssm:GetDocument, +ssm:AddTagsToResource, +ssm:ListTagsForResource, +s3:GetObject, +iam:PassRole +``` + +### List +```json +ssm:ListDocuments +``` + diff --git a/docs/aws-docs/providers/aws/ssm/index.md b/docs/aws-docs/providers/aws/ssm/index.md new file mode 100644 index 0000000000..846c08e6c7 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/ssm/parameter/index.md b/docs/aws-docs/providers/aws/ssm/parameter/index.md new file mode 100644 index 0000000000..abc1d975f5 --- /dev/null +++ b/docs/aws-docs/providers/aws/ssm/parameter/index.md @@ -0,0 +1,106 @@ +--- +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
DescriptionThe ``AWS::SSM::Parameter`` resource creates an SSM parameter in SYSlong Parameter Store.<br/> To create an SSM parameter, you must have the IAMlong (IAM) permissions ``ssm:PutParameter`` and ``ssm:AddTagsToResource``. On stack creation, CFNlong adds the following three tags to the parameter: ``aws:cloudformation:stack-name``, ``aws:cloudformation:logical-id``, and ``aws:cloudformation:stack-id``, in addition to any custom tags you specify.<br/> To add, update, or remove tags during stack update, you must have IAM permissions for both ``ssm:AddTagsToResource`` and ``ssm:RemoveTagsFromResource``. For more information, see [Managing Access Using Policies](https://docs.aws.amazon.com/systems-manager/latest/userguide/security-iam.html#security_iam_access-manage) in the *User Guide*.<br/> For information about valid values for parameters, see [About requirements and constraints for parameter names](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-su-create.html#sysman-parameter-name-constraints) in the *User Guide* and [PutParameter](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PutParameter.html) in the *API Reference*.
Idaws.ssm.parameter
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
typestringThe type of parameter.
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 Amazon Resource Name (ARN), is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters: ``arn:aws:ssm:us-east-2:111222333444:parameter/ExampleParameterName``
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +type, +value, +description, +policies, +allowed_pattern, +tier, +tags, +data_type, +name +FROM aws.ssm.parameter +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the parameter resource, the following permissions are required: + +### Read +```json +ssm:GetParameters +``` + +### Update +```json +ssm:PutParameter, +ssm:AddTagsToResource, +ssm:RemoveTagsFromResource, +ssm:GetParameters +``` + +### Delete +```json +ssm:DeleteParameter +``` + diff --git a/docs/aws-docs/providers/aws/ssm/parameters/index.md b/docs/aws-docs/providers/aws/ssm/parameters/index.md new file mode 100644 index 0000000000..d2df670d92 --- /dev/null +++ b/docs/aws-docs/providers/aws/ssm/parameters/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionThe ``AWS::SSM::Parameter`` resource creates an SSM parameter in SYSlong Parameter Store.<br/> To create an SSM parameter, you must have the IAMlong (IAM) permissions ``ssm:PutParameter`` and ``ssm:AddTagsToResource``. On stack creation, CFNlong adds the following three tags to the parameter: ``aws:cloudformation:stack-name``, ``aws:cloudformation:logical-id``, and ``aws:cloudformation:stack-id``, in addition to any custom tags you specify.<br/> To add, update, or remove tags during stack update, you must have IAM permissions for both ``ssm:AddTagsToResource`` and ``ssm:RemoveTagsFromResource``. For more information, see [Managing Access Using Policies](https://docs.aws.amazon.com/systems-manager/latest/userguide/security-iam.html#security_iam_access-manage) in the *User Guide*.<br/> For information about valid values for parameters, see [About requirements and constraints for parameter names](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-su-create.html#sysman-parameter-name-constraints) in the *User Guide* and [PutParameter](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PutParameter.html) in the *API Reference*.
Idaws.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 Amazon Resource Name (ARN), is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters: ``arn:aws:ssm:us-east-2:111222333444:parameter/ExampleParameterName``
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.ssm.parameters +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the parameters resource, the following permissions are required: + +### Create +```json +ssm:PutParameter, +ssm:AddTagsToResource, +ssm:GetParameters +``` + +### List +```json +ssm:DescribeParameters +``` + diff --git a/docs/aws-docs/providers/aws/ssm/patch_baseline/index.md b/docs/aws-docs/providers/aws/ssm/patch_baseline/index.md new file mode 100644 index 0000000000..a7d064ebf2 --- /dev/null +++ b/docs/aws-docs/providers/aws/ssm/patch_baseline/index.md @@ -0,0 +1,125 @@ +--- +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
DescriptionResource Type definition for AWS::SSM::PatchBaseline
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.ssm.patch_baseline +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the patch_baseline resource, the following permissions are required: + +### Delete +```json +ssm:DeletePatchBaseline, +ssm:GetPatchBaseline, +ssm:DeregisterPatchBaselineForPatchGroup +``` + +### Read +```json +ssm:GetDefaultPatchBaseline, +ssm:GetPatchBaseline, +ssm:ListTagsForResource +``` + +### Update +```json +ssm:UpdatePatchBaseline, +ssm:DeregisterPatchBaselineForPatchGroup, +ssm:AddTagsToResource, +ssm:RemoveTagsFromResource, +ssm:ListTagsForResource, +ssm:GetDefaultPatchBaseline, +ssm:RegisterDefaultPatchBaseline +``` + diff --git a/docs/aws-docs/providers/aws/ssm/patch_baselines/index.md b/docs/aws-docs/providers/aws/ssm/patch_baselines/index.md new file mode 100644 index 0000000000..e14aa62ddd --- /dev/null +++ b/docs/aws-docs/providers/aws/ssm/patch_baselines/index.md @@ -0,0 +1,86 @@ +--- +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
DescriptionResource Type definition for AWS::SSM::PatchBaseline
Idaws.ssm.patch_baselines
+ +## Fields + + + + + +
NameDatatypeDescription
idstringThe ID of the patch baseline.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.ssm.patch_baselines +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the patch_baselines resource, the following permissions are required: + +### Create +```json +ssm:CreatePatchBaseline, +ssm:RegisterPatchBaselineForPatchGroup, +ssm:AddTagsToResource, +ssm:RemoveTagsFromResource, +ssm:ListTagsForResource, +ssm:GetDefaultPatchBaseline, +ssm:RegisterDefaultPatchBaseline +``` + +### List +```json +ssm:DescribePatchBaselines, +ssm:GetDefaultPatchBaseline, +ssm:GetPatchBaseline, +ssm:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/ssm/resource_data_sync/index.md b/docs/aws-docs/providers/aws/ssm/resource_data_sync/index.md new file mode 100644 index 0000000000..b41925a730 --- /dev/null +++ b/docs/aws-docs/providers/aws/ssm/resource_data_sync/index.md @@ -0,0 +1,105 @@ +--- +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 Type definition for AWS::SSM::ResourceDataSync
Idaws.ssm.resource_data_sync
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
s3_destinationobject
kms_key_arnstring
sync_sourceobject
bucket_namestring
bucket_regionstring
sync_formatstring
sync_namestring
sync_typestring
bucket_prefixstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +s3_destination, +kms_key_arn, +sync_source, +bucket_name, +bucket_region, +sync_format, +sync_name, +sync_type, +bucket_prefix +FROM aws.ssm.resource_data_sync +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the resource_data_sync resource, the following permissions are required: + +### Delete +```json +ssm:ListResourceDataSync, +ssm:DeleteResourceDataSync +``` + +### Update +```json +ssm:ListResourceDataSync, +ssm:UpdateResourceDataSync +``` + +### Read +```json +ssm:ListResourceDataSync +``` + diff --git a/docs/aws-docs/providers/aws/ssm/resource_data_syncs/index.md b/docs/aws-docs/providers/aws/ssm/resource_data_syncs/index.md new file mode 100644 index 0000000000..1e80f78b8e --- /dev/null +++ b/docs/aws-docs/providers/aws/ssm/resource_data_syncs/index.md @@ -0,0 +1,78 @@ +--- +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 Type definition for AWS::SSM::ResourceDataSync
Idaws.ssm.resource_data_syncs
+ +## Fields + + + + + +
NameDatatypeDescription
sync_namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +sync_name +FROM aws.ssm.resource_data_syncs +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the resource_data_syncs resource, the following permissions are required: + +### Create +```json +ssm:CreateResourceDataSync, +ssm:ListResourceDataSync +``` + +### List +```json +ssm:ListResourceDataSync +``` + diff --git a/docs/aws-docs/providers/aws/ssm/resource_policies/index.md b/docs/aws-docs/providers/aws/ssm/resource_policies/index.md new file mode 100644 index 0000000000..d5a5b1fb1a --- /dev/null +++ b/docs/aws-docs/providers/aws/ssm/resource_policies/index.md @@ -0,0 +1,79 @@ +--- +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 Type definition for AWS::SSM::ResourcePolicy
Idaws.ssm.resource_policies
+ +## Fields + + + + + + +
NameDatatypeDescription
policy_idstringAn unique identifier within the policies of a resource.
resource_arnstringArn of OpsItemGroup etc.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +policy_id, +resource_arn +FROM aws.ssm.resource_policies +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the resource_policies resource, the following permissions are required: + +### Create +```json +ssm:PutResourcePolicy +``` + +### List +```json +ssm:GetResourcePolicies +``` + diff --git a/docs/aws-docs/providers/aws/ssm/resource_policy/index.md b/docs/aws-docs/providers/aws/ssm/resource_policy/index.md new file mode 100644 index 0000000000..dd88af4bad --- /dev/null +++ b/docs/aws-docs/providers/aws/ssm/resource_policy/index.md @@ -0,0 +1,93 @@ +--- +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 Type definition for AWS::SSM::ResourcePolicy
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +resource_arn, +policy, +policy_id, +policy_hash +FROM aws.ssm.resource_policy +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the resource_policy resource, the following permissions are required: + +### Read +```json +ssm:GetResourcePolicies +``` + +### Update +```json +ssm:PutResourcePolicy +``` + +### Delete +```json +ssm:DeleteResourcePolicy +``` + diff --git a/docs/aws-docs/providers/aws/ssmcontacts/contact/index.md b/docs/aws-docs/providers/aws/ssmcontacts/contact/index.md new file mode 100644 index 0000000000..95cedd9895 --- /dev/null +++ b/docs/aws-docs/providers/aws/ssmcontacts/contact/index.md @@ -0,0 +1,99 @@ +--- +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
DescriptionResource Type definition for AWS::SSMContacts::Contact
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +alias, +display_name, +type, +plan, +arn +FROM aws.ssmcontacts.contact +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the contact resource, the following permissions are required: + +### Read +```json +ssm-contacts:GetContact +``` + +### Update +```json +ssm-contacts:UpdateContact, +ssm-contacts:GetContact, +ssm-contacts:AssociateContact +``` + +### Delete +```json +ssm-contacts:DeleteContact, +ssm-contacts:GetContact, +ssm-contacts:AssociateContact +``` + diff --git a/docs/aws-docs/providers/aws/ssmcontacts/contact_channel/index.md b/docs/aws-docs/providers/aws/ssmcontacts/contact_channel/index.md new file mode 100644 index 0000000000..5fd89b6357 --- /dev/null +++ b/docs/aws-docs/providers/aws/ssmcontacts/contact_channel/index.md @@ -0,0 +1,99 @@ +--- +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
DescriptionResource Type definition for AWS::SSMContacts::ContactChannel
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +contact_id, +channel_name, +channel_type, +defer_activation, +channel_address, +arn +FROM aws.ssmcontacts.contact_channel +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the contact_channel resource, the following permissions are required: + +### Read +```json +ssm-contacts:GetContactChannel +``` + +### Update +```json +ssm-contacts:UpdateContactChannel, +ssm-contacts:GetContactChannel +``` + +### Delete +```json +ssm-contacts:DeleteContactChannel, +ssm-contacts:GetContactChannel +``` + diff --git a/docs/aws-docs/providers/aws/ssmcontacts/contact_channels/index.md b/docs/aws-docs/providers/aws/ssmcontacts/contact_channels/index.md new file mode 100644 index 0000000000..60d777a508 --- /dev/null +++ b/docs/aws-docs/providers/aws/ssmcontacts/contact_channels/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionResource Type definition for AWS::SSMContacts::ContactChannel
Idaws.ssmcontacts.contact_channels
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the engagement to a contact channel.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.ssmcontacts.contact_channels +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the contact_channels resource, the following permissions are required: + +### Create +```json +ssm-contacts:CreateContactChannel, +ssm-contacts:GetContactChannel +``` + +### List +```json +ssm-contacts:ListContactChannels +``` + diff --git a/docs/aws-docs/providers/aws/ssmcontacts/contacts/index.md b/docs/aws-docs/providers/aws/ssmcontacts/contacts/index.md new file mode 100644 index 0000000000..ecefb3b4f0 --- /dev/null +++ b/docs/aws-docs/providers/aws/ssmcontacts/contacts/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource Type definition for AWS::SSMContacts::Contact
Idaws.ssmcontacts.contacts
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the contact.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.ssmcontacts.contacts +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the contacts resource, the following permissions are required: + +### Create +```json +ssm-contacts:CreateContact, +ssm-contacts:GetContact, +ssm-contacts:AssociateContact +``` + +### List +```json +ssm-contacts:ListContacts +``` + diff --git a/docs/aws-docs/providers/aws/ssmcontacts/index.md b/docs/aws-docs/providers/aws/ssmcontacts/index.md new file mode 100644 index 0000000000..a45e0bc152 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/ssmcontacts/plan/index.md b/docs/aws-docs/providers/aws/ssmcontacts/plan/index.md new file mode 100644 index 0000000000..a10f66b08e --- /dev/null +++ b/docs/aws-docs/providers/aws/ssmcontacts/plan/index.md @@ -0,0 +1,97 @@ +--- +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
DescriptionEngagement Plan for a SSM Incident Manager Contact.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +contact_id, +stages, +rotation_ids, +arn +FROM aws.ssmcontacts.plan +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the plan resource, the following permissions are required: + +### Read +```json +ssm-contacts:GetContact +``` + +### Update +```json +ssm-contacts:UpdateContact, +ssm-contacts:GetContact, +ssm-contacts:AssociateContact +``` + +### Delete +```json +ssm-contacts:UpdateContact, +ssm-contacts:GetContact, +ssm-contacts:AssociateContact +``` + diff --git a/docs/aws-docs/providers/aws/ssmcontacts/plans/index.md b/docs/aws-docs/providers/aws/ssmcontacts/plans/index.md new file mode 100644 index 0000000000..7aaa4e968a --- /dev/null +++ b/docs/aws-docs/providers/aws/ssmcontacts/plans/index.md @@ -0,0 +1,69 @@ +--- +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
DescriptionEngagement Plan for a SSM Incident Manager Contact.
Idaws.ssmcontacts.plans
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the contact.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.ssmcontacts.plans +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the plans resource, the following permissions are required: + +### Create +```json +ssm-contacts:UpdateContact, +ssm-contacts:GetContact, +ssm-contacts:AssociateContact +``` + diff --git a/docs/aws-docs/providers/aws/ssmcontacts/rotation/index.md b/docs/aws-docs/providers/aws/ssmcontacts/rotation/index.md new file mode 100644 index 0000000000..521c514b8b --- /dev/null +++ b/docs/aws-docs/providers/aws/ssmcontacts/rotation/index.md @@ -0,0 +1,109 @@ +--- +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
DescriptionResource Type definition for AWS::SSMContacts::Rotation.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +contact_ids, +start_time, +time_zone_id, +recurrence, +tags, +arn +FROM aws.ssmcontacts.rotation +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the rotation resource, the following permissions are required: + +### Read +```json +ssm-contacts:GetRotation, +ssm-contacts:TagResource, +ssm-contacts:ListTagsForResource, +ssm-contacts:UntagResource +``` + +### Update +```json +ssm-contacts:UpdateRotation, +ssm-contacts:GetRotation, +ssm-contacts:TagResource, +ssm-contacts:ListTagsForResource, +ssm-contacts:UntagResource +``` + +### Delete +```json +ssm-contacts:DeleteRotation, +ssm-contacts:GetRotation, +ssm-contacts:ListTagsForResource, +ssm-contacts:UntagResource +``` + diff --git a/docs/aws-docs/providers/aws/ssmcontacts/rotations/index.md b/docs/aws-docs/providers/aws/ssmcontacts/rotations/index.md new file mode 100644 index 0000000000..e6c28869b9 --- /dev/null +++ b/docs/aws-docs/providers/aws/ssmcontacts/rotations/index.md @@ -0,0 +1,83 @@ +--- +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
DescriptionResource Type definition for AWS::SSMContacts::Rotation.
Idaws.ssmcontacts.rotations
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the rotation.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.ssmcontacts.rotations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the rotations resource, the following permissions are required: + +### Create +```json +ssm-contacts:CreateRotation, +ssm-contacts:GetRotation, +ssm-contacts:TagResource, +ssm-contacts:ListTagsForResource, +ssm-contacts:UntagResource +``` + +### List +```json +ssm-contacts:ListRotations, +ssm-contacts:GetRotation, +ssm-contacts:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/ssmincidents/index.md b/docs/aws-docs/providers/aws/ssmincidents/index.md new file mode 100644 index 0000000000..ccda4ff5ea --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/ssmincidents/replication_set/index.md b/docs/aws-docs/providers/aws/ssmincidents/replication_set/index.md new file mode 100644 index 0000000000..e69bd033e2 --- /dev/null +++ b/docs/aws-docs/providers/aws/ssmincidents/replication_set/index.md @@ -0,0 +1,101 @@ +--- +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
DescriptionResource type definition for AWS::SSMIncidents::ReplicationSet
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +regions, +deletion_protected, +tags +FROM aws.ssmincidents.replication_set +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the replication_set resource, the following permissions are required: + +### Read +```json +ssm-incidents:ListReplicationSets, +ssm-incidents:GetReplicationSet, +ssm-incidents:ListTagsForResource +``` + +### Update +```json +ssm-incidents:UpdateReplicationSet, +ssm-incidents:UpdateDeletionProtection, +ssm-incidents:GetReplicationSet, +ssm-incidents:TagResource, +ssm-incidents:UntagResource, +ssm-incidents:ListTagsForResource +``` + +### Delete +```json +ssm-incidents:DeleteReplicationSet, +ssm-incidents:GetReplicationSet +``` + diff --git a/docs/aws-docs/providers/aws/ssmincidents/replication_sets/index.md b/docs/aws-docs/providers/aws/ssmincidents/replication_sets/index.md new file mode 100644 index 0000000000..c3d4ed0751 --- /dev/null +++ b/docs/aws-docs/providers/aws/ssmincidents/replication_sets/index.md @@ -0,0 +1,83 @@ +--- +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
DescriptionResource type definition for AWS::SSMIncidents::ReplicationSet
Idaws.ssmincidents.replication_sets
+ +## Fields + + + + + +
NameDatatypeDescription
arnundefinedThe ARN of the ReplicationSet.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.ssmincidents.replication_sets +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the replication_sets resource, the following permissions are required: + +### Create +```json +ssm-incidents:CreateReplicationSet, +ssm-incidents:ListReplicationSets, +ssm-incidents:UpdateDeletionProtection, +ssm-incidents:GetReplicationSet, +ssm-incidents:TagResource, +ssm-incidents:ListTagsForResource, +iam:CreateServiceLinkedRole +``` + +### List +```json +ssm-incidents:ListReplicationSets +``` + diff --git a/docs/aws-docs/providers/aws/ssmincidents/response_plan/index.md b/docs/aws-docs/providers/aws/ssmincidents/response_plan/index.md new file mode 100644 index 0000000000..cc24e5a242 --- /dev/null +++ b/docs/aws-docs/providers/aws/ssmincidents/response_plan/index.md @@ -0,0 +1,113 @@ +--- +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
DescriptionResource type definition for AWS::SSMIncidents::ResponsePlan
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +name, +display_name, +chat_channel, +engagements, +actions, +integrations, +tags, +incident_template +FROM aws.ssmincidents.response_plan +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the response_plan resource, the following permissions are required: + +### Read +```json +ssm-incidents:GetResponsePlan, +ssm-incidents:ListTagsForResource +``` + +### Update +```json +ssm-incidents:UpdateResponsePlan, +ssm-incidents:GetResponsePlan, +ssm-incidents:TagResource, +ssm-incidents:UntagResource, +ssm-incidents:ListTagsForResource, +iam:PassRole, +secretsmanager:GetSecretValue, +kms:Decrypt, +kms:GenerateDataKey* +``` + +### Delete +```json +ssm-incidents:DeleteResponsePlan, +ssm-incidents:GetResponsePlan +``` + diff --git a/docs/aws-docs/providers/aws/ssmincidents/response_plans/index.md b/docs/aws-docs/providers/aws/ssmincidents/response_plans/index.md new file mode 100644 index 0000000000..5f55f531f6 --- /dev/null +++ b/docs/aws-docs/providers/aws/ssmincidents/response_plans/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionResource type definition for AWS::SSMIncidents::ResponsePlan
Idaws.ssmincidents.response_plans
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe ARN of the response plan.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.ssmincidents.response_plans +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the response_plans resource, the following permissions are required: + +### Create +```json +ssm-incidents:CreateResponsePlan, +ssm-incidents:GetResponsePlan, +ssm-incidents:TagResource, +ssm-incidents:ListTagsForResource, +iam:PassRole, +secretsmanager:GetSecretValue, +kms:Decrypt, +kms:GenerateDataKey* +``` + +### List +```json +ssm-incidents:ListResponsePlans +``` + diff --git a/docs/aws-docs/providers/aws/sso/assignment/index.md b/docs/aws-docs/providers/aws/sso/assignment/index.md new file mode 100644 index 0000000000..2ef03ad207 --- /dev/null +++ b/docs/aws-docs/providers/aws/sso/assignment/index.md @@ -0,0 +1,93 @@ +--- +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
DescriptionResource Type definition for SSO assignmet
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +instance_arn, +target_id, +target_type, +permission_set_arn, +principal_type, +principal_id +FROM aws.sso.assignment +WHERE data__Identifier = '|||||'; +``` + +## Permissions + +To operate on the assignment resource, the following permissions are required: + +### Read +```json +sso:ListAccountAssignments, +iam:GetSAMLProvider, +iam:ListRolePolicies +``` + +### Delete +```json +sso:ListAccountAssignments, +sso:DeleteAccountAssignment, +sso:DescribeAccountAssignmentDeletionStatus, +iam:GetSAMLProvider, +iam:ListRolePolicies +``` + diff --git a/docs/aws-docs/providers/aws/sso/assignments/index.md b/docs/aws-docs/providers/aws/sso/assignments/index.md new file mode 100644 index 0000000000..098f72516c --- /dev/null +++ b/docs/aws-docs/providers/aws/sso/assignments/index.md @@ -0,0 +1,96 @@ +--- +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
DescriptionResource Type definition for SSO assignmet
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +instance_arn, +target_id, +target_type, +permission_set_arn, +principal_type, +principal_id +FROM aws.sso.assignments +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the assignments resource, the following permissions are required: + +### Create +```json +sso:CreateAccountAssignment, +sso:DescribeAccountAssignmentCreationStatus, +sso:ListAccountAssignments, +iam:GetSAMLProvider, +iam:CreateSAMLProvider, +iam:AttachRolePolicy, +iam:PutRolePolicy, +iam:CreateRole, +iam:ListRolePolicies +``` + +### List +```json +sso:ListAccountAssignments, +iam:ListRolePolicies +``` + diff --git a/docs/aws-docs/providers/aws/sso/index.md b/docs/aws-docs/providers/aws/sso/index.md new file mode 100644 index 0000000000..03e4ff2fd6 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/sso/instance_access_control_attribute_configuration/index.md b/docs/aws-docs/providers/aws/sso/instance_access_control_attribute_configuration/index.md new file mode 100644 index 0000000000..ef72a0df61 --- /dev/null +++ b/docs/aws-docs/providers/aws/sso/instance_access_control_attribute_configuration/index.md @@ -0,0 +1,93 @@ +--- +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
DescriptionResource Type definition for SSO InstanceAccessControlAttributeConfiguration
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +instance_arn, +instance_access_control_attribute_configuration, +access_control_attributes +FROM aws.sso.instance_access_control_attribute_configuration +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the instance_access_control_attribute_configuration resource, the following permissions are required: + +### Read +```json +sso:DescribeInstanceAccessControlAttributeConfiguration +``` + +### Update +```json +sso:UpdateInstanceAccessControlAttributeConfiguration, +sso:DescribeInstanceAccessControlAttributeConfiguration +``` + +### Delete +```json +sso:DeleteInstanceAccessControlAttributeConfiguration, +sso:DescribeInstanceAccessControlAttributeConfiguration +``` + diff --git a/docs/aws-docs/providers/aws/sso/instance_access_control_attribute_configurations/index.md b/docs/aws-docs/providers/aws/sso/instance_access_control_attribute_configurations/index.md new file mode 100644 index 0000000000..9f5f5f223b --- /dev/null +++ b/docs/aws-docs/providers/aws/sso/instance_access_control_attribute_configurations/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource Type definition for SSO InstanceAccessControlAttributeConfiguration
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +instance_arn +FROM aws.sso.instance_access_control_attribute_configurations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the instance_access_control_attribute_configurations resource, the following permissions are required: + +### Create +```json +sso:CreateInstanceAccessControlAttributeConfiguration, +sso:UpdateApplicationProfileForAWSAccountInstance, +sso:DescribeInstanceAccessControlAttributeConfiguration +``` + +### List +```json +sso:DescribeInstanceAccessControlAttributeConfiguration +``` + diff --git a/docs/aws-docs/providers/aws/sso/permission_set/index.md b/docs/aws-docs/providers/aws/sso/permission_set/index.md new file mode 100644 index 0000000000..c3666114af --- /dev/null +++ b/docs/aws-docs/providers/aws/sso/permission_set/index.md @@ -0,0 +1,130 @@ +--- +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
DescriptionResource Type definition for SSO PermissionSet
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.sso.permission_set +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the permission_set resource, the following permissions are required: + +### Read +```json +sso:DescribePermissionSet, +sso:ListTagsForResource, +sso:ListManagedPoliciesInPermissionSet, +sso:ListCustomerManagedPolicyReferencesInPermissionSet, +sso:GetInlinePolicyForPermissionSet, +sso:GetPermissionsBoundaryForPermissionSet +``` + +### Update +```json +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 +```json +sso:DeletePermissionSet +``` + diff --git a/docs/aws-docs/providers/aws/sso/permission_sets/index.md b/docs/aws-docs/providers/aws/sso/permission_sets/index.md new file mode 100644 index 0000000000..1ddab2cf32 --- /dev/null +++ b/docs/aws-docs/providers/aws/sso/permission_sets/index.md @@ -0,0 +1,90 @@ +--- +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
DescriptionResource Type definition for SSO PermissionSet
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +instance_arn, +permission_set_arn +FROM aws.sso.permission_sets +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the permission_sets resource, the following permissions are required: + +### Create +```json +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 +```json +sso:DescribePermissionSet +``` + diff --git a/docs/aws-docs/providers/aws/stepfunctions/activities/index.md b/docs/aws-docs/providers/aws/stepfunctions/activities/index.md new file mode 100644 index 0000000000..7d1fc8d5a1 --- /dev/null +++ b/docs/aws-docs/providers/aws/stepfunctions/activities/index.md @@ -0,0 +1,67 @@ +--- +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
DescriptionResource schema for Activity
Idaws.stepfunctions.activities
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.stepfunctions.activities +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the activities resource, the following permissions are required: + +### Create +```json +states:CreateActivity +``` + diff --git a/docs/aws-docs/providers/aws/stepfunctions/activity/index.md b/docs/aws-docs/providers/aws/stepfunctions/activity/index.md new file mode 100644 index 0000000000..5552d421bb --- /dev/null +++ b/docs/aws-docs/providers/aws/stepfunctions/activity/index.md @@ -0,0 +1,94 @@ +--- +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
DescriptionResource schema for Activity
Idaws.stepfunctions.activity
+ +## Fields + + + + + + + +
NameDatatypeDescription
arnstring
namestring
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +name, +tags +FROM aws.stepfunctions.activity +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the activity resource, the following permissions are required: + +### Read +```json +states:DescribeActivity, +states:ListTagsForResource +``` + +### Update +```json +states:ListTagsForResource, +states:TagResource, +states:UntagResource +``` + +### Delete +```json +states:DeleteActivity +``` + diff --git a/docs/aws-docs/providers/aws/stepfunctions/index.md b/docs/aws-docs/providers/aws/stepfunctions/index.md new file mode 100644 index 0000000000..e7a0ead462 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/stepfunctions/state_machine/index.md b/docs/aws-docs/providers/aws/stepfunctions/state_machine/index.md new file mode 100644 index 0000000000..a97d218f0c --- /dev/null +++ b/docs/aws-docs/providers/aws/stepfunctions/state_machine/index.md @@ -0,0 +1,117 @@ +--- +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
DescriptionResource schema for StateMachine
Idaws.stepfunctions.state_machine
+ +## Fields + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
definition_substitutionsobject
definitionobject
role_arnstring
namestring
state_machine_typestring
tracing_configurationobject
definition_stringstring
logging_configurationobject
state_machine_revision_idstring
definition_s3_locationobject
arnstring
state_machine_namestring
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +definition_substitutions, +definition, +role_arn, +name, +state_machine_type, +tracing_configuration, +definition_string, +logging_configuration, +state_machine_revision_id, +definition_s3_location, +arn, +state_machine_name, +tags +FROM aws.stepfunctions.state_machine +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the state_machine resource, the following permissions are required: + +### Read +```json +states:DescribeStateMachine, +states:ListTagsForResource +``` + +### Update +```json +states:UpdateStateMachine, +states:TagResource, +states:UntagResource, +states:ListTagsForResource, +iam:PassRole +``` + +### Delete +```json +states:DeleteStateMachine, +states:DescribeStateMachine +``` + diff --git a/docs/aws-docs/providers/aws/stepfunctions/state_machine_alias/index.md b/docs/aws-docs/providers/aws/stepfunctions/state_machine_alias/index.md new file mode 100644 index 0000000000..1f7e371ff1 --- /dev/null +++ b/docs/aws-docs/providers/aws/stepfunctions/state_machine_alias/index.md @@ -0,0 +1,98 @@ +--- +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
DescriptionResource schema for StateMachineAlias
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +name, +description, +routing_configuration, +deployment_preference +FROM aws.stepfunctions.state_machine_alias +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the state_machine_alias resource, the following permissions are required: + +### Read +```json +states:DescribeStateMachineAlias +``` + +### Update +```json +cloudwatch:DescribeAlarms, +states:UpdateStateMachineAlias, +states:DescribeStateMachineAlias +``` + +### Delete +```json +states:DescribeStateMachineAlias, +states:DeleteStateMachineAlias +``` + diff --git a/docs/aws-docs/providers/aws/stepfunctions/state_machine_aliases/index.md b/docs/aws-docs/providers/aws/stepfunctions/state_machine_aliases/index.md new file mode 100644 index 0000000000..af37405b99 --- /dev/null +++ b/docs/aws-docs/providers/aws/stepfunctions/state_machine_aliases/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionResource schema for StateMachineAlias
Idaws.stepfunctions.state_machine_aliases
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe ARN of the alias.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.stepfunctions.state_machine_aliases +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the state_machine_aliases resource, the following permissions are required: + +### Create +```json +states:CreateStateMachineAlias, +states:DescribeStateMachineAlias +``` + +### List +```json +states:ListStateMachineAliases +``` + diff --git a/docs/aws-docs/providers/aws/stepfunctions/state_machine_version/index.md b/docs/aws-docs/providers/aws/stepfunctions/state_machine_version/index.md new file mode 100644 index 0000000000..4562acf91f --- /dev/null +++ b/docs/aws-docs/providers/aws/stepfunctions/state_machine_version/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionResource schema for StateMachineVersion
Idaws.stepfunctions.state_machine_version
+ +## Fields + + + + + + + + +
NameDatatypeDescription
arnstring
state_machine_arnstring
state_machine_revision_idstring
descriptionstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +state_machine_arn, +state_machine_revision_id, +description +FROM aws.stepfunctions.state_machine_version +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the state_machine_version resource, the following permissions are required: + +### Read +```json +states:DescribeStateMachine +``` + +### Delete +```json +states:DeleteStateMachineVersion, +states:DescribeStateMachine +``` + diff --git a/docs/aws-docs/providers/aws/stepfunctions/state_machine_versions/index.md b/docs/aws-docs/providers/aws/stepfunctions/state_machine_versions/index.md new file mode 100644 index 0000000000..d3e008db58 --- /dev/null +++ b/docs/aws-docs/providers/aws/stepfunctions/state_machine_versions/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource schema for StateMachineVersion
Idaws.stepfunctions.state_machine_versions
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.stepfunctions.state_machine_versions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the state_machine_versions resource, the following permissions are required: + +### Create +```json +states:PublishStateMachineVersion, +states:ListStateMachineVersions, +states:DescribeStateMachine +``` + +### List +```json +states:ListStateMachineVersions +``` + diff --git a/docs/aws-docs/providers/aws/stepfunctions/state_machines/index.md b/docs/aws-docs/providers/aws/stepfunctions/state_machines/index.md new file mode 100644 index 0000000000..c8fb50c1ac --- /dev/null +++ b/docs/aws-docs/providers/aws/stepfunctions/state_machines/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionResource schema for StateMachine
Idaws.stepfunctions.state_machines
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.stepfunctions.state_machines +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the state_machines resource, the following permissions are required: + +### Create +```json +states:CreateStateMachine, +states:DescribeStateMachine, +states:TagResource, +iam:PassRole, +s3:GetObject +``` + +### List +```json +states:ListStateMachines +``` + diff --git a/docs/aws-docs/providers/aws/supportapp/account_alias/index.md b/docs/aws-docs/providers/aws/supportapp/account_alias/index.md new file mode 100644 index 0000000000..1c332c6dee --- /dev/null +++ b/docs/aws-docs/providers/aws/supportapp/account_alias/index.md @@ -0,0 +1,91 @@ +--- +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
DescriptionAn AWS Support App resource that creates, updates, reads, and deletes a customer's account alias.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +account_alias, +account_alias_resource_id +FROM aws.supportapp.account_alias +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the account_alias resource, the following permissions are required: + +### Read +```json +supportapp:GetAccountAlias +``` + +### Update +```json +supportapp:PutAccountAlias, +supportapp:GetAccountAlias +``` + +### Delete +```json +supportapp:DeleteAccountAlias, +supportapp:GetAccountAlias +``` + diff --git a/docs/aws-docs/providers/aws/supportapp/account_aliases/index.md b/docs/aws-docs/providers/aws/supportapp/account_aliases/index.md new file mode 100644 index 0000000000..4da90c018c --- /dev/null +++ b/docs/aws-docs/providers/aws/supportapp/account_aliases/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionAn AWS Support App resource that creates, updates, reads, and deletes a customer's account alias.
Idaws.supportapp.account_aliases
+ +## Fields + + + + + +
NameDatatypeDescription
account_alias_resource_idstringUnique identifier representing an alias tied to an account
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +account_alias_resource_id +FROM aws.supportapp.account_aliases +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the account_aliases resource, the following permissions are required: + +### Create +```json +supportapp:PutAccountAlias, +supportapp:GetAccountAlias +``` + +### List +```json +supportapp:GetAccountAlias +``` + diff --git a/docs/aws-docs/providers/aws/supportapp/index.md b/docs/aws-docs/providers/aws/supportapp/index.md new file mode 100644 index 0000000000..a3be4fd27c --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/supportapp/slack_channel_configuration/index.md b/docs/aws-docs/providers/aws/supportapp/slack_channel_configuration/index.md new file mode 100644 index 0000000000..1a5c25823f --- /dev/null +++ b/docs/aws-docs/providers/aws/supportapp/slack_channel_configuration/index.md @@ -0,0 +1,103 @@ +--- +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
DescriptionAn AWS Support App resource that creates, updates, lists and deletes Slack channel configurations.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.supportapp.slack_channel_configuration +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the slack_channel_configuration resource, the following permissions are required: + +### Read +```json +supportapp:ListSlackChannelConfigurations +``` + +### Update +```json +supportapp:UpdateSlackChannelConfiguration, +supportapp:ListSlackChannelConfigurations +``` + +### Delete +```json +supportapp:DeleteSlackChannelConfiguration, +supportapp:ListSlackChannelConfigurations +``` + diff --git a/docs/aws-docs/providers/aws/supportapp/slack_channel_configurations/index.md b/docs/aws-docs/providers/aws/supportapp/slack_channel_configurations/index.md new file mode 100644 index 0000000000..99e7ca8030 --- /dev/null +++ b/docs/aws-docs/providers/aws/supportapp/slack_channel_configurations/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionAn AWS Support App resource that creates, updates, lists and deletes Slack channel configurations.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +team_id, +channel_id +FROM aws.supportapp.slack_channel_configurations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the slack_channel_configurations resource, the following permissions are required: + +### Create +```json +supportapp:CreateSlackChannelConfiguration, +supportapp:ListSlackChannelConfigurations +``` + +### List +```json +supportapp:ListSlackChannelConfigurations +``` + diff --git a/docs/aws-docs/providers/aws/supportapp/slack_workspace_configuration/index.md b/docs/aws-docs/providers/aws/supportapp/slack_workspace_configuration/index.md new file mode 100644 index 0000000000..feb7457bc4 --- /dev/null +++ b/docs/aws-docs/providers/aws/supportapp/slack_workspace_configuration/index.md @@ -0,0 +1,91 @@ +--- +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
DescriptionAn AWS Support App resource that creates, updates, lists, and deletes Slack workspace configurations.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +team_id, +version_id +FROM aws.supportapp.slack_workspace_configuration +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the slack_workspace_configuration resource, the following permissions are required: + +### Read +```json +supportapp:ListSlackWorkspaceConfigurations +``` + +### Update +```json +supportapp:RegisterSlackWorkspaceForOrganization, +supportapp:ListSlackWorkspaceConfigurations +``` + +### Delete +```json +supportapp:ListSlackWorkspaceConfigurations, +supportapp:DeleteSlackWorkspaceConfiguration +``` + diff --git a/docs/aws-docs/providers/aws/supportapp/slack_workspace_configurations/index.md b/docs/aws-docs/providers/aws/supportapp/slack_workspace_configurations/index.md new file mode 100644 index 0000000000..0632d1336a --- /dev/null +++ b/docs/aws-docs/providers/aws/supportapp/slack_workspace_configurations/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionAn AWS Support App resource that creates, updates, lists, and deletes Slack workspace configurations.
Idaws.supportapp.slack_workspace_configurations
+ +## Fields + + + + + +
NameDatatypeDescription
team_idstringThe team ID in Slack, which uniquely identifies a workspace.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +team_id +FROM aws.supportapp.slack_workspace_configurations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the slack_workspace_configurations resource, the following permissions are required: + +### Create +```json +supportapp:RegisterSlackWorkspaceForOrganization, +supportapp:ListSlackWorkspaceConfigurations +``` + +### List +```json +supportapp:ListSlackWorkspaceConfigurations +``` + diff --git a/docs/aws-docs/providers/aws/synthetics/canaries/index.md b/docs/aws-docs/providers/aws/synthetics/canaries/index.md new file mode 100644 index 0000000000..0f6a21c34f --- /dev/null +++ b/docs/aws-docs/providers/aws/synthetics/canaries/index.md @@ -0,0 +1,98 @@ +--- +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
DescriptionResource Type definition for AWS::Synthetics::Canary
Idaws.synthetics.canaries
+ +## Fields + + + + + +
NameDatatypeDescription
namestringName of the canary.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.synthetics.canaries +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the canaries resource, the following permissions are required: + +### Create +```json +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 +```json +synthetics:DescribeCanaries +``` + diff --git a/docs/aws-docs/providers/aws/synthetics/canary/index.md b/docs/aws-docs/providers/aws/synthetics/canary/index.md new file mode 100644 index 0000000000..5c8a984751 --- /dev/null +++ b/docs/aws-docs/providers/aws/synthetics/canary/index.md @@ -0,0 +1,143 @@ +--- +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
DescriptionResource Type definition for AWS::Synthetics::Canary
Idaws.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
vpc_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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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, +vpc_config, +run_config, +start_canary_after_creation, +visual_reference, +delete_lambda_resources_on_canary_deletion +FROM aws.synthetics.canary +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the canary resource, the following permissions are required: + +### Update +```json +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 +```json +synthetics:GetCanary, +synthetics:DescribeCanaries, +synthetics:ListTagsForResource, +iam:ListRoles, +s3:ListAllMyBuckets, +s3:GetBucketLocation +``` + +### Delete +```json +synthetics:DeleteCanary, +synthetics:GetCanary +``` + diff --git a/docs/aws-docs/providers/aws/synthetics/group/index.md b/docs/aws-docs/providers/aws/synthetics/group/index.md new file mode 100644 index 0000000000..aad35e9deb --- /dev/null +++ b/docs/aws-docs/providers/aws/synthetics/group/index.md @@ -0,0 +1,101 @@ +--- +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
DescriptionResource Type definition for AWS::Synthetics::Group
Idaws.synthetics.group
+ +## Fields + + + + + + + + +
NameDatatypeDescription
namestringName of the group.
idstringId of the group.
tagsarray
resource_arnsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +name, +id, +tags, +resource_arns +FROM aws.synthetics.group +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the group resource, the following permissions are required: + +### Update +```json +synthetics:AssociateResource, +synthetics:DisassociateResource, +synthetics:TagResource, +synthetics:UntagResource, +synthetics:GetGroup, +synthetics:ListGroupResources +``` + +### Read +```json +synthetics:GetGroup, +synthetics:ListTagsForResource, +synthetics:ListGroupResources +``` + +### Delete +```json +synthetics:DeleteGroup, +synthetics:GetGroup +``` + diff --git a/docs/aws-docs/providers/aws/synthetics/groups/index.md b/docs/aws-docs/providers/aws/synthetics/groups/index.md new file mode 100644 index 0000000000..638d819f71 --- /dev/null +++ b/docs/aws-docs/providers/aws/synthetics/groups/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionResource Type definition for AWS::Synthetics::Group
Idaws.synthetics.groups
+ +## Fields + + + + + +
NameDatatypeDescription
namestringName of the group.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name +FROM aws.synthetics.groups +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the groups resource, the following permissions are required: + +### Create +```json +synthetics:CreateGroup, +synthetics:AssociateResource, +synthetics:TagResource, +synthetics:GetGroup +``` + +### List +```json +synthetics:ListGroups +``` + diff --git a/docs/aws-docs/providers/aws/synthetics/index.md b/docs/aws-docs/providers/aws/synthetics/index.md new file mode 100644 index 0000000000..0b7ba29c19 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/systemsmanagersap/application/index.md b/docs/aws-docs/providers/aws/systemsmanagersap/application/index.md new file mode 100644 index 0000000000..f754f1b17d --- /dev/null +++ b/docs/aws-docs/providers/aws/systemsmanagersap/application/index.md @@ -0,0 +1,106 @@ +--- +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
DescriptionResource schema for AWS::SystemsManagerSAP::Application
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +application_id, +application_type, +arn, +credentials, +instances, +sap_instance_number, +sid, +tags +FROM aws.systemsmanagersap.application +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the application resource, the following permissions are required: + +### Read +```json +ssm-sap:GetApplication, +ssm-sap:ListTagsForResource +``` + +### Update +```json +ssm-sap:TagResource, +ssm-sap:UntagResource, +ssm-sap:ListTagsForResource, +ssm-sap:GetApplication +``` + +### Delete +```json +ssm-sap:DeregisterApplication, +ssm-sap:GetApplication +``` + diff --git a/docs/aws-docs/providers/aws/systemsmanagersap/applications/index.md b/docs/aws-docs/providers/aws/systemsmanagersap/applications/index.md new file mode 100644 index 0000000000..12d8a2f30d --- /dev/null +++ b/docs/aws-docs/providers/aws/systemsmanagersap/applications/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionResource schema for AWS::SystemsManagerSAP::Application
Idaws.systemsmanagersap.applications
+ +## Fields + + + + + +
NameDatatypeDescription
arnstringThe ARN of the Helix application
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.systemsmanagersap.applications +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the applications resource, the following permissions are required: + +### Create +```json +ssm-sap:RegisterApplication, +ssm-sap:GetApplication, +ssm-sap:TagResource, +ssm-sap:ListTagsForResource +``` + +### List +```json +ssm-sap:ListApplications +``` + diff --git a/docs/aws-docs/providers/aws/systemsmanagersap/index.md b/docs/aws-docs/providers/aws/systemsmanagersap/index.md new file mode 100644 index 0000000000..d35643ccb1 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/timestream/database/index.md b/docs/aws-docs/providers/aws/timestream/database/index.md new file mode 100644 index 0000000000..9693335d0b --- /dev/null +++ b/docs/aws-docs/providers/aws/timestream/database/index.md @@ -0,0 +1,100 @@ +--- +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
DescriptionThe AWS::Timestream::Database resource creates a Timestream database.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +database_name, +kms_key_id, +tags +FROM aws.timestream.database +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the database resource, the following permissions are required: + +### Read +```json +timestream:DescribeDatabase, +timestream:DescribeEndpoints, +timestream:ListTagsForResource +``` + +### Update +```json +timestream:UpdateDatabase, +timestream:DescribeDatabase, +timestream:DescribeEndpoints, +timestream:TagResource, +timestream:UntagResource +``` + +### Delete +```json +timestream:DeleteDatabase, +timestream:DescribeEndpoints +``` + diff --git a/docs/aws-docs/providers/aws/timestream/databases/index.md b/docs/aws-docs/providers/aws/timestream/databases/index.md new file mode 100644 index 0000000000..2fd885b1d9 --- /dev/null +++ b/docs/aws-docs/providers/aws/timestream/databases/index.md @@ -0,0 +1,83 @@ +--- +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
DescriptionThe AWS::Timestream::Database resource creates a Timestream database.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +database_name +FROM aws.timestream.databases +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the databases resource, the following permissions are required: + +### Create +```json +timestream:CreateDatabase, +timestream:DescribeEndpoints, +timestream:TagResource, +kms:CreateGrant, +kms:DescribeKey, +kms:Decrypt +``` + +### List +```json +timestream:ListDatabases, +timestream:DescribeEndpoints +``` + diff --git a/docs/aws-docs/providers/aws/timestream/index.md b/docs/aws-docs/providers/aws/timestream/index.md new file mode 100644 index 0000000000..edf74045f4 --- /dev/null +++ b/docs/aws-docs/providers/aws/timestream/index.md @@ -0,0 +1,45 @@ +--- +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: 8
+total selectable resources: 8
+total methods: 8
+
+
+ +::: + +## Resources +
+
+database
+databases
+influxdb_instance
+influxdb_instances +
+
+scheduled_queries
+scheduled_query
+table
+tables +
+
\ No newline at end of file diff --git a/docs/aws-docs/providers/aws/timestream/influxdb_instance/index.md b/docs/aws-docs/providers/aws/timestream/influxdb_instance/index.md new file mode 100644 index 0000000000..cc9e8fc48f --- /dev/null +++ b/docs/aws-docs/providers/aws/timestream/influxdb_instance/index.md @@ -0,0 +1,139 @@ +--- +title: influxdb_instance +hide_title: false +hide_table_of_contents: false +keywords: + - influxdb_instance + - 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 influxdb_instance resource + +## Overview + + + + + +
Nameinfluxdb_instance
TypeResource
DescriptionThe AWS::Timestream::InfluxDBInstance resource creates an InfluxDB instance.
Idaws.timestream.influxdb_instance
+ +## Fields + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
usernamestringThe username for the InfluxDB instance.
passwordstringThe password for the InfluxDB instance.
organizationstringThe organization for the InfluxDB instance.
bucketstringThe bucket for the InfluxDB instance.
db_instance_typestringThe compute instance of the InfluxDB instance.
vpc_subnet_idsarrayA list of EC2 subnet IDs for this InfluxDB instance.
vpc_security_group_idsarrayA list of Amazon EC2 VPC security groups to associate with this InfluxDB instance.
publicly_accessiblebooleanAttach a public IP to the customer ENI.
db_storage_typestringThe storage type of the InfluxDB instance.
allocated_storageintegerThe allocated storage for the InfluxDB instance.
db_parameter_group_identifierstringThe name of an existing InfluxDB parameter group.
log_delivery_configurationobjectConfiguration for sending logs to customer account from the InfluxDB instance.
statusstringStatus of the InfluxDB Instance.
arnstringThe Amazon Resource Name (ARN) that is associated with the InfluxDB instance.
namestringThe unique name that is associated with the InfluxDB instance.
availability_zonestringThe Availability Zone (AZ) where the InfluxDB instance is created.
secondary_availability_zonestringThe Secondary Availability Zone (AZ) where the InfluxDB instance is created, if DeploymentType is set as WITH_MULTIAZ_STANDBY.
endpointstringThe connection endpoint for the InfluxDB instance.
influx_auth_parameters_secret_arnstringThe Auth parameters secret Amazon Resource name (ARN) that is associated with the InfluxDB instance.
idstringThe service generated unique identifier for InfluxDB instance.
deployment_typestringDeployment type of the InfluxDB Instance.
tagsarrayAn arbitrary set of tags (key-value pairs) for this DB instance.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +username, +password, +organization, +bucket, +db_instance_type, +vpc_subnet_ids, +vpc_security_group_ids, +publicly_accessible, +db_storage_type, +allocated_storage, +db_parameter_group_identifier, +log_delivery_configuration, +status, +arn, +name, +availability_zone, +secondary_availability_zone, +endpoint, +influx_auth_parameters_secret_arn, +id, +deployment_type, +tags +FROM aws.timestream.influxdb_instance +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the influxdb_instance resource, the following permissions are required: + +### Read +```json +timestream-influxdb:GetDbInstance, +timestream-influxdb:ListTagsForResource +``` + +### Update +```json +s3:ListBucket, +s3:GetBucketPolicy, +timestream-influxdb:GetDbInstance, +timestream-influxdb:ListDbInstances, +timestream-influxdb:UpdateDbInstance, +timestream-influxdb:TagResource, +timestream-influxdb:UntagResource, +timestream-influxdb:ListTagsForResource +``` + +### Delete +```json +timestream-influxdb:GetDbInstance, +timestream-influxdb:ListDbInstances, +timestream-influxdb:DeleteDbInstance +``` + diff --git a/docs/aws-docs/providers/aws/timestream/influxdb_instances/index.md b/docs/aws-docs/providers/aws/timestream/influxdb_instances/index.md new file mode 100644 index 0000000000..13fa02f35a --- /dev/null +++ b/docs/aws-docs/providers/aws/timestream/influxdb_instances/index.md @@ -0,0 +1,89 @@ +--- +title: influxdb_instances +hide_title: false +hide_table_of_contents: false +keywords: + - influxdb_instances + - 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 influxdb_instances in a region + +## Overview + + + + + +
Nameinfluxdb_instances
TypeResource
DescriptionThe AWS::Timestream::InfluxDBInstance resource creates an InfluxDB instance.
Idaws.timestream.influxdb_instances
+ +## Fields + + + + + +
NameDatatypeDescription
idstringThe service generated unique identifier for InfluxDB instance.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.timestream.influxdb_instances +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the influxdb_instances resource, the following permissions are required: + +### Create +```json +s3:ListBucket, +s3:GetBucketPolicy, +timestream-influxdb:GetDbInstance, +timestream-influxdb:ListDbInstances, +timestream-influxdb:CreateDbInstance, +timestream-influxdb:TagResource, +timestream-influxdb:ListTagsForResource, +ec2:DescribeSubnets, +ec2:DescribeVpcs, +ec2:DescribeNetworkInterfaces, +ec2:DescribeSecurityGroups, +ec2:CreateNetworkInterface, +iam:CreateServiceLinkedRole +``` + +### List +```json +timestream-influxdb:ListDbInstances +``` + diff --git a/docs/aws-docs/providers/aws/timestream/scheduled_queries/index.md b/docs/aws-docs/providers/aws/timestream/scheduled_queries/index.md new file mode 100644 index 0000000000..343d014afd --- /dev/null +++ b/docs/aws-docs/providers/aws/timestream/scheduled_queries/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionThe AWS::Timestream::ScheduledQuery resource creates a Timestream Scheduled Query.
Idaws.timestream.scheduled_queries
+ +## Fields + + + + + +
NameDatatypeDescription
arnundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.timestream.scheduled_queries +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the scheduled_queries resource, the following permissions are required: + +### Create +```json +timestream:CreateScheduledQuery, +timestream:DescribeEndpoints +``` + +### List +```json +timestream:ListScheduledQueries, +timestream:DescribeEndpoints +``` + diff --git a/docs/aws-docs/providers/aws/timestream/scheduled_query/index.md b/docs/aws-docs/providers/aws/timestream/scheduled_query/index.md new file mode 100644 index 0000000000..2435a05f37 --- /dev/null +++ b/docs/aws-docs/providers/aws/timestream/scheduled_query/index.md @@ -0,0 +1,129 @@ +--- +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
DescriptionThe AWS::Timestream::ScheduledQuery resource creates a Timestream Scheduled Query.
Idaws.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
sq_namestringThe name of the scheduled query. Scheduled query names must be unique within each Region.
sq_query_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.
sq_schedule_configurationstringConfiguration for when the scheduled query is executed.
sq_notification_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.
sq_scheduled_query_execution_role_arnstringThe ARN for the IAM role that Timestream will assume when running the scheduled query.
sq_target_configurationstringConfiguration of target store where scheduled query results are written to.
sq_error_report_configurationstringConfiguration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
sq_kms_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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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, +sq_name, +sq_query_string, +sq_schedule_configuration, +sq_notification_configuration, +sq_scheduled_query_execution_role_arn, +sq_target_configuration, +sq_error_report_configuration, +sq_kms_key_id, +tags +FROM aws.timestream.scheduled_query +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the scheduled_query resource, the following permissions are required: + +### Read +```json +timestream:DescribeScheduledQuery, +timestream:ListTagsForResource, +timestream:DescribeEndpoints +``` + +### Update +```json +timestream:UpdateScheduledQuery, +timestream:TagResource, +timestream:UntagResource, +timestream:DescribeEndpoints +``` + +### Delete +```json +timestream:DeleteScheduledQuery, +timestream:DescribeEndpoints +``` + diff --git a/docs/aws-docs/providers/aws/timestream/table/index.md b/docs/aws-docs/providers/aws/timestream/table/index.md new file mode 100644 index 0000000000..ff9b35fef4 --- /dev/null +++ b/docs/aws-docs/providers/aws/timestream/table/index.md @@ -0,0 +1,114 @@ +--- +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
DescriptionThe AWS::Timestream::Table resource creates a Timestream Table.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +name, +database_name, +table_name, +retention_properties, +schema, +magnetic_store_write_properties, +tags +FROM aws.timestream.table +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the table resource, the following permissions are required: + +### Read +```json +timestream:DescribeTable, +timestream:DescribeEndpoints, +timestream:ListTagsForResource +``` + +### Update +```json +timestream:UpdateTable, +timestream:DescribeEndpoints, +timestream:TagResource, +timestream:UntagResource, +s3:PutObject, +s3:GetObject, +s3:GetBucketAcl, +kms:GenerateDataKey*, +kms:DescribeKey, +kms:Encrypt +``` + +### Delete +```json +timestream:DeleteTable, +timestream:DescribeEndpoints, +timestream:DescribeTable +``` + diff --git a/docs/aws-docs/providers/aws/timestream/tables/index.md b/docs/aws-docs/providers/aws/timestream/tables/index.md new file mode 100644 index 0000000000..0d02afe37b --- /dev/null +++ b/docs/aws-docs/providers/aws/timestream/tables/index.md @@ -0,0 +1,88 @@ +--- +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
DescriptionThe AWS::Timestream::Table resource creates a Timestream Table.
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +database_name, +table_name +FROM aws.timestream.tables +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the tables resource, the following permissions are required: + +### Create +```json +timestream:CreateTable, +timestream:DescribeEndpoints, +timestream:TagResource, +s3:PutObject, +s3:GetObject, +s3:GetBucketAcl, +kms:GenerateDataKey*, +kms:DescribeKey, +kms:Encrypt +``` + +### List +```json +timestream:ListTables, +timestream:DescribeEndpoints +``` + diff --git a/docs/aws-docs/providers/aws/transfer/agreement/index.md b/docs/aws-docs/providers/aws/transfer/agreement/index.md new file mode 100644 index 0000000000..9ab321a3b9 --- /dev/null +++ b/docs/aws-docs/providers/aws/transfer/agreement/index.md @@ -0,0 +1,108 @@ +--- +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
DescriptionResource Type definition for AWS::Transfer::Agreement
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +description, +server_id, +local_profile_id, +partner_profile_id, +base_directory, +access_role, +status, +tags, +agreement_id, +arn +FROM aws.transfer.agreement +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the agreement resource, the following permissions are required: + +### Read +```json +transfer:DescribeAgreement +``` + +### Update +```json +transfer:UpdateAgreement, +transfer:UnTagResource, +transfer:TagResource, +iam:PassRole +``` + +### Delete +```json +transfer:DeleteAgreement +``` + diff --git a/docs/aws-docs/providers/aws/transfer/agreements/index.md b/docs/aws-docs/providers/aws/transfer/agreements/index.md new file mode 100644 index 0000000000..a0a73ae10c --- /dev/null +++ b/docs/aws-docs/providers/aws/transfer/agreements/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionResource Type definition for AWS::Transfer::Agreement
Idaws.transfer.agreements
+ +## Fields + + + + + + +
NameDatatypeDescription
agreement_idstringA unique identifier for the agreement.
server_idstringA unique identifier for the server.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +agreement_id, +server_id +FROM aws.transfer.agreements +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the agreements resource, the following permissions are required: + +### Create +```json +transfer:CreateAgreement, +transfer:TagResource, +iam:PassRole +``` + +### List +```json +transfer:ListAgreements +``` + diff --git a/docs/aws-docs/providers/aws/transfer/certificate/index.md b/docs/aws-docs/providers/aws/transfer/certificate/index.md new file mode 100644 index 0000000000..3b220836d8 --- /dev/null +++ b/docs/aws-docs/providers/aws/transfer/certificate/index.md @@ -0,0 +1,117 @@ +--- +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
DescriptionResource Type definition for AWS::Transfer::Certificate
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.transfer.certificate +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the certificate resource, the following permissions are required: + +### Read +```json +transfer:DescribeCertificate +``` + +### Update +```json +transfer:UpdateCertificate, +transfer:UnTagResource, +transfer:TagResource +``` + +### Delete +```json +transfer:DeleteCertificate +``` + diff --git a/docs/aws-docs/providers/aws/transfer/certificates/index.md b/docs/aws-docs/providers/aws/transfer/certificates/index.md new file mode 100644 index 0000000000..5c27971f93 --- /dev/null +++ b/docs/aws-docs/providers/aws/transfer/certificates/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionResource Type definition for AWS::Transfer::Certificate
Idaws.transfer.certificates
+ +## Fields + + + + + +
NameDatatypeDescription
certificate_idstringA unique identifier for the certificate.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +certificate_id +FROM aws.transfer.certificates +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the certificates resource, the following permissions are required: + +### Create +```json +transfer:ImportCertificate, +transfer:TagResource +``` + +### List +```json +transfer:ListCertificates +``` + diff --git a/docs/aws-docs/providers/aws/transfer/connector/index.md b/docs/aws-docs/providers/aws/transfer/connector/index.md new file mode 100644 index 0000000000..685bd13466 --- /dev/null +++ b/docs/aws-docs/providers/aws/transfer/connector/index.md @@ -0,0 +1,104 @@ +--- +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
DescriptionResource Type definition for AWS::Transfer::Connector
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +access_role, +as2_config, +sftp_config, +arn, +connector_id, +logging_role, +tags, +url +FROM aws.transfer.connector +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the connector resource, the following permissions are required: + +### Read +```json +transfer:DescribeConnector +``` + +### Update +```json +transfer:UpdateConnector, +transfer:UnTagResource, +transfer:TagResource, +iam:PassRole +``` + +### Delete +```json +transfer:DeleteConnector +``` + diff --git a/docs/aws-docs/providers/aws/transfer/connectors/index.md b/docs/aws-docs/providers/aws/transfer/connectors/index.md new file mode 100644 index 0000000000..03657389dc --- /dev/null +++ b/docs/aws-docs/providers/aws/transfer/connectors/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionResource Type definition for AWS::Transfer::Connector
Idaws.transfer.connectors
+ +## Fields + + + + + +
NameDatatypeDescription
connector_idstringA unique identifier for the connector.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +connector_id +FROM aws.transfer.connectors +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the connectors resource, the following permissions are required: + +### Create +```json +transfer:CreateConnector, +transfer:TagResource, +iam:PassRole +``` + +### List +```json +transfer:ListConnectors +``` + diff --git a/docs/aws-docs/providers/aws/transfer/index.md b/docs/aws-docs/providers/aws/transfer/index.md new file mode 100644 index 0000000000..7843c6c207 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/transfer/profile/index.md b/docs/aws-docs/providers/aws/transfer/profile/index.md new file mode 100644 index 0000000000..c18e30349b --- /dev/null +++ b/docs/aws-docs/providers/aws/transfer/profile/index.md @@ -0,0 +1,99 @@ +--- +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
DescriptionResource Type definition for AWS::Transfer::Profile
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +as2_id, +profile_type, +tags, +certificate_ids, +arn, +profile_id +FROM aws.transfer.profile +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the profile resource, the following permissions are required: + +### Read +```json +transfer:DescribeProfile +``` + +### Update +```json +transfer:UpdateProfile, +transfer:UnTagResource, +transfer:TagResource +``` + +### Delete +```json +transfer:DeleteProfile +``` + diff --git a/docs/aws-docs/providers/aws/transfer/profiles/index.md b/docs/aws-docs/providers/aws/transfer/profiles/index.md new file mode 100644 index 0000000000..ae8e9d8008 --- /dev/null +++ b/docs/aws-docs/providers/aws/transfer/profiles/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionResource Type definition for AWS::Transfer::Profile
Idaws.transfer.profiles
+ +## Fields + + + + + +
NameDatatypeDescription
profile_idstringA unique identifier for the profile
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +profile_id +FROM aws.transfer.profiles +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the profiles resource, the following permissions are required: + +### Create +```json +transfer:CreateProfile, +transfer:TagResource +``` + +### List +```json +transfer:ListProfiles +``` + diff --git a/docs/aws-docs/providers/aws/transfer/workflow/index.md b/docs/aws-docs/providers/aws/transfer/workflow/index.md new file mode 100644 index 0000000000..c0c445847e --- /dev/null +++ b/docs/aws-docs/providers/aws/transfer/workflow/index.md @@ -0,0 +1,98 @@ +--- +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
DescriptionResource Type definition for AWS::Transfer::Workflow
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +on_exception_steps, +steps, +tags, +description, +workflow_id, +arn +FROM aws.transfer.workflow +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the workflow resource, the following permissions are required: + +### Read +```json +transfer:DescribeWorkflow +``` + +### Delete +```json +transfer:DeleteWorkflow +``` + +### Update +```json +transfer:UnTagResource, +transfer:TagResource +``` + diff --git a/docs/aws-docs/providers/aws/transfer/workflows/index.md b/docs/aws-docs/providers/aws/transfer/workflows/index.md new file mode 100644 index 0000000000..99ec75f8bd --- /dev/null +++ b/docs/aws-docs/providers/aws/transfer/workflows/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionResource Type definition for AWS::Transfer::Workflow
Idaws.transfer.workflows
+ +## Fields + + + + + +
NameDatatypeDescription
workflow_idstringA unique identifier for the workflow.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +workflow_id +FROM aws.transfer.workflows +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the workflows resource, the following permissions are required: + +### Create +```json +transfer:CreateWorkflow, +transfer:TagResource +``` + +### List +```json +transfer:ListWorkflows +``` + diff --git a/docs/aws-docs/providers/aws/transfer_api/connectors/index.md b/docs/aws-docs/providers/aws/transfer_api/connectors/index.md new file mode 100644 index 0000000000..8bddc44282 --- /dev/null +++ b/docs/aws-docs/providers/aws/transfer_api/connectors/index.md @@ -0,0 +1,45 @@ +--- +title: connectors +hide_title: false +hide_table_of_contents: false +keywords: + - connectors + - transfer_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameconnectors
TypeResource
Idaws.transfer.connectors
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `AccessRole` | `string` | | +| `Arn` | `string` | | +| `As2Config` | `object` | Contains the details for an AS2 connector object. The connector object is used for AS2 outbound processes, to connect the Transfer Family customer with the trading partner. | +| `ConnectorId` | `string` | | +| `LoggingRole` | `string` | | +| `SftpConfig` | `object` | Contains the details for an SFTP connector object. The connector object is used for transferring files to and from a partner's SFTP server. | +| `Tags` | `array` | | +| `Url` | `string` | | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `describe_connector` | `SELECT` | `data__ConnectorId, region` | Describes the connector that's identified by the <code>ConnectorId.</code> | +| `list_connectors` | `SELECT` | `region` | Lists the connectors for the specified Region. | +| `create_connector` | `INSERT` | `data__AccessRole, data__Url, region` | <p>Creates the connector, which captures the parameters for an outbound connection for the AS2 or SFTP protocol. The connector is required for sending files to an externally hosted AS2 or SFTP server. For more details about AS2 connectors, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/create-b2b-server.html#configure-as2-connector">Create AS2 connectors</a>.</p> <note> <p>You must specify exactly one configuration object: either for AS2 (<code>As2Config</code>) or SFTP (<code>SftpConfig</code>).</p> </note> | +| `delete_connector` | `DELETE` | `data__ConnectorId, region` | Deletes the connector that's specified in the provided <code>ConnectorId</code>. | +| `update_connector` | `UPDATE` | `data__ConnectorId, region` | Updates some of the parameters for an existing connector. Provide the <code>ConnectorId</code> for the connector that you want to update, along with the new values for the parameters to update. | diff --git a/docs/aws-docs/providers/aws/transfer_api/index.md b/docs/aws-docs/providers/aws/transfer_api/index.md new file mode 100644 index 0000000000..962da8d9e9 --- /dev/null +++ b/docs/aws-docs/providers/aws/transfer_api/index.md @@ -0,0 +1,48 @@ +--- +title: transfer_api +hide_title: false +hide_table_of_contents: false +keywords: + - transfer_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage AWS resources using SQL +custom_edit_url: null +image: /img/providers/aws/stackql-aws-provider-featured-image.png +--- +transfer_api + +:::info Service Summary + +
+
+total resources: 3
+total selectable resources: 3
+total methods: 15
+
+
+ +::: + +## Overview + + + + + + +
Nameaws.transfer_api
TypeService
Titletransfer_api
Descriptiontransfer_api
Idtransfer_api:v00.00.00000
+ +## Resources +
+
+connectors
+servers
+
+
+users
+
+
diff --git a/docs/aws-docs/providers/aws/transfer_api/servers/index.md b/docs/aws-docs/providers/aws/transfer_api/servers/index.md new file mode 100644 index 0000000000..666013d1d7 --- /dev/null +++ b/docs/aws-docs/providers/aws/transfer_api/servers/index.md @@ -0,0 +1,57 @@ +--- +title: servers +hide_title: false +hide_table_of_contents: false +keywords: + - servers + - transfer_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameservers
TypeResource
Idaws.transfer.servers
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `Arn` | `string` | | +| `Certificate` | `string` | | +| `Domain` | `string` | | +| `EndpointDetails` | `object` | <p>The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled server. With a VPC endpoint, you can restrict access to your server and resources only within your VPC. To control incoming internet traffic, invoke the <code>UpdateServer</code> API and attach an Elastic IP address to your server's endpoint.</p> <note> <p> After May 19, 2021, you won't be able to create a server using <code>EndpointType=VPC_ENDPOINT</code> in your Amazon Web Servicesaccount if your account hasn't already done so before May 19, 2021. If you have already created servers with <code>EndpointType=VPC_ENDPOINT</code> in your Amazon Web Servicesaccount on or before May 19, 2021, you will not be affected. After this date, use <code>EndpointType</code>=<code>VPC</code>.</p> <p>For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.</p> </note> | +| `EndpointType` | `string` | | +| `HostKeyFingerprint` | `string` | | +| `IdentityProviderDetails` | `object` | Returns information related to the type of user authentication that is in use for a file transfer protocol-enabled server's users. A server can have only one method of authentication. | +| `IdentityProviderType` | `string` | <p>The mode of authentication for a server. The default value is <code>SERVICE_MANAGED</code>, which allows you to store and access user credentials within the Transfer Family service.</p> <p>Use <code>AWS_DIRECTORY_SERVICE</code> to provide access to Active Directory groups in Directory Service for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connector. This option also requires you to provide a Directory ID by using the <code>IdentityProviderDetails</code> parameter.</p> <p>Use the <code>API_GATEWAY</code> value to integrate with an identity provider of your choosing. The <code>API_GATEWAY</code> setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using the <code>IdentityProviderDetails</code> parameter.</p> <p>Use the <code>AWS_LAMBDA</code> value to directly use an Lambda function as your identity provider. If you choose this value, you must specify the ARN for the Lambda function in the <code>Function</code> parameter for the <code>IdentityProviderDetails</code> data type.</p> | +| `LoggingRole` | `string` | | +| `PostAuthenticationLoginBanner` | `string` | | +| `PreAuthenticationLoginBanner` | `string` | | +| `ProtocolDetails` | `object` | The protocol settings that are configured for your server. | +| `Protocols` | `array` | | +| `SecurityPolicyName` | `string` | | +| `ServerId` | `string` | | +| `State` | `string` | <p>Describes the condition of a file transfer protocol-enabled server with respect to its ability to perform file operations. There are six possible states: <code>OFFLINE</code>, <code>ONLINE</code>, <code>STARTING</code>, <code>STOPPING</code>, <code>START_FAILED</code>, and <code>STOP_FAILED</code>.</p> <p> <code>OFFLINE</code> indicates that the server exists, but that it is not available for file operations. <code>ONLINE</code> indicates that the server is available to perform file operations. <code>STARTING</code> indicates that the server's was instantiated, but the server is not yet available to perform file operations. Under normal conditions, it can take a couple of minutes for the server to be completely operational. Both <code>START_FAILED</code> and <code>STOP_FAILED</code> are error conditions.</p> | +| `StructuredLogDestinations` | `array` | | +| `Tags` | `array` | | +| `UserCount` | `integer` | | +| `WorkflowDetails` | `object` | Container for the <code>WorkflowDetail</code> data type. It is used by actions that trigger a workflow to begin execution. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `describe_server` | `SELECT` | `data__ServerId, region` | <p>Describes a file transfer protocol-enabled server that you specify by passing the <code>ServerId</code> parameter.</p> <p>The response contains a description of a server's properties. When you set <code>EndpointType</code> to VPC, the response will contain the <code>EndpointDetails</code>.</p> | +| `list_servers` | `SELECT` | `region` | Lists the file transfer protocol-enabled
servers that are associated with your
Amazon Web Services account.
| +| `create_server` | `INSERT` | `region` | Instantiates an auto-scaling virtual server based on the selected file transfer protocol in Amazon Web Services. When you make updates to your file transfer protocol-enabled server or when you work with users, use the service-generated <code>ServerId</code> property that is assigned to the newly created server. | +| `delete_server` | `DELETE` | `data__ServerId, region` | <p>Deletes the file transfer protocol-enabled server that you specify.</p> <p>No response returns from this operation.</p> | +| `update_server` | `UPDATE` | `data__ServerId, region` | <p>Updates the file transfer protocol-enabled server's properties after that server has been created.</p> <p>The <code>UpdateServer</code> call returns the <code>ServerId</code> of the server you updated.</p> | diff --git a/docs/aws-docs/providers/aws/transfer_api/users/index.md b/docs/aws-docs/providers/aws/transfer_api/users/index.md new file mode 100644 index 0000000000..9c95cd434b --- /dev/null +++ b/docs/aws-docs/providers/aws/transfer_api/users/index.md @@ -0,0 +1,47 @@ +--- +title: users +hide_title: false +hide_table_of_contents: false +keywords: + - users + - transfer_api + - aws + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud 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 + + + + +
Nameusers
TypeResource
Idaws.transfer.users
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `Arn` | `string` | | +| `HomeDirectory` | `string` | | +| `HomeDirectoryMappings` | `array` | | +| `HomeDirectoryType` | `string` | | +| `Policy` | `string` | | +| `PosixProfile` | `object` | The full POSIX identity, including user ID (<code>Uid</code>), group ID (<code>Gid</code>), and any secondary groups IDs (<code>SecondaryGids</code>), that controls your users' access to your Amazon EFS file systems. The POSIX permissions that are set on files and directories in your file system determine the level of access your users get when transferring files into and out of your Amazon EFS file systems. | +| `Role` | `string` | | +| `SshPublicKeys` | `array` | | +| `Tags` | `array` | | +| `UserName` | `string` | | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `describe_user` | `SELECT` | `data__ServerId, data__UserName, region` | <p>Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its <code>ServerId</code> property.</p> <p>The response from this call returns the properties of the user associated with the <code>ServerId</code> value that was specified.</p> | +| `list_users` | `SELECT` | `data__ServerId, region` | Lists the users for a file transfer protocol-enabled server that you specify by passing the <code>ServerId</code> parameter. | +| `create_user` | `INSERT` | `data__Role, data__ServerId, data__UserName, region` | Creates a user and associates them with an existing file transfer protocol-enabled server. You can only create and associate users with servers that have the <code>IdentityProviderType</code> set to <code>SERVICE_MANAGED</code>. Using parameters for <code>CreateUser</code>, you can specify the user name, set the home directory, store the user's public key, and assign the user's Identity and Access Management (IAM) role. You can also optionally add a session policy, and assign metadata with tags that can be used to group and search for users. | +| `update_user` | `UPDATE` | `data__ServerId, data__UserName, region` | <p>Assigns new properties to a user. Parameters you pass modify any or all of the following: the home directory, role, and policy for the <code>UserName</code> and <code>ServerId</code> you specify.</p> <p>The response returns the <code>ServerId</code> and the <code>UserName</code> for the updated user.</p> | +| `delete_user` | `EXEC` | `data__ServerId, data__UserName, region` | <p>Deletes the user belonging to a file transfer protocol-enabled server you specify.</p> <p>No response returns from this operation.</p> <note> <p>When you delete a user from a server, the user's information is lost.</p> </note> | diff --git a/docs/aws-docs/providers/aws/verifiedpermissions/identity_source/index.md b/docs/aws-docs/providers/aws/verifiedpermissions/identity_source/index.md new file mode 100644 index 0000000000..89d2d5114b --- /dev/null +++ b/docs/aws-docs/providers/aws/verifiedpermissions/identity_source/index.md @@ -0,0 +1,103 @@ +--- +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
DescriptionDefinition of AWS::VerifiedPermissions::IdentitySource Resource Type
Idaws.verifiedpermissions.identity_source
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
configurationobject
detailsobject
identity_source_idstring
policy_store_idstring
principal_entity_typestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +configuration, +details, +identity_source_id, +policy_store_id, +principal_entity_type +FROM aws.verifiedpermissions.identity_source +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the identity_source resource, the following permissions are required: + +### Read +```json +verifiedpermissions:GetIdentitySource, +cognito-idp:DescribeUserPool, +cognito-idp:ListUserPoolClients +``` + +### Update +```json +verifiedpermissions:UpdateIdentitySource, +verifiedpermissions:GetIdentitySource, +cognito-idp:DescribeUserPool, +cognito-idp:ListUserPoolClients +``` + +### Delete +```json +verifiedpermissions:DeleteIdentitySource, +verifiedpermissions:GetIdentitySource, +cognito-idp:DescribeUserPool, +cognito-idp:ListUserPoolClients +``` + diff --git a/docs/aws-docs/providers/aws/verifiedpermissions/identity_sources/index.md b/docs/aws-docs/providers/aws/verifiedpermissions/identity_sources/index.md new file mode 100644 index 0000000000..a66f2faeb2 --- /dev/null +++ b/docs/aws-docs/providers/aws/verifiedpermissions/identity_sources/index.md @@ -0,0 +1,85 @@ +--- +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
DescriptionDefinition of AWS::VerifiedPermissions::IdentitySource Resource Type
Idaws.verifiedpermissions.identity_sources
+ +## Fields + + + + + + +
NameDatatypeDescription
identity_source_idstring
policy_store_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +identity_source_id, +policy_store_id +FROM aws.verifiedpermissions.identity_sources +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the identity_sources resource, the following permissions are required: + +### Create +```json +verifiedpermissions:CreateIdentitySource, +verifiedpermissions:GetIdentitySource, +cognito-idp:DescribeUserPool, +cognito-idp:ListUserPoolClients +``` + +### List +```json +verifiedpermissions:ListIdentitySources, +verifiedpermissions:GetIdentitySource, +cognito-idp:DescribeUserPool, +cognito-idp:ListUserPoolClients +``` + diff --git a/docs/aws-docs/providers/aws/verifiedpermissions/index.md b/docs/aws-docs/providers/aws/verifiedpermissions/index.md new file mode 100644 index 0000000000..59de388426 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/verifiedpermissions/policies/index.md b/docs/aws-docs/providers/aws/verifiedpermissions/policies/index.md new file mode 100644 index 0000000000..2e81fb0081 --- /dev/null +++ b/docs/aws-docs/providers/aws/verifiedpermissions/policies/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionDefinition of AWS::VerifiedPermissions::Policy Resource Type
Idaws.verifiedpermissions.policies
+ +## Fields + + + + + + +
NameDatatypeDescription
policy_idstring
policy_store_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +policy_id, +policy_store_id +FROM aws.verifiedpermissions.policies +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the policies resource, the following permissions are required: + +### Create +```json +verifiedpermissions:CreatePolicy, +verifiedpermissions:GetPolicy +``` + +### List +```json +verifiedpermissions:ListPolicies, +verifiedpermissions:GetPolicy +``` + diff --git a/docs/aws-docs/providers/aws/verifiedpermissions/policy/index.md b/docs/aws-docs/providers/aws/verifiedpermissions/policy/index.md new file mode 100644 index 0000000000..98d17b8bf0 --- /dev/null +++ b/docs/aws-docs/providers/aws/verifiedpermissions/policy/index.md @@ -0,0 +1,95 @@ +--- +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
DescriptionDefinition of AWS::VerifiedPermissions::Policy Resource Type
Idaws.verifiedpermissions.policy
+ +## Fields + + + + + + + + +
NameDatatypeDescription
definitionundefined
policy_idstring
policy_store_idstring
policy_typestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +definition, +policy_id, +policy_store_id, +policy_type +FROM aws.verifiedpermissions.policy +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the policy resource, the following permissions are required: + +### Read +```json +verifiedpermissions:GetPolicy +``` + +### Update +```json +verifiedpermissions:UpdatePolicy, +verifiedpermissions:GetPolicy +``` + +### Delete +```json +verifiedpermissions:DeletePolicy, +verifiedpermissions:GetPolicy +``` + diff --git a/docs/aws-docs/providers/aws/verifiedpermissions/policy_store/index.md b/docs/aws-docs/providers/aws/verifiedpermissions/policy_store/index.md new file mode 100644 index 0000000000..2a46fb7419 --- /dev/null +++ b/docs/aws-docs/providers/aws/verifiedpermissions/policy_store/index.md @@ -0,0 +1,100 @@ +--- +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
DescriptionRepresents a policy store that you can place schema, policies, and policy templates in to validate authorization requests
Idaws.verifiedpermissions.policy_store
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
arnstring
descriptionstring
policy_store_idstring
validation_settingsobject
schemaobject
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +description, +policy_store_id, +validation_settings, +schema +FROM aws.verifiedpermissions.policy_store +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the policy_store resource, the following permissions are required: + +### Read +```json +verifiedpermissions:GetPolicyStore, +verifiedpermissions:GetSchema +``` + +### Update +```json +verifiedpermissions:UpdatePolicyStore, +verifiedpermissions:GetPolicyStore, +verifiedpermissions:GetSchema, +verifiedpermissions:PutSchema +``` + +### Delete +```json +verifiedpermissions:DeletePolicyStore, +verifiedpermissions:GetPolicyStore +``` + diff --git a/docs/aws-docs/providers/aws/verifiedpermissions/policy_stores/index.md b/docs/aws-docs/providers/aws/verifiedpermissions/policy_stores/index.md new file mode 100644 index 0000000000..6cb3b371e2 --- /dev/null +++ b/docs/aws-docs/providers/aws/verifiedpermissions/policy_stores/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionRepresents a policy store that you can place schema, policies, and policy templates in to validate authorization requests
Idaws.verifiedpermissions.policy_stores
+ +## Fields + + + + + +
NameDatatypeDescription
policy_store_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +policy_store_id +FROM aws.verifiedpermissions.policy_stores +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the policy_stores resource, the following permissions are required: + +### Create +```json +verifiedpermissions:CreatePolicyStore, +verifiedpermissions:GetPolicyStore, +verifiedpermissions:PutSchema +``` + +### List +```json +verifiedpermissions:ListPolicyStores, +verifiedpermissions:GetPolicyStore, +verifiedpermissions:GetSchema +``` + diff --git a/docs/aws-docs/providers/aws/verifiedpermissions/policy_template/index.md b/docs/aws-docs/providers/aws/verifiedpermissions/policy_template/index.md new file mode 100644 index 0000000000..51a9637d64 --- /dev/null +++ b/docs/aws-docs/providers/aws/verifiedpermissions/policy_template/index.md @@ -0,0 +1,95 @@ +--- +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
DescriptionDefinition of AWS::VerifiedPermissions::PolicyTemplate Resource Type
Idaws.verifiedpermissions.policy_template
+ +## Fields + + + + + + + + +
NameDatatypeDescription
descriptionstring
policy_store_idstring
policy_template_idstring
statementstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +description, +policy_store_id, +policy_template_id, +statement +FROM aws.verifiedpermissions.policy_template +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the policy_template resource, the following permissions are required: + +### Read +```json +verifiedpermissions:GetPolicyTemplate +``` + +### Update +```json +verifiedpermissions:UpdatePolicyTemplate, +verifiedpermissions:GetPolicyTemplate +``` + +### Delete +```json +verifiedpermissions:DeletePolicyTemplate, +verifiedpermissions:GetPolicyTemplate +``` + diff --git a/docs/aws-docs/providers/aws/verifiedpermissions/policy_templates/index.md b/docs/aws-docs/providers/aws/verifiedpermissions/policy_templates/index.md new file mode 100644 index 0000000000..6499bf8e70 --- /dev/null +++ b/docs/aws-docs/providers/aws/verifiedpermissions/policy_templates/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionDefinition of AWS::VerifiedPermissions::PolicyTemplate Resource Type
Idaws.verifiedpermissions.policy_templates
+ +## Fields + + + + + + +
NameDatatypeDescription
policy_store_idstring
policy_template_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +policy_store_id, +policy_template_id +FROM aws.verifiedpermissions.policy_templates +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the policy_templates resource, the following permissions are required: + +### Create +```json +verifiedpermissions:CreatePolicyTemplate, +verifiedpermissions:GetPolicyTemplate +``` + +### List +```json +verifiedpermissions:ListPolicyTemplates, +verifiedpermissions:GetPolicyTemplate +``` + diff --git a/docs/aws-docs/providers/aws/voiceid/domain/index.md b/docs/aws-docs/providers/aws/voiceid/domain/index.md new file mode 100644 index 0000000000..7f7c538043 --- /dev/null +++ b/docs/aws-docs/providers/aws/voiceid/domain/index.md @@ -0,0 +1,106 @@ +--- +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
DescriptionThe AWS::VoiceID::Domain resource specifies an Amazon VoiceID Domain.
Idaws.voiceid.domain
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
descriptionstring
domain_idstring
namestring
server_side_encryption_configurationobject
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +description, +domain_id, +name, +server_side_encryption_configuration, +tags +FROM aws.voiceid.domain +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the domain resource, the following permissions are required: + +### Read +```json +voiceid:DescribeDomain, +voiceid:ListTagsForResource, +kms:Decrypt +``` + +### Update +```json +voiceid:DescribeDomain, +voiceid:UpdateDomain, +voiceid:TagResource, +voiceid:UntagResource, +voiceid:ListTagsForResource, +kms:CreateGrant, +kms:Decrypt, +kms:DescribeKey +``` + +### Delete +```json +voiceid:DeleteDomain, +voiceid:DescribeDomain, +kms:Decrypt +``` + diff --git a/docs/aws-docs/providers/aws/voiceid/domains/index.md b/docs/aws-docs/providers/aws/voiceid/domains/index.md new file mode 100644 index 0000000000..384aec1880 --- /dev/null +++ b/docs/aws-docs/providers/aws/voiceid/domains/index.md @@ -0,0 +1,84 @@ +--- +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
DescriptionThe AWS::VoiceID::Domain resource specifies an Amazon VoiceID Domain.
Idaws.voiceid.domains
+ +## Fields + + + + + +
NameDatatypeDescription
domain_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +domain_id +FROM aws.voiceid.domains +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the domains resource, the following permissions are required: + +### Create +```json +voiceid:CreateDomain, +voiceid:DescribeDomain, +voiceid:TagResource, +voiceid:ListTagsForResource, +kms:CreateGrant, +kms:DescribeKey, +kms:Decrypt +``` + +### List +```json +voiceid:ListDomains, +kms:Decrypt +``` + diff --git a/docs/aws-docs/providers/aws/voiceid/index.md b/docs/aws-docs/providers/aws/voiceid/index.md new file mode 100644 index 0000000000..c96ba98330 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/vpclattice/access_log_subscription/index.md b/docs/aws-docs/providers/aws/vpclattice/access_log_subscription/index.md new file mode 100644 index 0000000000..83e7862c33 --- /dev/null +++ b/docs/aws-docs/providers/aws/vpclattice/access_log_subscription/index.md @@ -0,0 +1,131 @@ +--- +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
DescriptionEnables access logs to be sent to Amazon CloudWatch, Amazon S3, and Amazon Kinesis Data Firehose. The service network owner can use the access logs to audit the services in the network. The service network owner will only see access logs from clients and services that are associated with their service network. Access log entries represent traffic originated from VPCs associated with that network.
Idaws.vpclattice.access_log_subscription
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
arnstring
destination_arnstring
idstring
resource_arnstring
resource_idstring
resource_identifierstring
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +destination_arn, +id, +resource_arn, +resource_id, +resource_identifier, +tags +FROM aws.vpclattice.access_log_subscription +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the access_log_subscription resource, the following permissions are required: + +### Read +```json +vpc-lattice:GetAccessLogSubscription, +vpc-lattice:ListTagsForResource, +logs:GetLogDelivery +``` + +### Update +```json +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 +```json +vpc-lattice:DeleteAccessLogSubscription, +vpc-lattice:UntagResource, +logs:DeleteLogDelivery, +logs:DeleteLogStream, +logs:GetLogDelivery, +logs:DeleteDestination, +s3:PutBucketLogging, +iam:GetServiceLinkedRoleDeletionStatus, +iam:DeleteServiceLinkedRole, +firehose:DeleteDeliveryStream, +firehose:UntagDeliveryStream +``` + diff --git a/docs/aws-docs/providers/aws/vpclattice/access_log_subscriptions/index.md b/docs/aws-docs/providers/aws/vpclattice/access_log_subscriptions/index.md new file mode 100644 index 0000000000..677fb19fb0 --- /dev/null +++ b/docs/aws-docs/providers/aws/vpclattice/access_log_subscriptions/index.md @@ -0,0 +1,96 @@ +--- +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
DescriptionEnables access logs to be sent to Amazon CloudWatch, Amazon S3, and Amazon Kinesis Data Firehose. The service network owner can use the access logs to audit the services in the network. The service network owner will only see access logs from clients and services that are associated with their service network. Access log entries represent traffic originated from VPCs associated with that network.
Idaws.vpclattice.access_log_subscriptions
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.vpclattice.access_log_subscriptions +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the access_log_subscriptions resource, the following permissions are required: + +### Create +```json +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 +```json +vpc-lattice:ListAccessLogSubscriptions +``` + diff --git a/docs/aws-docs/providers/aws/vpclattice/auth_policies/index.md b/docs/aws-docs/providers/aws/vpclattice/auth_policies/index.md new file mode 100644 index 0000000000..ed05665606 --- /dev/null +++ b/docs/aws-docs/providers/aws/vpclattice/auth_policies/index.md @@ -0,0 +1,68 @@ +--- +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
DescriptionCreates or updates the auth policy.
Idaws.vpclattice.auth_policies
+ +## Fields + + + + + +
NameDatatypeDescription
resource_identifierstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +resource_identifier +FROM aws.vpclattice.auth_policies +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the auth_policies resource, the following permissions are required: + +### Create +```json +vpc-lattice:GetAuthPolicy, +vpc-lattice:PutAuthPolicy +``` + diff --git a/docs/aws-docs/providers/aws/vpclattice/auth_policy/index.md b/docs/aws-docs/providers/aws/vpclattice/auth_policy/index.md new file mode 100644 index 0000000000..9fc88908c7 --- /dev/null +++ b/docs/aws-docs/providers/aws/vpclattice/auth_policy/index.md @@ -0,0 +1,93 @@ +--- +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
DescriptionCreates or updates the auth policy.
Idaws.vpclattice.auth_policy
+ +## Fields + + + + + + + +
NameDatatypeDescription
resource_identifierstring
policyobject
statestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +resource_identifier, +policy, +state +FROM aws.vpclattice.auth_policy +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the auth_policy resource, the following permissions are required: + +### Read +```json +vpc-lattice:GetAuthPolicy +``` + +### Update +```json +vpc-lattice:GetAuthPolicy, +vpc-lattice:PutAuthPolicy +``` + +### Delete +```json +vpc-lattice:GetAuthPolicy, +vpc-lattice:DeleteAuthPolicy +``` + diff --git a/docs/aws-docs/providers/aws/vpclattice/index.md b/docs/aws-docs/providers/aws/vpclattice/index.md new file mode 100644 index 0000000000..5fa0fa93c7 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/vpclattice/listener/index.md b/docs/aws-docs/providers/aws/vpclattice/listener/index.md new file mode 100644 index 0000000000..31da3b3272 --- /dev/null +++ b/docs/aws-docs/providers/aws/vpclattice/listener/index.md @@ -0,0 +1,110 @@ +--- +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
DescriptionCreates a listener for a service. Before you start using your Amazon VPC Lattice service, you must add one or more listeners. A listener is a process that checks for connection requests to your services.
Idaws.vpclattice.listener
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
default_actionobject
idstring
namestring
portinteger
protocolstring
service_arnstring
service_idstring
service_identifierstring
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +default_action, +id, +name, +port, +protocol, +service_arn, +service_id, +service_identifier, +tags +FROM aws.vpclattice.listener +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the listener resource, the following permissions are required: + +### Read +```json +vpc-lattice:GetListener, +vpc-lattice:ListTagsForResource +``` + +### Update +```json +vpc-lattice:UpdateListener, +vpc-lattice:TagResource, +vpc-lattice:UntagResource, +vpc-lattice:GetListener, +vpc-lattice:ListTagsForResource +``` + +### Delete +```json +vpc-lattice:DeleteListener +``` + diff --git a/docs/aws-docs/providers/aws/vpclattice/listeners/index.md b/docs/aws-docs/providers/aws/vpclattice/listeners/index.md new file mode 100644 index 0000000000..d3413e5e68 --- /dev/null +++ b/docs/aws-docs/providers/aws/vpclattice/listeners/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionCreates a listener for a service. Before you start using your Amazon VPC Lattice service, you must add one or more listeners. A listener is a process that checks for connection requests to your services.
Idaws.vpclattice.listeners
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.vpclattice.listeners +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the listeners resource, the following permissions are required: + +### Create +```json +vpc-lattice:CreateListener, +vpc-lattice:TagResource, +vpc-lattice:GetListener, +vpc-lattice:ListTagsForResource +``` + +### List +```json +vpc-lattice:ListListeners +``` + diff --git a/docs/aws-docs/providers/aws/vpclattice/resource_policies/index.md b/docs/aws-docs/providers/aws/vpclattice/resource_policies/index.md new file mode 100644 index 0000000000..7ba8899985 --- /dev/null +++ b/docs/aws-docs/providers/aws/vpclattice/resource_policies/index.md @@ -0,0 +1,68 @@ +--- +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
DescriptionRetrieves information about the resource policy. The resource policy is an IAM policy created by AWS RAM on behalf of the resource owner when they share a resource.
Idaws.vpclattice.resource_policies
+ +## Fields + + + + + +
NameDatatypeDescription
resource_arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +resource_arn +FROM aws.vpclattice.resource_policies +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the resource_policies resource, the following permissions are required: + +### Create +```json +vpc-lattice:GetResourcePolicy, +vpc-lattice:PutResourcePolicy +``` + diff --git a/docs/aws-docs/providers/aws/vpclattice/resource_policy/index.md b/docs/aws-docs/providers/aws/vpclattice/resource_policy/index.md new file mode 100644 index 0000000000..f33e3e6b98 --- /dev/null +++ b/docs/aws-docs/providers/aws/vpclattice/resource_policy/index.md @@ -0,0 +1,91 @@ +--- +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
DescriptionRetrieves information about the resource policy. The resource policy is an IAM policy created by AWS RAM on behalf of the resource owner when they share a resource.
Idaws.vpclattice.resource_policy
+ +## Fields + + + + + + +
NameDatatypeDescription
resource_arnstring
policyobject
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +resource_arn, +policy +FROM aws.vpclattice.resource_policy +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the resource_policy resource, the following permissions are required: + +### Read +```json +vpc-lattice:GetResourcePolicy +``` + +### Update +```json +vpc-lattice:GetResourcePolicy, +vpc-lattice:PutResourcePolicy +``` + +### Delete +```json +vpc-lattice:GetResourcePolicy, +vpc-lattice:DeleteResourcePolicy +``` + diff --git a/docs/aws-docs/providers/aws/vpclattice/rule/index.md b/docs/aws-docs/providers/aws/vpclattice/rule/index.md new file mode 100644 index 0000000000..23733f3c7e --- /dev/null +++ b/docs/aws-docs/providers/aws/vpclattice/rule/index.md @@ -0,0 +1,107 @@ +--- +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
DescriptionCreates a listener rule. Each listener has a default rule for checking connection requests, but you can define additional rules. Each rule consists of a priority, one or more actions, and one or more conditions.
Idaws.vpclattice.rule
+ +## Fields + + + + + + + + + + + + + +
NameDatatypeDescription
actionobject
arnstring
idstring
listener_identifierstring
matchobject
namestring
priorityinteger
service_identifierstring
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +action, +arn, +id, +listener_identifier, +match, +name, +priority, +service_identifier, +tags +FROM aws.vpclattice.rule +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the rule resource, the following permissions are required: + +### Read +```json +vpc-lattice:GetRule, +vpc-lattice:ListTagsForResource +``` + +### Update +```json +vpc-lattice:UpdateRule, +vpc-lattice:GetRule, +vpc-lattice:TagResource, +vpc-lattice:UntagResource +``` + +### Delete +```json +vpc-lattice:DeleteRule +``` + diff --git a/docs/aws-docs/providers/aws/vpclattice/rules/index.md b/docs/aws-docs/providers/aws/vpclattice/rules/index.md new file mode 100644 index 0000000000..d9fe1208dc --- /dev/null +++ b/docs/aws-docs/providers/aws/vpclattice/rules/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionCreates a listener rule. Each listener has a default rule for checking connection requests, but you can define additional rules. Each rule consists of a priority, one or more actions, and one or more conditions.
Idaws.vpclattice.rules
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.vpclattice.rules +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the rules resource, the following permissions are required: + +### Create +```json +vpc-lattice:CreateRule, +vpc-lattice:GetRule, +vpc-lattice:ListTagsForResource, +vpc-lattice:TagResource +``` + +### List +```json +vpc-lattice:ListRules +``` + diff --git a/docs/aws-docs/providers/aws/vpclattice/service/index.md b/docs/aws-docs/providers/aws/vpclattice/service/index.md new file mode 100644 index 0000000000..e72109bc06 --- /dev/null +++ b/docs/aws-docs/providers/aws/vpclattice/service/index.md @@ -0,0 +1,113 @@ +--- +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
DescriptionA service is any software application that can run on instances containers, or serverless functions within an account or virtual private cloud (VPC).
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +auth_type, +created_at, +dns_entry, +id, +last_updated_at, +name, +status, +certificate_arn, +custom_domain_name, +tags +FROM aws.vpclattice.service +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the service resource, the following permissions are required: + +### Read +```json +vpc-lattice:GetService, +vpc-lattice:ListTagsForResource +``` + +### Update +```json +vpc-lattice:UpdateService, +vpc-lattice:TagResource, +vpc-lattice:UntagResource, +vpc-lattice:GetService, +vpc-lattice:ListTagsForResource +``` + +### Delete +```json +vpc-lattice:DeleteService, +vpc-lattice:GetService +``` + diff --git a/docs/aws-docs/providers/aws/vpclattice/service_network/index.md b/docs/aws-docs/providers/aws/vpclattice/service_network/index.md new file mode 100644 index 0000000000..1f1509ce3d --- /dev/null +++ b/docs/aws-docs/providers/aws/vpclattice/service_network/index.md @@ -0,0 +1,103 @@ +--- +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
DescriptionA service network is a logical boundary for a collection of services. You can associate services and VPCs with a service network.
Idaws.vpclattice.service_network
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
arnstring
created_atstring
idstring
last_updated_atstring
namestring
auth_typestring
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +created_at, +id, +last_updated_at, +name, +auth_type, +tags +FROM aws.vpclattice.service_network +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the service_network resource, the following permissions are required: + +### Read +```json +vpc-lattice:GetServiceNetwork, +vpc-lattice:ListTagsForResource +``` + +### Update +```json +vpc-lattice:GetServiceNetwork, +vpc-lattice:UpdateServiceNetwork, +vpc-lattice:TagResource, +vpc-lattice:UntagResource +``` + +### Delete +```json +vpc-lattice:DeleteServiceNetwork +``` + diff --git a/docs/aws-docs/providers/aws/vpclattice/service_network_service_association/index.md b/docs/aws-docs/providers/aws/vpclattice/service_network_service_association/index.md new file mode 100644 index 0000000000..3230d59bdc --- /dev/null +++ b/docs/aws-docs/providers/aws/vpclattice/service_network_service_association/index.md @@ -0,0 +1,118 @@ +--- +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
DescriptionAssociates a service with a service network.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.vpclattice.service_network_service_association +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the service_network_service_association resource, the following permissions are required: + +### Read +```json +vpc-lattice:GetServiceNetworkServiceAssociation, +vpc-lattice:ListTagsForResource +``` + +### Update +```json +vpc-lattice:TagResource, +vpc-lattice:UntagResource, +vpc-lattice:GetServiceNetworkServiceAssociation, +vpc-lattice:ListTagsForResource +``` + +### Delete +```json +vpc-lattice:DeleteServiceNetworkServiceAssociation, +vpc-lattice:GetServiceNetworkServiceAssociation +``` + diff --git a/docs/aws-docs/providers/aws/vpclattice/service_network_service_associations/index.md b/docs/aws-docs/providers/aws/vpclattice/service_network_service_associations/index.md new file mode 100644 index 0000000000..5c4436abb2 --- /dev/null +++ b/docs/aws-docs/providers/aws/vpclattice/service_network_service_associations/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionAssociates a service with a service network.
Idaws.vpclattice.service_network_service_associations
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.vpclattice.service_network_service_associations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the service_network_service_associations resource, the following permissions are required: + +### Create +```json +vpc-lattice:CreateServiceNetworkServiceAssociation, +vpc-lattice:GetServiceNetworkServiceAssociation, +vpc-lattice:TagResource, +vpc-lattice:ListTagsForResource +``` + +### List +```json +vpc-lattice:ListServiceNetworkServiceAssociations +``` + diff --git a/docs/aws-docs/providers/aws/vpclattice/service_network_vpc_association/index.md b/docs/aws-docs/providers/aws/vpclattice/service_network_vpc_association/index.md new file mode 100644 index 0000000000..ac251f4f6d --- /dev/null +++ b/docs/aws-docs/providers/aws/vpclattice/service_network_vpc_association/index.md @@ -0,0 +1,116 @@ +--- +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
DescriptionAssociates a VPC with a service network.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.vpclattice.service_network_vpc_association +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the service_network_vpc_association resource, the following permissions are required: + +### Read +```json +vpc-lattice:GetServiceNetworkVpcAssociation, +vpc-lattice:ListTagsForResource +``` + +### Update +```json +vpc-lattice:TagResource, +vpc-lattice:UntagResource, +vpc-lattice:GetServiceNetworkVpcAssociation, +vpc-lattice:UpdateServiceNetworkVpcAssociation, +ec2:DescribeSecurityGroups, +vpc-lattice:ListTagsForResource +``` + +### Delete +```json +vpc-lattice:DeleteServiceNetworkVpcAssociation, +vpc-lattice:GetServiceNetworkVpcAssociation +``` + diff --git a/docs/aws-docs/providers/aws/vpclattice/service_network_vpc_associations/index.md b/docs/aws-docs/providers/aws/vpclattice/service_network_vpc_associations/index.md new file mode 100644 index 0000000000..06a0cb5913 --- /dev/null +++ b/docs/aws-docs/providers/aws/vpclattice/service_network_vpc_associations/index.md @@ -0,0 +1,83 @@ +--- +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
DescriptionAssociates a VPC with a service network.
Idaws.vpclattice.service_network_vpc_associations
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.vpclattice.service_network_vpc_associations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the service_network_vpc_associations resource, the following permissions are required: + +### Create +```json +vpc-lattice:CreateServiceNetworkVpcAssociation, +vpc-lattice:GetServiceNetworkVpcAssociation, +vpc-lattice:ListServiceNetworkVpcAssociations, +vpc-lattice:ListTagsForResource, +ec2:DescribeSecurityGroups, +ec2:DescribeVpcs, +vpc-lattice:TagResource +``` + +### List +```json +vpc-lattice:ListServiceNetworkVpcAssociations +``` + diff --git a/docs/aws-docs/providers/aws/vpclattice/service_networks/index.md b/docs/aws-docs/providers/aws/vpclattice/service_networks/index.md new file mode 100644 index 0000000000..d3c4a94abe --- /dev/null +++ b/docs/aws-docs/providers/aws/vpclattice/service_networks/index.md @@ -0,0 +1,81 @@ +--- +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
DescriptionA service network is a logical boundary for a collection of services. You can associate services and VPCs with a service network.
Idaws.vpclattice.service_networks
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.vpclattice.service_networks +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the service_networks resource, the following permissions are required: + +### Create +```json +vpc-lattice:GetServiceNetwork, +vpc-lattice:ListTagsForResource, +vpc-lattice:CreateServiceNetwork, +vpc-lattice:TagResource, +iam:CreateServiceLinkedRole +``` + +### List +```json +vpc-lattice:ListServiceNetworks +``` + diff --git a/docs/aws-docs/providers/aws/vpclattice/services/index.md b/docs/aws-docs/providers/aws/vpclattice/services/index.md new file mode 100644 index 0000000000..d1516987ab --- /dev/null +++ b/docs/aws-docs/providers/aws/vpclattice/services/index.md @@ -0,0 +1,83 @@ +--- +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
DescriptionA service is any software application that can run on instances containers, or serverless functions within an account or virtual private cloud (VPC).
Idaws.vpclattice.services
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.vpclattice.services +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the services resource, the following permissions are required: + +### Create +```json +vpc-lattice:CreateService, +vpc-lattice:GetService, +vpc-lattice:ListTagsForResource, +vpc-lattice:TagResource, +acm:DescribeCertificate, +acm:ListCertificates, +iam:CreateServiceLinkedRole +``` + +### List +```json +vpc-lattice:ListServices +``` + diff --git a/docs/aws-docs/providers/aws/vpclattice/target_group/index.md b/docs/aws-docs/providers/aws/vpclattice/target_group/index.md new file mode 100644 index 0000000000..510a1cb323 --- /dev/null +++ b/docs/aws-docs/providers/aws/vpclattice/target_group/index.md @@ -0,0 +1,126 @@ +--- +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
DescriptionA target group is a collection of targets, or compute resources, that run your application or service. A target group can only be used by a single service.
Idaws.vpclattice.target_group
+ +## Fields + + + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
configobject
created_atstring
idstring
last_updated_atstring
namestring
statusstring
typestring
targetsarray
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +config, +created_at, +id, +last_updated_at, +name, +status, +type, +targets, +tags +FROM aws.vpclattice.target_group +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the target_group resource, the following permissions are required: + +### Read +```json +vpc-lattice:GetTargetGroup, +vpc-lattice:ListTargets, +vpc-lattice:ListTagsForResource +``` + +### Update +```json +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 +```json +vpc-lattice:DeleteTargetGroup, +vpc-lattice:GetTargetGroup, +vpc-lattice:DeregisterTargets, +vpc-lattice:ListTargets, +lambda:RemovePermission +``` + diff --git a/docs/aws-docs/providers/aws/vpclattice/target_groups/index.md b/docs/aws-docs/providers/aws/vpclattice/target_groups/index.md new file mode 100644 index 0000000000..dbafc3b5a2 --- /dev/null +++ b/docs/aws-docs/providers/aws/vpclattice/target_groups/index.md @@ -0,0 +1,91 @@ +--- +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
DescriptionA target group is a collection of targets, or compute resources, that run your application or service. A target group can only be used by a single service.
Idaws.vpclattice.target_groups
+ +## Fields + + + + + +
NameDatatypeDescription
arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +arn +FROM aws.vpclattice.target_groups +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the target_groups resource, the following permissions are required: + +### Create +```json +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 +```json +vpc-lattice:ListTargetGroups +``` + diff --git a/docs/aws-docs/providers/aws/wafv2/index.md b/docs/aws-docs/providers/aws/wafv2/index.md new file mode 100644 index 0000000000..bb6f702ae7 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/wafv2/ip_set/index.md b/docs/aws-docs/providers/aws/wafv2/ip_set/index.md new file mode 100644 index 0000000000..ed8bf9e89d --- /dev/null +++ b/docs/aws-docs/providers/aws/wafv2/ip_set/index.md @@ -0,0 +1,105 @@ +--- +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
DescriptionContains a list of IP addresses. This can be either IPV4 or IPV6. The list will be mutually
Idaws.wafv2.ip_set
+ +## Fields + + + + + + + + + + + + +
NameDatatypeDescription
arnstring
descriptionstring
namestring
idstring
scopestring
ip_address_versionstring
addressesarrayList of IPAddresses.
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +description, +name, +id, +scope, +ip_address_version, +addresses, +tags +FROM aws.wafv2.ip_set +WHERE data__Identifier = '||'; +``` + +## Permissions + +To operate on the ip_set resource, the following permissions are required: + +### Delete +```json +wafv2:DeleteIPSet, +wafv2:GetIPSet +``` + +### Read +```json +wafv2:GetIPSet, +wafv2:ListTagsForResource +``` + +### Update +```json +wafv2:UpdateIPSet, +wafv2:GetIPSet, +wafv2:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/wafv2/ip_sets/index.md b/docs/aws-docs/providers/aws/wafv2/ip_sets/index.md new file mode 100644 index 0000000000..dfa7c9363f --- /dev/null +++ b/docs/aws-docs/providers/aws/wafv2/ip_sets/index.md @@ -0,0 +1,83 @@ +--- +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
DescriptionContains a list of IP addresses. This can be either IPV4 or IPV6. The list will be mutually
Idaws.wafv2.ip_sets
+ +## Fields + + + + + + + +
NameDatatypeDescription
nameundefined
idundefined
scopeundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name, +id, +scope +FROM aws.wafv2.ip_sets + +``` + +## Permissions + +To operate on the ip_sets resource, the following permissions are required: + +### Create +```json +wafv2:CreateIPSet, +wafv2:GetIPSet, +wafv2:ListTagsForResource +``` + +### List +```json +wafv2:listIPSets +``` + diff --git a/docs/aws-docs/providers/aws/wafv2/logging_configuration/index.md b/docs/aws-docs/providers/aws/wafv2/logging_configuration/index.md new file mode 100644 index 0000000000..748f1f600c --- /dev/null +++ b/docs/aws-docs/providers/aws/wafv2/logging_configuration/index.md @@ -0,0 +1,107 @@ +--- +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
DescriptionA WAFv2 Logging Configuration Resource Provider
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +resource_arn, +log_destination_configs, +redacted_fields, +managed_by_firewall_manager, +logging_filter +FROM aws.wafv2.logging_configuration +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the logging_configuration resource, the following permissions are required: + +### Read +```json +wafv2:GetLoggingConfiguration +``` + +### Update +```json +wafv2:PutLoggingConfiguration, +wafv2:GetLoggingConfiguration, +firehose:ListDeliveryStreams, +iam:CreateServiceLinkedRole, +iam:DescribeOrganization, +logs:CreateLogDelivery, +s3:PutBucketPolicy, +s3:GetBucketPolicy, +logs:PutResourcePolicy, +logs:DescribeResourcePolicies, +logs:DescribeLogGroups +``` + +### Delete +```json +wafv2:DeleteLoggingConfiguration, +wafv2:GetLoggingConfiguration, +logs:DeleteLogDelivery +``` + diff --git a/docs/aws-docs/providers/aws/wafv2/logging_configurations/index.md b/docs/aws-docs/providers/aws/wafv2/logging_configurations/index.md new file mode 100644 index 0000000000..89c705a9d7 --- /dev/null +++ b/docs/aws-docs/providers/aws/wafv2/logging_configurations/index.md @@ -0,0 +1,87 @@ +--- +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
DescriptionA WAFv2 Logging Configuration Resource Provider
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +resource_arn +FROM aws.wafv2.logging_configurations + +``` + +## Permissions + +To operate on the logging_configurations resource, the following permissions are required: + +### Create +```json +wafv2:PutLoggingConfiguration, +wafv2:GetLoggingConfiguration, +firehose:ListDeliveryStreams, +iam:CreateServiceLinkedRole, +iam:DescribeOrganization, +logs:CreateLogDelivery, +s3:PutBucketPolicy, +s3:GetBucketPolicy, +logs:PutResourcePolicy, +logs:DescribeResourcePolicies, +logs:DescribeLogGroups +``` + +### List +```json +wafv2:ListLoggingConfigurations +``` + diff --git a/docs/aws-docs/providers/aws/wafv2/regex_pattern_set/index.md b/docs/aws-docs/providers/aws/wafv2/regex_pattern_set/index.md new file mode 100644 index 0000000000..f3b0af5d4a --- /dev/null +++ b/docs/aws-docs/providers/aws/wafv2/regex_pattern_set/index.md @@ -0,0 +1,103 @@ +--- +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
DescriptionContains a list of Regular expressions based on the provided inputs. RegexPatternSet can be used with other WAF entities with RegexPatternSetReferenceStatement to perform other actions .
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +description, +name, +id, +regular_expression_list, +scope, +tags +FROM aws.wafv2.regex_pattern_set +WHERE data__Identifier = '||'; +``` + +## Permissions + +To operate on the regex_pattern_set resource, the following permissions are required: + +### Delete +```json +wafv2:DeleteRegexPatternSet, +wafv2:GetRegexPatternSet +``` + +### Read +```json +wafv2:GetRegexPatternSet, +wafv2:ListTagsForResource +``` + +### Update +```json +wafv2:UpdateRegexPatternSet, +wafv2:GetRegexPatternSet, +wafv2:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/wafv2/regex_pattern_sets/index.md b/docs/aws-docs/providers/aws/wafv2/regex_pattern_sets/index.md new file mode 100644 index 0000000000..3f2a041cd6 --- /dev/null +++ b/docs/aws-docs/providers/aws/wafv2/regex_pattern_sets/index.md @@ -0,0 +1,83 @@ +--- +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
DescriptionContains a list of Regular expressions based on the provided inputs. RegexPatternSet can be used with other WAF entities with RegexPatternSetReferenceStatement to perform other actions .
Idaws.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 + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name, +id, +scope +FROM aws.wafv2.regex_pattern_sets + +``` + +## Permissions + +To operate on the regex_pattern_sets resource, the following permissions are required: + +### Create +```json +wafv2:CreateRegexPatternSet, +wafv2:GetRegexPatternSet, +wafv2:ListTagsForResource +``` + +### List +```json +wafv2:listRegexPatternSets +``` + diff --git a/docs/aws-docs/providers/aws/wafv2/rule_group/index.md b/docs/aws-docs/providers/aws/wafv2/rule_group/index.md new file mode 100644 index 0000000000..b480db57b1 --- /dev/null +++ b/docs/aws-docs/providers/aws/wafv2/rule_group/index.md @@ -0,0 +1,115 @@ +--- +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
DescriptionContains the Rules that identify the requests that you want to allow, block, or count. In a RuleGroup, you also specify a default action (ALLOW or BLOCK), and the action for each Rule that you add to a RuleGroup, for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the RuleGroup with a CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a RuleGroup, a request needs to match only one of the specifications to be allowed, blocked, or counted.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +arn, +capacity, +description, +name, +id, +scope, +rules, +visibility_config, +tags, +label_namespace, +custom_response_bodies, +available_labels, +consumed_labels +FROM aws.wafv2.rule_group +WHERE data__Identifier = '||'; +``` + +## Permissions + +To operate on the rule_group resource, the following permissions are required: + +### Delete +```json +wafv2:DeleteRuleGroup, +wafv2:GetRuleGroup +``` + +### Read +```json +wafv2:GetRuleGroup, +wafv2:ListTagsForResource +``` + +### Update +```json +wafv2:UpdateRuleGroup, +wafv2:GetRuleGroup, +wafv2:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/wafv2/rule_groups/index.md b/docs/aws-docs/providers/aws/wafv2/rule_groups/index.md new file mode 100644 index 0000000000..7c0b75759d --- /dev/null +++ b/docs/aws-docs/providers/aws/wafv2/rule_groups/index.md @@ -0,0 +1,83 @@ +--- +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
DescriptionContains the Rules that identify the requests that you want to allow, block, or count. In a RuleGroup, you also specify a default action (ALLOW or BLOCK), and the action for each Rule that you add to a RuleGroup, for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the RuleGroup with a CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a RuleGroup, a request needs to match only one of the specifications to be allowed, blocked, or counted.
Idaws.wafv2.rule_groups
+ +## Fields + + + + + + + +
NameDatatypeDescription
nameundefined
idundefined
scopeundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name, +id, +scope +FROM aws.wafv2.rule_groups + +``` + +## Permissions + +To operate on the rule_groups resource, the following permissions are required: + +### Create +```json +wafv2:CreateRuleGroup, +wafv2:GetRuleGroup, +wafv2:ListTagsForResource +``` + +### List +```json +wafv2:listRuleGroups +``` + diff --git a/docs/aws-docs/providers/aws/wafv2/web_acl/index.md b/docs/aws-docs/providers/aws/wafv2/web_acl/index.md new file mode 100644 index 0000000000..e4ae27f547 --- /dev/null +++ b/docs/aws-docs/providers/aws/wafv2/web_acl/index.md @@ -0,0 +1,121 @@ +--- +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
DescriptionContains the Rules that identify the requests that you want to allow, block, or count. In a WebACL, you also specify a default action (ALLOW or BLOCK), and the action for each Rule that you add to a WebACL, for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the WebACL with a CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a WebACL, a request needs to match only one of the specifications to be allowed, blocked, or counted.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.wafv2.web_acl +WHERE data__Identifier = '||'; +``` + +## Permissions + +To operate on the web_acl resource, the following permissions are required: + +### Delete +```json +wafv2:DeleteWebACL, +wafv2:GetWebACL +``` + +### Read +```json +wafv2:GetWebACL, +wafv2:ListTagsForResource +``` + +### Update +```json +wafv2:UpdateWebACL, +wafv2:GetWebACL, +wafv2:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/wafv2/web_acls/index.md b/docs/aws-docs/providers/aws/wafv2/web_acls/index.md new file mode 100644 index 0000000000..561304e254 --- /dev/null +++ b/docs/aws-docs/providers/aws/wafv2/web_acls/index.md @@ -0,0 +1,83 @@ +--- +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
DescriptionContains the Rules that identify the requests that you want to allow, block, or count. In a WebACL, you also specify a default action (ALLOW or BLOCK), and the action for each Rule that you add to a WebACL, for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the WebACL with a CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a WebACL, a request needs to match only one of the specifications to be allowed, blocked, or counted.
Idaws.wafv2.web_acls
+ +## Fields + + + + + + + +
NameDatatypeDescription
nameundefined
idundefined
scopeundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +name, +id, +scope +FROM aws.wafv2.web_acls + +``` + +## Permissions + +To operate on the web_acls resource, the following permissions are required: + +### Create +```json +wafv2:CreateWebACL, +wafv2:GetWebACL, +wafv2:ListTagsForResource +``` + +### List +```json +wafv2:listWebACLs +``` + diff --git a/docs/aws-docs/providers/aws/wafv2/webacl_association/index.md b/docs/aws-docs/providers/aws/wafv2/webacl_association/index.md new file mode 100644 index 0000000000..c16e0b3729 --- /dev/null +++ b/docs/aws-docs/providers/aws/wafv2/webacl_association/index.md @@ -0,0 +1,137 @@ +--- +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
DescriptionAssociates WebACL to Application Load Balancer, CloudFront or API Gateway.
Idaws.wafv2.webacl_association
+ +## Fields + + + + + + +
NameDatatypeDescription
resource_arnstring
web_acl_arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +resource_arn, +web_acl_arn +FROM aws.wafv2.webacl_association +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the webacl_association resource, the following permissions are required: + +### Delete +```json +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 +```json +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 +```json +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 +``` + diff --git a/docs/aws-docs/providers/aws/wafv2/webacl_associations/index.md b/docs/aws-docs/providers/aws/wafv2/webacl_associations/index.md new file mode 100644 index 0000000000..bb11800ced --- /dev/null +++ b/docs/aws-docs/providers/aws/wafv2/webacl_associations/index.md @@ -0,0 +1,85 @@ +--- +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
DescriptionAssociates WebACL to Application Load Balancer, CloudFront or API Gateway.
Idaws.wafv2.webacl_associations
+ +## Fields + + + + + + +
NameDatatypeDescription
resource_arnundefined
web_acl_arnundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +resource_arn, +web_acl_arn +FROM aws.wafv2.webacl_associations + +``` + +## Permissions + +To operate on the webacl_associations resource, the following permissions are required: + +### Create +```json +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 +``` + diff --git a/docs/aws-docs/providers/aws/wisdom/assistant/index.md b/docs/aws-docs/providers/aws/wisdom/assistant/index.md new file mode 100644 index 0000000000..f4550d7024 --- /dev/null +++ b/docs/aws-docs/providers/aws/wisdom/assistant/index.md @@ -0,0 +1,99 @@ +--- +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
DescriptionDefinition of AWS::Wisdom::Assistant Resource Type
Idaws.wisdom.assistant
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
typestring
descriptionstring
assistant_arnstring
assistant_idstring
server_side_encryption_configurationobject
tagsarray
namestring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +type, +description, +assistant_arn, +assistant_id, +server_side_encryption_configuration, +tags, +name +FROM aws.wisdom.assistant +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the assistant resource, the following permissions are required: + +### Update +```json +wisdom:GetAssistant +``` + +### Read +```json +wisdom:GetAssistant +``` + +### Delete +```json +wisdom:DeleteAssistant +``` + diff --git a/docs/aws-docs/providers/aws/wisdom/assistant_association/index.md b/docs/aws-docs/providers/aws/wisdom/assistant_association/index.md new file mode 100644 index 0000000000..b51fc5190e --- /dev/null +++ b/docs/aws-docs/providers/aws/wisdom/assistant_association/index.md @@ -0,0 +1,99 @@ +--- +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
DescriptionDefinition of AWS::Wisdom::AssistantAssociation Resource Type
Idaws.wisdom.assistant_association
+ +## Fields + + + + + + + + + + + +
NameDatatypeDescription
assistant_association_arnstring
assistant_arnstring
assistant_association_idstring
assistant_idstring
associationobject
association_typestring
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +assistant_association_arn, +assistant_arn, +assistant_association_id, +assistant_id, +association, +association_type, +tags +FROM aws.wisdom.assistant_association +WHERE data__Identifier = '|'; +``` + +## Permissions + +To operate on the assistant_association resource, the following permissions are required: + +### Update +```json +wisdom:GetAssistantAssociation +``` + +### Read +```json +wisdom:GetAssistantAssociation +``` + +### Delete +```json +wisdom:DeleteAssistantAssociation +``` + diff --git a/docs/aws-docs/providers/aws/wisdom/assistant_associations/index.md b/docs/aws-docs/providers/aws/wisdom/assistant_associations/index.md new file mode 100644 index 0000000000..8636c06453 --- /dev/null +++ b/docs/aws-docs/providers/aws/wisdom/assistant_associations/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionDefinition of AWS::Wisdom::AssistantAssociation Resource Type
Idaws.wisdom.assistant_associations
+ +## Fields + + + + + + +
NameDatatypeDescription
assistant_association_idstring
assistant_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +assistant_association_id, +assistant_id +FROM aws.wisdom.assistant_associations +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the assistant_associations resource, the following permissions are required: + +### Create +```json +wisdom:CreateAssistantAssociation, +wisdom:TagResource +``` + +### List +```json +wisdom:ListAssistantAssociations +``` + diff --git a/docs/aws-docs/providers/aws/wisdom/assistants/index.md b/docs/aws-docs/providers/aws/wisdom/assistants/index.md new file mode 100644 index 0000000000..ea92b2533a --- /dev/null +++ b/docs/aws-docs/providers/aws/wisdom/assistants/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionDefinition of AWS::Wisdom::Assistant Resource Type
Idaws.wisdom.assistants
+ +## Fields + + + + + +
NameDatatypeDescription
assistant_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +assistant_id +FROM aws.wisdom.assistants +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the assistants resource, the following permissions are required: + +### Create +```json +kms:CreateGrant, +kms:DescribeKey, +wisdom:CreateAssistant, +wisdom:TagResource +``` + +### List +```json +wisdom:ListAssistants +``` + diff --git a/docs/aws-docs/providers/aws/wisdom/index.md b/docs/aws-docs/providers/aws/wisdom/index.md new file mode 100644 index 0000000000..e8daa2c3c9 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/wisdom/knowledge_base/index.md b/docs/aws-docs/providers/aws/wisdom/knowledge_base/index.md new file mode 100644 index 0000000000..3b7ba4c653 --- /dev/null +++ b/docs/aws-docs/providers/aws/wisdom/knowledge_base/index.md @@ -0,0 +1,106 @@ +--- +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
DescriptionDefinition of AWS::Wisdom::KnowledgeBase Resource Type
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.wisdom.knowledge_base +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the knowledge_base resource, the following permissions are required: + +### Update +```json +wisdom:GetKnowledgeBase +``` + +### Delete +```json +appflow:DeleteFlow, +appflow:StopFlow, +app-integrations:DeleteDataIntegrationAssociation, +wisdom:DeleteKnowledgeBase +``` + +### Read +```json +wisdom:GetKnowledgeBase +``` + diff --git a/docs/aws-docs/providers/aws/wisdom/knowledge_bases/index.md b/docs/aws-docs/providers/aws/wisdom/knowledge_bases/index.md new file mode 100644 index 0000000000..58253ab063 --- /dev/null +++ b/docs/aws-docs/providers/aws/wisdom/knowledge_bases/index.md @@ -0,0 +1,88 @@ +--- +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
DescriptionDefinition of AWS::Wisdom::KnowledgeBase Resource Type
Idaws.wisdom.knowledge_bases
+ +## Fields + + + + + +
NameDatatypeDescription
knowledge_base_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +knowledge_base_id +FROM aws.wisdom.knowledge_bases +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the knowledge_bases resource, the following permissions are required: + +### Create +```json +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 +```json +wisdom:ListKnowledgeBases +``` + diff --git a/docs/aws-docs/providers/aws/workspaces/connection_alias/index.md b/docs/aws-docs/providers/aws/workspaces/connection_alias/index.md new file mode 100644 index 0000000000..9605591259 --- /dev/null +++ b/docs/aws-docs/providers/aws/workspaces/connection_alias/index.md @@ -0,0 +1,85 @@ +--- +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
DescriptionResource Type definition for AWS::WorkSpaces::ConnectionAlias
Idaws.workspaces.connection_alias
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
associationsarray
alias_idstring
connection_stringstring
connection_alias_statestring
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +associations, +alias_id, +connection_string, +connection_alias_state, +tags +FROM aws.workspaces.connection_alias +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the connection_alias resource, the following permissions are required: + +### Read +```json +workspaces:DescribeConnectionAliases +``` + +### Delete +```json +workspaces:DeleteConnectionAlias +``` + diff --git a/docs/aws-docs/providers/aws/workspaces/connection_aliases/index.md b/docs/aws-docs/providers/aws/workspaces/connection_aliases/index.md new file mode 100644 index 0000000000..5197936576 --- /dev/null +++ b/docs/aws-docs/providers/aws/workspaces/connection_aliases/index.md @@ -0,0 +1,67 @@ +--- +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
DescriptionResource Type definition for AWS::WorkSpaces::ConnectionAlias
Idaws.workspaces.connection_aliases
+ +## Fields + + + + + +
NameDatatypeDescription
alias_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
+ +## `SELECT` Example +```sql +SELECT +region, +alias_id +FROM aws.workspaces.connection_aliases +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the connection_aliases resource, the following permissions are required: + +### Create +```json +workspaces:CreateConnectionAlias +``` + diff --git a/docs/aws-docs/providers/aws/workspaces/index.md b/docs/aws-docs/providers/aws/workspaces/index.md new file mode 100644 index 0000000000..9cf530a292 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/workspacesthinclient/environment/index.md b/docs/aws-docs/providers/aws/workspacesthinclient/environment/index.md new file mode 100644 index 0000000000..fccdf3b457 --- /dev/null +++ b/docs/aws-docs/providers/aws/workspacesthinclient/environment/index.md @@ -0,0 +1,138 @@ +--- +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
DescriptionResource type definition for AWS::WorkSpacesThinClient::Environment.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.workspacesthinclient.environment +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the environment resource, the following permissions are required: + +### Read +```json +thinclient:GetEnvironment, +thinclient:ListTagsForResource, +kms:Decrypt +``` + +### Update +```json +appstream:DescribeStacks, +workspaces:DescribeWorkspaceDirectories, +workspaces-web:GetPortal, +workspaces-web:GetUserSettings, +thinclient:UpdateEnvironment, +thinclient:GetEnvironment, +thinclient:TagResource, +thinclient:UntagResource, +thinclient:ListTagsForResource, +kms:Decrypt, +kms:GenerateDataKey +``` + +### Delete +```json +thinclient:DeleteEnvironment, +thinclient:UntagResource, +kms:Decrypt, +kms:RetireGrant +``` + diff --git a/docs/aws-docs/providers/aws/workspacesthinclient/environments/index.md b/docs/aws-docs/providers/aws/workspacesthinclient/environments/index.md new file mode 100644 index 0000000000..1f950a27e6 --- /dev/null +++ b/docs/aws-docs/providers/aws/workspacesthinclient/environments/index.md @@ -0,0 +1,89 @@ +--- +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
DescriptionResource type definition for AWS::WorkSpacesThinClient::Environment.
Idaws.workspacesthinclient.environments
+ +## Fields + + + + + +
NameDatatypeDescription
idstringUnique identifier of the environment.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +id +FROM aws.workspacesthinclient.environments +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the environments resource, the following permissions are required: + +### Create +```json +thinclient:CreateEnvironment, +thinclient:TagResource, +thinclient:ListTagsForResource, +appstream:DescribeStacks, +workspaces:DescribeWorkspaceDirectories, +workspaces-web:GetPortal, +workspaces-web:GetUserSettings, +kms:DescribeKey, +kms:CreateGrant, +kms:GenerateDataKey, +kms:Decrypt +``` + +### List +```json +thinclient:ListEnvironment, +thinclient:ListTagsForResource, +kms:Decrypt +``` + diff --git a/docs/aws-docs/providers/aws/workspacesthinclient/index.md b/docs/aws-docs/providers/aws/workspacesthinclient/index.md new file mode 100644 index 0000000000..a0772cfd51 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/workspacesweb/browser_settings/index.md b/docs/aws-docs/providers/aws/workspacesweb/browser_settings/index.md new file mode 100644 index 0000000000..5ac5097a05 --- /dev/null +++ b/docs/aws-docs/providers/aws/workspacesweb/browser_settings/index.md @@ -0,0 +1,117 @@ +--- +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
DescriptionDefinition of AWS::WorkSpacesWeb::BrowserSettings Resource Type
Idaws.workspacesweb.browser_settings
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
additional_encryption_contextobject
associated_portal_arnsarray
browser_policystring
browser_settings_arnstring
customer_managed_keystring
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +additional_encryption_context, +associated_portal_arns, +browser_policy, +browser_settings_arn, +customer_managed_key, +tags +FROM aws.workspacesweb.browser_settings +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the browser_settings resource, the following permissions are required: + +### Read +```json +workspaces-web:GetBrowserSettings, +workspaces-web:ListBrowserSettings, +workspaces-web:ListTagsForResource, +kms:CreateGrant, +kms:DescribeKey, +kms:GenerateDataKey, +kms:Decrypt +``` + +### Update +```json +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 +```json +workspaces-web:GetBrowserSettings, +workspaces-web:DeleteBrowserSettings, +kms:CreateGrant, +kms:DescribeKey, +kms:GenerateDataKey, +kms:Decrypt +``` + diff --git a/docs/aws-docs/providers/aws/workspacesweb/identity_provider/index.md b/docs/aws-docs/providers/aws/workspacesweb/identity_provider/index.md new file mode 100644 index 0000000000..9e686cab94 --- /dev/null +++ b/docs/aws-docs/providers/aws/workspacesweb/identity_provider/index.md @@ -0,0 +1,103 @@ +--- +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
DescriptionDefinition of AWS::WorkSpacesWeb::IdentityProvider Resource Type
Idaws.workspacesweb.identity_provider
+ +## Fields + + + + + + + + + +
NameDatatypeDescription
identity_provider_arnstring
identity_provider_detailsobject
identity_provider_namestring
identity_provider_typestring
portal_arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +identity_provider_arn, +identity_provider_details, +identity_provider_name, +identity_provider_type, +portal_arn +FROM aws.workspacesweb.identity_provider +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the identity_provider resource, the following permissions are required: + +### Read +```json +workspaces-web:GetIdentityProvider, +workspaces-web:ListIdentityProviders, +workspaces-web:ListTagsForResource +``` + +### Update +```json +workspaces-web:UpdateIdentityProvider, +workspaces-web:TagResource, +workspaces-web:UntagResource, +workspaces-web:GetIdentityProvider, +workspaces-web:ListIdentityProviders, +workspaces-web:ListTagsForResource +``` + +### Delete +```json +workspaces-web:GetIdentityProvider, +workspaces-web:DeleteIdentityProvider +``` + diff --git a/docs/aws-docs/providers/aws/workspacesweb/identity_providers/index.md b/docs/aws-docs/providers/aws/workspacesweb/identity_providers/index.md new file mode 100644 index 0000000000..267dee9efd --- /dev/null +++ b/docs/aws-docs/providers/aws/workspacesweb/identity_providers/index.md @@ -0,0 +1,80 @@ +--- +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
DescriptionDefinition of AWS::WorkSpacesWeb::IdentityProvider Resource Type
Idaws.workspacesweb.identity_providers
+ +## Fields + + + + + +
NameDatatypeDescription
identity_provider_arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +identity_provider_arn +FROM aws.workspacesweb.identity_providers +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the identity_providers resource, the following permissions are required: + +### Create +```json +workspaces-web:CreateIdentityProvider, +workspaces-web:GetIdentityProvider, +workspaces-web:ListTagsForResource, +workspaces-web:TagResource +``` + +### List +```json +workspaces-web:ListIdentityProviders +``` + diff --git a/docs/aws-docs/providers/aws/workspacesweb/index.md b/docs/aws-docs/providers/aws/workspacesweb/index.md new file mode 100644 index 0000000000..67bcaf6dda --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/workspacesweb/ip_access_settings/index.md b/docs/aws-docs/providers/aws/workspacesweb/ip_access_settings/index.md new file mode 100644 index 0000000000..fc2f445a4c --- /dev/null +++ b/docs/aws-docs/providers/aws/workspacesweb/ip_access_settings/index.md @@ -0,0 +1,124 @@ +--- +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
DescriptionDefinition of AWS::WorkSpacesWeb::IpAccessSettings Resource Type
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.workspacesweb.ip_access_settings +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the ip_access_settings resource, the following permissions are required: + +### Read +```json +workspaces-web:GetIpAccessSettings, +workspaces-web:ListIpAccessSettings, +workspaces-web:ListTagsForResource, +kms:CreateGrant, +kms:DescribeKey, +kms:GenerateDataKey, +kms:Decrypt +``` + +### Update +```json +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 +```json +workspaces-web:GetIpAccessSettings, +workspaces-web:ListIpAccessSettings, +workspaces-web:DeleteIpAccessSettings, +kms:CreateGrant, +kms:DescribeKey, +kms:GenerateDataKey, +kms:Decrypt +``` + diff --git a/docs/aws-docs/providers/aws/workspacesweb/network_settings/index.md b/docs/aws-docs/providers/aws/workspacesweb/network_settings/index.md new file mode 100644 index 0000000000..a89d85e812 --- /dev/null +++ b/docs/aws-docs/providers/aws/workspacesweb/network_settings/index.md @@ -0,0 +1,104 @@ +--- +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
DescriptionDefinition of AWS::WorkSpacesWeb::NetworkSettings Resource Type
Idaws.workspacesweb.network_settings
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
associated_portal_arnsarray
network_settings_arnstring
security_group_idsarray
subnet_idsarray
tagsarray
vpc_idstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +associated_portal_arns, +network_settings_arn, +security_group_ids, +subnet_ids, +tags, +vpc_id +FROM aws.workspacesweb.network_settings +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the network_settings resource, the following permissions are required: + +### Read +```json +workspaces-web:GetNetworkSettings, +workspaces-web:ListTagsForResource +``` + +### Update +```json +workspaces-web:UpdateNetworkSettings, +workspaces-web:UpdateResource, +workspaces-web:TagResource, +workspaces-web:UntagResource, +workspaces-web:GetNetworkSettings, +workspaces-web:ListTagsForResource +``` + +### Delete +```json +workspaces-web:GetNetworkSettings, +workspaces-web:DeleteNetworkSettings +``` + diff --git a/docs/aws-docs/providers/aws/workspacesweb/portal/index.md b/docs/aws-docs/providers/aws/workspacesweb/portal/index.md new file mode 100644 index 0000000000..1fafff4416 --- /dev/null +++ b/docs/aws-docs/providers/aws/workspacesweb/portal/index.md @@ -0,0 +1,169 @@ +--- +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
DescriptionDefinition of AWS::WorkSpacesWeb::Portal Resource Type
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.workspacesweb.portal +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the portal resource, the following permissions are required: + +### Read +```json +workspaces-web:GetPortal, +workspaces-web:GetPortalServiceProviderMetadata, +workspaces-web:ListTagsForResource, +kms:Decrypt +``` + +### Update +```json +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 +```json +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 +``` + diff --git a/docs/aws-docs/providers/aws/workspacesweb/portals/index.md b/docs/aws-docs/providers/aws/workspacesweb/portals/index.md new file mode 100644 index 0000000000..be18ccb22d --- /dev/null +++ b/docs/aws-docs/providers/aws/workspacesweb/portals/index.md @@ -0,0 +1,101 @@ +--- +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
DescriptionDefinition of AWS::WorkSpacesWeb::Portal Resource Type
Idaws.workspacesweb.portals
+ +## Fields + + + + + +
NameDatatypeDescription
portal_arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +portal_arn +FROM aws.workspacesweb.portals +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the portals resource, the following permissions are required: + +### Create +```json +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 +```json +workspaces-web:ListPortals, +kms:Decrypt +``` + diff --git a/docs/aws-docs/providers/aws/workspacesweb/trust_store/index.md b/docs/aws-docs/providers/aws/workspacesweb/trust_store/index.md new file mode 100644 index 0000000000..d5ed1cdbc8 --- /dev/null +++ b/docs/aws-docs/providers/aws/workspacesweb/trust_store/index.md @@ -0,0 +1,104 @@ +--- +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
DescriptionDefinition of AWS::WorkSpacesWeb::TrustStore Resource Type
Idaws.workspacesweb.trust_store
+ +## Fields + + + + + + + + +
NameDatatypeDescription
associated_portal_arnsarray
certificate_listarray
tagsarray
trust_store_arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +associated_portal_arns, +certificate_list, +tags, +trust_store_arn +FROM aws.workspacesweb.trust_store +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the trust_store resource, the following permissions are required: + +### Read +```json +workspaces-web:GetTrustStore, +workspaces-web:GetTrustStoreCertificate, +workspaces-web:ListTagsForResource, +workspaces-web:ListTrustStoreCertificates +``` + +### Update +```json +workspaces-web:UpdateTrustStore, +workspaces-web:TagResource, +workspaces-web:UntagResource, +workspaces-web:GetTrustStore, +workspaces-web:GetTrustStoreCertificate, +workspaces-web:ListTagsForResource, +workspaces-web:ListTrustStoreCertificates +``` + +### Delete +```json +workspaces-web:GetTrustStore, +workspaces-web:GetTrustStoreCertificate, +workspaces-web:DeleteTrustStore +``` + diff --git a/docs/aws-docs/providers/aws/workspacesweb/trust_stores/index.md b/docs/aws-docs/providers/aws/workspacesweb/trust_stores/index.md new file mode 100644 index 0000000000..d3930f3fc2 --- /dev/null +++ b/docs/aws-docs/providers/aws/workspacesweb/trust_stores/index.md @@ -0,0 +1,83 @@ +--- +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
DescriptionDefinition of AWS::WorkSpacesWeb::TrustStore Resource Type
Idaws.workspacesweb.trust_stores
+ +## Fields + + + + + +
NameDatatypeDescription
trust_store_arnstring
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +trust_store_arn +FROM aws.workspacesweb.trust_stores +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the trust_stores resource, the following permissions are required: + +### Create +```json +workspaces-web:CreateTrustStore, +workspaces-web:GetTrustStore, +workspaces-web:GetTrustStoreCertificate, +workspaces-web:ListTrustStoreCertificates, +workspaces-web:ListTagsForResource, +workspaces-web:TagResource +``` + +### List +```json +workspaces-web:ListTrustStores, +workspaces-web:ListTrustStoreCertificates +``` + diff --git a/docs/aws-docs/providers/aws/workspacesweb/user_access_logging_settings/index.md b/docs/aws-docs/providers/aws/workspacesweb/user_access_logging_settings/index.md new file mode 100644 index 0000000000..24fde94005 --- /dev/null +++ b/docs/aws-docs/providers/aws/workspacesweb/user_access_logging_settings/index.md @@ -0,0 +1,101 @@ +--- +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
DescriptionDefinition of AWS::WorkSpacesWeb::UserAccessLoggingSettings Resource Type
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +associated_portal_arns, +kinesis_stream_arn, +tags, +user_access_logging_settings_arn +FROM aws.workspacesweb.user_access_logging_settings +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the user_access_logging_settings resource, the following permissions are required: + +### Read +```json +workspaces-web:GetUserAccessLoggingSettings, +workspaces-web:ListTagsForResource +``` + +### Update +```json +workspaces-web:UpdateUserAccessLoggingSettings, +workspaces-web:TagResource, +workspaces-web:UntagResource, +workspaces-web:GetUserAccessLoggingSettings, +workspaces-web:ListTagsForResource, +kinesis:PutRecord, +kinesis:PutRecords +``` + +### Delete +```json +workspaces-web:GetUserAccessLoggingSettings, +workspaces-web:DeleteUserAccessLoggingSettings +``` + diff --git a/docs/aws-docs/providers/aws/workspacesweb/user_settings/index.md b/docs/aws-docs/providers/aws/workspacesweb/user_settings/index.md new file mode 100644 index 0000000000..2ae5b7b4b9 --- /dev/null +++ b/docs/aws-docs/providers/aws/workspacesweb/user_settings/index.md @@ -0,0 +1,129 @@ +--- +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
DescriptionDefinition of AWS::WorkSpacesWeb::UserSettings Resource Type
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` 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 aws.workspacesweb.user_settings +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the user_settings resource, the following permissions are required: + +### Read +```json +workspaces-web:GetUserSettings, +workspaces-web:ListTagsForResource, +kms:CreateGrant, +kms:DescribeKey, +kms:GenerateDataKey, +kms:Decrypt +``` + +### Update +```json +workspaces-web:UpdateUserSettings, +workspaces-web:TagResource, +workspaces-web:UntagResource, +workspaces-web:GetUserSettings, +workspaces-web:ListTagsForResource, +kms:CreateGrant, +kms:DescribeKey, +kms:GenerateDataKey, +kms:Decrypt +``` + +### Delete +```json +workspaces-web:GetUserSettings, +workspaces-web:DeleteUserSettings, +kms:CreateGrant, +kms:DescribeKey, +kms:GenerateDataKey, +kms:Decrypt +``` + diff --git a/docs/aws-docs/providers/aws/xray/group/index.md b/docs/aws-docs/providers/aws/xray/group/index.md new file mode 100644 index 0000000000..7aeb79e44b --- /dev/null +++ b/docs/aws-docs/providers/aws/xray/group/index.md @@ -0,0 +1,99 @@ +--- +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
DescriptionThis schema provides construct and validation rules for AWS-XRay Group resource parameters.
Idaws.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_arnstringThe ARN of the group that was generated on creation.
insights_configurationobject
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +filter_expression, +group_name, +group_arn, +insights_configuration, +tags +FROM aws.xray.group +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the group resource, the following permissions are required: + +### Read +```json +xray:GetGroup, +xray:ListTagsForResource +``` + +### Update +```json +xray:UpdateGroup, +xray:TagResource, +xray:UntagResource, +xray:ListTagsForResource +``` + +### Delete +```json +xray:DeleteGroup +``` + diff --git a/docs/aws-docs/providers/aws/xray/groups/index.md b/docs/aws-docs/providers/aws/xray/groups/index.md new file mode 100644 index 0000000000..db7e2683e5 --- /dev/null +++ b/docs/aws-docs/providers/aws/xray/groups/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionThis schema provides construct and validation rules for AWS-XRay Group resource parameters.
Idaws.xray.groups
+ +## Fields + + + + + +
NameDatatypeDescription
group_arnstringThe ARN of the group that was generated on creation.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +group_arn +FROM aws.xray.groups +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the groups resource, the following permissions are required: + +### Create +```json +xray:CreateGroup, +xray:TagResource +``` + +### List +```json +xray:GetGroups, +xray:ListTagsForResource +``` + diff --git a/docs/aws-docs/providers/aws/xray/index.md b/docs/aws-docs/providers/aws/xray/index.md new file mode 100644 index 0000000000..479bb82ee3 --- /dev/null +++ b/docs/aws-docs/providers/aws/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/aws-docs/providers/aws/xray/resource_policies/index.md b/docs/aws-docs/providers/aws/xray/resource_policies/index.md new file mode 100644 index 0000000000..781b8008f9 --- /dev/null +++ b/docs/aws-docs/providers/aws/xray/resource_policies/index.md @@ -0,0 +1,78 @@ +--- +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
DescriptionThis schema provides construct and validation rules for AWS-XRay Resource Policy resource parameters.
Idaws.xray.resource_policies
+ +## Fields + + + + + +
NameDatatypeDescription
policy_namestringThe name of the resource policy. Must be unique within a specific AWS account.
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +policy_name +FROM aws.xray.resource_policies +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the resource_policies resource, the following permissions are required: + +### Create +```json +xray:PutResourcePolicy, +xray:ListResourcePolicies +``` + +### List +```json +xray:ListResourcePolicies +``` + diff --git a/docs/aws-docs/providers/aws/xray/resource_policy/index.md b/docs/aws-docs/providers/aws/xray/resource_policy/index.md new file mode 100644 index 0000000000..57cdd8d2ad --- /dev/null +++ b/docs/aws-docs/providers/aws/xray/resource_policy/index.md @@ -0,0 +1,92 @@ +--- +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
DescriptionThis schema provides construct and validation rules for AWS-XRay Resource Policy resource parameters.
Idaws.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 + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +policy_name, +policy_document, +bypass_policy_lockout_check +FROM aws.xray.resource_policy +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the resource_policy resource, the following permissions are required: + +### Read +```json +xray:ListResourcePolicies +``` + +### Update +```json +xray:PutResourcePolicy, +xray:ListResourcePolicies +``` + +### Delete +```json +xray:DeleteResourcePolicy +``` + diff --git a/docs/aws-docs/providers/aws/xray/sampling_rule/index.md b/docs/aws-docs/providers/aws/xray/sampling_rule/index.md new file mode 100644 index 0000000000..7ad791a3d6 --- /dev/null +++ b/docs/aws-docs/providers/aws/xray/sampling_rule/index.md @@ -0,0 +1,101 @@ +--- +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
DescriptionThis schema provides construct and validation rules for AWS-XRay SamplingRule resource parameters.
Idaws.xray.sampling_rule
+ +## Fields + + + + + + + + + + +
NameDatatypeDescription
sampling_ruleobject
sampling_rule_recordobject
sampling_rule_updateobject
rule_arnstring
rule_namestring
tagsarray
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
delete_resourceDELETEdata__Identifier, region
get_resourceSELECTdata__Identifier, region
+ +## `SELECT` Example +```sql +SELECT +region, +sampling_rule, +sampling_rule_record, +sampling_rule_update, +rule_arn, +rule_name, +tags +FROM aws.xray.sampling_rule +WHERE data__Identifier = ''; +``` + +## Permissions + +To operate on the sampling_rule resource, the following permissions are required: + +### Read +```json +xray:GetSamplingRules, +xray:ListTagsForResource +``` + +### Update +```json +xray:UpdateSamplingRule, +xray:TagResource, +xray:UntagResource, +xray:ListTagsForResource +``` + +### Delete +```json +xray:DeleteSamplingRule +``` + diff --git a/docs/aws-docs/providers/aws/xray/sampling_rules/index.md b/docs/aws-docs/providers/aws/xray/sampling_rules/index.md new file mode 100644 index 0000000000..fca9d8431a --- /dev/null +++ b/docs/aws-docs/providers/aws/xray/sampling_rules/index.md @@ -0,0 +1,79 @@ +--- +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
DescriptionThis schema provides construct and validation rules for AWS-XRay SamplingRule resource parameters.
Idaws.xray.sampling_rules
+ +## Fields + + + + + +
NameDatatypeDescription
rule_arnundefined
regionstringAWS region.
+ +## Methods + + + + + + + + + + + + + + + + + +
NameAccessible byRequired Params
create_resourceINSERTdata__DesiredState, region
list_resourceSELECTregion
+ +## `SELECT` Example +```sql +SELECT +region, +rule_arn +FROM aws.xray.sampling_rules +WHERE region = 'us-east-1' +``` + +## Permissions + +To operate on the sampling_rules resource, the following permissions are required: + +### Create +```json +xray:CreateSamplingRule, +xray:TagResource +``` + +### List +```json +xray:GetSamplingRules, +xray:ListTagsForResource +``` + diff --git a/docs/awscc-docs/index.md b/docs/awscc-docs/index.md deleted file mode 100644 index 752c2a3288..0000000000 --- a/docs/awscc-docs/index.md +++ /dev/null @@ -1,306 +0,0 @@ ---- -title: awscc -hide_title: false -hide_table_of_contents: false -keywords: - - aws - - aws cloud control - - cloud control api - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud 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: awscc-doc -slug: /providers/awscc - ---- -Cloud services from AWS using the Cloud Control API. - -:::info Provider Summary (v24.03.00220) - -
-
-total services: 208
-total methods: 1,792
-
-
-total resources: 1,788
-total selectable resources: 1,788
-
-
- -::: - -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 `awscc` provider, run the following command: - -```bash -REGISTRY PULL awscc; -``` -> 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)) -- `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)) - -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='{ "awscc": { "type": "aws_signing_v4", "keyIDenvvar": "YOUR_ACCESS_KEY_ID_VAR", "credentialsenvvar": "YOUR_SECRET_KEY_VAR" }}' -stackql shell --auth="${AUTH}" - -``` -or using PowerShell: - -```powershell - -$Auth = "{ 'awscc': { '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 `awscc` 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
-ec2
-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 deleted file mode 100644 index 4860011920..0000000000 --- a/docs/awscc-docs/providers/awscc/accessanalyzer/analyzer/index.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -analyzer_name, -archive_rules, -arn, -tags, -type, -analyzer_configuration -FROM awscc.accessanalyzer.analyzer -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the analyzer resource, the following permissions are required: - -### Read -```json -access-analyzer:ListAnalyzers, -access-analyzer:GetAnalyzer, -access-analyzer:ListArchiveRules -``` - -### Update -```json -access-analyzer:CreateArchiveRule, -access-analyzer:DeleteArchiveRule, -access-analyzer:ListAnalyzers, -access-analyzer:TagResource, -access-analyzer:UntagResource, -access-analyzer:UpdateArchiveRule -``` - -### Delete -```json -access-analyzer:DeleteAnalyzer -``` - diff --git a/docs/awscc-docs/providers/awscc/accessanalyzer/analyzers/index.md b/docs/awscc-docs/providers/awscc/accessanalyzer/analyzers/index.md deleted file mode 100644 index 40cc5541f6..0000000000 --- a/docs/awscc-docs/providers/awscc/accessanalyzer/analyzers/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.accessanalyzer.analyzers -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the analyzers resource, the following permissions are required: - -### Create -```json -access-analyzer:CreateAnalyzer, -access-analyzer:TagResource, -iam:CreateServiceLinkedRole, -organizations:ListAWSServiceAccessForOrganization, -organizations:ListDelegatedAdministrators -``` - -### List -```json -access-analyzer:ListAnalyzers -``` - diff --git a/docs/awscc-docs/providers/awscc/accessanalyzer/index.md b/docs/awscc-docs/providers/awscc/accessanalyzer/index.md deleted file mode 100644 index 1a16250a36..0000000000 --- a/docs/awscc-docs/providers/awscc/accessanalyzer/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 deleted file mode 100644 index 98e1169809..0000000000 --- a/docs/awscc-docs/providers/awscc/acmpca/certificate/index.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the certificate resource, the following permissions are required: - -### Read -```json -acm-pca:GetCertificate -``` - -### Delete -```json -acm-pca:GetCertificate -``` - diff --git a/docs/awscc-docs/providers/awscc/acmpca/certificate_authorities/index.md b/docs/awscc-docs/providers/awscc/acmpca/certificate_authorities/index.md deleted file mode 100644 index 84e47ca46f..0000000000 --- a/docs/awscc-docs/providers/awscc/acmpca/certificate_authorities/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.acmpca.certificate_authorities -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the certificate_authorities resource, the following permissions are required: - -### Create -```json -acm-pca:CreateCertificateAuthority, -acm-pca:DescribeCertificateAuthority, -acm-pca:GetCertificateAuthorityCsr -``` - -### List -```json -acm-pca:DescribeCertificateAuthority, -acm-pca:GetCertificateAuthorityCsr, -acm-pca:ListCertificateAuthorities, -acm-pca:ListTags -``` - diff --git a/docs/awscc-docs/providers/awscc/acmpca/certificate_authority/index.md b/docs/awscc-docs/providers/awscc/acmpca/certificate_authority/index.md deleted file mode 100644 index 289bebdf1c..0000000000 --- a/docs/awscc-docs/providers/awscc/acmpca/certificate_authority/index.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the certificate_authority resource, the following permissions are required: - -### Read -```json -acm-pca:DescribeCertificateAuthority, -acm-pca:GetCertificateAuthorityCsr, -acm-pca:ListTags -``` - -### Update -```json -acm-pca:ListTags, -acm-pca:TagCertificateAuthority, -acm-pca:UntagCertificateAuthority, -acm-pca:UpdateCertificateAuthority -``` - -### Delete -```json -acm-pca:DeleteCertificateAuthority, -acm-pca:DescribeCertificateAuthority -``` - 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 deleted file mode 100644 index 877c81019f..0000000000 --- a/docs/awscc-docs/providers/awscc/acmpca/certificate_authority_activation/index.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -certificate_authority_arn, -certificate, -certificate_chain, -status, -complete_certificate_chain -FROM awscc.acmpca.certificate_authority_activation -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the certificate_authority_activation resource, the following permissions are required: - -### Read -```json -acm-pca:GetCertificateAuthorityCertificate, -acm-pca:DescribeCertificateAuthority -``` - -### Delete -```json -acm-pca:UpdateCertificateAuthority -``` - -### Update -```json -acm-pca:ImportCertificateAuthorityCertificate, -acm-pca:UpdateCertificateAuthority -``` - diff --git a/docs/awscc-docs/providers/awscc/acmpca/index.md b/docs/awscc-docs/providers/awscc/acmpca/index.md deleted file mode 100644 index 1fcfcf4ad6..0000000000 --- a/docs/awscc-docs/providers/awscc/acmpca/index.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -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: 5
-total selectable resources: 5
-total methods: 5
-
-
- -::: - -## Resources -
-
-certificate
-certificate_authorities
-certificate_authority -
-
-certificate_authority_activation
-permission -
-
\ 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 deleted file mode 100644 index 1a7537b50f..0000000000 --- a/docs/awscc-docs/providers/awscc/acmpca/permission/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -actions, -certificate_authority_arn, -principal, -source_account -FROM awscc.acmpca.permission -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the permission resource, the following permissions are required: - -### Read -```json -acm-pca:ListPermissions -``` - -### Delete -```json -acm-pca:DeletePermission -``` - diff --git a/docs/awscc-docs/providers/awscc/amplify/app/index.md b/docs/awscc-docs/providers/awscc/amplify/app/index.md deleted file mode 100644 index 30cf4f98f5..0000000000 --- a/docs/awscc-docs/providers/awscc/amplify/app/index.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -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
iam_service_rolestring
namestring
oauth_tokenstring
platformstring
repositorystring
tagsarray
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## 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, -iam_service_role, -name, -oauth_token, -platform, -repository, -tags -FROM awscc.amplify.app -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the app resource, the following permissions are required: - -### Delete -```json -amplify:GetApp, -amplify:DeleteApp, -codecommit:GetRepository, -codecommit:GetRepositoryTriggers, -codecommit:PutRepositoryTriggers, -sns:Unsubscribe, -iam:PassRole -``` - -### Read -```json -amplify:GetApp, -amplify:ListTagsForResource, -codecommit:GetRepository, -codecommit:GetRepositoryTriggers, -iam:PassRole -``` - -### Update -```json -amplify:GetApp, -amplify:UpdateApp, -amplify:ListTagsForResource, -amplify:TagResource, -amplify:UntagResource, -codecommit:GetRepository, -codecommit:PutRepositoryTriggers, -codecommit:GetRepositoryTriggers, -sns:CreateTopic, -sns:Subscribe, -sns:Unsubscribe, -iam:PassRole -``` - diff --git a/docs/awscc-docs/providers/awscc/amplify/apps/index.md b/docs/awscc-docs/providers/awscc/amplify/apps/index.md deleted file mode 100644 index 6a151ffa18..0000000000 --- a/docs/awscc-docs/providers/awscc/amplify/apps/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.amplify.apps -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the apps resource, the following permissions are required: - -### Create -```json -amplify:GetApp, -amplify:CreateApp, -amplify:TagResource, -codecommit:GetRepository, -codecommit:PutRepositoryTriggers, -codecommit:GetRepositoryTriggers, -sns:CreateTopic, -sns:Subscribe, -iam:PassRole -``` - -### List -```json -amplify:GetApp, -amplify:ListApps, -amplify:ListTagsForResource, -iam:PassRole -``` - diff --git a/docs/awscc-docs/providers/awscc/amplify/branch/index.md b/docs/awscc-docs/providers/awscc/amplify/branch/index.md deleted file mode 100644 index 948451c90f..0000000000 --- a/docs/awscc-docs/providers/awscc/amplify/branch/index.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the branch resource, the following permissions are required: - -### Delete -```json -amplify:GetBranch, -amplify:DeleteBranch, -codecommit:GetRepository, -codecommit:GetRepositoryTriggers, -sns:Unsubscribe, -iam:PassRole -``` - -### Read -```json -amplify:GetBranch, -amplify:ListTagsForResource, -codecommit:GetRepository, -codecommit:GetRepositoryTriggers, -s3:GetObject, -s3:GetObjectAcl, -iam:PassRole -``` - -### Update -```json -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 -``` - diff --git a/docs/awscc-docs/providers/awscc/amplify/branches/index.md b/docs/awscc-docs/providers/awscc/amplify/branches/index.md deleted file mode 100644 index 3832b3577b..0000000000 --- a/docs/awscc-docs/providers/awscc/amplify/branches/index.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.amplify.branches -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the branches resource, the following permissions are required: - -### Create -```json -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 -```json -amplify:GetBranch, -amplify:ListBranches, -amplify:ListTagsForResource, -iam:PassRole -``` - diff --git a/docs/awscc-docs/providers/awscc/amplify/domain/index.md b/docs/awscc-docs/providers/awscc/amplify/domain/index.md deleted file mode 100644 index 7552c57db9..0000000000 --- a/docs/awscc-docs/providers/awscc/amplify/domain/index.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -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_iam_rolestring
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. - -## Example -```sql -SELECT -region, -app_id, -arn, -auto_sub_domain_creation_patterns, -auto_sub_domain_iam_role, -certificate_record, -certificate, -certificate_settings, -domain_name, -domain_status, -update_status, -enable_auto_sub_domain, -status_reason, -sub_domain_settings -FROM awscc.amplify.domain -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the domain resource, the following permissions are required: - -### Delete -```json -amplify:DeleteDomainAssociation, -iam:PassRole, -amplify:DeleteDomainAssociation -``` - -### Read -```json -amplify:GetDomainAssociation, -route53:ListHostedZones, -iam:PassRole, -amplify:ListTagsForResource -``` - -### Update -```json -amplify:UpdateDomainAssociation, -route53:ListHostedZones, -route53:ChangeResourceRecordSets, -iam:PassRole, -amplify:ListTagsForResource, -amplify:TagResource, -amplify:UntagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/amplify/domains/index.md b/docs/awscc-docs/providers/awscc/amplify/domains/index.md deleted file mode 100644 index ece046f6ec..0000000000 --- a/docs/awscc-docs/providers/awscc/amplify/domains/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.amplify.domains -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the domains resource, the following permissions are required: - -### Create -```json -amplify:CreateDomainAssociation, -route53:ListHostedZones, -route53:ChangeResourceRecordSets, -iam:PassRole, -amplify:TagResource -``` - -### List -```json -amplify:ListDomainAssociations, -iam:PassRole, -amplify:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/amplify/index.md b/docs/awscc-docs/providers/awscc/amplify/index.md deleted file mode 100644 index 144afbb223..0000000000 --- a/docs/awscc-docs/providers/awscc/amplify/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -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 deleted file mode 100644 index ca649ae90f..0000000000 --- a/docs/awscc-docs/providers/awscc/amplifyuibuilder/component/index.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -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. - -## 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 data__Identifier = '||'; -``` - -## Permissions - -To operate on the component resource, the following permissions are required: - -### Read -```json -amplify:GetApp, -amplifyuibuilder:GetComponent -``` - -### Update -```json -amplify:GetApp, -amplifyuibuilder:GetComponent, -amplifyuibuilder:TagResource, -amplifyuibuilder:UntagResource, -amplifyuibuilder:UpdateComponent -``` - -### Delete -```json -amplify:GetApp, -amplifyuibuilder:DeleteComponent, -amplifyuibuilder:GetComponent, -amplifyuibuilder:UntagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/amplifyuibuilder/components/index.md b/docs/awscc-docs/providers/awscc/amplifyuibuilder/components/index.md deleted file mode 100644 index b81c1847c1..0000000000 --- a/docs/awscc-docs/providers/awscc/amplifyuibuilder/components/index.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -app_id, -environment_name, -id -FROM awscc.amplifyuibuilder.components -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the components resource, the following permissions are required: - -### Create -```json -amplify:GetApp, -amplifyuibuilder:CreateComponent, -amplifyuibuilder:GetComponent, -amplifyuibuilder:TagResource -``` - -### List -```json -amplify:GetApp, -amplifyuibuilder:ListComponents -``` - diff --git a/docs/awscc-docs/providers/awscc/amplifyuibuilder/form/index.md b/docs/awscc-docs/providers/awscc/amplifyuibuilder/form/index.md deleted file mode 100644 index 0f5944d766..0000000000 --- a/docs/awscc-docs/providers/awscc/amplifyuibuilder/form/index.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -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. - -## 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 data__Identifier = '||'; -``` - -## Permissions - -To operate on the form resource, the following permissions are required: - -### Read -```json -amplify:GetApp, -amplifyuibuilder:GetForm, -amplifyuibuilder:TagResource -``` - -### Update -```json -amplify:GetApp, -amplifyuibuilder:GetForm, -amplifyuibuilder:TagResource, -amplifyuibuilder:UntagResource, -amplifyuibuilder:UpdateForm -``` - -### Delete -```json -amplify:GetApp, -amplifyuibuilder:DeleteForm, -amplifyuibuilder:TagResource, -amplifyuibuilder:UntagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/amplifyuibuilder/forms/index.md b/docs/awscc-docs/providers/awscc/amplifyuibuilder/forms/index.md deleted file mode 100644 index 9c85f6009e..0000000000 --- a/docs/awscc-docs/providers/awscc/amplifyuibuilder/forms/index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -app_id, -environment_name, -id -FROM awscc.amplifyuibuilder.forms -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the forms resource, the following permissions are required: - -### Create -```json -amplify:GetApp, -amplifyuibuilder:CreateForm, -amplifyuibuilder:GetForm, -amplifyuibuilder:TagResource, -amplifyuibuilder:UntagResource -``` - -### List -```json -amplify:GetApp, -amplifyuibuilder:ListForms -``` - diff --git a/docs/awscc-docs/providers/awscc/amplifyuibuilder/index.md b/docs/awscc-docs/providers/awscc/amplifyuibuilder/index.md deleted file mode 100644 index 00dcbbad9a..0000000000 --- a/docs/awscc-docs/providers/awscc/amplifyuibuilder/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -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 deleted file mode 100644 index 68a4cbe31e..0000000000 --- a/docs/awscc-docs/providers/awscc/amplifyuibuilder/theme/index.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -app_id, -created_at, -environment_name, -id, -modified_at, -name, -overrides, -tags, -values -FROM awscc.amplifyuibuilder.theme -WHERE data__Identifier = '||'; -``` - -## Permissions - -To operate on the theme resource, the following permissions are required: - -### Read -```json -amplify:GetApp, -amplifyuibuilder:GetTheme -``` - -### Update -```json -amplify:GetApp, -amplifyuibuilder:GetTheme, -amplifyuibuilder:TagResource, -amplifyuibuilder:UntagResource, -amplifyuibuilder:UpdateTheme -``` - -### Delete -```json -amplify:GetApp, -amplifyuibuilder:DeleteTheme, -amplifyuibuilder:UntagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/amplifyuibuilder/themes/index.md b/docs/awscc-docs/providers/awscc/amplifyuibuilder/themes/index.md deleted file mode 100644 index 67b3cead2d..0000000000 --- a/docs/awscc-docs/providers/awscc/amplifyuibuilder/themes/index.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -app_id, -environment_name, -id -FROM awscc.amplifyuibuilder.themes -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the themes resource, the following permissions are required: - -### Create -```json -amplify:GetApp, -amplifyuibuilder:CreateTheme, -amplifyuibuilder:GetTheme, -amplifyuibuilder:TagResource -``` - -### List -```json -amplify:GetApp, -amplifyuibuilder:ListThemes -``` - diff --git a/docs/awscc-docs/providers/awscc/apigateway/account/index.md b/docs/awscc-docs/providers/awscc/apigateway/account/index.md deleted file mode 100644 index 4db2acb66f..0000000000 --- a/docs/awscc-docs/providers/awscc/apigateway/account/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id, -cloud_watch_role_arn -FROM awscc.apigateway.account -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the account resource, the following permissions are required: - -### Read -```json -apigateway:GET -``` - -### Update -```json -apigateway:PATCH, -iam:GetRole, -iam:PassRole -``` - diff --git a/docs/awscc-docs/providers/awscc/apigateway/api_key/index.md b/docs/awscc-docs/providers/awscc/apigateway/api_key/index.md deleted file mode 100644 index bd3440a8d3..0000000000 --- a/docs/awscc-docs/providers/awscc/apigateway/api_key/index.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -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
api_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. - -## Example -```sql -SELECT -region, -api_key_id, -customer_id, -description, -enabled, -generate_distinct_id, -name, -stage_keys, -tags, -value -FROM awscc.apigateway.api_key -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the api_key resource, the following permissions are required: - -### Read -```json -apigateway:GET -``` - -### Update -```json -apigateway:GET, -apigateway:PATCH, -apigateway:PUT, -apigateway:DELETE -``` - -### Delete -```json -apigateway:DELETE, -apigateway:GET -``` - diff --git a/docs/awscc-docs/providers/awscc/apigateway/api_keys/index.md b/docs/awscc-docs/providers/awscc/apigateway/api_keys/index.md deleted file mode 100644 index 2e202692ec..0000000000 --- a/docs/awscc-docs/providers/awscc/apigateway/api_keys/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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
api_key_idstring
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -api_key_id -FROM awscc.apigateway.api_keys -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the api_keys resource, the following permissions are required: - -### Create -```json -apigateway:POST, -apigateway:GET, -apigateway:PUT -``` - -### List -```json -apigateway:GET -``` - diff --git a/docs/awscc-docs/providers/awscc/apigateway/authorizer/index.md b/docs/awscc-docs/providers/awscc/apigateway/authorizer/index.md deleted file mode 100644 index 7cd26eb84c..0000000000 --- a/docs/awscc-docs/providers/awscc/apigateway/authorizer/index.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -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_arnsarrayA 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. - -## 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_arns, -type -FROM awscc.apigateway.authorizer -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the authorizer resource, the following permissions are required: - -### Read -```json -apigateway:GET -``` - -### Update -```json -apigateway:GET, -apigateway:PATCH, -iam:PassRole -``` - -### Delete -```json -apigateway:DELETE -``` - diff --git a/docs/awscc-docs/providers/awscc/apigateway/authorizers/index.md b/docs/awscc-docs/providers/awscc/apigateway/authorizers/index.md deleted file mode 100644 index 49417f20be..0000000000 --- a/docs/awscc-docs/providers/awscc/apigateway/authorizers/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -rest_api_id, -authorizer_id -FROM awscc.apigateway.authorizers -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the authorizers resource, the following permissions are required: - -### Create -```json -apigateway:POST, -iam:PassRole -``` - -### List -```json -apigateway:GET -``` - 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 deleted file mode 100644 index f8084a8861..0000000000 --- a/docs/awscc-docs/providers/awscc/apigateway/base_path_mapping/index.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -base_path, -domain_name, -rest_api_id, -stage -FROM awscc.apigateway.base_path_mapping -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the base_path_mapping resource, the following permissions are required: - -### Read -```json -apigateway:GET -``` - -### Update -```json -apigateway:GET, -apigateway:DELETE, -apigateway:PATCH -``` - -### Delete -```json -apigateway:DELETE -``` - 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 deleted file mode 100644 index bf1a2aa310..0000000000 --- a/docs/awscc-docs/providers/awscc/apigateway/base_path_mappings/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -domain_name, -base_path -FROM awscc.apigateway.base_path_mappings -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the base_path_mappings resource, the following permissions are required: - -### Create -```json -apigateway:POST, -apigateway:GET -``` - -### List -```json -apigateway:GET -``` - diff --git a/docs/awscc-docs/providers/awscc/apigateway/client_certificate/index.md b/docs/awscc-docs/providers/awscc/apigateway/client_certificate/index.md deleted file mode 100644 index c549b2e7c1..0000000000 --- a/docs/awscc-docs/providers/awscc/apigateway/client_certificate/index.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -client_certificate_id, -description, -tags -FROM awscc.apigateway.client_certificate -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the client_certificate resource, the following permissions are required: - -### Read -```json -apigateway:GET -``` - -### Update -```json -apigateway:GET, -apigateway:PATCH, -apigateway:PUT, -apigateway:DELETE -``` - -### Delete -```json -apigateway:DELETE -``` - diff --git a/docs/awscc-docs/providers/awscc/apigateway/client_certificates/index.md b/docs/awscc-docs/providers/awscc/apigateway/client_certificates/index.md deleted file mode 100644 index 8c5918e646..0000000000 --- a/docs/awscc-docs/providers/awscc/apigateway/client_certificates/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -client_certificate_id -FROM awscc.apigateway.client_certificates -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the client_certificates resource, the following permissions are required: - -### Create -```json -apigateway:POST, -apigateway:GET, -apigateway:PUT -``` - -### List -```json -apigateway:GET -``` - diff --git a/docs/awscc-docs/providers/awscc/apigateway/deployment/index.md b/docs/awscc-docs/providers/awscc/apigateway/deployment/index.md deleted file mode 100644 index 473f4950b3..0000000000 --- a/docs/awscc-docs/providers/awscc/apigateway/deployment/index.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -deployment_id, -deployment_canary_settings, -description, -rest_api_id, -stage_description, -stage_name -FROM awscc.apigateway.deployment -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the deployment resource, the following permissions are required: - -### Read -```json -apigateway:GET -``` - -### Update -```json -apigateway:PATCH, -apigateway:GET, -apigateway:PUT, -apigateway:DELETE -``` - -### Delete -```json -apigateway:GET, -apigateway:DELETE -``` - diff --git a/docs/awscc-docs/providers/awscc/apigateway/deployments/index.md b/docs/awscc-docs/providers/awscc/apigateway/deployments/index.md deleted file mode 100644 index 2c28c988f0..0000000000 --- a/docs/awscc-docs/providers/awscc/apigateway/deployments/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -deployment_id, -rest_api_id -FROM awscc.apigateway.deployments -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the deployments resource, the following permissions are required: - -### Create -```json -apigateway:POST, -apigateway:PATCH, -apigateway:PUT, -apigateway:GET -``` - -### List -```json -apigateway:GET -``` - diff --git a/docs/awscc-docs/providers/awscc/apigateway/documentation_part/index.md b/docs/awscc-docs/providers/awscc/apigateway/documentation_part/index.md deleted file mode 100644 index 074cd93fe7..0000000000 --- a/docs/awscc-docs/providers/awscc/apigateway/documentation_part/index.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -documentation_part_id, -location, -properties, -rest_api_id -FROM awscc.apigateway.documentation_part -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the documentation_part resource, the following permissions are required: - -### Read -```json -apigateway:GET -``` - -### Update -```json -apigateway:GET, -apigateway:PATCH -``` - -### Delete -```json -apigateway:DELETE -``` - diff --git a/docs/awscc-docs/providers/awscc/apigateway/documentation_parts/index.md b/docs/awscc-docs/providers/awscc/apigateway/documentation_parts/index.md deleted file mode 100644 index 06749bd12b..0000000000 --- a/docs/awscc-docs/providers/awscc/apigateway/documentation_parts/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -documentation_part_id, -rest_api_id -FROM awscc.apigateway.documentation_parts -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the documentation_parts resource, the following permissions are required: - -### Create -```json -apigateway:GET, -apigateway:POST -``` - -### List -```json -apigateway:GET -``` - diff --git a/docs/awscc-docs/providers/awscc/apigateway/documentation_version/index.md b/docs/awscc-docs/providers/awscc/apigateway/documentation_version/index.md deleted file mode 100644 index f56930b2de..0000000000 --- a/docs/awscc-docs/providers/awscc/apigateway/documentation_version/index.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -description, -documentation_version, -rest_api_id -FROM awscc.apigateway.documentation_version -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the documentation_version resource, the following permissions are required: - -### Read -```json -apigateway:GET -``` - -### Update -```json -apigateway:GET, -apigateway:PATCH -``` - -### Delete -```json -apigateway:DELETE -``` - diff --git a/docs/awscc-docs/providers/awscc/apigateway/documentation_versions/index.md b/docs/awscc-docs/providers/awscc/apigateway/documentation_versions/index.md deleted file mode 100644 index f3a2be07f1..0000000000 --- a/docs/awscc-docs/providers/awscc/apigateway/documentation_versions/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -documentation_version, -rest_api_id -FROM awscc.apigateway.documentation_versions -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the documentation_versions resource, the following permissions are required: - -### Create -```json -apigateway:GET, -apigateway:POST -``` - -### List -```json -apigateway:GET -``` - diff --git a/docs/awscc-docs/providers/awscc/apigateway/domain_name/index.md b/docs/awscc-docs/providers/awscc/apigateway/domain_name/index.md deleted file mode 100644 index f91d5e15be..0000000000 --- a/docs/awscc-docs/providers/awscc/apigateway/domain_name/index.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the domain_name resource, the following permissions are required: - -### Read -```json -apigateway:* -``` - -### Update -```json -apigateway:* -``` - -### Delete -```json -apigateway:* -``` - diff --git a/docs/awscc-docs/providers/awscc/apigateway/domain_names/index.md b/docs/awscc-docs/providers/awscc/apigateway/domain_names/index.md deleted file mode 100644 index 30e2e13241..0000000000 --- a/docs/awscc-docs/providers/awscc/apigateway/domain_names/index.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -domain_name -FROM awscc.apigateway.domain_names -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the domain_names resource, the following permissions are required: - -### Create -```json -apigateway:* -``` - -### List -```json -apigateway:* -``` - diff --git a/docs/awscc-docs/providers/awscc/apigateway/gateway_responses/index.md b/docs/awscc-docs/providers/awscc/apigateway/gateway_responses/index.md deleted file mode 100644 index df219e8626..0000000000 --- a/docs/awscc-docs/providers/awscc/apigateway/gateway_responses/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.apigateway.gateway_responses -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the gateway_responses resource, the following permissions are required: - -### Create -```json -apigateway:PUT, -apigateway:GET -``` - -### List -```json -apigateway:GET -``` - diff --git a/docs/awscc-docs/providers/awscc/apigateway/index.md b/docs/awscc-docs/providers/awscc/apigateway/index.md deleted file mode 100644 index 23a4338f40..0000000000 --- a/docs/awscc-docs/providers/awscc/apigateway/index.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -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: 35
-total selectable resources: 35
-total methods: 35
-
-
- -::: - -## Resources -
-
-account
-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_responses -
-
-method
-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 deleted file mode 100644 index 2d2eb1d73b..0000000000 --- a/docs/awscc-docs/providers/awscc/apigateway/method/index.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -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. - -## 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 data__Identifier = '||'; -``` - -## Permissions - -To operate on the method resource, the following permissions are required: - -### Read -```json -apigateway:GET -``` - -### Update -```json -apigateway:GET, -apigateway:DELETE, -apigateway:PUT, -iam:PassRole -``` - -### Delete -```json -apigateway:DELETE -``` - diff --git a/docs/awscc-docs/providers/awscc/apigateway/model/index.md b/docs/awscc-docs/providers/awscc/apigateway/model/index.md deleted file mode 100644 index e9bed8ec53..0000000000 --- a/docs/awscc-docs/providers/awscc/apigateway/model/index.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -content_type, -description, -name, -rest_api_id, -schema -FROM awscc.apigateway.model -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the model resource, the following permissions are required: - -### Read -```json -apigateway:GET -``` - -### Update -```json -apigateway:PATCH, -apigateway:GET -``` - -### Delete -```json -apigateway:GET, -apigateway:DELETE -``` - diff --git a/docs/awscc-docs/providers/awscc/apigateway/models/index.md b/docs/awscc-docs/providers/awscc/apigateway/models/index.md deleted file mode 100644 index 84150056ec..0000000000 --- a/docs/awscc-docs/providers/awscc/apigateway/models/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -rest_api_id, -name -FROM awscc.apigateway.models -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the models resource, the following permissions are required: - -### Create -```json -apigateway:POST, -apigateway:GET -``` - -### List -```json -apigateway:GET -``` - diff --git a/docs/awscc-docs/providers/awscc/apigateway/request_validator/index.md b/docs/awscc-docs/providers/awscc/apigateway/request_validator/index.md deleted file mode 100644 index 8b2986d458..0000000000 --- a/docs/awscc-docs/providers/awscc/apigateway/request_validator/index.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -request_validator_id, -name, -rest_api_id, -validate_request_body, -validate_request_parameters -FROM awscc.apigateway.request_validator -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the request_validator resource, the following permissions are required: - -### Update -```json -apigateway:PATCH, -apigateway:GET -``` - -### Delete -```json -apigateway:DELETE -``` - -### Read -```json -apigateway:GET -``` - diff --git a/docs/awscc-docs/providers/awscc/apigateway/request_validators/index.md b/docs/awscc-docs/providers/awscc/apigateway/request_validators/index.md deleted file mode 100644 index 97748381ae..0000000000 --- a/docs/awscc-docs/providers/awscc/apigateway/request_validators/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -rest_api_id, -request_validator_id -FROM awscc.apigateway.request_validators -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the request_validators resource, the following permissions are required: - -### Create -```json -apigateway:POST, -apigateway:GET -``` - -### List -```json -apigateway:GET -``` - diff --git a/docs/awscc-docs/providers/awscc/apigateway/resource/index.md b/docs/awscc-docs/providers/awscc/apigateway/resource/index.md deleted file mode 100644 index 04e1e2bb9c..0000000000 --- a/docs/awscc-docs/providers/awscc/apigateway/resource/index.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -resource_id, -rest_api_id, -parent_id, -path_part -FROM awscc.apigateway.resource -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the resource resource, the following permissions are required: - -### Read -```json -apigateway:GET -``` - -### Update -```json -apigateway:GET, -apigateway:PATCH -``` - -### Delete -```json -apigateway:DELETE -``` - diff --git a/docs/awscc-docs/providers/awscc/apigateway/resources/index.md b/docs/awscc-docs/providers/awscc/apigateway/resources/index.md deleted file mode 100644 index 1dcd7a8ece..0000000000 --- a/docs/awscc-docs/providers/awscc/apigateway/resources/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -rest_api_id, -resource_id -FROM awscc.apigateway.resources -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the resources resource, the following permissions are required: - -### Create -```json -apigateway:POST -``` - -### List -```json -apigateway:GET -``` - diff --git a/docs/awscc-docs/providers/awscc/apigateway/rest_api/index.md b/docs/awscc-docs/providers/awscc/apigateway/rest_api/index.md deleted file mode 100644 index 89e677bb8b..0000000000 --- a/docs/awscc-docs/providers/awscc/apigateway/rest_api/index.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the rest_api resource, the following permissions are required: - -### Read -```json -apigateway:GET -``` - -### Update -```json -apigateway:GET, -apigateway:DELETE, -apigateway:PATCH, -apigateway:PUT, -apigateway:UpdateRestApiPolicy, -s3:GetObject, -iam:PassRole -``` - -### Delete -```json -apigateway:DELETE -``` - diff --git a/docs/awscc-docs/providers/awscc/apigateway/rest_apis/index.md b/docs/awscc-docs/providers/awscc/apigateway/rest_apis/index.md deleted file mode 100644 index 86b2cc73a1..0000000000 --- a/docs/awscc-docs/providers/awscc/apigateway/rest_apis/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -rest_api_id -FROM awscc.apigateway.rest_apis -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the rest_apis resource, the following permissions are required: - -### Create -```json -apigateway:GET, -apigateway:POST, -apigateway:PUT, -apigateway:PATCH, -apigateway:UpdateRestApiPolicy, -s3:GetObject, -iam:PassRole -``` - -### List -```json -apigateway:GET -``` - diff --git a/docs/awscc-docs/providers/awscc/apigateway/stage/index.md b/docs/awscc-docs/providers/awscc/apigateway/stage/index.md deleted file mode 100644 index 1118da8e87..0000000000 --- a/docs/awscc-docs/providers/awscc/apigateway/stage/index.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the stage resource, the following permissions are required: - -### Read -```json -apigateway:GET -``` - -### Update -```json -apigateway:GET, -apigateway:PATCH, -apigateway:PUT, -apigateway:DELETE -``` - -### Delete -```json -apigateway:DELETE -``` - diff --git a/docs/awscc-docs/providers/awscc/apigateway/stages/index.md b/docs/awscc-docs/providers/awscc/apigateway/stages/index.md deleted file mode 100644 index 2f0a301c9f..0000000000 --- a/docs/awscc-docs/providers/awscc/apigateway/stages/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -rest_api_id, -stage_name -FROM awscc.apigateway.stages -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the stages resource, the following permissions are required: - -### Create -```json -apigateway:POST, -apigateway:PATCH, -apigateway:GET, -apigateway:PUT -``` - -### List -```json -apigateway:GET -``` - diff --git a/docs/awscc-docs/providers/awscc/apigateway/usage_plan/index.md b/docs/awscc-docs/providers/awscc/apigateway/usage_plan/index.md deleted file mode 100644 index f7254d9fe2..0000000000 --- a/docs/awscc-docs/providers/awscc/apigateway/usage_plan/index.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id, -api_stages, -description, -quota, -tags, -throttle, -usage_plan_name -FROM awscc.apigateway.usage_plan -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the usage_plan resource, the following permissions are required: - -### Read -```json -apigateway:GET -``` - -### Update -```json -apigateway:GET, -apigateway:DELETE, -apigateway:PATCH, -apigateway:PUT -``` - -### Delete -```json -apigateway:DELETE, -apigateway:GET, -apigateway:PATCH -``` - 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 deleted file mode 100644 index ca33805fd9..0000000000 --- a/docs/awscc-docs/providers/awscc/apigateway/usage_plan_key/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -key_id, -key_type, -usage_plan_id, -id -FROM awscc.apigateway.usage_plan_key -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the usage_plan_key resource, the following permissions are required: - -### Read -```json -apigateway:GET -``` - -### Delete -```json -apigateway:DELETE, -apigateway:GET -``` - 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 deleted file mode 100644 index f98960910c..0000000000 --- a/docs/awscc-docs/providers/awscc/apigateway/usage_plan_keys/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.apigateway.usage_plan_keys -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the usage_plan_keys resource, the following permissions are required: - -### Create -```json -apigateway:POST, -apigateway:GET -``` - -### List -```json -apigateway:GET -``` - diff --git a/docs/awscc-docs/providers/awscc/apigateway/usage_plans/index.md b/docs/awscc-docs/providers/awscc/apigateway/usage_plans/index.md deleted file mode 100644 index 8de87172dc..0000000000 --- a/docs/awscc-docs/providers/awscc/apigateway/usage_plans/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.apigateway.usage_plans -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the usage_plans resource, the following permissions are required: - -### Create -```json -apigateway:POST, -apigateway:GET, -apigateway:PUT -``` - -### List -```json -apigateway:GET -``` - diff --git a/docs/awscc-docs/providers/awscc/apigateway/vpc_link/index.md b/docs/awscc-docs/providers/awscc/apigateway/vpc_link/index.md deleted file mode 100644 index 625f4f8b7b..0000000000 --- a/docs/awscc-docs/providers/awscc/apigateway/vpc_link/index.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -description, -tags, -target_arns, -vpc_link_id -FROM awscc.apigateway.vpc_link -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the vpc_link resource, the following permissions are required: - -### Update -```json -apigateway:PATCH, -apigateway:GET, -apigateway:PUT, -ec2:CreateVpcEndpointServiceConfiguration, -ec2:DeleteVpcEndpointServiceConfigurations, -ec2:DescribeVpcEndpointServiceConfigurations, -ec2:ModifyVpcEndpointServicePermissions -``` - -### Read -```json -apigateway:GET, -ec2:CreateVpcEndpointServiceConfiguration, -ec2:DeleteVpcEndpointServiceConfigurations, -ec2:DescribeVpcEndpointServiceConfigurations, -ec2:ModifyVpcEndpointServicePermissions -``` - -### Delete -```json -apigateway:GET, -apigateway:DELETE, -apigateway:PUT, -ec2:CreateVpcEndpointServiceConfiguration, -ec2:DeleteVpcEndpointServiceConfigurations, -ec2:DescribeVpcEndpointServiceConfigurations, -ec2:ModifyVpcEndpointServicePermissions -``` - diff --git a/docs/awscc-docs/providers/awscc/apigateway/vpc_links/index.md b/docs/awscc-docs/providers/awscc/apigateway/vpc_links/index.md deleted file mode 100644 index a9e05bc569..0000000000 --- a/docs/awscc-docs/providers/awscc/apigateway/vpc_links/index.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -vpc_link_id -FROM awscc.apigateway.vpc_links -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the vpc_links resource, the following permissions are required: - -### Create -```json -apigateway:POST, -apigateway:PUT, -apigateway:GET, -ec2:CreateVpcEndpointServiceConfiguration, -ec2:DeleteVpcEndpointServiceConfigurations, -ec2:DescribeVpcEndpointServiceConfigurations, -ec2:ModifyVpcEndpointServicePermissions -``` - -### List -```json -apigateway:GET, -ec2:CreateVpcEndpointServiceConfiguration, -ec2:DeleteVpcEndpointServiceConfigurations, -ec2:DescribeVpcEndpointServiceConfigurations, -ec2:ModifyVpcEndpointServicePermissions -``` - diff --git a/docs/awscc-docs/providers/awscc/apigatewayv2/api/index.md b/docs/awscc-docs/providers/awscc/apigatewayv2/api/index.md deleted file mode 100644 index c9283c3f21..0000000000 --- a/docs/awscc-docs/providers/awscc/apigatewayv2/api/index.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the api resource, the following permissions are required: - -### Update -```json -apigateway:PATCH, -apigateway:GET, -apigateway:PUT, -apigateway:POST, -s3:getObject -``` - -### Read -```json -apigateway:GET, -s3:getObject -``` - -### Delete -```json -apigateway:GET, -apigateway:DELETE, -s3:getObject -``` - diff --git a/docs/awscc-docs/providers/awscc/apigatewayv2/api_mapping/index.md b/docs/awscc-docs/providers/awscc/apigatewayv2/api_mapping/index.md deleted file mode 100644 index e48d1777f9..0000000000 --- a/docs/awscc-docs/providers/awscc/apigatewayv2/api_mapping/index.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -api_mapping_id, -domain_name, -stage, -api_mapping_key, -api_id -FROM awscc.apigatewayv2.api_mapping -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the api_mapping resource, the following permissions are required: - -### Update -```json -apigateway:PATCH, -apigateway:GET, -apigateway:PUT -``` - -### Read -```json -apigateway:GET -``` - -### Delete -```json -apigateway:DELETE -``` - diff --git a/docs/awscc-docs/providers/awscc/apigatewayv2/api_mappings/index.md b/docs/awscc-docs/providers/awscc/apigatewayv2/api_mappings/index.md deleted file mode 100644 index d0acdef67c..0000000000 --- a/docs/awscc-docs/providers/awscc/apigatewayv2/api_mappings/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -api_mapping_id, -domain_name -FROM awscc.apigatewayv2.api_mappings -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the api_mappings resource, the following permissions are required: - -### Create -```json -apigateway:POST -``` - -### List -```json -apigateway:GET -``` - diff --git a/docs/awscc-docs/providers/awscc/apigatewayv2/apis/index.md b/docs/awscc-docs/providers/awscc/apigatewayv2/apis/index.md deleted file mode 100644 index a950a2498c..0000000000 --- a/docs/awscc-docs/providers/awscc/apigatewayv2/apis/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -api_id -FROM awscc.apigatewayv2.apis -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the apis resource, the following permissions are required: - -### Create -```json -apigateway:POST, -apigateway:PUT, -s3:getObject -``` - -### List -```json -apigateway:GET, -s3:getObject -``` - diff --git a/docs/awscc-docs/providers/awscc/apigatewayv2/authorizer/index.md b/docs/awscc-docs/providers/awscc/apigatewayv2/authorizer/index.md deleted file mode 100644 index 4f5b8f8c1f..0000000000 --- a/docs/awscc-docs/providers/awscc/apigatewayv2/authorizer/index.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the authorizer resource, the following permissions are required: - -### Update -```json -apigateway:PATCH, -apigateway:GET, -apigateway:PUT, -iam:PassRole -``` - -### Read -```json -apigateway:GET -``` - -### Delete -```json -apigateway:GET, -apigateway:DELETE -``` - diff --git a/docs/awscc-docs/providers/awscc/apigatewayv2/authorizers/index.md b/docs/awscc-docs/providers/awscc/apigatewayv2/authorizers/index.md deleted file mode 100644 index 6123733652..0000000000 --- a/docs/awscc-docs/providers/awscc/apigatewayv2/authorizers/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -authorizer_id, -api_id -FROM awscc.apigatewayv2.authorizers -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the authorizers resource, the following permissions are required: - -### Create -```json -apigateway:POST, -iam:PassRole -``` - -### List -```json -apigateway:GET -``` - diff --git a/docs/awscc-docs/providers/awscc/apigatewayv2/deployment/index.md b/docs/awscc-docs/providers/awscc/apigatewayv2/deployment/index.md deleted file mode 100644 index dfd03fb290..0000000000 --- a/docs/awscc-docs/providers/awscc/apigatewayv2/deployment/index.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -deployment_id, -description, -stage_name, -api_id -FROM awscc.apigatewayv2.deployment -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the deployment resource, the following permissions are required: - -### Update -```json -apigateway:PATCH, -apigateway:GET, -apigateway:PUT -``` - -### Read -```json -apigateway:GET -``` - -### Delete -```json -apigateway:GET, -apigateway:DELETE -``` - diff --git a/docs/awscc-docs/providers/awscc/apigatewayv2/deployments/index.md b/docs/awscc-docs/providers/awscc/apigatewayv2/deployments/index.md deleted file mode 100644 index 5b0a31c7fd..0000000000 --- a/docs/awscc-docs/providers/awscc/apigatewayv2/deployments/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -api_id, -deployment_id -FROM awscc.apigatewayv2.deployments -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the deployments resource, the following permissions are required: - -### Create -```json -apigateway:POST -``` - -### List -```json -apigateway:GET -``` - diff --git a/docs/awscc-docs/providers/awscc/apigatewayv2/domain_name/index.md b/docs/awscc-docs/providers/awscc/apigatewayv2/domain_name/index.md deleted file mode 100644 index 5e1a8d8eec..0000000000 --- a/docs/awscc-docs/providers/awscc/apigatewayv2/domain_name/index.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the domain_name resource, the following permissions are required: - -### Update -```json -apigateway:PATCH, -apigateway:GET, -apigateway:PUT -``` - -### Read -```json -apigateway:GET -``` - -### Delete -```json -apigateway:GET, -apigateway:DELETE -``` - diff --git a/docs/awscc-docs/providers/awscc/apigatewayv2/domain_names/index.md b/docs/awscc-docs/providers/awscc/apigatewayv2/domain_names/index.md deleted file mode 100644 index db017e4137..0000000000 --- a/docs/awscc-docs/providers/awscc/apigatewayv2/domain_names/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -domain_name -FROM awscc.apigatewayv2.domain_names -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the domain_names resource, the following permissions are required: - -### Create -```json -apigateway:POST, -apigateway:GET, -apigateway:PUT -``` - -### List -```json -apigateway:GET -``` - diff --git a/docs/awscc-docs/providers/awscc/apigatewayv2/index.md b/docs/awscc-docs/providers/awscc/apigatewayv2/index.md deleted file mode 100644 index 56a49f1537..0000000000 --- a/docs/awscc-docs/providers/awscc/apigatewayv2/index.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -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 deleted file mode 100644 index 7fb465f1f3..0000000000 --- a/docs/awscc-docs/providers/awscc/apigatewayv2/integration_response/index.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -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. - -## 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 data__Identifier = '||'; -``` - -## Permissions - -To operate on the integration_response resource, the following permissions are required: - -### Read -```json -apigateway:GET -``` - -### Update -```json -apigateway:PATCH, -apigateway:PUT, -apigateway:GET -``` - -### Delete -```json -apigateway:GET, -apigateway:DELETE -``` - diff --git a/docs/awscc-docs/providers/awscc/apigatewayv2/integration_responses/index.md b/docs/awscc-docs/providers/awscc/apigatewayv2/integration_responses/index.md deleted file mode 100644 index 34d55d1959..0000000000 --- a/docs/awscc-docs/providers/awscc/apigatewayv2/integration_responses/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -api_id, -integration_id, -integration_response_id -FROM awscc.apigatewayv2.integration_responses -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the integration_responses resource, the following permissions are required: - -### Create -```json -apigateway:POST -``` - -### List -```json -apigateway:GET -``` - diff --git a/docs/awscc-docs/providers/awscc/apigatewayv2/model/index.md b/docs/awscc-docs/providers/awscc/apigatewayv2/model/index.md deleted file mode 100644 index 9fcbee507a..0000000000 --- a/docs/awscc-docs/providers/awscc/apigatewayv2/model/index.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -model_id, -description, -content_type, -schema, -api_id, -name -FROM awscc.apigatewayv2.model -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the model resource, the following permissions are required: - -### Update -```json -apigateway:PATCH, -apigateway:GET, -apigateway:PUT -``` - -### Read -```json -apigateway:GET -``` - -### Delete -```json -apigateway:GET, -apigateway:DELETE -``` - diff --git a/docs/awscc-docs/providers/awscc/apigatewayv2/models/index.md b/docs/awscc-docs/providers/awscc/apigatewayv2/models/index.md deleted file mode 100644 index f8540c4aba..0000000000 --- a/docs/awscc-docs/providers/awscc/apigatewayv2/models/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -api_id, -model_id -FROM awscc.apigatewayv2.models -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the models resource, the following permissions are required: - -### Create -```json -apigateway:POST -``` - -### List -```json -apigateway:GET -``` - diff --git a/docs/awscc-docs/providers/awscc/apigatewayv2/route/index.md b/docs/awscc-docs/providers/awscc/apigatewayv2/route/index.md deleted file mode 100644 index f5bd51b6fb..0000000000 --- a/docs/awscc-docs/providers/awscc/apigatewayv2/route/index.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the route resource, the following permissions are required: - -### Update -```json -apigateway:PATCH, -apigateway:GET, -apigateway:PUT -``` - -### Read -```json -apigateway:GET -``` - -### Delete -```json -apigateway:GET, -apigateway:DELETE -``` - diff --git a/docs/awscc-docs/providers/awscc/apigatewayv2/route_response/index.md b/docs/awscc-docs/providers/awscc/apigatewayv2/route_response/index.md deleted file mode 100644 index 92e9bfdfde..0000000000 --- a/docs/awscc-docs/providers/awscc/apigatewayv2/route_response/index.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -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. - -## 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 data__Identifier = '||'; -``` - -## Permissions - -To operate on the route_response resource, the following permissions are required: - -### Update -```json -apigateway:PATCH, -apigateway:GET, -apigateway:PUT -``` - -### Read -```json -apigateway:GET -``` - -### Delete -```json -apigateway:GET, -apigateway:DELETE -``` - diff --git a/docs/awscc-docs/providers/awscc/apigatewayv2/route_responses/index.md b/docs/awscc-docs/providers/awscc/apigatewayv2/route_responses/index.md deleted file mode 100644 index fd802f2cd6..0000000000 --- a/docs/awscc-docs/providers/awscc/apigatewayv2/route_responses/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -api_id, -route_id, -route_response_id -FROM awscc.apigatewayv2.route_responses -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the route_responses resource, the following permissions are required: - -### Create -```json -apigateway:POST -``` - -### List -```json -apigateway:GET -``` - diff --git a/docs/awscc-docs/providers/awscc/apigatewayv2/routes/index.md b/docs/awscc-docs/providers/awscc/apigatewayv2/routes/index.md deleted file mode 100644 index b7480a2abd..0000000000 --- a/docs/awscc-docs/providers/awscc/apigatewayv2/routes/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -api_id, -route_id -FROM awscc.apigatewayv2.routes -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the routes resource, the following permissions are required: - -### Create -```json -apigateway:POST -``` - -### List -```json -apigateway:GET -``` - diff --git a/docs/awscc-docs/providers/awscc/apigatewayv2/vpc_link/index.md b/docs/awscc-docs/providers/awscc/apigatewayv2/vpc_link/index.md deleted file mode 100644 index 217430ba70..0000000000 --- a/docs/awscc-docs/providers/awscc/apigatewayv2/vpc_link/index.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -vpc_link_id, -subnet_ids, -security_group_ids, -tags, -name -FROM awscc.apigatewayv2.vpc_link -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the vpc_link resource, the following permissions are required: - -### Update -```json -apigateway:PATCH, -apigateway:GET, -apigateway:TagResource, -apigateway:unTagResource, -iam:CreateServiceLinkedRole, -iam:DeleteServiceLinkedRole, -iam:GetServiceLinkedRoleDeletionStatus -``` - -### Read -```json -apigateway:GET, -iam:CreateServiceLinkedRole, -iam:DeleteServiceLinkedRole, -iam:GetServiceLinkedRoleDeletionStatus -``` - -### Delete -```json -apigateway:GET, -apigateway:DELETE, -iam:CreateServiceLinkedRole, -iam:DeleteServiceLinkedRole, -iam:GetServiceLinkedRoleDeletionStatus -``` - diff --git a/docs/awscc-docs/providers/awscc/apigatewayv2/vpc_links/index.md b/docs/awscc-docs/providers/awscc/apigatewayv2/vpc_links/index.md deleted file mode 100644 index c61c65bfeb..0000000000 --- a/docs/awscc-docs/providers/awscc/apigatewayv2/vpc_links/index.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -vpc_link_id -FROM awscc.apigatewayv2.vpc_links -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the vpc_links resource, the following permissions are required: - -### Create -```json -apigateway:POST, -apigateway:GET, -apigateway:TagResource, -iam:CreateServiceLinkedRole, -iam:DeleteServiceLinkedRole, -iam:GetServiceLinkedRoleDeletionStatus -``` - -### List -```json -apigateway:GET, -iam:CreateServiceLinkedRole, -iam:DeleteServiceLinkedRole, -iam:GetServiceLinkedRoleDeletionStatus -``` - diff --git a/docs/awscc-docs/providers/awscc/appconfig/application/index.md b/docs/awscc-docs/providers/awscc/appconfig/application/index.md deleted file mode 100644 index 1a33a2c98e..0000000000 --- a/docs/awscc-docs/providers/awscc/appconfig/application/index.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -description, -application_id, -tags, -name -FROM awscc.appconfig.application -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the application resource, the following permissions are required: - -### Read -```json -appconfig:GetApplication, -appconfig:ListTagsForResource -``` - -### Update -```json -appconfig:UpdateApplication, -appconfig:TagResource, -appconfig:UntagResource -``` - -### Delete -```json -appconfig:GetApplication, -appconfig:DeleteApplication -``` - diff --git a/docs/awscc-docs/providers/awscc/appconfig/applications/index.md b/docs/awscc-docs/providers/awscc/appconfig/applications/index.md deleted file mode 100644 index ef2ba3feb5..0000000000 --- a/docs/awscc-docs/providers/awscc/appconfig/applications/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -application_id -FROM awscc.appconfig.applications -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the applications resource, the following permissions are required: - -### Create -```json -appconfig:CreateApplication, -appconfig:GetApplication, -appconfig:ListTagsForResource, -appconfig:TagResource -``` - -### List -```json -appconfig:ListApplications -``` - diff --git a/docs/awscc-docs/providers/awscc/appconfig/configuration_profile/index.md b/docs/awscc-docs/providers/awscc/appconfig/configuration_profile/index.md deleted file mode 100644 index 1f6b680af9..0000000000 --- a/docs/awscc-docs/providers/awscc/appconfig/configuration_profile/index.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the configuration_profile resource, the following permissions are required: - -### Read -```json -appconfig:GetConfigurationProfile, -appconfig:ListTagsForResource -``` - -### Update -```json -appconfig:UpdateConfigurationProfile, -appconfig:TagResource, -appconfig:UntagResource, -iam:PassRole -``` - -### Delete -```json -appconfig:DeleteConfigurationProfile -``` - diff --git a/docs/awscc-docs/providers/awscc/appconfig/configuration_profiles/index.md b/docs/awscc-docs/providers/awscc/appconfig/configuration_profiles/index.md deleted file mode 100644 index 417ca5a56e..0000000000 --- a/docs/awscc-docs/providers/awscc/appconfig/configuration_profiles/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -application_id, -configuration_profile_id -FROM awscc.appconfig.configuration_profiles -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the configuration_profiles resource, the following permissions are required: - -### Create -```json -appconfig:CreateConfigurationProfile, -appconfig:GetConfigurationProfile, -appconfig:TagResource, -appconfig:ListTagsForResource, -iam:PassRole -``` - -### List -```json -appconfig:ListConfigurationProfiles -``` - diff --git a/docs/awscc-docs/providers/awscc/appconfig/environment/index.md b/docs/awscc-docs/providers/awscc/appconfig/environment/index.md deleted file mode 100644 index 9aae298b6d..0000000000 --- a/docs/awscc-docs/providers/awscc/appconfig/environment/index.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -environment_id, -application_id, -name, -description, -monitors, -tags -FROM awscc.appconfig.environment -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the environment resource, the following permissions are required: - -### Read -```json -appconfig:GetEnvironment, -appconfig:ListTagsForResource -``` - -### Update -```json -appconfig:UpdateEnvironment, -appconfig:TagResource, -appconfig:UntagResource, -iam:PassRole -``` - -### Delete -```json -appconfig:GetEnvironment, -appconfig:DeleteEnvironment -``` - diff --git a/docs/awscc-docs/providers/awscc/appconfig/environments/index.md b/docs/awscc-docs/providers/awscc/appconfig/environments/index.md deleted file mode 100644 index 2001cb9c15..0000000000 --- a/docs/awscc-docs/providers/awscc/appconfig/environments/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -application_id, -environment_id -FROM awscc.appconfig.environments -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the environments resource, the following permissions are required: - -### Create -```json -appconfig:CreateEnvironment, -appconfig:GetEnvironment, -appconfig:ListTagsForResource, -appconfig:TagResource, -iam:PassRole -``` - -### List -```json -appconfig:ListEnvironments -``` - diff --git a/docs/awscc-docs/providers/awscc/appconfig/extension/index.md b/docs/awscc-docs/providers/awscc/appconfig/extension/index.md deleted file mode 100644 index bed834a796..0000000000 --- a/docs/awscc-docs/providers/awscc/appconfig/extension/index.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id, -arn, -version_number, -name, -description, -actions, -parameters, -latest_version_number, -tags -FROM awscc.appconfig.extension -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the extension resource, the following permissions are required: - -### Read -```json -appconfig:GetExtension -``` - -### Update -```json -appconfig:UpdateExtension, -appconfig:TagResource, -appconfig:UntagResource -``` - -### Delete -```json -appconfig:DeleteExtension, -appconfig:UntagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/appconfig/extension_association/index.md b/docs/awscc-docs/providers/awscc/appconfig/extension_association/index.md deleted file mode 100644 index 87e8299cae..0000000000 --- a/docs/awscc-docs/providers/awscc/appconfig/extension_association/index.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the extension_association resource, the following permissions are required: - -### Read -```json -appconfig:GetExtensionAssociation -``` - -### Update -```json -appconfig:UpdateExtensionAssociation, -appconfig:TagResource, -appconfig:UntagResource -``` - -### Delete -```json -appconfig:DeleteExtensionAssociation, -appconfig:UntagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/appconfig/extension_associations/index.md b/docs/awscc-docs/providers/awscc/appconfig/extension_associations/index.md deleted file mode 100644 index c203805650..0000000000 --- a/docs/awscc-docs/providers/awscc/appconfig/extension_associations/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.appconfig.extension_associations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the extension_associations resource, the following permissions are required: - -### Create -```json -appconfig:CreateExtensionAssociation, -appconfig:TagResource -``` - -### List -```json -appconfig:ListExtensionAssociations -``` - diff --git a/docs/awscc-docs/providers/awscc/appconfig/extensions/index.md b/docs/awscc-docs/providers/awscc/appconfig/extensions/index.md deleted file mode 100644 index a676d6eee9..0000000000 --- a/docs/awscc-docs/providers/awscc/appconfig/extensions/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.appconfig.extensions -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the extensions resource, the following permissions are required: - -### Create -```json -appconfig:CreateExtension, -appconfig:TagResource, -iam:PassRole -``` - -### List -```json -appconfig:ListExtensions -``` - 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 deleted file mode 100644 index b317e8f4bf..0000000000 --- a/docs/awscc-docs/providers/awscc/appconfig/hosted_configuration_version/index.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -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. - -## 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 data__Identifier = '||'; -``` - -## Permissions - -To operate on the hosted_configuration_version resource, the following permissions are required: - -### Read -```json -appconfig:GetHostedConfigurationVersion -``` - -### Delete -```json -appconfig:DeleteHostedConfigurationVersion -``` - 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 deleted file mode 100644 index ca9e3e7e5e..0000000000 --- a/docs/awscc-docs/providers/awscc/appconfig/hosted_configuration_versions/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -application_id, -configuration_profile_id, -version_number -FROM awscc.appconfig.hosted_configuration_versions -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the hosted_configuration_versions resource, the following permissions are required: - -### Create -```json -appconfig:CreateHostedConfigurationVersion -``` - -### List -```json -appconfig:ListHostedConfigurationVersions -``` - diff --git a/docs/awscc-docs/providers/awscc/appconfig/index.md b/docs/awscc-docs/providers/awscc/appconfig/index.md deleted file mode 100644 index fbb72f8d68..0000000000 --- a/docs/awscc-docs/providers/awscc/appconfig/index.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -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 deleted file mode 100644 index 7ea067443b..0000000000 --- a/docs/awscc-docs/providers/awscc/appflow/connector/index.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -connector_label, -connector_arn, -connector_provisioning_type, -connector_provisioning_config, -description -FROM awscc.appflow.connector -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the connector resource, the following permissions are required: - -### Read -```json -appflow:DescribeConnector -``` - -### Delete -```json -appflow:UnRegisterConnector -``` - -### Update -```json -appflow:UpdateConnectorRegistration, -lambda:InvokeFunction -``` - diff --git a/docs/awscc-docs/providers/awscc/appflow/connector_profile/index.md b/docs/awscc-docs/providers/awscc/appflow/connector_profile/index.md deleted file mode 100644 index a59aba4860..0000000000 --- a/docs/awscc-docs/providers/awscc/appflow/connector_profile/index.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -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.
kms_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. - -## Example -```sql -SELECT -region, -connector_profile_arn, -connector_label, -connector_profile_name, -kms_arn, -connector_type, -connection_mode, -connector_profile_config, -credentials_arn -FROM awscc.appflow.connector_profile -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the connector_profile resource, the following permissions are required: - -### Delete -```json -appflow:DeleteConnectorProfile -``` - -### Read -```json -appflow:DescribeConnectorProfiles -``` - -### Update -```json -appflow:UpdateConnectorProfile, -kms:ListKeys, -kms:DescribeKey, -kms:ListAliases, -kms:CreateGrant, -kms:ListGrants, -iam:PassRole, -secretsmanager:CreateSecret, -secretsmanager:GetSecretValue, -secretsmanager:PutResourcePolicy -``` - diff --git a/docs/awscc-docs/providers/awscc/appflow/connector_profiles/index.md b/docs/awscc-docs/providers/awscc/appflow/connector_profiles/index.md deleted file mode 100644 index 06719420b0..0000000000 --- a/docs/awscc-docs/providers/awscc/appflow/connector_profiles/index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -connector_profile_name -FROM awscc.appflow.connector_profiles -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the connector_profiles resource, the following permissions are required: - -### Create -```json -appflow:CreateConnectorProfile, -kms:ListKeys, -kms:DescribeKey, -kms:ListAliases, -kms:CreateGrant, -kms:ListGrants, -iam:PassRole, -secretsmanager:CreateSecret, -secretsmanager:GetSecretValue, -secretsmanager:PutResourcePolicy -``` - -### List -```json -appflow:DescribeConnectorProfiles -``` - diff --git a/docs/awscc-docs/providers/awscc/appflow/connectors/index.md b/docs/awscc-docs/providers/awscc/appflow/connectors/index.md deleted file mode 100644 index 52772bc440..0000000000 --- a/docs/awscc-docs/providers/awscc/appflow/connectors/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -connector_label -FROM awscc.appflow.connectors -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the connectors resource, the following permissions are required: - -### Create -```json -appflow:RegisterConnector, -lambda:InvokeFunction -``` - -### List -```json -appflow:ListConnectors -``` - diff --git a/docs/awscc-docs/providers/awscc/appflow/flow/index.md b/docs/awscc-docs/providers/awscc/appflow/flow/index.md deleted file mode 100644 index 380ab8df0a..0000000000 --- a/docs/awscc-docs/providers/awscc/appflow/flow/index.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -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.
kms_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. - -## Example -```sql -SELECT -region, -flow_arn, -flow_name, -description, -kms_arn, -trigger_config, -flow_status, -source_flow_config, -destination_flow_config_list, -tasks, -tags, -metadata_catalog_config -FROM awscc.appflow.flow -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the flow resource, the following permissions are required: - -### Read -```json -appflow:DescribeFlow, -appflow:ListTagsForResource -``` - -### Update -```json -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 -```json -appflow:DeleteFlow -``` - diff --git a/docs/awscc-docs/providers/awscc/appflow/flows/index.md b/docs/awscc-docs/providers/awscc/appflow/flows/index.md deleted file mode 100644 index 95e64c4279..0000000000 --- a/docs/awscc-docs/providers/awscc/appflow/flows/index.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -flow_name -FROM awscc.appflow.flows -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the flows resource, the following permissions are required: - -### Create -```json -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 -```json -appflow:ListFlows -``` - diff --git a/docs/awscc-docs/providers/awscc/appflow/index.md b/docs/awscc-docs/providers/awscc/appflow/index.md deleted file mode 100644 index bc7b9af8be..0000000000 --- a/docs/awscc-docs/providers/awscc/appflow/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -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 deleted file mode 100644 index 77ab8fc544..0000000000 --- a/docs/awscc-docs/providers/awscc/appintegrations/data_integration/index.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -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_uristringThe 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. - -## Example -```sql -SELECT -region, -description, -id, -data_integration_arn, -name, -kms_key, -schedule_config, -source_uri, -tags, -file_configuration, -object_configuration -FROM awscc.appintegrations.data_integration -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the data_integration resource, the following permissions are required: - -### Read -```json -app-integrations:GetDataIntegration, -app-integrations:ListTagsForResource -``` - -### Update -```json -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 -```json -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 -``` - diff --git a/docs/awscc-docs/providers/awscc/appintegrations/data_integrations/index.md b/docs/awscc-docs/providers/awscc/appintegrations/data_integrations/index.md deleted file mode 100644 index 0b528263fd..0000000000 --- a/docs/awscc-docs/providers/awscc/appintegrations/data_integrations/index.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.appintegrations.data_integrations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the data_integrations resource, the following permissions are required: - -### Create -```json -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 -```json -app-integrations:ListDataIntegrations -``` - diff --git a/docs/awscc-docs/providers/awscc/appintegrations/event_integration/index.md b/docs/awscc-docs/providers/awscc/appintegrations/event_integration/index.md deleted file mode 100644 index a8fddd4b06..0000000000 --- a/docs/awscc-docs/providers/awscc/appintegrations/event_integration/index.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -description, -event_integration_arn, -name, -event_bridge_bus, -event_filter, -tags -FROM awscc.appintegrations.event_integration -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the event_integration resource, the following permissions are required: - -### Read -```json -app-integrations:GetEventIntegration, -app-integrations:ListTagsForResource -``` - -### Update -```json -app-integrations:GetEventIntegration, -app-integrations:UpdateEventIntegration, -app-integrations:TagResource, -app-integrations:UntagResource -``` - -### Delete -```json -app-integrations:DeleteEventIntegration -``` - diff --git a/docs/awscc-docs/providers/awscc/appintegrations/event_integrations/index.md b/docs/awscc-docs/providers/awscc/appintegrations/event_integrations/index.md deleted file mode 100644 index 53c9e742c5..0000000000 --- a/docs/awscc-docs/providers/awscc/appintegrations/event_integrations/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.appintegrations.event_integrations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the event_integrations resource, the following permissions are required: - -### Create -```json -app-integrations:CreateEventIntegration, -app-integrations:TagResource -``` - -### List -```json -app-integrations:ListEventIntegrations -``` - diff --git a/docs/awscc-docs/providers/awscc/appintegrations/index.md b/docs/awscc-docs/providers/awscc/appintegrations/index.md deleted file mode 100644 index 01197d8d5a..0000000000 --- a/docs/awscc-docs/providers/awscc/appintegrations/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index 669f6e4837..0000000000 --- a/docs/awscc-docs/providers/awscc/applicationautoscaling/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index 4144d696de..0000000000 --- a/docs/awscc-docs/providers/awscc/applicationautoscaling/scalable_target/index.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -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_arnstringSpecify 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. - -## Example -```sql -SELECT -region, -id, -max_capacity, -min_capacity, -resource_id, -role_arn, -scalable_dimension, -scheduled_actions, -service_namespace, -suspended_state -FROM awscc.applicationautoscaling.scalable_target -WHERE data__Identifier = '||'; -``` - -## Permissions - -To operate on the scalable_target resource, the following permissions are required: - -### Read -```json -application-autoscaling:DescribeScalableTargets, -application-autoscaling:DescribeScheduledActions -``` - -### Update -```json -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 -```json -application-autoscaling:DeregisterScalableTarget -``` - diff --git a/docs/awscc-docs/providers/awscc/applicationautoscaling/scalable_targets/index.md b/docs/awscc-docs/providers/awscc/applicationautoscaling/scalable_targets/index.md deleted file mode 100644 index b17652423d..0000000000 --- a/docs/awscc-docs/providers/awscc/applicationautoscaling/scalable_targets/index.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -resource_id, -scalable_dimension, -service_namespace -FROM awscc.applicationautoscaling.scalable_targets -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the scalable_targets resource, the following permissions are required: - -### Create -```json -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 -```json -application-autoscaling:DescribeScalableTargets -``` - diff --git a/docs/awscc-docs/providers/awscc/applicationautoscaling/scaling_policies/index.md b/docs/awscc-docs/providers/awscc/applicationautoscaling/scaling_policies/index.md deleted file mode 100644 index f03ab9fc35..0000000000 --- a/docs/awscc-docs/providers/awscc/applicationautoscaling/scaling_policies/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -scalable_dimension -FROM awscc.applicationautoscaling.scaling_policies -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the scaling_policies resource, the following permissions are required: - -### Create -```json -application-autoscaling:DescribeScalingPolicies, -application-autoscaling:PutScalingPolicy -``` - -### List -```json -application-autoscaling:DescribeScalingPolicies -``` - diff --git a/docs/awscc-docs/providers/awscc/applicationautoscaling/scaling_policy/index.md b/docs/awscc-docs/providers/awscc/applicationautoscaling/scaling_policy/index.md deleted file mode 100644 index a5bf673a28..0000000000 --- a/docs/awscc-docs/providers/awscc/applicationautoscaling/scaling_policy/index.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the scaling_policy resource, the following permissions are required: - -### Read -```json -application-autoscaling:DescribeScalingPolicies -``` - -### Update -```json -application-autoscaling:DescribeScalingPolicies, -application-autoscaling:PutScalingPolicy -``` - -### Delete -```json -application-autoscaling:DescribeScalingPolicies, -application-autoscaling:DeleteScalingPolicy -``` - diff --git a/docs/awscc-docs/providers/awscc/applicationinsights/application/index.md b/docs/awscc-docs/providers/awscc/applicationinsights/application/index.md deleted file mode 100644 index 5de631936a..0000000000 --- a/docs/awscc-docs/providers/awscc/applicationinsights/application/index.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -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_arnstringThe ARN of the ApplicationInsights application.
cwe_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_sns_topic_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. - -## Example -```sql -SELECT -region, -resource_group_name, -application_arn, -cwe_monitor_enabled, -ops_center_enabled, -ops_item_sns_topic_arn, -tags, -custom_components, -log_pattern_sets, -auto_configuration_enabled, -component_monitoring_settings, -grouping_type -FROM awscc.applicationinsights.application -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the application resource, the following permissions are required: - -### Read -```json -* -``` - -### Update -```json -* -``` - -### Delete -```json -* -``` - diff --git a/docs/awscc-docs/providers/awscc/applicationinsights/applications/index.md b/docs/awscc-docs/providers/awscc/applicationinsights/applications/index.md deleted file mode 100644 index 05d54ba81f..0000000000 --- a/docs/awscc-docs/providers/awscc/applicationinsights/applications/index.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -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_arnstringThe ARN of the ApplicationInsights application.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -application_arn -FROM awscc.applicationinsights.applications -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the applications resource, the following permissions are required: - -### Create -```json -* -``` - -### List -```json -* -``` - diff --git a/docs/awscc-docs/providers/awscc/applicationinsights/index.md b/docs/awscc-docs/providers/awscc/applicationinsights/index.md deleted file mode 100644 index e9ec883106..0000000000 --- a/docs/awscc-docs/providers/awscc/applicationinsights/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 deleted file mode 100644 index 2555ef5aa6..0000000000 --- a/docs/awscc-docs/providers/awscc/apprunner/auto_scaling_configuration/index.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the auto_scaling_configuration resource, the following permissions are required: - -### Read -```json -apprunner:DescribeAutoScalingConfiguration -``` - -### Delete -```json -apprunner:DeleteAutoScalingConfiguration -``` - 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 deleted file mode 100644 index 8b7980d3e5..0000000000 --- a/docs/awscc-docs/providers/awscc/apprunner/auto_scaling_configurations/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -auto_scaling_configuration_arn -FROM awscc.apprunner.auto_scaling_configurations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the auto_scaling_configurations resource, the following permissions are required: - -### Create -```json -apprunner:CreateAutoScalingConfiguration, -apprunner:DescribeAutoScalingConfiguration, -apprunner:TagResource -``` - -### List -```json -apprunner:ListAutoScalingConfiguration -``` - diff --git a/docs/awscc-docs/providers/awscc/apprunner/index.md b/docs/awscc-docs/providers/awscc/apprunner/index.md deleted file mode 100644 index 852d158ac2..0000000000 --- a/docs/awscc-docs/providers/awscc/apprunner/index.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -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 deleted file mode 100644 index ce770a768b..0000000000 --- a/docs/awscc-docs/providers/awscc/apprunner/observability_configuration/index.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -observability_configuration_arn, -observability_configuration_name, -observability_configuration_revision, -latest, -trace_configuration, -tags -FROM awscc.apprunner.observability_configuration -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the observability_configuration resource, the following permissions are required: - -### Read -```json -apprunner:DescribeObservabilityConfiguration -``` - -### Delete -```json -apprunner:DeleteObservabilityConfiguration -``` - diff --git a/docs/awscc-docs/providers/awscc/apprunner/observability_configurations/index.md b/docs/awscc-docs/providers/awscc/apprunner/observability_configurations/index.md deleted file mode 100644 index 234ac4b938..0000000000 --- a/docs/awscc-docs/providers/awscc/apprunner/observability_configurations/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -observability_configuration_arn -FROM awscc.apprunner.observability_configurations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the observability_configurations resource, the following permissions are required: - -### Create -```json -apprunner:CreateObservabilityConfiguration, -apprunner:DescribeObservabilityConfiguration, -apprunner:TagResource -``` - -### List -```json -apprunner:ListObservabilityConfigurations -``` - diff --git a/docs/awscc-docs/providers/awscc/apprunner/service/index.md b/docs/awscc-docs/providers/awscc/apprunner/service/index.md deleted file mode 100644 index cf966559ed..0000000000 --- a/docs/awscc-docs/providers/awscc/apprunner/service/index.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the service resource, the following permissions are required: - -### Read -```json -apprunner:DescribeService -``` - -### Update -```json -apprunner:UpdateService, -iam:PassRole -``` - -### Delete -```json -apprunner:DeleteService -``` - diff --git a/docs/awscc-docs/providers/awscc/apprunner/services/index.md b/docs/awscc-docs/providers/awscc/apprunner/services/index.md deleted file mode 100644 index a0aa3fd217..0000000000 --- a/docs/awscc-docs/providers/awscc/apprunner/services/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -service_arn -FROM awscc.apprunner.services -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the services resource, the following permissions are required: - -### Create -```json -apprunner:CreateService, -apprunner:TagResource, -iam:PassRole, -iam:CreateServiceLinkedRole, -logs:CreateLogGroup, -logs:PutRetentionPolicy, -logs:CreateLogStream, -logs:PutLogEvents, -logs:DescribeLogStreams, -events:PutRule, -events:PutTargets -``` - -### List -```json -apprunner:ListServices, -iam:PassRole -``` - diff --git a/docs/awscc-docs/providers/awscc/apprunner/vpc_connector/index.md b/docs/awscc-docs/providers/awscc/apprunner/vpc_connector/index.md deleted file mode 100644 index ddde8a1971..0000000000 --- a/docs/awscc-docs/providers/awscc/apprunner/vpc_connector/index.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -vpc_connector_name, -vpc_connector_arn, -vpc_connector_revision, -subnets, -security_groups, -tags -FROM awscc.apprunner.vpc_connector -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the vpc_connector resource, the following permissions are required: - -### Read -```json -apprunner:DescribeVpcConnector -``` - -### Delete -```json -apprunner:DeleteVpcConnector -``` - diff --git a/docs/awscc-docs/providers/awscc/apprunner/vpc_connectors/index.md b/docs/awscc-docs/providers/awscc/apprunner/vpc_connectors/index.md deleted file mode 100644 index a154113c18..0000000000 --- a/docs/awscc-docs/providers/awscc/apprunner/vpc_connectors/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -vpc_connector_arn -FROM awscc.apprunner.vpc_connectors -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the vpc_connectors resource, the following permissions are required: - -### Create -```json -iam:CreateServiceLinkedRole, -apprunner:CreateVpcConnector, -apprunner:DescribeVpcConnector, -apprunner:TagResource, -ec2:DescribeSubnets, -ec2:DescribeSecurityGroups -``` - -### List -```json -apprunner:ListVpcConnectors -``` - 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 deleted file mode 100644 index 18f3ceeccc..0000000000 --- a/docs/awscc-docs/providers/awscc/apprunner/vpc_ingress_connection/index.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the vpc_ingress_connection resource, the following permissions are required: - -### Read -```json -apprunner:DescribeVpcIngressConnection -``` - -### Update -```json -apprunner:UpdateVpcIngressConnection -``` - -### Delete -```json -apprunner:DeleteVpcIngressConnection -``` - 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 deleted file mode 100644 index 770efe9dde..0000000000 --- a/docs/awscc-docs/providers/awscc/apprunner/vpc_ingress_connections/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -vpc_ingress_connection_arn -FROM awscc.apprunner.vpc_ingress_connections -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the vpc_ingress_connections resource, the following permissions are required: - -### Create -```json -apprunner:CreateVpcIngressConnection, -apprunner:DescribeVpcIngressConnection, -ec2:DescribeVpcs, -ec2:DescribeVpcEndpoints, -ec2:DescribeSubnets, -apprunner:TagResource -``` - -### List -```json -apprunner:ListVpcIngressConnections -``` - diff --git a/docs/awscc-docs/providers/awscc/appstream/app_block/index.md b/docs/awscc-docs/providers/awscc/appstream/app_block/index.md deleted file mode 100644 index df8c531a06..0000000000 --- a/docs/awscc-docs/providers/awscc/appstream/app_block/index.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the app_block resource, the following permissions are required: - -### Read -```json -appstream:DescribeAppBlocks -``` - -### Delete -```json -appstream:DeleteAppBlock -``` - 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 deleted file mode 100644 index 951ac2b538..0000000000 --- a/docs/awscc-docs/providers/awscc/appstream/app_block_builder/index.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the app_block_builder resource, the following permissions are required: - -### Read -```json -appstream:DescribeAppBlockBuilders -``` - -### Update -```json -appstream:UpdateAppBlockBuilder, -appstream:DescribeAppBlockBuilders, -appstream:StartAppBlockBuilder, -appstream:StopAppBlockBuilder, -appstream:AssociateAppBlockBuilderAppBlock, -appstream:DisassociateAppBlockBuilderAppBlock, -appstream:DescribeAppBlockBuilderAppBlockAssociations, -appstream:ListTagsForResource, -appstream:TagResource, -appstream:UntagResource, -iam:PassRole -``` - -### Delete -```json -appstream:DescribeAppBlockBuilders, -appstream:DeleteAppBlockBuilder, -appstream:DisassociateAppBlockBuilderAppBlock, -appstream:DescribeAppBlockBuilderAppBlockAssociations -``` - 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 deleted file mode 100644 index 198eed895a..0000000000 --- a/docs/awscc-docs/providers/awscc/appstream/app_block_builders/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.appstream.app_block_builders -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the app_block_builders resource, the following permissions are required: - -### Create -```json -appstream:CreateAppBlockBuilder, -appstream:DescribeAppBlockBuilders, -appstream:StartAppBlockBuilder, -appstream:AssociateAppBlockBuilderAppBlock, -appstream:DescribeAppBlockBuilderAppBlockAssociations, -appstream:TagResource, -iam:PassRole -``` - -### List -```json -appstream:DescribeAppBlockBuilders -``` - diff --git a/docs/awscc-docs/providers/awscc/appstream/application/index.md b/docs/awscc-docs/providers/awscc/appstream/application/index.md deleted file mode 100644 index 1c5dc6a239..0000000000 --- a/docs/awscc-docs/providers/awscc/appstream/application/index.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the application resource, the following permissions are required: - -### Read -```json -appstream:DescribeApplications -``` - -### Update -```json -appstream:UpdateApplication, -s3:GetObject -``` - -### Delete -```json -appstream:DeleteApplication -``` - 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 deleted file mode 100644 index 8a0707fc2b..0000000000 --- a/docs/awscc-docs/providers/awscc/appstream/application_entitlement_association/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -stack_name, -entitlement_name, -application_identifier -FROM awscc.appstream.application_entitlement_association -WHERE data__Identifier = '||'; -``` - -## Permissions - -To operate on the application_entitlement_association resource, the following permissions are required: - -### Read -```json -appstream:ListEntitledApplications -``` - -### Delete -```json -appstream:DisassociateApplicationFromEntitlement, -appstream:ListEntitledApplications -``` - 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 deleted file mode 100644 index 76e8bd7ccb..0000000000 --- a/docs/awscc-docs/providers/awscc/appstream/application_fleet_association/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -fleet_name, -application_arn -FROM awscc.appstream.application_fleet_association -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the application_fleet_association resource, the following permissions are required: - -### Read -```json -appstream:DescribeApplicationFleetAssociations -``` - -### Delete -```json -appstream:DisassociateApplicationFleet, -appstream:DescribeApplicationFleetAssociations -``` - diff --git a/docs/awscc-docs/providers/awscc/appstream/directory_config/index.md b/docs/awscc-docs/providers/awscc/appstream/directory_config/index.md deleted file mode 100644 index 2cd34f8fda..0000000000 --- a/docs/awscc-docs/providers/awscc/appstream/directory_config/index.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -organizational_unit_distinguished_names, -service_account_credentials, -directory_name, -certificate_based_auth_properties -FROM awscc.appstream.directory_config -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the directory_config resource, the following permissions are required: - -### Update -```json -appstream:CreateDirectoryConfig, -appstream:DeleteDirectoryConfig, -appstream:DescribeDirectoryConfig, -appstream:UpdateDirectoryConfig, -iam:CreateServiceLinkedRole, -iam:DeleteServiceLinkedRole, -iam:GetServiceLinkedRoleDeletionStatus -``` - -### Read -```json -appstream:CreateDirectoryConfig, -appstream:DeleteDirectoryConfig, -appstream:DescribeDirectoryConfig, -appstream:UpdateDirectoryConfig, -iam:CreateServiceLinkedRole, -iam:DeleteServiceLinkedRole, -iam:GetServiceLinkedRoleDeletionStatus -``` - -### Delete -```json -appstream:CreateDirectoryConfig, -appstream:DeleteDirectoryConfig, -appstream:DescribeDirectoryConfig, -appstream:UpdateDirectoryConfig, -iam:CreateServiceLinkedRole, -iam:DeleteServiceLinkedRole, -iam:GetServiceLinkedRoleDeletionStatus -``` - diff --git a/docs/awscc-docs/providers/awscc/appstream/directory_configs/index.md b/docs/awscc-docs/providers/awscc/appstream/directory_configs/index.md deleted file mode 100644 index a0be5b67be..0000000000 --- a/docs/awscc-docs/providers/awscc/appstream/directory_configs/index.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -directory_name -FROM awscc.appstream.directory_configs -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the directory_configs resource, the following permissions are required: - -### Create -```json -appstream:CreateDirectoryConfig, -appstream:DeleteDirectoryConfig, -appstream:DescribeDirectoryConfig, -appstream:UpdateDirectoryConfig, -iam:CreateServiceLinkedRole, -iam:DeleteServiceLinkedRole, -iam:GetServiceLinkedRoleDeletionStatus -``` - -### List -```json -appstream:CreateDirectoryConfig, -appstream:DeleteDirectoryConfig, -appstream:DescribeDirectoryConfig, -appstream:UpdateDirectoryConfig, -iam:CreateServiceLinkedRole, -iam:DeleteServiceLinkedRole, -iam:GetServiceLinkedRoleDeletionStatus -``` - diff --git a/docs/awscc-docs/providers/awscc/appstream/entitlement/index.md b/docs/awscc-docs/providers/awscc/appstream/entitlement/index.md deleted file mode 100644 index 46d8906aef..0000000000 --- a/docs/awscc-docs/providers/awscc/appstream/entitlement/index.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -stack_name, -description, -app_visibility, -attributes, -created_time, -last_modified_time -FROM awscc.appstream.entitlement -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the entitlement resource, the following permissions are required: - -### Read -```json -appstream:DescribeEntitlements -``` - -### Update -```json -appstream:UpdateEntitlement -``` - -### Delete -```json -appstream:DeleteEntitlement -``` - diff --git a/docs/awscc-docs/providers/awscc/appstream/image_builder/index.md b/docs/awscc-docs/providers/awscc/appstream/image_builder/index.md deleted file mode 100644 index ca104ad5ab..0000000000 --- a/docs/awscc-docs/providers/awscc/appstream/image_builder/index.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the image_builder resource, the following permissions are required: - -### Read -```json -appstream:CreateImageBuilder, -appstream:CreateImageBuilderStreamingURL, -appstream:CreateStreamingURL, -appstream:DeleteImageBuilder, -appstream:DescribeImageBuilders, -appstream:StartImageBuilder, -appstream:StopImageBuilder, -iam:CreateServiceLinkedRole, -iam:DeleteServiceLinkedRole, -iam:GetServiceLinkedRoleDeletionStatus -``` - -### Delete -```json -appstream:CreateImageBuilder, -appstream:CreateImageBuilderStreamingURL, -appstream:CreateStreamingURL, -appstream:DeleteImageBuilder, -appstream:DescribeImageBuilders, -appstream:StartImageBuilder, -appstream:StopImageBuilder, -iam:CreateServiceLinkedRole, -iam:DeleteServiceLinkedRole, -iam:GetServiceLinkedRoleDeletionStatus -``` - diff --git a/docs/awscc-docs/providers/awscc/appstream/image_builders/index.md b/docs/awscc-docs/providers/awscc/appstream/image_builders/index.md deleted file mode 100644 index 902314567a..0000000000 --- a/docs/awscc-docs/providers/awscc/appstream/image_builders/index.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.appstream.image_builders -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the image_builders resource, the following permissions are required: - -### Create -```json -appstream:CreateImageBuilder, -appstream:CreateImageBuilderStreamingURL, -appstream:CreateStreamingURL, -appstream:DeleteImageBuilder, -appstream:DescribeImageBuilders, -appstream:StartImageBuilder, -appstream:StopImageBuilder, -iam:CreateServiceLinkedRole, -iam:DeleteServiceLinkedRole, -iam:GetServiceLinkedRoleDeletionStatus -``` - -### List -```json -appstream:CreateImageBuilder, -appstream:CreateImageBuilderStreamingURL, -appstream:CreateStreamingURL, -appstream:DeleteImageBuilder, -appstream:DescribeImageBuilders, -appstream:StartImageBuilder, -appstream:StopImageBuilder, -iam:CreateServiceLinkedRole, -iam:DeleteServiceLinkedRole, -iam:GetServiceLinkedRoleDeletionStatus -``` - diff --git a/docs/awscc-docs/providers/awscc/appstream/index.md b/docs/awscc-docs/providers/awscc/appstream/index.md deleted file mode 100644 index ae0b91b612..0000000000 --- a/docs/awscc-docs/providers/awscc/appstream/index.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -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: 11
-total selectable resources: 11
-total methods: 11
-
-
- -::: - -## Resources -
-
-app_block
-app_block_builder
-app_block_builders
-application
-application_entitlement_association
-application_fleet_association -
-
-directory_config
-directory_configs
-entitlement
-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 deleted file mode 100644 index d578bc7e28..0000000000 --- a/docs/awscc-docs/providers/awscc/appsync/domain_name/index.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -domain_name, -description, -certificate_arn, -app_sync_domain_name, -hosted_zone_id -FROM awscc.appsync.domain_name -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the domain_name resource, the following permissions are required: - -### Delete -```json -appsync:GetDomainName, -appsync:DeleteDomainName -``` - -### Update -```json -appsync:UpdateDomainName -``` - -### Read -```json -appsync:GetDomainName -``` - 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 deleted file mode 100644 index d2b20d76f6..0000000000 --- a/docs/awscc-docs/providers/awscc/appsync/domain_name_api_association/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -domain_name, -api_id, -api_association_identifier -FROM awscc.appsync.domain_name_api_association -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the domain_name_api_association resource, the following permissions are required: - -### Delete -```json -appsync:DisassociateApi, -appsync:GetApiAssociation -``` - -### Update -```json -appsync:AssociateApi, -appsync:GetApiAssociation -``` - -### Read -```json -appsync:GetApiAssociation -``` - diff --git a/docs/awscc-docs/providers/awscc/appsync/domain_names/index.md b/docs/awscc-docs/providers/awscc/appsync/domain_names/index.md deleted file mode 100644 index 6272796d7d..0000000000 --- a/docs/awscc-docs/providers/awscc/appsync/domain_names/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -domain_name -FROM awscc.appsync.domain_names -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the domain_names resource, the following permissions are required: - -### Create -```json -appsync:CreateDomainName, -appsync:GetDomainName, -acm:DescribeCertificate, -cloudfront:UpdateDistribution -``` - -### List -```json -appsync:ListDomainNames -``` - diff --git a/docs/awscc-docs/providers/awscc/appsync/function_configuration/index.md b/docs/awscc-docs/providers/awscc/appsync/function_configuration/index.md deleted file mode 100644 index dfed51977f..0000000000 --- a/docs/awscc-docs/providers/awscc/appsync/function_configuration/index.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the function_configuration resource, the following permissions are required: - -### Read -```json -appsync:GetFunction -``` - -### Update -```json -s3:GetObject, -appsync:UpdateFunction -``` - -### Delete -```json -appsync:DeleteFunction -``` - diff --git a/docs/awscc-docs/providers/awscc/appsync/function_configurations/index.md b/docs/awscc-docs/providers/awscc/appsync/function_configurations/index.md deleted file mode 100644 index 68db81eb71..0000000000 --- a/docs/awscc-docs/providers/awscc/appsync/function_configurations/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -function_arn -FROM awscc.appsync.function_configurations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the function_configurations resource, the following permissions are required: - -### Create -```json -s3:GetObject, -appsync:CreateFunction -``` - -### List -```json -appsync:ListFunctions -``` - diff --git a/docs/awscc-docs/providers/awscc/appsync/index.md b/docs/awscc-docs/providers/awscc/appsync/index.md deleted file mode 100644 index 0035ffb3f7..0000000000 --- a/docs/awscc-docs/providers/awscc/appsync/index.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -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: 9
-total selectable resources: 9
-total methods: 9
-
-
- -::: - -## Resources -
-
-domain_name
-domain_name_api_association
-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 deleted file mode 100644 index 8c1bd4e862..0000000000 --- a/docs/awscc-docs/providers/awscc/appsync/resolver/index.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the resolver resource, the following permissions are required: - -### Read -```json -appsync:GetResolver -``` - -### Update -```json -s3:GetObject, -appsync:UpdateResolver -``` - -### Delete -```json -appsync:DeleteResolver -``` - diff --git a/docs/awscc-docs/providers/awscc/appsync/resolvers/index.md b/docs/awscc-docs/providers/awscc/appsync/resolvers/index.md deleted file mode 100644 index 27001cd0d3..0000000000 --- a/docs/awscc-docs/providers/awscc/appsync/resolvers/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -resolver_arn -FROM awscc.appsync.resolvers -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the resolvers resource, the following permissions are required: - -### Create -```json -s3:GetObject, -appsync:CreateResolver, -appsync:GetResolver -``` - -### List -```json -appsync:ListResolvers -``` - 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 deleted file mode 100644 index fd74395277..0000000000 --- a/docs/awscc-docs/providers/awscc/appsync/source_api_association/index.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the source_api_association resource, the following permissions are required: - -### Read -```json -appsync:GetSourceApiAssociation, -appsync:ListSourceApiAssociations -``` - -### Update -```json -appsync:GetSourceApiAssociation, -appsync:UpdateSourceApiAssociation, -appsync:GetSourceApiAssociation -``` - -### Delete -```json -appsync:GetSourceApiAssociation, -appsync:DisassociateSourceGraphqlApi, -appsync:DisassociateMergedGraphqlApi, -appsync:ListSourceApiAssociations -``` - 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 deleted file mode 100644 index 9fde124435..0000000000 --- a/docs/awscc-docs/providers/awscc/appsync/source_api_associations/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -association_arn -FROM awscc.appsync.source_api_associations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the source_api_associations resource, the following permissions are required: - -### Create -```json -appsync:AssociateSourceGraphqlApi, -appsync:AssociateMergedGraphqlApi, -appsync:GetSourceApiAssociation -``` - -### List -```json -appsync:ListSourceApiAssociations -``` - diff --git a/docs/awscc-docs/providers/awscc/aps/index.md b/docs/awscc-docs/providers/awscc/aps/index.md deleted file mode 100644 index df06cf709a..0000000000 --- a/docs/awscc-docs/providers/awscc/aps/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index 44dfc69266..0000000000 --- a/docs/awscc-docs/providers/awscc/aps/rule_groups_namespace/index.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -workspace, -name, -data, -arn, -tags -FROM awscc.aps.rule_groups_namespace -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the rule_groups_namespace resource, the following permissions are required: - -### Read -```json -aps:DescribeRuleGroupsNamespace, -aps:ListTagsForResource -``` - -### Update -```json -aps:PutRuleGroupsNamespace, -aps:DescribeRuleGroupsNamespace, -aps:TagResource, -aps:UntagResource, -aps:ListTagsForResource -``` - -### Delete -```json -aps:DeleteRuleGroupsNamespace, -aps:DescribeRuleGroupsNamespace -``` - 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 deleted file mode 100644 index 777f24340b..0000000000 --- a/docs/awscc-docs/providers/awscc/aps/rule_groups_namespaces/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.aps.rule_groups_namespaces -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the rule_groups_namespaces resource, the following permissions are required: - -### Create -```json -aps:CreateRuleGroupsNamespace, -aps:DescribeRuleGroupsNamespace, -aps:TagResource -``` - -### List -```json -aps:ListRuleGroupsNamespaces, -aps:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/aps/workspace/index.md b/docs/awscc-docs/providers/awscc/aps/workspace/index.md deleted file mode 100644 index b262a5d7b1..0000000000 --- a/docs/awscc-docs/providers/awscc/aps/workspace/index.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -workspace_id, -alias, -arn, -alert_manager_definition, -prometheus_endpoint, -logging_configuration, -kms_key_arn, -tags -FROM awscc.aps.workspace -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the workspace resource, the following permissions are required: - -### Read -```json -aps:DescribeWorkspace, -aps:ListTagsForResource, -aps:DescribeAlertManagerDefinition, -aps:DescribeLoggingConfiguration -``` - -### Update -```json -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 -```json -aps:DeleteWorkspace, -aps:DescribeWorkspace, -aps:DeleteAlertManagerDefinition, -aps:DeleteLoggingConfiguration, -logs:DeleteLogDelivery -``` - diff --git a/docs/awscc-docs/providers/awscc/aps/workspaces/index.md b/docs/awscc-docs/providers/awscc/aps/workspaces/index.md deleted file mode 100644 index 120b06a46e..0000000000 --- a/docs/awscc-docs/providers/awscc/aps/workspaces/index.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.aps.workspaces -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the workspaces resource, the following permissions are required: - -### Create -```json -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 -```json -aps:ListWorkspaces, -aps:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/arczonalshift/index.md b/docs/awscc-docs/providers/awscc/arczonalshift/index.md deleted file mode 100644 index 95e9761671..0000000000 --- a/docs/awscc-docs/providers/awscc/arczonalshift/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 deleted file mode 100644 index 5c36b5f252..0000000000 --- a/docs/awscc-docs/providers/awscc/arczonalshift/zonal_autoshift_configuration/index.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -zonal_autoshift_status, -practice_run_configuration, -resource_identifier -FROM awscc.arczonalshift.zonal_autoshift_configuration -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the zonal_autoshift_configuration resource, the following permissions are required: - -### Read -```json -arc-zonal-shift:GetManagedResource -``` - -### Update -```json -arc-zonal-shift:GetManagedResource, -arc-zonal-shift:UpdatePracticeRunConfiguration, -arc-zonal-shift:UpdateZonalAutoshiftConfiguration, -cloudwatch:DescribeAlarms -``` - -### Delete -```json -arc-zonal-shift:DeletePracticeRunConfiguration, -arc-zonal-shift:GetManagedResource, -arc-zonal-shift:UpdateZonalAutoshiftConfiguration -``` - 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 deleted file mode 100644 index c06c29a3d1..0000000000 --- a/docs/awscc-docs/providers/awscc/arczonalshift/zonal_autoshift_configurations/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -resource_identifier -FROM awscc.arczonalshift.zonal_autoshift_configurations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the zonal_autoshift_configurations resource, the following permissions are required: - -### Create -```json -arc-zonal-shift:CreatePracticeRunConfiguration, -arc-zonal-shift:GetManagedResource, -arc-zonal-shift:UpdateZonalAutoshiftConfiguration, -cloudwatch:DescribeAlarms, -iam:CreateServiceLinkedRole -``` - -### List -```json -arc-zonal-shift:ListManagedResources -``` - diff --git a/docs/awscc-docs/providers/awscc/athena/capacity_reservation/index.md b/docs/awscc-docs/providers/awscc/athena/capacity_reservation/index.md deleted file mode 100644 index 9119df5a08..0000000000 --- a/docs/awscc-docs/providers/awscc/athena/capacity_reservation/index.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the capacity_reservation resource, the following permissions are required: - -### Read -```json -athena:GetCapacityReservation, -athena:GetCapacityAssignmentConfiguration, -athena:ListTagsForResource -``` - -### Update -```json -athena:UpdateCapacityReservation, -athena:PutCapacityAssignmentConfiguration, -athena:GetCapacityReservation, -athena:TagResource, -athena:UntagResource -``` - -### Delete -```json -athena:CancelCapacityReservation, -athena:GetCapacityReservation, -athena:DeleteCapacityReservation -``` - diff --git a/docs/awscc-docs/providers/awscc/athena/capacity_reservations/index.md b/docs/awscc-docs/providers/awscc/athena/capacity_reservations/index.md deleted file mode 100644 index be41fd2f2a..0000000000 --- a/docs/awscc-docs/providers/awscc/athena/capacity_reservations/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.athena.capacity_reservations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the capacity_reservations resource, the following permissions are required: - -### Create -```json -athena:CreateCapacityReservation, -athena:PutCapacityAssignmentConfiguration, -athena:GetCapacityReservation, -athena:TagResource -``` - -### List -```json -athena:ListCapacityReservations, -athena:GetCapacityReservation -``` - diff --git a/docs/awscc-docs/providers/awscc/athena/data_catalog/index.md b/docs/awscc-docs/providers/awscc/athena/data_catalog/index.md deleted file mode 100644 index f593b4ad5e..0000000000 --- a/docs/awscc-docs/providers/awscc/athena/data_catalog/index.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -description, -parameters, -tags, -type -FROM awscc.athena.data_catalog -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the data_catalog resource, the following permissions are required: - -### Read -```json -athena:GetDataCatalog, -athena:ListTagsForResource -``` - -### Update -```json -athena:UpdateDataCatalog, -athena:TagResource, -athena:GetDataCatalog, -athena:UntagResource, -athena:ListTagsForResource -``` - -### Delete -```json -athena:DeleteDataCatalog -``` - diff --git a/docs/awscc-docs/providers/awscc/athena/data_catalogs/index.md b/docs/awscc-docs/providers/awscc/athena/data_catalogs/index.md deleted file mode 100644 index 929c00d475..0000000000 --- a/docs/awscc-docs/providers/awscc/athena/data_catalogs/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.athena.data_catalogs -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the data_catalogs resource, the following permissions are required: - -### Create -```json -athena:CreateDataCatalog, -athena:TagResource -``` - -### List -```json -athena:ListDataCatalog -``` - diff --git a/docs/awscc-docs/providers/awscc/athena/index.md b/docs/awscc-docs/providers/awscc/athena/index.md deleted file mode 100644 index e856b3bbf1..0000000000 --- a/docs/awscc-docs/providers/awscc/athena/index.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -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 deleted file mode 100644 index f72e102520..0000000000 --- a/docs/awscc-docs/providers/awscc/athena/named_queries/index.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -named_query_id -FROM awscc.athena.named_queries -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the named_queries resource, the following permissions are required: - -### Create -```json -athena:CreateNamedQuery -``` - -### List -```json -athena:ListNamedQueries -``` - diff --git a/docs/awscc-docs/providers/awscc/athena/named_query/index.md b/docs/awscc-docs/providers/awscc/athena/named_query/index.md deleted file mode 100644 index 2262fb33b1..0000000000 --- a/docs/awscc-docs/providers/awscc/athena/named_query/index.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -database, -description, -query_string, -work_group, -named_query_id -FROM awscc.athena.named_query -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the named_query resource, the following permissions are required: - -### Read -```json -athena:GetNamedQuery -``` - -### Delete -```json -athena:DeleteNamedQuery -``` - diff --git a/docs/awscc-docs/providers/awscc/athena/prepared_statement/index.md b/docs/awscc-docs/providers/awscc/athena/prepared_statement/index.md deleted file mode 100644 index 6a06472869..0000000000 --- a/docs/awscc-docs/providers/awscc/athena/prepared_statement/index.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -statement_name, -work_group, -description, -query_statement -FROM awscc.athena.prepared_statement -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the prepared_statement resource, the following permissions are required: - -### Read -```json -athena:GetPreparedStatement -``` - -### Update -```json -athena:UpdatePreparedStatement -``` - -### Delete -```json -athena:DeletePreparedStatement, -athena:GetPreparedStatement -``` - diff --git a/docs/awscc-docs/providers/awscc/athena/prepared_statements/index.md b/docs/awscc-docs/providers/awscc/athena/prepared_statements/index.md deleted file mode 100644 index ff765a48de..0000000000 --- a/docs/awscc-docs/providers/awscc/athena/prepared_statements/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -statement_name, -work_group -FROM awscc.athena.prepared_statements -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the prepared_statements resource, the following permissions are required: - -### Create -```json -athena:CreatePreparedStatement, -athena:GetPreparedStatement -``` - -### List -```json -athena:ListPreparedStatements -``` - diff --git a/docs/awscc-docs/providers/awscc/athena/work_group/index.md b/docs/awscc-docs/providers/awscc/athena/work_group/index.md deleted file mode 100644 index 2246070fde..0000000000 --- a/docs/awscc-docs/providers/awscc/athena/work_group/index.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the work_group resource, the following permissions are required: - -### Read -```json -athena:GetWorkGroup, -athena:ListTagsForResource -``` - -### Delete -```json -athena:DeleteWorkGroup, -athena:GetWorkGroup, -athena:UntagResource -``` - -### Update -```json -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 -``` - diff --git a/docs/awscc-docs/providers/awscc/athena/work_groups/index.md b/docs/awscc-docs/providers/awscc/athena/work_groups/index.md deleted file mode 100644 index f21869e381..0000000000 --- a/docs/awscc-docs/providers/awscc/athena/work_groups/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.athena.work_groups -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the work_groups resource, the following permissions are required: - -### Create -```json -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 -```json -athena:ListWorkGroups -``` - diff --git a/docs/awscc-docs/providers/awscc/auditmanager/assessment/index.md b/docs/awscc-docs/providers/awscc/auditmanager/assessment/index.md deleted file mode 100644 index a5d9174f32..0000000000 --- a/docs/awscc-docs/providers/awscc/auditmanager/assessment/index.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the assessment resource, the following permissions are required: - -### Read -```json -auditmanager:GetAssessment -``` - -### Update -```json -auditmanager:UpdateAssessment, -auditmanager:UpdateAssessmentStatus, -auditmanager:BatchCreateDelegationByAssessment, -auditmanager:BatchDeleteDelegationByAssessment -``` - -### Delete -```json -auditmanager:DeleteAssessment -``` - diff --git a/docs/awscc-docs/providers/awscc/auditmanager/assessments/index.md b/docs/awscc-docs/providers/awscc/auditmanager/assessments/index.md deleted file mode 100644 index e30428030a..0000000000 --- a/docs/awscc-docs/providers/awscc/auditmanager/assessments/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -assessment_id -FROM awscc.auditmanager.assessments -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the assessments resource, the following permissions are required: - -### Create -```json -auditmanager:CreateAssessment, -auditmanager:TagResource, -auditmanager:ListTagsForResource, -auditmanager:BatchCreateDelegationByAssessment, -iam:PassRole -``` - -### List -```json -auditmanager:ListAssessments -``` - diff --git a/docs/awscc-docs/providers/awscc/auditmanager/index.md b/docs/awscc-docs/providers/awscc/auditmanager/index.md deleted file mode 100644 index dc3aac018d..0000000000 --- a/docs/awscc-docs/providers/awscc/auditmanager/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 deleted file mode 100644 index eee18b181e..0000000000 --- a/docs/awscc-docs/providers/awscc/autoscaling/auto_scaling_group/index.md +++ /dev/null @@ -1,139 +0,0 @@ ---- -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_arnstring
target_group_arnsarray
cooldownstring
notification_configurationsarray
desired_capacitystring
health_check_grace_periodinteger
default_instance_warmupinteger
new_instances_protected_from_scale_inboolean
launch_templateobject
mixed_instances_policyobject
vpc_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. - -## Example -```sql -SELECT -region, -lifecycle_hook_specification_list, -load_balancer_names, -launch_configuration_name, -service_linked_role_arn, -target_group_arns, -cooldown, -notification_configurations, -desired_capacity, -health_check_grace_period, -default_instance_warmup, -new_instances_protected_from_scale_in, -launch_template, -mixed_instances_policy, -vpc_zone_identifier, -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 data__Identifier = ''; -``` - -## Permissions - -To operate on the auto_scaling_group resource, the following permissions are required: - -### Read -```json -autoscaling:*, -managed-fleets:GetAutoScalingGroup -``` - -### Update -```json -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 -```json -autoscaling:*, -managed-fleets:GetAutoScalingGroup, -managed-fleets:DeleteAutoScalingGroup -``` - 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 deleted file mode 100644 index b6b2d222a4..0000000000 --- a/docs/awscc-docs/providers/awscc/autoscaling/auto_scaling_groups/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -auto_scaling_group_name -FROM awscc.autoscaling.auto_scaling_groups -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the auto_scaling_groups resource, the following permissions are required: - -### Create -```json -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 -```json -autoscaling:* -``` - diff --git a/docs/awscc-docs/providers/awscc/autoscaling/index.md b/docs/awscc-docs/providers/awscc/autoscaling/index.md deleted file mode 100644 index c75a683f22..0000000000 --- a/docs/awscc-docs/providers/awscc/autoscaling/index.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -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: 11
-total selectable resources: 11
-total methods: 11
-
-
- -::: - -## 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 -
-
\ 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 deleted file mode 100644 index 3606af82fc..0000000000 --- a/docs/awscc-docs/providers/awscc/autoscaling/launch_configuration/index.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -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_vpc_idstringThe ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to.
classic_link_vpc_security_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. - -## Example -```sql -SELECT -region, -associate_public_ip_address, -block_device_mappings, -classic_link_vpc_id, -classic_link_vpc_security_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 data__Identifier = ''; -``` - -## Permissions - -To operate on the launch_configuration resource, the following permissions are required: - -### Read -```json -autoscaling:DescribeLaunchConfigurations -``` - -### Delete -```json -autoscaling:DeleteLaunchConfiguration, -autoscaling:DescribeLaunchConfigurations -``` - diff --git a/docs/awscc-docs/providers/awscc/autoscaling/launch_configurations/index.md b/docs/awscc-docs/providers/awscc/autoscaling/launch_configurations/index.md deleted file mode 100644 index 912f3eeb26..0000000000 --- a/docs/awscc-docs/providers/awscc/autoscaling/launch_configurations/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -launch_configuration_name -FROM awscc.autoscaling.launch_configurations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the launch_configurations resource, the following permissions are required: - -### Create -```json -autoscaling:CreateLaunchConfiguration, -autoscaling:DescribeLaunchConfigurations, -iam:PassRole -``` - -### List -```json -autoscaling:DescribeLaunchConfigurations -``` - diff --git a/docs/awscc-docs/providers/awscc/autoscaling/lifecycle_hook/index.md b/docs/awscc-docs/providers/awscc/autoscaling/lifecycle_hook/index.md deleted file mode 100644 index 7a5533977d..0000000000 --- a/docs/awscc-docs/providers/awscc/autoscaling/lifecycle_hook/index.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -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_arnstringThe 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_arnstringThe 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. - -## Example -```sql -SELECT -region, -auto_scaling_group_name, -default_result, -heartbeat_timeout, -lifecycle_hook_name, -lifecycle_transition, -notification_metadata, -notification_target_arn, -role_arn -FROM awscc.autoscaling.lifecycle_hook -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the lifecycle_hook resource, the following permissions are required: - -### Read -```json -autoscaling:DescribeLifecycleHooks -``` - -### Update -```json -autoscaling:PutLifecycleHook, -autoscaling:DescribeLifecycleHooks, -iam:PassRole -``` - -### Delete -```json -autoscaling:DeleteLifecycleHook, -autoscaling:DescribeLifecycleHooks -``` - diff --git a/docs/awscc-docs/providers/awscc/autoscaling/lifecycle_hooks/index.md b/docs/awscc-docs/providers/awscc/autoscaling/lifecycle_hooks/index.md deleted file mode 100644 index d16f9c6ae0..0000000000 --- a/docs/awscc-docs/providers/awscc/autoscaling/lifecycle_hooks/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -auto_scaling_group_name, -lifecycle_hook_name -FROM awscc.autoscaling.lifecycle_hooks -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the lifecycle_hooks resource, the following permissions are required: - -### Create -```json -autoscaling:PutLifecycleHook, -autoscaling:DescribeLifecycleHooks, -iam:PassRole -``` - -### List -```json -autoscaling:DescribeLifecycleHooks -``` - diff --git a/docs/awscc-docs/providers/awscc/autoscaling/scaling_policies/index.md b/docs/awscc-docs/providers/awscc/autoscaling/scaling_policies/index.md deleted file mode 100644 index 5dec18554c..0000000000 --- a/docs/awscc-docs/providers/awscc/autoscaling/scaling_policies/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.autoscaling.scaling_policies -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the scaling_policies resource, the following permissions are required: - -### Create -```json -autoscaling:DescribePolicies, -autoscaling:PutScalingPolicy, -cloudwatch:GetMetricData -``` - -### List -```json -autoscaling:DescribePolicies -``` - diff --git a/docs/awscc-docs/providers/awscc/autoscaling/scaling_policy/index.md b/docs/awscc-docs/providers/awscc/autoscaling/scaling_policy/index.md deleted file mode 100644 index 343c80fbdd..0000000000 --- a/docs/awscc-docs/providers/awscc/autoscaling/scaling_policy/index.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the scaling_policy resource, the following permissions are required: - -### Read -```json -autoscaling:DescribePolicies -``` - -### Update -```json -autoscaling:DescribePolicies, -autoscaling:PutScalingPolicy, -cloudwatch:GetMetricData -``` - -### Delete -```json -autoscaling:DeletePolicy, -autoscaling:DescribePolicies -``` - diff --git a/docs/awscc-docs/providers/awscc/autoscaling/scheduled_action/index.md b/docs/awscc-docs/providers/awscc/autoscaling/scheduled_action/index.md deleted file mode 100644 index 340a06177b..0000000000 --- a/docs/awscc-docs/providers/awscc/autoscaling/scheduled_action/index.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the scheduled_action resource, the following permissions are required: - -### Read -```json -autoscaling:DescribeScheduledActions -``` - -### Update -```json -autoscaling:PutScheduledUpdateGroupAction -``` - -### Delete -```json -autoscaling:DeleteScheduledAction, -autoscaling:DescribeScheduledActions -``` - diff --git a/docs/awscc-docs/providers/awscc/autoscaling/scheduled_actions/index.md b/docs/awscc-docs/providers/awscc/autoscaling/scheduled_actions/index.md deleted file mode 100644 index 17bbe16527..0000000000 --- a/docs/awscc-docs/providers/awscc/autoscaling/scheduled_actions/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -scheduled_action_name, -auto_scaling_group_name -FROM awscc.autoscaling.scheduled_actions -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the scheduled_actions resource, the following permissions are required: - -### Create -```json -autoscaling:PutScheduledUpdateGroupAction, -autoscaling:DescribeScheduledActions -``` - -### List -```json -autoscaling:DescribeScheduledActions -``` - diff --git a/docs/awscc-docs/providers/awscc/autoscaling/warm_pool/index.md b/docs/awscc-docs/providers/awscc/autoscaling/warm_pool/index.md deleted file mode 100644 index c1af3711ee..0000000000 --- a/docs/awscc-docs/providers/awscc/autoscaling/warm_pool/index.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the warm_pool resource, the following permissions are required: - -### Delete -```json -autoscaling:DeleteWarmPool, -autoscaling:DescribeWarmPool -``` - -### Read -```json -autoscaling:DescribeWarmPool -``` - -### Update -```json -autoscaling:PutWarmPool, -autoscaling:DescribeWarmPool, -autoscaling:DescribeAutoScalingGroups -``` - diff --git a/docs/awscc-docs/providers/awscc/b2bi/capabilities/index.md b/docs/awscc-docs/providers/awscc/b2bi/capabilities/index.md deleted file mode 100644 index 94b314a60d..0000000000 --- a/docs/awscc-docs/providers/awscc/b2bi/capabilities/index.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -capability_id -FROM awscc.b2bi.capabilities -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the capabilities resource, the following permissions are required: - -### Create -```json -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 -```json -b2bi:ListCapabilities -``` - diff --git a/docs/awscc-docs/providers/awscc/b2bi/capability/index.md b/docs/awscc-docs/providers/awscc/b2bi/capability/index.md deleted file mode 100644 index 17eb6ef406..0000000000 --- a/docs/awscc-docs/providers/awscc/b2bi/capability/index.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -capability_arn, -capability_id, -configuration, -created_at, -instructions_documents, -modified_at, -name, -tags, -type -FROM awscc.b2bi.capability -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the capability resource, the following permissions are required: - -### Read -```json -b2bi:GetCapability, -b2bi:ListTagsForResource -``` - -### Update -```json -b2bi:TagResource, -b2bi:UntagResource, -b2bi:UpdateCapability -``` - -### Delete -```json -b2bi:DeleteCapability -``` - diff --git a/docs/awscc-docs/providers/awscc/b2bi/index.md b/docs/awscc-docs/providers/awscc/b2bi/index.md deleted file mode 100644 index bb7085c8b8..0000000000 --- a/docs/awscc-docs/providers/awscc/b2bi/index.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -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 deleted file mode 100644 index 84a69adafc..0000000000 --- a/docs/awscc-docs/providers/awscc/b2bi/partnership/index.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the partnership resource, the following permissions are required: - -### Read -```json -b2bi:GetPartnership, -b2bi:ListTagsForResource -``` - -### Update -```json -b2bi:TagResource, -b2bi:UntagResource, -b2bi:UpdatePartnership -``` - -### Delete -```json -b2bi:DeletePartnership -``` - diff --git a/docs/awscc-docs/providers/awscc/b2bi/partnerships/index.md b/docs/awscc-docs/providers/awscc/b2bi/partnerships/index.md deleted file mode 100644 index d6899c47e9..0000000000 --- a/docs/awscc-docs/providers/awscc/b2bi/partnerships/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -partnership_id -FROM awscc.b2bi.partnerships -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the partnerships resource, the following permissions are required: - -### Create -```json -b2bi:CreatePartnership, -b2bi:TagResource, -s3:PutObject -``` - -### List -```json -b2bi:ListPartnerships -``` - diff --git a/docs/awscc-docs/providers/awscc/b2bi/profile/index.md b/docs/awscc-docs/providers/awscc/b2bi/profile/index.md deleted file mode 100644 index 0341e5b3c1..0000000000 --- a/docs/awscc-docs/providers/awscc/b2bi/profile/index.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the profile resource, the following permissions are required: - -### Read -```json -b2bi:GetProfile, -b2bi:ListTagsForResource -``` - -### Update -```json -b2bi:TagResource, -b2bi:UntagResource, -b2bi:UpdateProfile -``` - -### Delete -```json -b2bi:DeleteProfile, -logs:DeleteLogDelivery, -logs:ListLogDeliveries -``` - diff --git a/docs/awscc-docs/providers/awscc/b2bi/profiles/index.md b/docs/awscc-docs/providers/awscc/b2bi/profiles/index.md deleted file mode 100644 index 6b2cacd068..0000000000 --- a/docs/awscc-docs/providers/awscc/b2bi/profiles/index.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -profile_id -FROM awscc.b2bi.profiles -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the profiles resource, the following permissions are required: - -### Create -```json -b2bi:CreateProfile, -b2bi:TagResource, -logs:CreateLogDelivery, -logs:CreateLogGroup, -logs:CreateLogStream, -logs:DescribeLogGroups, -logs:DescribeLogStreams, -logs:DescribeResourcePolicies, -logs:ListLogDeliveries, -logs:PutLogEvents, -logs:PutResourcePolicy -``` - -### List -```json -b2bi:ListProfiles -``` - diff --git a/docs/awscc-docs/providers/awscc/b2bi/transformer/index.md b/docs/awscc-docs/providers/awscc/b2bi/transformer/index.md deleted file mode 100644 index 361174e3bc..0000000000 --- a/docs/awscc-docs/providers/awscc/b2bi/transformer/index.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the transformer resource, the following permissions are required: - -### Read -```json -b2bi:GetTransformer, -b2bi:ListTagsForResource -``` - -### Update -```json -b2bi:TagResource, -b2bi:UntagResource, -b2bi:UpdateTransformer -``` - -### Delete -```json -b2bi:DeleteTransformer, -logs:DeleteLogDelivery, -logs:ListLogDeliveries -``` - diff --git a/docs/awscc-docs/providers/awscc/b2bi/transformers/index.md b/docs/awscc-docs/providers/awscc/b2bi/transformers/index.md deleted file mode 100644 index a6565f6718..0000000000 --- a/docs/awscc-docs/providers/awscc/b2bi/transformers/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -transformer_id -FROM awscc.b2bi.transformers -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the transformers resource, the following permissions are required: - -### Create -```json -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 -```json -b2bi:ListTransformers -``` - diff --git a/docs/awscc-docs/providers/awscc/backup/backup_plan/index.md b/docs/awscc-docs/providers/awscc/backup/backup_plan/index.md deleted file mode 100644 index b9fb0c5d32..0000000000 --- a/docs/awscc-docs/providers/awscc/backup/backup_plan/index.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -backup_plan, -backup_plan_tags, -backup_plan_arn, -backup_plan_id, -version_id -FROM awscc.backup.backup_plan -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the backup_plan resource, the following permissions are required: - -### Read -```json -backup:GetBackupPlan, -backup:ListTags -``` - -### Delete -```json -backup:GetBackupPlan, -backup:DeleteBackupPlan -``` - -### Update -```json -backup:UpdateBackupPlan, -backup:ListTags, -backup:TagResource, -backup:UntagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/backup/backup_plans/index.md b/docs/awscc-docs/providers/awscc/backup/backup_plans/index.md deleted file mode 100644 index 8a284ae63d..0000000000 --- a/docs/awscc-docs/providers/awscc/backup/backup_plans/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -backup_plan_id -FROM awscc.backup.backup_plans -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the backup_plans resource, the following permissions are required: - -### Create -```json -backup:GetBackupPlan, -backup:TagResource, -backup:CreateBackupPlan -``` - -### List -```json -backup:ListBackupPlans -``` - diff --git a/docs/awscc-docs/providers/awscc/backup/backup_selection/index.md b/docs/awscc-docs/providers/awscc/backup/backup_selection/index.md deleted file mode 100644 index 0970c86619..0000000000 --- a/docs/awscc-docs/providers/awscc/backup/backup_selection/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id, -backup_plan_id, -backup_selection, -selection_id -FROM awscc.backup.backup_selection -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the backup_selection resource, the following permissions are required: - -### Delete -```json -backup:GetBackupSelection, -backup:DeleteBackupSelection -``` - -### Read -```json -backup:GetBackupSelection -``` - diff --git a/docs/awscc-docs/providers/awscc/backup/backup_selections/index.md b/docs/awscc-docs/providers/awscc/backup/backup_selections/index.md deleted file mode 100644 index 907c61f326..0000000000 --- a/docs/awscc-docs/providers/awscc/backup/backup_selections/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.backup.backup_selections -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the backup_selections resource, the following permissions are required: - -### Create -```json -backup:CreateBackupSelection, -iam:GetRole, -iam:PassRole, -iam:CreateServiceLinkedRole -``` - -### List -```json -backup:ListBackupSelections -``` - diff --git a/docs/awscc-docs/providers/awscc/backup/backup_vault/index.md b/docs/awscc-docs/providers/awscc/backup/backup_vault/index.md deleted file mode 100644 index bf2f4c65fb..0000000000 --- a/docs/awscc-docs/providers/awscc/backup/backup_vault/index.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the backup_vault resource, the following permissions are required: - -### Read -```json -backup:DescribeBackupVault, -backup:GetBackupVaultNotifications, -backup:GetBackupVaultAccessPolicy, -backup:ListTags -``` - -### Update -```json -backup:DescribeBackupVault, -backup:DeleteBackupVaultAccessPolicy, -backup:DeleteBackupVaultNotifications, -backup:DeleteBackupVaultLockConfiguration, -backup:ListTags, -backup:TagResource, -backup:UntagResource, -backup:PutBackupVaultAccessPolicy, -backup:PutBackupVaultNotifications, -backup:PutBackupVaultLockConfiguration -``` - -### Delete -```json -backup:DeleteBackupVault -``` - diff --git a/docs/awscc-docs/providers/awscc/backup/backup_vaults/index.md b/docs/awscc-docs/providers/awscc/backup/backup_vaults/index.md deleted file mode 100644 index 3b129a5e88..0000000000 --- a/docs/awscc-docs/providers/awscc/backup/backup_vaults/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -backup_vault_name -FROM awscc.backup.backup_vaults -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the backup_vaults resource, the following permissions are required: - -### Create -```json -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 -```json -backup:ListBackupVaults -``` - diff --git a/docs/awscc-docs/providers/awscc/backup/framework/index.md b/docs/awscc-docs/providers/awscc/backup/framework/index.md deleted file mode 100644 index 151a7a9798..0000000000 --- a/docs/awscc-docs/providers/awscc/backup/framework/index.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the framework resource, the following permissions are required: - -### Read -```json -backup:DescribeFramework, -backup:ListTags -``` - -### Update -```json -backup:DescribeFramework, -backup:UpdateFramework, -backup:ListTags, -backup:TagResource, -backup:UntagResource -``` - -### Delete -```json -backup:DeleteFramework, -backup:DescribeFramework -``` - diff --git a/docs/awscc-docs/providers/awscc/backup/frameworks/index.md b/docs/awscc-docs/providers/awscc/backup/frameworks/index.md deleted file mode 100644 index a852471fd3..0000000000 --- a/docs/awscc-docs/providers/awscc/backup/frameworks/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -framework_arn -FROM awscc.backup.frameworks -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the frameworks resource, the following permissions are required: - -### Create -```json -backup:CreateFramework, -backup:DescribeFramework, -backup:ListTags, -backup:TagResource, -iam:CreateServiceLinkedRole -``` - -### List -```json -backup:ListFrameworks -``` - diff --git a/docs/awscc-docs/providers/awscc/backup/index.md b/docs/awscc-docs/providers/awscc/backup/index.md deleted file mode 100644 index bf5ad0a664..0000000000 --- a/docs/awscc-docs/providers/awscc/backup/index.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -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 deleted file mode 100644 index 2022b9231e..0000000000 --- a/docs/awscc-docs/providers/awscc/backup/report_plan/index.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the report_plan resource, the following permissions are required: - -### Read -```json -backup:DescribeReportPlan, -backup:ListTags -``` - -### Update -```json -backup:DescribeReportPlan, -backup:UpdateReportPlan, -backup:ListTags, -backup:UntagResource, -backup:TagResource -``` - -### Delete -```json -backup:DeleteReportPlan, -backup:DescribeReportPlan -``` - diff --git a/docs/awscc-docs/providers/awscc/backup/report_plans/index.md b/docs/awscc-docs/providers/awscc/backup/report_plans/index.md deleted file mode 100644 index adf0ce08c3..0000000000 --- a/docs/awscc-docs/providers/awscc/backup/report_plans/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -report_plan_arn -FROM awscc.backup.report_plans -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the report_plans resource, the following permissions are required: - -### Create -```json -backup:CreateReportPlan, -backup:DescribeReportPlan, -backup:ListTags, -backup:TagResource, -iam:CreateServiceLinkedRole -``` - -### List -```json -backup:ListReportPlans -``` - 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 deleted file mode 100644 index b331a9573c..0000000000 --- a/docs/awscc-docs/providers/awscc/backup/restore_testing_plan/index.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the restore_testing_plan resource, the following permissions are required: - -### Read -```json -backup:GetRestoreTestingPlan, -backup:ListTags -``` - -### Update -```json -backup:UpdateRestoreTestingPlan, -backup:TagResource, -backup:UntagResource, -backup:GetRestoreTestingPlan, -backup:ListTags -``` - -### Delete -```json -backup:DeleteRestoreTestingPlan, -backup:GetRestoreTestingPlan -``` - 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 deleted file mode 100644 index f35a2df757..0000000000 --- a/docs/awscc-docs/providers/awscc/backup/restore_testing_plans/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -restore_testing_plan_name -FROM awscc.backup.restore_testing_plans -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the restore_testing_plans resource, the following permissions are required: - -### Create -```json -backup:CreateRestoreTestingPlan, -backup:TagResource, -backup:GetRestoreTestingPlan, -backup:ListTags -``` - -### List -```json -backup:ListRestoreTestingPlans -``` - 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 deleted file mode 100644 index c4c7e3f8f1..0000000000 --- a/docs/awscc-docs/providers/awscc/backup/restore_testing_selection/index.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the restore_testing_selection resource, the following permissions are required: - -### Read -```json -backup:GetRestoreTestingSelection -``` - -### Update -```json -backup:UpdateRestoreTestingSelection, -backup:GetRestoreTestingSelection, -iam:PassRole -``` - -### Delete -```json -backup:DeleteRestoreTestingSelection, -backup:GetRestoreTestingSelection -``` - 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 deleted file mode 100644 index b4c18c6db9..0000000000 --- a/docs/awscc-docs/providers/awscc/backup/restore_testing_selections/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -restore_testing_plan_name, -restore_testing_selection_name -FROM awscc.backup.restore_testing_selections -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the restore_testing_selections resource, the following permissions are required: - -### Create -```json -backup:CreateRestoreTestingSelection, -backup:GetRestoreTestingSelection, -iam:PassRole -``` - -### List -```json -backup:ListRestoreTestingSelections -``` - diff --git a/docs/awscc-docs/providers/awscc/backupgateway/hypervisor/index.md b/docs/awscc-docs/providers/awscc/backupgateway/hypervisor/index.md deleted file mode 100644 index 89dea69411..0000000000 --- a/docs/awscc-docs/providers/awscc/backupgateway/hypervisor/index.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -host, -hypervisor_arn, -kms_key_arn, -log_group_arn, -name, -password, -tags, -username -FROM awscc.backupgateway.hypervisor -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the hypervisor resource, the following permissions are required: - -### Read -```json -backup-gateway:GetHypervisor, -backup-gateway:ListHypervisors -``` - -### Update -```json -backup-gateway:UpdateHypervisor, -backup-gateway:GetHypervisor, -backup-gateway:ListHypervisors, -backup-gateway:ImportHypervisorConfiguration, -backup-gateway:DeleteHypervisor -``` - -### Delete -```json -backup-gateway:DeleteHypervisor, -backup-gateway:GetHypervisor, -backup-gateway:ListHypervisors -``` - diff --git a/docs/awscc-docs/providers/awscc/backupgateway/hypervisors/index.md b/docs/awscc-docs/providers/awscc/backupgateway/hypervisors/index.md deleted file mode 100644 index ac245d5e8c..0000000000 --- a/docs/awscc-docs/providers/awscc/backupgateway/hypervisors/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -hypervisor_arn -FROM awscc.backupgateway.hypervisors -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the hypervisors resource, the following permissions are required: - -### Create -```json -backup-gateway:ImportHypervisorConfiguration, -backup-gateway:GetHypervisor, -backup-gateway:ListHypervisors, -backup-gateway:TagResource, -kms:CreateGrant, -kms:Encrypt, -kms:Decrypt -``` - -### List -```json -backup-gateway:ListHypervisors -``` - diff --git a/docs/awscc-docs/providers/awscc/backupgateway/index.md b/docs/awscc-docs/providers/awscc/backupgateway/index.md deleted file mode 100644 index 352d351e9f..0000000000 --- a/docs/awscc-docs/providers/awscc/backupgateway/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 deleted file mode 100644 index 1a3960e2bf..0000000000 --- a/docs/awscc-docs/providers/awscc/batch/compute_environment/index.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the compute_environment resource, the following permissions are required: - -### Read -```json -Batch:DescribeComputeEnvironments -``` - -### Update -```json -Batch:UpdateComputeEnvironment, -Batch:DescribeComputeEnvironments, -Batch:TagResource, -Batch:UnTagResource, -Iam:PassRole, -Eks:DescribeCluster -``` - -### Delete -```json -Batch:DeleteComputeEnvironment, -Batch:DescribeComputeEnvironments, -Batch:UpdateComputeEnvironment, -Iam:PassRole, -Eks:DescribeCluster -``` - diff --git a/docs/awscc-docs/providers/awscc/batch/compute_environments/index.md b/docs/awscc-docs/providers/awscc/batch/compute_environments/index.md deleted file mode 100644 index 58a1f21c42..0000000000 --- a/docs/awscc-docs/providers/awscc/batch/compute_environments/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -compute_environment_arn -FROM awscc.batch.compute_environments -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the compute_environments resource, the following permissions are required: - -### Create -```json -Batch:CreateComputeEnvironment, -Batch:TagResource, -Batch:DescribeComputeEnvironments, -iam:CreateServiceLinkedRole, -Iam:PassRole, -Eks:DescribeCluster -``` - -### List -```json -Batch:DescribeComputeEnvironments -``` - diff --git a/docs/awscc-docs/providers/awscc/batch/index.md b/docs/awscc-docs/providers/awscc/batch/index.md deleted file mode 100644 index 98b78d5a63..0000000000 --- a/docs/awscc-docs/providers/awscc/batch/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -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 deleted file mode 100644 index 366759a943..0000000000 --- a/docs/awscc-docs/providers/awscc/batch/job_queue/index.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the job_queue resource, the following permissions are required: - -### Read -```json -Batch:DescribeJobQueues -``` - -### Update -```json -Batch:DescribeJobQueues, -Batch:UpdateJobQueue, -Batch:TagResource, -Batch:UnTagResource -``` - -### Delete -```json -Batch:UpdateJobQueue, -Batch:DescribeJobQueues, -Batch:DeleteJobQueue -``` - diff --git a/docs/awscc-docs/providers/awscc/batch/job_queues/index.md b/docs/awscc-docs/providers/awscc/batch/job_queues/index.md deleted file mode 100644 index 9096ce4884..0000000000 --- a/docs/awscc-docs/providers/awscc/batch/job_queues/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -job_queue_arn -FROM awscc.batch.job_queues -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the job_queues resource, the following permissions are required: - -### Create -```json -Batch:CreateJobQueue, -Batch:TagResource, -Batch:DescribeJobQueues -``` - -### List -```json -Batch:DescribeJobQueues -``` - diff --git a/docs/awscc-docs/providers/awscc/batch/scheduling_policies/index.md b/docs/awscc-docs/providers/awscc/batch/scheduling_policies/index.md deleted file mode 100644 index 5600a61d8c..0000000000 --- a/docs/awscc-docs/providers/awscc/batch/scheduling_policies/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.batch.scheduling_policies -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the scheduling_policies resource, the following permissions are required: - -### Create -```json -Batch:CreateSchedulingPolicy, -Batch:TagResource -``` - -### List -```json -Batch:ListSchedulingPolicies, -Batch:DescribeSchedulingPolicies -``` - diff --git a/docs/awscc-docs/providers/awscc/batch/scheduling_policy/index.md b/docs/awscc-docs/providers/awscc/batch/scheduling_policy/index.md deleted file mode 100644 index ee2c98db8d..0000000000 --- a/docs/awscc-docs/providers/awscc/batch/scheduling_policy/index.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -arn, -fairshare_policy, -tags -FROM awscc.batch.scheduling_policy -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the scheduling_policy resource, the following permissions are required: - -### Read -```json -Batch:DescribeSchedulingPolicies -``` - -### Update -```json -Batch:UpdateSchedulingPolicy, -Batch:TagResource, -Batch:UnTagResource -``` - -### Delete -```json -Batch:DescribeSchedulingPolicies, -Batch:DeleteSchedulingPolicy -``` - diff --git a/docs/awscc-docs/providers/awscc/billingconductor/billing_group/index.md b/docs/awscc-docs/providers/awscc/billingconductor/billing_group/index.md deleted file mode 100644 index 80b37bb5b6..0000000000 --- a/docs/awscc-docs/providers/awscc/billingconductor/billing_group/index.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the billing_group resource, the following permissions are required: - -### Read -```json -billingconductor:ListBillingGroups, -billingconductor:ListAccountAssociations, -organizations:ListAccounts, -billingconductor:ListTagsForResource -``` - -### Update -```json -billingconductor:UpdateBillingGroup, -billingconductor:ListAccountAssociations, -organizations:ListAccounts, -billingconductor:AssociateAccounts, -billingconductor:DisassociateAccounts, -billingconductor:ListBillingGroups, -billingconductor:TagResource, -billingconductor:UntagResource -``` - -### Delete -```json -billingconductor:DeleteBillingGroup, -billingconductor:ListBillingGroups, -billingconductor:UntagResource, -billingconductor:UpdateBillingGroup -``` - diff --git a/docs/awscc-docs/providers/awscc/billingconductor/billing_groups/index.md b/docs/awscc-docs/providers/awscc/billingconductor/billing_groups/index.md deleted file mode 100644 index 817f1bf8e8..0000000000 --- a/docs/awscc-docs/providers/awscc/billingconductor/billing_groups/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.billingconductor.billing_groups -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the billing_groups resource, the following permissions are required: - -### Create -```json -billingconductor:CreateBillingGroup, -billingconductor:AssociateAccounts, -billingconductor:ListBillingGroups, -billingconductor:TagResource, -billingconductor:ListTagsForResource -``` - -### List -```json -billingconductor:ListBillingGroups, -billingconductor:ListAccountAssociations, -organizations:ListAccounts, -billingconductor:ListTagsForResource -``` - 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 deleted file mode 100644 index cc5436b7d8..0000000000 --- a/docs/awscc-docs/providers/awscc/billingconductor/custom_line_item/index.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the custom_line_item resource, the following permissions are required: - -### Read -```json -billingconductor:ListCustomLineItems, -billingconductor:ListCustomLineItemVersions, -billingconductor:ListResourcesAssociatedToCustomLineItem, -billingconductor:ListTagsForResource -``` - -### Update -```json -billingconductor:UpdateCustomLineItem, -billingconductor:ListCustomLineItems, -billingconductor:ListResourcesAssociatedToCustomLineItem, -billingconductor:BatchAssociateResourcesToCustomLineItem, -billingconductor:BatchDisassociateResourcesFromCustomLineItem, -billingconductor:TagResource, -billingconductor:UntagResource -``` - -### Delete -```json -billingconductor:DeleteCustomLineItem, -billingconductor:ListCustomLineItems, -billingconductor:BatchDisassociateResourcesFromCustomLineItem, -billingconductor:ListResourcesAssociatedToCustomLineItem, -billingconductor:UntagResource -``` - 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 deleted file mode 100644 index 655d258593..0000000000 --- a/docs/awscc-docs/providers/awscc/billingconductor/custom_line_items/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.billingconductor.custom_line_items -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the custom_line_items resource, the following permissions are required: - -### Create -```json -billingconductor:CreateCustomLineItem, -billingconductor:BatchAssociateResourcesToCustomLineItem, -billingconductor:ListCustomLineItems, -billingconductor:TagResource, -billingconductor:ListTagsForResource -``` - -### List -```json -billingconductor:ListCustomLineItems, -billingconductor:ListResourcesAssociatedToCustomLineItem, -billingconductor:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/billingconductor/index.md b/docs/awscc-docs/providers/awscc/billingconductor/index.md deleted file mode 100644 index 9083974b9a..0000000000 --- a/docs/awscc-docs/providers/awscc/billingconductor/index.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -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 deleted file mode 100644 index 18667b43fc..0000000000 --- a/docs/awscc-docs/providers/awscc/billingconductor/pricing_plan/index.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -name, -pricing_rule_arns, -size, -description, -creation_time, -last_modified_time, -tags -FROM awscc.billingconductor.pricing_plan -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the pricing_plan resource, the following permissions are required: - -### Read -```json -billingconductor:ListPricingPlans, -billingconductor:ListPricingRulesAssociatedToPricingPlan, -billingconductor:ListTagsForResource -``` - -### Update -```json -billingconductor:ListPricingPlans, -billingconductor:UpdatePricingPlan, -billingconductor:ListPricingRulesAssociatedToPricingPlan, -billingconductor:AssociatePricingRules, -billingconductor:DisassociatePricingRules, -billingconductor:TagResource, -billingconductor:UntagResource -``` - -### Delete -```json -billingconductor:ListPricingPlans, -billingconductor:DeletePricingPlan, -billingconductor:UntagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/billingconductor/pricing_plans/index.md b/docs/awscc-docs/providers/awscc/billingconductor/pricing_plans/index.md deleted file mode 100644 index fcd96b786b..0000000000 --- a/docs/awscc-docs/providers/awscc/billingconductor/pricing_plans/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.billingconductor.pricing_plans -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the pricing_plans resource, the following permissions are required: - -### Create -```json -billingconductor:CreatePricingPlan, -billingconductor:AssociatePricingRules, -billingconductor:ListPricingPlans, -billingconductor:TagResource, -billingconductor:ListTagsForResource -``` - -### List -```json -billingconductor:ListPricingPlans, -billingconductor:ListPricingRulesAssociatedToPricingPlan, -billingconductor:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/billingconductor/pricing_rule/index.md b/docs/awscc-docs/providers/awscc/billingconductor/pricing_rule/index.md deleted file mode 100644 index 71e6e61ed9..0000000000 --- a/docs/awscc-docs/providers/awscc/billingconductor/pricing_rule/index.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the pricing_rule resource, the following permissions are required: - -### Read -```json -billingconductor:ListPricingRules, -billingconductor:ListTagsForResource -``` - -### Update -```json -billingconductor:UpdatePricingRule, -billingconductor:ListPricingRules, -billingconductor:TagResource, -billingconductor:UntagResource -``` - -### Delete -```json -billingconductor:DeletePricingRule, -billingconductor:ListPricingRules, -billingconductor:UntagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/billingconductor/pricing_rules/index.md b/docs/awscc-docs/providers/awscc/billingconductor/pricing_rules/index.md deleted file mode 100644 index 952576b0d5..0000000000 --- a/docs/awscc-docs/providers/awscc/billingconductor/pricing_rules/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.billingconductor.pricing_rules -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the pricing_rules resource, the following permissions are required: - -### Create -```json -billingconductor:CreatePricingRule, -billingconductor:ListPricingRules, -billingconductor:TagResource, -billingconductor:ListTagsForResource -``` - -### List -```json -billingconductor:ListPricingRules, -billingconductor:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/budgets/budgets_action/index.md b/docs/awscc-docs/providers/awscc/budgets/budgets_action/index.md deleted file mode 100644 index eca68974b4..0000000000 --- a/docs/awscc-docs/providers/awscc/budgets/budgets_action/index.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the budgets_action resource, the following permissions are required: - -### Read -```json -budgets:DescribeBudgetAction -``` - -### Update -```json -budgets:UpdateBudgetAction, -iam:PassRole -``` - -### Delete -```json -budgets:DeleteBudgetAction -``` - diff --git a/docs/awscc-docs/providers/awscc/budgets/budgets_actions/index.md b/docs/awscc-docs/providers/awscc/budgets/budgets_actions/index.md deleted file mode 100644 index f4cb87098f..0000000000 --- a/docs/awscc-docs/providers/awscc/budgets/budgets_actions/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -action_id, -budget_name -FROM awscc.budgets.budgets_actions -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the budgets_actions resource, the following permissions are required: - -### Create -```json -budgets:CreateBudgetAction, -iam:PassRole -``` - -### List -```json -budgets:DescribeBudgetActionsForAccount, -budgets:DescribeBudgetActionsForBudget -``` - diff --git a/docs/awscc-docs/providers/awscc/budgets/index.md b/docs/awscc-docs/providers/awscc/budgets/index.md deleted file mode 100644 index 39b930d222..0000000000 --- a/docs/awscc-docs/providers/awscc/budgets/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 deleted file mode 100644 index 543e1443bc..0000000000 --- a/docs/awscc-docs/providers/awscc/cassandra/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index 9759176cb4..0000000000 --- a/docs/awscc-docs/providers/awscc/cassandra/keyspace/index.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -keyspace_name, -tags, -replication_specification -FROM awscc.cassandra.keyspace -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the keyspace resource, the following permissions are required: - -### Read -```json -cassandra:Select, -cassandra:SelectMultiRegionResource -``` - -### Update -```json -cassandra:Alter, -cassandra:AlterMultiRegionResource, -cassandra:Select, -cassandra:SelectMultiRegionResource, -cassandra:TagResource, -cassandra:TagMultiRegionResource, -cassandra:UntagResource, -cassandra:UntagMultiRegionResource -``` - -### Delete -```json -cassandra:Drop, -cassandra:DropMultiRegionResource, -cassandra:Select, -cassandra:SelectMultiRegionResource -``` - diff --git a/docs/awscc-docs/providers/awscc/cassandra/keyspaces/index.md b/docs/awscc-docs/providers/awscc/cassandra/keyspaces/index.md deleted file mode 100644 index 958c7f1ee7..0000000000 --- a/docs/awscc-docs/providers/awscc/cassandra/keyspaces/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -keyspace_name -FROM awscc.cassandra.keyspaces -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the keyspaces resource, the following permissions are required: - -### Create -```json -cassandra:Create, -cassandra:CreateMultiRegionResource, -cassandra:Select, -cassandra:SelectMultiRegionResource, -cassandra:TagResource, -cassandra:TagMultiRegionResource, -iam:CreateServiceLinkedRole -``` - -### List -```json -cassandra:Select, -cassandra:SelectMultiRegionResource -``` - diff --git a/docs/awscc-docs/providers/awscc/cassandra/table/index.md b/docs/awscc-docs/providers/awscc/cassandra/table/index.md deleted file mode 100644 index 756628063c..0000000000 --- a/docs/awscc-docs/providers/awscc/cassandra/table/index.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the table resource, the following permissions are required: - -### Read -```json -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 -```json -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 -```json -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 -``` - diff --git a/docs/awscc-docs/providers/awscc/cassandra/tables/index.md b/docs/awscc-docs/providers/awscc/cassandra/tables/index.md deleted file mode 100644 index f580871765..0000000000 --- a/docs/awscc-docs/providers/awscc/cassandra/tables/index.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -keyspace_name, -table_name -FROM awscc.cassandra.tables -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the tables resource, the following permissions are required: - -### Create -```json -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 -```json -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 -``` - diff --git a/docs/awscc-docs/providers/awscc/ce/anomaly_monitor/index.md b/docs/awscc-docs/providers/awscc/ce/anomaly_monitor/index.md deleted file mode 100644 index 5b2b7fd6e9..0000000000 --- a/docs/awscc-docs/providers/awscc/ce/anomaly_monitor/index.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the anomaly_monitor resource, the following permissions are required: - -### Read -```json -ce:GetAnomalyMonitors -``` - -### Update -```json -ce:UpdateAnomalyMonitor -``` - -### Delete -```json -ce:DeleteAnomalyMonitor -``` - diff --git a/docs/awscc-docs/providers/awscc/ce/anomaly_monitors/index.md b/docs/awscc-docs/providers/awscc/ce/anomaly_monitors/index.md deleted file mode 100644 index 023a652790..0000000000 --- a/docs/awscc-docs/providers/awscc/ce/anomaly_monitors/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -monitor_arn -FROM awscc.ce.anomaly_monitors -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the anomaly_monitors resource, the following permissions are required: - -### Create -```json -ce:CreateAnomalyMonitor, -ce:TagResource -``` - -### List -```json -ce:GetAnomalyMonitors -``` - diff --git a/docs/awscc-docs/providers/awscc/ce/anomaly_subscription/index.md b/docs/awscc-docs/providers/awscc/ce/anomaly_subscription/index.md deleted file mode 100644 index e021fef4f5..0000000000 --- a/docs/awscc-docs/providers/awscc/ce/anomaly_subscription/index.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the anomaly_subscription resource, the following permissions are required: - -### Read -```json -ce:GetAnomalySubscriptions -``` - -### Update -```json -ce:UpdateAnomalySubscription -``` - -### Delete -```json -ce:DeleteAnomalySubscription -``` - diff --git a/docs/awscc-docs/providers/awscc/ce/anomaly_subscriptions/index.md b/docs/awscc-docs/providers/awscc/ce/anomaly_subscriptions/index.md deleted file mode 100644 index a7c3984073..0000000000 --- a/docs/awscc-docs/providers/awscc/ce/anomaly_subscriptions/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -subscription_arn -FROM awscc.ce.anomaly_subscriptions -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the anomaly_subscriptions resource, the following permissions are required: - -### Create -```json -ce:CreateAnomalySubscription, -ce:TagResource -``` - -### List -```json -ce:GetAnomalySubscriptions -``` - diff --git a/docs/awscc-docs/providers/awscc/ce/cost_categories/index.md b/docs/awscc-docs/providers/awscc/ce/cost_categories/index.md deleted file mode 100644 index ae9d496eda..0000000000 --- a/docs/awscc-docs/providers/awscc/ce/cost_categories/index.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.ce.cost_categories -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the cost_categories resource, the following permissions are required: - -### Create -```json -ce:CreateCostCategoryDefinition -``` - -### List -```json -ce:ListCostCategoryDefinitions -``` - diff --git a/docs/awscc-docs/providers/awscc/ce/cost_category/index.md b/docs/awscc-docs/providers/awscc/ce/cost_category/index.md deleted file mode 100644 index 01a8438cf6..0000000000 --- a/docs/awscc-docs/providers/awscc/ce/cost_category/index.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -effective_start, -name, -rule_version, -rules, -split_charge_rules, -default_value -FROM awscc.ce.cost_category -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the cost_category resource, the following permissions are required: - -### Read -```json -ce:DescribeCostCategoryDefinition -``` - -### Update -```json -ce:UpdateCostCategoryDefinition -``` - -### Delete -```json -ce:DeleteCostCategoryDefinition -``` - diff --git a/docs/awscc-docs/providers/awscc/ce/index.md b/docs/awscc-docs/providers/awscc/ce/index.md deleted file mode 100644 index a8159fc1d3..0000000000 --- a/docs/awscc-docs/providers/awscc/ce/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -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 deleted file mode 100644 index c7d05424b5..0000000000 --- a/docs/awscc-docs/providers/awscc/certificatemanager/account/index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -expiry_events_configuration, -account_id -FROM awscc.certificatemanager.account -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the account resource, the following permissions are required: - -### Read -```json -acm:GetAccountConfiguration -``` - -### Update -```json -acm:GetAccountConfiguration, -acm:PutAccountConfiguration -``` - -### Delete -```json -acm:GetAccountConfiguration, -acm:PutAccountConfiguration -``` - diff --git a/docs/awscc-docs/providers/awscc/certificatemanager/index.md b/docs/awscc-docs/providers/awscc/certificatemanager/index.md deleted file mode 100644 index 08d4798f2d..0000000000 --- a/docs/awscc-docs/providers/awscc/certificatemanager/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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: 1
-total selectable resources: 1
-total methods: 1
-
-
- -::: - -## Resources -
-
-account -
-
- -
-
\ 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 deleted file mode 100644 index 16f32c281e..0000000000 --- a/docs/awscc-docs/providers/awscc/chatbot/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index 8d10afe734..0000000000 --- a/docs/awscc-docs/providers/awscc/chatbot/microsoft_teams_channel_configuration/index.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the microsoft_teams_channel_configuration resource, the following permissions are required: - -### Read -```json -chatbot:GetMicrosoftTeamsChannelConfiguration -``` - -### Update -```json -chatbot:UpdateMicrosoftTeamsChannelConfiguration, -iam:PassRole -``` - -### Delete -```json -chatbot:GetMicrosoftTeamsChannelConfiguration, -chatbot:DeleteMicrosoftTeamsChannelConfiguration -``` - 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 deleted file mode 100644 index 9ffa2333e7..0000000000 --- a/docs/awscc-docs/providers/awscc/chatbot/microsoft_teams_channel_configurations/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.chatbot.microsoft_teams_channel_configurations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the microsoft_teams_channel_configurations resource, the following permissions are required: - -### Create -```json -chatbot:CreateMicrosoftTeamsChannelConfiguration, -iam:PassRole, -iam:CreateServiceLinkedRole -``` - -### List -```json -chatbot:ListMicrosoftTeamsChannelConfigurations -``` - 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 deleted file mode 100644 index fae6835208..0000000000 --- a/docs/awscc-docs/providers/awscc/chatbot/slack_channel_configuration/index.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the slack_channel_configuration resource, the following permissions are required: - -### Read -```json -chatbot:DescribeSlackChannelConfigurations -``` - -### Update -```json -chatbot:UpdateSlackChannelConfiguration, -iam:PassRole -``` - -### Delete -```json -chatbot:DeleteSlackChannelConfiguration -``` - 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 deleted file mode 100644 index 6afa52faea..0000000000 --- a/docs/awscc-docs/providers/awscc/chatbot/slack_channel_configurations/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.chatbot.slack_channel_configurations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the slack_channel_configurations resource, the following permissions are required: - -### Create -```json -chatbot:CreateSlackChannelConfiguration, -iam:PassRole, -iam:CreateServiceLinkedRole -``` - -### List -```json -chatbot:DescribeSlackChannelConfigurations -``` - diff --git a/docs/awscc-docs/providers/awscc/cleanrooms/analysis_template/index.md b/docs/awscc-docs/providers/awscc/cleanrooms/analysis_template/index.md deleted file mode 100644 index 1e701df820..0000000000 --- a/docs/awscc-docs/providers/awscc/cleanrooms/analysis_template/index.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the analysis_template resource, the following permissions are required: - -### Read -```json -cleanrooms:GetAnalysisTemplate, -cleanrooms:ListTagsForResource -``` - -### Update -```json -cleanrooms:UpdateAnalysisTemplate, -cleanrooms:GetAnalysisTemplate, -cleanrooms:ListTagsForResource, -cleanrooms:TagResource, -cleanrooms:UntagResource -``` - -### Delete -```json -cleanrooms:DeleteAnalysisTemplate, -cleanrooms:GetAnalysisTemplate, -cleanrooms:ListAnalysisTemplates, -cleanrooms:ListTagsForResource, -cleanrooms:UntagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/cleanrooms/analysis_templates/index.md b/docs/awscc-docs/providers/awscc/cleanrooms/analysis_templates/index.md deleted file mode 100644 index 500e73cc2b..0000000000 --- a/docs/awscc-docs/providers/awscc/cleanrooms/analysis_templates/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -analysis_template_identifier, -membership_identifier -FROM awscc.cleanrooms.analysis_templates -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the analysis_templates resource, the following permissions are required: - -### Create -```json -cleanrooms:CreateAnalysisTemplate, -cleanrooms:ListTagsForResource, -cleanrooms:TagResource, -cleanrooms:GetAnalysisTemplate, -cleanrooms:ListAnalysisTemplates -``` - -### List -```json -cleanrooms:ListAnalysisTemplates -``` - diff --git a/docs/awscc-docs/providers/awscc/cleanrooms/collaboration/index.md b/docs/awscc-docs/providers/awscc/cleanrooms/collaboration/index.md deleted file mode 100644 index 23013d851c..0000000000 --- a/docs/awscc-docs/providers/awscc/cleanrooms/collaboration/index.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the collaboration resource, the following permissions are required: - -### Read -```json -cleanrooms:GetCollaboration, -cleanrooms:ListMembers, -cleanrooms:ListTagsForResource -``` - -### Update -```json -cleanrooms:UpdateCollaboration, -cleanrooms:GetCollaboration, -cleanrooms:ListMembers, -cleanrooms:ListTagsForResource, -cleanrooms:TagResource, -cleanrooms:UntagResource -``` - -### Delete -```json -cleanrooms:DeleteCollaboration, -cleanrooms:GetCollaboration, -cleanrooms:ListTagsForResource, -cleanrooms:UntagResource, -cleanrooms:ListMembers, -cleanrooms:ListCollaborations -``` - diff --git a/docs/awscc-docs/providers/awscc/cleanrooms/collaborations/index.md b/docs/awscc-docs/providers/awscc/cleanrooms/collaborations/index.md deleted file mode 100644 index 732136f60c..0000000000 --- a/docs/awscc-docs/providers/awscc/cleanrooms/collaborations/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -collaboration_identifier -FROM awscc.cleanrooms.collaborations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the collaborations resource, the following permissions are required: - -### Create -```json -cleanrooms:CreateCollaboration, -cleanrooms:GetCollaboration, -cleanrooms:ListMembers, -cleanrooms:ListTagsForResource, -cleanrooms:TagResource, -cleanrooms:GetCollaboration, -cleanrooms:ListCollaborations -``` - -### List -```json -cleanrooms:ListCollaborations -``` - diff --git a/docs/awscc-docs/providers/awscc/cleanrooms/configured_table/index.md b/docs/awscc-docs/providers/awscc/cleanrooms/configured_table/index.md deleted file mode 100644 index e2d3625979..0000000000 --- a/docs/awscc-docs/providers/awscc/cleanrooms/configured_table/index.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the configured_table resource, the following permissions are required: - -### Read -```json -cleanrooms:GetConfiguredTable, -cleanrooms:GetConfiguredTableAnalysisRule, -cleanrooms:ListTagsForResource -``` - -### Update -```json -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 -```json -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 -``` - 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 deleted file mode 100644 index 3cbf8e394b..0000000000 --- a/docs/awscc-docs/providers/awscc/cleanrooms/configured_table_association/index.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the configured_table_association resource, the following permissions are required: - -### Read -```json -cleanrooms:GetConfiguredTableAssociation, -cleanrooms:ListTagsForResource -``` - -### Update -```json -cleanrooms:UpdateConfiguredTableAssociation, -cleanrooms:GetConfiguredTableAssociation, -iam:PassRole, -cleanrooms:ListTagsForResource, -cleanrooms:TagResource, -cleanrooms:UntagResource -``` - -### Delete -```json -cleanrooms:DeleteConfiguredTableAssociation, -cleanrooms:GetConfiguredTableAssociation, -cleanrooms:ListConfiguredTableAssociations, -cleanrooms:ListTagsForResource, -cleanrooms:UntagResource -``` - 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 deleted file mode 100644 index 9f4b5d03f0..0000000000 --- a/docs/awscc-docs/providers/awscc/cleanrooms/configured_table_associations/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -configured_table_association_identifier, -membership_identifier -FROM awscc.cleanrooms.configured_table_associations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the configured_table_associations resource, the following permissions are required: - -### Create -```json -cleanrooms:CreateConfiguredTableAssociation, -iam:PassRole, -cleanrooms:ListTagsForResource, -cleanrooms:TagResource, -cleanrooms:GetConfiguredTableAssociation, -cleanrooms:ListConfiguredTableAssociations -``` - -### List -```json -cleanrooms:ListConfiguredTableAssociations -``` - diff --git a/docs/awscc-docs/providers/awscc/cleanrooms/configured_tables/index.md b/docs/awscc-docs/providers/awscc/cleanrooms/configured_tables/index.md deleted file mode 100644 index d03a0fa4b8..0000000000 --- a/docs/awscc-docs/providers/awscc/cleanrooms/configured_tables/index.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -configured_table_identifier -FROM awscc.cleanrooms.configured_tables -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the configured_tables resource, the following permissions are required: - -### Create -```json -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 -```json -cleanrooms:ListConfiguredTables -``` - diff --git a/docs/awscc-docs/providers/awscc/cleanrooms/index.md b/docs/awscc-docs/providers/awscc/cleanrooms/index.md deleted file mode 100644 index 1149e657c2..0000000000 --- a/docs/awscc-docs/providers/awscc/cleanrooms/index.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -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 deleted file mode 100644 index f90fcda8db..0000000000 --- a/docs/awscc-docs/providers/awscc/cleanrooms/membership/index.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the membership resource, the following permissions are required: - -### Read -```json -cleanrooms:GetMembership, -cleanrooms:ListTagsForResource, -logs:ListLogDeliveries, -logs:DescribeLogGroups, -logs:DescribeResourcePolicies, -logs:GetLogDelivery -``` - -### Update -```json -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 -```json -cleanrooms:DeleteMembership, -cleanrooms:GetMembership, -cleanrooms:ListMemberships, -cleanrooms:ListTagsForResource, -logs:ListLogDeliveries, -logs:DescribeLogGroups, -logs:DescribeResourcePolicies, -logs:GetLogDelivery -``` - diff --git a/docs/awscc-docs/providers/awscc/cleanrooms/memberships/index.md b/docs/awscc-docs/providers/awscc/cleanrooms/memberships/index.md deleted file mode 100644 index 287aa8e733..0000000000 --- a/docs/awscc-docs/providers/awscc/cleanrooms/memberships/index.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -membership_identifier -FROM awscc.cleanrooms.memberships -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the memberships resource, the following permissions are required: - -### Create -```json -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 -```json -cleanrooms:ListMemberships -``` - diff --git a/docs/awscc-docs/providers/awscc/cloud_control/index.md b/docs/awscc-docs/providers/awscc/cloud_control/index.md deleted file mode 100644 index fd3dc14614..0000000000 --- a/docs/awscc-docs/providers/awscc/cloud_control/index.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -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 deleted file mode 100644 index 682915afff..0000000000 --- a/docs/awscc-docs/providers/awscc/cloud_control/resource/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -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 deleted file mode 100644 index e75aef99e8..0000000000 --- a/docs/awscc-docs/providers/awscc/cloud_control/resource_request/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -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 deleted file mode 100644 index 0fba39741a..0000000000 --- a/docs/awscc-docs/providers/awscc/cloud_control/resource_requests/index.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -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 deleted file mode 100644 index 6fef07717e..0000000000 --- a/docs/awscc-docs/providers/awscc/cloud_control/resources/index.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -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 deleted file mode 100644 index 45460709ff..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudformation/hook_default_version/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -type_version_arn, -type_name, -arn, -version_id -FROM awscc.cloudformation.hook_default_version -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the hook_default_version resource, the following permissions are required: - -### Read -```json -cloudformation:DescribeType -``` - -### Update -```json -cloudformation:SetTypeDefaultVersion -``` - 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 deleted file mode 100644 index 53d63b9016..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudformation/hook_default_versions/index.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.cloudformation.hook_default_versions -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the hook_default_versions resource, the following permissions are required: - -### Create -```json -cloudformation:SetTypeDefaultVersion -``` - -### List -```json -cloudformation:ListTypes -``` - 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 deleted file mode 100644 index 3ff53e3ee8..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudformation/hook_type_config/index.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -type_arn, -type_name, -configuration_arn, -configuration, -configuration_alias -FROM awscc.cloudformation.hook_type_config -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the hook_type_config resource, the following permissions are required: - -### Read -```json -cloudformation:BatchDescribeTypeConfigurations -``` - -### Update -```json -cloudformation:SetTypeConfiguration -``` - -### Delete -```json -cloudformation:SetTypeConfiguration -``` - 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 deleted file mode 100644 index 7f2c0daa93..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudformation/hook_type_configs/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -configuration_arn -FROM awscc.cloudformation.hook_type_configs -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the hook_type_configs resource, the following permissions are required: - -### Create -```json -cloudformation:SetTypeConfiguration -``` - -### List -```json -cloudformation:ListTypes, -cloudformation:BatchDescribeTypeConfigurations -``` - diff --git a/docs/awscc-docs/providers/awscc/cloudformation/hook_version/index.md b/docs/awscc-docs/providers/awscc/cloudformation/hook_version/index.md deleted file mode 100644 index e7bded46f6..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudformation/hook_version/index.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the hook_version resource, the following permissions are required: - -### Read -```json -cloudformation:DescribeType -``` - -### Delete -```json -cloudformation:DeregisterType, -cloudformation:DescribeType -``` - diff --git a/docs/awscc-docs/providers/awscc/cloudformation/hook_versions/index.md b/docs/awscc-docs/providers/awscc/cloudformation/hook_versions/index.md deleted file mode 100644 index 1cd0133483..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudformation/hook_versions/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.cloudformation.hook_versions -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the hook_versions resource, the following permissions are required: - -### Create -```json -cloudformation:DescribeType, -cloudformation:DescribeTypeRegistration, -cloudformation:RegisterType, -iam:PassRole, -s3:GetObject, -s3:ListBucket, -kms:Decrypt -``` - -### List -```json -cloudformation:ListTypes, -cloudformation:ListTypeVersions -``` - diff --git a/docs/awscc-docs/providers/awscc/cloudformation/index.md b/docs/awscc-docs/providers/awscc/cloudformation/index.md deleted file mode 100644 index e30cebce3f..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudformation/index.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -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: 23
-total selectable resources: 23
-total methods: 23
-
-
- -::: - -## 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
-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 deleted file mode 100644 index ea0f6bf1d0..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudformation/module_default_version/index.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -module_name, -version_id -FROM awscc.cloudformation.module_default_version -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the module_default_version resource, the following permissions are required: - -### Read -```json -cloudformation:DescribeType -``` - 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 deleted file mode 100644 index 528097b714..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudformation/module_default_versions/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.cloudformation.module_default_versions -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the module_default_versions resource, the following permissions are required: - -### Create -```json -cloudformation:DescribeType, -cloudformation:SetTypeDefaultVersion -``` - -### List -```json -cloudformation:ListTypes -``` - diff --git a/docs/awscc-docs/providers/awscc/cloudformation/module_version/index.md b/docs/awscc-docs/providers/awscc/cloudformation/module_version/index.md deleted file mode 100644 index 1dd7c4660a..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudformation/module_version/index.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the module_version resource, the following permissions are required: - -### Read -```json -cloudformation:DescribeType -``` - -### Delete -```json -cloudformation:DeregisterType, -cloudformation:DescribeType -``` - 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 deleted file mode 100644 index b5cc92c964..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudformation/public_type_version/index.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the public_type_version resource, the following permissions are required: - -### Read -```json -cloudformation:DescribeType, -cloudformation:DescribePublisher -``` - 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 deleted file mode 100644 index 7bea00247f..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudformation/public_type_versions/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -public_type_arn -FROM awscc.cloudformation.public_type_versions -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the public_type_versions resource, the following permissions are required: - -### Create -```json -cloudformation:TestType, -cloudformation:DescribeType, -cloudformation:PublishType, -cloudformation:DescribePublisher, -s3:GetObject, -s3:PutObject -``` - -### List -```json -cloudformation:ListTypes -``` - diff --git a/docs/awscc-docs/providers/awscc/cloudformation/publisher/index.md b/docs/awscc-docs/providers/awscc/cloudformation/publisher/index.md deleted file mode 100644 index 57c125a7d1..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudformation/publisher/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -accept_terms_and_conditions, -publisher_id, -connection_arn, -publisher_status, -publisher_profile, -identity_provider -FROM awscc.cloudformation.publisher -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the publisher resource, the following permissions are required: - -### Read -```json -cloudformation:DescribePublisher -``` - diff --git a/docs/awscc-docs/providers/awscc/cloudformation/publishers/index.md b/docs/awscc-docs/providers/awscc/cloudformation/publishers/index.md deleted file mode 100644 index 6e1857bf20..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudformation/publishers/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -publisher_id -FROM awscc.cloudformation.publishers -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the publishers resource, the following permissions are required: - -### Create -```json -cloudformation:RegisterPublisher, -cloudformation:DescribePublisher, -codestar-connections:GetConnection, -codestar-connections:UseConnection -``` - -### List -```json -cloudformation:DescribePublisher -``` - 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 deleted file mode 100644 index 820bbaaa82..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudformation/resource_default_version/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -version_id, -type_name, -arn, -type_version_arn -FROM awscc.cloudformation.resource_default_version -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the resource_default_version resource, the following permissions are required: - -### Read -```json -cloudformation:DescribeType -``` - -### Update -```json -cloudformation:SetTypeDefaultVersion -``` - -### Delete -```json - -``` - 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 deleted file mode 100644 index 34e1816b53..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudformation/resource_default_versions/index.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.cloudformation.resource_default_versions -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the resource_default_versions resource, the following permissions are required: - -### Create -```json -cloudformation:SetTypeDefaultVersion -``` - -### List -```json -cloudformation:ListTypeVersions -``` - diff --git a/docs/awscc-docs/providers/awscc/cloudformation/resource_version/index.md b/docs/awscc-docs/providers/awscc/cloudformation/resource_version/index.md deleted file mode 100644 index b642553ff6..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudformation/resource_version/index.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the resource_version resource, the following permissions are required: - -### Read -```json -cloudformation:DescribeType -``` - -### Delete -```json -cloudformation:DeregisterType, -cloudformation:DescribeType -``` - diff --git a/docs/awscc-docs/providers/awscc/cloudformation/resource_versions/index.md b/docs/awscc-docs/providers/awscc/cloudformation/resource_versions/index.md deleted file mode 100644 index 2b7ed7e1b0..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudformation/resource_versions/index.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.cloudformation.resource_versions -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the resource_versions resource, the following permissions are required: - -### Create -```json -cloudformation:DescribeTypeRegistration, -cloudformation:RegisterType, -iam:PassRole, -s3:GetObject, -s3:ListBucket, -kms:Decrypt, -cloudformation:ListTypeVersions, -cloudformation:DeregisterType, -cloudformation:DescribeType -``` - -### List -```json -cloudformation:ListTypes -``` - diff --git a/docs/awscc-docs/providers/awscc/cloudformation/stack/index.md b/docs/awscc-docs/providers/awscc/cloudformation/stack/index.md deleted file mode 100644 index 05612e1d07..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudformation/stack/index.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -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_arnstring
outputsarray
descriptionstring
disable_rollbackboolean
enable_termination_protectionboolean
notification_arnsarray
parametersobject
parent_idstring
root_idstring
change_set_idstring
stack_namestring
stack_idstring
stack_policy_bodyobject
stack_policy_urlstring
stack_statusstring
stack_status_reasonstring
tagsarray
template_bodyobject
template_urlstring
timeout_in_minutesinteger
last_update_timestring
creation_timestring
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -capabilities, -role_arn, -outputs, -description, -disable_rollback, -enable_termination_protection, -notification_arns, -parameters, -parent_id, -root_id, -change_set_id, -stack_name, -stack_id, -stack_policy_body, -stack_policy_url, -stack_status, -stack_status_reason, -tags, -template_body, -template_url, -timeout_in_minutes, -last_update_time, -creation_time -FROM awscc.cloudformation.stack -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the stack resource, the following permissions are required: - -### Update -```json -cloudformation:DescribeStacks, -cloudformation:UpdateStack, -cloudformation:UpdateTerminationProtection, -cloudformation:SetStackPolicy, -iam:PassRole -``` - -### Delete -```json -cloudformation:DescribeStacks, -cloudformation:DeleteStack -``` - -### Read -```json -cloudformation:DescribeStacks, -cloudformation:GetStackPolicy, -cloudformation:GetTemplate -``` - diff --git a/docs/awscc-docs/providers/awscc/cloudformation/stack_set/index.md b/docs/awscc-docs/providers/awscc/cloudformation/stack_set/index.md deleted file mode 100644 index 1e0697bb08..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudformation/stack_set/index.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -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_arnstringThe 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_urlstringLocation 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. - -## Example -```sql -SELECT -region, -stack_set_name, -stack_set_id, -administration_role_arn, -auto_deployment, -capabilities, -description, -execution_role_name, -operation_preferences, -stack_instances_group, -parameters, -permission_model, -tags, -template_body, -template_url, -call_as, -managed_execution -FROM awscc.cloudformation.stack_set -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the stack_set resource, the following permissions are required: - -### Read -```json -cloudformation:DescribeStackSet, -cloudformation:ListStackInstances, -cloudformation:DescribeStackInstance -``` - -### Update -```json -cloudformation:GetTemplateSummary, -cloudformation:UpdateStackSet, -cloudformation:CreateStackInstances, -cloudformation:DeleteStackInstances, -cloudformation:UpdateStackInstances, -cloudformation:DescribeStackSet, -cloudformation:DescribeStackSetOperation, -cloudformation:ListStackSetOperationResults, -cloudformation:TagResource, -cloudformation:UntagResource, -iam:PassRole -``` - -### Delete -```json -cloudformation:DeleteStackSet, -cloudformation:DeleteStackInstances, -cloudformation:DescribeStackSet, -cloudformation:DescribeStackSetOperation, -cloudformation:ListStackSetOperationResults, -cloudformation:UntagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/cloudformation/stack_sets/index.md b/docs/awscc-docs/providers/awscc/cloudformation/stack_sets/index.md deleted file mode 100644 index ed1be95fe9..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudformation/stack_sets/index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -stack_set_id -FROM awscc.cloudformation.stack_sets -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the stack_sets resource, the following permissions are required: - -### Create -```json -cloudformation:GetTemplateSummary, -cloudformation:CreateStackSet, -cloudformation:CreateStackInstances, -cloudformation:DescribeStackSetOperation, -cloudformation:ListStackSetOperationResults, -cloudformation:TagResource, -iam:PassRole -``` - -### List -```json -cloudformation:ListStackSets, -cloudformation:DescribeStackSet, -cloudformation:ListStackInstances, -cloudformation:DescribeStackInstance -``` - diff --git a/docs/awscc-docs/providers/awscc/cloudformation/stacks/index.md b/docs/awscc-docs/providers/awscc/cloudformation/stacks/index.md deleted file mode 100644 index d1341c8146..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudformation/stacks/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -stack_id -FROM awscc.cloudformation.stacks -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the stacks resource, the following permissions are required: - -### Create -```json -cloudformation:DescribeStacks, -cloudformation:CreateStack, -iam:PassRole -``` - -### List -```json -cloudformation:ListStacks -``` - diff --git a/docs/awscc-docs/providers/awscc/cloudformation/type_activation/index.md b/docs/awscc-docs/providers/awscc/cloudformation/type_activation/index.md deleted file mode 100644 index e1aa17d997..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudformation/type_activation/index.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the type_activation resource, the following permissions are required: - -### Update -```json -cloudformation:ActivateType, -cloudformation:DescribeType, -iam:PassRole -``` - -### Read -```json -cloudformation:DescribeType -``` - -### Delete -```json -cloudformation:DeactivateType, -cloudformation:DescribeType -``` - diff --git a/docs/awscc-docs/providers/awscc/cloudformation/type_activations/index.md b/docs/awscc-docs/providers/awscc/cloudformation/type_activations/index.md deleted file mode 100644 index a17b5db0fb..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudformation/type_activations/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.cloudformation.type_activations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the type_activations resource, the following permissions are required: - -### Create -```json -cloudformation:ActivateType, -cloudformation:DescribeType, -iam:PassRole -``` - -### List -```json -cloudformation:ListTypes -``` - diff --git a/docs/awscc-docs/providers/awscc/cloudfront/cache_policies/index.md b/docs/awscc-docs/providers/awscc/cloudfront/cache_policies/index.md deleted file mode 100644 index fd496dc59b..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudfront/cache_policies/index.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.cloudfront.cache_policies - -``` - -## Permissions - -To operate on the cache_policies resource, the following permissions are required: - -### Create -```json -cloudfront:CreateCachePolicy -``` - -### List -```json -cloudfront:ListCachePolicies -``` - diff --git a/docs/awscc-docs/providers/awscc/cloudfront/cache_policy/index.md b/docs/awscc-docs/providers/awscc/cloudfront/cache_policy/index.md deleted file mode 100644 index 2ab843dd15..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudfront/cache_policy/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -cache_policy_config, -id, -last_modified_time -FROM awscc.cloudfront.cache_policy -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the cache_policy resource, the following permissions are required: - -### Delete -```json -cloudfront:DeleteCachePolicy, -cloudfront:GetCachePolicy -``` - -### Read -```json -cloudfront:GetCachePolicy -``` - -### Update -```json -cloudfront:UpdateCachePolicy, -cloudfront:GetCachePolicy -``` - 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 deleted file mode 100644 index 99264400df..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudfront/cloud_front_origin_access_identities/index.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.cloudfront.cloud_front_origin_access_identities - -``` - -## Permissions - -To operate on the cloud_front_origin_access_identities resource, the following permissions are required: - -### Create -```json -cloudfront:CreateCloudFrontOriginAccessIdentity -``` - -### List -```json -cloudfront:ListCloudFrontOriginAccessIdentities -``` - 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 deleted file mode 100644 index 13bc40c38b..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudfront/cloud_front_origin_access_identity/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -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. - -## 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 = ''; -``` - -## Permissions - -To operate on the cloud_front_origin_access_identity resource, the following permissions are required: - -### Delete -```json -cloudfront:DeleteCloudFrontOriginAccessIdentity, -cloudfront:GetCloudFrontOriginAccessIdentity -``` - -### Read -```json -cloudfront:GetCloudFrontOriginAccessIdentity -``` - -### Update -```json -cloudfront:UpdateCloudFrontOriginAccessIdentity, -cloudfront:GetCloudFrontOriginAccessIdentity -``` - 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 deleted file mode 100644 index be14cc4f63..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudfront/continuous_deployment_policies/index.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.cloudfront.continuous_deployment_policies - -``` - -## Permissions - -To operate on the continuous_deployment_policies resource, the following permissions are required: - -### Create -```json -cloudfront:CreateContinuousDeploymentPolicy -``` - -### List -```json -cloudfront:ListContinuousDeploymentPolicies -``` - 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 deleted file mode 100644 index 9db4a3ca8b..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudfront/continuous_deployment_policy/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -continuous_deployment_policy_config, -id, -last_modified_time -FROM awscc.cloudfront.continuous_deployment_policy -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the continuous_deployment_policy resource, the following permissions are required: - -### Delete -```json -cloudfront:DeleteContinuousDeploymentPolicy, -cloudfront:GetContinuousDeploymentPolicy -``` - -### Read -```json -cloudfront:GetContinuousDeploymentPolicy -``` - -### Update -```json -cloudfront:UpdateContinuousDeploymentPolicy, -cloudfront:GetContinuousDeploymentPolicy -``` - diff --git a/docs/awscc-docs/providers/awscc/cloudfront/distribution/index.md b/docs/awscc-docs/providers/awscc/cloudfront/distribution/index.md deleted file mode 100644 index b12244e1c8..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudfront/distribution/index.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -distribution_config, -domain_name, -id, -tags -FROM awscc.cloudfront.distribution -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the distribution resource, the following permissions are required: - -### Delete -```json -cloudfront:DeleteDistribution, -cloudfront:GetDistribution, -cloudfront:GetDistributionConfig -``` - -### Read -```json -cloudfront:GetDistribution, -cloudfront:GetDistributionConfig -``` - -### Update -```json -cloudfront:GetDistribution, -cloudfront:GetDistributionConfig, -cloudfront:UpdateDistribution, -cloudfront:UpdateDistributionWithStagingConfig, -cloudfront:ListTagsForResource, -cloudfront:TagResource, -cloudfront:UntagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/cloudfront/distributions/index.md b/docs/awscc-docs/providers/awscc/cloudfront/distributions/index.md deleted file mode 100644 index da3517c060..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudfront/distributions/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.cloudfront.distributions - -``` - -## Permissions - -To operate on the distributions resource, the following permissions are required: - -### Create -```json -cloudfront:CreateDistribution, -cloudfront:CreateDistributionWithTags, -cloudfront:GetDistribution, -cloudfront:GetDistributionConfig, -cloudfront:TagResource -``` - -### List -```json -cloudfront:ListDistributions -``` - diff --git a/docs/awscc-docs/providers/awscc/cloudfront/function/index.md b/docs/awscc-docs/providers/awscc/cloudfront/function/index.md deleted file mode 100644 index 2ab6e9e713..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudfront/function/index.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -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_arnstring
function_codestring
function_configobject
function_metadataobject
namestring
stagestring
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -auto_publish, -function_arn, -function_code, -function_config, -function_metadata, -name, -stage -FROM awscc.cloudfront.function -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the function resource, the following permissions are required: - -### Delete -```json -cloudfront:DeleteFunction, -cloudfront:DescribeFunction -``` - -### Read -```json -cloudfront:DescribeFunction, -cloudfront:GetFunction -``` - -### Update -```json -cloudfront:UpdateFunction, -cloudfront:PublishFunction, -cloudfront:DescribeFunction -``` - diff --git a/docs/awscc-docs/providers/awscc/cloudfront/functions/index.md b/docs/awscc-docs/providers/awscc/cloudfront/functions/index.md deleted file mode 100644 index c18b79ef89..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudfront/functions/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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_arnstring
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -function_arn -FROM awscc.cloudfront.functions - -``` - -## Permissions - -To operate on the functions resource, the following permissions are required: - -### Create -```json -cloudfront:CreateFunction, -cloudfront:PublishFunction, -cloudfront:DescribeFunction -``` - -### List -```json -cloudfront:ListFunctions -``` - diff --git a/docs/awscc-docs/providers/awscc/cloudfront/index.md b/docs/awscc-docs/providers/awscc/cloudfront/index.md deleted file mode 100644 index 6214478d87..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudfront/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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: 25
-total selectable resources: 25
-total methods: 25
-
-
- -::: - -## 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
-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 deleted file mode 100644 index dcaa389bb5..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudfront/key_group/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id, -key_group_config, -last_modified_time -FROM awscc.cloudfront.key_group -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the key_group resource, the following permissions are required: - -### Delete -```json -cloudfront:DeleteKeyGroup, -cloudfront:GetKeyGroup -``` - -### Read -```json -cloudfront:GetKeyGroup -``` - -### Update -```json -cloudfront:UpdateKeyGroup, -cloudfront:GetKeyGroup -``` - diff --git a/docs/awscc-docs/providers/awscc/cloudfront/key_groups/index.md b/docs/awscc-docs/providers/awscc/cloudfront/key_groups/index.md deleted file mode 100644 index dfc2570ac1..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudfront/key_groups/index.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.cloudfront.key_groups - -``` - -## Permissions - -To operate on the key_groups resource, the following permissions are required: - -### Create -```json -cloudfront:CreateKeyGroup -``` - -### List -```json -cloudfront:ListKeyGroups -``` - 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 deleted file mode 100644 index a4d8400780..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudfront/key_value_store/index.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -id, -status, -name, -comment, -import_source -FROM awscc.cloudfront.key_value_store -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the key_value_store resource, the following permissions are required: - -### Delete -```json -cloudfront:DeleteKeyValueStore, -cloudfront:DescribeKeyValueStore -``` - -### Read -```json -cloudfront:DescribeKeyValueStore -``` - -### Update -```json -cloudfront:UpdateKeyValueStore, -cloudfront:DescribeKeyValueStore -``` - 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 deleted file mode 100644 index 374c16ed26..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudfront/key_value_stores/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.cloudfront.key_value_stores - -``` - -## Permissions - -To operate on the key_value_stores resource, the following permissions are required: - -### Create -```json -cloudfront:CreateKeyValueStore, -cloudfront:DescribeKeyValueStore, -s3:GetObject, -s3:HeadObject, -s3:GetBucketLocation -``` - -### List -```json -cloudfront:ListKeyValueStores -``` - diff --git a/docs/awscc-docs/providers/awscc/cloudfront/monitoring_subscription/index.md b/docs/awscc-docs/providers/awscc/cloudfront/monitoring_subscription/index.md deleted file mode 100644 index 43685e90ad..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudfront/monitoring_subscription/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -distribution_id, -monitoring_subscription -FROM awscc.cloudfront.monitoring_subscription -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the monitoring_subscription resource, the following permissions are required: - -### Delete -```json -cloudfront:DeleteMonitoringSubscription -``` - -### Read -```json -cloudfront:GetMonitoringSubscription -``` - 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 deleted file mode 100644 index 2a95cfe36f..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudfront/origin_access_control/index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id, -origin_access_control_config -FROM awscc.cloudfront.origin_access_control -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the origin_access_control resource, the following permissions are required: - -### Delete -```json -cloudfront:DeleteOriginAccessControl, -cloudfront:GetOriginAccessControl -``` - -### Read -```json -cloudfront:GetOriginAccessControl -``` - -### Update -```json -cloudfront:UpdateOriginAccessControl, -cloudfront:GetOriginAccessControl -``` - 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 deleted file mode 100644 index 720613b4f4..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudfront/origin_access_controls/index.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.cloudfront.origin_access_controls - -``` - -## Permissions - -To operate on the origin_access_controls resource, the following permissions are required: - -### Create -```json -cloudfront:CreateOriginAccessControl -``` - -### List -```json -cloudfront:ListOriginAccessControls -``` - 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 deleted file mode 100644 index 7c3ed4a9a3..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudfront/origin_request_policies/index.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.cloudfront.origin_request_policies - -``` - -## Permissions - -To operate on the origin_request_policies resource, the following permissions are required: - -### Create -```json -cloudfront:CreateOriginRequestPolicy -``` - -### List -```json -cloudfront:ListOriginRequestPolicies -``` - 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 deleted file mode 100644 index a61e766925..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudfront/origin_request_policy/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id, -last_modified_time, -origin_request_policy_config -FROM awscc.cloudfront.origin_request_policy -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the origin_request_policy resource, the following permissions are required: - -### Delete -```json -cloudfront:DeleteOriginRequestPolicy, -cloudfront:GetOriginRequestPolicy -``` - -### Read -```json -cloudfront:GetOriginRequestPolicy -``` - -### Update -```json -cloudfront:UpdateOriginRequestPolicy, -cloudfront:GetOriginRequestPolicy -``` - diff --git a/docs/awscc-docs/providers/awscc/cloudfront/public_key/index.md b/docs/awscc-docs/providers/awscc/cloudfront/public_key/index.md deleted file mode 100644 index ef8d226d92..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudfront/public_key/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -created_time, -id, -public_key_config -FROM awscc.cloudfront.public_key -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the public_key resource, the following permissions are required: - -### Delete -```json -cloudfront:DeletePublicKey, -cloudfront:GetPublicKey -``` - -### Read -```json -cloudfront:GetPublicKey -``` - -### Update -```json -cloudfront:UpdatePublicKey, -cloudfront:GetPublicKey -``` - diff --git a/docs/awscc-docs/providers/awscc/cloudfront/public_keys/index.md b/docs/awscc-docs/providers/awscc/cloudfront/public_keys/index.md deleted file mode 100644 index 1415598ee1..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudfront/public_keys/index.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.cloudfront.public_keys - -``` - -## Permissions - -To operate on the public_keys resource, the following permissions are required: - -### Create -```json -cloudfront:CreatePublicKey -``` - -### List -```json -cloudfront:ListPublicKeys -``` - 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 deleted file mode 100644 index 764cb4fb56..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudfront/realtime_log_config/index.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -end_points, -fields, -name, -sampling_rate -FROM awscc.cloudfront.realtime_log_config -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the realtime_log_config resource, the following permissions are required: - -### Delete -```json -cloudfront:DeleteRealtimeLogConfig, -cloudfront:GetRealtimeLogConfig -``` - -### Read -```json -cloudfront:GetRealtimeLogConfig -``` - -### Update -```json -cloudfront:UpdateRealtimeLogConfig, -cloudfront:GetRealtimeLogConfig, -iam:PassRole -``` - 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 deleted file mode 100644 index df3d16a261..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudfront/realtime_log_configs/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.cloudfront.realtime_log_configs - -``` - -## Permissions - -To operate on the realtime_log_configs resource, the following permissions are required: - -### Create -```json -cloudfront:CreateRealtimeLogConfig, -iam:PassRole -``` - -### List -```json -cloudfront:ListRealtimeLogConfigs -``` - 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 deleted file mode 100644 index 911446c947..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudfront/response_headers_policies/index.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.cloudfront.response_headers_policies - -``` - -## Permissions - -To operate on the response_headers_policies resource, the following permissions are required: - -### Create -```json -cloudfront:CreateResponseHeadersPolicy -``` - -### List -```json -cloudfront:ListResponseHeadersPolicies -``` - 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 deleted file mode 100644 index a267e0787f..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudfront/response_headers_policy/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id, -last_modified_time, -response_headers_policy_config -FROM awscc.cloudfront.response_headers_policy -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the response_headers_policy resource, the following permissions are required: - -### Delete -```json -cloudfront:DeleteResponseHeadersPolicy, -cloudfront:GetResponseHeadersPolicy -``` - -### Read -```json -cloudfront:GetResponseHeadersPolicy -``` - -### Update -```json -cloudfront:UpdateResponseHeadersPolicy, -cloudfront:GetResponseHeadersPolicy -``` - diff --git a/docs/awscc-docs/providers/awscc/cloudtrail/channel/index.md b/docs/awscc-docs/providers/awscc/cloudtrail/channel/index.md deleted file mode 100644 index 5f4b2436db..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudtrail/channel/index.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -source, -destinations, -channel_arn, -tags -FROM awscc.cloudtrail.channel -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the channel resource, the following permissions are required: - -### Read -```json -CloudTrail:GetChannel, -CloudTrail:ListChannels -``` - -### Update -```json -CloudTrail:UpdateChannel, -CloudTrail:GetChannel, -CloudTrail:AddTags, -CloudTrail:RemoveTags -``` - -### Delete -```json -CloudTrail:DeleteChannel -``` - diff --git a/docs/awscc-docs/providers/awscc/cloudtrail/channels/index.md b/docs/awscc-docs/providers/awscc/cloudtrail/channels/index.md deleted file mode 100644 index ef73f53985..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudtrail/channels/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -channel_arn -FROM awscc.cloudtrail.channels -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the channels resource, the following permissions are required: - -### Create -```json -CloudTrail:CreateChannel, -CloudTrail:AddTags -``` - -### List -```json -CloudTrail:ListChannels -``` - 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 deleted file mode 100644 index 29e14a9aac..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudtrail/event_data_store/index.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the event_data_store resource, the following permissions are required: - -### Read -```json -CloudTrail:GetEventDataStore, -CloudTrail:ListEventDataStores, -CloudTrail:GetInsightSelectors, -CloudTrail:ListTags -``` - -### Update -```json -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 -```json -CloudTrail:DeleteEventDataStore, -CloudTrail:GetEventDataStore, -CloudTrail:DisableFederation, -glue:DeleteTable, -lakeformation:DeregisterResource -``` - 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 deleted file mode 100644 index 6d0b246829..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudtrail/event_data_stores/index.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -event_data_store_arn -FROM awscc.cloudtrail.event_data_stores -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the event_data_stores resource, the following permissions are required: - -### Create -```json -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 -```json -CloudTrail:ListEventDataStores, -CloudTrail:GetEventDataStore, -CloudTrail:GetInsightSelectors, -CloudTrail:ListTags -``` - diff --git a/docs/awscc-docs/providers/awscc/cloudtrail/index.md b/docs/awscc-docs/providers/awscc/cloudtrail/index.md deleted file mode 100644 index 324d4a26bb..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudtrail/index.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -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: 7
-total selectable resources: 7
-total methods: 7
-
-
- -::: - -## Resources -
-
-channel
-channels
-event_data_store
-event_data_stores -
-
-resource_policy
-trail
-trails -
-
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/cloudtrail/resource_policy/index.md b/docs/awscc-docs/providers/awscc/cloudtrail/resource_policy/index.md deleted file mode 100644 index 481794d360..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudtrail/resource_policy/index.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -resource_arn, -resource_policy -FROM awscc.cloudtrail.resource_policy -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the resource_policy resource, the following permissions are required: - -### Read -```json -CloudTrail:GetResourcePolicy -``` - -### Update -```json -CloudTrail:PutResourcePolicy, -CloudTrail:GetResourcePolicy -``` - -### Delete -```json -CloudTrail:DeleteResourcePolicy -``` - diff --git a/docs/awscc-docs/providers/awscc/cloudtrail/trail/index.md b/docs/awscc-docs/providers/awscc/cloudtrail/trail/index.md deleted file mode 100644 index 44c36cc6bc..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudtrail/trail/index.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -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.
kms_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. - -## 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, -kms_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 data__Identifier = ''; -``` - -## Permissions - -To operate on the trail resource, the following permissions are required: - -### Read -```json -CloudTrail:GetTrail, -CloudTrail:GetTrailStatus, -CloudTrail:ListTags, -CloudTrail:GetEventSelectors, -CloudTrail:GetInsightSelectors, -CloudTrail:DescribeTrails -``` - -### Update -```json -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 -```json -CloudTrail:DeleteTrail -``` - diff --git a/docs/awscc-docs/providers/awscc/cloudtrail/trails/index.md b/docs/awscc-docs/providers/awscc/cloudtrail/trails/index.md deleted file mode 100644 index 06de56b4df..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudtrail/trails/index.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -trail_name -FROM awscc.cloudtrail.trails -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the trails resource, the following permissions are required: - -### Create -```json -CloudTrail:CreateTrail, -CloudTrail:StartLogging, -CloudTrail:AddTags, -CloudTrail:PutEventSelectors, -CloudTrail:PutInsightSelectors, -iam:GetRole, -iam:PassRole, -iam:CreateServiceLinkedRole, -organizations:DescribeOrganization, -organizations:ListAWSServiceAccessForOrganization -``` - -### List -```json -CloudTrail:ListTrails, -CloudTrail:GetTrail, -CloudTrail:GetTrailStatus, -CloudTrail:ListTags, -CloudTrail:GetEventSelectors, -CloudTrail:GetInsightSelectors, -CloudTrail:DescribeTrails -``` - diff --git a/docs/awscc-docs/providers/awscc/cloudwatch/alarm/index.md b/docs/awscc-docs/providers/awscc/cloudwatch/alarm/index.md deleted file mode 100644 index 6c74237314..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudwatch/alarm/index.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -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.
ok_actionsarrayThe 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. - -## 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, -ok_actions, -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 data__Identifier = ''; -``` - -## Permissions - -To operate on the alarm resource, the following permissions are required: - -### Update -```json -cloudwatch:PutMetricAlarm, -cloudwatch:DescribeAlarms -``` - -### Delete -```json -cloudwatch:DeleteAlarms, -cloudwatch:DescribeAlarms -``` - -### Read -```json -cloudwatch:DescribeAlarms -``` - diff --git a/docs/awscc-docs/providers/awscc/cloudwatch/alarms/index.md b/docs/awscc-docs/providers/awscc/cloudwatch/alarms/index.md deleted file mode 100644 index 2200c4e59d..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudwatch/alarms/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -alarm_name -FROM awscc.cloudwatch.alarms -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the alarms resource, the following permissions are required: - -### Create -```json -cloudwatch:PutMetricAlarm, -cloudwatch:DescribeAlarms -``` - -### List -```json -cloudwatch:DescribeAlarms -``` - diff --git a/docs/awscc-docs/providers/awscc/cloudwatch/composite_alarm/index.md b/docs/awscc-docs/providers/awscc/cloudwatch/composite_alarm/index.md deleted file mode 100644 index 9f5bbcd371..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudwatch/composite_alarm/index.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -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.
ok_actionsarrayThe 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. - -## Example -```sql -SELECT -region, -arn, -alarm_name, -alarm_rule, -alarm_description, -actions_enabled, -ok_actions, -alarm_actions, -insufficient_data_actions, -actions_suppressor, -actions_suppressor_wait_period, -actions_suppressor_extension_period -FROM awscc.cloudwatch.composite_alarm -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the composite_alarm resource, the following permissions are required: - -### Read -```json -cloudwatch:DescribeAlarms -``` - -### Update -```json -cloudwatch:DescribeAlarms, -cloudwatch:PutCompositeAlarm -``` - -### Delete -```json -cloudwatch:DescribeAlarms, -cloudwatch:DeleteAlarms -``` - diff --git a/docs/awscc-docs/providers/awscc/cloudwatch/composite_alarms/index.md b/docs/awscc-docs/providers/awscc/cloudwatch/composite_alarms/index.md deleted file mode 100644 index fcd59fafa6..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudwatch/composite_alarms/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -alarm_name -FROM awscc.cloudwatch.composite_alarms -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the composite_alarms resource, the following permissions are required: - -### Create -```json -cloudwatch:DescribeAlarms, -cloudwatch:PutCompositeAlarm -``` - -### List -```json -cloudwatch:DescribeAlarms -``` - diff --git a/docs/awscc-docs/providers/awscc/cloudwatch/index.md b/docs/awscc-docs/providers/awscc/cloudwatch/index.md deleted file mode 100644 index 8948529e54..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudwatch/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -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 deleted file mode 100644 index 268ddc687d..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudwatch/metric_stream/index.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the metric_stream resource, the following permissions are required: - -### Update -```json -cloudwatch:PutMetricStream, -cloudwatch:GetMetricStream, -cloudwatch:TagResource, -cloudwatch:UntagResource, -iam:PassRole -``` - -### Delete -```json -cloudwatch:DeleteMetricStream, -cloudwatch:GetMetricStream -``` - -### Read -```json -cloudwatch:GetMetricStream -``` - diff --git a/docs/awscc-docs/providers/awscc/cloudwatch/metric_streams/index.md b/docs/awscc-docs/providers/awscc/cloudwatch/metric_streams/index.md deleted file mode 100644 index 5f5f88cdf0..0000000000 --- a/docs/awscc-docs/providers/awscc/cloudwatch/metric_streams/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.cloudwatch.metric_streams -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the metric_streams resource, the following permissions are required: - -### Create -```json -cloudwatch:PutMetricStream, -cloudwatch:GetMetricStream, -cloudwatch:TagResource, -iam:PassRole -``` - -### List -```json -cloudwatch:ListMetricStreams -``` - diff --git a/docs/awscc-docs/providers/awscc/codeartifact/domain/index.md b/docs/awscc-docs/providers/awscc/codeartifact/domain/index.md deleted file mode 100644 index a1f13efa09..0000000000 --- a/docs/awscc-docs/providers/awscc/codeartifact/domain/index.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -domain_name, -name, -owner, -encryption_key, -permissions_policy_document, -tags, -arn -FROM awscc.codeartifact.domain -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the domain resource, the following permissions are required: - -### Read -```json -codeartifact:DescribeDomain, -codeartifact:GetDomainPermissionsPolicy, -codeartifact:ListTagsForResource -``` - -### Update -```json -codeartifact:PutDomainPermissionsPolicy, -codeartifact:DeleteDomainPermissionsPolicy, -codeartifact:GetDomainPermissionsPolicy, -codeartifact:TagResource, -codeartifact:UntagResource -``` - -### Delete -```json -codeartifact:DeleteDomain, -codeartifact:DescribeDomain -``` - diff --git a/docs/awscc-docs/providers/awscc/codeartifact/domains/index.md b/docs/awscc-docs/providers/awscc/codeartifact/domains/index.md deleted file mode 100644 index 61ea5206a8..0000000000 --- a/docs/awscc-docs/providers/awscc/codeartifact/domains/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.codeartifact.domains -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the domains resource, the following permissions are required: - -### Create -```json -codeartifact:CreateDomain, -codeartifact:DescribeDomain, -codeartifact:PutDomainPermissionsPolicy, -codeartifact:GetDomainPermissionsPolicy, -codeartifact:TagResource -``` - -### List -```json -codeartifact:ListDomains -``` - diff --git a/docs/awscc-docs/providers/awscc/codeartifact/index.md b/docs/awscc-docs/providers/awscc/codeartifact/index.md deleted file mode 100644 index 1d0259132d..0000000000 --- a/docs/awscc-docs/providers/awscc/codeartifact/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index eccdcdcdb7..0000000000 --- a/docs/awscc-docs/providers/awscc/codeartifact/repositories/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.codeartifact.repositories -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the repositories resource, the following permissions are required: - -### Create -```json -codeartifact:CreateRepository, -codeartifact:DescribeRepository, -codeartifact:PutRepositoryPermissionsPolicy, -codeartifact:AssociateExternalConnection, -codeartifact:AssociateWithDownstreamRepository, -codeartifact:TagResource -``` - -### List -```json -codeartifact:ListRepositories -``` - diff --git a/docs/awscc-docs/providers/awscc/codeartifact/repository/index.md b/docs/awscc-docs/providers/awscc/codeartifact/repository/index.md deleted file mode 100644 index 1097bb8985..0000000000 --- a/docs/awscc-docs/providers/awscc/codeartifact/repository/index.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the repository resource, the following permissions are required: - -### Read -```json -codeartifact:DescribeRepository, -codeartifact:GetRepositoryPermissionsPolicy, -codeartifact:ListTagsForResource -``` - -### Update -```json -codeartifact:PutRepositoryPermissionsPolicy, -codeartifact:DeleteRepositoryPermissionsPolicy, -codeartifact:AssociateExternalConnection, -codeartifact:DisassociateExternalConnection, -codeartifact:UpdateRepository, -codeartifact:DescribeRepository, -codeartifact:AssociateWithDownstreamRepository, -codeartifact:TagResource, -codeartifact:UntagResource -``` - -### Delete -```json -codeartifact:DeleteRepository, -codeartifact:DescribeRepository -``` - diff --git a/docs/awscc-docs/providers/awscc/codebuild/fleet/index.md b/docs/awscc-docs/providers/awscc/codebuild/fleet/index.md deleted file mode 100644 index d09dc60950..0000000000 --- a/docs/awscc-docs/providers/awscc/codebuild/fleet/index.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -base_capacity, -environment_type, -compute_type, -tags, -arn -FROM awscc.codebuild.fleet -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the fleet resource, the following permissions are required: - -### Delete -```json -codebuild:BatchGetFleets, -codebuild:DeleteFleet -``` - -### Read -```json -codebuild:BatchGetFleets -``` - -### Update -```json -codebuild:BatchGetFleets, -codebuild:UpdateFleet -``` - diff --git a/docs/awscc-docs/providers/awscc/codebuild/fleets/index.md b/docs/awscc-docs/providers/awscc/codebuild/fleets/index.md deleted file mode 100644 index 43bffe75eb..0000000000 --- a/docs/awscc-docs/providers/awscc/codebuild/fleets/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.codebuild.fleets -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the fleets resource, the following permissions are required: - -### Create -```json -codebuild:BatchGetFleets, -codebuild:CreateFleet -``` - -### List -```json -codebuild:ListFleets -``` - diff --git a/docs/awscc-docs/providers/awscc/codebuild/index.md b/docs/awscc-docs/providers/awscc/codebuild/index.md deleted file mode 100644 index 685574c9ad..0000000000 --- a/docs/awscc-docs/providers/awscc/codebuild/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 deleted file mode 100644 index f7f3729579..0000000000 --- a/docs/awscc-docs/providers/awscc/codedeploy/application/index.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -application_name, -compute_platform, -tags -FROM awscc.codedeploy.application -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the application resource, the following permissions are required: - -### Read -```json -codedeploy:GetApplication, -codedeploy:ListTagsForResource -``` - -### Delete -```json -codedeploy:GetApplication, -codedeploy:DeleteApplication -``` - -### Update -```json -codedeploy:TagResource, -codedeploy:UntagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/codedeploy/applications/index.md b/docs/awscc-docs/providers/awscc/codedeploy/applications/index.md deleted file mode 100644 index 541bda62ba..0000000000 --- a/docs/awscc-docs/providers/awscc/codedeploy/applications/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -application_name -FROM awscc.codedeploy.applications -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the applications resource, the following permissions are required: - -### Create -```json -codedeploy:CreateApplication, -codedeploy:TagResource -``` - -### List -```json -codedeploy:ListApplications -``` - diff --git a/docs/awscc-docs/providers/awscc/codedeploy/deployment_config/index.md b/docs/awscc-docs/providers/awscc/codedeploy/deployment_config/index.md deleted file mode 100644 index 9f309f3aca..0000000000 --- a/docs/awscc-docs/providers/awscc/codedeploy/deployment_config/index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -compute_platform, -deployment_config_name, -minimum_healthy_hosts, -zonal_config, -traffic_routing_config -FROM awscc.codedeploy.deployment_config -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the deployment_config resource, the following permissions are required: - -### Read -```json -codedeploy:GetDeploymentConfig -``` - -### Delete -```json -codedeploy:GetDeploymentConfig, -codedeploy:DeleteDeploymentConfig -``` - diff --git a/docs/awscc-docs/providers/awscc/codedeploy/deployment_configs/index.md b/docs/awscc-docs/providers/awscc/codedeploy/deployment_configs/index.md deleted file mode 100644 index 86ba19d137..0000000000 --- a/docs/awscc-docs/providers/awscc/codedeploy/deployment_configs/index.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -deployment_config_name -FROM awscc.codedeploy.deployment_configs -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the deployment_configs resource, the following permissions are required: - -### Create -```json -codedeploy:CreateDeploymentConfig -``` - -### List -```json -codedeploy:ListDeploymentConfigs -``` - diff --git a/docs/awscc-docs/providers/awscc/codedeploy/index.md b/docs/awscc-docs/providers/awscc/codedeploy/index.md deleted file mode 100644 index f46ec3c85d..0000000000 --- a/docs/awscc-docs/providers/awscc/codedeploy/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index 5fd0c10a34..0000000000 --- a/docs/awscc-docs/providers/awscc/codeguruprofiler/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 deleted file mode 100644 index f7e8eaca63..0000000000 --- a/docs/awscc-docs/providers/awscc/codeguruprofiler/profiling_group/index.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -profiling_group_name, -compute_platform, -agent_permissions, -anomaly_detection_notification_configuration, -arn, -tags -FROM awscc.codeguruprofiler.profiling_group -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the profiling_group resource, the following permissions are required: - -### Read -```json -codeguru-profiler:DescribeProfilingGroup, -codeguru-profiler:ListTagsForResource -``` - -### Update -```json -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 -```json -codeguru-profiler:DeleteProfilingGroup -``` - diff --git a/docs/awscc-docs/providers/awscc/codeguruprofiler/profiling_groups/index.md b/docs/awscc-docs/providers/awscc/codeguruprofiler/profiling_groups/index.md deleted file mode 100644 index e4f46f6f71..0000000000 --- a/docs/awscc-docs/providers/awscc/codeguruprofiler/profiling_groups/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -profiling_group_name -FROM awscc.codeguruprofiler.profiling_groups -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the profiling_groups resource, the following permissions are required: - -### Create -```json -sns:Publish, -codeguru-profiler:AddNotificationChannels, -codeguru-profiler:CreateProfilingGroup, -codeguru-profiler:PutPermission, -codeguru-profiler:TagResource -``` - -### List -```json -codeguru-profiler:ListProfilingGroups, -codeguru-profiler:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/codegurureviewer/index.md b/docs/awscc-docs/providers/awscc/codegurureviewer/index.md deleted file mode 100644 index da97e437ff..0000000000 --- a/docs/awscc-docs/providers/awscc/codegurureviewer/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 deleted file mode 100644 index 637d1b412d..0000000000 --- a/docs/awscc-docs/providers/awscc/codegurureviewer/repository_association/index.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -type, -owner, -bucket_name, -connection_arn, -association_arn, -tags -FROM awscc.codegurureviewer.repository_association -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the repository_association resource, the following permissions are required: - -### Read -```json -codeguru-reviewer:DescribeRepositoryAssociation, -codeguru-reviewer:ListTagsForResource -``` - -### Delete -```json -codeguru-reviewer:DescribeRepositoryAssociation, -codeguru-reviewer:DisassociateRepository, -codecommit:UntagResource, -events:DeleteRule, -events:RemoveTargets, -codestar-connections:UntagResource, -codestar-connections:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/codegurureviewer/repository_associations/index.md b/docs/awscc-docs/providers/awscc/codegurureviewer/repository_associations/index.md deleted file mode 100644 index 98db6d9ed0..0000000000 --- a/docs/awscc-docs/providers/awscc/codegurureviewer/repository_associations/index.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -association_arn -FROM awscc.codegurureviewer.repository_associations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the repository_associations resource, the following permissions are required: - -### Create -```json -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 -```json -codeguru-reviewer:ListRepositoryAssociations -``` - 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 deleted file mode 100644 index e8261fe84f..0000000000 --- a/docs/awscc-docs/providers/awscc/codepipeline/custom_action_type/index.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -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. - -## 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 data__Identifier = '||'; -``` - -## Permissions - -To operate on the custom_action_type resource, the following permissions are required: - -### Read -```json -codepipeline:ListActionTypes, -codepipeline:ListTagsForResource -``` - -### Update -```json -codepipeline:ListActionTypes, -codepipeline:TagResource, -codepipeline:UntagResource -``` - -### Delete -```json -codepipeline:DeleteCustomActionType, -codepipeline:ListActionTypes -``` - 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 deleted file mode 100644 index 2b416f4d7c..0000000000 --- a/docs/awscc-docs/providers/awscc/codepipeline/custom_action_types/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -category, -provider, -version -FROM awscc.codepipeline.custom_action_types -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the custom_action_types resource, the following permissions are required: - -### Create -```json -codepipeline:CreateCustomActionType, -codepipeline:TagResource, -codepipeline:ListActionTypes -``` - -### List -```json -codepipeline:ListActionTypes -``` - diff --git a/docs/awscc-docs/providers/awscc/codepipeline/index.md b/docs/awscc-docs/providers/awscc/codepipeline/index.md deleted file mode 100644 index 7058e3fe66..0000000000 --- a/docs/awscc-docs/providers/awscc/codepipeline/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 deleted file mode 100644 index 11dfe41804..0000000000 --- a/docs/awscc-docs/providers/awscc/codestarconnections/connection/index.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -connection_arn, -connection_name, -connection_status, -owner_account_id, -provider_type, -host_arn, -tags -FROM awscc.codestarconnections.connection -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the connection resource, the following permissions are required: - -### Read -```json -codestar-connections:GetConnection, -codestar-connections:ListTagsForResource -``` - -### Update -```json -codestar-connections:ListTagsForResource, -codestar-connections:TagResource, -codestar-connections:UntagResource -``` - -### Delete -```json -codestar-connections:DeleteConnection -``` - diff --git a/docs/awscc-docs/providers/awscc/codestarconnections/connections/index.md b/docs/awscc-docs/providers/awscc/codestarconnections/connections/index.md deleted file mode 100644 index c2512ada3c..0000000000 --- a/docs/awscc-docs/providers/awscc/codestarconnections/connections/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -connection_arn -FROM awscc.codestarconnections.connections -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the connections resource, the following permissions are required: - -### Create -```json -codestar-connections:CreateConnection, -codestar-connections:TagResource -``` - -### List -```json -codestar-connections:ListConnections, -codestar-connections:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/codestarconnections/index.md b/docs/awscc-docs/providers/awscc/codestarconnections/index.md deleted file mode 100644 index 7678e23445..0000000000 --- a/docs/awscc-docs/providers/awscc/codestarconnections/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -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 deleted file mode 100644 index 358ad83910..0000000000 --- a/docs/awscc-docs/providers/awscc/codestarconnections/repository_link/index.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the repository_link resource, the following permissions are required: - -### Update -```json -codestar-connections:GetConnection, -codestar-connections:ListTagsForResource, -codestar-connections:PassConnection, -codestar-connections:UseConnection, -codestar-connections:TagResource, -codestar-connections:UntagResource, -codestar-connections:UpdateRepositoryLink -``` - -### Read -```json -codestar-connections:GetRepositoryLink, -codestar-connections:ListTagsForResource, -codestar-connections:GetConnection -``` - -### Delete -```json -codestar-connections:GetRepositoryLink, -codestar-connections:DeleteRepositoryLink, -codestar-connections:GetConnection -``` - diff --git a/docs/awscc-docs/providers/awscc/codestarconnections/repository_links/index.md b/docs/awscc-docs/providers/awscc/codestarconnections/repository_links/index.md deleted file mode 100644 index 8467f84e5a..0000000000 --- a/docs/awscc-docs/providers/awscc/codestarconnections/repository_links/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -repository_link_arn -FROM awscc.codestarconnections.repository_links -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the repository_links resource, the following permissions are required: - -### Create -```json -codestar-connections:CreateRepositoryLink, -codestar-connections:TagResource, -codestar-connections:UseConnection, -codestar-connections:PassConnection, -codestar-connections:GetConnection, -iam:CreateServiceLinkedRole -``` - -### List -```json -codestar-connections:ListRepositoryLinks, -codestar-connections:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/codestarconnections/sync_configuration/index.md b/docs/awscc-docs/providers/awscc/codestarconnections/sync_configuration/index.md deleted file mode 100644 index 58fee928f1..0000000000 --- a/docs/awscc-docs/providers/awscc/codestarconnections/sync_configuration/index.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the sync_configuration resource, the following permissions are required: - -### Read -```json -codestar-connections:GetSyncConfiguration -``` - -### Update -```json -codestar-connections:UpdateSyncConfiguration, -codestar-connections:PassRepository, -iam:PassRole -``` - -### Delete -```json -codestar-connections:DeleteSyncConfiguration, -codestar-connections:GetSyncConfiguration -``` - diff --git a/docs/awscc-docs/providers/awscc/codestarconnections/sync_configurations/index.md b/docs/awscc-docs/providers/awscc/codestarconnections/sync_configurations/index.md deleted file mode 100644 index 1d2b6c1780..0000000000 --- a/docs/awscc-docs/providers/awscc/codestarconnections/sync_configurations/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -resource_name, -sync_type -FROM awscc.codestarconnections.sync_configurations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the sync_configurations resource, the following permissions are required: - -### Create -```json -codestar-connections:CreateSyncConfiguration, -codestar-connections:PassRepository, -iam:PassRole -``` - -### List -```json -codestar-connections:ListSyncConfigurations, -codestar-connections:ListRepositoryLinks -``` - diff --git a/docs/awscc-docs/providers/awscc/codestarnotifications/index.md b/docs/awscc-docs/providers/awscc/codestarnotifications/index.md deleted file mode 100644 index 0a57040898..0000000000 --- a/docs/awscc-docs/providers/awscc/codestarnotifications/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 deleted file mode 100644 index dce8be6862..0000000000 --- a/docs/awscc-docs/providers/awscc/codestarnotifications/notification_rule/index.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the notification_rule resource, the following permissions are required: - -### Read -```json -codestar-notifications:describeNotificationRule -``` - -### Delete -```json -codestar-notifications:deleteNotificationRule, -codestar-notifications:describeNotificationRule -``` - -### Update -```json -codestar-notifications:updateNotificationRule, -codestar-notifications:TagResource, -codestar-notifications:UntagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/codestarnotifications/notification_rules/index.md b/docs/awscc-docs/providers/awscc/codestarnotifications/notification_rules/index.md deleted file mode 100644 index 38f82359bc..0000000000 --- a/docs/awscc-docs/providers/awscc/codestarnotifications/notification_rules/index.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.codestarnotifications.notification_rules -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the notification_rules resource, the following permissions are required: - -### Create -```json -codestar-notifications:createNotificationRule -``` - -### List -```json -codestar-notifications:listNotificationRules -``` - diff --git a/docs/awscc-docs/providers/awscc/cognito/identity_pool/index.md b/docs/awscc-docs/providers/awscc/cognito/identity_pool/index.md deleted file mode 100644 index 9db52b68c9..0000000000 --- a/docs/awscc-docs/providers/awscc/cognito/identity_pool/index.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -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_arnsarray
open_id_connect_provider_arnsarray
allow_classic_flowboolean
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## 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_arns, -open_id_connect_provider_arns, -allow_classic_flow -FROM awscc.cognito.identity_pool -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the identity_pool resource, the following permissions are required: - -### Read -```json -cognito-identity:DescribeIdentityPool -``` - -### Update -```json -cognito-identity:UpdateIdentityPool, -cognito-identity:DescribeIdentityPool, -cognito-sync:SetIdentityPoolConfiguration, -cognito-sync:SetCognitoEvents, -iam:PassRole -``` - -### Delete -```json -cognito-identity:DeleteIdentityPool -``` - 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 deleted file mode 100644 index ee537fb38b..0000000000 --- a/docs/awscc-docs/providers/awscc/cognito/identity_pool_principal_tag/index.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -identity_pool_id, -identity_provider_name, -use_defaults, -principal_tags -FROM awscc.cognito.identity_pool_principal_tag -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the identity_pool_principal_tag resource, the following permissions are required: - -### Read -```json -cognito-identity:GetPrincipalTagAttributeMap -``` - -### Update -```json -cognito-identity:GetPrincipalTagAttributeMap, -cognito-identity:SetPrincipalTagAttributeMap -``` - -### Delete -```json -cognito-identity:GetPrincipalTagAttributeMap, -cognito-identity:SetPrincipalTagAttributeMap -``` - 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 deleted file mode 100644 index e511d8d92d..0000000000 --- a/docs/awscc-docs/providers/awscc/cognito/identity_pool_principal_tags/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -identity_pool_id, -identity_provider_name -FROM awscc.cognito.identity_pool_principal_tags -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the identity_pool_principal_tags resource, the following permissions are required: - -### Create -```json -cognito-identity:GetPrincipalTagAttributeMap, -cognito-identity:SetPrincipalTagAttributeMap -``` - -### List -```json -cognito-identity:GetPrincipalTagAttributeMap -``` - 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 deleted file mode 100644 index d1e82a9b88..0000000000 --- a/docs/awscc-docs/providers/awscc/cognito/identity_pool_role_attachment/index.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -identity_pool_id, -roles, -id, -role_mappings -FROM awscc.cognito.identity_pool_role_attachment -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the identity_pool_role_attachment resource, the following permissions are required: - -### Read -```json -cognito-identity:GetIdentityPoolRoles -``` - -### Update -```json -cognito-identity:GetIdentityPoolRoles, -cognito-identity:SetIdentityPoolRoles, -iam:PassRole -``` - -### Delete -```json -cognito-identity:GetIdentityPoolRoles, -cognito-identity:SetIdentityPoolRoles -``` - 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 deleted file mode 100644 index 1931b1fff2..0000000000 --- a/docs/awscc-docs/providers/awscc/cognito/identity_pool_role_attachments/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.cognito.identity_pool_role_attachments -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the identity_pool_role_attachments resource, the following permissions are required: - -### Create -```json -cognito-identity:GetIdentityPoolRoles, -cognito-identity:SetIdentityPoolRoles, -iam:PassRole -``` - -### List -```json -cognito-identity:GetIdentityPoolRoles -``` - diff --git a/docs/awscc-docs/providers/awscc/cognito/identity_pools/index.md b/docs/awscc-docs/providers/awscc/cognito/identity_pools/index.md deleted file mode 100644 index 1ffffcdd73..0000000000 --- a/docs/awscc-docs/providers/awscc/cognito/identity_pools/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.cognito.identity_pools -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the identity_pools resource, the following permissions are required: - -### Create -```json -cognito-identity:CreateIdentityPool, -cognito-sync:SetIdentityPoolConfiguration, -cognito-sync:SetCognitoEvents, -iam:PassRole -``` - -### List -```json -cognito-identity:ListIdentityPools -``` - diff --git a/docs/awscc-docs/providers/awscc/cognito/index.md b/docs/awscc-docs/providers/awscc/cognito/index.md deleted file mode 100644 index d5a5951349..0000000000 --- a/docs/awscc-docs/providers/awscc/cognito/index.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -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: 17
-total selectable resources: 17
-total methods: 17
-
-
- -::: - -## Resources -
-
-identity_pool
-identity_pool_principal_tag
-identity_pool_principal_tags
-identity_pool_role_attachment
-identity_pool_role_attachments
-identity_pools
-log_delivery_configuration
-user_pool
-user_pool_client -
-
-user_pool_clients
-user_pool_group
-user_pool_groups
-user_pool_risk_configuration_attachment
-user_pool_user
-user_pool_user_to_group_attachment
-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 deleted file mode 100644 index a86b908c60..0000000000 --- a/docs/awscc-docs/providers/awscc/cognito/log_delivery_configuration/index.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id, -user_pool_id, -log_configurations -FROM awscc.cognito.log_delivery_configuration -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the log_delivery_configuration resource, the following permissions are required: - -### Read -```json -cognito-idp:GetLogDeliveryConfiguration -``` - -### Update -```json -cognito-idp:GetLogDeliveryConfiguration, -cognito-idp:SetLogDeliveryConfiguration, -logs:CreateLogDelivery, -logs:GetLogDelivery, -logs:UpdateLogDelivery, -logs:DeleteLogDelivery, -logs:ListLogDeliveries, -logs:PutResourcePolicy, -logs:DescribeResourcePolicies, -logs:DescribeLogGroups -``` - -### Delete -```json -cognito-idp:GetLogDeliveryConfiguration, -cognito-idp:SetLogDeliveryConfiguration, -logs:CreateLogDelivery, -logs:GetLogDelivery, -logs:UpdateLogDelivery, -logs:DeleteLogDelivery, -logs:ListLogDeliveries, -logs:PutResourcePolicy, -logs:DescribeResourcePolicies, -logs:DescribeLogGroups -``` - diff --git a/docs/awscc-docs/providers/awscc/cognito/user_pool/index.md b/docs/awscc-docs/providers/awscc/cognito/user_pool/index.md deleted file mode 100644 index 5f927afc6a..0000000000 --- a/docs/awscc-docs/providers/awscc/cognito/user_pool/index.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -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_urlstring
arnstring
user_pool_idstring
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## 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_url, -arn, -user_pool_id -FROM awscc.cognito.user_pool -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the user_pool resource, the following permissions are required: - -### Read -```json -cognito-idp:DescribeUserPool -``` - -### Update -```json -cognito-idp:UpdateUserPool, -cognito-idp:ListTagsForResource, -cognito-idp:UntagResource, -cognito-idp:TagResource, -cognito-idp:SetUserPoolMfaConfig, -cognito-idp:AddCustomAttributes, -cognito-idp:DescribeUserPool, -iam:PassRole -``` - -### Delete -```json -cognito-idp:DeleteUserPool -``` - 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 deleted file mode 100644 index d80927037f..0000000000 --- a/docs/awscc-docs/providers/awscc/cognito/user_pool_client/index.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -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_urlsarray
default_redirect_uristring
logout_urlsarray
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. - -## 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_urls, -default_redirect_uri, -logout_urls, -supported_identity_providers, -analytics_configuration, -prevent_user_existence_errors, -enable_token_revocation, -enable_propagate_additional_user_context_data, -name, -client_secret, -client_id -FROM awscc.cognito.user_pool_client -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the user_pool_client resource, the following permissions are required: - -### Read -```json -cognito-idp:DescribeUserPoolClient -``` - -### Update -```json -cognito-idp:UpdateUserPoolClient, -iam:PassRole, -iam:PutRolePolicy -``` - -### Delete -```json -cognito-idp:DeleteUserPoolClient, -iam:PutRolePolicy, -iam:DeleteRolePolicy -``` - 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 deleted file mode 100644 index 6ce08a95f4..0000000000 --- a/docs/awscc-docs/providers/awscc/cognito/user_pool_clients/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -user_pool_id, -client_id -FROM awscc.cognito.user_pool_clients -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the user_pool_clients resource, the following permissions are required: - -### Create -```json -cognito-idp:CreateUserPoolClient, -iam:PassRole, -iam:PutRolePolicy, -iam:CreateServiceLinkedRole -``` - -### List -```json -cognito-idp:ListUserPoolClients -``` - 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 deleted file mode 100644 index a8d747f38d..0000000000 --- a/docs/awscc-docs/providers/awscc/cognito/user_pool_group/index.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -description, -group_name, -precedence, -role_arn, -user_pool_id -FROM awscc.cognito.user_pool_group -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the user_pool_group resource, the following permissions are required: - -### Read -```json -cognito-idp:GetGroup -``` - -### Update -```json -cognito-idp:UpdateGroup, -iam:PassRole, -iam:PutRolePolicy -``` - -### Delete -```json -cognito-idp:DeleteGroup, -cognito-idp:GetGroup, -iam:PutRolePolicy -``` - 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 deleted file mode 100644 index f731cad360..0000000000 --- a/docs/awscc-docs/providers/awscc/cognito/user_pool_groups/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -user_pool_id, -group_name -FROM awscc.cognito.user_pool_groups -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the user_pool_groups resource, the following permissions are required: - -### Create -```json -cognito-idp:CreateGroup, -iam:PassRole, -iam:PutRolePolicy, -cognito-idp:GetGroup -``` - -### List -```json -cognito-idp:ListGroups -``` - 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 deleted file mode 100644 index a92fae0f25..0000000000 --- a/docs/awscc-docs/providers/awscc/cognito/user_pool_risk_configuration_attachment/index.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the user_pool_risk_configuration_attachment resource, the following permissions are required: - -### Read -```json -cognito-idp:DescribeRiskConfiguration -``` - -### Update -```json -cognito-idp:SetRiskConfiguration, -cognito-idp:DescribeRiskConfiguration, -iam:PassRole -``` - -### Delete -```json -cognito-idp:SetRiskConfiguration, -cognito-idp:DescribeRiskConfiguration -``` - 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 deleted file mode 100644 index 4d838e7e52..0000000000 --- a/docs/awscc-docs/providers/awscc/cognito/user_pool_user/index.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the user_pool_user resource, the following permissions are required: - -### Read -```json -cognito-idp:AdminGetUser -``` - -### Delete -```json -cognito-idp:AdminDeleteUser -``` - 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 deleted file mode 100644 index 1fedb06e6a..0000000000 --- a/docs/awscc-docs/providers/awscc/cognito/user_pool_user_to_group_attachment/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -user_pool_id, -username, -group_name -FROM awscc.cognito.user_pool_user_to_group_attachment -WHERE data__Identifier = '||'; -``` - -## Permissions - -To operate on the user_pool_user_to_group_attachment resource, the following permissions are required: - -### Delete -```json -cognito-idp:AdminRemoveUserFromGroup, -cognito-idp:AdminListGroupsForUser -``` - -### Read -```json -cognito-idp:AdminListGroupsForUser -``` - 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 deleted file mode 100644 index 5a8ec0cf50..0000000000 --- a/docs/awscc-docs/providers/awscc/cognito/user_pool_users/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -user_pool_id, -username -FROM awscc.cognito.user_pool_users -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the user_pool_users resource, the following permissions are required: - -### Create -```json -cognito-idp:AdminCreateUser, -cognito-idp:AdminGetUser, -iam:PassRole -``` - -### List -```json -cognito-idp:ListUsers -``` - diff --git a/docs/awscc-docs/providers/awscc/cognito/user_pools/index.md b/docs/awscc-docs/providers/awscc/cognito/user_pools/index.md deleted file mode 100644 index 5f54d74339..0000000000 --- a/docs/awscc-docs/providers/awscc/cognito/user_pools/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -user_pool_id -FROM awscc.cognito.user_pools -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the user_pools resource, the following permissions are required: - -### Create -```json -cognito-idp:CreateUserPool, -iam:PassRole, -cognito-idp:SetUserPoolMfaConfig, -cognito-idp:DescribeUserPool, -kms:CreateGrant, -iam:CreateServiceLinkedRole -``` - -### List -```json -cognito-idp:ListUserPools -``` - diff --git a/docs/awscc-docs/providers/awscc/comprehend/document_classifier/index.md b/docs/awscc-docs/providers/awscc/comprehend/document_classifier/index.md deleted file mode 100644 index 7af273a09b..0000000000 --- a/docs/awscc-docs/providers/awscc/comprehend/document_classifier/index.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the document_classifier resource, the following permissions are required: - -### Read -```json -comprehend:DescribeDocumentClassifier, -comprehend:DescribeResourcePolicy, -comprehend:ListTagsForResource -``` - -### Update -```json -iam:PassRole, -comprehend:PutResourcePolicy, -comprehend:DeleteResourcePolicy, -comprehend:DescribeResourcePolicy, -comprehend:DescribeDocumentClassifier, -comprehend:ListTagsForResource, -comprehend:TagResource, -comprehend:UntagResource -``` - -### Delete -```json -comprehend:DescribeDocumentClassifier, -comprehend:DeleteDocumentClassifier -``` - diff --git a/docs/awscc-docs/providers/awscc/comprehend/document_classifiers/index.md b/docs/awscc-docs/providers/awscc/comprehend/document_classifiers/index.md deleted file mode 100644 index 98f988f3c6..0000000000 --- a/docs/awscc-docs/providers/awscc/comprehend/document_classifiers/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.comprehend.document_classifiers -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the document_classifiers resource, the following permissions are required: - -### Create -```json -iam:PassRole, -comprehend:CreateDocumentClassifier, -comprehend:DescribeDocumentClassifier, -comprehend:DescribeResourcePolicy, -comprehend:ListTagsForResource, -textract:DetectDocumentText -``` - -### List -```json -comprehend:ListDocumentClassifiers -``` - diff --git a/docs/awscc-docs/providers/awscc/comprehend/flywheel/index.md b/docs/awscc-docs/providers/awscc/comprehend/flywheel/index.md deleted file mode 100644 index 44c1e05ca9..0000000000 --- a/docs/awscc-docs/providers/awscc/comprehend/flywheel/index.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the flywheel resource, the following permissions are required: - -### Read -```json -comprehend:DescribeFlywheel, -comprehend:ListTagsForResource -``` - -### Update -```json -iam:PassRole, -comprehend:DescribeFlywheel, -comprehend:UpdateFlywheel, -comprehend:ListTagsForResource, -comprehend:TagResource, -comprehend:UntagResource -``` - -### Delete -```json -comprehend:DeleteFlywheel, -comprehend:DescribeFlywheel -``` - diff --git a/docs/awscc-docs/providers/awscc/comprehend/flywheels/index.md b/docs/awscc-docs/providers/awscc/comprehend/flywheels/index.md deleted file mode 100644 index 2f18d0cd9b..0000000000 --- a/docs/awscc-docs/providers/awscc/comprehend/flywheels/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.comprehend.flywheels -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the flywheels resource, the following permissions are required: - -### Create -```json -iam:PassRole, -comprehend:CreateFlywheel, -comprehend:DescribeFlywheel, -comprehend:ListTagsForResource -``` - -### List -```json -comprehend:ListFlywheels -``` - diff --git a/docs/awscc-docs/providers/awscc/comprehend/index.md b/docs/awscc-docs/providers/awscc/comprehend/index.md deleted file mode 100644 index bd99662060..0000000000 --- a/docs/awscc-docs/providers/awscc/comprehend/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index 6dee6e1012..0000000000 --- a/docs/awscc-docs/providers/awscc/config/aggregation_authorization/index.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -authorized_account_id, -authorized_aws_region, -aggregation_authorization_arn, -tags -FROM awscc.config.aggregation_authorization -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the aggregation_authorization resource, the following permissions are required: - -### Update -```json -config:DescribeAggregationAuthorizations, -config:TagResource, -config:UntagResource, -config:ListTagsForResource -``` - -### Read -```json -config:DescribeAggregationAuthorizations, -config:ListTagsForResource -``` - -### Delete -```json -config:DescribeAggregationAuthorizations, -config:DeleteAggregationAuthorization, -config:UntagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/config/aggregation_authorizations/index.md b/docs/awscc-docs/providers/awscc/config/aggregation_authorizations/index.md deleted file mode 100644 index b51265e7fc..0000000000 --- a/docs/awscc-docs/providers/awscc/config/aggregation_authorizations/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -authorized_account_id, -authorized_aws_region -FROM awscc.config.aggregation_authorizations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the aggregation_authorizations resource, the following permissions are required: - -### Create -```json -config:DescribeAggregationAuthorizations, -config:PutAggregationAuthorization, -config:TagResource -``` - -### List -```json -config:DescribeAggregationAuthorizations -``` - diff --git a/docs/awscc-docs/providers/awscc/config/config_rule/index.md b/docs/awscc-docs/providers/awscc/config/config_rule/index.md deleted file mode 100644 index 9213c3a096..0000000000 --- a/docs/awscc-docs/providers/awscc/config/config_rule/index.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the config_rule resource, the following permissions are required: - -### Read -```json -config:DescribeConfigRules, -config:DescribeComplianceByConfigRule -``` - -### Delete -```json -config:DeleteConfigRule, -config:DescribeConfigRules -``` - -### Update -```json -config:PutConfigRule, -config:DescribeConfigRules -``` - diff --git a/docs/awscc-docs/providers/awscc/config/config_rules/index.md b/docs/awscc-docs/providers/awscc/config/config_rules/index.md deleted file mode 100644 index c2174c3a3e..0000000000 --- a/docs/awscc-docs/providers/awscc/config/config_rules/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -config_rule_name -FROM awscc.config.config_rules -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the config_rules resource, the following permissions are required: - -### Create -```json -config:PutConfigRule, -config:DescribeConfigRules -``` - -### List -```json -config:DescribeConfigRules -``` - diff --git a/docs/awscc-docs/providers/awscc/config/configuration_aggregator/index.md b/docs/awscc-docs/providers/awscc/config/configuration_aggregator/index.md deleted file mode 100644 index 704bd9cae4..0000000000 --- a/docs/awscc-docs/providers/awscc/config/configuration_aggregator/index.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -account_aggregation_sources, -configuration_aggregator_name, -configuration_aggregator_arn, -organization_aggregation_source, -tags -FROM awscc.config.configuration_aggregator -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the configuration_aggregator resource, the following permissions are required: - -### Read -```json -config:DescribeConfigurationAggregators, -config:ListTagsForResource -``` - -### Update -```json -config:PutConfigurationAggregator, -config:DescribeConfigurationAggregators, -config:TagResource, -config:UntagResource, -config:ListTagsForResource, -iam:PassRole, -organizations:EnableAWSServiceAccess, -organizations:ListDelegatedAdministrators -``` - -### Delete -```json -config:DeleteConfigurationAggregator, -config:UntagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/config/configuration_aggregators/index.md b/docs/awscc-docs/providers/awscc/config/configuration_aggregators/index.md deleted file mode 100644 index 44ae57f2d8..0000000000 --- a/docs/awscc-docs/providers/awscc/config/configuration_aggregators/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -configuration_aggregator_name -FROM awscc.config.configuration_aggregators -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the configuration_aggregators resource, the following permissions are required: - -### Create -```json -config:PutConfigurationAggregator, -config:DescribeConfigurationAggregators, -config:TagResource, -iam:PassRole, -organizations:EnableAWSServiceAccess, -organizations:ListDelegatedAdministrators -``` - -### List -```json -config:DescribeConfigurationAggregators -``` - diff --git a/docs/awscc-docs/providers/awscc/config/conformance_pack/index.md b/docs/awscc-docs/providers/awscc/config/conformance_pack/index.md deleted file mode 100644 index 5c8af7307d..0000000000 --- a/docs/awscc-docs/providers/awscc/config/conformance_pack/index.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -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_ssm_document_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. - -## Example -```sql -SELECT -region, -conformance_pack_name, -delivery_s3_bucket, -delivery_s3_key_prefix, -template_body, -template_s3_uri, -template_ssm_document_details, -conformance_pack_input_parameters -FROM awscc.config.conformance_pack -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the conformance_pack resource, the following permissions are required: - -### Read -```json -config:DescribeConformancePacks -``` - -### Update -```json -config:PutConformancePack, -config:DescribeConformancePackStatus, -s3:GetObject, -s3:GetBucketAcl, -iam:CreateServiceLinkedRole, -iam:PassRole -``` - -### Delete -```json -config:DeleteConformancePack, -config:DescribeConformancePackStatus -``` - diff --git a/docs/awscc-docs/providers/awscc/config/conformance_packs/index.md b/docs/awscc-docs/providers/awscc/config/conformance_packs/index.md deleted file mode 100644 index 03b03c9639..0000000000 --- a/docs/awscc-docs/providers/awscc/config/conformance_packs/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -conformance_pack_name -FROM awscc.config.conformance_packs -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the conformance_packs resource, the following permissions are required: - -### Create -```json -config:PutConformancePack, -config:DescribeConformancePackStatus, -config:DescribeConformancePacks, -s3:GetObject, -s3:GetBucketAcl, -iam:CreateServiceLinkedRole, -iam:PassRole -``` - -### List -```json -config:DescribeConformancePacks -``` - diff --git a/docs/awscc-docs/providers/awscc/config/index.md b/docs/awscc-docs/providers/awscc/config/index.md deleted file mode 100644 index 0a6e09afad..0000000000 --- a/docs/awscc-docs/providers/awscc/config/index.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -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 deleted file mode 100644 index c663dd2196..0000000000 --- a/docs/awscc-docs/providers/awscc/config/organization_conformance_pack/index.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the organization_conformance_pack resource, the following permissions are required: - -### Read -```json -config:DescribeOrganizationConformancePacks -``` - -### Delete -```json -config:DeleteOrganizationConformancePack, -config:DescribeOrganizationConformancePackStatuses, -config:GetOrganizationConformancePackDetailedStatus, -organizations:ListDelegatedAdministrators -``` - -### Update -```json -config:PutOrganizationConformancePack, -config:DescribeOrganizationConformancePackStatuses, -config:GetOrganizationConformancePackDetailedStatus, -s3:GetObject, -s3:GetBucketAcl, -iam:CreateServiceLinkedRole, -iam:PassRole, -organizations:ListDelegatedAdministrators, -organizations:EnableAWSServiceAccess -``` - 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 deleted file mode 100644 index d0f56237d1..0000000000 --- a/docs/awscc-docs/providers/awscc/config/organization_conformance_packs/index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -organization_conformance_pack_name -FROM awscc.config.organization_conformance_packs -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the organization_conformance_packs resource, the following permissions are required: - -### Create -```json -config:PutOrganizationConformancePack, -config:DescribeOrganizationConformancePackStatuses, -config:GetOrganizationConformancePackDetailedStatus, -config:DescribeOrganizationConformancePacks, -s3:GetObject, -s3:GetBucketAcl, -iam:CreateServiceLinkedRole, -iam:PassRole, -organizations:ListDelegatedAdministrators, -organizations:EnableAWSServiceAccess -``` - -### List -```json -config:DescribeOrganizationConformancePacks -``` - diff --git a/docs/awscc-docs/providers/awscc/config/stored_queries/index.md b/docs/awscc-docs/providers/awscc/config/stored_queries/index.md deleted file mode 100644 index 6d1de05642..0000000000 --- a/docs/awscc-docs/providers/awscc/config/stored_queries/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -query_name -FROM awscc.config.stored_queries -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the stored_queries resource, the following permissions are required: - -### Create -```json -config:PutStoredQuery, -config:GetStoredQuery, -config:TagResource -``` - -### List -```json -config:ListStoredQueries -``` - diff --git a/docs/awscc-docs/providers/awscc/config/stored_query/index.md b/docs/awscc-docs/providers/awscc/config/stored_query/index.md deleted file mode 100644 index c67b84c990..0000000000 --- a/docs/awscc-docs/providers/awscc/config/stored_query/index.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -query_arn, -query_id, -query_name, -query_description, -query_expression, -tags -FROM awscc.config.stored_query -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the stored_query resource, the following permissions are required: - -### Read -```json -config:GetStoredQuery, -config:ListTagsForResource -``` - -### Update -```json -config:PutStoredQuery, -config:GetStoredQuery, -config:TagResource, -config:UntagResource, -config:ListTagsForResource -``` - -### Delete -```json -config:DeleteStoredQuery, -config:UntagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/connect/approved_origin/index.md b/docs/awscc-docs/providers/awscc/connect/approved_origin/index.md deleted file mode 100644 index 476323e6be..0000000000 --- a/docs/awscc-docs/providers/awscc/connect/approved_origin/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -origin, -instance_id -FROM awscc.connect.approved_origin -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the approved_origin resource, the following permissions are required: - -### Read -```json -connect:ListApprovedOrigins -``` - -### Delete -```json -connect:DisassociateApprovedOrigin, -connect:ListApprovedOrigins -``` - diff --git a/docs/awscc-docs/providers/awscc/connect/approved_origins/index.md b/docs/awscc-docs/providers/awscc/connect/approved_origins/index.md deleted file mode 100644 index 82a33c038e..0000000000 --- a/docs/awscc-docs/providers/awscc/connect/approved_origins/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -instance_id, -origin -FROM awscc.connect.approved_origins -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the approved_origins resource, the following permissions are required: - -### Create -```json -connect:AssociateApprovedOrigin, -connect:ListApprovedOrigins -``` - -### List -```json -connect:ListApprovedOrigins -``` - diff --git a/docs/awscc-docs/providers/awscc/connect/contact_flow/index.md b/docs/awscc-docs/providers/awscc/connect/contact_flow/index.md deleted file mode 100644 index 8acf0c5398..0000000000 --- a/docs/awscc-docs/providers/awscc/connect/contact_flow/index.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -instance_arn, -contact_flow_arn, -name, -content, -description, -state, -type, -tags -FROM awscc.connect.contact_flow -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the contact_flow resource, the following permissions are required: - -### Read -```json -connect:DescribeContactFlow -``` - -### Delete -```json -connect:DeleteContactFlow, -connect:UntagResource -``` - -### Update -```json -connect:UpdateContactFlowMetadata, -connect:UpdateContactFlowContent, -connect:TagResource, -connect:UntagResource -``` - 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 deleted file mode 100644 index 38dbecda45..0000000000 --- a/docs/awscc-docs/providers/awscc/connect/contact_flow_module/index.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -instance_arn, -contact_flow_module_arn, -name, -content, -description, -state, -status, -tags -FROM awscc.connect.contact_flow_module -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the contact_flow_module resource, the following permissions are required: - -### Read -```json -connect:DescribeContactFlowModule -``` - -### Delete -```json -connect:DeleteContactFlowModule, -connect:UntagResource -``` - -### Update -```json -connect:UpdateContactFlowModuleMetadata, -connect:UpdateContactFlowModuleContent, -connect:TagResource, -connect:UntagResource -``` - 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 deleted file mode 100644 index 60d0ac2d98..0000000000 --- a/docs/awscc-docs/providers/awscc/connect/contact_flow_modules/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -contact_flow_module_arn -FROM awscc.connect.contact_flow_modules -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the contact_flow_modules resource, the following permissions are required: - -### Create -```json -connect:CreateContactFlowModule, -connect:TagResource -``` - -### List -```json -connect:ListContactFlowModules -``` - diff --git a/docs/awscc-docs/providers/awscc/connect/contact_flows/index.md b/docs/awscc-docs/providers/awscc/connect/contact_flows/index.md deleted file mode 100644 index a18672791e..0000000000 --- a/docs/awscc-docs/providers/awscc/connect/contact_flows/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -contact_flow_arn -FROM awscc.connect.contact_flows -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the contact_flows resource, the following permissions are required: - -### Create -```json -connect:CreateContactFlow, -connect:TagResource -``` - -### List -```json -connect:ListContactFlows -``` - diff --git a/docs/awscc-docs/providers/awscc/connect/evaluation_form/index.md b/docs/awscc-docs/providers/awscc/connect/evaluation_form/index.md deleted file mode 100644 index 275fc1c23b..0000000000 --- a/docs/awscc-docs/providers/awscc/connect/evaluation_form/index.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -title, -description, -evaluation_form_arn, -instance_arn, -items, -scoring_strategy, -status, -tags -FROM awscc.connect.evaluation_form -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the evaluation_form resource, the following permissions are required: - -### Read -```json -connect:DescribeEvaluationForm, -connect:ListEvaluationFormVersions -``` - -### Update -```json -connect:UpdateEvaluationForm, -connect:ListEvaluationFormVersions, -connect:ActivateEvaluationForm, -connect:DeactivateEvaluationForm, -connect:TagResource, -connect:UntagResource -``` - -### Delete -```json -connect:DeleteEvaluationForm, -connect:UntagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/connect/evaluation_forms/index.md b/docs/awscc-docs/providers/awscc/connect/evaluation_forms/index.md deleted file mode 100644 index 6dc8255799..0000000000 --- a/docs/awscc-docs/providers/awscc/connect/evaluation_forms/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -evaluation_form_arn -FROM awscc.connect.evaluation_forms -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the evaluation_forms resource, the following permissions are required: - -### Create -```json -connect:CreateEvaluationForm, -connect:ActivateEvaluationForm, -connect:TagResource -``` - -### List -```json -connect:ListEvaluationForms -``` - 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 deleted file mode 100644 index 671074b571..0000000000 --- a/docs/awscc-docs/providers/awscc/connect/hours_of_operation/index.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -instance_arn, -name, -description, -time_zone, -config, -hours_of_operation_arn, -tags -FROM awscc.connect.hours_of_operation -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the hours_of_operation resource, the following permissions are required: - -### Read -```json -connect:DescribeHoursOfOperation -``` - -### Delete -```json -connect:DeleteHoursOfOperation, -connect:UntagResource -``` - -### Update -```json -connect:UpdateHoursOfOperation, -connect:TagResource, -connect:UntagResource -``` - 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 deleted file mode 100644 index 018f5d1426..0000000000 --- a/docs/awscc-docs/providers/awscc/connect/hours_of_operations/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -hours_of_operation_arn -FROM awscc.connect.hours_of_operations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the hours_of_operations resource, the following permissions are required: - -### Create -```json -connect:CreateHoursOfOperation, -connect:TagResource -``` - -### List -```json -connect:ListHoursOfOperations -``` - diff --git a/docs/awscc-docs/providers/awscc/connect/index.md b/docs/awscc-docs/providers/awscc/connect/index.md deleted file mode 100644 index d874279c78..0000000000 --- a/docs/awscc-docs/providers/awscc/connect/index.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -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: 43
-total selectable resources: 43
-total methods: 43
-
-
- -::: - -## 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
-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 deleted file mode 100644 index d7f48de709..0000000000 --- a/docs/awscc-docs/providers/awscc/connect/instance/index.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the instance resource, the following permissions are required: - -### Read -```json -connect:DescribeInstance, -connect:ListInstanceAttributes, -ds:DescribeDirectories -``` - -### Update -```json -connect:ListInstanceAttributes, -connect:UpdateInstanceAttribute, -iam:CreateServiceLinkedRole, -iam:PutRolePolicy, -connect:TagResource, -connect:UntagResource -``` - -### Delete -```json -connect:DeleteInstance, -connect:DescribeInstance, -connect:UntagResource, -ds:DeleteDirectory, -ds:UnauthorizeApplication, -ds:DescribeDirectories -``` - 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 deleted file mode 100644 index 422263af2d..0000000000 --- a/docs/awscc-docs/providers/awscc/connect/instance_storage_config/index.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -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. - -## 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 data__Identifier = '||'; -``` - -## Permissions - -To operate on the instance_storage_config resource, the following permissions are required: - -### Read -```json -connect:DescribeInstanceStorageConfig, -connect:ListInstanceStorageConfigs, -connect:DescribeInstance, -ds:DescribeDirectories, -s3:GetBucketAcl, -s3:GetBucketLocation -``` - -### Update -```json -connect:UpdateInstanceStorageConfig, -ds:DescribeDirectories, -s3:GetBucketAcl, -s3:GetBucketLocation, -kinesis:DescribeStream, -iam:PutRolePolicy, -kms:DescribeKey, -kms:CreateGrant, -kms:RetireGrant, -firehose:DescribeDeliveryStream -``` - -### Delete -```json -connect:DisassociateInstanceStorageConfig, -connect:DescribeInstance, -s3:GetBucketAcl, -s3:GetBucketLocation, -kms:RetireGrant -``` - 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 deleted file mode 100644 index 97ac54ff36..0000000000 --- a/docs/awscc-docs/providers/awscc/connect/instance_storage_configs/index.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -instance_arn, -association_id, -resource_type -FROM awscc.connect.instance_storage_configs -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the instance_storage_configs resource, the following permissions are required: - -### Create -```json -connect:AssociateInstanceStorageConfig, -connect:DescribeInstance, -ds:DescribeDirectories, -s3:GetBucketAcl, -s3:GetBucketLocation, -iam:PutRolePolicy, -kinesis:DescribeStream, -kms:DescribeKey, -kms:CreateGrant, -firehose:DescribeDeliveryStream -``` - -### List -```json -connect:DescribeInstance, -connect:ListInstanceStorageConfigs, -ds:DescribeDirectories -``` - diff --git a/docs/awscc-docs/providers/awscc/connect/instances/index.md b/docs/awscc-docs/providers/awscc/connect/instances/index.md deleted file mode 100644 index 3179f2b084..0000000000 --- a/docs/awscc-docs/providers/awscc/connect/instances/index.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.connect.instances -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the instances resource, the following permissions are required: - -### Create -```json -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 -```json -connect:ListInstances, -connect:ListInstanceAttributes, -ds:DescribeDirectories -``` - diff --git a/docs/awscc-docs/providers/awscc/connect/integration_association/index.md b/docs/awscc-docs/providers/awscc/connect/integration_association/index.md deleted file mode 100644 index 7a9bf288df..0000000000 --- a/docs/awscc-docs/providers/awscc/connect/integration_association/index.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -integration_association_id, -instance_id, -integration_arn, -integration_type -FROM awscc.connect.integration_association -WHERE data__Identifier = '||'; -``` - -## Permissions - -To operate on the integration_association resource, the following permissions are required: - -### Read -```json -connect:ListBots, -connect:ListLambdaFunctions, -connect:ListIntegrationAssociations -``` - -### Delete -```json -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 -``` - diff --git a/docs/awscc-docs/providers/awscc/connect/integration_associations/index.md b/docs/awscc-docs/providers/awscc/connect/integration_associations/index.md deleted file mode 100644 index 874fe4a3c2..0000000000 --- a/docs/awscc-docs/providers/awscc/connect/integration_associations/index.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -instance_id, -integration_type, -integration_arn -FROM awscc.connect.integration_associations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the integration_associations resource, the following permissions are required: - -### Create -```json -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 -```json -connect:ListBots, -connect:ListLambdaFunctions, -connect:ListIntegrationAssociations -``` - diff --git a/docs/awscc-docs/providers/awscc/connect/predefined_attribute/index.md b/docs/awscc-docs/providers/awscc/connect/predefined_attribute/index.md deleted file mode 100644 index e785593861..0000000000 --- a/docs/awscc-docs/providers/awscc/connect/predefined_attribute/index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -instance_arn, -name, -values -FROM awscc.connect.predefined_attribute -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the predefined_attribute resource, the following permissions are required: - -### Read -```json -connect:DescribePredefinedAttribute -``` - -### Delete -```json -connect:DeletePredefinedAttribute -``` - -### Update -```json -connect:UpdatePredefinedAttribute -``` - diff --git a/docs/awscc-docs/providers/awscc/connect/predefined_attributes/index.md b/docs/awscc-docs/providers/awscc/connect/predefined_attributes/index.md deleted file mode 100644 index 4c3dfceddf..0000000000 --- a/docs/awscc-docs/providers/awscc/connect/predefined_attributes/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -instance_arn, -name -FROM awscc.connect.predefined_attributes -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the predefined_attributes resource, the following permissions are required: - -### Create -```json -connect:CreatePredefinedAttribute -``` - -### List -```json -connect:ListPredefinedAttributes -``` - diff --git a/docs/awscc-docs/providers/awscc/connect/prompt/index.md b/docs/awscc-docs/providers/awscc/connect/prompt/index.md deleted file mode 100644 index 079c3e72b3..0000000000 --- a/docs/awscc-docs/providers/awscc/connect/prompt/index.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -instance_arn, -name, -description, -s3_uri, -prompt_arn, -tags -FROM awscc.connect.prompt -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the prompt resource, the following permissions are required: - -### Read -```json -connect:DescribePrompt -``` - -### Update -```json -connect:UpdatePrompt, -connect:TagResource, -connect:UntagResource -``` - -### Delete -```json -connect:DeletePrompt -``` - diff --git a/docs/awscc-docs/providers/awscc/connect/prompts/index.md b/docs/awscc-docs/providers/awscc/connect/prompts/index.md deleted file mode 100644 index 46c45430c8..0000000000 --- a/docs/awscc-docs/providers/awscc/connect/prompts/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -prompt_arn -FROM awscc.connect.prompts -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the prompts resource, the following permissions are required: - -### Create -```json -connect:CreatePrompt, -connect:TagResource, -s3:GetObject, -kms:Decrypt, -s3:GetObjectAcl -``` - -### List -```json -connect:ListPrompts -``` - diff --git a/docs/awscc-docs/providers/awscc/connect/queue/index.md b/docs/awscc-docs/providers/awscc/connect/queue/index.md deleted file mode 100644 index 4f4d491218..0000000000 --- a/docs/awscc-docs/providers/awscc/connect/queue/index.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the queue resource, the following permissions are required: - -### Read -```json -connect:DescribeQueue, -connect:ListQueueQuickConnects -``` - -### Delete -```json -connect:DeleteQueue, -connect:UntagResource -``` - -### Update -```json -connect:UpdateQueueHoursOfOperation, -connect:UpdateQueueMaxContacts, -connect:UpdateQueueName, -connect:UpdateQueueOutboundCallerConfig, -connect:UpdateQueueStatus, -connect:AssociateQueueQuickConnects, -connect:DisassociateQueueQuickConnects, -connect:TagResource, -connect:UntagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/connect/queues/index.md b/docs/awscc-docs/providers/awscc/connect/queues/index.md deleted file mode 100644 index 4066ae4b8d..0000000000 --- a/docs/awscc-docs/providers/awscc/connect/queues/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -queue_arn -FROM awscc.connect.queues -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the queues resource, the following permissions are required: - -### Create -```json -connect:CreateQueue, -connect:TagResource -``` - -### List -```json -connect:ListQueues, -connect:ListQueueQuickConnects -``` - diff --git a/docs/awscc-docs/providers/awscc/connect/quick_connect/index.md b/docs/awscc-docs/providers/awscc/connect/quick_connect/index.md deleted file mode 100644 index 97049d571f..0000000000 --- a/docs/awscc-docs/providers/awscc/connect/quick_connect/index.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -instance_arn, -name, -description, -quick_connect_config, -quick_connect_arn, -tags, -quick_connect_type -FROM awscc.connect.quick_connect -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the quick_connect resource, the following permissions are required: - -### Read -```json -connect:DescribeQuickConnect -``` - -### Delete -```json -connect:DeleteQuickConnect, -connect:UntagResource -``` - -### Update -```json -connect:UpdateQuickConnectName, -connect:UpdateQuickConnectConfig, -connect:TagResource, -connect:UntagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/connect/quick_connects/index.md b/docs/awscc-docs/providers/awscc/connect/quick_connects/index.md deleted file mode 100644 index 570ce7c72f..0000000000 --- a/docs/awscc-docs/providers/awscc/connect/quick_connects/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -quick_connect_arn -FROM awscc.connect.quick_connects -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the quick_connects resource, the following permissions are required: - -### Create -```json -connect:CreateQuickConnect, -connect:TagResource -``` - -### List -```json -connect:ListQuickConnects -``` - diff --git a/docs/awscc-docs/providers/awscc/connect/routing_profile/index.md b/docs/awscc-docs/providers/awscc/connect/routing_profile/index.md deleted file mode 100644 index 67425d0781..0000000000 --- a/docs/awscc-docs/providers/awscc/connect/routing_profile/index.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the routing_profile resource, the following permissions are required: - -### Read -```json -connect:DescribeRoutingProfile, -connect:ListRoutingProfileQueues -``` - -### Delete -```json -connect:DeleteRoutingProfile, -connect:UntagResource -``` - -### Update -```json -connect:AssociateRoutingProfileQueues, -connect:DisassociateRoutingProfileQueues, -connect:UpdateRoutingProfileConcurrency, -connect:UpdateRoutingProfileName, -connect:UpdateRoutingProfileDefaultOutboundQueue, -connect:UpdateRoutingProfileQueues, -connect:TagResource, -connect:UntagResource, -connect:ListRoutingProfileQueues, -connect:UpdateRoutingProfileAgentAvailabilityTimer -``` - diff --git a/docs/awscc-docs/providers/awscc/connect/routing_profiles/index.md b/docs/awscc-docs/providers/awscc/connect/routing_profiles/index.md deleted file mode 100644 index 29a8ddb475..0000000000 --- a/docs/awscc-docs/providers/awscc/connect/routing_profiles/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -routing_profile_arn -FROM awscc.connect.routing_profiles -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the routing_profiles resource, the following permissions are required: - -### Create -```json -connect:CreateRoutingProfile, -connect:TagResource -``` - -### List -```json -connect:ListRoutingProfiles, -connect:ListRoutingProfileQueues -``` - diff --git a/docs/awscc-docs/providers/awscc/connect/rule/index.md b/docs/awscc-docs/providers/awscc/connect/rule/index.md deleted file mode 100644 index 959b9df4ea..0000000000 --- a/docs/awscc-docs/providers/awscc/connect/rule/index.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -rule_arn, -instance_arn, -trigger_event_source, -function, -actions, -publish_status, -tags -FROM awscc.connect.rule -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the rule resource, the following permissions are required: - -### Read -```json -connect:DescribeRule -``` - -### Delete -```json -connect:DeleteRule, -connect:UntagResource -``` - -### Update -```json -connect:UpdateRule, -cases:GetTemplate, -cases:ListFields, -cases:ListFieldOptions, -connect:TagResource, -connect:UntagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/connect/security_key/index.md b/docs/awscc-docs/providers/awscc/connect/security_key/index.md deleted file mode 100644 index bfad895fe2..0000000000 --- a/docs/awscc-docs/providers/awscc/connect/security_key/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -key, -instance_id, -association_id -FROM awscc.connect.security_key -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the security_key resource, the following permissions are required: - -### Read -```json -connect:ListSecurityKeys -``` - -### Delete -```json -connect:DisassociateSecurityKey -``` - diff --git a/docs/awscc-docs/providers/awscc/connect/security_keys/index.md b/docs/awscc-docs/providers/awscc/connect/security_keys/index.md deleted file mode 100644 index 256f693353..0000000000 --- a/docs/awscc-docs/providers/awscc/connect/security_keys/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -instance_id, -association_id -FROM awscc.connect.security_keys -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the security_keys resource, the following permissions are required: - -### Create -```json -connect:AssociateSecurityKey -``` - -### List -```json -connect:ListSecurityKeys -``` - diff --git a/docs/awscc-docs/providers/awscc/connect/security_profile/index.md b/docs/awscc-docs/providers/awscc/connect/security_profile/index.md deleted file mode 100644 index 185a270cb4..0000000000 --- a/docs/awscc-docs/providers/awscc/connect/security_profile/index.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the security_profile resource, the following permissions are required: - -### Read -```json -connect:DescribeSecurityProfile, -connect:ListSecurityProfilePermissions -``` - -### Update -```json -connect:TagResource, -connect:UpdateSecurityProfile, -connect:UntagResource -``` - -### Delete -```json -connect:DeleteSecurityProfile, -connect:UntagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/connect/security_profiles/index.md b/docs/awscc-docs/providers/awscc/connect/security_profiles/index.md deleted file mode 100644 index c2e8a80d70..0000000000 --- a/docs/awscc-docs/providers/awscc/connect/security_profiles/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -security_profile_arn -FROM awscc.connect.security_profiles -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the security_profiles resource, the following permissions are required: - -### Create -```json -connect:CreateSecurityProfile, -connect:TagResource -``` - -### List -```json -connect:ListSecurityProfiles -``` - diff --git a/docs/awscc-docs/providers/awscc/connect/task_template/index.md b/docs/awscc-docs/providers/awscc/connect/task_template/index.md deleted file mode 100644 index 5ab12af480..0000000000 --- a/docs/awscc-docs/providers/awscc/connect/task_template/index.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the task_template resource, the following permissions are required: - -### Read -```json -connect:GetTaskTemplate -``` - -### Update -```json -connect:UpdateTaskTemplate, -connect:TagResource, -connect:UntagResource -``` - -### Delete -```json -connect:DeleteTaskTemplate, -connect:UntagResource, -connect:GetTaskTemplate -``` - diff --git a/docs/awscc-docs/providers/awscc/connect/task_templates/index.md b/docs/awscc-docs/providers/awscc/connect/task_templates/index.md deleted file mode 100644 index 1cb21bb6fc..0000000000 --- a/docs/awscc-docs/providers/awscc/connect/task_templates/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.connect.task_templates -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the task_templates resource, the following permissions are required: - -### Create -```json -connect:CreateTaskTemplate, -connect:TagResource -``` - -### List -```json -connect:ListTaskTemplates -``` - 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 deleted file mode 100644 index 26f3be2953..0000000000 --- a/docs/awscc-docs/providers/awscc/connect/traffic_distribution_group/index.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -instance_arn, -traffic_distribution_group_arn, -description, -name, -status, -tags, -is_default -FROM awscc.connect.traffic_distribution_group -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the traffic_distribution_group resource, the following permissions are required: - -### Read -```json -connect:DescribeTrafficDistributionGroup -``` - -### Update -```json -connect:TagResource, -connect:UntagResource -``` - -### Delete -```json -connect:DeleteTrafficDistributionGroup, -connect:DescribeTrafficDistributionGroup, -connect:UntagResource -``` - 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 deleted file mode 100644 index e799f61d9b..0000000000 --- a/docs/awscc-docs/providers/awscc/connect/traffic_distribution_groups/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -traffic_distribution_group_arn -FROM awscc.connect.traffic_distribution_groups -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the traffic_distribution_groups resource, the following permissions are required: - -### Create -```json -connect:CreateTrafficDistributionGroup, -connect:DescribeTrafficDistributionGroup, -connect:TagResource -``` - -### List -```json -connect:ListTrafficDistributionGroups -``` - diff --git a/docs/awscc-docs/providers/awscc/connect/user/index.md b/docs/awscc-docs/providers/awscc/connect/user/index.md deleted file mode 100644 index 9f3c27e56f..0000000000 --- a/docs/awscc-docs/providers/awscc/connect/user/index.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the user resource, the following permissions are required: - -### Read -```json -connect:DescribeUser, -connect:ListUserProficiencies -``` - -### Delete -```json -connect:DeleteUser, -connect:UntagResource -``` - -### Update -```json -connect:UpdateUserIdentityInfo, -connect:UpdateUserPhoneConfig, -connect:UpdateUserRoutingProfile, -connect:UpdateUserSecurityProfiles, -connect:UpdateUserHierarchy, -connect:TagResource, -connect:UntagResource, -connect:AssociateUserProficiencies, -connect:DisassociateUserProficiencies, -connect:UpdateUserProficiencies -``` - 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 deleted file mode 100644 index b25a6a498a..0000000000 --- a/docs/awscc-docs/providers/awscc/connect/user_hierarchy_group/index.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -instance_arn, -user_hierarchy_group_arn, -parent_group_arn, -name, -tags -FROM awscc.connect.user_hierarchy_group -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the user_hierarchy_group resource, the following permissions are required: - -### Read -```json -connect:DescribeUserHierarchyGroup -``` - -### Delete -```json -connect:DeleteUserHierarchyGroup, -connect:UntagResource -``` - -### Update -```json -connect:UpdateUserHierarchyGroupName, -connect:TagResource, -connect:UntagResource -``` - 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 deleted file mode 100644 index 6838d87f31..0000000000 --- a/docs/awscc-docs/providers/awscc/connect/user_hierarchy_groups/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -user_hierarchy_group_arn -FROM awscc.connect.user_hierarchy_groups -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the user_hierarchy_groups resource, the following permissions are required: - -### Create -```json -connect:CreateUserHierarchyGroup, -connect:TagResource -``` - -### List -```json -connect:ListUserHierarchyGroups -``` - diff --git a/docs/awscc-docs/providers/awscc/connect/users/index.md b/docs/awscc-docs/providers/awscc/connect/users/index.md deleted file mode 100644 index ef16e00472..0000000000 --- a/docs/awscc-docs/providers/awscc/connect/users/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -user_arn -FROM awscc.connect.users -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the users resource, the following permissions are required: - -### Create -```json -connect:CreateUser, -connect:TagResource, -connect:AssociateUserProficiencies -``` - -### List -```json -connect:ListUsers -``` - diff --git a/docs/awscc-docs/providers/awscc/connect/view/index.md b/docs/awscc-docs/providers/awscc/connect/view/index.md deleted file mode 100644 index 85be5bcc02..0000000000 --- a/docs/awscc-docs/providers/awscc/connect/view/index.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -instance_arn, -view_arn, -view_id, -name, -description, -template, -actions, -view_content_sha256, -tags -FROM awscc.connect.view -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the view resource, the following permissions are required: - -### Read -```json -connect:DescribeView -``` - -### Delete -```json -connect:DeleteView, -connect:UntagResource -``` - -### Update -```json -connect:UpdateViewMetadata, -connect:UpdateViewContent, -connect:TagResource, -connect:UntagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/connect/view_version/index.md b/docs/awscc-docs/providers/awscc/connect/view_version/index.md deleted file mode 100644 index 7395122c73..0000000000 --- a/docs/awscc-docs/providers/awscc/connect/view_version/index.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -view_arn, -view_version_arn, -version_description, -view_content_sha256, -version -FROM awscc.connect.view_version -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the view_version resource, the following permissions are required: - -### Read -```json -connect:DescribeView -``` - -### Delete -```json -connect:DeleteViewVersion -``` - diff --git a/docs/awscc-docs/providers/awscc/connect/view_versions/index.md b/docs/awscc-docs/providers/awscc/connect/view_versions/index.md deleted file mode 100644 index 0907a7266a..0000000000 --- a/docs/awscc-docs/providers/awscc/connect/view_versions/index.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -view_version_arn -FROM awscc.connect.view_versions -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the view_versions resource, the following permissions are required: - -### Create -```json -connect:CreateViewVersion -``` - -### List -```json -connect:ListViewVersions -``` - diff --git a/docs/awscc-docs/providers/awscc/connect/views/index.md b/docs/awscc-docs/providers/awscc/connect/views/index.md deleted file mode 100644 index dc6a56a1da..0000000000 --- a/docs/awscc-docs/providers/awscc/connect/views/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -view_arn -FROM awscc.connect.views -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the views resource, the following permissions are required: - -### Create -```json -connect:CreateView, -connect:TagResource -``` - -### List -```json -connect:ListViews -``` - diff --git a/docs/awscc-docs/providers/awscc/connectcampaigns/campaign/index.md b/docs/awscc-docs/providers/awscc/connectcampaigns/campaign/index.md deleted file mode 100644 index cc8fb8af57..0000000000 --- a/docs/awscc-docs/providers/awscc/connectcampaigns/campaign/index.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -connect_instance_arn, -dialer_config, -arn, -name, -outbound_call_config, -tags -FROM awscc.connectcampaigns.campaign -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the campaign resource, the following permissions are required: - -### Read -```json -connect-campaigns:DescribeCampaign -``` - -### Delete -```json -connect-campaigns:DeleteCampaign -``` - -### Update -```json -connect-campaigns:UpdateCampaignDialerConfig, -connect-campaigns:UpdateCampaignName, -connect-campaigns:UpdateCampaignOutboundCallConfig, -connect-campaigns:TagResource, -connect-campaigns:UntagResource, -connect-campaigns:DescribeCampaign -``` - diff --git a/docs/awscc-docs/providers/awscc/connectcampaigns/campaigns/index.md b/docs/awscc-docs/providers/awscc/connectcampaigns/campaigns/index.md deleted file mode 100644 index db9159e390..0000000000 --- a/docs/awscc-docs/providers/awscc/connectcampaigns/campaigns/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.connectcampaigns.campaigns -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the campaigns resource, the following permissions are required: - -### Create -```json -connect-campaigns:CreateCampaign, -connect-campaigns:DescribeCampaign, -connect-campaigns:TagResource, -connect:DescribeContactFlow, -connect:DescribeInstance, -connect:DescribeQueue -``` - -### List -```json -connect-campaigns:ListCampaigns -``` - diff --git a/docs/awscc-docs/providers/awscc/connectcampaigns/index.md b/docs/awscc-docs/providers/awscc/connectcampaigns/index.md deleted file mode 100644 index 5414579fb4..0000000000 --- a/docs/awscc-docs/providers/awscc/connectcampaigns/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 deleted file mode 100644 index 65ed231430..0000000000 --- a/docs/awscc-docs/providers/awscc/controltower/enabled_baseline/index.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -baseline_identifier, -baseline_version, -enabled_baseline_identifier, -target_identifier, -parameters, -tags -FROM awscc.controltower.enabled_baseline -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the enabled_baseline resource, the following permissions are required: - -### Read -```json -controltower:GetEnabledBaseline, -controltower:ListEnabledBaselines, -controltower:ListTagsForResource -``` - -### Update -```json -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 -```json -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 -``` - diff --git a/docs/awscc-docs/providers/awscc/controltower/enabled_baselines/index.md b/docs/awscc-docs/providers/awscc/controltower/enabled_baselines/index.md deleted file mode 100644 index 38c00ee640..0000000000 --- a/docs/awscc-docs/providers/awscc/controltower/enabled_baselines/index.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -enabled_baseline_identifier -FROM awscc.controltower.enabled_baselines -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the enabled_baselines resource, the following permissions are required: - -### Create -```json -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 -```json -controltower:ListEnabledBaselines -``` - diff --git a/docs/awscc-docs/providers/awscc/controltower/enabled_control/index.md b/docs/awscc-docs/providers/awscc/controltower/enabled_control/index.md deleted file mode 100644 index 07f12a9bb3..0000000000 --- a/docs/awscc-docs/providers/awscc/controltower/enabled_control/index.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -control_identifier, -target_identifier, -parameters, -tags -FROM awscc.controltower.enabled_control -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the enabled_control resource, the following permissions are required: - -### Update -```json -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 -```json -controltower:GetControlOperation, -controltower:DisableControl, -organizations:UpdatePolicy, -organizations:DeletePolicy, -organizations:CreatePolicy, -organizations:AttachPolicy, -organizations:DetachPolicy, -organizations:ListPoliciesForTarget, -organizations:ListTargetsForPolicy, -organizations:DescribePolicy -``` - -### Read -```json -controltower:ListEnabledControls, -controltower:GetEnabledControl, -controltower:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/controltower/enabled_controls/index.md b/docs/awscc-docs/providers/awscc/controltower/enabled_controls/index.md deleted file mode 100644 index a5f786c1fe..0000000000 --- a/docs/awscc-docs/providers/awscc/controltower/enabled_controls/index.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -target_identifier, -control_identifier -FROM awscc.controltower.enabled_controls -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the enabled_controls resource, the following permissions are required: - -### Create -```json -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 -```json -controltower:ListEnabledControls -``` - diff --git a/docs/awscc-docs/providers/awscc/controltower/index.md b/docs/awscc-docs/providers/awscc/controltower/index.md deleted file mode 100644 index 1aa857f948..0000000000 --- a/docs/awscc-docs/providers/awscc/controltower/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -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 deleted file mode 100644 index b555b5814c..0000000000 --- a/docs/awscc-docs/providers/awscc/controltower/landing_zone/index.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -landing_zone_identifier, -arn, -status, -latest_available_version, -drift_status, -manifest, -version, -tags -FROM awscc.controltower.landing_zone -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the landing_zone resource, the following permissions are required: - -### Read -```json -controltower:GetLandingZone, -controltower:ListTagsForResource -``` - -### Update -```json -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 -```json -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 -``` - diff --git a/docs/awscc-docs/providers/awscc/controltower/landing_zones/index.md b/docs/awscc-docs/providers/awscc/controltower/landing_zones/index.md deleted file mode 100644 index 56a59c90d7..0000000000 --- a/docs/awscc-docs/providers/awscc/controltower/landing_zones/index.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -landing_zone_identifier -FROM awscc.controltower.landing_zones -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the landing_zones resource, the following permissions are required: - -### Create -```json -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 -```json -controltower:ListLandingZones -``` - diff --git a/docs/awscc-docs/providers/awscc/cur/index.md b/docs/awscc-docs/providers/awscc/cur/index.md deleted file mode 100644 index 628fc63e17..0000000000 --- a/docs/awscc-docs/providers/awscc/cur/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 deleted file mode 100644 index a729e01d75..0000000000 --- a/docs/awscc-docs/providers/awscc/cur/report_definition/index.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the report_definition resource, the following permissions are required: - -### Read -```json -cur:DescribeReportDefinitions -``` - -### Update -```json -cur:DescribeReportDefinitions, -cur:ModifyReportDefinition -``` - -### Delete -```json -cur:DescribeReportDefinitions, -cur:DeleteReportDefinition -``` - diff --git a/docs/awscc-docs/providers/awscc/cur/report_definitions/index.md b/docs/awscc-docs/providers/awscc/cur/report_definitions/index.md deleted file mode 100644 index a4e340e47e..0000000000 --- a/docs/awscc-docs/providers/awscc/cur/report_definitions/index.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -report_name -FROM awscc.cur.report_definitions -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the report_definitions resource, the following permissions are required: - -### Create -```json -cur:PutReportDefinition -``` - -### List -```json -cur:DescribeReportDefinitions -``` - 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 deleted file mode 100644 index c0c2e175d0..0000000000 --- a/docs/awscc-docs/providers/awscc/customerprofiles/calculated_attribute_definition/index.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the calculated_attribute_definition resource, the following permissions are required: - -### Read -```json -profile:GetCalculatedAttributeDefinition -``` - -### Update -```json -profile:GetCalculatedAttributeDefinition, -profile:UpdateCalculatedAttributeDefinition, -profile:UntagResource, -profile:TagResource -``` - -### Delete -```json -profile:DeleteCalculatedAttributeDefinition -``` - 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 deleted file mode 100644 index 54ca4c2597..0000000000 --- a/docs/awscc-docs/providers/awscc/customerprofiles/calculated_attribute_definitions/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -domain_name, -calculated_attribute_name -FROM awscc.customerprofiles.calculated_attribute_definitions -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the calculated_attribute_definitions resource, the following permissions are required: - -### Create -```json -profile:CreateCalculatedAttributeDefinition, -profile:TagResource -``` - -### List -```json -profile:ListCalculatedAttributeDefinitions -``` - diff --git a/docs/awscc-docs/providers/awscc/customerprofiles/domain/index.md b/docs/awscc-docs/providers/awscc/customerprofiles/domain/index.md deleted file mode 100644 index 69534f9fb0..0000000000 --- a/docs/awscc-docs/providers/awscc/customerprofiles/domain/index.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the domain resource, the following permissions are required: - -### Read -```json -profile:GetDomain -``` - -### Update -```json -profile:GetDomain, -profile:UpdateDomain, -profile:UntagResource, -profile:TagResource -``` - -### Delete -```json -profile:DeleteDomain -``` - diff --git a/docs/awscc-docs/providers/awscc/customerprofiles/domains/index.md b/docs/awscc-docs/providers/awscc/customerprofiles/domains/index.md deleted file mode 100644 index dd9a4d1f0c..0000000000 --- a/docs/awscc-docs/providers/awscc/customerprofiles/domains/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -domain_name -FROM awscc.customerprofiles.domains -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the domains resource, the following permissions are required: - -### Create -```json -profile:CreateDomain, -profile:TagResource -``` - -### List -```json -profile:ListDomains -``` - diff --git a/docs/awscc-docs/providers/awscc/customerprofiles/event_stream/index.md b/docs/awscc-docs/providers/awscc/customerprofiles/event_stream/index.md deleted file mode 100644 index f389bb7791..0000000000 --- a/docs/awscc-docs/providers/awscc/customerprofiles/event_stream/index.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the event_stream resource, the following permissions are required: - -### Read -```json -profile:GetEventStream, -kinesis:DescribeStreamSummary -``` - -### Update -```json -kinesis:DescribeStreamSummary, -profile:GetEventStream, -profile:UntagResource, -profile:TagResource -``` - -### Delete -```json -profile:DeleteEventStream, -iam:DeleteRolePolicy -``` - diff --git a/docs/awscc-docs/providers/awscc/customerprofiles/event_streams/index.md b/docs/awscc-docs/providers/awscc/customerprofiles/event_streams/index.md deleted file mode 100644 index 819455b436..0000000000 --- a/docs/awscc-docs/providers/awscc/customerprofiles/event_streams/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -domain_name, -event_stream_name -FROM awscc.customerprofiles.event_streams -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the event_streams resource, the following permissions are required: - -### Create -```json -profile:CreateEventStream, -iam:PutRolePolicy, -kinesis:DescribeStreamSummary, -profile:TagResource -``` - -### List -```json -profile:ListEventStreams -``` - diff --git a/docs/awscc-docs/providers/awscc/customerprofiles/index.md b/docs/awscc-docs/providers/awscc/customerprofiles/index.md deleted file mode 100644 index 93e12e402e..0000000000 --- a/docs/awscc-docs/providers/awscc/customerprofiles/index.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -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 deleted file mode 100644 index f4aa225154..0000000000 --- a/docs/awscc-docs/providers/awscc/customerprofiles/integration/index.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the integration resource, the following permissions are required: - -### Read -```json -profile:GetIntegration -``` - -### Delete -```json -profile:DeleteIntegration, -appflow:DeleteFlow, -app-integrations:ListEventIntegrationAssociations, -app-integrations:DeleteEventIntegrationAssociation, -events:RemoveTargets, -events:ListTargetsByRule, -events:DeleteRule -``` - -### Update -```json -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 -``` - diff --git a/docs/awscc-docs/providers/awscc/customerprofiles/integrations/index.md b/docs/awscc-docs/providers/awscc/customerprofiles/integrations/index.md deleted file mode 100644 index f063347a7b..0000000000 --- a/docs/awscc-docs/providers/awscc/customerprofiles/integrations/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -domain_name, -uri -FROM awscc.customerprofiles.integrations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the integrations resource, the following permissions are required: - -### Create -```json -profile:GetIntegration, -profile:PutIntegration, -appflow:CreateFlow, -app-integrations:CreateEventIntegrationAssociation, -app-integrations:GetEventIntegration, -events:ListTargetsByRule, -events:PutRule, -events:PutTargets, -events:PutEvents, -profile:TagResource -``` - -### List -```json -profile:ListIntegrations -``` - diff --git a/docs/awscc-docs/providers/awscc/customerprofiles/object_type/index.md b/docs/awscc-docs/providers/awscc/customerprofiles/object_type/index.md deleted file mode 100644 index 363fafa7bf..0000000000 --- a/docs/awscc-docs/providers/awscc/customerprofiles/object_type/index.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the object_type resource, the following permissions are required: - -### Read -```json -profile:GetProfileObjectType -``` - -### Update -```json -profile:GetProfileObjectType, -profile:PutProfileObjectType, -profile:UntagResource, -profile:TagResource -``` - -### Delete -```json -profile:DeleteProfileObjectType -``` - diff --git a/docs/awscc-docs/providers/awscc/customerprofiles/object_types/index.md b/docs/awscc-docs/providers/awscc/customerprofiles/object_types/index.md deleted file mode 100644 index d18be3b983..0000000000 --- a/docs/awscc-docs/providers/awscc/customerprofiles/object_types/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -domain_name, -object_type_name -FROM awscc.customerprofiles.object_types -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the object_types resource, the following permissions are required: - -### Create -```json -profile:GetProfileObjectType, -profile:PutProfileObjectType, -profile:TagResource -``` - -### List -```json -profile:ListProfileObjectTypes -``` - diff --git a/docs/awscc-docs/providers/awscc/databrew/dataset/index.md b/docs/awscc-docs/providers/awscc/databrew/dataset/index.md deleted file mode 100644 index 503d818420..0000000000 --- a/docs/awscc-docs/providers/awscc/databrew/dataset/index.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -format, -format_options, -input, -path_options, -tags -FROM awscc.databrew.dataset -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the dataset resource, the following permissions are required: - -### Read -```json -databrew:DescribeDataset, -databrew:ListTagsForResource, -iam:ListRoles -``` - -### Update -```json -databrew:UpdateDataset, -glue:GetConnection, -glue:GetTable -``` - -### Delete -```json -databrew:DeleteDataset -``` - diff --git a/docs/awscc-docs/providers/awscc/databrew/datasets/index.md b/docs/awscc-docs/providers/awscc/databrew/datasets/index.md deleted file mode 100644 index d88d1d3c5c..0000000000 --- a/docs/awscc-docs/providers/awscc/databrew/datasets/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.databrew.datasets -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the datasets resource, the following permissions are required: - -### Create -```json -databrew:CreateDataset, -databrew:TagResource, -databrew:UntagResource, -glue:GetConnection, -glue:GetTable, -iam:PassRole -``` - -### List -```json -databrew:ListDatasets, -databrew:ListTagsForResource, -iam:ListRoles -``` - diff --git a/docs/awscc-docs/providers/awscc/databrew/index.md b/docs/awscc-docs/providers/awscc/databrew/index.md deleted file mode 100644 index 7266f8fe88..0000000000 --- a/docs/awscc-docs/providers/awscc/databrew/index.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -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 deleted file mode 100644 index 24fcf34ed5..0000000000 --- a/docs/awscc-docs/providers/awscc/databrew/job/index.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the job resource, the following permissions are required: - -### Read -```json -databrew:DescribeJob, -databrew:ListTagsForResource, -iam:ListRoles -``` - -### Update -```json -databrew:UpdateProfileJob, -databrew:UpdateRecipeJob, -iam:PassRole -``` - -### Delete -```json -databrew:DeleteJob -``` - diff --git a/docs/awscc-docs/providers/awscc/databrew/jobs/index.md b/docs/awscc-docs/providers/awscc/databrew/jobs/index.md deleted file mode 100644 index edce9f30ec..0000000000 --- a/docs/awscc-docs/providers/awscc/databrew/jobs/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.databrew.jobs -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the jobs resource, the following permissions are required: - -### Create -```json -databrew:CreateProfileJob, -databrew:CreateRecipeJob, -databrew:TagResource, -databrew:UntagResource, -iam:PassRole -``` - -### List -```json -databrew:ListJobs, -databrew:ListTagsForResource, -iam:ListRoles -``` - diff --git a/docs/awscc-docs/providers/awscc/databrew/project/index.md b/docs/awscc-docs/providers/awscc/databrew/project/index.md deleted file mode 100644 index 3ff8c449ee..0000000000 --- a/docs/awscc-docs/providers/awscc/databrew/project/index.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -dataset_name, -name, -recipe_name, -role_arn, -sample, -tags -FROM awscc.databrew.project -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the project resource, the following permissions are required: - -### Read -```json -databrew:DescribeProject, -databrew:ListTagsForResource, -iam:ListRoles -``` - -### Update -```json -databrew:UpdateProject, -iam:PassRole -``` - -### Delete -```json -databrew:DeleteProject -``` - diff --git a/docs/awscc-docs/providers/awscc/databrew/projects/index.md b/docs/awscc-docs/providers/awscc/databrew/projects/index.md deleted file mode 100644 index d48bc8dff0..0000000000 --- a/docs/awscc-docs/providers/awscc/databrew/projects/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.databrew.projects -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the projects resource, the following permissions are required: - -### Create -```json -databrew:CreateProject, -databrew:TagResource, -databrew:UntagResource, -iam:PassRole -``` - -### List -```json -databrew:ListProjects, -databrew:ListTagsForResource, -iam:ListRoles -``` - diff --git a/docs/awscc-docs/providers/awscc/databrew/recipe/index.md b/docs/awscc-docs/providers/awscc/databrew/recipe/index.md deleted file mode 100644 index 915649be03..0000000000 --- a/docs/awscc-docs/providers/awscc/databrew/recipe/index.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -description, -name, -steps, -tags -FROM awscc.databrew.recipe -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the recipe resource, the following permissions are required: - -### Read -```json -databrew:DescribeRecipe, -databrew:ListTagsForResource, -iam:ListRoles -``` - -### Delete -```json -databrew:DeleteRecipeVersion -``` - -### Update -```json -databrew:UpdateRecipe -``` - diff --git a/docs/awscc-docs/providers/awscc/databrew/recipes/index.md b/docs/awscc-docs/providers/awscc/databrew/recipes/index.md deleted file mode 100644 index 908970a258..0000000000 --- a/docs/awscc-docs/providers/awscc/databrew/recipes/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.databrew.recipes -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the recipes resource, the following permissions are required: - -### Create -```json -databrew:CreateRecipe, -databrew:TagResource, -databrew:UntagResource, -iam:PassRole -``` - -### List -```json -databrew:ListRecipes, -databrew:ListTagsForResource, -iam:ListRoles -``` - diff --git a/docs/awscc-docs/providers/awscc/databrew/ruleset/index.md b/docs/awscc-docs/providers/awscc/databrew/ruleset/index.md deleted file mode 100644 index 0dce0acc2d..0000000000 --- a/docs/awscc-docs/providers/awscc/databrew/ruleset/index.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -description, -target_arn, -rules, -tags -FROM awscc.databrew.ruleset -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the ruleset resource, the following permissions are required: - -### Read -```json -databrew:DescribeRuleset, -databrew:ListTagsForResource, -iam:ListRoles -``` - -### Update -```json -databrew:UpdateRuleset -``` - -### Delete -```json -databrew:DeleteRuleset -``` - diff --git a/docs/awscc-docs/providers/awscc/databrew/rulesets/index.md b/docs/awscc-docs/providers/awscc/databrew/rulesets/index.md deleted file mode 100644 index 3a701cc4d8..0000000000 --- a/docs/awscc-docs/providers/awscc/databrew/rulesets/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.databrew.rulesets -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the rulesets resource, the following permissions are required: - -### Create -```json -databrew:CreateRuleset, -databrew:TagResource, -databrew:UntagResource, -iam:PassRole -``` - -### List -```json -databrew:ListRulesets, -databrew:ListTagsForResource, -iam:ListRoles -``` - diff --git a/docs/awscc-docs/providers/awscc/databrew/schedule/index.md b/docs/awscc-docs/providers/awscc/databrew/schedule/index.md deleted file mode 100644 index 5df7483b3e..0000000000 --- a/docs/awscc-docs/providers/awscc/databrew/schedule/index.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -job_names, -cron_expression, -name, -tags -FROM awscc.databrew.schedule -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the schedule resource, the following permissions are required: - -### Read -```json -databrew:DescribeSchedule, -databrew:ListTagsForResource, -iam:ListRoles -``` - -### Update -```json -databrew:UpdateSchedule -``` - -### Delete -```json -databrew:DeleteSchedule -``` - diff --git a/docs/awscc-docs/providers/awscc/databrew/schedules/index.md b/docs/awscc-docs/providers/awscc/databrew/schedules/index.md deleted file mode 100644 index 6f37eeb149..0000000000 --- a/docs/awscc-docs/providers/awscc/databrew/schedules/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.databrew.schedules -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the schedules resource, the following permissions are required: - -### Create -```json -databrew:CreateSchedule, -databrew:TagResource, -databrew:UntagResource, -iam:PassRole -``` - -### List -```json -databrew:ListSchedules, -databrew:ListTagsForResource, -iam:ListRoles -``` - diff --git a/docs/awscc-docs/providers/awscc/datapipeline/index.md b/docs/awscc-docs/providers/awscc/datapipeline/index.md deleted file mode 100644 index e179bb4ca5..0000000000 --- a/docs/awscc-docs/providers/awscc/datapipeline/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 deleted file mode 100644 index f226adbe61..0000000000 --- a/docs/awscc-docs/providers/awscc/datapipeline/pipeline/index.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -activate, -description, -name, -parameter_objects, -parameter_values, -pipeline_objects, -pipeline_tags, -pipeline_id -FROM awscc.datapipeline.pipeline -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the pipeline resource, the following permissions are required: - -### Read -```json -datapipeline:GetPipelineDefinition, -datapipeline:DescribePipelines -``` - -### Update -```json -datapipeline:PutPipelineDefinition, -datapipeline:AddTags, -datapipeline:RemoveTags, -datapipeline:DeactivatePipeline, -datapipeline:GetPipelineDefinition, -datapipeline:ActivatePipeline, -datapipeline:ValidatePipelineDefinition, -datapipeline:DescribePipelines, -datapipeline:AddTags, -datapipeline:RemoveTags, -iam:PassRole -``` - -### Delete -```json -datapipeline:DeletePipeline, -datapipeline:DescribePipelines, -datapipeline:GetPipelineDefinition, -datapipeline:RemoveTags -``` - diff --git a/docs/awscc-docs/providers/awscc/datapipeline/pipelines/index.md b/docs/awscc-docs/providers/awscc/datapipeline/pipelines/index.md deleted file mode 100644 index cc201e58ab..0000000000 --- a/docs/awscc-docs/providers/awscc/datapipeline/pipelines/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -pipeline_id -FROM awscc.datapipeline.pipelines -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the pipelines resource, the following permissions are required: - -### Create -```json -datapipeline:CreatePipeline, -datapipeline:PutPipelineDefinition, -datapipeline:GetPipelineDefinition, -datapipeline:DescribePipelines, -datapipeline:ValidatePipelineDefinition, -datapipeline:ActivatePipeline, -datapipeline:AddTags, -iam:PassRole -``` - -### List -```json -datapipeline:ListPipelines -``` - diff --git a/docs/awscc-docs/providers/awscc/datasync/agent/index.md b/docs/awscc-docs/providers/awscc/datasync/agent/index.md deleted file mode 100644 index 2e502b6c6e..0000000000 --- a/docs/awscc-docs/providers/awscc/datasync/agent/index.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the agent resource, the following permissions are required: - -### Read -```json -datasync:DescribeAgent, -datasync:ListTagsForResource -``` - -### Update -```json -datasync:UpdateAgent, -datasync:DescribeAgent, -datasync:ListTagsForResource, -datasync:TagResource, -datasync:UntagResource -``` - -### Delete -```json -datasync:DeleteAgent -``` - diff --git a/docs/awscc-docs/providers/awscc/datasync/agents/index.md b/docs/awscc-docs/providers/awscc/datasync/agents/index.md deleted file mode 100644 index a8849b449e..0000000000 --- a/docs/awscc-docs/providers/awscc/datasync/agents/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -agent_arn -FROM awscc.datasync.agents -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the agents resource, the following permissions are required: - -### Create -```json -datasync:CreateAgent, -datasync:TagResource, -datasync:DescribeAgent, -datasync:ListTagsForResource, -ec2:DescribeNetworkInterfaces, -ec2:DescribeSecurityGroups, -ec2:DescribeSubnets, -ec2:DescribeVpcEndpoints -``` - -### List -```json -datasync:ListAgents -``` - diff --git a/docs/awscc-docs/providers/awscc/datasync/index.md b/docs/awscc-docs/providers/awscc/datasync/index.md deleted file mode 100644 index ac9eb432e1..0000000000 --- a/docs/awscc-docs/providers/awscc/datasync/index.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -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 deleted file mode 100644 index 17827243c3..0000000000 --- a/docs/awscc-docs/providers/awscc/datasync/location_azure_blob/index.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the location_azure_blob resource, the following permissions are required: - -### Read -```json -datasync:DescribeLocationAzureBlob, -datasync:ListTagsForResource -``` - -### Update -```json -datasync:DescribeLocationAzureBlob, -datasync:ListTagsForResource, -datasync:TagResource, -datasync:UntagResource, -datasync:UpdateLocationAzureBlob -``` - -### Delete -```json -datasync:DeleteLocation -``` - 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 deleted file mode 100644 index 3fe936d3e4..0000000000 --- a/docs/awscc-docs/providers/awscc/datasync/location_azure_blobs/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -location_arn -FROM awscc.datasync.location_azure_blobs -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the location_azure_blobs resource, the following permissions are required: - -### Create -```json -datasync:CreateLocationAzureBlob, -datasync:DescribeLocationAzureBlob, -datasync:TagResource, -datasync:ListTagsForResource -``` - -### List -```json -datasync:ListLocations -``` - diff --git a/docs/awscc-docs/providers/awscc/datasync/location_efs/index.md b/docs/awscc-docs/providers/awscc/datasync/location_efs/index.md deleted file mode 100644 index 98816d1753..0000000000 --- a/docs/awscc-docs/providers/awscc/datasync/location_efs/index.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the location_efs resource, the following permissions are required: - -### Read -```json -datasync:DescribeLocationEfs, -datasync:ListTagsForResource -``` - -### Update -```json -datasync:DescribeLocationEfs, -datasync:ListTagsForResource, -datasync:TagResource, -datasync:UntagResource -``` - -### Delete -```json -datasync:DeleteLocation -``` - diff --git a/docs/awscc-docs/providers/awscc/datasync/location_hdfs/index.md b/docs/awscc-docs/providers/awscc/datasync/location_hdfs/index.md deleted file mode 100644 index bf73ecee07..0000000000 --- a/docs/awscc-docs/providers/awscc/datasync/location_hdfs/index.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the location_hdfs resource, the following permissions are required: - -### Read -```json -datasync:DescribeLocationHdfs, -datasync:ListTagsForResource -``` - -### Update -```json -datasync:UpdateLocationHdfs, -datasync:DescribeLocationHdfs, -datasync:ListTagsForResource, -datasync:TagResource, -datasync:UntagResource -``` - -### Delete -```json -datasync:DeleteLocation -``` - diff --git a/docs/awscc-docs/providers/awscc/datasync/location_nfs/index.md b/docs/awscc-docs/providers/awscc/datasync/location_nfs/index.md deleted file mode 100644 index 69f3ad988b..0000000000 --- a/docs/awscc-docs/providers/awscc/datasync/location_nfs/index.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -mount_options, -on_prem_config, -server_hostname, -subdirectory, -tags, -location_arn, -location_uri -FROM awscc.datasync.location_nfs -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the location_nfs resource, the following permissions are required: - -### Read -```json -datasync:DescribeLocationNfs, -datasync:ListTagsForResource -``` - -### Update -```json -datasync:DescribeLocationNfs, -datasync:ListTagsForResource, -datasync:TagResource, -datasync:UntagResource, -datasync:UpdateLocationNfs -``` - -### Delete -```json -datasync:DeleteLocation -``` - 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 deleted file mode 100644 index 2efbc0ab47..0000000000 --- a/docs/awscc-docs/providers/awscc/datasync/location_object_storage/index.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the location_object_storage resource, the following permissions are required: - -### Read -```json -datasync:DescribeLocationObjectStorage, -datasync:ListTagsForResource -``` - -### Update -```json -datasync:DescribeLocationObjectStorage, -datasync:ListTagsForResource, -datasync:TagResource, -datasync:UntagResource, -datasync:UpdateLocationObjectStorage -``` - -### Delete -```json -datasync:DeleteLocation -``` - 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 deleted file mode 100644 index ae4679e1af..0000000000 --- a/docs/awscc-docs/providers/awscc/datasync/location_object_storages/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -location_arn -FROM awscc.datasync.location_object_storages -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the location_object_storages resource, the following permissions are required: - -### Create -```json -datasync:CreateLocationObjectStorage, -datasync:DescribeLocationObjectStorage, -datasync:ListTagsForResource, -datasync:TagResource -``` - -### List -```json -datasync:ListLocations -``` - diff --git a/docs/awscc-docs/providers/awscc/datasync/location_s3/index.md b/docs/awscc-docs/providers/awscc/datasync/location_s3/index.md deleted file mode 100644 index b822476aa1..0000000000 --- a/docs/awscc-docs/providers/awscc/datasync/location_s3/index.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -s3_config, -s3_bucket_arn, -subdirectory, -s3_storage_class, -tags, -location_arn, -location_uri -FROM awscc.datasync.location_s3 -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the location_s3 resource, the following permissions are required: - -### Read -```json -datasync:DescribeLocationS3, -datasync:ListTagsForResource -``` - -### Update -```json -datasync:DescribeLocationS3, -datasync:ListTagsForResource, -datasync:TagResource, -datasync:UntagResource -``` - -### Delete -```json -datasync:DeleteLocation -``` - diff --git a/docs/awscc-docs/providers/awscc/datasync/location_s3s/index.md b/docs/awscc-docs/providers/awscc/datasync/location_s3s/index.md deleted file mode 100644 index 2245049667..0000000000 --- a/docs/awscc-docs/providers/awscc/datasync/location_s3s/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -location_arn -FROM awscc.datasync.location_s3s -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the location_s3s resource, the following permissions are required: - -### Create -```json -datasync:CreateLocationS3, -datasync:DescribeLocationS3, -datasync:ListTagsForResource, -datasync:TagResource, -s3:ListAllMyBuckets, -s3:ListBucket, -iam:GetRole, -iam:PassRole -``` - -### List -```json -datasync:ListLocations -``` - diff --git a/docs/awscc-docs/providers/awscc/datasync/location_smb/index.md b/docs/awscc-docs/providers/awscc/datasync/location_smb/index.md deleted file mode 100644 index 25349e7a6f..0000000000 --- a/docs/awscc-docs/providers/awscc/datasync/location_smb/index.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the location_smb resource, the following permissions are required: - -### Read -```json -datasync:DescribeLocationSmb, -datasync:ListTagsForResource -``` - -### Update -```json -datasync:DescribeLocationSmb, -datasync:ListTagsForResource, -datasync:TagResource, -datasync:UntagResource, -datasync:UpdateLocationSmb -``` - -### Delete -```json -datasync:DeleteLocation -``` - diff --git a/docs/awscc-docs/providers/awscc/datasync/location_smbs/index.md b/docs/awscc-docs/providers/awscc/datasync/location_smbs/index.md deleted file mode 100644 index 5cf40ad3ab..0000000000 --- a/docs/awscc-docs/providers/awscc/datasync/location_smbs/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -location_arn -FROM awscc.datasync.location_smbs -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the location_smbs resource, the following permissions are required: - -### Create -```json -datasync:CreateLocationSmb, -datasync:DescribeLocationSmb, -datasync:ListTagsForResource, -datasync:TagResource -``` - -### List -```json -datasync:ListLocations -``` - 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 deleted file mode 100644 index a8c253a593..0000000000 --- a/docs/awscc-docs/providers/awscc/datasync/locationf_sx_lustre/index.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -fsx_filesystem_arn, -security_group_arns, -subdirectory, -tags, -location_arn, -location_uri -FROM awscc.datasync.locationf_sx_lustre -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the locationf_sx_lustre resource, the following permissions are required: - -### Read -```json -datasync:DescribeLocationFsxLustre, -datasync:ListTagsForResource -``` - -### Update -```json -datasync:DescribeLocationFsxLustre, -datasync:ListTagsForResource, -datasync:TagResource, -datasync:UntagResource -``` - -### Delete -```json -datasync:DeleteLocation -``` - 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 deleted file mode 100644 index 910888092b..0000000000 --- a/docs/awscc-docs/providers/awscc/datasync/locationf_sx_lustres/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -location_arn -FROM awscc.datasync.locationf_sx_lustres -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the locationf_sx_lustres resource, the following permissions are required: - -### Create -```json -datasync:CreateLocationFsxLustre, -datasync:DescribeLocationFsxLustre, -datasync:ListTagsForResource, -datasync:TagResource, -fsx:DescribeFileSystems, -ec2:DescribeNetworkInterfaces, -ec2:DescribeSubnets, -ec2:DescribeSecurityGroups -``` - -### List -```json -datasync:ListLocations -``` - 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 deleted file mode 100644 index 5c57e821ba..0000000000 --- a/docs/awscc-docs/providers/awscc/datasync/locationf_sx_ontap/index.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the locationf_sx_ontap resource, the following permissions are required: - -### Read -```json -datasync:DescribeLocationFsxOntap, -datasync:ListTagsForResource -``` - -### Update -```json -datasync:DescribeLocationFsxOntap, -datasync:ListTagsForResource, -datasync:TagResource, -datasync:UntagResource -``` - -### Delete -```json -datasync:DeleteLocation -``` - 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 deleted file mode 100644 index f7497d7fe8..0000000000 --- a/docs/awscc-docs/providers/awscc/datasync/locationf_sx_ontaps/index.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -location_arn -FROM awscc.datasync.locationf_sx_ontaps -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the locationf_sx_ontaps resource, the following permissions are required: - -### Create -```json -datasync:CreateLocationFsxOntap, -datasync:DescribeLocationFsxOntap, -datasync:ListTagsForResource, -datasync:TagResource, -fsx:DescribeStorageVirtualMachines, -fsx:DescribeFileSystems, -ec2:DescribeNetworkInterfaces, -ec2:DescribeSubnets, -ec2:DescribeSecurityGroups -``` - -### List -```json -datasync:ListLocations -``` - 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 deleted file mode 100644 index 6a942f6d08..0000000000 --- a/docs/awscc-docs/providers/awscc/datasync/locationf_sx_open_zfs/index.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the locationf_sx_open_zfs resource, the following permissions are required: - -### Read -```json -datasync:DescribeLocationFsxOpenZfs, -datasync:ListTagsForResource -``` - -### Update -```json -datasync:DescribeLocationFsxOpenZfs, -datasync:ListTagsForResource, -datasync:TagResource, -datasync:UntagResource -``` - -### Delete -```json -datasync:DeleteLocation -``` - 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 deleted file mode 100644 index 1324fdf8bb..0000000000 --- a/docs/awscc-docs/providers/awscc/datasync/locationf_sx_windows/index.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the locationf_sx_windows resource, the following permissions are required: - -### Read -```json -datasync:DescribeLocationFsxWindows, -datasync:ListTagsForResource -``` - -### Update -```json -datasync:DescribeLocationFsxWindows, -datasync:ListTagsForResource, -datasync:TagResource, -datasync:UntagResource -``` - -### Delete -```json -datasync:DeleteLocation -``` - diff --git a/docs/awscc-docs/providers/awscc/datasync/storage_system/index.md b/docs/awscc-docs/providers/awscc/datasync/storage_system/index.md deleted file mode 100644 index 6698ee47b6..0000000000 --- a/docs/awscc-docs/providers/awscc/datasync/storage_system/index.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the storage_system resource, the following permissions are required: - -### Read -```json -datasync:DescribeStorageSystem, -datasync:ListTagsForResource, -secretsmanager:DescribeSecret -``` - -### Update -```json -datasync:UpdateStorageSystem, -datasync:DescribeStorageSystem, -datasync:ListTagsForResource, -datasync:TagResource, -datasync:UntagResource, -secretsmanager:DescribeSecret, -secretsmanager:PutSecretValue -``` - -### Delete -```json -datasync:DescribeStorageSystem, -datasync:RemoveStorageSystem, -secretsmanager:DescribeSecret, -secretsmanager:DeleteSecret -``` - diff --git a/docs/awscc-docs/providers/awscc/datasync/storage_systems/index.md b/docs/awscc-docs/providers/awscc/datasync/storage_systems/index.md deleted file mode 100644 index 0f63565364..0000000000 --- a/docs/awscc-docs/providers/awscc/datasync/storage_systems/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -storage_system_arn -FROM awscc.datasync.storage_systems -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the storage_systems resource, the following permissions are required: - -### Create -```json -datasync:AddStorageSystem, -datasync:DescribeStorageSystem, -datasync:ListTagsForResource, -datasync:TagResource, -secretsmanager:CreateSecret, -secretsmanager:DescribeSecret, -iam:CreateServiceLinkedRole -``` - -### List -```json -datasync:ListStorageSystems -``` - diff --git a/docs/awscc-docs/providers/awscc/datasync/task/index.md b/docs/awscc-docs/providers/awscc/datasync/task/index.md deleted file mode 100644 index 176486e078..0000000000 --- a/docs/awscc-docs/providers/awscc/datasync/task/index.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the task resource, the following permissions are required: - -### Read -```json -datasync:DescribeTask, -datasync:ListTagsForResource -``` - -### Update -```json -datasync:UpdateTask, -datasync:DescribeTask, -datasync:ListTagsForResource, -datasync:TagResource, -datasync:UntagResource, -logs:DescribeLogGroups, -iam:PassRole -``` - -### Delete -```json -datasync:DeleteTask, -ec2:DescribeNetworkInterfaces, -ec2:DeleteNetworkInterface, -ec2:DescribeSecurityGroups, -ec2:DescribeSubnets, -fsx:DescribeFileSystems, -elasticfilesystem:DescribeFileSystems, -elasticfilesystem:DescribeMountTargets, -iam:GetRole -``` - diff --git a/docs/awscc-docs/providers/awscc/datasync/tasks/index.md b/docs/awscc-docs/providers/awscc/datasync/tasks/index.md deleted file mode 100644 index 63195eb70a..0000000000 --- a/docs/awscc-docs/providers/awscc/datasync/tasks/index.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -task_arn -FROM awscc.datasync.tasks -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the tasks resource, the following permissions are required: - -### Create -```json -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 -```json -datasync:ListTasks -``` - diff --git a/docs/awscc-docs/providers/awscc/datazone/data_source/index.md b/docs/awscc-docs/providers/awscc/datazone/data_source/index.md deleted file mode 100644 index 865ae868ec..0000000000 --- a/docs/awscc-docs/providers/awscc/datazone/data_source/index.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the data_source resource, the following permissions are required: - -### Read -```json -datazone:GetDataSource -``` - -### Update -```json -datazone:UpdateDataSource, -datazone:GetDataSource, -datazone:DeleteDataSource -``` - -### Delete -```json -datazone:DeleteDataSource, -datazone:GetDataSource -``` - diff --git a/docs/awscc-docs/providers/awscc/datazone/data_sources/index.md b/docs/awscc-docs/providers/awscc/datazone/data_sources/index.md deleted file mode 100644 index 3b4128f7eb..0000000000 --- a/docs/awscc-docs/providers/awscc/datazone/data_sources/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -domain_id, -id -FROM awscc.datazone.data_sources -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the data_sources resource, the following permissions are required: - -### Create -```json -datazone:CreateDataSource, -iam:PassRole, -datazone:GetDataSource, -datazone:DeleteDataSource -``` - -### List -```json -datazone:ListDataSources -``` - diff --git a/docs/awscc-docs/providers/awscc/datazone/domain/index.md b/docs/awscc-docs/providers/awscc/datazone/domain/index.md deleted file mode 100644 index acdd45cfb2..0000000000 --- a/docs/awscc-docs/providers/awscc/datazone/domain/index.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the domain resource, the following permissions are required: - -### Read -```json -datazone:GetDomain -``` - -### Update -```json -datazone:UpdateDomain, -datazone:GetDomain, -datazone:TagResource, -datazone:UntagResource, -sso:CreateManagedApplicationInstance, -sso:DeleteManagedApplicationInstance, -sso:PutApplicationAssignmentConfiguration -``` - -### Delete -```json -datazone:DeleteDomain, -datazone:GetDomain -``` - diff --git a/docs/awscc-docs/providers/awscc/datazone/domains/index.md b/docs/awscc-docs/providers/awscc/datazone/domains/index.md deleted file mode 100644 index 583f48fead..0000000000 --- a/docs/awscc-docs/providers/awscc/datazone/domains/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.datazone.domains -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the domains resource, the following permissions are required: - -### Create -```json -datazone:CreateDomain, -datazone:UpdateDomain, -datazone:GetDomain, -datazone:TagResource, -sso:CreateManagedApplicationInstance, -sso:DeleteManagedApplicationInstance, -sso:PutApplicationAssignmentConfiguration -``` - -### List -```json -datazone:ListDomains -``` - diff --git a/docs/awscc-docs/providers/awscc/datazone/environment/index.md b/docs/awscc-docs/providers/awscc/datazone/environment/index.md deleted file mode 100644 index 7a6d71a297..0000000000 --- a/docs/awscc-docs/providers/awscc/datazone/environment/index.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the environment resource, the following permissions are required: - -### Read -```json -datazone:GetEnvironment -``` - -### Update -```json -datazone:UpdateEnvironment, -datazone:GetEnvironment, -datazone:DeleteEnvironment -``` - -### Delete -```json -datazone:DeleteEnvironment, -datazone:GetEnvironment -``` - 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 deleted file mode 100644 index fa6a5f7b5f..0000000000 --- a/docs/awscc-docs/providers/awscc/datazone/environment_blueprint_configuration/index.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the environment_blueprint_configuration resource, the following permissions are required: - -### Read -```json -datazone:GetEnvironmentBlueprintConfiguration -``` - -### Update -```json -datazone:DeleteEnvironmentBlueprintConfiguration, -iam:PassRole, -datazone:GetEnvironmentBlueprintConfiguration, -datazone:PutEnvironmentBlueprintConfiguration -``` - -### Delete -```json -datazone:GetEnvironmentBlueprintConfiguration, -datazone:DeleteEnvironmentBlueprintConfiguration -``` - 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 deleted file mode 100644 index bf5aed3ea6..0000000000 --- a/docs/awscc-docs/providers/awscc/datazone/environment_blueprint_configurations/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -domain_id, -environment_blueprint_id -FROM awscc.datazone.environment_blueprint_configurations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the environment_blueprint_configurations resource, the following permissions are required: - -### Create -```json -datazone:ListEnvironmentBlueprints, -iam:PassRole, -datazone:GetEnvironmentBlueprintConfiguration, -datazone:PutEnvironmentBlueprintConfiguration -``` - -### List -```json -datazone:ListEnvironmentBlueprintConfigurations -``` - diff --git a/docs/awscc-docs/providers/awscc/datazone/environment_profile/index.md b/docs/awscc-docs/providers/awscc/datazone/environment_profile/index.md deleted file mode 100644 index 64879e3ada..0000000000 --- a/docs/awscc-docs/providers/awscc/datazone/environment_profile/index.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the environment_profile resource, the following permissions are required: - -### Read -```json -datazone:GetEnvironmentProfile -``` - -### Update -```json -datazone:UpdateEnvironmentProfile, -datazone:GetEnvironmentProfile -``` - -### Delete -```json -datazone:DeleteEnvironmentProfile, -datazone:GetEnvironmentProfile -``` - diff --git a/docs/awscc-docs/providers/awscc/datazone/environment_profiles/index.md b/docs/awscc-docs/providers/awscc/datazone/environment_profiles/index.md deleted file mode 100644 index 5a819027dc..0000000000 --- a/docs/awscc-docs/providers/awscc/datazone/environment_profiles/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -domain_id, -id -FROM awscc.datazone.environment_profiles -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the environment_profiles resource, the following permissions are required: - -### Create -```json -datazone:CreateEnvironmentProfile, -datazone:GetEnvironmentProfile -``` - -### List -```json -datazone:ListEnvironmentProfiles -``` - diff --git a/docs/awscc-docs/providers/awscc/datazone/environments/index.md b/docs/awscc-docs/providers/awscc/datazone/environments/index.md deleted file mode 100644 index 057939b250..0000000000 --- a/docs/awscc-docs/providers/awscc/datazone/environments/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -domain_id, -id -FROM awscc.datazone.environments -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the environments resource, the following permissions are required: - -### Create -```json -datazone:CreateEnvironment, -datazone:GetEnvironment, -datazone:DeleteEnvironment -``` - -### List -```json -datazone:ListEnvironments -``` - diff --git a/docs/awscc-docs/providers/awscc/datazone/index.md b/docs/awscc-docs/providers/awscc/datazone/index.md deleted file mode 100644 index 7c4e2cc7ac..0000000000 --- a/docs/awscc-docs/providers/awscc/datazone/index.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -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 deleted file mode 100644 index 3086d96173..0000000000 --- a/docs/awscc-docs/providers/awscc/datazone/project/index.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the project resource, the following permissions are required: - -### Read -```json -datazone:GetProject -``` - -### Update -```json -datazone:UpdateProject, -datazone:GetProject -``` - -### Delete -```json -datazone:DeleteProject, -datazone:GetProject -``` - diff --git a/docs/awscc-docs/providers/awscc/datazone/projects/index.md b/docs/awscc-docs/providers/awscc/datazone/projects/index.md deleted file mode 100644 index 3ec8ba9b72..0000000000 --- a/docs/awscc-docs/providers/awscc/datazone/projects/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -domain_id, -id -FROM awscc.datazone.projects -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the projects resource, the following permissions are required: - -### Create -```json -datazone:CreateProject, -datazone:GetProject -``` - -### List -```json -datazone:ListProjects -``` - diff --git a/docs/awscc-docs/providers/awscc/datazone/subscription_target/index.md b/docs/awscc-docs/providers/awscc/datazone/subscription_target/index.md deleted file mode 100644 index 298eca8e52..0000000000 --- a/docs/awscc-docs/providers/awscc/datazone/subscription_target/index.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -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. - -## 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 data__Identifier = '||'; -``` - -## Permissions - -To operate on the subscription_target resource, the following permissions are required: - -### Read -```json -datazone:GetSubscriptionTarget -``` - -### Update -```json -datazone:UpdateSubscriptionTarget, -datazone:GetSubscriptionTarget, -iam:PassRole -``` - -### Delete -```json -datazone:DeleteSubscriptionTarget -``` - diff --git a/docs/awscc-docs/providers/awscc/datazone/subscription_targets/index.md b/docs/awscc-docs/providers/awscc/datazone/subscription_targets/index.md deleted file mode 100644 index 1c92cc48f3..0000000000 --- a/docs/awscc-docs/providers/awscc/datazone/subscription_targets/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -domain_id, -environment_id, -id -FROM awscc.datazone.subscription_targets -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the subscription_targets resource, the following permissions are required: - -### Create -```json -datazone:CreateSubscriptionTarget, -datazone:GetSubscriptionTarget, -iam:PassRole -``` - -### List -```json -datazone:ListSubscriptionTargets -``` - diff --git a/docs/awscc-docs/providers/awscc/detective/graph/index.md b/docs/awscc-docs/providers/awscc/detective/graph/index.md deleted file mode 100644 index 86741f302b..0000000000 --- a/docs/awscc-docs/providers/awscc/detective/graph/index.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -tags, -auto_enable_members -FROM awscc.detective.graph -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the graph resource, the following permissions are required: - -### Update -```json -detective:UntagResource, -detective:TagResource, -detective:ListTagsForResource, -detective:UpdateOrganizationConfiguration, -organizations:DescribeOrganization -``` - -### Read -```json -detective:ListGraphs, -detective:ListTagsForResource, -detective:DescribeOrganizationConfiguration, -organizations:DescribeOrganization -``` - -### Delete -```json -detective:DeleteGraph -``` - diff --git a/docs/awscc-docs/providers/awscc/detective/graphs/index.md b/docs/awscc-docs/providers/awscc/detective/graphs/index.md deleted file mode 100644 index 63e465c515..0000000000 --- a/docs/awscc-docs/providers/awscc/detective/graphs/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.detective.graphs -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the graphs resource, the following permissions are required: - -### Create -```json -detective:CreateGraph, -detective:UpdateOrganizationConfiguration, -organizations:DescribeOrganization -``` - -### List -```json -detective:ListGraphs, -detective:ListTagsForResource, -detective:DescribeOrganizationConfiguration, -organizations:DescribeOrganization -``` - diff --git a/docs/awscc-docs/providers/awscc/detective/index.md b/docs/awscc-docs/providers/awscc/detective/index.md deleted file mode 100644 index 683cd10f8a..0000000000 --- a/docs/awscc-docs/providers/awscc/detective/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -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 deleted file mode 100644 index cb8bd6e083..0000000000 --- a/docs/awscc-docs/providers/awscc/detective/member_invitation/index.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -graph_arn, -member_id, -member_email_address, -disable_email_notification, -message -FROM awscc.detective.member_invitation -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the member_invitation resource, the following permissions are required: - -### Read -```json -detective:GetMembers -``` - -### Delete -```json -detective:DeleteMembers -``` - diff --git a/docs/awscc-docs/providers/awscc/detective/member_invitations/index.md b/docs/awscc-docs/providers/awscc/detective/member_invitations/index.md deleted file mode 100644 index b16c5e8b44..0000000000 --- a/docs/awscc-docs/providers/awscc/detective/member_invitations/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -graph_arn, -member_id -FROM awscc.detective.member_invitations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the member_invitations resource, the following permissions are required: - -### Create -```json -detective:CreateMembers, -detective:GetMembers -``` - -### List -```json -detective:ListGraphs, -detective:ListMembers -``` - diff --git a/docs/awscc-docs/providers/awscc/detective/organization_admin/index.md b/docs/awscc-docs/providers/awscc/detective/organization_admin/index.md deleted file mode 100644 index 51409c1562..0000000000 --- a/docs/awscc-docs/providers/awscc/detective/organization_admin/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -account_id, -graph_arn -FROM awscc.detective.organization_admin -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the organization_admin resource, the following permissions are required: - -### Read -```json -detective:ListOrganizationAdminAccount, -organizations:DescribeOrganization -``` - -### Delete -```json -detective:DisableOrganizationAdminAccount, -detective:ListOrganizationAdminAccount, -organizations:DescribeOrganization -``` - diff --git a/docs/awscc-docs/providers/awscc/detective/organization_admins/index.md b/docs/awscc-docs/providers/awscc/detective/organization_admins/index.md deleted file mode 100644 index b09a93c3ae..0000000000 --- a/docs/awscc-docs/providers/awscc/detective/organization_admins/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -account_id -FROM awscc.detective.organization_admins -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the organization_admins resource, the following permissions are required: - -### Create -```json -detective:EnableOrganizationAdminAccount, -detective:ListOrganizationAdminAccount, -iam:CreateServiceLinkedRole, -organizations:RegisterDelegatedAdministrator, -organizations:DescribeOrganization, -organizations:EnableAWSServiceAccess, -organizations:ListAccounts -``` - -### List -```json -detective:ListOrganizationAdminAccount, -organizations:DescribeOrganization -``` - diff --git a/docs/awscc-docs/providers/awscc/devopsguru/index.md b/docs/awscc-docs/providers/awscc/devopsguru/index.md deleted file mode 100644 index c07a1fab50..0000000000 --- a/docs/awscc-docs/providers/awscc/devopsguru/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -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 deleted file mode 100644 index d404daa04a..0000000000 --- a/docs/awscc-docs/providers/awscc/devopsguru/log_anomaly_detection_integration/index.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -account_id -FROM awscc.devopsguru.log_anomaly_detection_integration -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the log_anomaly_detection_integration resource, the following permissions are required: - -### Read -```json -devops-guru:DescribeServiceIntegration -``` - -### Update -```json -devops-guru:UpdateServiceIntegration, -logs:TagLogGroup, -logs:UntagLogGroup -``` - -### Delete -```json -devops-guru:DescribeServiceIntegration, -devops-guru:UpdateServiceIntegration, -logs:TagLogGroup, -logs:UntagLogGroup -``` - 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 deleted file mode 100644 index 70b9286fb8..0000000000 --- a/docs/awscc-docs/providers/awscc/devopsguru/log_anomaly_detection_integrations/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -account_id -FROM awscc.devopsguru.log_anomaly_detection_integrations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the log_anomaly_detection_integrations resource, the following permissions are required: - -### Create -```json -devops-guru:DescribeServiceIntegration, -devops-guru:UpdateServiceIntegration, -logs:TagLogGroup, -logs:UntagLogGroup -``` - -### List -```json -devops-guru:DescribeServiceIntegration -``` - diff --git a/docs/awscc-docs/providers/awscc/devopsguru/notification_channel/index.md b/docs/awscc-docs/providers/awscc/devopsguru/notification_channel/index.md deleted file mode 100644 index 8f805f0c3f..0000000000 --- a/docs/awscc-docs/providers/awscc/devopsguru/notification_channel/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -config, -id -FROM awscc.devopsguru.notification_channel -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the notification_channel resource, the following permissions are required: - -### Delete -```json -devops-guru:RemoveNotificationChannel, -devops-guru:ListNotificationChannels -``` - -### Read -```json -devops-guru:ListNotificationChannels -``` - diff --git a/docs/awscc-docs/providers/awscc/devopsguru/notification_channels/index.md b/docs/awscc-docs/providers/awscc/devopsguru/notification_channels/index.md deleted file mode 100644 index 7c1b21d498..0000000000 --- a/docs/awscc-docs/providers/awscc/devopsguru/notification_channels/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.devopsguru.notification_channels -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the notification_channels resource, the following permissions are required: - -### Create -```json -devops-guru:AddNotificationChannel, -devops-guru:ListNotificationChannels, -sns:Publish, -sns:GetTopicAttributes, -sns:SetTopicAttributes -``` - -### List -```json -devops-guru:ListNotificationChannels -``` - diff --git a/docs/awscc-docs/providers/awscc/devopsguru/resource_collection/index.md b/docs/awscc-docs/providers/awscc/devopsguru/resource_collection/index.md deleted file mode 100644 index 6f79e3181e..0000000000 --- a/docs/awscc-docs/providers/awscc/devopsguru/resource_collection/index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -resource_collection_filter, -resource_collection_type -FROM awscc.devopsguru.resource_collection -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the resource_collection resource, the following permissions are required: - -### Read -```json -devops-guru:GetResourceCollection -``` - -### Delete -```json -devops-guru:UpdateResourceCollection, -devops-guru:GetResourceCollection -``` - -### Update -```json -devops-guru:UpdateResourceCollection, -devops-guru:GetResourceCollection -``` - diff --git a/docs/awscc-docs/providers/awscc/devopsguru/resource_collections/index.md b/docs/awscc-docs/providers/awscc/devopsguru/resource_collections/index.md deleted file mode 100644 index 60a94864e4..0000000000 --- a/docs/awscc-docs/providers/awscc/devopsguru/resource_collections/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -resource_collection_type -FROM awscc.devopsguru.resource_collections -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the resource_collections resource, the following permissions are required: - -### Create -```json -devops-guru:UpdateResourceCollection, -devops-guru:GetResourceCollection -``` - -### List -```json -devops-guru:GetResourceCollection -``` - diff --git a/docs/awscc-docs/providers/awscc/directoryservice/index.md b/docs/awscc-docs/providers/awscc/directoryservice/index.md deleted file mode 100644 index 9fb0486997..0000000000 --- a/docs/awscc-docs/providers/awscc/directoryservice/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 deleted file mode 100644 index 0e3d17a208..0000000000 --- a/docs/awscc-docs/providers/awscc/directoryservice/simple_ad/index.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the simple_ad resource, the following permissions are required: - -### Read -```json -ds:DescribeDirectories -``` - -### Update -```json -ds:EnableSso, -ds:DisableSso, -ds:DescribeDirectories -``` - -### Delete -```json -ds:DeleteDirectory, -ds:DescribeDirectories, -ec2:DescribeNetworkInterfaces, -ec2:DeleteSecurityGroup, -ec2:DeleteNetworkInterface, -ec2:RevokeSecurityGroupIngress, -ec2:RevokeSecurityGroupEgress, -ec2:DeleteTags -``` - diff --git a/docs/awscc-docs/providers/awscc/directoryservice/simple_ads/index.md b/docs/awscc-docs/providers/awscc/directoryservice/simple_ads/index.md deleted file mode 100644 index 8b04fa6368..0000000000 --- a/docs/awscc-docs/providers/awscc/directoryservice/simple_ads/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -directory_id -FROM awscc.directoryservice.simple_ads -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the simple_ads resource, the following permissions are required: - -### Create -```json -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 -```json -ds:DescribeDirectories -``` - diff --git a/docs/awscc-docs/providers/awscc/dms/data_provider/index.md b/docs/awscc-docs/providers/awscc/dms/data_provider/index.md deleted file mode 100644 index a94302afbe..0000000000 --- a/docs/awscc-docs/providers/awscc/dms/data_provider/index.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the data_provider resource, the following permissions are required: - -### Read -```json -dms:ListDataProviders, -dms:DescribeDataProviders, -dms:ListTagsForResource -``` - -### Update -```json -dms:UpdateDataProvider, -dms:ModifyDataProvider, -dms:AddTagsToResource, -dms:RemoveTagsToResource, -dms:ListTagsForResource -``` - -### Delete -```json -dms:DeleteDataProvider -``` - diff --git a/docs/awscc-docs/providers/awscc/dms/data_providers/index.md b/docs/awscc-docs/providers/awscc/dms/data_providers/index.md deleted file mode 100644 index d1cf2ef2be..0000000000 --- a/docs/awscc-docs/providers/awscc/dms/data_providers/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -data_provider_arn -FROM awscc.dms.data_providers -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the data_providers resource, the following permissions are required: - -### Create -```json -dms:CreateDataProvider, -dms:ListDataProviders, -dms:DescribeDataProviders, -dms:AddTagsToResource, -dms:ListTagsForResource -``` - -### List -```json -dms:ListDataProviders, -dms:DescribeDataProviders, -dms:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/dms/index.md b/docs/awscc-docs/providers/awscc/dms/index.md deleted file mode 100644 index adeb267b1c..0000000000 --- a/docs/awscc-docs/providers/awscc/dms/index.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -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 deleted file mode 100644 index 3b61333979..0000000000 --- a/docs/awscc-docs/providers/awscc/dms/instance_profile/index.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the instance_profile resource, the following permissions are required: - -### Read -```json -dms:ListInstanceProfiles, -dms:DescribeInstanceProfiles, -dms:ListTagsForResource -``` - -### Update -```json -dms:UpdateInstanceProfile, -dms:ModifyInstanceProfile, -dms:AddTagsToResource, -dms:RemoveTagsToResource, -dms:ListTagsForResource -``` - -### Delete -```json -dms:DeleteInstanceProfile -``` - diff --git a/docs/awscc-docs/providers/awscc/dms/instance_profiles/index.md b/docs/awscc-docs/providers/awscc/dms/instance_profiles/index.md deleted file mode 100644 index 06ed5f7f7b..0000000000 --- a/docs/awscc-docs/providers/awscc/dms/instance_profiles/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -instance_profile_arn -FROM awscc.dms.instance_profiles -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the instance_profiles resource, the following permissions are required: - -### Create -```json -dms:CreateInstanceProfile, -dms:ListInstanceProfiles, -dms:DescribeInstanceProfiles, -dms:AddTagsToResource, -dms:ListTagsForResource -``` - -### List -```json -dms:ListInstanceProfiles, -dms:DescribeInstanceProfiles, -dms:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/dms/migration_project/index.md b/docs/awscc-docs/providers/awscc/dms/migration_project/index.md deleted file mode 100644 index 2045810316..0000000000 --- a/docs/awscc-docs/providers/awscc/dms/migration_project/index.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the migration_project resource, the following permissions are required: - -### Read -```json -dms:DescribeMigrationProjects, -dms:ListMigrationProjects, -dms:ListTagsForResource -``` - -### Update -```json -dms:UpdateMigrationProject, -dms:ModifyMigrationProject, -dms:AddTagsToResource, -dms:RemoveTagsToResource, -dms:ListTagsForResource, -iam:PassRole -``` - -### Delete -```json -dms:DeleteMigrationProject -``` - diff --git a/docs/awscc-docs/providers/awscc/dms/migration_projects/index.md b/docs/awscc-docs/providers/awscc/dms/migration_projects/index.md deleted file mode 100644 index 36a514bd6e..0000000000 --- a/docs/awscc-docs/providers/awscc/dms/migration_projects/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -migration_project_arn -FROM awscc.dms.migration_projects -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the migration_projects resource, the following permissions are required: - -### Create -```json -dms:CreateMigrationProject, -dms:ListMigrationProjects, -dms:DescribeMigrationProjects, -dms:AddTagsToResource, -dms:ListTagsForResource, -iam:PassRole -``` - -### List -```json -dms:ListMigrationProjects, -dms:DescribeMigrationProjects, -dms:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/dms/replication_config/index.md b/docs/awscc-docs/providers/awscc/dms/replication_config/index.md deleted file mode 100644 index c62758bddc..0000000000 --- a/docs/awscc-docs/providers/awscc/dms/replication_config/index.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the replication_config resource, the following permissions are required: - -### Read -```json -dms:DescribeReplicationConfigs, -dms:ListTagsForResource -``` - -### Update -```json -dms:ModifyReplicationConfig, -dms:AddTagsToResource, -dms:RemoveTagsToResource, -dms:ListTagsForResource, -iam:CreateServiceLinkedRole, -iam:AttachRolePolicy, -iam:PutRolePolicy, -iam:UpdateRoleDescription -``` - -### Delete -```json -dms:DescribeReplicationConfigs, -dms:DeleteReplicationConfig, -dms:ListTagsForResource, -iam:DeleteServiceLinkedRole, -iam:GetServiceLinkedRoleDeletionStatus -``` - diff --git a/docs/awscc-docs/providers/awscc/dms/replication_configs/index.md b/docs/awscc-docs/providers/awscc/dms/replication_configs/index.md deleted file mode 100644 index 44589475e0..0000000000 --- a/docs/awscc-docs/providers/awscc/dms/replication_configs/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -replication_config_arn -FROM awscc.dms.replication_configs -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the replication_configs resource, the following permissions are required: - -### Create -```json -dms:CreateReplicationConfig, -dms:AddTagsToResource, -dms:ListTagsForResource, -iam:CreateServiceLinkedRole, -iam:AttachRolePolicy, -iam:PutRolePolicy, -iam:UpdateRoleDescription -``` - -### List -```json -dms:DescribeReplicationConfigs, -dms:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/docdbelastic/cluster/index.md b/docs/awscc-docs/providers/awscc/docdbelastic/cluster/index.md deleted file mode 100644 index ace3aa7b53..0000000000 --- a/docs/awscc-docs/providers/awscc/docdbelastic/cluster/index.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the cluster resource, the following permissions are required: - -### Read -```json -docdb-elastic:GetCluster, -docdb-elastic:ListTagsForResource -``` - -### Update -```json -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 -```json -docdb-elastic:DeleteCluster, -ec2:DescribeVpcEndpoints, -ec2:DeleteVpcEndpoints, -ec2:ModifyVpcEndpoint, -ec2:DescribeSecurityGroups, -ec2:DescribeSubnets, -ec2:DescribeVpcAttribute, -ec2:DescribeVpcs, -ec2:DescribeAvailabilityZones -``` - diff --git a/docs/awscc-docs/providers/awscc/docdbelastic/clusters/index.md b/docs/awscc-docs/providers/awscc/docdbelastic/clusters/index.md deleted file mode 100644 index 1c7514a803..0000000000 --- a/docs/awscc-docs/providers/awscc/docdbelastic/clusters/index.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -cluster_arn -FROM awscc.docdbelastic.clusters -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the clusters resource, the following permissions are required: - -### Create -```json -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 -```json -docdb-elastic:ListClusters -``` - diff --git a/docs/awscc-docs/providers/awscc/docdbelastic/index.md b/docs/awscc-docs/providers/awscc/docdbelastic/index.md deleted file mode 100644 index e0e107a3c5..0000000000 --- a/docs/awscc-docs/providers/awscc/docdbelastic/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 deleted file mode 100644 index 7e8d1288a1..0000000000 --- a/docs/awscc-docs/providers/awscc/dynamodb/global_table/index.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -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
sse_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. - -## Example -```sql -SELECT -region, -table_id, -sse_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 data__Identifier = ''; -``` - -## Permissions - -To operate on the global_table resource, the following permissions are required: - -### Read -```json -dynamodb:Describe*, -dynamodb:GetResourcePolicy, -application-autoscaling:Describe*, -cloudwatch:PutMetricData, -dynamodb:ListTagsOfResource, -kms:DescribeKey -``` - -### Update -```json -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 -```json -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 -``` - diff --git a/docs/awscc-docs/providers/awscc/dynamodb/global_tables/index.md b/docs/awscc-docs/providers/awscc/dynamodb/global_tables/index.md deleted file mode 100644 index c55a78a967..0000000000 --- a/docs/awscc-docs/providers/awscc/dynamodb/global_tables/index.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -table_name -FROM awscc.dynamodb.global_tables -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the global_tables resource, the following permissions are required: - -### Create -```json -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 -```json -dynamodb:ListTables, -cloudwatch:PutMetricData -``` - diff --git a/docs/awscc-docs/providers/awscc/dynamodb/index.md b/docs/awscc-docs/providers/awscc/dynamodb/index.md deleted file mode 100644 index a4da9ecee1..0000000000 --- a/docs/awscc-docs/providers/awscc/dynamodb/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index 93cddc451d..0000000000 --- a/docs/awscc-docs/providers/awscc/dynamodb/table/index.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -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
sse_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. - -## Example -```sql -SELECT -region, -sse_specification, -kinesis_stream_specification, -stream_specification, -contributor_insights_specification, -import_source_specification, -point_in_time_recovery_specification, -provisioned_throughput, -table_name, -attribute_definitions, -billing_mode, -global_secondary_indexes, -key_schema, -local_secondary_indexes, -arn, -stream_arn, -deletion_protection_enabled, -table_class, -tags, -time_to_live_specification -FROM awscc.dynamodb.table -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the table resource, the following permissions are required: - -### Read -```json -dynamodb:DescribeTable, -dynamodb:DescribeContinuousBackups, -dynamodb:DescribeContributorInsights, -dynamodb:DescribeKinesisStreamingDestination, -dynamodb:ListTagsOfResource, -dynamodb:GetResourcePolicy -``` - -### Update -```json -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 -```json -dynamodb:DeleteTable, -dynamodb:DescribeTable -``` - diff --git a/docs/awscc-docs/providers/awscc/dynamodb/tables/index.md b/docs/awscc-docs/providers/awscc/dynamodb/tables/index.md deleted file mode 100644 index 0e90e26197..0000000000 --- a/docs/awscc-docs/providers/awscc/dynamodb/tables/index.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -table_name -FROM awscc.dynamodb.tables -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the tables resource, the following permissions are required: - -### Create -```json -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 -```json -dynamodb:ListTables -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/capacity_reservation/index.md b/docs/awscc-docs/providers/awscc/ec2/capacity_reservation/index.md deleted file mode 100644 index 64fe69a3de..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/capacity_reservation/index.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -title: capacity_reservation -hide_title: false -hide_table_of_contents: false -keywords: - - capacity_reservation - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual capacity_reservation resource - -## Overview - - - - - -
Namecapacity_reservation
TypeResource
Descriptioncapacity_reservation
Idawscc.ec2.capacity_reservation
- -## Fields - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
tenancystring
end_date_typestring
tag_specificationsarray
availability_zonestring
total_instance_countinteger
end_datestring
ebs_optimizedboolean
out_post_arnstring
instance_countinteger
placement_group_arnstring
available_instance_countinteger
instance_platformstring
idstring
instance_typestring
ephemeral_storageboolean
instance_match_criteriastring
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -tenancy, -end_date_type, -tag_specifications, -availability_zone, -total_instance_count, -end_date, -ebs_optimized, -out_post_arn, -instance_count, -placement_group_arn, -available_instance_count, -instance_platform, -id, -instance_type, -ephemeral_storage, -instance_match_criteria -FROM awscc.ec2.capacity_reservation -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the capacity_reservation resource, the following permissions are required: - -### Delete -```json -ec2:CreateCapacityReservation, -ec2:DescribeCapacityReservations, -ec2:CancelCapacityReservation, -ec2:DeleteTags -``` - -### Read -```json -ec2:DescribeCapacityReservations -``` - -### Update -```json -ec2:ModifyCapacityReservation, -ec2:CreateCapacityReservation, -ec2:DescribeCapacityReservations, -ec2:CancelCapacityReservation, -ec2:CreateTags, -ec2:DeleteTags -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/capacity_reservation_fleet/index.md b/docs/awscc-docs/providers/awscc/ec2/capacity_reservation_fleet/index.md deleted file mode 100644 index 288d4a2543..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/capacity_reservation_fleet/index.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -title: capacity_reservation_fleet -hide_title: false -hide_table_of_contents: false -keywords: - - capacity_reservation_fleet - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual capacity_reservation_fleet resource - -## Overview - - - - - -
Namecapacity_reservation_fleet
TypeResource
Descriptioncapacity_reservation_fleet
Idawscc.ec2.capacity_reservation_fleet
- -## Fields - - - - - - - - - - - - - - -
NameDatatypeDescription
allocation_strategystring
tag_specificationsarray
instance_type_specificationsarray
total_target_capacityinteger
end_datestring
instance_match_criteriastring
capacity_reservation_fleet_idstring
tenancystring
remove_end_dateboolean
no_remove_end_dateboolean
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -allocation_strategy, -tag_specifications, -instance_type_specifications, -total_target_capacity, -end_date, -instance_match_criteria, -capacity_reservation_fleet_id, -tenancy, -remove_end_date, -no_remove_end_date -FROM awscc.ec2.capacity_reservation_fleet -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the capacity_reservation_fleet resource, the following permissions are required: - -### Delete -```json -ec2:CreateCapacityReservationFleet, -ec2:ModifyCapacityReservationFleet, -ec2:DescribeCapacityReservationFleets, -ec2:CancelCapacityReservationFleets, -ec2:CreateCapacityReservation, -ec2:DescribeCapacityReservations, -ec2:CancelCapacityReservation, -ec2:DeleteTags -``` - -### Read -```json -ec2:DescribeCapacityReservationFleets, -ec2:DescribeInstances, -ec2:DescribeCapacityReservations -``` - -### Update -```json -ec2:CreateCapacityReservationFleet, -ec2:ModifyCapacityReservationFleet, -ec2:DescribeCapacityReservationFleets, -ec2:CancelCapacityReservationFleets, -ec2:CreateCapacityReservation, -ec2:ModifyCapacityReservation, -ec2:DescribeCapacityReservations, -ec2:CancelCapacityReservation, -ec2:DescribeInstances, -ec2:DeleteTags -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/capacity_reservation_fleets/index.md b/docs/awscc-docs/providers/awscc/ec2/capacity_reservation_fleets/index.md deleted file mode 100644 index be18df59f7..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/capacity_reservation_fleets/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: capacity_reservation_fleets -hide_title: false -hide_table_of_contents: false -keywords: - - capacity_reservation_fleets - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of capacity_reservation_fleets in a region - -## Overview - - - - - -
Namecapacity_reservation_fleets
TypeResource
Descriptioncapacity_reservation_fleets
Idawscc.ec2.capacity_reservation_fleets
- -## Fields - - - - - -
NameDatatypeDescription
capacity_reservation_fleet_idstring
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -capacity_reservation_fleet_id -FROM awscc.ec2.capacity_reservation_fleets -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the capacity_reservation_fleets resource, the following permissions are required: - -### Create -```json -ec2:CreateCapacityReservationFleet, -ec2:ModifyCapacityReservationFleet, -ec2:DescribeCapacityReservationFleets, -ec2:CancelCapacityReservationFleets, -ec2:CreateCapacityReservation, -ec2:DescribeCapacityReservations, -ec2:CancelCapacityReservation, -ec2:DescribeInstances, -ec2:CreateTags, -iam:CreateServiceLinkedRole -``` - -### List -```json -ec2:DescribeCapacityReservationFleets, -ec2:DescribeCapacityReservations, -ec2:DescribeInstances -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/capacity_reservations/index.md b/docs/awscc-docs/providers/awscc/ec2/capacity_reservations/index.md deleted file mode 100644 index 4051771e16..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/capacity_reservations/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: capacity_reservations -hide_title: false -hide_table_of_contents: false -keywords: - - capacity_reservations - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of capacity_reservations in a region - -## Overview - - - - - -
Namecapacity_reservations
TypeResource
Descriptioncapacity_reservations
Idawscc.ec2.capacity_reservations
- -## Fields - - - - - -
NameDatatypeDescription
idstring
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -id -FROM awscc.ec2.capacity_reservations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the capacity_reservations resource, the following permissions are required: - -### Create -```json -ec2:CreateCapacityReservation, -ec2:DescribeCapacityReservations, -ec2:CancelCapacityReservation, -ec2:CreateTags -``` - -### List -```json -ec2:DescribeCapacityReservations -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/carrier_gateway/index.md b/docs/awscc-docs/providers/awscc/ec2/carrier_gateway/index.md deleted file mode 100644 index 0b7bd83ae5..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/carrier_gateway/index.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -title: carrier_gateway -hide_title: false -hide_table_of_contents: false -keywords: - - carrier_gateway - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual carrier_gateway resource - -## Overview - - - - - -
Namecarrier_gateway
TypeResource
Descriptioncarrier_gateway
Idawscc.ec2.carrier_gateway
- -## Fields - - - - - - - - - -
NameDatatypeDescription
carrier_gateway_idstringThe ID of the carrier gateway.
statestringThe state of the carrier gateway.
vpc_idstringThe ID of the VPC.
owner_idstringThe ID of the owner.
tagsarrayThe tags for the carrier gateway.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -carrier_gateway_id, -state, -vpc_id, -owner_id, -tags -FROM awscc.ec2.carrier_gateway -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the carrier_gateway resource, the following permissions are required: - -### Read -```json -ec2:DescribeCarrierGateways -``` - -### Update -```json -ec2:DescribeCarrierGateways, -ec2:CreateTags, -ec2:DeleteTags -``` - -### Delete -```json -ec2:DeleteCarrierGateway, -ec2:DescribeCarrierGateways -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/carrier_gateways/index.md b/docs/awscc-docs/providers/awscc/ec2/carrier_gateways/index.md deleted file mode 100644 index 823be54875..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/carrier_gateways/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: carrier_gateways -hide_title: false -hide_table_of_contents: false -keywords: - - carrier_gateways - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of carrier_gateways in a region - -## Overview - - - - - -
Namecarrier_gateways
TypeResource
Descriptioncarrier_gateways
Idawscc.ec2.carrier_gateways
- -## Fields - - - - - -
NameDatatypeDescription
carrier_gateway_idstringThe ID of the carrier gateway.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -carrier_gateway_id -FROM awscc.ec2.carrier_gateways -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the carrier_gateways resource, the following permissions are required: - -### Create -```json -ec2:CreateCarrierGateway, -ec2:DescribeCarrierGateways, -ec2:CreateTags -``` - -### List -```json -ec2:DescribeCarrierGateways -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/customer_gateway/index.md b/docs/awscc-docs/providers/awscc/ec2/customer_gateway/index.md deleted file mode 100644 index 527b3fd173..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/customer_gateway/index.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -title: customer_gateway -hide_title: false -hide_table_of_contents: false -keywords: - - customer_gateway - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual customer_gateway resource - -## Overview - - - - - -
Namecustomer_gateway
TypeResource
Descriptioncustomer_gateway
Idawscc.ec2.customer_gateway
- -## Fields - - - - - - - - - - -
NameDatatypeDescription
customer_gateway_idstringCustomerGateway ID generated after customer gateway is created. Each customer gateway has a unique ID.
bgp_asnintegerFor devices that support BGP, the customer gateway's BGP ASN.
ip_addressstringThe internet-routable IP address for the customer gateway's outside interface. The address must be static.
tagsarrayOne or more tags for the customer gateway.
typestringThe type of VPN connection that this customer gateway supports.
device_namestringA name for the customer gateway device.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -customer_gateway_id, -bgp_asn, -ip_address, -tags, -type, -device_name -FROM awscc.ec2.customer_gateway -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the customer_gateway resource, the following permissions are required: - -### Read -```json -ec2:DescribeCustomerGateways -``` - -### Update -```json -ec2:CreateTags, -ec2:DeleteTags -``` - -### Delete -```json -ec2:DeleteCustomerGateway, -ec2:DescribeCustomerGateways -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/customer_gateways/index.md b/docs/awscc-docs/providers/awscc/ec2/customer_gateways/index.md deleted file mode 100644 index a99e91c0b0..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/customer_gateways/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: customer_gateways -hide_title: false -hide_table_of_contents: false -keywords: - - customer_gateways - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of customer_gateways in a region - -## Overview - - - - - -
Namecustomer_gateways
TypeResource
Descriptioncustomer_gateways
Idawscc.ec2.customer_gateways
- -## Fields - - - - - -
NameDatatypeDescription
customer_gateway_idstringCustomerGateway ID generated after customer gateway is created. Each customer gateway has a unique ID.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -customer_gateway_id -FROM awscc.ec2.customer_gateways -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the customer_gateways resource, the following permissions are required: - -### Create -```json -ec2:CreateCustomerGateway, -ec2:DescribeCustomerGateways -``` - -### List -```json -ec2:DescribeCustomerGateways -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/dhcp_options/index.md b/docs/awscc-docs/providers/awscc/ec2/dhcp_options/index.md deleted file mode 100644 index 7deb8fe86d..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/dhcp_options/index.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -title: dhcp_options -hide_title: false -hide_table_of_contents: false -keywords: - - dhcp_options - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual dhcp_options resource - -## Overview - - - - - -
Namedhcp_options
TypeResource
Descriptiondhcp_options
Idawscc.ec2.dhcp_options
- -## Fields - - - - - - - - - - - -
NameDatatypeDescription
netbios_name_serversarrayThe IPv4 addresses of up to four NetBIOS name servers.
ntp_serversarrayThe IPv4 addresses of up to four Network Time Protocol (NTP) servers.
dhcp_options_idstring
domain_namestringThis value is used to complete unqualified DNS hostnames.
netbios_node_typeintegerThe NetBIOS node type (1, 2, 4, or 8).
domain_name_serversarrayThe IPv4 addresses of up to four domain name servers, or AmazonProvidedDNS.
tagsarrayAny tags assigned to the DHCP options set.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -netbios_name_servers, -ntp_servers, -dhcp_options_id, -domain_name, -netbios_node_type, -domain_name_servers, -tags -FROM awscc.ec2.dhcp_options -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the dhcp_options resource, the following permissions are required: - -### Read -```json -ec2:DescribeDhcpOptions, -ec2:DescribeTags -``` - -### Update -```json -ec2:CreateTags, -ec2:DescribeDhcpOptions, -ec2:DeleteTags -``` - -### Delete -```json -ec2:DeleteDhcpOptions, -ec2:DeleteTags, -ec2:DescribeDhcpOptions -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/ec2fleet/index.md b/docs/awscc-docs/providers/awscc/ec2/ec2fleet/index.md deleted file mode 100644 index 76f4535ff5..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/ec2fleet/index.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -title: ec2fleet -hide_title: false -hide_table_of_contents: false -keywords: - - ec2fleet - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual ec2fleet resource - -## Overview - - - - - -
Nameec2fleet
TypeResource
Descriptionec2fleet
Idawscc.ec2.ec2fleet
- -## Fields - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
target_capacity_specificationobject
on_demand_optionsobject
typestring
excess_capacity_termination_policystring
tag_specificationsarray
spot_optionsobject
valid_fromstring
replace_unhealthy_instancesboolean
launch_template_configsarray
fleet_idstring
terminate_instances_with_expirationboolean
valid_untilstring
contextstring
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -target_capacity_specification, -on_demand_options, -type, -excess_capacity_termination_policy, -tag_specifications, -spot_options, -valid_from, -replace_unhealthy_instances, -launch_template_configs, -fleet_id, -terminate_instances_with_expiration, -valid_until, -context -FROM awscc.ec2.ec2fleet -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the ec2fleet resource, the following permissions are required: - -### Delete -```json -ec2:DescribeFleets, -ec2:DeleteFleets -``` - -### Read -```json -ec2:DescribeFleets -``` - -### Update -```json -ec2:ModifyFleet, -ec2:DescribeFleets -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/ec2fleets/index.md b/docs/awscc-docs/providers/awscc/ec2/ec2fleets/index.md deleted file mode 100644 index d6e0c44423..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/ec2fleets/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: ec2fleets -hide_title: false -hide_table_of_contents: false -keywords: - - ec2fleets - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of ec2fleets in a region - -## Overview - - - - - -
Nameec2fleets
TypeResource
Descriptionec2fleets
Idawscc.ec2.ec2fleets
- -## Fields - - - - - -
NameDatatypeDescription
fleet_idstring
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -fleet_id -FROM awscc.ec2.ec2fleets -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the ec2fleets resource, the following permissions are required: - -### Create -```json -ec2:CreateFleet, -ec2:DescribeFleets -``` - -### List -```json -ec2:DescribeFleets -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/egress_only_internet_gateway/index.md b/docs/awscc-docs/providers/awscc/ec2/egress_only_internet_gateway/index.md deleted file mode 100644 index 9e10809c73..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/egress_only_internet_gateway/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: egress_only_internet_gateway -hide_title: false -hide_table_of_contents: false -keywords: - - egress_only_internet_gateway - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual egress_only_internet_gateway resource - -## Overview - - - - - -
Nameegress_only_internet_gateway
TypeResource
Descriptionegress_only_internet_gateway
Idawscc.ec2.egress_only_internet_gateway
- -## Fields - - - - - - -
NameDatatypeDescription
idstringService Generated ID of the EgressOnlyInternetGateway
vpc_idstringThe ID of the VPC for which to create the egress-only internet gateway.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -id, -vpc_id -FROM awscc.ec2.egress_only_internet_gateway -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the egress_only_internet_gateway resource, the following permissions are required: - -### Read -```json -ec2:DescribeEgressOnlyInternetGateways -``` - -### Delete -```json -ec2:DeleteEgressOnlyInternetGateway, -ec2:DescribeEgressOnlyInternetGateways, -ec2:DescribeVpcs -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/egress_only_internet_gateways/index.md b/docs/awscc-docs/providers/awscc/ec2/egress_only_internet_gateways/index.md deleted file mode 100644 index 9a6076eefa..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/egress_only_internet_gateways/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: egress_only_internet_gateways -hide_title: false -hide_table_of_contents: false -keywords: - - egress_only_internet_gateways - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of egress_only_internet_gateways in a region - -## Overview - - - - - -
Nameegress_only_internet_gateways
TypeResource
Descriptionegress_only_internet_gateways
Idawscc.ec2.egress_only_internet_gateways
- -## Fields - - - - - -
NameDatatypeDescription
idstringService Generated ID of the EgressOnlyInternetGateway
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -id -FROM awscc.ec2.egress_only_internet_gateways -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the egress_only_internet_gateways resource, the following permissions are required: - -### Create -```json -ec2:CreateEgressOnlyInternetGateway, -ec2:DescribeEgressOnlyInternetGateways -``` - -### List -```json -ec2:DescribeEgressOnlyInternetGateways -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/eip/index.md b/docs/awscc-docs/providers/awscc/ec2/eip/index.md deleted file mode 100644 index d9491e0554..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/eip/index.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -title: eip -hide_title: false -hide_table_of_contents: false -keywords: - - eip - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual eip resource - -## Overview - - - - - -
Nameeip
TypeResource
Descriptioneip
Idawscc.ec2.eip
- -## Fields - - - - - - - - - - - - -
NameDatatypeDescription
public_ipstring
allocation_idstring
domainstringThe network (``vpc``).<br/> If you define an Elastic IP address and associate it with a VPC that is defined in the same template, you must declare a dependency on the VPC-gateway attachment by using the [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) on this resource.
network_border_groupstringA unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network border groups.<br/> Use [DescribeAvailabilityZones](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAvailabilityZones.html) to view the network border groups.
transfer_addressstringThe Elastic IP address you are accepting for transfer. You can only accept one transferred address. For more information on Elastic IP address transfers, see [Transfer Elastic IP addresses](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#transfer-EIPs-intro) in the *Amazon Virtual Private Cloud User Guide*.
instance_idstringThe ID of the instance.<br/> Updates to the ``InstanceId`` property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource.
public_ipv4_poolstringThe ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool.<br/> Updates to the ``PublicIpv4Pool`` property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource.
tagsarrayAny tags assigned to the Elastic IP address.<br/> Updates to the ``Tags`` property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -public_ip, -allocation_id, -domain, -network_border_group, -transfer_address, -instance_id, -public_ipv4_pool, -tags -FROM awscc.ec2.eip -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the eip resource, the following permissions are required: - -### Read -```json -ec2:DescribeAddresses -``` - -### Delete -```json -ec2:ReleaseAddress, -ec2:DescribeAddresses, -ec2:DisassociateAddress -``` - -### Update -```json -ec2:DescribeAddresses, -ec2:DisassociateAddress, -ec2:DeleteTags, -ec2:CreateTags, -ec2:AssociateAddress -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/eip_association/index.md b/docs/awscc-docs/providers/awscc/ec2/eip_association/index.md deleted file mode 100644 index 187f98b434..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/eip_association/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: eip_association -hide_title: false -hide_table_of_contents: false -keywords: - - eip_association - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual eip_association resource - -## Overview - - - - - -
Nameeip_association
TypeResource
Descriptioneip_association
Idawscc.ec2.eip_association
- -## Fields - - - - - - - - - - -
NameDatatypeDescription
idstringComposite ID of non-empty properties, to determine the identification.
allocation_idstringThe allocation ID. This is required for EC2-VPC.
network_interface_idstringThe ID of the network interface.
instance_idstringThe ID of the instance.
private_ip_addressstringThe primary or secondary private IP address to associate with the Elastic IP address.
e_ipstringThe Elastic IP address to associate with the instance.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -id, -allocation_id, -network_interface_id, -instance_id, -private_ip_address, -e_ip -FROM awscc.ec2.eip_association -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the eip_association resource, the following permissions are required: - -### Read -```json -ec2:DescribeAddresses -``` - -### Delete -```json -ec2:DisassociateAddress, -ec2:DescribeAddresses -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/eip_associations/index.md b/docs/awscc-docs/providers/awscc/ec2/eip_associations/index.md deleted file mode 100644 index dc9fa5e2f0..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/eip_associations/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: eip_associations -hide_title: false -hide_table_of_contents: false -keywords: - - eip_associations - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of eip_associations in a region - -## Overview - - - - - -
Nameeip_associations
TypeResource
Descriptioneip_associations
Idawscc.ec2.eip_associations
- -## Fields - - - - - -
NameDatatypeDescription
idstringComposite ID of non-empty properties, to determine the identification.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -id -FROM awscc.ec2.eip_associations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the eip_associations resource, the following permissions are required: - -### Create -```json -ec2:DescribeAddresses, -ec2:AssociateAddress -``` - -### List -```json -ec2:DescribeAddresses -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/eips/index.md b/docs/awscc-docs/providers/awscc/ec2/eips/index.md deleted file mode 100644 index ef0c55661a..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/eips/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: eips -hide_title: false -hide_table_of_contents: false -keywords: - - eips - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of eips in a region - -## Overview - - - - - -
Nameeips
TypeResource
Descriptioneips
Idawscc.ec2.eips
- -## Fields - - - - - - -
NameDatatypeDescription
public_ipstring
allocation_idstring
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -public_ip, -allocation_id -FROM awscc.ec2.eips -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the eips resource, the following permissions are required: - -### Create -```json -ec2:AllocateAddress, -ec2:AcceptAddressTransfer, -ec2:DescribeAddresses, -ec2:AssociateAddress, -ec2:CreateTags -``` - -### List -```json -ec2:DescribeAddresses -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/enclave_certificate_iam_role_association/index.md b/docs/awscc-docs/providers/awscc/ec2/enclave_certificate_iam_role_association/index.md deleted file mode 100644 index 88a2957b94..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/enclave_certificate_iam_role_association/index.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: enclave_certificate_iam_role_association -hide_title: false -hide_table_of_contents: false -keywords: - - enclave_certificate_iam_role_association - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual enclave_certificate_iam_role_association resource - -## Overview - - - - - -
Nameenclave_certificate_iam_role_association
TypeResource
Descriptionenclave_certificate_iam_role_association
Idawscc.ec2.enclave_certificate_iam_role_association
- -## Fields - - - - - - - - - -
NameDatatypeDescription
certificate_arnstringThe Amazon Resource Name (ARN) of the ACM certificate with which to associate the IAM role.
role_arnstringThe Amazon Resource Name (ARN) of the IAM role to associate with the ACM certificate. You can associate up to 16 IAM roles with an ACM certificate.
certificate_s3_bucket_namestringThe name of the Amazon S3 bucket to which the certificate was uploaded.
certificate_s3_object_keystringThe Amazon S3 object key where the certificate, certificate chain, and encrypted private key bundle are stored.
encryption_kms_key_idstringThe ID of the AWS KMS CMK used to encrypt the private key of the certificate.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -certificate_arn, -role_arn, -certificate_s3_bucket_name, -certificate_s3_object_key, -encryption_kms_key_id -FROM awscc.ec2.enclave_certificate_iam_role_association -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the enclave_certificate_iam_role_association resource, the following permissions are required: - -### Read -```json -ec2:GetAssociatedEnclaveCertificateIamRoles -``` - -### Delete -```json -ec2:DisassociateEnclaveCertificateIamRole -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/enclave_certificate_iam_role_associations/index.md b/docs/awscc-docs/providers/awscc/ec2/enclave_certificate_iam_role_associations/index.md deleted file mode 100644 index 3faa7fd043..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/enclave_certificate_iam_role_associations/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: enclave_certificate_iam_role_associations -hide_title: false -hide_table_of_contents: false -keywords: - - enclave_certificate_iam_role_associations - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of enclave_certificate_iam_role_associations in a region - -## Overview - - - - - -
Nameenclave_certificate_iam_role_associations
TypeResource
Descriptionenclave_certificate_iam_role_associations
Idawscc.ec2.enclave_certificate_iam_role_associations
- -## Fields - - - - - - -
NameDatatypeDescription
certificate_arnstringThe Amazon Resource Name (ARN) of the ACM certificate with which to associate the IAM role.
role_arnstringThe Amazon Resource Name (ARN) of the IAM role to associate with the ACM certificate. You can associate up to 16 IAM roles with an ACM certificate.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -certificate_arn, -role_arn -FROM awscc.ec2.enclave_certificate_iam_role_associations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the enclave_certificate_iam_role_associations resource, the following permissions are required: - -### Create -```json -ec2:AssociateEnclaveCertificateIamRole -``` - -### List -```json -ec2:GetAssociatedEnclaveCertificateIamRoles -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/flow_log/index.md b/docs/awscc-docs/providers/awscc/ec2/flow_log/index.md deleted file mode 100644 index 9e835c36ae..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/flow_log/index.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -title: flow_log -hide_title: false -hide_table_of_contents: false -keywords: - - flow_log - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual flow_log resource - -## Overview - - - - - -
Nameflow_log
TypeResource
Descriptionflow_log
Idawscc.ec2.flow_log
- -## Fields - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
idstringThe Flow Log ID
deliver_cross_account_rolestringThe ARN of the IAM role that allows Amazon EC2 to publish flow logs across accounts.
deliver_logs_permission_arnstringThe ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account. If you specify LogDestinationType as s3 or kinesis-data-firehose, do not specify DeliverLogsPermissionArn or LogGroupName.
log_destinationstringSpecifies the destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group, an Amazon S3 bucket, or a Kinesis Firehose stream. The value specified for this parameter depends on the value specified for LogDestinationType.
log_destination_typestringSpecifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3.
log_formatstringThe fields to include in the flow log record, in the order in which they should appear.
log_group_namestringThe name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs. If you specify LogDestinationType as s3 or kinesis-data-firehose, do not specify DeliverLogsPermissionArn or LogGroupName.
max_aggregation_intervalintegerThe maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes).
resource_idstringThe ID of the subnet, network interface, or VPC for which you want to create a flow log.
resource_typestringThe type of resource for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property.
tagsarrayThe tags to apply to the flow logs.
traffic_typestringThe type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.
destination_optionsobject
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -id, -deliver_cross_account_role, -deliver_logs_permission_arn, -log_destination, -log_destination_type, -log_format, -log_group_name, -max_aggregation_interval, -resource_id, -resource_type, -tags, -traffic_type, -destination_options -FROM awscc.ec2.flow_log -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the flow_log resource, the following permissions are required: - -### Read -```json -ec2:DescribeFlowLogs -``` - -### Update -```json -ec2:CreateTags, -ec2:DeleteTags, -ec2:DescribeFlowLogs -``` - -### Delete -```json -ec2:DeleteFlowLogs, -ec2:DescribeFlowLogs, -logs:DeleteLogDelivery -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/flow_logs/index.md b/docs/awscc-docs/providers/awscc/ec2/flow_logs/index.md deleted file mode 100644 index f095996040..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/flow_logs/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: flow_logs -hide_title: false -hide_table_of_contents: false -keywords: - - flow_logs - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of flow_logs in a region - -## Overview - - - - - -
Nameflow_logs
TypeResource
Descriptionflow_logs
Idawscc.ec2.flow_logs
- -## Fields - - - - - -
NameDatatypeDescription
idstringThe Flow Log ID
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -id -FROM awscc.ec2.flow_logs -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the flow_logs resource, the following permissions are required: - -### Create -```json -ec2:CreateFlowLogs, -ec2:DescribeFlowLogs, -ec2:CreateTags, -iam:PassRole, -logs:CreateLogDelivery, -s3:GetBucketPolicy, -s3:PutBucketPolicy -``` - -### List -```json -ec2:DescribeFlowLogs -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/gateway_route_table_association/index.md b/docs/awscc-docs/providers/awscc/ec2/gateway_route_table_association/index.md deleted file mode 100644 index 056a42eedb..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/gateway_route_table_association/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: gateway_route_table_association -hide_title: false -hide_table_of_contents: false -keywords: - - gateway_route_table_association - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual gateway_route_table_association resource - -## Overview - - - - - -
Namegateway_route_table_association
TypeResource
Descriptiongateway_route_table_association
Idawscc.ec2.gateway_route_table_association
- -## Fields - - - - - - - -
NameDatatypeDescription
route_table_idstringThe ID of the route table.
gateway_idstringThe ID of the gateway.
association_idstringThe route table association ID.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -route_table_id, -gateway_id, -association_id -FROM awscc.ec2.gateway_route_table_association -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the gateway_route_table_association resource, the following permissions are required: - -### Read -```json -ec2:DescribeRouteTables -``` - -### Update -```json -ec2:DescribeRouteTables, -ec2:ReplaceRouteTableAssociation -``` - -### Delete -```json -ec2:DescribeRouteTables, -ec2:DisassociateRouteTable -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/host/index.md b/docs/awscc-docs/providers/awscc/ec2/host/index.md deleted file mode 100644 index b40d357879..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/host/index.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -title: host -hide_title: false -hide_table_of_contents: false -keywords: - - host - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual host resource - -## Overview - - - - - -
Namehost
TypeResource
Descriptionhost
Idawscc.ec2.host
- -## Fields - - - - - - - - - - - - - -
NameDatatypeDescription
host_idstringID of the host created.
auto_placementstringIndicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID.
availability_zonestringThe Availability Zone in which to allocate the Dedicated Host.
host_recoverystringIndicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default.
instance_typestringSpecifies the instance type to be supported by the Dedicated Hosts. If you specify an instance type, the Dedicated Hosts support instances of the specified instance type only.
instance_familystringSpecifies the instance family to be supported by the Dedicated Hosts. If you specify an instance family, the Dedicated Hosts support multiple instance types within that instance family.
outpost_arnstringThe Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which to allocate the Dedicated Host.
host_maintenancestringAutomatically allocates a new dedicated host and moves your instances on to it if a degradation is detected on your current host.
asset_idstringThe ID of the Outpost hardware asset.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -host_id, -auto_placement, -availability_zone, -host_recovery, -instance_type, -instance_family, -outpost_arn, -host_maintenance, -asset_id -FROM awscc.ec2.host -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the host resource, the following permissions are required: - -### Read -```json -ec2:DescribeHosts -``` - -### Update -```json -ec2:ModifyHosts, -ec2:DescribeHosts -``` - -### Delete -```json -ec2:ReleaseHosts, -ec2:DescribeHosts -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/hosts/index.md b/docs/awscc-docs/providers/awscc/ec2/hosts/index.md deleted file mode 100644 index 6c122eb64e..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/hosts/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: hosts -hide_title: false -hide_table_of_contents: false -keywords: - - hosts - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of hosts in a region - -## Overview - - - - - -
Namehosts
TypeResource
Descriptionhosts
Idawscc.ec2.hosts
- -## Fields - - - - - -
NameDatatypeDescription
host_idstringID of the host created.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -host_id -FROM awscc.ec2.hosts -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the hosts resource, the following permissions are required: - -### Create -```json -ec2:AllocateHosts, -ec2:DescribeHosts -``` - -### List -```json -ec2:DescribeHosts -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/index.md b/docs/awscc-docs/providers/awscc/ec2/index.md deleted file mode 100644 index ce55a796a1..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/index.md +++ /dev/null @@ -1,188 +0,0 @@ ---- -title: ec2 -hide_title: false -hide_table_of_contents: false -keywords: - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- - -The ec2 service documentation. - -:::info Service Summary - -
-
-total resources: 151
-total selectable resources: 151
-total methods: 151
-
-
- -::: - -## Resources -
-
-capacity_reservation
-capacity_reservation_fleet
-capacity_reservation_fleets
-capacity_reservations
-carrier_gateway
-carrier_gateways
-customer_gateway
-customer_gateways
-dhcp_options
-ec2fleet
-ec2fleets
-egress_only_internet_gateway
-egress_only_internet_gateways
-eip
-eip_association
-eip_associations
-eips
-enclave_certificate_iam_role_association
-enclave_certificate_iam_role_associations
-flow_log
-flow_logs
-gateway_route_table_association
-host
-hosts
-instance_connect_endpoint
-instance_connect_endpoints
-instances
-internet_gateway
-internet_gateways
-ipam
-ipam_allocation
-ipam_allocations
-ipam_pool
-ipam_pool_cidr
-ipam_pool_cidrs
-ipam_pools
-ipam_resource_discoveries
-ipam_resource_discovery
-ipam_resource_discovery_association
-ipam_resource_discovery_associations
-ipam_scope
-ipam_scopes
-ipams
-key_pair
-key_pairs
-launch_template
-launch_templates
-local_gateway_route
-local_gateway_route_table
-local_gateway_route_table_virtual_interface_group_association
-local_gateway_route_table_virtual_interface_group_associations
-local_gateway_route_tables
-local_gateway_route_tablevpc_association
-local_gateway_route_tablevpc_associations
-local_gateway_routes
-nat_gateway
-nat_gateways
-network_acl
-network_acls
-network_insights_access_scope
-network_insights_access_scope_analyses
-network_insights_access_scope_analysis
-network_insights_access_scopes
-network_insights_analyses
-network_insights_analysis
-network_insights_path
-network_insights_paths
-network_interface
-network_interface_attachment
-network_interface_attachments
-network_interfaces
-network_performance_metric_subscription
-network_performance_metric_subscriptions
-placement_group
-placement_groups
-prefix_list -
-
-prefix_lists
-route
-route_table
-route_tables
-routes
-security_group_egress
-security_group_egresses
-security_group_ingress
-security_group_ingresses
-snapshot_block_public_access
-snapshot_block_public_accesses
-snapshots
-spot_fleet
-spot_fleets
-subnet
-subnet_cidr_block
-subnet_cidr_blocks
-subnet_network_acl_association
-subnet_network_acl_associations
-subnet_route_table_association
-subnet_route_table_associations
-subnets
-transit_gateway
-transit_gateway_attachment
-transit_gateway_attachments
-transit_gateway_connect
-transit_gateway_connects
-transit_gateway_multicast_domain
-transit_gateway_multicast_domain_association
-transit_gateway_multicast_domain_associations
-transit_gateway_multicast_domains
-transit_gateway_multicast_group_member
-transit_gateway_multicast_group_members
-transit_gateway_multicast_group_source
-transit_gateway_multicast_group_sources
-transit_gateway_peering_attachment
-transit_gateway_peering_attachments
-transit_gateway_route_table
-transit_gateway_route_tables
-transit_gateway_vpc_attachment
-transit_gateway_vpc_attachments
-transit_gateways
-verified_access_endpoint
-verified_access_endpoints
-verified_access_group
-verified_access_groups
-verified_access_instance
-verified_access_instances
-verified_access_trust_provider
-verified_access_trust_providers
-volume
-volume_attachment
-volume_attachments
-volumes
-vpc
-vpc_endpoint
-vpc_endpoint_connection_notification
-vpc_endpoint_connection_notifications
-vpc_endpoint_service
-vpc_endpoint_service_permissions
-vpc_endpoint_services
-vpc_endpoints
-vpc_gateway_attachment
-vpc_gateway_attachments
-vpc_peering_connection
-vpc_peering_connections
-vpcdhcp_options_association
-vpcdhcp_options_associations
-vpcs
-vpn_connection
-vpn_connection_route
-vpn_connection_routes
-vpn_connections
-vpn_gateway
-vpn_gateways -
-
\ No newline at end of file diff --git a/docs/awscc-docs/providers/awscc/ec2/instance_connect_endpoint/index.md b/docs/awscc-docs/providers/awscc/ec2/instance_connect_endpoint/index.md deleted file mode 100644 index 4d75706953..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/instance_connect_endpoint/index.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -title: instance_connect_endpoint -hide_title: false -hide_table_of_contents: false -keywords: - - instance_connect_endpoint - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual instance_connect_endpoint resource - -## Overview - - - - - -
Nameinstance_connect_endpoint
TypeResource
Descriptioninstance_connect_endpoint
Idawscc.ec2.instance_connect_endpoint
- -## Fields - - - - - - - - - - -
NameDatatypeDescription
idstringThe id of the instance connect endpoint
subnet_idstringThe subnet id of the instance connect endpoint
client_tokenstringThe client token of the instance connect endpoint.
preserve_client_ipbooleanIf true, the address of the instance connect endpoint client is preserved when connecting to the end resource
tagsarrayThe tags of the instance connect endpoint.
security_group_idsarrayThe security group IDs of the instance connect endpoint.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -id, -subnet_id, -client_token, -preserve_client_ip, -tags, -security_group_ids -FROM awscc.ec2.instance_connect_endpoint -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the instance_connect_endpoint resource, the following permissions are required: - -### Read -```json -ec2:DescribeInstanceConnectEndpoints -``` - -### Update -```json -ec2:DescribeInstanceConnectEndpoints, -ec2:CreateTags, -ec2:DeleteTags -``` - -### Delete -```json -ec2:DeleteInstanceConnectEndpoint, -ec2:DescribeInstanceConnectEndpoints -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/instance_connect_endpoints/index.md b/docs/awscc-docs/providers/awscc/ec2/instance_connect_endpoints/index.md deleted file mode 100644 index 221a3e668e..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/instance_connect_endpoints/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: instance_connect_endpoints -hide_title: false -hide_table_of_contents: false -keywords: - - instance_connect_endpoints - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of instance_connect_endpoints in a region - -## Overview - - - - - -
Nameinstance_connect_endpoints
TypeResource
Descriptioninstance_connect_endpoints
Idawscc.ec2.instance_connect_endpoints
- -## Fields - - - - - -
NameDatatypeDescription
idstringThe id of the instance connect endpoint
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -id -FROM awscc.ec2.instance_connect_endpoints -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the instance_connect_endpoints resource, the following permissions are required: - -### Create -```json -ec2:CreateInstanceConnectEndpoint, -ec2:DescribeInstanceConnectEndpoints, -ec2:CreateTags, -ec2:CreateNetworkInterface, -iam:CreateServiceLinkedRole -``` - -### List -```json -ec2:DescribeInstanceConnectEndpoints -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/instances/index.md b/docs/awscc-docs/providers/awscc/ec2/instances/index.md deleted file mode 100644 index 3e79926a69..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/instances/index.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -title: instances -hide_title: false -hide_table_of_contents: false -keywords: - - instances - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -List of ec2 instances by region (requires `aws` provider to be installed) - -## Overview - - - - - -
Nameinstances
TypeResource
DescriptionList of ec2 instances by region (requires `aws` provider to be installed)
Idawscc.ec2.instances
- -## Fields - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
instance_idstringThe ID of the instance.
instance_stateobjectDescribes the current state of an instance.
instance_typestringThe instance type.
vpc_idstring
subnet_idstring
ami_launch_indexintegerThe AMI launch index, which can be used to find this instance in the launch group.
architecturestringThe architecture of the image.
block_device_mappingarrayAny block device mapping entries for the instance.
boot_modestringThe boot mode of the instance.
capacity_reservation_idstringThe ID of the Capacity Reservation.
capacity_reservation_specificationobjectDescribes the instances Capacity Reservation targeting preferences
client_tokenstringThe idempotency token you provided when you launched the instance, if applicable.
cpu_optionsobjectThe CPU options for the instance.
dns_namestring(IPv4 only) The public DNS name assigned to the instance.
ebs_optimizedbooleanIndicates whether the instance is optimized for Amazon EBS I/O.
elastic_gpu_association_setarrayThe Elastic GPU associated with the instance.
elastic_inference_accelerator_association_setarrayThe elastic inference accelerator associated with the instance.
ena_supportbooleanSpecifies whether enhanced networking with ENA is enabled.
enclave_optionsobjectIndicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
group_setarrayThe security groups for the instance.
hibernation_optionsobjectIndicates whether your instance is configured for hibernation.
hypervisorstringThe hypervisor type of the instance.
iam_instance_profileobjectDescribes an IAM instance profile.
image_idstringThe ID of the AMI used to launch the instance.
instance_lifecyclestringIndicates whether this is a Spot Instance or a Scheduled Instance.
ip_addressstringThe public IPv4 address, or the Carrier IP address assigned to the instance, if applicable.
ipv6_addressstringThe IPv6 address assigned to the instance.
kernel_idstringThe kernel associated with this instance, if applicable.
key_namestringThe name of the key pair, if this instance was launched with an associated key pair.
launch_timestringThe time the instance was launched.
license_setarrayThe license configurations for the instance.
maintenance_optionsobjectThe maintenance options for the instance.
metadata_optionsobjectThe metadata options for the instance.
monitoringobjectDescribes the monitoring of an instance.
network_interface_setarray[EC2-VPC] The network interfaces for the instance.
outpost_arnstring
placementobjectDescribes the placement of an instance.
platformstringThe value is Windows instances; otherwise blank.
platform_detailsstringThe platform details value for the instance.
private_dns_namestring(IPv4 only) The private DNS hostname name assigned to the instance.
private_dns_name_optionsobjectDescribes the options for instance hostnames.
private_ip_addressstringThe private IPv4 address assigned to the instance.
product_codesarrayThe product codes attached to this instance, if applicable.
ramdisk_idstringThe RAM disk associated with this instance, if applicable.
reasonstringThe reason for the most recent state transition. This might be an empty string.
root_device_namestringThe device name of the root device volume.
root_device_typestringThe root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.
source_dest_checkbooleanIndicates whether source/destination checking is enabled.
spot_instance_request_idstringIf the request is a Spot Instance request, the ID of the request.
sriov_net_supportstringSpecifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
state_reasonobjectDescribes a state change.
tag_setarray
tpm_supportstringIf the instance is configured for NitroTPM support
usage_operationstringThe usage operation value for the instance.
usage_operation_update_timestringThe time that the usage operation was last updated.
virtualization_typestringThe virtualization type of the instance.
regionstring
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -instance_id, -instance_state, -instance_type, -vpc_id, -subnet_id, -ami_launch_index, -architecture, -block_device_mapping, -boot_mode, -capacity_reservation_id, -capacity_reservation_specification, -client_token, -cpu_options, -dns_name, -ebs_optimized, -elastic_gpu_association_set, -elastic_inference_accelerator_association_set, -ena_support, -enclave_options, -group_set, -hibernation_options, -hypervisor, -iam_instance_profile, -image_id, -instance_lifecycle, -ip_address, -ipv6_address, -kernel_id, -key_name, -launch_time, -license_set, -maintenance_options, -metadata_options, -monitoring, -network_interface_set, -outpost_arn, -placement, -platform, -platform_details, -private_dns_name, -private_dns_name_options, -private_ip_address, -product_codes, -ramdisk_id, -reason, -root_device_name, -root_device_type, -source_dest_check, -spot_instance_request_id, -sriov_net_support, -state_reason, -tag_set, -tpm_support, -usage_operation, -usage_operation_update_time, -virtualization_type, -region -FROM awscc.ec2.instances -WHERE region = ''; -``` - - - - diff --git a/docs/awscc-docs/providers/awscc/ec2/internet_gateway/index.md b/docs/awscc-docs/providers/awscc/ec2/internet_gateway/index.md deleted file mode 100644 index 366ccf9d8b..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/internet_gateway/index.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: internet_gateway -hide_title: false -hide_table_of_contents: false -keywords: - - internet_gateway - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual internet_gateway resource - -## Overview - - - - - -
Nameinternet_gateway
TypeResource
Descriptioninternet_gateway
Idawscc.ec2.internet_gateway
- -## Fields - - - - - - -
NameDatatypeDescription
internet_gateway_idstringID of internet gateway.
tagsarrayAny tags to assign to the internet gateway.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -internet_gateway_id, -tags -FROM awscc.ec2.internet_gateway -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the internet_gateway resource, the following permissions are required: - -### Read -```json -ec2:DescribeInternetGateways -``` - -### Delete -```json -ec2:DeleteInternetGateway, -ec2:DescribeInternetGateways -``` - -### Update -```json -ec2:DeleteTags, -ec2:CreateTags, -ec2:DescribeInternetGateways -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/internet_gateways/index.md b/docs/awscc-docs/providers/awscc/ec2/internet_gateways/index.md deleted file mode 100644 index 3042da5409..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/internet_gateways/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: internet_gateways -hide_title: false -hide_table_of_contents: false -keywords: - - internet_gateways - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of internet_gateways in a region - -## Overview - - - - - -
Nameinternet_gateways
TypeResource
Descriptioninternet_gateways
Idawscc.ec2.internet_gateways
- -## Fields - - - - - -
NameDatatypeDescription
internet_gateway_idstringID of internet gateway.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -internet_gateway_id -FROM awscc.ec2.internet_gateways -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the internet_gateways resource, the following permissions are required: - -### Create -```json -ec2:CreateInternetGateway, -ec2:CreateTags, -ec2:DescribeInternetGateways -``` - -### List -```json -ec2:DescribeInternetGateways -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/ipam/index.md b/docs/awscc-docs/providers/awscc/ec2/ipam/index.md deleted file mode 100644 index ec43be36c4..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/ipam/index.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -title: ipam -hide_title: false -hide_table_of_contents: false -keywords: - - ipam - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual ipam resource - -## Overview - - - - - -
Nameipam
TypeResource
Descriptionipam
Idawscc.ec2.ipam
- -## Fields - - - - - - - - - - - - - - - - -
NameDatatypeDescription
ipam_idstringId of the IPAM.
arnstringThe Amazon Resource Name (ARN) of the IPAM.
default_resource_discovery_idstringThe Id of the default resource discovery, created with this IPAM.
default_resource_discovery_association_idstringThe Id of the default association to the default resource discovery, created with this IPAM.
resource_discovery_association_countintegerThe count of resource discoveries associated with this IPAM.
descriptionstring
public_default_scope_idstringThe Id of the default scope for publicly routable IP space, created with this IPAM.
private_default_scope_idstringThe Id of the default scope for publicly routable IP space, created with this IPAM.
scope_countintegerThe number of scopes that currently exist in this IPAM.
operating_regionsarrayThe regions IPAM is enabled for. Allows pools to be created in these regions, as well as enabling monitoring
tierstringThe tier of the IPAM.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -ipam_id, -arn, -default_resource_discovery_id, -default_resource_discovery_association_id, -resource_discovery_association_count, -description, -public_default_scope_id, -private_default_scope_id, -scope_count, -operating_regions, -tier, -tags -FROM awscc.ec2.ipam -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the ipam resource, the following permissions are required: - -### Read -```json -ec2:DescribeIpams -``` - -### Update -```json -ec2:ModifyIpam, -ec2:CreateTags, -ec2:DeleteTags, -ec2:DescribeIpams -``` - -### Delete -```json -ec2:DeleteIpam, -ec2:DeleteTags, -ec2:DescribeIpams -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/ipam_allocation/index.md b/docs/awscc-docs/providers/awscc/ec2/ipam_allocation/index.md deleted file mode 100644 index 511c2f19fe..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/ipam_allocation/index.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: ipam_allocation -hide_title: false -hide_table_of_contents: false -keywords: - - ipam_allocation - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual ipam_allocation resource - -## Overview - - - - - -
Nameipam_allocation
TypeResource
Descriptionipam_allocation
Idawscc.ec2.ipam_allocation
- -## Fields - - - - - - - - - -
NameDatatypeDescription
ipam_pool_allocation_idstringId of the allocation.
ipam_pool_idstringId of the IPAM Pool.
cidrstring
netmask_lengthintegerThe desired netmask length of the allocation. If set, IPAM will choose a block of free space with this size and return the CIDR representing it.
descriptionstring
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -ipam_pool_allocation_id, -ipam_pool_id, -cidr, -netmask_length, -description -FROM awscc.ec2.ipam_allocation -WHERE data__Identifier = '||'; -``` - -## Permissions - -To operate on the ipam_allocation resource, the following permissions are required: - -### Read -```json -ec2:GetIpamPoolAllocations -``` - -### Delete -```json -ec2:ReleaseIpamPoolAllocation -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/ipam_allocations/index.md b/docs/awscc-docs/providers/awscc/ec2/ipam_allocations/index.md deleted file mode 100644 index c6e879c694..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/ipam_allocations/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: ipam_allocations -hide_title: false -hide_table_of_contents: false -keywords: - - ipam_allocations - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of ipam_allocations in a region - -## Overview - - - - - -
Nameipam_allocations
TypeResource
Descriptionipam_allocations
Idawscc.ec2.ipam_allocations
- -## Fields - - - - - - - -
NameDatatypeDescription
ipam_pool_idstringId of the IPAM Pool.
ipam_pool_allocation_idstringId of the allocation.
cidrundefined
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -ipam_pool_id, -ipam_pool_allocation_id, -cidr -FROM awscc.ec2.ipam_allocations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the ipam_allocations resource, the following permissions are required: - -### Create -```json -ec2:AllocateIpamPoolCidr, -ec2:GetIpamPoolAllocations -``` - -### List -```json -ec2:GetIpamPoolAllocations -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/ipam_pool/index.md b/docs/awscc-docs/providers/awscc/ec2/ipam_pool/index.md deleted file mode 100644 index faed634869..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/ipam_pool/index.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -title: ipam_pool -hide_title: false -hide_table_of_contents: false -keywords: - - ipam_pool - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual ipam_pool resource - -## Overview - - - - - -
Nameipam_pool
TypeResource
Descriptionipam_pool
Idawscc.ec2.ipam_pool
- -## Fields - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
ipam_pool_idstringId of the IPAM Pool.
address_familystringThe address family of the address space in this pool. Either IPv4 or IPv6.
allocation_min_netmask_lengthintegerThe minimum allowed netmask length for allocations made from this pool.
allocation_default_netmask_lengthintegerThe default netmask length for allocations made from this pool. This value is used when the netmask length of an allocation isn't specified.
allocation_max_netmask_lengthintegerThe maximum allowed netmask length for allocations made from this pool.
allocation_resource_tagsarrayWhen specified, an allocation will not be allowed unless a resource has a matching set of tags.
arnstringThe Amazon Resource Name (ARN) of the IPAM Pool.
auto_importbooleanDetermines what to do if IPAM discovers resources that haven't been assigned an allocation. If set to true, an allocation will be made automatically.
aws_servicestringLimits which service in Amazon Web Services that the pool can be used in.
descriptionstring
ipam_scope_idstringThe Id of the scope this pool is a part of.
ipam_scope_arnstringThe Amazon Resource Name (ARN) of the scope this pool is a part of.
ipam_scope_typestringDetermines whether this scope contains publicly routable space or space for a private network
ipam_arnstringThe Amazon Resource Name (ARN) of the IPAM this pool is a part of.
localestringThe region of this pool. If not set, this will default to "None" which will disable non-custom allocations. If the locale has been specified for the source pool, this value must match.
pool_depthintegerThe depth of this pool in the source pool hierarchy.
provisioned_cidrsarrayA list of cidrs representing the address space available for allocation in this pool.
public_ip_sourcestringThe IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is `byoip`.
publicly_advertisablebooleanDetermines whether or not address space from this pool is publicly advertised. Must be set if and only if the pool is IPv6.
source_ipam_pool_idstringThe Id of this pool's source. If set, all space provisioned in this pool must be free space provisioned in the parent pool.
source_resourceobject
statestringThe state of this pool. This can be one of the following values: "create-in-progress", "create-complete", "modify-in-progress", "modify-complete", "delete-in-progress", or "delete-complete"
state_messagestringAn explanation of how the pool arrived at it current state.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -ipam_pool_id, -address_family, -allocation_min_netmask_length, -allocation_default_netmask_length, -allocation_max_netmask_length, -allocation_resource_tags, -arn, -auto_import, -aws_service, -description, -ipam_scope_id, -ipam_scope_arn, -ipam_scope_type, -ipam_arn, -locale, -pool_depth, -provisioned_cidrs, -public_ip_source, -publicly_advertisable, -source_ipam_pool_id, -source_resource, -state, -state_message, -tags -FROM awscc.ec2.ipam_pool -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the ipam_pool resource, the following permissions are required: - -### Read -```json -ec2:DescribeIpamPools, -ec2:GetIpamPoolCidrs -``` - -### Update -```json -ec2:ModifyIpamPool, -ec2:DescribeIpamPools, -ec2:GetIpamPoolCidrs, -ec2:ProvisionIpamPoolCidr, -ec2:DeprovisionIpamPoolCidr, -ec2:CreateTags, -ec2:DeleteTags -``` - -### Delete -```json -ec2:DeleteIpamPool, -ec2:DescribeIpamPools, -ec2:GetIpamPoolCidrs, -ec2:DeprovisionIpamPoolCidr, -ec2:DeleteTags -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/ipam_pool_cidr/index.md b/docs/awscc-docs/providers/awscc/ec2/ipam_pool_cidr/index.md deleted file mode 100644 index aebc0128c6..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/ipam_pool_cidr/index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: ipam_pool_cidr -hide_title: false -hide_table_of_contents: false -keywords: - - ipam_pool_cidr - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual ipam_pool_cidr resource - -## Overview - - - - - -
Nameipam_pool_cidr
TypeResource
Descriptionipam_pool_cidr
Idawscc.ec2.ipam_pool_cidr
- -## Fields - - - - - - - - - -
NameDatatypeDescription
ipam_pool_cidr_idstringId of the IPAM Pool Cidr.
ipam_pool_idstringId of the IPAM Pool.
cidrstringRepresents a single IPv4 or IPv6 CIDR
netmask_lengthintegerThe desired netmask length of the provision. If set, IPAM will choose a block of free space with this size and return the CIDR representing it.
statestringProvisioned state of the cidr.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -ipam_pool_cidr_id, -ipam_pool_id, -cidr, -netmask_length, -state -FROM awscc.ec2.ipam_pool_cidr -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the ipam_pool_cidr resource, the following permissions are required: - -### Read -```json -ec2:GetIpamPoolCidrs -``` - -### Delete -```json -ec2:DeprovisionIpamPoolCidr, -ec2:GetIpamPoolCidrs -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/ipam_pool_cidrs/index.md b/docs/awscc-docs/providers/awscc/ec2/ipam_pool_cidrs/index.md deleted file mode 100644 index ca420d7052..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/ipam_pool_cidrs/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: ipam_pool_cidrs -hide_title: false -hide_table_of_contents: false -keywords: - - ipam_pool_cidrs - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of ipam_pool_cidrs in a region - -## Overview - - - - - -
Nameipam_pool_cidrs
TypeResource
Descriptionipam_pool_cidrs
Idawscc.ec2.ipam_pool_cidrs
- -## Fields - - - - - - -
NameDatatypeDescription
ipam_pool_idstringId of the IPAM Pool.
ipam_pool_cidr_idstringId of the IPAM Pool Cidr.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -ipam_pool_id, -ipam_pool_cidr_id -FROM awscc.ec2.ipam_pool_cidrs -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the ipam_pool_cidrs resource, the following permissions are required: - -### Create -```json -ec2:ProvisionIpamPoolCidr, -ec2:GetIpamPoolCidrs -``` - -### List -```json -ec2:GetIpamPoolCidrs -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/ipam_pools/index.md b/docs/awscc-docs/providers/awscc/ec2/ipam_pools/index.md deleted file mode 100644 index 391f38aaa1..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/ipam_pools/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: ipam_pools -hide_title: false -hide_table_of_contents: false -keywords: - - ipam_pools - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of ipam_pools in a region - -## Overview - - - - - -
Nameipam_pools
TypeResource
Descriptionipam_pools
Idawscc.ec2.ipam_pools
- -## Fields - - - - - -
NameDatatypeDescription
ipam_pool_idstringId of the IPAM Pool.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -ipam_pool_id -FROM awscc.ec2.ipam_pools -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the ipam_pools resource, the following permissions are required: - -### Create -```json -ec2:CreateIpamPool, -ec2:DescribeIpamPools, -ec2:ProvisionIpamPoolCidr, -ec2:GetIpamPoolCidrs, -ec2:CreateTags -``` - -### List -```json -ec2:DescribeIpamPools -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/ipam_resource_discoveries/index.md b/docs/awscc-docs/providers/awscc/ec2/ipam_resource_discoveries/index.md deleted file mode 100644 index 0ebf839f0b..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/ipam_resource_discoveries/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: ipam_resource_discoveries -hide_title: false -hide_table_of_contents: false -keywords: - - ipam_resource_discoveries - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of ipam_resource_discoveries in a region - -## Overview - - - - - -
Nameipam_resource_discoveries
TypeResource
Descriptionipam_resource_discoveries
Idawscc.ec2.ipam_resource_discoveries
- -## Fields - - - - - -
NameDatatypeDescription
ipam_resource_discovery_idstringId of the IPAM Pool.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -ipam_resource_discovery_id -FROM awscc.ec2.ipam_resource_discoveries -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the ipam_resource_discoveries resource, the following permissions are required: - -### Create -```json -ec2:CreateIpamResourceDiscovery, -ec2:DescribeIpamResourceDiscoveries, -ec2:CreateTags -``` - -### List -```json -ec2:DescribeIpamResourceDiscoveries -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/ipam_resource_discovery/index.md b/docs/awscc-docs/providers/awscc/ec2/ipam_resource_discovery/index.md deleted file mode 100644 index 0b89039739..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/ipam_resource_discovery/index.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -title: ipam_resource_discovery -hide_title: false -hide_table_of_contents: false -keywords: - - ipam_resource_discovery - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual ipam_resource_discovery resource - -## Overview - - - - - -
Nameipam_resource_discovery
TypeResource
Descriptionipam_resource_discovery
Idawscc.ec2.ipam_resource_discovery
- -## Fields - - - - - - - - - - - - - -
NameDatatypeDescription
ipam_resource_discovery_idstringId of the IPAM Pool.
owner_idstringOwner Account ID of the Resource Discovery
operating_regionsarrayThe regions Resource Discovery is enabled for. Allows resource discoveries to be created in these regions, as well as enabling monitoring
ipam_resource_discovery_regionstringThe region the resource discovery is setup in.
descriptionstring
is_defaultbooleanDetermines whether or not address space from this pool is publicly advertised. Must be set if and only if the pool is IPv6.
ipam_resource_discovery_arnstringAmazon Resource Name (Arn) for the Resource Discovery.
statestringThe state of this Resource Discovery.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -ipam_resource_discovery_id, -owner_id, -operating_regions, -ipam_resource_discovery_region, -description, -is_default, -ipam_resource_discovery_arn, -state, -tags -FROM awscc.ec2.ipam_resource_discovery -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the ipam_resource_discovery resource, the following permissions are required: - -### Read -```json -ec2:DescribeIpamResourceDiscoveries -``` - -### Update -```json -ec2:ModifyIpamResourceDiscovery, -ec2:DescribeIpamResourceDiscoveries, -ec2:CreateTags, -ec2:DeleteTags -``` - -### Delete -```json -ec2:DeleteIpamResourceDiscovery, -ec2:DescribeIpamResourceDiscoveries, -ec2:DeleteTags -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/ipam_resource_discovery_association/index.md b/docs/awscc-docs/providers/awscc/ec2/ipam_resource_discovery_association/index.md deleted file mode 100644 index e90de7d72f..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/ipam_resource_discovery_association/index.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -title: ipam_resource_discovery_association -hide_title: false -hide_table_of_contents: false -keywords: - - ipam_resource_discovery_association - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual ipam_resource_discovery_association resource - -## Overview - - - - - -
Nameipam_resource_discovery_association
TypeResource
Descriptionipam_resource_discovery_association
Idawscc.ec2.ipam_resource_discovery_association
- -## Fields - - - - - - - - - - - - - - - -
NameDatatypeDescription
ipam_arnstringArn of the IPAM.
ipam_regionstringThe home region of the IPAM.
ipam_resource_discovery_association_idstringId of the IPAM Resource Discovery Association.
ipam_resource_discovery_idstringThe Amazon Resource Name (ARN) of the IPAM Resource Discovery Association.
ipam_idstringThe Id of the IPAM this Resource Discovery is associated to.
ipam_resource_discovery_association_arnstringThe Amazon Resource Name (ARN) of the resource discovery association is a part of.
is_defaultbooleanIf the Resource Discovery Association exists due as part of CreateIpam.
owner_idstringThe AWS Account ID for the account where the shared IPAM exists.
statestringThe operational state of the Resource Discovery Association. Related to Create/Delete activities.
resource_discovery_statusstringThe status of the resource discovery.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -ipam_arn, -ipam_region, -ipam_resource_discovery_association_id, -ipam_resource_discovery_id, -ipam_id, -ipam_resource_discovery_association_arn, -is_default, -owner_id, -state, -resource_discovery_status, -tags -FROM awscc.ec2.ipam_resource_discovery_association -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the ipam_resource_discovery_association resource, the following permissions are required: - -### Read -```json -ec2:DescribeIpamResourceDiscoveryAssociations -``` - -### Update -```json -ec2:DescribeIpamResourceDiscoveryAssociations, -ec2:CreateTags, -ec2:DeleteTags -``` - -### Delete -```json -ec2:DisassociateIpamResourceDiscovery, -ec2:DescribeIpamResourceDiscoveryAssociations, -ec2:DeleteTags -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/ipam_resource_discovery_associations/index.md b/docs/awscc-docs/providers/awscc/ec2/ipam_resource_discovery_associations/index.md deleted file mode 100644 index 70dbb30fa5..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/ipam_resource_discovery_associations/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: ipam_resource_discovery_associations -hide_title: false -hide_table_of_contents: false -keywords: - - ipam_resource_discovery_associations - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of ipam_resource_discovery_associations in a region - -## Overview - - - - - -
Nameipam_resource_discovery_associations
TypeResource
Descriptionipam_resource_discovery_associations
Idawscc.ec2.ipam_resource_discovery_associations
- -## Fields - - - - - -
NameDatatypeDescription
ipam_resource_discovery_association_idstringId of the IPAM Resource Discovery Association.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -ipam_resource_discovery_association_id -FROM awscc.ec2.ipam_resource_discovery_associations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the ipam_resource_discovery_associations resource, the following permissions are required: - -### Create -```json -ec2:AssociateIpamResourceDiscovery, -ec2:DescribeIpamResourceDiscoveryAssociations, -ec2:CreateTags -``` - -### List -```json -ec2:DescribeIpamResourceDiscoveryAssociations -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/ipam_scope/index.md b/docs/awscc-docs/providers/awscc/ec2/ipam_scope/index.md deleted file mode 100644 index 1ccb22836d..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/ipam_scope/index.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -title: ipam_scope -hide_title: false -hide_table_of_contents: false -keywords: - - ipam_scope - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual ipam_scope resource - -## Overview - - - - - -
Nameipam_scope
TypeResource
Descriptionipam_scope
Idawscc.ec2.ipam_scope
- -## Fields - - - - - - - - - - - - - -
NameDatatypeDescription
ipam_scope_idstringId of the IPAM scope.
arnstringThe Amazon Resource Name (ARN) of the IPAM scope.
ipam_idstringThe Id of the IPAM this scope is a part of.
ipam_arnstringThe Amazon Resource Name (ARN) of the IPAM this scope is a part of.
ipam_scope_typestringDetermines whether this scope contains publicly routable space or space for a private network
is_defaultbooleanIs this one of the default scopes created with the IPAM.
descriptionstring
pool_countintegerThe number of pools that currently exist in this scope.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -ipam_scope_id, -arn, -ipam_id, -ipam_arn, -ipam_scope_type, -is_default, -description, -pool_count, -tags -FROM awscc.ec2.ipam_scope -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the ipam_scope resource, the following permissions are required: - -### Read -```json -ec2:DescribeIpamScopes -``` - -### Update -```json -ec2:ModifyIpamScope, -ec2:DescribeIpamScopes, -ec2:CreateTags, -ec2:DeleteTags -``` - -### Delete -```json -ec2:DeleteIpamScope, -ec2:DescribeIpamScopes, -ec2:DeleteTags -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/ipam_scopes/index.md b/docs/awscc-docs/providers/awscc/ec2/ipam_scopes/index.md deleted file mode 100644 index c8d9d0020c..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/ipam_scopes/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: ipam_scopes -hide_title: false -hide_table_of_contents: false -keywords: - - ipam_scopes - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of ipam_scopes in a region - -## Overview - - - - - -
Nameipam_scopes
TypeResource
Descriptionipam_scopes
Idawscc.ec2.ipam_scopes
- -## Fields - - - - - -
NameDatatypeDescription
ipam_scope_idstringId of the IPAM scope.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -ipam_scope_id -FROM awscc.ec2.ipam_scopes -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the ipam_scopes resource, the following permissions are required: - -### Create -```json -ec2:CreateIpamScope, -ec2:DescribeIpamScopes, -ec2:CreateTags -``` - -### List -```json -ec2:DescribeIpamScopes -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/ipams/index.md b/docs/awscc-docs/providers/awscc/ec2/ipams/index.md deleted file mode 100644 index 9d498941d5..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/ipams/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: ipams -hide_title: false -hide_table_of_contents: false -keywords: - - ipams - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of ipams in a region - -## Overview - - - - - -
Nameipams
TypeResource
Descriptionipams
Idawscc.ec2.ipams
- -## Fields - - - - - -
NameDatatypeDescription
ipam_idstringId of the IPAM.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -ipam_id -FROM awscc.ec2.ipams -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the ipams resource, the following permissions are required: - -### Create -```json -ec2:CreateIpam, -iam:CreateServiceLinkedRole, -ec2:CreateTags, -ec2:DescribeIpams -``` - -### List -```json -ec2:DescribeIpams -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/key_pair/index.md b/docs/awscc-docs/providers/awscc/ec2/key_pair/index.md deleted file mode 100644 index a9ead1295b..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/key_pair/index.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -title: key_pair -hide_title: false -hide_table_of_contents: false -keywords: - - key_pair - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual key_pair resource - -## Overview - - - - - -
Namekey_pair
TypeResource
Descriptionkey_pair
Idawscc.ec2.key_pair
- -## Fields - - - - - - - - - - - -
NameDatatypeDescription
key_namestringThe name of the SSH key pair
key_typestringThe crypto-system used to generate a key pair.
key_formatstringThe format of the private key
public_key_materialstringPlain text public key to import
key_fingerprintstringA short sequence of bytes used for public key verification
key_pair_idstringAn AWS generated ID for the key pair
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -key_name, -key_type, -key_format, -public_key_material, -key_fingerprint, -key_pair_id, -tags -FROM awscc.ec2.key_pair -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the key_pair resource, the following permissions are required: - -### Read -```json -ec2:DescribeKeyPairs -``` - -### Delete -```json -ec2:DeleteKeyPair, -ssm:DeleteParameter, -ec2:DescribeKeyPairs -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/key_pairs/index.md b/docs/awscc-docs/providers/awscc/ec2/key_pairs/index.md deleted file mode 100644 index 1d15fe14e6..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/key_pairs/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: key_pairs -hide_title: false -hide_table_of_contents: false -keywords: - - key_pairs - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of key_pairs in a region - -## Overview - - - - - -
Namekey_pairs
TypeResource
Descriptionkey_pairs
Idawscc.ec2.key_pairs
- -## Fields - - - - - -
NameDatatypeDescription
key_namestringThe name of the SSH key pair
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -key_name -FROM awscc.ec2.key_pairs -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the key_pairs resource, the following permissions are required: - -### Create -```json -ec2:CreateKeyPair, -ec2:ImportKeyPair, -ec2:CreateTags, -ssm:PutParameter -``` - -### List -```json -ec2:DescribeKeyPairs -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/launch_template/index.md b/docs/awscc-docs/providers/awscc/ec2/launch_template/index.md deleted file mode 100644 index b556b7fcfe..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/launch_template/index.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: launch_template -hide_title: false -hide_table_of_contents: false -keywords: - - launch_template - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual launch_template resource - -## Overview - - - - - -
Namelaunch_template
TypeResource
Descriptionlaunch_template
Idawscc.ec2.launch_template
- -## Fields - - - - - - - - - - - -
NameDatatypeDescription
launch_template_namestringA name for the launch template.
launch_template_dataobjectThe information for the launch template.
version_descriptionstringA description for the first version of the launch template.
tag_specificationsarrayThe tags to apply to the launch template on creation. To tag the launch template, the resource type must be ``launch-template``.<br/> To specify the tags for the resources that are created when an instance is launched, you must use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-tagspecifications).
latest_version_numberstring
launch_template_idstring
default_version_numberstring
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -launch_template_name, -launch_template_data, -version_description, -tag_specifications, -latest_version_number, -launch_template_id, -default_version_number -FROM awscc.ec2.launch_template -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the launch_template resource, the following permissions are required: - -### Read -```json -ec2:DescribeLaunchTemplates -``` - -### Update -```json -ec2:CreateLaunchTemplateVersion -``` - -### Delete -```json -ec2:DeleteLaunchTemplate, -ec2:DeleteTags, -ec2:DescribeLaunchTemplates -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/launch_templates/index.md b/docs/awscc-docs/providers/awscc/ec2/launch_templates/index.md deleted file mode 100644 index 83cb1f7605..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/launch_templates/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: launch_templates -hide_title: false -hide_table_of_contents: false -keywords: - - launch_templates - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of launch_templates in a region - -## Overview - - - - - -
Namelaunch_templates
TypeResource
Descriptionlaunch_templates
Idawscc.ec2.launch_templates
- -## Fields - - - - - -
NameDatatypeDescription
launch_template_idstring
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -launch_template_id -FROM awscc.ec2.launch_templates -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the launch_templates resource, the following permissions are required: - -### Create -```json -ec2:CreateLaunchTemplate, -ec2:CreateTags -``` - -### List -```json -ec2:DescribeLaunchTemplates -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/local_gateway_route/index.md b/docs/awscc-docs/providers/awscc/ec2/local_gateway_route/index.md deleted file mode 100644 index 9a23385b91..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/local_gateway_route/index.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -title: local_gateway_route -hide_title: false -hide_table_of_contents: false -keywords: - - local_gateway_route - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual local_gateway_route resource - -## Overview - - - - - -
Namelocal_gateway_route
TypeResource
Descriptionlocal_gateway_route
Idawscc.ec2.local_gateway_route
- -## Fields - - - - - - - - - - -
NameDatatypeDescription
destination_cidr_blockstringThe CIDR block used for destination matches.
local_gateway_route_table_idstringThe ID of the local gateway route table.
local_gateway_virtual_interface_group_idstringThe ID of the virtual interface group.
network_interface_idstringThe ID of the network interface.
statestringThe state of the route.
typestringThe route type.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -destination_cidr_block, -local_gateway_route_table_id, -local_gateway_virtual_interface_group_id, -network_interface_id, -state, -type -FROM awscc.ec2.local_gateway_route -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the local_gateway_route resource, the following permissions are required: - -### Read -```json -ec2:SearchLocalGatewayRoutes -``` - -### Delete -```json -ec2:DeleteLocalGatewayRoute, -ec2:SearchLocalGatewayRoutes -``` - -### Update -```json -ec2:ModifyLocalGatewayRoute, -ec2:SearchLocalGatewayRoutes -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/local_gateway_route_table/index.md b/docs/awscc-docs/providers/awscc/ec2/local_gateway_route_table/index.md deleted file mode 100644 index a943ab2103..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/local_gateway_route_table/index.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -title: local_gateway_route_table -hide_title: false -hide_table_of_contents: false -keywords: - - local_gateway_route_table - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual local_gateway_route_table resource - -## Overview - - - - - -
Namelocal_gateway_route_table
TypeResource
Descriptionlocal_gateway_route_table
Idawscc.ec2.local_gateway_route_table
- -## Fields - - - - - - - - - - - - -
NameDatatypeDescription
local_gateway_route_table_idstringThe ID of the local gateway route table.
local_gateway_route_table_arnstringThe ARN of the local gateway route table.
local_gateway_idstringThe ID of the local gateway.
outpost_arnstringThe ARN of the outpost.
owner_idstringThe owner of the local gateway route table.
statestringThe state of the local gateway route table.
modestringThe mode of the local gateway route table.
tagsarrayThe tags for the local gateway route table.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -local_gateway_route_table_id, -local_gateway_route_table_arn, -local_gateway_id, -outpost_arn, -owner_id, -state, -mode, -tags -FROM awscc.ec2.local_gateway_route_table -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the local_gateway_route_table resource, the following permissions are required: - -### Read -```json -ec2:DescribeLocalGatewayRouteTables -``` - -### Update -```json -ec2:DescribeLocalGatewayRouteTables, -ec2:CreateTags, -ec2:DeleteTags -``` - -### Delete -```json -ec2:DeleteLocalGatewayRouteTable, -ec2:DescribeLocalGatewayRouteTables, -ec2:DeleteTags -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/local_gateway_route_table_virtual_interface_group_association/index.md b/docs/awscc-docs/providers/awscc/ec2/local_gateway_route_table_virtual_interface_group_association/index.md deleted file mode 100644 index 69818610fa..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/local_gateway_route_table_virtual_interface_group_association/index.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -title: local_gateway_route_table_virtual_interface_group_association -hide_title: false -hide_table_of_contents: false -keywords: - - local_gateway_route_table_virtual_interface_group_association - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual local_gateway_route_table_virtual_interface_group_association resource - -## Overview - - - - - -
Namelocal_gateway_route_table_virtual_interface_group_association
TypeResource
Descriptionlocal_gateway_route_table_virtual_interface_group_association
Idawscc.ec2.local_gateway_route_table_virtual_interface_group_association
- -## Fields - - - - - - - - - - - - -
NameDatatypeDescription
local_gateway_route_table_virtual_interface_group_association_idstringThe ID of the local gateway route table virtual interface group association.
local_gateway_idstringThe ID of the local gateway.
local_gateway_route_table_idstringThe ID of the local gateway route table.
local_gateway_route_table_arnstringThe ARN of the local gateway route table.
local_gateway_virtual_interface_group_idstringThe ID of the local gateway route table virtual interface group.
owner_idstringThe owner of the local gateway route table virtual interface group association.
statestringThe state of the local gateway route table virtual interface group association.
tagsarrayThe tags for the local gateway route table virtual interface group association.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -local_gateway_route_table_virtual_interface_group_association_id, -local_gateway_id, -local_gateway_route_table_id, -local_gateway_route_table_arn, -local_gateway_virtual_interface_group_id, -owner_id, -state, -tags -FROM awscc.ec2.local_gateway_route_table_virtual_interface_group_association -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the local_gateway_route_table_virtual_interface_group_association resource, the following permissions are required: - -### Read -```json -ec2:DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations -``` - -### Update -```json -ec2:DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations, -ec2:CreateTags, -ec2:DeleteTags -``` - -### Delete -```json -ec2:DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation, -ec2:DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations, -ec2:DeleteTags -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/local_gateway_route_table_virtual_interface_group_associations/index.md b/docs/awscc-docs/providers/awscc/ec2/local_gateway_route_table_virtual_interface_group_associations/index.md deleted file mode 100644 index 5e78d5b472..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/local_gateway_route_table_virtual_interface_group_associations/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: local_gateway_route_table_virtual_interface_group_associations -hide_title: false -hide_table_of_contents: false -keywords: - - local_gateway_route_table_virtual_interface_group_associations - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of local_gateway_route_table_virtual_interface_group_associations in a region - -## Overview - - - - - -
Namelocal_gateway_route_table_virtual_interface_group_associations
TypeResource
Descriptionlocal_gateway_route_table_virtual_interface_group_associations
Idawscc.ec2.local_gateway_route_table_virtual_interface_group_associations
- -## Fields - - - - - -
NameDatatypeDescription
local_gateway_route_table_virtual_interface_group_association_idstringThe ID of the local gateway route table virtual interface group association.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -local_gateway_route_table_virtual_interface_group_association_id -FROM awscc.ec2.local_gateway_route_table_virtual_interface_group_associations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the local_gateway_route_table_virtual_interface_group_associations resource, the following permissions are required: - -### Create -```json -ec2:CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation, -ec2:DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations, -ec2:CreateTags -``` - -### List -```json -ec2:DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/local_gateway_route_tables/index.md b/docs/awscc-docs/providers/awscc/ec2/local_gateway_route_tables/index.md deleted file mode 100644 index 5e434331fe..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/local_gateway_route_tables/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: local_gateway_route_tables -hide_title: false -hide_table_of_contents: false -keywords: - - local_gateway_route_tables - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of local_gateway_route_tables in a region - -## Overview - - - - - -
Namelocal_gateway_route_tables
TypeResource
Descriptionlocal_gateway_route_tables
Idawscc.ec2.local_gateway_route_tables
- -## Fields - - - - - -
NameDatatypeDescription
local_gateway_route_table_idstringThe ID of the local gateway route table.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -local_gateway_route_table_id -FROM awscc.ec2.local_gateway_route_tables -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the local_gateway_route_tables resource, the following permissions are required: - -### Create -```json -ec2:CreateLocalGatewayRouteTable, -ec2:DescribeLocalGatewayRouteTables, -ec2:CreateTags -``` - -### List -```json -ec2:DescribeLocalGatewayRouteTables -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/local_gateway_route_tablevpc_association/index.md b/docs/awscc-docs/providers/awscc/ec2/local_gateway_route_tablevpc_association/index.md deleted file mode 100644 index 547932396b..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/local_gateway_route_tablevpc_association/index.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: local_gateway_route_tablevpc_association -hide_title: false -hide_table_of_contents: false -keywords: - - local_gateway_route_tablevpc_association - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual local_gateway_route_tablevpc_association resource - -## Overview - - - - - -
Namelocal_gateway_route_tablevpc_association
TypeResource
Descriptionlocal_gateway_route_tablevpc_association
Idawscc.ec2.local_gateway_route_tablevpc_association
- -## Fields - - - - - - - - - - -
NameDatatypeDescription
local_gateway_idstringThe ID of the local gateway.
local_gateway_route_table_idstringThe ID of the local gateway route table.
local_gateway_route_table_vpc_association_idstringThe ID of the association.
statestringThe state of the association.
vpc_idstringThe ID of the VPC.
tagsarrayThe tags for the association.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -local_gateway_id, -local_gateway_route_table_id, -local_gateway_route_table_vpc_association_id, -state, -vpc_id, -tags -FROM awscc.ec2.local_gateway_route_tablevpc_association -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the local_gateway_route_tablevpc_association resource, the following permissions are required: - -### Read -```json -ec2:DescribeLocalGatewayRouteTableVpcAssociations -``` - -### Update -```json -ec2:DescribeLocalGatewayRouteTableVpcAssociations, -ec2:CreateTags, -ec2:DeleteTags -``` - -### Delete -```json -ec2:DeleteLocalGatewayRouteTableVpcAssociation, -ec2:DescribeLocalGatewayRouteTableVpcAssociations, -ec2:DeleteTags -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/local_gateway_route_tablevpc_associations/index.md b/docs/awscc-docs/providers/awscc/ec2/local_gateway_route_tablevpc_associations/index.md deleted file mode 100644 index f046343bfb..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/local_gateway_route_tablevpc_associations/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: local_gateway_route_tablevpc_associations -hide_title: false -hide_table_of_contents: false -keywords: - - local_gateway_route_tablevpc_associations - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of local_gateway_route_tablevpc_associations in a region - -## Overview - - - - - -
Namelocal_gateway_route_tablevpc_associations
TypeResource
Descriptionlocal_gateway_route_tablevpc_associations
Idawscc.ec2.local_gateway_route_tablevpc_associations
- -## Fields - - - - - -
NameDatatypeDescription
local_gateway_route_table_vpc_association_idstringThe ID of the association.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -local_gateway_route_table_vpc_association_id -FROM awscc.ec2.local_gateway_route_tablevpc_associations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the local_gateway_route_tablevpc_associations resource, the following permissions are required: - -### Create -```json -ec2:CreateLocalGatewayRouteTableVpcAssociation, -ec2:DescribeLocalGatewayRouteTableVpcAssociations, -ec2:CreateTags -``` - -### List -```json -ec2:DescribeLocalGatewayRouteTableVpcAssociations -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/local_gateway_routes/index.md b/docs/awscc-docs/providers/awscc/ec2/local_gateway_routes/index.md deleted file mode 100644 index 7aaf71c85f..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/local_gateway_routes/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: local_gateway_routes -hide_title: false -hide_table_of_contents: false -keywords: - - local_gateway_routes - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of local_gateway_routes in a region - -## Overview - - - - - -
Namelocal_gateway_routes
TypeResource
Descriptionlocal_gateway_routes
Idawscc.ec2.local_gateway_routes
- -## Fields - - - - - - -
NameDatatypeDescription
destination_cidr_blockstringThe CIDR block used for destination matches.
local_gateway_route_table_idstringThe ID of the local gateway route table.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -destination_cidr_block, -local_gateway_route_table_id -FROM awscc.ec2.local_gateway_routes -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the local_gateway_routes resource, the following permissions are required: - -### Create -```json -ec2:CreateLocalGatewayRoute, -ec2:SearchLocalGatewayRoutes -``` - -### List -```json -ec2:DescribeLocalGatewayRouteTables, -ec2:SearchLocalGatewayRoutes -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/nat_gateway/index.md b/docs/awscc-docs/providers/awscc/ec2/nat_gateway/index.md deleted file mode 100644 index 9a4ed24111..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/nat_gateway/index.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -title: nat_gateway -hide_title: false -hide_table_of_contents: false -keywords: - - nat_gateway - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual nat_gateway resource - -## Overview - - - - - -
Namenat_gateway
TypeResource
Descriptionnat_gateway
Idawscc.ec2.nat_gateway
- -## Fields - - - - - - - - - - - - - - -
NameDatatypeDescription
subnet_idstringThe ID of the subnet in which the NAT gateway is located.
nat_gateway_idstring
connectivity_typestringIndicates whether the NAT gateway supports public or private connectivity. The default is public connectivity.
private_ip_addressstringThe private IPv4 address to assign to the NAT gateway. If you don't provide an address, a private IPv4 address will be automatically assigned.
tagsarrayThe tags for the NAT gateway.
allocation_idstring[Public NAT gateway only] The allocation ID of the Elastic IP address that's associated with the NAT gateway. This property is required for a public NAT gateway and cannot be specified with a private NAT gateway.
secondary_allocation_idsarraySecondary EIP allocation IDs. For more information, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon VPC User Guide*.
secondary_private_ip_addressesarraySecondary private IPv4 addresses. For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon Virtual Private Cloud User Guide*.<br/> ``SecondaryPrivateIpAddressCount`` and ``SecondaryPrivateIpAddresses`` cannot be set at the same time.
secondary_private_ip_address_countinteger[Private NAT gateway only] The number of secondary private IPv4 addresses you want to assign to the NAT gateway. For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon Virtual Private Cloud User Guide*.<br/> ``SecondaryPrivateIpAddressCount`` and ``SecondaryPrivateIpAddresses`` cannot be set at the same time.
max_drain_duration_secondsintegerThe maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress. Default value is 350 seconds.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -subnet_id, -nat_gateway_id, -connectivity_type, -private_ip_address, -tags, -allocation_id, -secondary_allocation_ids, -secondary_private_ip_addresses, -secondary_private_ip_address_count, -max_drain_duration_seconds -FROM awscc.ec2.nat_gateway -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the nat_gateway resource, the following permissions are required: - -### Delete -```json -ec2:DeleteNatGateway, -ec2:DescribeNatGateways -``` - -### Read -```json -ec2:DescribeNatGateways -``` - -### Update -```json -ec2:DescribeNatGateways, -ec2:CreateTags, -ec2:DeleteTags, -ec2:AssociateNatGatewayAddress, -ec2:DisassociateNatGatewayAddress, -ec2:AssignPrivateNatGatewayAddress, -ec2:UnassignPrivateNatGatewayAddress -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/nat_gateways/index.md b/docs/awscc-docs/providers/awscc/ec2/nat_gateways/index.md deleted file mode 100644 index a3b7a69bcb..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/nat_gateways/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: nat_gateways -hide_title: false -hide_table_of_contents: false -keywords: - - nat_gateways - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of nat_gateways in a region - -## Overview - - - - - -
Namenat_gateways
TypeResource
Descriptionnat_gateways
Idawscc.ec2.nat_gateways
- -## Fields - - - - - -
NameDatatypeDescription
nat_gateway_idstring
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -nat_gateway_id -FROM awscc.ec2.nat_gateways -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the nat_gateways resource, the following permissions are required: - -### Create -```json -ec2:CreateNatGateway, -ec2:DescribeNatGateways, -ec2:CreateTags -``` - -### List -```json -ec2:DescribeNatGateways -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/network_acl/index.md b/docs/awscc-docs/providers/awscc/ec2/network_acl/index.md deleted file mode 100644 index d6ef07bf00..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/network_acl/index.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -title: network_acl -hide_title: false -hide_table_of_contents: false -keywords: - - network_acl - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual network_acl resource - -## Overview - - - - - -
Namenetwork_acl
TypeResource
Descriptionnetwork_acl
Idawscc.ec2.network_acl
- -## Fields - - - - - - - -
NameDatatypeDescription
idstring
tagsarrayThe tags to assign to the network ACL.
vpc_idstringThe ID of the VPC.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -id, -tags, -vpc_id -FROM awscc.ec2.network_acl -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the network_acl resource, the following permissions are required: - -### Read -```json -ec2:DescribeNetworkAcls, -ec2:DescribeTags -``` - -### Update -```json -ec2:DescribeNetworkAcls, -ec2:DeleteTags, -ec2:CreateTags -``` - -### Delete -```json -ec2:DeleteTags, -ec2:DeleteNetworkAcl, -ec2:DescribeNetworkAcls -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/network_acls/index.md b/docs/awscc-docs/providers/awscc/ec2/network_acls/index.md deleted file mode 100644 index 8667043aae..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/network_acls/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: network_acls -hide_title: false -hide_table_of_contents: false -keywords: - - network_acls - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of network_acls in a region - -## Overview - - - - - -
Namenetwork_acls
TypeResource
Descriptionnetwork_acls
Idawscc.ec2.network_acls
- -## Fields - - - - - -
NameDatatypeDescription
idstring
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -id -FROM awscc.ec2.network_acls -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the network_acls resource, the following permissions are required: - -### Create -```json -ec2:CreateNetworkAcl, -ec2:DescribeNetworkAcls, -ec2:CreateTags -``` - -### List -```json -ec2:DescribeNetworkAcls -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/network_insights_access_scope/index.md b/docs/awscc-docs/providers/awscc/ec2/network_insights_access_scope/index.md deleted file mode 100644 index f63aeb5641..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/network_insights_access_scope/index.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -title: network_insights_access_scope -hide_title: false -hide_table_of_contents: false -keywords: - - network_insights_access_scope - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual network_insights_access_scope resource - -## Overview - - - - - -
Namenetwork_insights_access_scope
TypeResource
Descriptionnetwork_insights_access_scope
Idawscc.ec2.network_insights_access_scope
- -## Fields - - - - - - - - - - - -
NameDatatypeDescription
network_insights_access_scope_idstring
network_insights_access_scope_arnstring
created_datestring
updated_datestring
tagsarray
match_pathsarray
exclude_pathsarray
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -network_insights_access_scope_id, -network_insights_access_scope_arn, -created_date, -updated_date, -tags, -match_paths, -exclude_paths -FROM awscc.ec2.network_insights_access_scope -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the network_insights_access_scope resource, the following permissions are required: - -### Read -```json -ec2:DescribeNetworkInsightsAccessScopes, -ec2:GetNetworkInsightsAccessScopeContent -``` - -### Update -```json -ec2:DescribeNetworkInsightsAccessScopes, -ec2:GetNetworkInsightsAccessScopeContent, -ec2:CreateTags, -ec2:DeleteTags -``` - -### Delete -```json -ec2:DeleteNetworkInsightsAccessScope, -ec2:DeleteTags -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/network_insights_access_scope_analyses/index.md b/docs/awscc-docs/providers/awscc/ec2/network_insights_access_scope_analyses/index.md deleted file mode 100644 index 8a0a95e9bb..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/network_insights_access_scope_analyses/index.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: network_insights_access_scope_analyses -hide_title: false -hide_table_of_contents: false -keywords: - - network_insights_access_scope_analyses - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of network_insights_access_scope_analyses in a region - -## Overview - - - - - -
Namenetwork_insights_access_scope_analyses
TypeResource
Descriptionnetwork_insights_access_scope_analyses
Idawscc.ec2.network_insights_access_scope_analyses
- -## Fields - - - - - -
NameDatatypeDescription
network_insights_access_scope_analysis_idstring
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -network_insights_access_scope_analysis_id -FROM awscc.ec2.network_insights_access_scope_analyses -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the network_insights_access_scope_analyses resource, the following permissions are required: - -### Create -```json -ec2:CreateTags, -ec2:StartNetworkInsightsAccessScopeAnalysis, -ec2:GetTransitGatewayRouteTablePropagations, -ec2:Describe*, -elasticloadbalancing:Describe*, -directconnect:Describe*, -tiros:CreateQuery, -tiros:GetQueryAnswer, -tiros:GetQueryExplanation -``` - -### List -```json -ec2:DescribeNetworkInsightsAccessScopeAnalyses -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/network_insights_access_scope_analysis/index.md b/docs/awscc-docs/providers/awscc/ec2/network_insights_access_scope_analysis/index.md deleted file mode 100644 index db092aaebb..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/network_insights_access_scope_analysis/index.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -title: network_insights_access_scope_analysis -hide_title: false -hide_table_of_contents: false -keywords: - - network_insights_access_scope_analysis - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual network_insights_access_scope_analysis resource - -## Overview - - - - - -
Namenetwork_insights_access_scope_analysis
TypeResource
Descriptionnetwork_insights_access_scope_analysis
Idawscc.ec2.network_insights_access_scope_analysis
- -## Fields - - - - - - - - - - - - - - -
NameDatatypeDescription
network_insights_access_scope_analysis_idstring
network_insights_access_scope_analysis_arnstring
network_insights_access_scope_idstring
statusstring
status_messagestring
start_datestring
end_datestring
findings_foundstring
analyzed_eni_countinteger
tagsarray
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -network_insights_access_scope_analysis_id, -network_insights_access_scope_analysis_arn, -network_insights_access_scope_id, -status, -status_message, -start_date, -end_date, -findings_found, -analyzed_eni_count, -tags -FROM awscc.ec2.network_insights_access_scope_analysis -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the network_insights_access_scope_analysis resource, the following permissions are required: - -### Read -```json -ec2:DescribeNetworkInsightsAccessScopeAnalyses -``` - -### Update -```json -ec2:DescribeNetworkInsightsAccessScopeAnalyses, -ec2:CreateTags, -ec2:DeleteTags -``` - -### Delete -```json -ec2:DeleteNetworkInsightsAccessScopeAnalysis, -ec2:DeleteTags -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/network_insights_access_scopes/index.md b/docs/awscc-docs/providers/awscc/ec2/network_insights_access_scopes/index.md deleted file mode 100644 index 800fae5ad9..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/network_insights_access_scopes/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: network_insights_access_scopes -hide_title: false -hide_table_of_contents: false -keywords: - - network_insights_access_scopes - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of network_insights_access_scopes in a region - -## Overview - - - - - -
Namenetwork_insights_access_scopes
TypeResource
Descriptionnetwork_insights_access_scopes
Idawscc.ec2.network_insights_access_scopes
- -## Fields - - - - - -
NameDatatypeDescription
network_insights_access_scope_idstring
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -network_insights_access_scope_id -FROM awscc.ec2.network_insights_access_scopes -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the network_insights_access_scopes resource, the following permissions are required: - -### Create -```json -ec2:CreateNetworkInsightsAccessScope, -ec2:CreateTags, -tiros:CreateQuery -``` - -### List -```json -ec2:DescribeNetworkInsightsAccessScopes -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/network_insights_analyses/index.md b/docs/awscc-docs/providers/awscc/ec2/network_insights_analyses/index.md deleted file mode 100644 index 486cccf11d..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/network_insights_analyses/index.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: network_insights_analyses -hide_title: false -hide_table_of_contents: false -keywords: - - network_insights_analyses - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of network_insights_analyses in a region - -## Overview - - - - - -
Namenetwork_insights_analyses
TypeResource
Descriptionnetwork_insights_analyses
Idawscc.ec2.network_insights_analyses
- -## Fields - - - - - -
NameDatatypeDescription
network_insights_analysis_idstring
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -network_insights_analysis_id -FROM awscc.ec2.network_insights_analyses -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the network_insights_analyses resource, the following permissions are required: - -### Create -```json -ec2:CreateTags, -ec2:StartNetworkInsightsAnalysis, -ec2:GetTransitGatewayRouteTablePropagations, -ec2:SearchTransitGatewayRoutes, -ec2:Describe*, -ec2:GetManagedPrefixListEntries, -elasticloadbalancing:Describe*, -directconnect:Describe*, -tiros:CreateQuery, -tiros:GetQueryAnswer, -tiros:GetQueryExplanation -``` - -### List -```json -ec2:Describe* -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/network_insights_analysis/index.md b/docs/awscc-docs/providers/awscc/ec2/network_insights_analysis/index.md deleted file mode 100644 index 4338a468b5..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/network_insights_analysis/index.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -title: network_insights_analysis -hide_title: false -hide_table_of_contents: false -keywords: - - network_insights_analysis - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual network_insights_analysis resource - -## Overview - - - - - -
Namenetwork_insights_analysis
TypeResource
Descriptionnetwork_insights_analysis
Idawscc.ec2.network_insights_analysis
- -## Fields - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
statusstring
return_path_componentsarray
network_insights_analysis_idstring
network_insights_path_idstring
network_path_foundboolean
suggested_accountsarray
filter_in_arnsarray
network_insights_analysis_arnstring
status_messagestring
start_datestring
alternate_path_hintsarray
explanationsarray
forward_path_componentsarray
additional_accountsarray
tagsarray
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -status, -return_path_components, -network_insights_analysis_id, -network_insights_path_id, -network_path_found, -suggested_accounts, -filter_in_arns, -network_insights_analysis_arn, -status_message, -start_date, -alternate_path_hints, -explanations, -forward_path_components, -additional_accounts, -tags -FROM awscc.ec2.network_insights_analysis -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the network_insights_analysis resource, the following permissions are required: - -### Read -```json -ec2:Describe* -``` - -### Update -```json -ec2:CreateTags, -ec2:Describe*, -ec2:DeleteTags -``` - -### Delete -```json -ec2:DeleteNetworkInsightsAnalysis, -ec2:DeleteTags -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/network_insights_path/index.md b/docs/awscc-docs/providers/awscc/ec2/network_insights_path/index.md deleted file mode 100644 index 731c15355b..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/network_insights_path/index.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -title: network_insights_path -hide_title: false -hide_table_of_contents: false -keywords: - - network_insights_path - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual network_insights_path resource - -## Overview - - - - - -
Namenetwork_insights_path
TypeResource
Descriptionnetwork_insights_path
Idawscc.ec2.network_insights_path
- -## Fields - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
network_insights_path_idstring
network_insights_path_arnstring
created_datestring
source_ipstring
filter_at_sourceobject
filter_at_destinationobject
destination_ipstring
sourcestring
destinationstring
source_arnstring
destination_arnstring
protocolstring
destination_portinteger
tagsarray
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -network_insights_path_id, -network_insights_path_arn, -created_date, -source_ip, -filter_at_source, -filter_at_destination, -destination_ip, -source, -destination, -source_arn, -destination_arn, -protocol, -destination_port, -tags -FROM awscc.ec2.network_insights_path -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the network_insights_path resource, the following permissions are required: - -### Delete -```json -ec2:DeleteNetworkInsightsPath, -ec2:DeleteTags -``` - -### Read -```json -ec2:DescribeNetworkInsightsPaths -``` - -### Update -```json -ec2:DescribeNetworkInsightsPaths, -ec2:CreateTags, -ec2:DeleteTags -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/network_insights_paths/index.md b/docs/awscc-docs/providers/awscc/ec2/network_insights_paths/index.md deleted file mode 100644 index dc63e3bacb..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/network_insights_paths/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: network_insights_paths -hide_title: false -hide_table_of_contents: false -keywords: - - network_insights_paths - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of network_insights_paths in a region - -## Overview - - - - - -
Namenetwork_insights_paths
TypeResource
Descriptionnetwork_insights_paths
Idawscc.ec2.network_insights_paths
- -## Fields - - - - - -
NameDatatypeDescription
network_insights_path_idstring
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -network_insights_path_id -FROM awscc.ec2.network_insights_paths -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the network_insights_paths resource, the following permissions are required: - -### Create -```json -ec2:CreateNetworkInsightsPath, -ec2:CreateTags -``` - -### List -```json -ec2:DescribeNetworkInsightsPaths -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/network_interface/index.md b/docs/awscc-docs/providers/awscc/ec2/network_interface/index.md deleted file mode 100644 index fcc1ed3941..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/network_interface/index.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -title: network_interface -hide_title: false -hide_table_of_contents: false -keywords: - - network_interface - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual network_interface resource - -## Overview - - - - - -
Namenetwork_interface
TypeResource
Descriptionnetwork_interface
Idawscc.ec2.network_interface
- -## Fields - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
descriptionstringA description for the network interface.
private_ip_addressstringAssigns a single private IP address to the network interface, which is used as the primary private IP address. If you want to specify multiple private IP address, use the PrivateIpAddresses property.
private_ip_addressesarrayAssigns a list of private IP addresses to the network interface. You can specify a primary private IP address by setting the value of the Primary property to true in the PrivateIpAddressSpecification property. If you want EC2 to automatically assign private IP addresses, use the SecondaryPrivateIpAddressCount property and do not specify this property.
secondary_private_ip_address_countintegerThe number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses
primary_private_ip_addressstringReturns the primary private IP address of the network interface.
ipv4_prefixesarrayAssigns a list of IPv4 prefixes to the network interface. If you want EC2 to automatically assign IPv4 prefixes, use the Ipv4PrefixCount property and do not specify this property. Presently, only /28 prefixes are supported. You can't specify IPv4 prefixes if you've specified one of the following: a count of IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.
ipv4_prefix_countintegerThe number of IPv4 prefixes to assign to a network interface. When you specify a number of IPv4 prefixes, Amazon EC2 selects these prefixes from your existing subnet CIDR reservations, if available, or from free spaces in the subnet. By default, these will be /28 prefixes. You can't specify a count of IPv4 prefixes if you've specified one of the following: specific IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.
group_setarrayA list of security group IDs associated with this network interface.
ipv6_addressesarrayOne or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet to associate with the network interface. If you're specifying a number of IPv6 addresses, use the Ipv6AddressCount property and don't specify this property.
ipv6_prefixesarrayAssigns a list of IPv6 prefixes to the network interface. If you want EC2 to automatically assign IPv6 prefixes, use the Ipv6PrefixCount property and do not specify this property. Presently, only /80 prefixes are supported. You can't specify IPv6 prefixes if you've specified one of the following: a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.
ipv6_prefix_countintegerThe number of IPv6 prefixes to assign to a network interface. When you specify a number of IPv6 prefixes, Amazon EC2 selects these prefixes from your existing subnet CIDR reservations, if available, or from free spaces in the subnet. By default, these will be /80 prefixes. You can't specify a count of IPv6 prefixes if you've specified one of the following: specific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.
subnet_idstringThe ID of the subnet to associate with the network interface.
source_dest_checkbooleanIndicates whether traffic to or from the instance is validated.
interface_typestringIndicates the type of network interface.
secondary_private_ip_addressesarrayReturns the secondary private IP addresses of the network interface.
ipv6_address_countintegerThe number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. To specify specific IPv6 addresses, use the Ipv6Addresses property and don't specify this property.
enable_primary_ipv6booleanIf you have instances or ENIs that rely on the IPv6 address not changing, to avoid disrupting traffic to instances or ENIs, you can enable a primary IPv6 address. Enable this option to automatically assign an IPv6 associated with the ENI attached to your instance to be the primary IPv6 address. When you enable an IPv6 address to be a primary IPv6, you cannot disable it. Traffic will be routed to the primary IPv6 address until the instance is terminated or the ENI is detached. If you have multiple IPv6 addresses associated with an ENI and you enable a primary IPv6 address, the first IPv6 address associated with the ENI becomes the primary IPv6 address.
primary_ipv6_addressstringThe primary IPv6 address
connection_tracking_specificationobject
idstringNetwork interface id.
tagsarrayAn arbitrary set of tags (key-value pairs) for this network interface.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -description, -private_ip_address, -private_ip_addresses, -secondary_private_ip_address_count, -primary_private_ip_address, -ipv4_prefixes, -ipv4_prefix_count, -group_set, -ipv6_addresses, -ipv6_prefixes, -ipv6_prefix_count, -subnet_id, -source_dest_check, -interface_type, -secondary_private_ip_addresses, -ipv6_address_count, -enable_primary_ipv6, -primary_ipv6_address, -connection_tracking_specification, -id, -tags -FROM awscc.ec2.network_interface -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the network_interface resource, the following permissions are required: - -### Delete -```json -ec2:DescribeNetworkInterfaces, -ec2:DeleteNetworkInterface -``` - -### Read -```json -ec2:DescribeNetworkInterfaces -``` - -### Update -```json -ec2:DescribeNetworkInterfaces, -ec2:ModifyNetworkInterfaceAttribute, -ec2:UnassignIpv6Addresses, -ec2:AssignIpv6Addresses, -ec2:DeleteTags, -ec2:CreateTags, -ec2:UnassignPrivateIpAddresses, -ec2:AssignPrivateIpAddresses -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/network_interface_attachment/index.md b/docs/awscc-docs/providers/awscc/ec2/network_interface_attachment/index.md deleted file mode 100644 index 5f63be3868..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/network_interface_attachment/index.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: network_interface_attachment -hide_title: false -hide_table_of_contents: false -keywords: - - network_interface_attachment - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual network_interface_attachment resource - -## Overview - - - - - -
Namenetwork_interface_attachment
TypeResource
Descriptionnetwork_interface_attachment
Idawscc.ec2.network_interface_attachment
- -## Fields - - - - - - - - - - -
NameDatatypeDescription
attachment_idstringThe ID of the network interface attachment.
delete_on_terminationbooleanWhether to delete the network interface when the instance terminates. By default, this value is set to true.
device_indexstringThe network interface's position in the attachment order. For example, the first attached network interface has a DeviceIndex of 0.
instance_idstringThe ID of the instance to which you will attach the ENI.
network_interface_idstringThe ID of the ENI that you want to attach.
ena_srd_specificationobject
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -attachment_id, -delete_on_termination, -device_index, -instance_id, -network_interface_id, -ena_srd_specification -FROM awscc.ec2.network_interface_attachment -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the network_interface_attachment resource, the following permissions are required: - -### Read -```json -ec2:DescribeNetworkInterfaces -``` - -### Update -```json -ec2:ModifyNetworkInterfaceAttribute, -ec2:DescribeNetworkInterfaces, -ec2:AttachNetworkInterface, -ec2:DetachNetworkInterface -``` - -### Delete -```json -ec2:DetachNetworkInterface, -ec2:DescribeNetworkInterfaces -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/network_interface_attachments/index.md b/docs/awscc-docs/providers/awscc/ec2/network_interface_attachments/index.md deleted file mode 100644 index cec682dda8..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/network_interface_attachments/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: network_interface_attachments -hide_title: false -hide_table_of_contents: false -keywords: - - network_interface_attachments - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of network_interface_attachments in a region - -## Overview - - - - - -
Namenetwork_interface_attachments
TypeResource
Descriptionnetwork_interface_attachments
Idawscc.ec2.network_interface_attachments
- -## Fields - - - - - -
NameDatatypeDescription
attachment_idstringThe ID of the network interface attachment.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -attachment_id -FROM awscc.ec2.network_interface_attachments -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the network_interface_attachments resource, the following permissions are required: - -### Create -```json -ec2:AttachNetworkInterface, -ec2:DescribeNetworkInterfaces, -ec2:ModifyNetworkInterfaceAttribute -``` - -### List -```json -ec2:DescribeNetworkInterfaces -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/network_interfaces/index.md b/docs/awscc-docs/providers/awscc/ec2/network_interfaces/index.md deleted file mode 100644 index 3a07005481..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/network_interfaces/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: network_interfaces -hide_title: false -hide_table_of_contents: false -keywords: - - network_interfaces - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of network_interfaces in a region - -## Overview - - - - - -
Namenetwork_interfaces
TypeResource
Descriptionnetwork_interfaces
Idawscc.ec2.network_interfaces
- -## Fields - - - - - -
NameDatatypeDescription
idstringNetwork interface id.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -id -FROM awscc.ec2.network_interfaces -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the network_interfaces resource, the following permissions are required: - -### Create -```json -ec2:CreateNetworkInterface, -ec2:DescribeNetworkInterfaces, -ec2:CreateTags, -ec2:ModifyNetworkInterfaceAttribute -``` - -### List -```json -ec2:DescribeNetworkInterfaces -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/network_performance_metric_subscription/index.md b/docs/awscc-docs/providers/awscc/ec2/network_performance_metric_subscription/index.md deleted file mode 100644 index 717314dcaf..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/network_performance_metric_subscription/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: network_performance_metric_subscription -hide_title: false -hide_table_of_contents: false -keywords: - - network_performance_metric_subscription - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual network_performance_metric_subscription resource - -## Overview - - - - - -
Namenetwork_performance_metric_subscription
TypeResource
Descriptionnetwork_performance_metric_subscription
Idawscc.ec2.network_performance_metric_subscription
- -## Fields - - - - - - - - -
NameDatatypeDescription
sourcestringThe starting Region or Availability Zone for metric to subscribe to.
destinationstringThe target Region or Availability Zone for the metric to subscribe to.
metricstringThe metric type to subscribe to.
statisticstringThe statistic to subscribe to.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -source, -destination, -metric, -statistic -FROM awscc.ec2.network_performance_metric_subscription -WHERE data__Identifier = '|||'; -``` - -## Permissions - -To operate on the network_performance_metric_subscription resource, the following permissions are required: - -### Read -```json -ec2:DescribeAwsNetworkPerformanceMetricSubscriptions -``` - -### Delete -```json -ec2:DescribeAwsNetworkPerformanceMetricSubscriptions, -ec2:DisableAwsNetworkPerformanceMetricSubscription -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/network_performance_metric_subscriptions/index.md b/docs/awscc-docs/providers/awscc/ec2/network_performance_metric_subscriptions/index.md deleted file mode 100644 index a4d765df8b..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/network_performance_metric_subscriptions/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: network_performance_metric_subscriptions -hide_title: false -hide_table_of_contents: false -keywords: - - network_performance_metric_subscriptions - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of network_performance_metric_subscriptions in a region - -## Overview - - - - - -
Namenetwork_performance_metric_subscriptions
TypeResource
Descriptionnetwork_performance_metric_subscriptions
Idawscc.ec2.network_performance_metric_subscriptions
- -## Fields - - - - - - - - -
NameDatatypeDescription
sourcestringThe starting Region or Availability Zone for metric to subscribe to.
destinationstringThe target Region or Availability Zone for the metric to subscribe to.
metricstringThe metric type to subscribe to.
statisticstringThe statistic to subscribe to.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -source, -destination, -metric, -statistic -FROM awscc.ec2.network_performance_metric_subscriptions -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the network_performance_metric_subscriptions resource, the following permissions are required: - -### Create -```json -ec2:DescribeAwsNetworkPerformanceMetricSubscriptions, -ec2:EnableAwsNetworkPerformanceMetricSubscription -``` - -### List -```json -ec2:DescribeAwsNetworkPerformanceMetricSubscriptions -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/placement_group/index.md b/docs/awscc-docs/providers/awscc/ec2/placement_group/index.md deleted file mode 100644 index dad4436a2b..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/placement_group/index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: placement_group -hide_title: false -hide_table_of_contents: false -keywords: - - placement_group - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual placement_group resource - -## Overview - - - - - -
Nameplacement_group
TypeResource
Descriptionplacement_group
Idawscc.ec2.placement_group
- -## Fields - - - - - - - - - -
NameDatatypeDescription
strategystringThe placement strategy.
group_namestringThe Group Name of Placement Group.
spread_levelstringThe Spread Level of Placement Group is an enum where it accepts either host or rack when strategy is spread
partition_countintegerThe number of partitions. Valid only when **Strategy** is set to `partition`
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -strategy, -group_name, -spread_level, -partition_count, -tags -FROM awscc.ec2.placement_group -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the placement_group resource, the following permissions are required: - -### Read -```json -ec2:DescribePlacementGroups -``` - -### Delete -```json -ec2:DeletePlacementGroup, -ec2:DescribePlacementGroups -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/placement_groups/index.md b/docs/awscc-docs/providers/awscc/ec2/placement_groups/index.md deleted file mode 100644 index 32d63ad3b6..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/placement_groups/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: placement_groups -hide_title: false -hide_table_of_contents: false -keywords: - - placement_groups - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of placement_groups in a region - -## Overview - - - - - -
Nameplacement_groups
TypeResource
Descriptionplacement_groups
Idawscc.ec2.placement_groups
- -## Fields - - - - - -
NameDatatypeDescription
group_namestringThe Group Name of Placement Group.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -group_name -FROM awscc.ec2.placement_groups -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the placement_groups resource, the following permissions are required: - -### Create -```json -ec2:CreatePlacementGroup, -ec2:DescribePlacementGroups, -ec2:CreateTags -``` - -### List -```json -ec2:DescribePlacementGroups -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/prefix_list/index.md b/docs/awscc-docs/providers/awscc/ec2/prefix_list/index.md deleted file mode 100644 index 02a55b1004..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/prefix_list/index.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -title: prefix_list -hide_title: false -hide_table_of_contents: false -keywords: - - prefix_list - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual prefix_list resource - -## Overview - - - - - -
Nameprefix_list
TypeResource
Descriptionprefix_list
Idawscc.ec2.prefix_list
- -## Fields - - - - - - - - - - - - - -
NameDatatypeDescription
prefix_list_namestringName of Prefix List.
prefix_list_idstringId of Prefix List.
owner_idstringOwner Id of Prefix List.
address_familystringIp Version of Prefix List.
max_entriesintegerMax Entries of Prefix List.
versionintegerVersion of Prefix List.
tagsarrayTags for Prefix List
entriesarrayEntries of Prefix List.
arnstringThe Amazon Resource Name (ARN) of the Prefix List.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -prefix_list_name, -prefix_list_id, -owner_id, -address_family, -max_entries, -version, -tags, -entries, -arn -FROM awscc.ec2.prefix_list -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the prefix_list resource, the following permissions are required: - -### Read -```json -EC2:GetManagedPrefixListEntries, -EC2:DescribeManagedPrefixLists -``` - -### Update -```json -EC2:DescribeManagedPrefixLists, -EC2:GetManagedPrefixListEntries, -EC2:ModifyManagedPrefixList, -EC2:CreateTags, -EC2:DeleteTags -``` - -### Delete -```json -EC2:DeleteManagedPrefixList, -EC2:DescribeManagedPrefixLists -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/prefix_lists/index.md b/docs/awscc-docs/providers/awscc/ec2/prefix_lists/index.md deleted file mode 100644 index b1082581a9..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/prefix_lists/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: prefix_lists -hide_title: false -hide_table_of_contents: false -keywords: - - prefix_lists - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of prefix_lists in a region - -## Overview - - - - - -
Nameprefix_lists
TypeResource
Descriptionprefix_lists
Idawscc.ec2.prefix_lists
- -## Fields - - - - - -
NameDatatypeDescription
prefix_list_idstringId of Prefix List.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -prefix_list_id -FROM awscc.ec2.prefix_lists -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the prefix_lists resource, the following permissions are required: - -### Create -```json -EC2:CreateManagedPrefixList, -EC2:DescribeManagedPrefixLists, -EC2:CreateTags -``` - -### List -```json -EC2:DescribeManagedPrefixLists, -EC2:GetManagedPrefixListEntries -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/route/index.md b/docs/awscc-docs/providers/awscc/ec2/route/index.md deleted file mode 100644 index ae6c62a650..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/route/index.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -title: route -hide_title: false -hide_table_of_contents: false -keywords: - - route - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual route resource - -## Overview - - - - - -
Nameroute
TypeResource
Descriptionroute
Idawscc.ec2.route
- -## Fields - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
carrier_gateway_idstringThe ID of the carrier gateway.
cidr_blockstringThe primary identifier of the resource generated by the service.
core_network_arnstringThe Amazon Resource Name (ARN) of the core network.
destination_cidr_blockstringThe IPv4 CIDR block used for the destination match.
destination_ipv6_cidr_blockstringThe IPv6 CIDR block used for the destination match.
destination_prefix_list_idstringThe ID of managed prefix list, it's a set of one or more CIDR blocks.
egress_only_internet_gateway_idstringThe ID of the egress-only internet gateway.
gateway_idstringThe ID of an internet gateway or virtual private gateway attached to your VPC.
instance_idstringThe ID of a NAT instance in your VPC.
local_gateway_idstringThe ID of the local gateway.
nat_gateway_idstringThe ID of a NAT gateway.
network_interface_idstringThe ID of the network interface.
route_table_idstringThe ID of the route table. The routing table must be associated with the same VPC that the virtual private gateway is attached to.
transit_gateway_idstringThe ID of a transit gateway.
vpc_endpoint_idstringThe ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.
vpc_peering_connection_idstringThe ID of a VPC peering connection.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -carrier_gateway_id, -cidr_block, -core_network_arn, -destination_cidr_block, -destination_ipv6_cidr_block, -destination_prefix_list_id, -egress_only_internet_gateway_id, -gateway_id, -instance_id, -local_gateway_id, -nat_gateway_id, -network_interface_id, -route_table_id, -transit_gateway_id, -vpc_endpoint_id, -vpc_peering_connection_id -FROM awscc.ec2.route -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the route resource, the following permissions are required: - -### Read -```json -ec2:DescribeRouteTables -``` - -### Update -```json -ec2:ReplaceRoute, -ec2:DescribeRouteTables, -ec2:DescribeNetworkInterfaces -``` - -### Delete -```json -ec2:DeleteRoute, -ec2:DescribeRouteTables -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/route_table/index.md b/docs/awscc-docs/providers/awscc/ec2/route_table/index.md deleted file mode 100644 index c85e20fafc..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/route_table/index.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -title: route_table -hide_title: false -hide_table_of_contents: false -keywords: - - route_table - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual route_table resource - -## Overview - - - - - -
Nameroute_table
TypeResource
Descriptionroute_table
Idawscc.ec2.route_table
- -## Fields - - - - - - - -
NameDatatypeDescription
route_table_idstring
tagsarrayAny tags assigned to the route table.
vpc_idstringThe ID of the VPC.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -route_table_id, -tags, -vpc_id -FROM awscc.ec2.route_table -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the route_table resource, the following permissions are required: - -### Read -```json -ec2:DescribeRouteTables -``` - -### Update -```json -ec2:CreateTags, -ec2:DeleteTags, -ec2:DescribeRouteTables -``` - -### Delete -```json -ec2:DescribeRouteTables, -ec2:DeleteRouteTable -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/route_tables/index.md b/docs/awscc-docs/providers/awscc/ec2/route_tables/index.md deleted file mode 100644 index 593073ae3e..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/route_tables/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: route_tables -hide_title: false -hide_table_of_contents: false -keywords: - - route_tables - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of route_tables in a region - -## Overview - - - - - -
Nameroute_tables
TypeResource
Descriptionroute_tables
Idawscc.ec2.route_tables
- -## Fields - - - - - -
NameDatatypeDescription
route_table_idstring
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -route_table_id -FROM awscc.ec2.route_tables -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the route_tables resource, the following permissions are required: - -### Create -```json -ec2:CreateRouteTable, -ec2:CreateTags, -ec2:DescribeRouteTables -``` - -### List -```json -ec2:DescribeRouteTables -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/routes/index.md b/docs/awscc-docs/providers/awscc/ec2/routes/index.md deleted file mode 100644 index 4047fc19d0..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/routes/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: routes -hide_title: false -hide_table_of_contents: false -keywords: - - routes - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of routes in a region - -## Overview - - - - - -
Nameroutes
TypeResource
Descriptionroutes
Idawscc.ec2.routes
- -## Fields - - - - - - -
NameDatatypeDescription
route_table_idstringThe ID of the route table. The routing table must be associated with the same VPC that the virtual private gateway is attached to.
cidr_blockstringThe primary identifier of the resource generated by the service.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -route_table_id, -cidr_block -FROM awscc.ec2.routes -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the routes resource, the following permissions are required: - -### Create -```json -ec2:CreateRoute, -ec2:DescribeRouteTables, -ec2:DescribeNetworkInterfaces -``` - -### List -```json -ec2:DescribeRouteTables -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/security_group_egress/index.md b/docs/awscc-docs/providers/awscc/ec2/security_group_egress/index.md deleted file mode 100644 index ef957e67cf..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/security_group_egress/index.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -title: security_group_egress -hide_title: false -hide_table_of_contents: false -keywords: - - security_group_egress - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual security_group_egress resource - -## Overview - - - - - -
Namesecurity_group_egress
TypeResource
Descriptionsecurity_group_egress
Idawscc.ec2.security_group_egress
- -## Fields - - - - - - - - - - - - - - -
NameDatatypeDescription
cidr_ipstringThe IPv4 address range, in CIDR format.<br/> You must specify a destination security group (``DestinationPrefixListId`` or ``DestinationSecurityGroupId``) or a CIDR range (``CidrIp`` or ``CidrIpv6``).<br/> For examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *User Guide*.
cidr_ipv6stringThe IPv6 address range, in CIDR format.<br/> You must specify a destination security group (``DestinationPrefixListId`` or ``DestinationSecurityGroupId``) or a CIDR range (``CidrIp`` or ``CidrIpv6``).<br/> For examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *User Guide*.
descriptionstringThe description of an egress (outbound) security group rule.<br/> Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
from_portintegerIf the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types).
to_portintegerIf the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes).
ip_protocolstringThe IP protocol name (``tcp``, ``udp``, ``icmp``, ``icmpv6``) or number (see [Protocol Numbers](https://docs.aws.amazon.com/http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml)).<br/> Use ``-1`` to specify all protocols. When authorizing security group rules, specifying ``-1`` or a protocol number other than ``tcp``, ``udp``, ``icmp``, or ``icmpv6`` allows traffic on all ports, regardless of any port range you specify. For ``tcp``, ``udp``, and ``icmp``, you must specify a port range. For ``icmpv6``, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
destination_security_group_idstringThe ID of the security group.<br/> You must specify a destination security group (``DestinationPrefixListId`` or ``DestinationSecurityGroupId``) or a CIDR range (``CidrIp`` or ``CidrIpv6``).
idstring
destination_prefix_list_idstringThe prefix list IDs for an AWS service. This is the AWS service that you want to access through a VPC endpoint from instances associated with the security group.<br/> You must specify a destination security group (``DestinationPrefixListId`` or ``DestinationSecurityGroupId``) or a CIDR range (``CidrIp`` or ``CidrIpv6``).
group_idstringThe ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -cidr_ip, -cidr_ipv6, -description, -from_port, -to_port, -ip_protocol, -destination_security_group_id, -id, -destination_prefix_list_id, -group_id -FROM awscc.ec2.security_group_egress -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the security_group_egress resource, the following permissions are required: - -### Read -```json -ec2:DescribeSecurityGroupRules -``` - -### Update -```json -ec2:UpdateSecurityGroupRuleDescriptionsEgress -``` - -### Delete -```json -ec2:RevokeSecurityGroupEgress, -ec2:DescribeSecurityGroupRules -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/security_group_egresses/index.md b/docs/awscc-docs/providers/awscc/ec2/security_group_egresses/index.md deleted file mode 100644 index dcbf5b86ed..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/security_group_egresses/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: security_group_egresses -hide_title: false -hide_table_of_contents: false -keywords: - - security_group_egresses - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of security_group_egresses in a region - -## Overview - - - - - -
Namesecurity_group_egresses
TypeResource
Descriptionsecurity_group_egresses
Idawscc.ec2.security_group_egresses
- -## Fields - - - - - -
NameDatatypeDescription
idstring
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -id -FROM awscc.ec2.security_group_egresses -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the security_group_egresses resource, the following permissions are required: - -### Create -```json -ec2:AuthorizeSecurityGroupEgress, -ec2:RevokeSecurityGroupEgress, -ec2:DescribeSecurityGroupRules -``` - -### List -```json -ec2:DescribeSecurityGroupRules -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/security_group_ingress/index.md b/docs/awscc-docs/providers/awscc/ec2/security_group_ingress/index.md deleted file mode 100644 index 83b43e35d5..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/security_group_ingress/index.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -title: security_group_ingress -hide_title: false -hide_table_of_contents: false -keywords: - - security_group_ingress - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual security_group_ingress resource - -## Overview - - - - - -
Namesecurity_group_ingress
TypeResource
Descriptionsecurity_group_ingress
Idawscc.ec2.security_group_ingress
- -## Fields - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
idstringThe Security Group Rule Id
cidr_ipstringThe IPv4 ranges
cidr_ipv6string[VPC only] The IPv6 ranges
descriptionstringUpdates the description of an ingress (inbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously
from_portintegerThe start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.<br/><br/>Use this for ICMP and any protocol that uses ports.
group_idstringThe ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.<br/><br/>You must specify the GroupName property or the GroupId property. For security groups that are in a VPC, you must use the GroupId property.
group_namestringThe name of the security group.
ip_protocolstringThe IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers).<br/><br/>[VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
source_prefix_list_idstring[EC2-VPC only] The ID of a prefix list.<br/><br/>
source_security_group_idstringThe ID of the security group. You must specify either the security group ID or the security group name. For security groups in a nondefault VPC, you must specify the security group ID.
source_security_group_namestring[EC2-Classic, default VPC] The name of the source security group.<br/><br/>You must specify the GroupName property or the GroupId property. For security groups that are in a VPC, you must use the GroupId property.
source_security_group_owner_idstring[nondefault VPC] The AWS account ID that owns the source security group. You can't specify this property with an IP address range.<br/><br/>If you specify SourceSecurityGroupName or SourceSecurityGroupId and that security group is owned by a different account than the account creating the stack, you must specify the SourceSecurityGroupOwnerId; otherwise, this property is optional.
to_portintegerThe end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes for the specified ICMP type. If you specify all ICMP/ICMPv6 types, you must specify all codes.<br/><br/>Use this for ICMP and any protocol that uses ports.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -id, -cidr_ip, -cidr_ipv6, -description, -from_port, -group_id, -group_name, -ip_protocol, -source_prefix_list_id, -source_security_group_id, -source_security_group_name, -source_security_group_owner_id, -to_port -FROM awscc.ec2.security_group_ingress -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the security_group_ingress resource, the following permissions are required: - -### Update -```json -ec2:UpdateSecurityGroupRuleDescriptionsIngress -``` - -### Delete -```json -ec2:DescribeSecurityGroupRules, -ec2:RevokeSecurityGroupIngress -``` - -### Read -```json -ec2:DescribeSecurityGroups, -ec2:DescribeSecurityGroupRules -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/security_group_ingresses/index.md b/docs/awscc-docs/providers/awscc/ec2/security_group_ingresses/index.md deleted file mode 100644 index b9fe5bfcb1..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/security_group_ingresses/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: security_group_ingresses -hide_title: false -hide_table_of_contents: false -keywords: - - security_group_ingresses - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of security_group_ingresses in a region - -## Overview - - - - - -
Namesecurity_group_ingresses
TypeResource
Descriptionsecurity_group_ingresses
Idawscc.ec2.security_group_ingresses
- -## Fields - - - - - -
NameDatatypeDescription
idstringThe Security Group Rule Id
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -id -FROM awscc.ec2.security_group_ingresses -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the security_group_ingresses resource, the following permissions are required: - -### Create -```json -ec2:DescribeSecurityGroupRules, -ec2:AuthorizeSecurityGroupIngress -``` - -### List -```json -ec2:DescribeSecurityGroupRules -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/snapshot_block_public_access/index.md b/docs/awscc-docs/providers/awscc/ec2/snapshot_block_public_access/index.md deleted file mode 100644 index 8e7115e48e..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/snapshot_block_public_access/index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: snapshot_block_public_access -hide_title: false -hide_table_of_contents: false -keywords: - - snapshot_block_public_access - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual snapshot_block_public_access resource - -## Overview - - - - - -
Namesnapshot_block_public_access
TypeResource
Descriptionsnapshot_block_public_access
Idawscc.ec2.snapshot_block_public_access
- -## Fields - - - - - - -
NameDatatypeDescription
statestringThe state of EBS Snapshot Block Public Access.
account_idstringThe identifier for the specified AWS account.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -state, -account_id -FROM awscc.ec2.snapshot_block_public_access -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the snapshot_block_public_access resource, the following permissions are required: - -### Read -```json -ec2:GetSnapshotBlockPublicAccessState -``` - -### Update -```json -ec2:EnableSnapshotBlockPublicAccess, -ec2:GetSnapshotBlockPublicAccessState -``` - -### Delete -```json -ec2:DisableSnapshotBlockPublicAccess, -ec2:GetSnapshotBlockPublicAccessState -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/snapshot_block_public_accesses/index.md b/docs/awscc-docs/providers/awscc/ec2/snapshot_block_public_accesses/index.md deleted file mode 100644 index 2e55d2f708..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/snapshot_block_public_accesses/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: snapshot_block_public_accesses -hide_title: false -hide_table_of_contents: false -keywords: - - snapshot_block_public_accesses - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of snapshot_block_public_accesses in a region - -## Overview - - - - - -
Namesnapshot_block_public_accesses
TypeResource
Descriptionsnapshot_block_public_accesses
Idawscc.ec2.snapshot_block_public_accesses
- -## Fields - - - - - -
NameDatatypeDescription
account_idstringThe identifier for the specified AWS account.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -account_id -FROM awscc.ec2.snapshot_block_public_accesses -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the snapshot_block_public_accesses resource, the following permissions are required: - -### Create -```json -ec2:EnableSnapshotBlockPublicAccess, -ec2:GetSnapshotBlockPublicAccessState -``` - -### List -```json -ec2:GetSnapshotBlockPublicAccessState -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/snapshots/index.md b/docs/awscc-docs/providers/awscc/ec2/snapshots/index.md deleted file mode 100644 index cddc65d0ee..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/snapshots/index.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -title: snapshots -hide_title: false -hide_table_of_contents: false -keywords: - - snapshots - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -List of snapshots by region (requires `aws` provider to be installed) - -## Overview - - - - - -
Namesnapshots
TypeResource
DescriptionList of snapshots by region (requires `aws` provider to be installed)
Idawscc.ec2.snapshots
- -## Fields - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
descriptionstringThe description for the snapshot.
data_encryption_key_idstringThe data encryption key identifier for the snapshot.
encryptedbooleanIndicates whether the snapshot is encrypted.
kms_key_idstringThe Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the parent volume.
outpost_arnstring
owner_aliasstringThe Amazon Web Services owner alias.
owner_idstring
progressstringThe progress of the snapshot, as a percentage.
restore_expiry_timestringOnly for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived.
snapshot_idstringThe ID of the snapshot. Each snapshot receives a unique identifier when it is created.
start_timestringThe time stamp when the snapshot was initiated.
statusstringThe snapshot state.
status_messagestringEncrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper Key Management Service (KMS) permissions are not obtained) this field displays error state details.
storage_tierstringThe storage tier in which the snapshot is stored.
tag_setarray
volume_idstringThe ID of the volume that was used to create the snapshot.
volume_sizeintegerThe size of the volume, in GiB.
regionstring
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -description, -data_encryption_key_id, -encrypted, -kms_key_id, -outpost_arn, -owner_alias, -owner_id, -progress, -restore_expiry_time, -snapshot_id, -start_time, -status, -status_message, -storage_tier, -tag_set, -volume_id, -volume_size, -region -FROM awscc.ec2.snapshots -WHERE region = ''; -``` - - - - diff --git a/docs/awscc-docs/providers/awscc/ec2/spot_fleet/index.md b/docs/awscc-docs/providers/awscc/ec2/spot_fleet/index.md deleted file mode 100644 index ec8ac19e70..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/spot_fleet/index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: spot_fleet -hide_title: false -hide_table_of_contents: false -keywords: - - spot_fleet - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual spot_fleet resource - -## Overview - - - - - -
Namespot_fleet
TypeResource
Descriptionspot_fleet
Idawscc.ec2.spot_fleet
- -## Fields - - - - - - -
NameDatatypeDescription
idstring
spot_fleet_request_config_dataobject
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -id, -spot_fleet_request_config_data -FROM awscc.ec2.spot_fleet -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the spot_fleet resource, the following permissions are required: - -### Delete -```json -ec2:DescribeSpotFleetRequests, -ec2:CancelSpotFleetRequests -``` - -### Read -```json -ec2:DescribeSpotFleetRequests -``` - -### Update -```json -ec2:ModifySpotFleetRequest, -ec2:DescribeSpotFleetRequests -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/spot_fleets/index.md b/docs/awscc-docs/providers/awscc/ec2/spot_fleets/index.md deleted file mode 100644 index 7d918ede5f..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/spot_fleets/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: spot_fleets -hide_title: false -hide_table_of_contents: false -keywords: - - spot_fleets - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of spot_fleets in a region - -## Overview - - - - - -
Namespot_fleets
TypeResource
Descriptionspot_fleets
Idawscc.ec2.spot_fleets
- -## Fields - - - - - -
NameDatatypeDescription
idstring
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -id -FROM awscc.ec2.spot_fleets -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the spot_fleets resource, the following permissions are required: - -### Create -```json -iam:PassRole, -ec2:CreateTags, -ec2:RequestSpotFleet, -ec2:DescribeSpotFleetRequests, -ec2:RunInstances -``` - -### List -```json -ec2:DescribeSpotFleetRequests -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/subnet/index.md b/docs/awscc-docs/providers/awscc/ec2/subnet/index.md deleted file mode 100644 index 50e864e55d..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/subnet/index.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -title: subnet -hide_title: false -hide_table_of_contents: false -keywords: - - subnet - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual subnet resource - -## Overview - - - - - -
Namesubnet
TypeResource
Descriptionsubnet
Idawscc.ec2.subnet
- -## Fields - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
assign_ipv6_address_on_creationbooleanIndicates whether a network interface created in this subnet receives an IPv6 address. The default value is ``false``.<br/> If you specify ``AssignIpv6AddressOnCreation``, you must also specify an IPv6 CIDR block.
vpc_idstringThe ID of the VPC the subnet is in.<br/> If you update this property, you must also update the ``CidrBlock`` property.
map_public_ip_on_launchbooleanIndicates whether instances launched in this subnet receive a public IPv4 address. The default value is ``false``.<br/> AWS charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the *Public IPv4 Address* tab on the [VPC pricing page](https://docs.aws.amazon.com/vpc/pricing/).
network_acl_association_idstring
availability_zonestringThe Availability Zone of the subnet.<br/> If you update this property, you must also update the ``CidrBlock`` property.
availability_zone_idstringThe AZ ID of the subnet.
cidr_blockstringThe IPv4 CIDR block assigned to the subnet.<br/> If you update this property, we create a new subnet, and then delete the existing one.
subnet_idstring
ipv6_cidr_blocksarrayThe IPv6 network ranges for the subnet, in CIDR notation.
ipv6_cidr_blockstringThe IPv6 CIDR block.<br/> If you specify ``AssignIpv6AddressOnCreation``, you must also specify an IPv6 CIDR block.
outpost_arnstringThe Amazon Resource Name (ARN) of the Outpost.
ipv6_nativebooleanIndicates whether this is an IPv6 only subnet. For more information, see [Subnet basics](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html#subnet-basics) in the *User Guide*.
enable_dns64booleanIndicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations. For more information, see [DNS64 and NAT64](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-nat64-dns64) in the *User Guide*.
private_dns_name_options_on_launchobjectThe hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries to the instances should be handled. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *User Guide*.<br/> Available options:<br/> + EnableResourceNameDnsAAAARecord (true | false)<br/> + EnableResourceNameDnsARecord (true | false)<br/> + HostnameType (ip-name | resource-name)
tagsarrayAny tags assigned to the subnet.
ipv4_ipam_pool_idstringAn IPv4 IPAM pool ID for the subnet.
ipv4_netmask_lengthintegerAn IPv4 netmask length for the subnet.
ipv6_ipam_pool_idstringAn IPv6 IPAM pool ID for the subnet.
ipv6_netmask_lengthintegerAn IPv6 netmask length for the subnet.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -assign_ipv6_address_on_creation, -vpc_id, -map_public_ip_on_launch, -network_acl_association_id, -availability_zone, -availability_zone_id, -cidr_block, -subnet_id, -ipv6_cidr_blocks, -ipv6_cidr_block, -outpost_arn, -ipv6_native, -enable_dns64, -private_dns_name_options_on_launch, -tags, -ipv4_ipam_pool_id, -ipv4_netmask_length, -ipv6_ipam_pool_id, -ipv6_netmask_length -FROM awscc.ec2.subnet -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the subnet resource, the following permissions are required: - -### Read -```json -ec2:DescribeSubnets, -ec2:DescribeNetworkAcls -``` - -### Update -```json -ec2:DescribeSubnets, -ec2:ModifySubnetAttribute, -ec2:CreateTags, -ec2:DeleteTags, -ec2:AssociateSubnetCidrBlock, -ec2:DisassociateSubnetCidrBlock -``` - -### Delete -```json -ec2:DescribeSubnets, -ec2:DeleteSubnet -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/subnet_cidr_block/index.md b/docs/awscc-docs/providers/awscc/ec2/subnet_cidr_block/index.md deleted file mode 100644 index 2095247323..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/subnet_cidr_block/index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: subnet_cidr_block -hide_title: false -hide_table_of_contents: false -keywords: - - subnet_cidr_block - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual subnet_cidr_block resource - -## Overview - - - - - -
Namesubnet_cidr_block
TypeResource
Descriptionsubnet_cidr_block
Idawscc.ec2.subnet_cidr_block
- -## Fields - - - - - - - - - -
NameDatatypeDescription
idstringInformation about the IPv6 association.
ipv6_cidr_blockstringThe IPv6 network range for the subnet, in CIDR notation. The subnet size must use a /64 prefix length
ipv6_ipam_pool_idstringThe ID of an IPv6 Amazon VPC IP Address Manager (IPAM) pool from which to allocate, to get the subnet's CIDR
ipv6_netmask_lengthintegerThe netmask length of the IPv6 CIDR to allocate to the subnet from an IPAM pool
subnet_idstringThe ID of the subnet
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -id, -ipv6_cidr_block, -ipv6_ipam_pool_id, -ipv6_netmask_length, -subnet_id -FROM awscc.ec2.subnet_cidr_block -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the subnet_cidr_block resource, the following permissions are required: - -### Delete -```json -ec2:DisassociateSubnetCidrBlock, -ec2:DescribeSubnets -``` - -### Read -```json -ec2:DescribeSubnets -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/subnet_cidr_blocks/index.md b/docs/awscc-docs/providers/awscc/ec2/subnet_cidr_blocks/index.md deleted file mode 100644 index 1cd2088c25..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/subnet_cidr_blocks/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: subnet_cidr_blocks -hide_title: false -hide_table_of_contents: false -keywords: - - subnet_cidr_blocks - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of subnet_cidr_blocks in a region - -## Overview - - - - - -
Namesubnet_cidr_blocks
TypeResource
Descriptionsubnet_cidr_blocks
Idawscc.ec2.subnet_cidr_blocks
- -## Fields - - - - - -
NameDatatypeDescription
idstringInformation about the IPv6 association.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -id -FROM awscc.ec2.subnet_cidr_blocks -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the subnet_cidr_blocks resource, the following permissions are required: - -### Create -```json -ec2:AssociateSubnetCidrBlock, -ec2:DescribeSubnets -``` - -### List -```json -ec2:DescribeSubnets -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/subnet_network_acl_association/index.md b/docs/awscc-docs/providers/awscc/ec2/subnet_network_acl_association/index.md deleted file mode 100644 index daf368f5e9..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/subnet_network_acl_association/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: subnet_network_acl_association -hide_title: false -hide_table_of_contents: false -keywords: - - subnet_network_acl_association - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual subnet_network_acl_association resource - -## Overview - - - - - -
Namesubnet_network_acl_association
TypeResource
Descriptionsubnet_network_acl_association
Idawscc.ec2.subnet_network_acl_association
- -## Fields - - - - - - - -
NameDatatypeDescription
subnet_idstringThe ID of the subnet
network_acl_idstringThe ID of the network ACL
association_idstring
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -subnet_id, -network_acl_id, -association_id -FROM awscc.ec2.subnet_network_acl_association -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the subnet_network_acl_association resource, the following permissions are required: - -### Read -```json -ec2:DescribeNetworkAcls -``` - -### Delete -```json -ec2:DescribeNetworkAcls, -ec2:ReplaceNetworkAclAssociation -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/subnet_network_acl_associations/index.md b/docs/awscc-docs/providers/awscc/ec2/subnet_network_acl_associations/index.md deleted file mode 100644 index 5d0ef29a67..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/subnet_network_acl_associations/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: subnet_network_acl_associations -hide_title: false -hide_table_of_contents: false -keywords: - - subnet_network_acl_associations - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of subnet_network_acl_associations in a region - -## Overview - - - - - -
Namesubnet_network_acl_associations
TypeResource
Descriptionsubnet_network_acl_associations
Idawscc.ec2.subnet_network_acl_associations
- -## Fields - - - - - -
NameDatatypeDescription
association_idstring
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -association_id -FROM awscc.ec2.subnet_network_acl_associations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the subnet_network_acl_associations resource, the following permissions are required: - -### Create -```json -ec2:DescribeNetworkAcls, -ec2:ReplaceNetworkAclAssociation -``` - -### List -```json -ec2:DescribeNetworkAcls -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/subnet_route_table_association/index.md b/docs/awscc-docs/providers/awscc/ec2/subnet_route_table_association/index.md deleted file mode 100644 index d15f9c9655..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/subnet_route_table_association/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: subnet_route_table_association -hide_title: false -hide_table_of_contents: false -keywords: - - subnet_route_table_association - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual subnet_route_table_association resource - -## Overview - - - - - -
Namesubnet_route_table_association
TypeResource
Descriptionsubnet_route_table_association
Idawscc.ec2.subnet_route_table_association
- -## Fields - - - - - - - -
NameDatatypeDescription
idstring
route_table_idstringThe ID of the route table.<br/> The physical ID changes when the route table ID is changed.
subnet_idstringThe ID of the subnet.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -id, -route_table_id, -subnet_id -FROM awscc.ec2.subnet_route_table_association -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the subnet_route_table_association resource, the following permissions are required: - -### Read -```json -ec2:DescribeRouteTables -``` - -### Delete -```json -ec2:DisassociateRouteTable, -ec2:DescribeSubnets, -ec2:DescribeRouteTables -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/subnet_route_table_associations/index.md b/docs/awscc-docs/providers/awscc/ec2/subnet_route_table_associations/index.md deleted file mode 100644 index 2ceadbe6ac..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/subnet_route_table_associations/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: subnet_route_table_associations -hide_title: false -hide_table_of_contents: false -keywords: - - subnet_route_table_associations - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of subnet_route_table_associations in a region - -## Overview - - - - - -
Namesubnet_route_table_associations
TypeResource
Descriptionsubnet_route_table_associations
Idawscc.ec2.subnet_route_table_associations
- -## Fields - - - - - -
NameDatatypeDescription
idstring
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -id -FROM awscc.ec2.subnet_route_table_associations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the subnet_route_table_associations resource, the following permissions are required: - -### Create -```json -ec2:AssociateRouteTable, -ec2:ReplaceRouteTableAssociation, -ec2:DescribeSubnets, -ec2:DescribeRouteTables -``` - -### List -```json -ec2:DescribeRouteTables -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/subnets/index.md b/docs/awscc-docs/providers/awscc/ec2/subnets/index.md deleted file mode 100644 index 41a4b91aaf..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/subnets/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: subnets -hide_title: false -hide_table_of_contents: false -keywords: - - subnets - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of subnets in a region - -## Overview - - - - - -
Namesubnets
TypeResource
Descriptionsubnets
Idawscc.ec2.subnets
- -## Fields - - - - - -
NameDatatypeDescription
subnet_idstring
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -subnet_id -FROM awscc.ec2.subnets -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the subnets resource, the following permissions are required: - -### Create -```json -ec2:DescribeSubnets, -ec2:CreateSubnet, -ec2:CreateTags, -ec2:ModifySubnetAttribute -``` - -### List -```json -ec2:DescribeSubnets, -ec2:DescribeNetworkAcls -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/transit_gateway/index.md b/docs/awscc-docs/providers/awscc/ec2/transit_gateway/index.md deleted file mode 100644 index e31e88d883..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/transit_gateway/index.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -title: transit_gateway -hide_title: false -hide_table_of_contents: false -keywords: - - transit_gateway - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual transit_gateway resource - -## Overview - - - - - -
Nametransit_gateway
TypeResource
Descriptiontransit_gateway
Idawscc.ec2.transit_gateway
- -## Fields - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
descriptionstring
association_default_route_table_idstring
auto_accept_shared_attachmentsstring
transit_gateway_arnstring
default_route_table_propagationstring
transit_gateway_cidr_blocksarray
propagation_default_route_table_idstring
default_route_table_associationstring
idstring
vpn_ecmp_supportstring
dns_supportstring
multicast_supportstring
amazon_side_asninteger
tagsarray
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -description, -association_default_route_table_id, -auto_accept_shared_attachments, -transit_gateway_arn, -default_route_table_propagation, -transit_gateway_cidr_blocks, -propagation_default_route_table_id, -default_route_table_association, -id, -vpn_ecmp_support, -dns_support, -multicast_support, -amazon_side_asn, -tags -FROM awscc.ec2.transit_gateway -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the transit_gateway resource, the following permissions are required: - -### Read -```json -ec2:CreateTransitGateway, -ec2:CreateTags, -ec2:DescribeTransitGateways, -ec2:DescribeTags, -ec2:DeleteTransitGateway, -ec2:DeleteTags, -ec2:ModifyTransitGateway, -ec2:ModifyTransitGatewayOptions -``` - -### Update -```json -ec2:CreateTransitGateway, -ec2:CreateTags, -ec2:DescribeTransitGateways, -ec2:DescribeTags, -ec2:DeleteTransitGateway, -ec2:DeleteTags, -ec2:ModifyTransitGateway, -ec2:ModifyTransitGatewayOptions -``` - -### Delete -```json -ec2:CreateTransitGateway, -ec2:CreateTags, -ec2:DescribeTransitGateways, -ec2:DescribeTags, -ec2:DeleteTransitGateway, -ec2:DeleteTags, -ec2:ModifyTransitGateway, -ec2:ModifyTransitGatewayOptions -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/transit_gateway_attachment/index.md b/docs/awscc-docs/providers/awscc/ec2/transit_gateway_attachment/index.md deleted file mode 100644 index a3ef79c7f9..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/transit_gateway_attachment/index.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -title: transit_gateway_attachment -hide_title: false -hide_table_of_contents: false -keywords: - - transit_gateway_attachment - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual transit_gateway_attachment resource - -## Overview - - - - - -
Nametransit_gateway_attachment
TypeResource
Descriptiontransit_gateway_attachment
Idawscc.ec2.transit_gateway_attachment
- -## Fields - - - - - - - - - - -
NameDatatypeDescription
idstring
transit_gateway_idstring
vpc_idstring
subnet_idsarray
tagsarray
optionsobjectThe options for the transit gateway vpc attachment.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -id, -transit_gateway_id, -vpc_id, -subnet_ids, -tags, -options -FROM awscc.ec2.transit_gateway_attachment -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the transit_gateway_attachment resource, the following permissions are required: - -### Read -```json -ec2:DescribeTransitGatewayAttachments, -ec2:DescribeTransitGatewayVpcAttachments, -ec2:CreateTransitGatewayVpcAttachment, -ec2:DeleteTransitGatewayVpcAttachment, -ec2:CreateTags, -ec2:DeleteTags, -ec2:DescribeTags, -ec2:DescribeTransitGatewayAttachments, -ec2:ModifyTransitGatewayVpcAttachment -``` - -### Delete -```json -ec2:DescribeTransitGatewayAttachments, -ec2:DescribeTransitGatewayVpcAttachments, -ec2:CreateTransitGatewayVpcAttachment, -ec2:DeleteTransitGatewayVpcAttachment, -ec2:CreateTags, -ec2:DeleteTags, -ec2:DescribeTags, -ec2:DescribeTransitGatewayAttachments, -ec2:ModifyTransitGatewayVpcAttachment -``` - -### Update -```json -ec2:DescribeTransitGatewayAttachments, -ec2:DescribeTransitGatewayVpcAttachments, -ec2:DescribeTags, -ec2:CreateTransitGatewayVpcAttachment, -ec2:CreateTags, -ec2:DeleteTransitGatewayVpcAttachment, -ec2:DeleteTags, -ec2:ModifyTransitGatewayVpcAttachment -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/transit_gateway_attachments/index.md b/docs/awscc-docs/providers/awscc/ec2/transit_gateway_attachments/index.md deleted file mode 100644 index ac3a3bb83a..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/transit_gateway_attachments/index.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: transit_gateway_attachments -hide_title: false -hide_table_of_contents: false -keywords: - - transit_gateway_attachments - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of transit_gateway_attachments in a region - -## Overview - - - - - -
Nametransit_gateway_attachments
TypeResource
Descriptiontransit_gateway_attachments
Idawscc.ec2.transit_gateway_attachments
- -## Fields - - - - - -
NameDatatypeDescription
idstring
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -id -FROM awscc.ec2.transit_gateway_attachments -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the transit_gateway_attachments resource, the following permissions are required: - -### Create -```json -ec2:DescribeTransitGatewayAttachments, -ec2:DescribeTransitGatewayVpcAttachments, -ec2:CreateTransitGatewayVpcAttachment, -ec2:DeleteTransitGatewayVpcAttachment, -ec2:CreateTags, -ec2:DeleteTags, -ec2:DescribeTags, -ec2:DescribeTransitGatewayAttachments, -ec2:ModifyTransitGatewayVpcAttachment -``` - -### List -```json -ec2:DescribeTransitGatewayAttachments, -ec2:DescribeTransitGatewayVpcAttachments, -ec2:DescribeTags, -ec2:CreateTransitGatewayVpcAttachment, -ec2:CreateTags, -ec2:DeleteTransitGatewayVpcAttachment, -ec2:DeleteTags, -ec2:ModifyTransitGatewayVpcAttachment -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/transit_gateway_connect/index.md b/docs/awscc-docs/providers/awscc/ec2/transit_gateway_connect/index.md deleted file mode 100644 index 12770bae10..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/transit_gateway_connect/index.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -title: transit_gateway_connect -hide_title: false -hide_table_of_contents: false -keywords: - - transit_gateway_connect - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual transit_gateway_connect resource - -## Overview - - - - - -
Nametransit_gateway_connect
TypeResource
Descriptiontransit_gateway_connect
Idawscc.ec2.transit_gateway_connect
- -## Fields - - - - - - - - - - - -
NameDatatypeDescription
transit_gateway_attachment_idstringThe ID of the Connect attachment.
transport_transit_gateway_attachment_idstringThe ID of the attachment from which the Connect attachment was created.
transit_gateway_idstringThe ID of the transit gateway.
statestringThe state of the attachment.
creation_timestringThe creation time.
tagsarrayThe tags for the attachment.
optionsobjectThe Connect attachment options.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -transit_gateway_attachment_id, -transport_transit_gateway_attachment_id, -transit_gateway_id, -state, -creation_time, -tags, -options -FROM awscc.ec2.transit_gateway_connect -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the transit_gateway_connect resource, the following permissions are required: - -### Read -```json -ec2:DescribeTransitGatewayConnects -``` - -### Update -```json -ec2:DescribeTransitGatewayConnects, -ec2:DeleteTags, -ec2:CreateTags -``` - -### Delete -```json -ec2:DeleteTransitGatewayConnect, -ec2:DescribeTransitGatewayConnects, -ec2:DeleteTags -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/transit_gateway_connects/index.md b/docs/awscc-docs/providers/awscc/ec2/transit_gateway_connects/index.md deleted file mode 100644 index f28287dfa1..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/transit_gateway_connects/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: transit_gateway_connects -hide_title: false -hide_table_of_contents: false -keywords: - - transit_gateway_connects - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of transit_gateway_connects in a region - -## Overview - - - - - -
Nametransit_gateway_connects
TypeResource
Descriptiontransit_gateway_connects
Idawscc.ec2.transit_gateway_connects
- -## Fields - - - - - -
NameDatatypeDescription
transit_gateway_attachment_idstringThe ID of the Connect attachment.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -transit_gateway_attachment_id -FROM awscc.ec2.transit_gateway_connects -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the transit_gateway_connects resource, the following permissions are required: - -### Create -```json -ec2:CreateTransitGatewayConnect, -ec2:DescribeTransitGatewayConnects, -ec2:CreateTags -``` - -### List -```json -ec2:DescribeTransitGatewayConnects -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/transit_gateway_multicast_domain/index.md b/docs/awscc-docs/providers/awscc/ec2/transit_gateway_multicast_domain/index.md deleted file mode 100644 index eff070021f..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/transit_gateway_multicast_domain/index.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -title: transit_gateway_multicast_domain -hide_title: false -hide_table_of_contents: false -keywords: - - transit_gateway_multicast_domain - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual transit_gateway_multicast_domain resource - -## Overview - - - - - -
Nametransit_gateway_multicast_domain
TypeResource
Descriptiontransit_gateway_multicast_domain
Idawscc.ec2.transit_gateway_multicast_domain
- -## Fields - - - - - - - - - - - -
NameDatatypeDescription
transit_gateway_multicast_domain_idstringThe ID of the transit gateway multicast domain.
transit_gateway_multicast_domain_arnstringThe Amazon Resource Name (ARN) of the transit gateway multicast domain.
transit_gateway_idstringThe ID of the transit gateway.
statestringThe state of the transit gateway multicast domain.
creation_timestringThe time the transit gateway multicast domain was created.
tagsarrayThe tags for the transit gateway multicast domain.
optionsobjectThe options for the transit gateway multicast domain.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -transit_gateway_multicast_domain_id, -transit_gateway_multicast_domain_arn, -transit_gateway_id, -state, -creation_time, -tags, -options -FROM awscc.ec2.transit_gateway_multicast_domain -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the transit_gateway_multicast_domain resource, the following permissions are required: - -### Read -```json -ec2:DescribeTransitGatewayMulticastDomains -``` - -### Update -```json -ec2:DescribeTransitGatewayMulticastDomains, -ec2:DeleteTags, -ec2:CreateTags -``` - -### Delete -```json -ec2:DescribeTransitGatewayMulticastDomains, -ec2:DeleteTransitGatewayMulticastDomain, -ec2:DeleteTags -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/transit_gateway_multicast_domain_association/index.md b/docs/awscc-docs/providers/awscc/ec2/transit_gateway_multicast_domain_association/index.md deleted file mode 100644 index 72a3e6d94a..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/transit_gateway_multicast_domain_association/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: transit_gateway_multicast_domain_association -hide_title: false -hide_table_of_contents: false -keywords: - - transit_gateway_multicast_domain_association - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual transit_gateway_multicast_domain_association resource - -## Overview - - - - - -
Nametransit_gateway_multicast_domain_association
TypeResource
Descriptiontransit_gateway_multicast_domain_association
Idawscc.ec2.transit_gateway_multicast_domain_association
- -## Fields - - - - - - - - - - -
NameDatatypeDescription
transit_gateway_multicast_domain_idstringThe ID of the transit gateway multicast domain.
transit_gateway_attachment_idstringThe ID of the transit gateway attachment.
resource_idstringThe ID of the resource.
resource_typestringThe type of resource, for example a VPC attachment.
statestringThe state of the subnet association.
subnet_idstringThe IDs of the subnets to associate with the transit gateway multicast domain.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -transit_gateway_multicast_domain_id, -transit_gateway_attachment_id, -resource_id, -resource_type, -state, -subnet_id -FROM awscc.ec2.transit_gateway_multicast_domain_association -WHERE data__Identifier = '||'; -``` - -## Permissions - -To operate on the transit_gateway_multicast_domain_association resource, the following permissions are required: - -### Read -```json -ec2:GetTransitGatewayMulticastDomainAssociations -``` - -### Delete -```json -ec2:DisassociateTransitGatewayMulticastDomain, -ec2:GetTransitGatewayMulticastDomainAssociations -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/transit_gateway_multicast_domain_associations/index.md b/docs/awscc-docs/providers/awscc/ec2/transit_gateway_multicast_domain_associations/index.md deleted file mode 100644 index 556bfc5086..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/transit_gateway_multicast_domain_associations/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: transit_gateway_multicast_domain_associations -hide_title: false -hide_table_of_contents: false -keywords: - - transit_gateway_multicast_domain_associations - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of transit_gateway_multicast_domain_associations in a region - -## Overview - - - - - -
Nametransit_gateway_multicast_domain_associations
TypeResource
Descriptiontransit_gateway_multicast_domain_associations
Idawscc.ec2.transit_gateway_multicast_domain_associations
- -## Fields - - - - - - - -
NameDatatypeDescription
transit_gateway_multicast_domain_idstringThe ID of the transit gateway multicast domain.
transit_gateway_attachment_idstringThe ID of the transit gateway attachment.
subnet_idstringThe IDs of the subnets to associate with the transit gateway multicast domain.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -transit_gateway_multicast_domain_id, -transit_gateway_attachment_id, -subnet_id -FROM awscc.ec2.transit_gateway_multicast_domain_associations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the transit_gateway_multicast_domain_associations resource, the following permissions are required: - -### Create -```json -ec2:AssociateTransitGatewayMulticastDomain, -ec2:GetTransitGatewayMulticastDomainAssociations -``` - -### List -```json -ec2:GetTransitGatewayMulticastDomainAssociations -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/transit_gateway_multicast_domains/index.md b/docs/awscc-docs/providers/awscc/ec2/transit_gateway_multicast_domains/index.md deleted file mode 100644 index cd4de27e32..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/transit_gateway_multicast_domains/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: transit_gateway_multicast_domains -hide_title: false -hide_table_of_contents: false -keywords: - - transit_gateway_multicast_domains - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of transit_gateway_multicast_domains in a region - -## Overview - - - - - -
Nametransit_gateway_multicast_domains
TypeResource
Descriptiontransit_gateway_multicast_domains
Idawscc.ec2.transit_gateway_multicast_domains
- -## Fields - - - - - -
NameDatatypeDescription
transit_gateway_multicast_domain_idstringThe ID of the transit gateway multicast domain.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -transit_gateway_multicast_domain_id -FROM awscc.ec2.transit_gateway_multicast_domains -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the transit_gateway_multicast_domains resource, the following permissions are required: - -### Create -```json -ec2:DescribeTransitGatewayMulticastDomains, -ec2:CreateTransitGatewayMulticastDomain, -ec2:CreateTags -``` - -### List -```json -ec2:DescribeTransitGatewayMulticastDomains -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/transit_gateway_multicast_group_member/index.md b/docs/awscc-docs/providers/awscc/ec2/transit_gateway_multicast_group_member/index.md deleted file mode 100644 index 5e22d59122..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/transit_gateway_multicast_group_member/index.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -title: transit_gateway_multicast_group_member -hide_title: false -hide_table_of_contents: false -keywords: - - transit_gateway_multicast_group_member - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual transit_gateway_multicast_group_member resource - -## Overview - - - - - -
Nametransit_gateway_multicast_group_member
TypeResource
Descriptiontransit_gateway_multicast_group_member
Idawscc.ec2.transit_gateway_multicast_group_member
- -## Fields - - - - - - - - - - - - - - - -
NameDatatypeDescription
group_ip_addressstringThe IP address assigned to the transit gateway multicast group.
transit_gateway_attachment_idstringThe ID of the transit gateway attachment.
transit_gateway_multicast_domain_idstringThe ID of the transit gateway multicast domain.
subnet_idstringThe ID of the subnet.
resource_idstringThe ID of the resource.
resource_typestringThe type of resource, for example a VPC attachment.
network_interface_idstringThe ID of the transit gateway attachment.
group_memberbooleanIndicates that the resource is a transit gateway multicast group member.
group_sourcebooleanIndicates that the resource is a transit gateway multicast group member.
member_typestringThe member type (for example, static).
source_typestringThe source type.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -group_ip_address, -transit_gateway_attachment_id, -transit_gateway_multicast_domain_id, -subnet_id, -resource_id, -resource_type, -network_interface_id, -group_member, -group_source, -member_type, -source_type -FROM awscc.ec2.transit_gateway_multicast_group_member -WHERE data__Identifier = '||'; -``` - -## Permissions - -To operate on the transit_gateway_multicast_group_member resource, the following permissions are required: - -### Read -```json -ec2:SearchTransitGatewayMulticastGroups -``` - -### Delete -```json -ec2:DeregisterTransitGatewayMulticastGroupMembers, -ec2:SearchTransitGatewayMulticastGroups -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/transit_gateway_multicast_group_members/index.md b/docs/awscc-docs/providers/awscc/ec2/transit_gateway_multicast_group_members/index.md deleted file mode 100644 index 986a7773a6..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/transit_gateway_multicast_group_members/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: transit_gateway_multicast_group_members -hide_title: false -hide_table_of_contents: false -keywords: - - transit_gateway_multicast_group_members - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of transit_gateway_multicast_group_members in a region - -## Overview - - - - - -
Nametransit_gateway_multicast_group_members
TypeResource
Descriptiontransit_gateway_multicast_group_members
Idawscc.ec2.transit_gateway_multicast_group_members
- -## Fields - - - - - - - -
NameDatatypeDescription
transit_gateway_multicast_domain_idstringThe ID of the transit gateway multicast domain.
group_ip_addressstringThe IP address assigned to the transit gateway multicast group.
network_interface_idstringThe ID of the transit gateway attachment.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -transit_gateway_multicast_domain_id, -group_ip_address, -network_interface_id -FROM awscc.ec2.transit_gateway_multicast_group_members -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the transit_gateway_multicast_group_members resource, the following permissions are required: - -### Create -```json -ec2:RegisterTransitGatewayMulticastGroupMembers, -ec2:SearchTransitGatewayMulticastGroups -``` - -### List -```json -ec2:SearchTransitGatewayMulticastGroups -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/transit_gateway_multicast_group_source/index.md b/docs/awscc-docs/providers/awscc/ec2/transit_gateway_multicast_group_source/index.md deleted file mode 100644 index 9752086765..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/transit_gateway_multicast_group_source/index.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -title: transit_gateway_multicast_group_source -hide_title: false -hide_table_of_contents: false -keywords: - - transit_gateway_multicast_group_source - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual transit_gateway_multicast_group_source resource - -## Overview - - - - - -
Nametransit_gateway_multicast_group_source
TypeResource
Descriptiontransit_gateway_multicast_group_source
Idawscc.ec2.transit_gateway_multicast_group_source
- -## Fields - - - - - - - - - - - - - - - -
NameDatatypeDescription
group_ip_addressstringThe IP address assigned to the transit gateway multicast group.
transit_gateway_attachment_idstringThe ID of the transit gateway attachment.
transit_gateway_multicast_domain_idstringThe ID of the transit gateway multicast domain.
subnet_idstringThe ID of the subnet.
resource_idstringThe ID of the resource.
resource_typestringThe type of resource, for example a VPC attachment.
network_interface_idstringThe ID of the transit gateway attachment.
group_memberbooleanIndicates that the resource is a transit gateway multicast group member.
group_sourcebooleanIndicates that the resource is a transit gateway multicast group member.
member_typestringThe member type (for example, static).
source_typestringThe source type.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -group_ip_address, -transit_gateway_attachment_id, -transit_gateway_multicast_domain_id, -subnet_id, -resource_id, -resource_type, -network_interface_id, -group_member, -group_source, -member_type, -source_type -FROM awscc.ec2.transit_gateway_multicast_group_source -WHERE data__Identifier = '||'; -``` - -## Permissions - -To operate on the transit_gateway_multicast_group_source resource, the following permissions are required: - -### Read -```json -ec2:SearchTransitGatewayMulticastGroups -``` - -### Delete -```json -ec2:DeregisterTransitGatewayMulticastGroupSources, -ec2:SearchTransitGatewayMulticastGroups -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/transit_gateway_multicast_group_sources/index.md b/docs/awscc-docs/providers/awscc/ec2/transit_gateway_multicast_group_sources/index.md deleted file mode 100644 index a5e9d6dfe1..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/transit_gateway_multicast_group_sources/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: transit_gateway_multicast_group_sources -hide_title: false -hide_table_of_contents: false -keywords: - - transit_gateway_multicast_group_sources - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of transit_gateway_multicast_group_sources in a region - -## Overview - - - - - -
Nametransit_gateway_multicast_group_sources
TypeResource
Descriptiontransit_gateway_multicast_group_sources
Idawscc.ec2.transit_gateway_multicast_group_sources
- -## Fields - - - - - - - -
NameDatatypeDescription
transit_gateway_multicast_domain_idstringThe ID of the transit gateway multicast domain.
group_ip_addressstringThe IP address assigned to the transit gateway multicast group.
network_interface_idstringThe ID of the transit gateway attachment.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -transit_gateway_multicast_domain_id, -group_ip_address, -network_interface_id -FROM awscc.ec2.transit_gateway_multicast_group_sources -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the transit_gateway_multicast_group_sources resource, the following permissions are required: - -### Create -```json -ec2:RegisterTransitGatewayMulticastGroupSources, -ec2:SearchTransitGatewayMulticastGroups -``` - -### List -```json -ec2:SearchTransitGatewayMulticastGroups -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/transit_gateway_peering_attachment/index.md b/docs/awscc-docs/providers/awscc/ec2/transit_gateway_peering_attachment/index.md deleted file mode 100644 index 20cdbf9eae..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/transit_gateway_peering_attachment/index.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -title: transit_gateway_peering_attachment -hide_title: false -hide_table_of_contents: false -keywords: - - transit_gateway_peering_attachment - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual transit_gateway_peering_attachment resource - -## Overview - - - - - -
Nametransit_gateway_peering_attachment
TypeResource
Descriptiontransit_gateway_peering_attachment
Idawscc.ec2.transit_gateway_peering_attachment
- -## Fields - - - - - - - - - - - - - -
NameDatatypeDescription
statusobjectThe status of the transit gateway peering attachment.
transit_gateway_idstringThe ID of the transit gateway.
peer_transit_gateway_idstringThe ID of the peer transit gateway.
peer_account_idstringThe ID of the peer account
statestringThe state of the transit gateway peering attachment. Note that the initiating state has been deprecated.
creation_timestringThe time the transit gateway peering attachment was created.
peer_regionstringPeer Region
tagsarrayThe tags for the transit gateway peering attachment.
transit_gateway_attachment_idstringThe ID of the transit gateway peering attachment.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -status, -transit_gateway_id, -peer_transit_gateway_id, -peer_account_id, -state, -creation_time, -peer_region, -tags, -transit_gateway_attachment_id -FROM awscc.ec2.transit_gateway_peering_attachment -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the transit_gateway_peering_attachment resource, the following permissions are required: - -### Read -```json -ec2:DescribeTransitGatewayPeeringAttachments -``` - -### Update -```json -ec2:DescribeTransitGatewayPeeringAttachments -``` - -### Delete -```json -ec2:DeleteTransitGatewayPeeringAttachment, -ec2:DescribeTransitGatewayPeeringAttachments -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/transit_gateway_peering_attachments/index.md b/docs/awscc-docs/providers/awscc/ec2/transit_gateway_peering_attachments/index.md deleted file mode 100644 index 58d1636b05..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/transit_gateway_peering_attachments/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: transit_gateway_peering_attachments -hide_title: false -hide_table_of_contents: false -keywords: - - transit_gateway_peering_attachments - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of transit_gateway_peering_attachments in a region - -## Overview - - - - - -
Nametransit_gateway_peering_attachments
TypeResource
Descriptiontransit_gateway_peering_attachments
Idawscc.ec2.transit_gateway_peering_attachments
- -## Fields - - - - - -
NameDatatypeDescription
transit_gateway_attachment_idstringThe ID of the transit gateway peering attachment.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -transit_gateway_attachment_id -FROM awscc.ec2.transit_gateway_peering_attachments -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the transit_gateway_peering_attachments resource, the following permissions are required: - -### Create -```json -ec2:CreateTransitGatewayPeeringAttachment, -ec2:DescribeTransitGatewayPeeringAttachments -``` - -### List -```json -ec2:DescribeTransitGatewayPeeringAttachments -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/transit_gateway_route_table/index.md b/docs/awscc-docs/providers/awscc/ec2/transit_gateway_route_table/index.md deleted file mode 100644 index 2fd0ee2294..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/transit_gateway_route_table/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: transit_gateway_route_table -hide_title: false -hide_table_of_contents: false -keywords: - - transit_gateway_route_table - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual transit_gateway_route_table resource - -## Overview - - - - - -
Nametransit_gateway_route_table
TypeResource
Descriptiontransit_gateway_route_table
Idawscc.ec2.transit_gateway_route_table
- -## Fields - - - - - - - -
NameDatatypeDescription
transit_gateway_route_table_idstringTransit Gateway Route Table primary identifier
transit_gateway_idstringThe ID of the transit gateway.
tagsarrayTags are composed of a Key/Value pair. You can use tags to categorize and track each parameter group. The tag value null is permitted.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -transit_gateway_route_table_id, -transit_gateway_id, -tags -FROM awscc.ec2.transit_gateway_route_table -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the transit_gateway_route_table resource, the following permissions are required: - -### Read -```json -ec2:DescribeTransitGatewayRouteTables -``` - -### Delete -```json -ec2:DeleteTransitGatewayRouteTable, -ec2:DescribeTransitGatewayRouteTables, -ec2:GetTransitGatewayRouteTableAssociations, -ec2:DisassociateTransitGatewayRouteTable -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/transit_gateway_route_tables/index.md b/docs/awscc-docs/providers/awscc/ec2/transit_gateway_route_tables/index.md deleted file mode 100644 index 2a8dd45b4d..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/transit_gateway_route_tables/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: transit_gateway_route_tables -hide_title: false -hide_table_of_contents: false -keywords: - - transit_gateway_route_tables - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of transit_gateway_route_tables in a region - -## Overview - - - - - -
Nametransit_gateway_route_tables
TypeResource
Descriptiontransit_gateway_route_tables
Idawscc.ec2.transit_gateway_route_tables
- -## Fields - - - - - -
NameDatatypeDescription
transit_gateway_route_table_idstringTransit Gateway Route Table primary identifier
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -transit_gateway_route_table_id -FROM awscc.ec2.transit_gateway_route_tables -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the transit_gateway_route_tables resource, the following permissions are required: - -### Create -```json -ec2:CreateTransitGatewayRouteTable, -ec2:CreateTags, -ec2:DescribeTransitGatewayRouteTables -``` - -### List -```json -ec2:DescribeTransitGatewayRouteTables -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/transit_gateway_vpc_attachment/index.md b/docs/awscc-docs/providers/awscc/ec2/transit_gateway_vpc_attachment/index.md deleted file mode 100644 index a558bdc89d..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/transit_gateway_vpc_attachment/index.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -title: transit_gateway_vpc_attachment -hide_title: false -hide_table_of_contents: false -keywords: - - transit_gateway_vpc_attachment - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual transit_gateway_vpc_attachment resource - -## Overview - - - - - -
Nametransit_gateway_vpc_attachment
TypeResource
Descriptiontransit_gateway_vpc_attachment
Idawscc.ec2.transit_gateway_vpc_attachment
- -## Fields - - - - - - - - - - - - -
NameDatatypeDescription
optionsobjectThe options for the transit gateway vpc attachment.
transit_gateway_idstring
vpc_idstring
remove_subnet_idsarray
idstring
subnet_idsarray
add_subnet_idsarray
tagsarray
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -options, -transit_gateway_id, -vpc_id, -remove_subnet_ids, -id, -subnet_ids, -add_subnet_ids, -tags -FROM awscc.ec2.transit_gateway_vpc_attachment -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the transit_gateway_vpc_attachment resource, the following permissions are required: - -### Read -```json -ec2:DescribeTransitGatewayAttachments, -ec2:DescribeTransitGatewayVpcAttachments, -ec2:CreateTransitGatewayVpcAttachment, -ec2:DeleteTransitGatewayVpcAttachment, -ec2:CreateTags, -ec2:DeleteTags, -ec2:DescribeTags, -ec2:DescribeTransitGatewayAttachments, -ec2:ModifyTransitGatewayVpcAttachment -``` - -### Update -```json -ec2:DescribeTransitGatewayAttachments, -ec2:DescribeTransitGatewayVpcAttachments, -ec2:DescribeTags, -ec2:CreateTransitGatewayVpcAttachment, -ec2:CreateTags, -ec2:DeleteTransitGatewayVpcAttachment, -ec2:DeleteTags, -ec2:ModifyTransitGatewayVpcAttachment -``` - -### Delete -```json -ec2:DescribeTransitGatewayAttachments, -ec2:DescribeTransitGatewayVpcAttachments, -ec2:CreateTransitGatewayVpcAttachment, -ec2:DeleteTransitGatewayVpcAttachment, -ec2:CreateTags, -ec2:DeleteTags, -ec2:DescribeTags, -ec2:DescribeTransitGatewayAttachments, -ec2:ModifyTransitGatewayVpcAttachment -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/transit_gateway_vpc_attachments/index.md b/docs/awscc-docs/providers/awscc/ec2/transit_gateway_vpc_attachments/index.md deleted file mode 100644 index a5aafcc021..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/transit_gateway_vpc_attachments/index.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: transit_gateway_vpc_attachments -hide_title: false -hide_table_of_contents: false -keywords: - - transit_gateway_vpc_attachments - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of transit_gateway_vpc_attachments in a region - -## Overview - - - - - -
Nametransit_gateway_vpc_attachments
TypeResource
Descriptiontransit_gateway_vpc_attachments
Idawscc.ec2.transit_gateway_vpc_attachments
- -## Fields - - - - - -
NameDatatypeDescription
idstring
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -id -FROM awscc.ec2.transit_gateway_vpc_attachments -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the transit_gateway_vpc_attachments resource, the following permissions are required: - -### Create -```json -ec2:DescribeTransitGatewayAttachments, -ec2:DescribeTransitGatewayVpcAttachments, -ec2:CreateTransitGatewayVpcAttachment, -ec2:DeleteTransitGatewayVpcAttachment, -ec2:CreateTags, -ec2:DeleteTags, -ec2:DescribeTags, -ec2:DescribeTransitGatewayAttachments, -ec2:ModifyTransitGatewayVpcAttachment -``` - -### List -```json -ec2:DescribeTransitGatewayAttachments, -ec2:DescribeTransitGatewayVpcAttachments, -ec2:DescribeTags, -ec2:CreateTransitGatewayVpcAttachment, -ec2:CreateTags, -ec2:DeleteTransitGatewayVpcAttachment, -ec2:DeleteTags, -ec2:ModifyTransitGatewayVpcAttachment -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/transit_gateways/index.md b/docs/awscc-docs/providers/awscc/ec2/transit_gateways/index.md deleted file mode 100644 index 5c3cf3311e..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/transit_gateways/index.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -title: transit_gateways -hide_title: false -hide_table_of_contents: false -keywords: - - transit_gateways - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of transit_gateways in a region - -## Overview - - - - - -
Nametransit_gateways
TypeResource
Descriptiontransit_gateways
Idawscc.ec2.transit_gateways
- -## Fields - - - - - -
NameDatatypeDescription
idstring
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -id -FROM awscc.ec2.transit_gateways -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the transit_gateways resource, the following permissions are required: - -### Create -```json -ec2:CreateTransitGateway, -ec2:CreateTags, -ec2:DescribeTransitGateways, -ec2:DescribeTags, -ec2:DeleteTransitGateway, -ec2:DeleteTags, -ec2:ModifyTransitGateway, -ec2:ModifyTransitGatewayOptions -``` - -### List -```json -ec2:CreateTransitGateway, -ec2:CreateTags, -ec2:DescribeTransitGateways, -ec2:DescribeTags, -ec2:DeleteTransitGateway, -ec2:DeleteTags, -ec2:ModifyTransitGateway, -ec2:ModifyTransitGatewayOptions -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/verified_access_endpoint/index.md b/docs/awscc-docs/providers/awscc/ec2/verified_access_endpoint/index.md deleted file mode 100644 index da2e70a5aa..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/verified_access_endpoint/index.md +++ /dev/null @@ -1,198 +0,0 @@ ---- -title: verified_access_endpoint -hide_title: false -hide_table_of_contents: false -keywords: - - verified_access_endpoint - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual verified_access_endpoint resource - -## Overview - - - - - -
Nameverified_access_endpoint
TypeResource
Descriptionverified_access_endpoint
Idawscc.ec2.verified_access_endpoint
- -## Fields - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
verified_access_endpoint_idstringThe ID of the AWS Verified Access endpoint.
verified_access_group_idstringThe ID of the AWS Verified Access group.
verified_access_instance_idstringThe ID of the AWS Verified Access instance.
statusstringThe endpoint status.
security_group_idsarrayThe IDs of the security groups for the endpoint.
network_interface_optionsobjectThe options for network-interface type endpoint.
load_balancer_optionsobjectThe load balancer details if creating the AWS Verified Access endpoint as load-balancer type.
endpoint_typestringThe type of AWS Verified Access endpoint. Incoming application requests will be sent to an IP address, load balancer or a network interface depending on the endpoint type specified.The type of AWS Verified Access endpoint. Incoming application requests will be sent to an IP address, load balancer or a network interface depending on the endpoint type specified.
endpoint_domainstringA DNS name that is generated for the endpoint.
endpoint_domain_prefixstringA custom identifier that gets prepended to a DNS name that is generated for the endpoint.
device_validation_domainstringReturned if endpoint has a device trust provider attached.
domain_certificate_arnstringThe ARN of a public TLS/SSL certificate imported into or created with ACM.
attachment_typestringThe type of attachment used to provide connectivity between the AWS Verified Access endpoint and the application.
application_domainstringThe DNS name for users to reach your application.
creation_timestringThe creation time.
last_updated_timestringThe last updated time.
descriptionstringA description for the AWS Verified Access endpoint.
policy_documentstringThe AWS Verified Access policy document.
policy_enabledbooleanThe status of the Verified Access policy.
tagsarrayAn array of key-value pairs to apply to this resource.
sse_specificationobjectThe configuration options for customer provided KMS encryption.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -verified_access_endpoint_id, -verified_access_group_id, -verified_access_instance_id, -status, -security_group_ids, -network_interface_options, -load_balancer_options, -endpoint_type, -endpoint_domain, -endpoint_domain_prefix, -device_validation_domain, -domain_certificate_arn, -attachment_type, -application_domain, -creation_time, -last_updated_time, -description, -policy_document, -policy_enabled, -tags, -sse_specification -FROM awscc.ec2.verified_access_endpoint -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the verified_access_endpoint resource, the following permissions are required: - -### Read -```json -ec2:DescribeVerifiedAccessEndpoints, -ec2:GetVerifiedAccessEndpointPolicy, -ec2:DescribeTags, -acm:CreateCertificateRelation, -acm:DeleteCertificateRelation, -acm:DescribeCertificate, -acm:GetCertificateWithPK, -ec2:CreateTags, -ec2:CreateVerifiedAccessEndpoint, -ec2:DeleteTags, -ec2:DeleteVerifiedAccessEndpoint, -ec2:DescribeAccountAttributes, -ec2:DescribeNetworkInterfaces, -ec2:DescribeSecurityGroups, -ec2:DescribeSubnets, -ec2:ModifyVerifiedAccessEndpoint, -ec2:ModifyVerifiedAccessEndpointPolicy, -elasticloadbalancing:DescribeListenerCertificates, -elasticloadbalancing:DescribeListeners, -elasticloadbalancing:DescribeLoadBalancers, -iam:CreateServiceLinkedRole, -iam:ListRoles, -sso:CreateManagedApplicationInstance, -sso:DeleteManagedApplicationInstance, -sso:GetManagedApplicationInstance, -sso:GetPeregrineStatus, -sso:GetSharedSsoConfiguration, -kms:DescribeKey, -kms:RetireGrant, -kms:CreateGrant, -kms:GenerateDataKey, -kms:Decrypt -``` - -### Update -```json -ec2:ModifyVerifiedAccessEndpoint, -ec2:ModifyVerifiedAccessEndpointPolicy, -ec2:DescribeVerifiedAccessEndpoints, -ec2:GetVerifiedAccessEndpointPolicy, -ec2:DescribeTags, -ec2:DeleteTags, -ec2:CreateTags, -acm:GetCertificateWithPK, -acm:DescribeCertificate, -acm:CreateCertificateRelation, -acm:DeleteCertificateRelation, -sso:GetManagedApplicationInstance, -sso:GetPeregrineStatus, -sso:GetSharedSsoConfiguration, -sso:CreateManagedApplicationInstance, -sso:DeleteManagedApplicationInstance, -ec2:DescribeSubnets, -ec2:DescribeSecurityGroups, -ec2:DescribeNetworkInterfaces, -ec2:DescribeAccountAttributes, -elasticloadbalancing:DescribeLoadBalancers, -elasticloadbalancing:DescribeListeners, -elasticloadbalancing:DescribeListenerCertificates, -ec2:CreateVerifiedAccessEndpoint, -ec2:DeleteVerifiedAccessEndpoint, -iam:CreateServiceLinkedRole, -iam:ListRoles, -kms:DescribeKey, -kms:RetireGrant, -kms:CreateGrant, -kms:GenerateDataKey, -kms:Decrypt -``` - -### Delete -```json -ec2:DescribeVerifiedAccessEndpoints, -ec2:DescribeTags, -ec2:DeleteVerifiedAccessEndpoint, -ec2:DeleteTags, -sso:DeleteManagedApplicationInstance, -acm:DeleteCertificateRelation, -acm:DescribeCertificate, -acm:CreateCertificateRelation, -acm:GetCertificateWithPK, -ec2:CreateTags, -ec2:CreateVerifiedAccessEndpoint, -ec2:DescribeAccountAttributes, -ec2:DescribeNetworkInterfaces, -ec2:DescribeSecurityGroups, -ec2:DescribeSubnets, -ec2:GetVerifiedAccessEndpointPolicy, -ec2:ModifyVerifiedAccessEndpoint, -ec2:ModifyVerifiedAccessEndpointPolicy, -elasticloadbalancing:DescribeListenerCertificates, -elasticloadbalancing:DescribeListeners, -elasticloadbalancing:DescribeLoadBalancers, -iam:CreateServiceLinkedRole, -iam:ListRoles, -sso:CreateManagedApplicationInstance, -sso:GetManagedApplicationInstance, -sso:GetPeregrineStatus, -sso:GetSharedSsoConfiguration, -kms:DescribeKey, -kms:RetireGrant, -kms:CreateGrant, -kms:GenerateDataKey, -kms:Decrypt -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/verified_access_endpoints/index.md b/docs/awscc-docs/providers/awscc/ec2/verified_access_endpoints/index.md deleted file mode 100644 index 8fa2b67d0c..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/verified_access_endpoints/index.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -title: verified_access_endpoints -hide_title: false -hide_table_of_contents: false -keywords: - - verified_access_endpoints - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of verified_access_endpoints in a region - -## Overview - - - - - -
Nameverified_access_endpoints
TypeResource
Descriptionverified_access_endpoints
Idawscc.ec2.verified_access_endpoints
- -## Fields - - - - - -
NameDatatypeDescription
verified_access_endpoint_idstringThe ID of the AWS Verified Access endpoint.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -verified_access_endpoint_id -FROM awscc.ec2.verified_access_endpoints -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the verified_access_endpoints resource, the following permissions are required: - -### Create -```json -ec2:CreateVerifiedAccessEndpoint, -ec2:DescribeVerifiedAccessEndpoints, -ec2:CreateTags, -ec2:DescribeTags, -iam:CreateServiceLinkedRole, -iam:ListRoles, -acm:GetCertificateWithPK, -acm:DescribeCertificate, -acm:CreateCertificateRelation, -sso:GetManagedApplicationInstance, -sso:GetPeregrineStatus, -sso:GetSharedSsoConfiguration, -sso:CreateManagedApplicationInstance, -ec2:DescribeSubnets, -ec2:DescribeSecurityGroups, -ec2:DescribeNetworkInterfaces, -ec2:DescribeAccountAttributes, -elasticloadbalancing:DescribeLoadBalancers, -elasticloadbalancing:DescribeListeners, -elasticloadbalancing:DescribeListenerCertificates, -acm:DeleteCertificateRelation, -ec2:DeleteTags, -ec2:DeleteVerifiedAccessEndpoint, -ec2:GetVerifiedAccessEndpointPolicy, -ec2:ModifyVerifiedAccessEndpoint, -ec2:ModifyVerifiedAccessEndpointPolicy, -sso:DeleteManagedApplicationInstance, -kms:DescribeKey, -kms:RetireGrant, -kms:CreateGrant, -kms:GenerateDataKey, -kms:Decrypt -``` - -### List -```json -ec2:DescribeVerifiedAccessEndpoints, -ec2:DescribeTags, -acm:CreateCertificateRelation, -acm:DeleteCertificateRelation, -acm:DescribeCertificate, -acm:GetCertificateWithPK, -ec2:CreateTags, -ec2:CreateVerifiedAccessEndpoint, -ec2:DeleteTags, -ec2:DeleteVerifiedAccessEndpoint, -ec2:DescribeAccountAttributes, -ec2:DescribeNetworkInterfaces, -ec2:DescribeSecurityGroups, -ec2:DescribeSubnets, -ec2:GetVerifiedAccessEndpointPolicy, -ec2:ModifyVerifiedAccessEndpoint, -ec2:ModifyVerifiedAccessEndpointPolicy, -elasticloadbalancing:DescribeListenerCertificates, -elasticloadbalancing:DescribeListeners, -elasticloadbalancing:DescribeLoadBalancers, -iam:CreateServiceLinkedRole, -iam:ListRoles, -sso:CreateManagedApplicationInstance, -sso:DeleteManagedApplicationInstance, -sso:GetManagedApplicationInstance, -sso:GetPeregrineStatus, -sso:GetSharedSsoConfiguration, -kms:DescribeKey, -kms:RetireGrant, -kms:CreateGrant, -kms:GenerateDataKey, -kms:Decrypt -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/verified_access_group/index.md b/docs/awscc-docs/providers/awscc/ec2/verified_access_group/index.md deleted file mode 100644 index 018eb9af86..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/verified_access_group/index.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -title: verified_access_group -hide_title: false -hide_table_of_contents: false -keywords: - - verified_access_group - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual verified_access_group resource - -## Overview - - - - - -
Nameverified_access_group
TypeResource
Descriptionverified_access_group
Idawscc.ec2.verified_access_group
- -## Fields - - - - - - - - - - - - - - - -
NameDatatypeDescription
verified_access_group_idstringThe ID of the AWS Verified Access group.
verified_access_instance_idstringThe ID of the AWS Verified Access instance.
verified_access_group_arnstringThe ARN of the Verified Access group.
ownerstringThe AWS account number that owns the group.
creation_timestringTime this Verified Access Group was created.
last_updated_timestringTime this Verified Access Group was last updated.
descriptionstringA description for the AWS Verified Access group.
policy_documentstringThe AWS Verified Access policy document.
policy_enabledbooleanThe status of the Verified Access policy.
tagsarrayAn array of key-value pairs to apply to this resource.
sse_specificationobjectThe configuration options for customer provided KMS encryption.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -verified_access_group_id, -verified_access_instance_id, -verified_access_group_arn, -owner, -creation_time, -last_updated_time, -description, -policy_document, -policy_enabled, -tags, -sse_specification -FROM awscc.ec2.verified_access_group -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the verified_access_group resource, the following permissions are required: - -### Read -```json -ec2:DescribeVerifiedAccessGroups, -ec2:GetVerifiedAccessGroupPolicy, -ec2:DescribeTags, -kms:DescribeKey, -kms:RetireGrant, -kms:CreateGrant, -kms:GenerateDataKey, -kms:Decrypt -``` - -### Update -```json -ec2:ModifyVerifiedAccessGroup, -ec2:ModifyVerifiedAccessGroupPolicy, -ec2:DescribeVerifiedAccessGroups, -ec2:GetVerifiedAccessGroupPolicy, -ec2:DescribeTags, -ec2:DeleteTags, -ec2:CreateTags, -kms:DescribeKey, -kms:RetireGrant, -kms:CreateGrant, -kms:GenerateDataKey, -kms:Decrypt -``` - -### Delete -```json -ec2:DeleteVerifiedAccessGroup, -ec2:DeleteTags, -ec2:DescribeVerifiedAccessGroups, -ec2:DescribeTags, -kms:DescribeKey, -kms:RetireGrant, -kms:CreateGrant, -kms:GenerateDataKey, -kms:Decrypt -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/verified_access_groups/index.md b/docs/awscc-docs/providers/awscc/ec2/verified_access_groups/index.md deleted file mode 100644 index c5c4d3faa5..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/verified_access_groups/index.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: verified_access_groups -hide_title: false -hide_table_of_contents: false -keywords: - - verified_access_groups - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of verified_access_groups in a region - -## Overview - - - - - -
Nameverified_access_groups
TypeResource
Descriptionverified_access_groups
Idawscc.ec2.verified_access_groups
- -## Fields - - - - - -
NameDatatypeDescription
verified_access_group_idstringThe ID of the AWS Verified Access group.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -verified_access_group_id -FROM awscc.ec2.verified_access_groups -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the verified_access_groups resource, the following permissions are required: - -### Create -```json -ec2:CreateVerifiedAccessGroup, -ec2:DescribeVerifiedAccessGroups, -ec2:GetVerifiedAccessGroupPolicy, -ec2:CreateTags, -ec2:DescribeTags, -kms:DescribeKey, -kms:RetireGrant, -kms:CreateGrant, -kms:GenerateDataKey, -kms:Decrypt -``` - -### List -```json -ec2:DescribeVerifiedAccessGroups, -ec2:DescribeTags, -kms:DescribeKey, -kms:RetireGrant, -kms:CreateGrant, -kms:GenerateDataKey, -kms:Decrypt -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/verified_access_instance/index.md b/docs/awscc-docs/providers/awscc/ec2/verified_access_instance/index.md deleted file mode 100644 index 0bbaff72c1..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/verified_access_instance/index.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -title: verified_access_instance -hide_title: false -hide_table_of_contents: false -keywords: - - verified_access_instance - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual verified_access_instance resource - -## Overview - - - - - -
Nameverified_access_instance
TypeResource
Descriptionverified_access_instance
Idawscc.ec2.verified_access_instance
- -## Fields - - - - - - - - - - - - - -
NameDatatypeDescription
verified_access_instance_idstringThe ID of the AWS Verified Access instance.
verified_access_trust_providersarrayAWS Verified Access trust providers.
verified_access_trust_provider_idsarrayThe IDs of the AWS Verified Access trust providers.
creation_timestringTime this Verified Access Instance was created.
last_updated_timestringTime this Verified Access Instance was last updated.
descriptionstringA description for the AWS Verified Access instance.
logging_configurationsobjectThe configuration options for AWS Verified Access instances.
tagsarrayAn array of key-value pairs to apply to this resource.
fips_enabledbooleanIndicates whether FIPS is enabled
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -verified_access_instance_id, -verified_access_trust_providers, -verified_access_trust_provider_ids, -creation_time, -last_updated_time, -description, -logging_configurations, -tags, -fips_enabled -FROM awscc.ec2.verified_access_instance -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the verified_access_instance resource, the following permissions are required: - -### Read -```json -ec2:DescribeVerifiedAccessInstances, -ec2:DescribeVerifiedAccessInstanceLoggingConfigurations, -ec2:DescribeTags, -logs:GetLogDelivery, -logs:ListLogDeliveries -``` - -### Update -```json -ec2:ModifyVerifiedAccessInstance, -ec2:ModifyVerifiedAccessInstanceLoggingConfiguration, -ec2:DescribeVerifiedAccessInstances, -ec2:DescribeVerifiedAccessInstanceLoggingConfigurations, -ec2:DescribeTags, -ec2:AttachVerifiedAccessTrustProvider, -ec2:DetachVerifiedAccessTrustProvider, -ec2:DeleteTags, -ec2:CreateTags, -ec2:DescribeTags, -logs:CreateLogDelivery, -logs:GetLogDelivery, -logs:ListLogDeliveries, -logs:UpdateLogDelivery, -logs:DeleteLogDelivery, -logs:PutDestination, -logs:PutLogEvents, -logs:DescribeLogStreams, -s3:listBuckets, -s3:PutObject, -s3:GetBucketPolicy, -s3:PutBucketPolicy, -logs:DescribeLogGroups, -logs:PutResourcePolicy, -firehose:TagDeliveryStream, -iam:CreateServiceLinkedRole, -logs:DescribeResourcePolicies -``` - -### Delete -```json -ec2:DeleteVerifiedAccessInstance, -ec2:DeleteTags, -ec2:DescribeVerifiedAccessInstances, -ec2:DescribeVerifiedAccessInstanceLoggingConfigurations, -ec2:DetachVerifiedAccessTrustProvider, -ec2:GetVerifiedAccessGroupPolicy, -ec2:DescribeTags, -logs:ListLogDeliveries, -logs:GetLogDelivery, -logs:DeleteLogDelivery -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/verified_access_instances/index.md b/docs/awscc-docs/providers/awscc/ec2/verified_access_instances/index.md deleted file mode 100644 index 93996049a8..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/verified_access_instances/index.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -title: verified_access_instances -hide_title: false -hide_table_of_contents: false -keywords: - - verified_access_instances - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of verified_access_instances in a region - -## Overview - - - - - -
Nameverified_access_instances
TypeResource
Descriptionverified_access_instances
Idawscc.ec2.verified_access_instances
- -## Fields - - - - - -
NameDatatypeDescription
verified_access_instance_idstringThe ID of the AWS Verified Access instance.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -verified_access_instance_id -FROM awscc.ec2.verified_access_instances -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the verified_access_instances resource, the following permissions are required: - -### Create -```json -ec2:CreateVerifiedAccessInstance, -ec2:AttachVerifiedAccessTrustProvider, -ec2:ModifyVerifiedAccessInstanceLoggingConfiguration, -ec2:DescribeVerifiedAccessInstances, -ec2:DescribeVerifiedAccessInstanceLoggingConfigurations, -ec2:CreateTags, -ec2:DescribeTags, -logs:CreateLogDelivery, -logs:GetLogDelivery, -logs:UpdateLogDelivery, -logs:PutDestination, -logs:DeleteLogDelivery, -logs:ListLogDeliveries, -logs:PutLogEvents, -logs:DescribeLogStreams, -s3:listBuckets, -s3:PutObject, -s3:GetBucketPolicy, -s3:PutBucketPolicy, -logs:DescribeLogGroups, -logs:PutResourcePolicy, -firehose:TagDeliveryStream, -logs:DescribeResourcePolicies, -iam:CreateServiceLinkedRole, -verified-access:AllowVerifiedAccess -``` - -### List -```json -ec2:DescribeVerifiedAccessInstances, -ec2:DescribeTags, -logs:ListLogDeliveries, -logs:GetLogDelivery -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/verified_access_trust_provider/index.md b/docs/awscc-docs/providers/awscc/ec2/verified_access_trust_provider/index.md deleted file mode 100644 index e915b45e43..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/verified_access_trust_provider/index.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -title: verified_access_trust_provider -hide_title: false -hide_table_of_contents: false -keywords: - - verified_access_trust_provider - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual verified_access_trust_provider resource - -## Overview - - - - - -
Nameverified_access_trust_provider
TypeResource
Descriptionverified_access_trust_provider
Idawscc.ec2.verified_access_trust_provider
- -## Fields - - - - - - - - - - - - - - - - -
NameDatatypeDescription
trust_provider_typestringType of trust provider. Possible values: user|device
device_trust_provider_typestringThe type of device-based trust provider. Possible values: jamf|crowdstrike
user_trust_provider_typestringThe type of device-based trust provider. Possible values: oidc|iam-identity-center
oidc_optionsobject
device_optionsobject
policy_reference_namestringThe identifier to be used when working with policy rules.
creation_timestringThe creation time.
last_updated_timestringThe last updated time.
verified_access_trust_provider_idstringThe ID of the Amazon Web Services Verified Access trust provider.
descriptionstringA description for the Amazon Web Services Verified Access trust provider.
tagsarrayAn array of key-value pairs to apply to this resource.
sse_specificationobjectThe configuration options for customer provided KMS encryption.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -trust_provider_type, -device_trust_provider_type, -user_trust_provider_type, -oidc_options, -device_options, -policy_reference_name, -creation_time, -last_updated_time, -verified_access_trust_provider_id, -description, -tags, -sse_specification -FROM awscc.ec2.verified_access_trust_provider -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the verified_access_trust_provider resource, the following permissions are required: - -### Read -```json -ec2:DescribeVerifiedAccessTrustProviders, -ec2:DescribeTags, -kms:DescribeKey, -kms:GenerateDataKey, -kms:Decrypt -``` - -### Update -```json -ec2:ModifyVerifiedAccessTrustProvider, -ec2:DescribeVerifiedAccessTrustProviders, -ec2:DescribeTags, -ec2:DeleteTags, -ec2:CreateTags, -kms:DescribeKey, -kms:RetireGrant, -kms:CreateGrant, -kms:GenerateDataKey, -kms:Decrypt -``` - -### Delete -```json -ec2:DeleteVerifiedAccessTrustProvider, -ec2:DeleteTags, -ec2:DescribeVerifiedAccessTrustProviders, -ec2:DescribeTags, -kms:DescribeKey, -kms:RetireGrant, -kms:CreateGrant, -kms:GenerateDataKey, -kms:Decrypt -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/verified_access_trust_providers/index.md b/docs/awscc-docs/providers/awscc/ec2/verified_access_trust_providers/index.md deleted file mode 100644 index e8bc12b392..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/verified_access_trust_providers/index.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -title: verified_access_trust_providers -hide_title: false -hide_table_of_contents: false -keywords: - - verified_access_trust_providers - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of verified_access_trust_providers in a region - -## Overview - - - - - -
Nameverified_access_trust_providers
TypeResource
Descriptionverified_access_trust_providers
Idawscc.ec2.verified_access_trust_providers
- -## Fields - - - - - -
NameDatatypeDescription
verified_access_trust_provider_idstringThe ID of the Amazon Web Services Verified Access trust provider.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -verified_access_trust_provider_id -FROM awscc.ec2.verified_access_trust_providers -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the verified_access_trust_providers resource, the following permissions are required: - -### Create -```json -ec2:CreateVerifiedAccessTrustProvider, -ec2:DescribeVerifiedAccessTrustProviders, -ec2:CreateTags, -ec2:DescribeTags, -sso:GetSharedSsoConfiguration, -kms:DescribeKey, -kms:RetireGrant, -kms:CreateGrant, -kms:GenerateDataKey, -kms:Decrypt -``` - -### List -```json -ec2:DescribeVerifiedAccessTrustProviders, -ec2:DescribeTags, -kms:DescribeKey, -kms:GenerateDataKey, -kms:Decrypt -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/volume/index.md b/docs/awscc-docs/providers/awscc/ec2/volume/index.md deleted file mode 100644 index fd4695a6ee..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/volume/index.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -title: volume -hide_title: false -hide_table_of_contents: false -keywords: - - volume - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual volume resource - -## Overview - - - - - -
Namevolume
TypeResource
Descriptionvolume
Idawscc.ec2.volume
- -## Fields - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
multi_attach_enabledbooleanIndicates whether Amazon EBS Multi-Attach is enabled.<br/> CFNlong does not currently support updating a single-attach volume to be multi-attach enabled, updating a multi-attach enabled volume to be single-attach, or updating the size or number of I/O operations per second (IOPS) of a multi-attach enabled volume.
kms_key_idstringThe identifier of the kms-key-long to use for Amazon EBS encryption. If ``KmsKeyId`` is specified, the encrypted state must be ``true``.<br/> If you omit this property and your account is enabled for encryption by default, or *Encrypted* is set to ``true``, then the volume is encrypted using the default key specified for your account. If your account does not have a default key, then the volume is encrypted using the aws-managed-key.<br/> Alternatively, if you want to specify a different key, you can specify one of the following:<br/> + Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.<br/> + Key alias. Specify the alias for the key, prefixed with ``alias/``. For example, for a key with the alias ``my_cmk``, use ``alias/my_cmk``. Or to specify the aws-managed-key, use ``alias/aws/ebs``.<br/> + Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.<br/> + Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
encryptedbooleanIndicates whether the volume should be encrypted. The effect of setting the encryption state to ``true`` depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see [Encryption by default](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default) in the *Amazon Elastic Compute Cloud User Guide*.<br/> Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see [Supported instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances).
sizeintegerThe size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.<br/> The following are the supported volumes sizes for each volume type:<br/> + ``gp2`` and ``gp3``: 1 - 16,384 GiB<br/> + ``io1``: 4 - 16,384 GiB<br/> + ``io2``: 4 - 65,536 GiB<br/> + ``st1`` and ``sc1``: 125 - 16,384 GiB<br/> + ``standard``: 1 - 1024 GiB
auto_enable_iobooleanIndicates whether the volume is auto-enabled for I/O operations. By default, Amazon EBS disables I/O to the volume from attached EC2 instances when it determines that a volume's data is potentially inconsistent. If the consistency of the volume is not a concern, and you prefer that the volume be made available immediately if it's impaired, you can configure the volume to automatically enable I/O.
outpost_arnstringThe Amazon Resource Name (ARN) of the Outpost.
availability_zonestringThe ID of the Availability Zone in which to create the volume. For example, ``us-east-1a``.
throughputintegerThe throughput to provision for a volume, with a maximum of 1,000 MiB/s.<br/> This parameter is valid only for ``gp3`` volumes. The default value is 125.<br/> Valid Range: Minimum value of 125. Maximum value of 1000.
iopsintegerThe number of I/O operations per second (IOPS). For ``gp3``, ``io1``, and ``io2`` volumes, this represents the number of IOPS that are provisioned for the volume. For ``gp2`` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.<br/> The following are the supported values for each volume type:<br/> + ``gp3``: 3,000 - 16,000 IOPS<br/> + ``io1``: 100 - 64,000 IOPS<br/> + ``io2``: 100 - 256,000 IOPS<br/> <br/> For ``io2`` volumes, you can achieve up to 256,000 IOPS on [instances built on the Nitro System](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances). On other instances, you can achieve performance up to 32,000 IOPS.<br/> This parameter is required for ``io1`` and ``io2`` volumes. The default for ``gp3`` volumes is 3,000 IOPS. This parameter is not supported for ``gp2``, ``st1``, ``sc1``, or ``standard`` volumes.
snapshot_idstringThe snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.
volume_typestringThe volume type. This parameter can be one of the following values:<br/> + General Purpose SSD: ``gp2`` | ``gp3`` <br/> + Provisioned IOPS SSD: ``io1`` | ``io2`` <br/> + Throughput Optimized HDD: ``st1`` <br/> + Cold HDD: ``sc1`` <br/> + Magnetic: ``standard`` <br/> <br/> For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the *Amazon Elastic Compute Cloud User Guide*.<br/> Default: ``gp2``
volume_idstring
tagsarrayThe tags to apply to the volume during creation.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -multi_attach_enabled, -kms_key_id, -encrypted, -size, -auto_enable_io, -outpost_arn, -availability_zone, -throughput, -iops, -snapshot_id, -volume_type, -volume_id, -tags -FROM awscc.ec2.volume -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the volume resource, the following permissions are required: - -### Read -```json -ec2:DescribeVolumes, -ec2:DescribeVolumeAttribute, -ec2:DescribeTags -``` - -### Update -```json -ec2:ModifyVolume, -ec2:ModifyVolumeAttribute, -ec2:DescribeVolumeAttribute, -ec2:DescribeVolumesModifications, -ec2:DescribeVolumes, -ec2:CreateTags, -ec2:DeleteTags -``` - -### Delete -```json -ec2:DeleteVolume, -ec2:CreateSnapshot, -ec2:DescribeSnapshots, -ec2:DeleteTags, -ec2:DescribeVolumes -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/volume_attachment/index.md b/docs/awscc-docs/providers/awscc/ec2/volume_attachment/index.md deleted file mode 100644 index cf5919cc81..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/volume_attachment/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: volume_attachment -hide_title: false -hide_table_of_contents: false -keywords: - - volume_attachment - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual volume_attachment resource - -## Overview - - - - - -
Namevolume_attachment
TypeResource
Descriptionvolume_attachment
Idawscc.ec2.volume_attachment
- -## Fields - - - - - - - -
NameDatatypeDescription
volume_idstringThe ID of the Amazon EBS volume. The volume and instance must be within the same Availability Zone. This value can be a reference to an [AWS::EC2::Volume](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html) resource, or it can be the volume ID of an existing Amazon EBS volume.
instance_idstringThe ID of the instance to which the volume attaches. This value can be a reference to an [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource, or it can be the physical ID of an existing EC2 instance.
devicestringThe device name (for example, ``/dev/sdh`` or ``xvdh``).
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -volume_id, -instance_id, -device -FROM awscc.ec2.volume_attachment -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the volume_attachment resource, the following permissions are required: - -### Read -```json -ec2:DescribeVolumes -``` - -### Delete -```json -ec2:DetachVolume, -ec2:DescribeVolumes -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/volume_attachments/index.md b/docs/awscc-docs/providers/awscc/ec2/volume_attachments/index.md deleted file mode 100644 index 7a34a50c89..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/volume_attachments/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: volume_attachments -hide_title: false -hide_table_of_contents: false -keywords: - - volume_attachments - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of volume_attachments in a region - -## Overview - - - - - -
Namevolume_attachments
TypeResource
Descriptionvolume_attachments
Idawscc.ec2.volume_attachments
- -## Fields - - - - - - -
NameDatatypeDescription
volume_idundefinedThe ID of the Amazon EBS volume. The volume and instance must be within the same Availability Zone. This value can be a reference to an [AWS::EC2::Volume](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html) resource, or it can be the volume ID of an existing Amazon EBS volume.
instance_idundefinedThe ID of the instance to which the volume attaches. This value can be a reference to an [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource, or it can be the physical ID of an existing EC2 instance.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -volume_id, -instance_id -FROM awscc.ec2.volume_attachments -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the volume_attachments resource, the following permissions are required: - -### Create -```json -ec2:AttachVolume, -ec2:DescribeVolumes -``` - -### List -```json -ec2:DescribeVolumes -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/volumes/index.md b/docs/awscc-docs/providers/awscc/ec2/volumes/index.md deleted file mode 100644 index dc3de08c41..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/volumes/index.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: volumes -hide_title: false -hide_table_of_contents: false -keywords: - - volumes - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of volumes in a region - -## Overview - - - - - -
Namevolumes
TypeResource
Descriptionvolumes
Idawscc.ec2.volumes
- -## Fields - - - - - -
NameDatatypeDescription
volume_idstring
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -volume_id -FROM awscc.ec2.volumes -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the volumes resource, the following permissions are required: - -### Create -```json -ec2:CreateVolume, -ec2:DescribeVolumes, -ec2:DescribeVolumeAttribute, -ec2:ModifyVolumeAttribute, -ec2:CreateTags, -kms:GenerateDataKeyWithoutPlaintext, -kms:CreateGrant -``` - -### List -```json -ec2:DescribeVolumes, -ec2:DescribeTags, -ec2:DescribeVolumeAttribute -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/vpc/index.md b/docs/awscc-docs/providers/awscc/ec2/vpc/index.md deleted file mode 100644 index 7db8361a4f..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/vpc/index.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -title: vpc -hide_title: false -hide_table_of_contents: false -keywords: - - vpc - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual vpc resource - -## Overview - - - - - -
Namevpc
TypeResource
Descriptionvpc
Idawscc.ec2.vpc
- -## Fields - - - - - - - - - - - - - - - - -
NameDatatypeDescription
vpc_idstring
cidr_blockstringThe IPv4 network range for the VPC, in CIDR notation. For example, ``10.0.0.0/16``. We modify the specified CIDR block to its canonical form; for example, if you specify ``100.68.0.18/18``, we modify it to ``100.68.0.0/18``.<br/> You must specify either``CidrBlock`` or ``Ipv4IpamPoolId``.
cidr_block_associationsarray
default_network_aclstring
default_security_groupstring
ipv6_cidr_blocksarray
enable_dns_hostnamesbooleanIndicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not. Disabled by default for nondefault VPCs. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support).<br/> You can only enable DNS hostnames if you've enabled DNS support.
enable_dns_supportbooleanIndicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range "plus two" succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled. Enabled by default. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support).
instance_tenancystringThe allowed tenancy of instances launched into the VPC.<br/> + ``default``: An instance launched into the VPC runs on shared hardware by default, unless you explicitly specify a different tenancy during instance launch.<br/> + ``dedicated``: An instance launched into the VPC runs on dedicated hardware by default, unless you explicitly specify a tenancy of ``host`` during instance launch. You cannot specify a tenancy of ``default`` during instance launch.<br/> <br/> Updating ``InstanceTenancy`` requires no replacement only if you are updating its value from ``dedicated`` to ``default``. Updating ``InstanceTenancy`` from ``default`` to ``dedicated`` requires replacement.
ipv4_ipam_pool_idstringThe ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. For more information, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*.<br/> You must specify either``CidrBlock`` or ``Ipv4IpamPoolId``.
ipv4_netmask_lengthintegerThe netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*.
tagsarrayThe tags for the VPC.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -vpc_id, -cidr_block, -cidr_block_associations, -default_network_acl, -default_security_group, -ipv6_cidr_blocks, -enable_dns_hostnames, -enable_dns_support, -instance_tenancy, -ipv4_ipam_pool_id, -ipv4_netmask_length, -tags -FROM awscc.ec2.vpc -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the vpc resource, the following permissions are required: - -### Read -```json -ec2:DescribeVpcs, -ec2:DescribeSecurityGroups, -ec2:DescribeNetworkAcls, -ec2:DescribeVpcAttribute -``` - -### Update -```json -ec2:CreateTags, -ec2:ModifyVpcAttribute, -ec2:DeleteTags, -ec2:ModifyVpcTenancy -``` - -### Delete -```json -ec2:DeleteVpc, -ec2:DescribeVpcs -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/vpc_endpoint/index.md b/docs/awscc-docs/providers/awscc/ec2/vpc_endpoint/index.md deleted file mode 100644 index 1153c7e303..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/vpc_endpoint/index.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -title: vpc_endpoint -hide_title: false -hide_table_of_contents: false -keywords: - - vpc_endpoint - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual vpc_endpoint resource - -## Overview - - - - - -
Namevpc_endpoint
TypeResource
Descriptionvpc_endpoint
Idawscc.ec2.vpc_endpoint
- -## Fields - - - - - - - - - - - - - - - - -
NameDatatypeDescription
idstring
creation_timestampstring
dns_entriesarray
network_interface_idsarray
policy_documentobjectAn endpoint policy, which controls access to the service from the VPC. The default endpoint policy allows full access to the service. Endpoint policies are supported only for gateway and interface endpoints.<br/> For CloudFormation templates in YAML, you can provide the policy in JSON or YAML format. CFNlong converts YAML policies to JSON format before calling the API to create or modify the VPC endpoint.
private_dns_enabledbooleanIndicate whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, ``kinesis.us-east-1.amazonaws.com``), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service.<br/> To use a private hosted zone, you must set the following VPC attributes to ``true``: ``enableDnsHostnames`` and ``enableDnsSupport``.<br/> This property is supported only for interface endpoints.<br/> Default: ``false``
route_table_idsarrayThe IDs of the route tables. Routing is supported only for gateway endpoints.
security_group_idsarrayThe IDs of the security groups to associate with the endpoint network interfaces. If this parameter is not specified, we use the default security group for the VPC. Security groups are supported only for interface endpoints.
service_namestringThe name of the endpoint service.
subnet_idsarrayThe IDs of the subnets in which to create endpoint network interfaces. You must specify this property for an interface endpoint or a Gateway Load Balancer endpoint. You can't specify this property for a gateway endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet.
vpc_endpoint_typestringThe type of endpoint.<br/> Default: Gateway
vpc_idstringThe ID of the VPC.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -id, -creation_timestamp, -dns_entries, -network_interface_ids, -policy_document, -private_dns_enabled, -route_table_ids, -security_group_ids, -service_name, -subnet_ids, -vpc_endpoint_type, -vpc_id -FROM awscc.ec2.vpc_endpoint -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the vpc_endpoint resource, the following permissions are required: - -### Read -```json -ec2:DescribeVpcEndpoints -``` - -### Update -```json -ec2:ModifyVpcEndpoint, -ec2:DescribeVpcEndpoints -``` - -### Delete -```json -ec2:DeleteVpcEndpoints, -ec2:DescribeVpcEndpoints -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/vpc_endpoint_connection_notification/index.md b/docs/awscc-docs/providers/awscc/ec2/vpc_endpoint_connection_notification/index.md deleted file mode 100644 index 81cf855411..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/vpc_endpoint_connection_notification/index.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -title: vpc_endpoint_connection_notification -hide_title: false -hide_table_of_contents: false -keywords: - - vpc_endpoint_connection_notification - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual vpc_endpoint_connection_notification resource - -## Overview - - - - - -
Namevpc_endpoint_connection_notification
TypeResource
Descriptionvpc_endpoint_connection_notification
Idawscc.ec2.vpc_endpoint_connection_notification
- -## Fields - - - - - - - - - -
NameDatatypeDescription
vpc_endpoint_connection_notification_idstringVPC Endpoint Connection ID generated by service
connection_eventsarrayThe endpoint events for which to receive notifications.
connection_notification_arnstringThe ARN of the SNS topic for the notifications.
service_idstringThe ID of the endpoint service.
vpc_endpoint_idstringThe ID of the endpoint.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -vpc_endpoint_connection_notification_id, -connection_events, -connection_notification_arn, -service_id, -vpc_endpoint_id -FROM awscc.ec2.vpc_endpoint_connection_notification -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the vpc_endpoint_connection_notification resource, the following permissions are required: - -### Read -```json -ec2:DescribeVpcEndpointConnectionNotifications -``` - -### Update -```json -ec2:ModifyVpcEndpointConnectionNotification, -ec2:DescribeVpcEndpointConnectionNotifications -``` - -### Delete -```json -ec2:DeleteVpcEndpointConnectionNotifications -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/vpc_endpoint_connection_notifications/index.md b/docs/awscc-docs/providers/awscc/ec2/vpc_endpoint_connection_notifications/index.md deleted file mode 100644 index 0dcea272f9..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/vpc_endpoint_connection_notifications/index.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: vpc_endpoint_connection_notifications -hide_title: false -hide_table_of_contents: false -keywords: - - vpc_endpoint_connection_notifications - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of vpc_endpoint_connection_notifications in a region - -## Overview - - - - - -
Namevpc_endpoint_connection_notifications
TypeResource
Descriptionvpc_endpoint_connection_notifications
Idawscc.ec2.vpc_endpoint_connection_notifications
- -## Fields - - - - - -
NameDatatypeDescription
vpc_endpoint_connection_notification_idstringVPC Endpoint Connection ID generated by service
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -vpc_endpoint_connection_notification_id -FROM awscc.ec2.vpc_endpoint_connection_notifications -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the vpc_endpoint_connection_notifications resource, the following permissions are required: - -### Create -```json -ec2:CreateVpcEndpointConnectionNotification -``` - -### List -```json -ec2:DescribeVpcEndpointConnectionNotifications -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/vpc_endpoint_service/index.md b/docs/awscc-docs/providers/awscc/ec2/vpc_endpoint_service/index.md deleted file mode 100644 index d6fe4916e0..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/vpc_endpoint_service/index.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -title: vpc_endpoint_service -hide_title: false -hide_table_of_contents: false -keywords: - - vpc_endpoint_service - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual vpc_endpoint_service resource - -## Overview - - - - - -
Namevpc_endpoint_service
TypeResource
Descriptionvpc_endpoint_service
Idawscc.ec2.vpc_endpoint_service
- -## Fields - - - - - - - - - - -
NameDatatypeDescription
network_load_balancer_arnsarray
contributor_insights_enabledboolean
payer_responsibilitystring
service_idstring
acceptance_requiredboolean
gateway_load_balancer_arnsarray
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -network_load_balancer_arns, -contributor_insights_enabled, -payer_responsibility, -service_id, -acceptance_required, -gateway_load_balancer_arns -FROM awscc.ec2.vpc_endpoint_service -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the vpc_endpoint_service resource, the following permissions are required: - -### Update -```json -ec2:ModifyVpcEndpointServiceConfiguration, -ec2:DeleteVpcEndpointServiceConfigurations, -ec2:DescribeVpcEndpointServiceConfigurations, -ec2:ModifyVpcEndpointServicePayerResponsibility, -cloudwatch:ListManagedInsightRules, -cloudwatch:DeleteInsightRules, -cloudwatch:PutManagedInsightRules -``` - -### Read -```json -ec2:DescribeVpcEndpointServiceConfigurations, -cloudwatch:ListManagedInsightRules -``` - -### Delete -```json -ec2:DeleteVpcEndpointServiceConfigurations, -ec2:DescribeVpcEndpointServiceConfigurations, -cloudwatch:ListManagedInsightRules, -cloudwatch:DeleteInsightRules -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/vpc_endpoint_service_permissions/index.md b/docs/awscc-docs/providers/awscc/ec2/vpc_endpoint_service_permissions/index.md deleted file mode 100644 index 2e1a558a2e..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/vpc_endpoint_service_permissions/index.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -title: vpc_endpoint_service_permissions -hide_title: false -hide_table_of_contents: false -keywords: - - vpc_endpoint_service_permissions - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual vpc_endpoint_service_permissions resource - -## Overview - - - - - -
Namevpc_endpoint_service_permissions
TypeResource
Descriptionvpc_endpoint_service_permissions
Idawscc.ec2.vpc_endpoint_service_permissions
- -## Fields - - - - - - -
NameDatatypeDescription
allowed_principalsarray
service_idstring
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -allowed_principals, -service_id -FROM awscc.ec2.vpc_endpoint_service_permissions -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the vpc_endpoint_service_permissions resource, the following permissions are required: - -### Update -```json -ec2:CreateVpcEndpointServicePermissions, -ec2:ModifyVpcEndpointServicePermissions, -ec2:DeleteVpcEndpointServicePermissions, -ec2:DescribeVpcEndpointServicePermissions -``` - -### Read -```json -ec2:CreateVpcEndpointServicePermissions, -ec2:ModifyVpcEndpointServicePermissions, -ec2:DeleteVpcEndpointServicePermissions, -ec2:DescribeVpcEndpointServicePermissions -``` - -### Delete -```json -ec2:CreateVpcEndpointServicePermissions, -ec2:ModifyVpcEndpointServicePermissions, -ec2:DeleteVpcEndpointServicePermissions, -ec2:DescribeVpcEndpointServicePermissions -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/vpc_endpoint_services/index.md b/docs/awscc-docs/providers/awscc/ec2/vpc_endpoint_services/index.md deleted file mode 100644 index 7ce74c91f6..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/vpc_endpoint_services/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: vpc_endpoint_services -hide_title: false -hide_table_of_contents: false -keywords: - - vpc_endpoint_services - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of vpc_endpoint_services in a region - -## Overview - - - - - -
Namevpc_endpoint_services
TypeResource
Descriptionvpc_endpoint_services
Idawscc.ec2.vpc_endpoint_services
- -## Fields - - - - - -
NameDatatypeDescription
service_idstring
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -service_id -FROM awscc.ec2.vpc_endpoint_services -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the vpc_endpoint_services resource, the following permissions are required: - -### Create -```json -ec2:CreateVpcEndpointServiceConfiguration, -ec2:ModifyVpcEndpointServiceConfiguration, -ec2:ModifyVpcEndpointServicePayerResponsibility, -cloudwatch:ListManagedInsightRules, -cloudwatch:DeleteInsightRules, -cloudwatch:PutManagedInsightRules, -ec2:DescribeVpcEndpointServiceConfigurations -``` - -### List -```json -ec2:DescribeVpcEndpointServiceConfigurations, -cloudwatch:ListManagedInsightRules -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/vpc_endpoints/index.md b/docs/awscc-docs/providers/awscc/ec2/vpc_endpoints/index.md deleted file mode 100644 index 48be5e072a..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/vpc_endpoints/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: vpc_endpoints -hide_title: false -hide_table_of_contents: false -keywords: - - vpc_endpoints - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of vpc_endpoints in a region - -## Overview - - - - - -
Namevpc_endpoints
TypeResource
Descriptionvpc_endpoints
Idawscc.ec2.vpc_endpoints
- -## Fields - - - - - -
NameDatatypeDescription
idstring
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -id -FROM awscc.ec2.vpc_endpoints -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the vpc_endpoints resource, the following permissions are required: - -### Create -```json -ec2:CreateVpcEndpoint, -ec2:DescribeVpcEndpoints -``` - -### List -```json -ec2:DescribeVpcEndpoints -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/vpc_gateway_attachment/index.md b/docs/awscc-docs/providers/awscc/ec2/vpc_gateway_attachment/index.md deleted file mode 100644 index 6ecede6f7b..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/vpc_gateway_attachment/index.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: vpc_gateway_attachment -hide_title: false -hide_table_of_contents: false -keywords: - - vpc_gateway_attachment - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual vpc_gateway_attachment resource - -## Overview - - - - - -
Namevpc_gateway_attachment
TypeResource
Descriptionvpc_gateway_attachment
Idawscc.ec2.vpc_gateway_attachment
- -## Fields - - - - - - - - -
NameDatatypeDescription
attachment_typestringUsed to identify if this resource is an Internet Gateway or Vpn Gateway Attachment
internet_gateway_idstringThe ID of the internet gateway. You must specify either InternetGatewayId or VpnGatewayId, but not both.
vpc_idstringThe ID of the VPC.
vpn_gateway_idstringThe ID of the virtual private gateway. You must specify either InternetGatewayId or VpnGatewayId, but not both.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -attachment_type, -internet_gateway_id, -vpc_id, -vpn_gateway_id -FROM awscc.ec2.vpc_gateway_attachment -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the vpc_gateway_attachment resource, the following permissions are required: - -### Read -```json -ec2:DescribeInternetGateways, -ec2:DescribeVpnGateways -``` - -### Update -```json -ec2:AttachInternetGateway, -ec2:AttachVpnGateway, -ec2:DetachInternetGateway, -ec2:DetachVpnGateway, -ec2:DescribeInternetGateways, -ec2:DescribeVpnGateways -``` - -### Delete -```json -ec2:DetachInternetGateway, -ec2:DetachVpnGateway, -ec2:DescribeInternetGateways, -ec2:DescribeVpnGateways -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/vpc_gateway_attachments/index.md b/docs/awscc-docs/providers/awscc/ec2/vpc_gateway_attachments/index.md deleted file mode 100644 index 1b6eb899e7..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/vpc_gateway_attachments/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: vpc_gateway_attachments -hide_title: false -hide_table_of_contents: false -keywords: - - vpc_gateway_attachments - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of vpc_gateway_attachments in a region - -## Overview - - - - - -
Namevpc_gateway_attachments
TypeResource
Descriptionvpc_gateway_attachments
Idawscc.ec2.vpc_gateway_attachments
- -## Fields - - - - - - -
NameDatatypeDescription
attachment_typestringUsed to identify if this resource is an Internet Gateway or Vpn Gateway Attachment
vpc_idstringThe ID of the VPC.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -attachment_type, -vpc_id -FROM awscc.ec2.vpc_gateway_attachments -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the vpc_gateway_attachments resource, the following permissions are required: - -### Create -```json -ec2:AttachInternetGateway, -ec2:AttachVpnGateway, -ec2:DescribeInternetGateways, -ec2:DescribeVpnGateways -``` - -### List -```json -ec2:DescribeInternetGateways, -ec2:DescribeVpnGateways -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/vpc_peering_connection/index.md b/docs/awscc-docs/providers/awscc/ec2/vpc_peering_connection/index.md deleted file mode 100644 index 5ccab3c294..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/vpc_peering_connection/index.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: vpc_peering_connection -hide_title: false -hide_table_of_contents: false -keywords: - - vpc_peering_connection - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual vpc_peering_connection resource - -## Overview - - - - - -
Namevpc_peering_connection
TypeResource
Descriptionvpc_peering_connection
Idawscc.ec2.vpc_peering_connection
- -## Fields - - - - - - - - - - - -
NameDatatypeDescription
idstring
peer_owner_idstringThe AWS account ID of the owner of the accepter VPC.
peer_regionstringThe Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request.
peer_role_arnstringThe Amazon Resource Name (ARN) of the VPC peer role for the peering connection in another AWS account.
peer_vpc_idstringThe ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request.
vpc_idstringThe ID of the VPC.
tagsarray
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -id, -peer_owner_id, -peer_region, -peer_role_arn, -peer_vpc_id, -vpc_id, -tags -FROM awscc.ec2.vpc_peering_connection -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the vpc_peering_connection resource, the following permissions are required: - -### Read -```json -ec2:DescribeVpcPeeringConnections -``` - -### Update -```json -ec2:CreateTags, -ec2:DeleteTags, -ec2:DescribeVpcPeeringConnections -``` - -### Delete -```json -ec2:DeleteVpcPeeringConnection, -ec2:DescribeVpcPeeringConnections -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/vpc_peering_connections/index.md b/docs/awscc-docs/providers/awscc/ec2/vpc_peering_connections/index.md deleted file mode 100644 index ff0d21bb55..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/vpc_peering_connections/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: vpc_peering_connections -hide_title: false -hide_table_of_contents: false -keywords: - - vpc_peering_connections - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of vpc_peering_connections in a region - -## Overview - - - - - -
Namevpc_peering_connections
TypeResource
Descriptionvpc_peering_connections
Idawscc.ec2.vpc_peering_connections
- -## Fields - - - - - -
NameDatatypeDescription
idstring
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -id -FROM awscc.ec2.vpc_peering_connections -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the vpc_peering_connections resource, the following permissions are required: - -### Create -```json -ec2:CreateVpcPeeringConnection, -ec2:DescribeVpcPeeringConnections, -ec2:AcceptVpcPeeringConnection, -ec2:CreateTags, -sts:AssumeRole -``` - -### List -```json -ec2:DescribeVpcPeeringConnections -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/vpcdhcp_options_association/index.md b/docs/awscc-docs/providers/awscc/ec2/vpcdhcp_options_association/index.md deleted file mode 100644 index 00889e8bff..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/vpcdhcp_options_association/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: vpcdhcp_options_association -hide_title: false -hide_table_of_contents: false -keywords: - - vpcdhcp_options_association - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual vpcdhcp_options_association resource - -## Overview - - - - - -
Namevpcdhcp_options_association
TypeResource
Descriptionvpcdhcp_options_association
Idawscc.ec2.vpcdhcp_options_association
- -## Fields - - - - - - -
NameDatatypeDescription
dhcp_options_idstringThe ID of the DHCP options set, or default to associate no DHCP options with the VPC.
vpc_idstringThe ID of the VPC.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -dhcp_options_id, -vpc_id -FROM awscc.ec2.vpcdhcp_options_association -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the vpcdhcp_options_association resource, the following permissions are required: - -### Update -```json -ec2:AssociateDhcpOptions -``` - -### Delete -```json -ec2:AssociateDhcpOptions -``` - -### Read -```json -ec2:DescribeVpcs -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/vpcdhcp_options_associations/index.md b/docs/awscc-docs/providers/awscc/ec2/vpcdhcp_options_associations/index.md deleted file mode 100644 index 22c34ed637..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/vpcdhcp_options_associations/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: vpcdhcp_options_associations -hide_title: false -hide_table_of_contents: false -keywords: - - vpcdhcp_options_associations - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of vpcdhcp_options_associations in a region - -## Overview - - - - - -
Namevpcdhcp_options_associations
TypeResource
Descriptionvpcdhcp_options_associations
Idawscc.ec2.vpcdhcp_options_associations
- -## Fields - - - - - - -
NameDatatypeDescription
dhcp_options_idstringThe ID of the DHCP options set, or default to associate no DHCP options with the VPC.
vpc_idstringThe ID of the VPC.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -dhcp_options_id, -vpc_id -FROM awscc.ec2.vpcdhcp_options_associations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the vpcdhcp_options_associations resource, the following permissions are required: - -### Create -```json -ec2:AssociateDhcpOptions -``` - -### List -```json -ec2:DescribeVpcs -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/vpcs/index.md b/docs/awscc-docs/providers/awscc/ec2/vpcs/index.md deleted file mode 100644 index 0845dc7b3a..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/vpcs/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: vpcs -hide_title: false -hide_table_of_contents: false -keywords: - - vpcs - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of vpcs in a region - -## Overview - - - - - -
Namevpcs
TypeResource
Descriptionvpcs
Idawscc.ec2.vpcs
- -## Fields - - - - - -
NameDatatypeDescription
vpc_idstring
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -vpc_id -FROM awscc.ec2.vpcs -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the vpcs resource, the following permissions are required: - -### Create -```json -ec2:CreateVpc, -ec2:DescribeVpcs, -ec2:ModifyVpcAttribute, -ec2:CreateTags -``` - -### List -```json -ec2:DescribeVpcs -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/vpn_connection/index.md b/docs/awscc-docs/providers/awscc/ec2/vpn_connection/index.md deleted file mode 100644 index ea319aaead..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/vpn_connection/index.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -title: vpn_connection -hide_title: false -hide_table_of_contents: false -keywords: - - vpn_connection - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual vpn_connection resource - -## Overview - - - - - -
Namevpn_connection
TypeResource
Descriptionvpn_connection
Idawscc.ec2.vpn_connection
- -## Fields - - - - - - - - - - - - -
NameDatatypeDescription
vpn_connection_idstringThe provider-assigned unique ID for this managed resource
customer_gateway_idstringThe ID of the customer gateway at your end of the VPN connection.
static_routes_onlybooleanIndicates whether the VPN connection uses static routes only.
tagsarrayAny tags assigned to the VPN connection.
transit_gateway_idstringThe ID of the transit gateway associated with the VPN connection.
typestringThe type of VPN connection.
vpn_gateway_idstringThe ID of the virtual private gateway at the AWS side of the VPN connection.
vpn_tunnel_options_specificationsarrayThe tunnel options for the VPN connection.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -vpn_connection_id, -customer_gateway_id, -static_routes_only, -tags, -transit_gateway_id, -type, -vpn_gateway_id, -vpn_tunnel_options_specifications -FROM awscc.ec2.vpn_connection -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the vpn_connection resource, the following permissions are required: - -### Delete -```json -ec2:DescribeVpnConnections, -ec2:DeleteVpnConnection, -ec2:DeleteTags -``` - -### Update -```json -ec2:DescribeVpnConnections, -ec2:CreateTags, -ec2:DeleteTags -``` - -### Read -```json -ec2:DescribeVpnConnections -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/vpn_connection_route/index.md b/docs/awscc-docs/providers/awscc/ec2/vpn_connection_route/index.md deleted file mode 100644 index d007568547..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/vpn_connection_route/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: vpn_connection_route -hide_title: false -hide_table_of_contents: false -keywords: - - vpn_connection_route - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual vpn_connection_route resource - -## Overview - - - - - -
Namevpn_connection_route
TypeResource
Descriptionvpn_connection_route
Idawscc.ec2.vpn_connection_route
- -## Fields - - - - - - -
NameDatatypeDescription
destination_cidr_blockstringThe CIDR block associated with the local subnet of the customer network.
vpn_connection_idstringThe ID of the VPN connection.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -destination_cidr_block, -vpn_connection_id -FROM awscc.ec2.vpn_connection_route -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the vpn_connection_route resource, the following permissions are required: - -### Read -```json -ec2:DescribeVpnConnections -``` - -### Delete -```json -ec2:DeleteVpnConnectionRoute, -ec2:DescribeVpnConnections -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/vpn_connection_routes/index.md b/docs/awscc-docs/providers/awscc/ec2/vpn_connection_routes/index.md deleted file mode 100644 index ece2bfaa8b..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/vpn_connection_routes/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: vpn_connection_routes -hide_title: false -hide_table_of_contents: false -keywords: - - vpn_connection_routes - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of vpn_connection_routes in a region - -## Overview - - - - - -
Namevpn_connection_routes
TypeResource
Descriptionvpn_connection_routes
Idawscc.ec2.vpn_connection_routes
- -## Fields - - - - - - -
NameDatatypeDescription
destination_cidr_blockstringThe CIDR block associated with the local subnet of the customer network.
vpn_connection_idstringThe ID of the VPN connection.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -destination_cidr_block, -vpn_connection_id -FROM awscc.ec2.vpn_connection_routes -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the vpn_connection_routes resource, the following permissions are required: - -### Create -```json -ec2:CreateVpnConnectionRoute, -ec2:DescribeVpnConnections -``` - -### List -```json -ec2:DescribeVpnConnections -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/vpn_connections/index.md b/docs/awscc-docs/providers/awscc/ec2/vpn_connections/index.md deleted file mode 100644 index 301e1d2c51..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/vpn_connections/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: vpn_connections -hide_title: false -hide_table_of_contents: false -keywords: - - vpn_connections - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of vpn_connections in a region - -## Overview - - - - - -
Namevpn_connections
TypeResource
Descriptionvpn_connections
Idawscc.ec2.vpn_connections
- -## Fields - - - - - -
NameDatatypeDescription
vpn_connection_idstringThe provider-assigned unique ID for this managed resource
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -vpn_connection_id -FROM awscc.ec2.vpn_connections -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the vpn_connections resource, the following permissions are required: - -### Create -```json -ec2:DescribeVpnConnections, -ec2:CreateVpnConnection, -ec2:CreateTags -``` - -### List -```json -ec2:DescribeVpnConnections -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/vpn_gateway/index.md b/docs/awscc-docs/providers/awscc/ec2/vpn_gateway/index.md deleted file mode 100644 index b511b36d8b..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/vpn_gateway/index.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -title: vpn_gateway -hide_title: false -hide_table_of_contents: false -keywords: - - vpn_gateway - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Gets an individual vpn_gateway resource - -## Overview - - - - - -
Namevpn_gateway
TypeResource
Descriptionvpn_gateway
Idawscc.ec2.vpn_gateway
- -## Fields - - - - - - - - -
NameDatatypeDescription
v_pn_gateway_idstringVPN Gateway ID generated by service
amazon_side_asnintegerThe private Autonomous System Number (ASN) for the Amazon side of a BGP session.
tagsarrayAny tags assigned to the virtual private gateway.
typestringThe type of VPN connection the virtual private gateway supports.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -v_pn_gateway_id, -amazon_side_asn, -tags, -type -FROM awscc.ec2.vpn_gateway -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the vpn_gateway resource, the following permissions are required: - -### Read -```json -ec2:DescribeVpnGateways -``` - -### Update -```json -ec2:CreateTags, -ec2:DeleteTags -``` - -### Delete -```json -ec2:DeleteVpnGateway -``` - diff --git a/docs/awscc-docs/providers/awscc/ec2/vpn_gateways/index.md b/docs/awscc-docs/providers/awscc/ec2/vpn_gateways/index.md deleted file mode 100644 index a7f321ac07..0000000000 --- a/docs/awscc-docs/providers/awscc/ec2/vpn_gateways/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: vpn_gateways -hide_title: false -hide_table_of_contents: false -keywords: - - vpn_gateways - - ec2 - - aws - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage AWS resources using SQL -custom_edit_url: null -image: /img/providers/aws/stackql-aws-provider-featured-image.png ---- -Retrieves a list of vpn_gateways in a region - -## Overview - - - - - -
Namevpn_gateways
TypeResource
Descriptionvpn_gateways
Idawscc.ec2.vpn_gateways
- -## Fields - - - - - -
NameDatatypeDescription
v_pn_gateway_idstringVPN Gateway ID generated by service
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -v_pn_gateway_id -FROM awscc.ec2.vpn_gateways -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the vpn_gateways resource, the following permissions are required: - -### Create -```json -ec2:CreateVpnGateway, -ec2:DescribeVpnGateways -``` - -### List -```json -ec2:DescribeVpnGateways -``` - diff --git a/docs/awscc-docs/providers/awscc/ecr/index.md b/docs/awscc-docs/providers/awscc/ecr/index.md deleted file mode 100644 index 226bdf3202..0000000000 --- a/docs/awscc-docs/providers/awscc/ecr/index.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -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 deleted file mode 100644 index 69261fdce2..0000000000 --- a/docs/awscc-docs/providers/awscc/ecr/public_repositories/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -repository_name -FROM awscc.ecr.public_repositories -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the public_repositories resource, the following permissions are required: - -### Create -```json -ecr-public:CreateRepository, -ecr-public:SetRepositoryPolicy, -ecr-public:PutRepositoryCatalogData, -ecr-public:TagResource -``` - -### List -```json -ecr-public:DescribeRepositories -``` - diff --git a/docs/awscc-docs/providers/awscc/ecr/public_repository/index.md b/docs/awscc-docs/providers/awscc/ecr/public_repository/index.md deleted file mode 100644 index bb571a908a..0000000000 --- a/docs/awscc-docs/providers/awscc/ecr/public_repository/index.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -repository_name, -repository_policy_text, -arn, -repository_catalog_data, -tags -FROM awscc.ecr.public_repository -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the public_repository resource, the following permissions are required: - -### Read -```json -ecr-public:DescribeRepositories, -ecr-public:GetRepositoryPolicy, -ecr-public:GetRepositoryCatalogData, -ecr-public:ListTagsForResource -``` - -### Update -```json -ecr-public:SetRepositoryPolicy, -ecr-public:DeleteRepositoryPolicy, -ecr-public:PutRepositoryCatalogData, -ecr-public:TagResource, -ecr-public:UntagResource -``` - -### Delete -```json -ecr-public:DeleteRepository -``` - 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 deleted file mode 100644 index d4174c8bfd..0000000000 --- a/docs/awscc-docs/providers/awscc/ecr/pull_through_cache_rule/index.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -ecr_repository_prefix, -upstream_registry_url, -credential_arn, -upstream_registry -FROM awscc.ecr.pull_through_cache_rule -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the pull_through_cache_rule resource, the following permissions are required: - -### Read -```json -ecr:DescribePullThroughCacheRules -``` - -### Update -```json -ecr:DescribePullThroughCacheRules, -ecr:CreatePullThroughCacheRule, -ecr:DeletePullThroughCacheRule, -iam:CreateServiceLinkedRole, -secretsmanager:GetSecretValue -``` - -### Delete -```json -ecr:DescribePullThroughCacheRules, -ecr:DeletePullThroughCacheRule -``` - 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 deleted file mode 100644 index e7360a161a..0000000000 --- a/docs/awscc-docs/providers/awscc/ecr/pull_through_cache_rules/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -ecr_repository_prefix -FROM awscc.ecr.pull_through_cache_rules -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the pull_through_cache_rules resource, the following permissions are required: - -### Create -```json -ecr:DescribePullThroughCacheRules, -ecr:CreatePullThroughCacheRule, -ecr:DeletePullThroughCacheRule, -iam:CreateServiceLinkedRole, -secretsmanager:GetSecretValue -``` - -### List -```json -ecr:DescribePullThroughCacheRules -``` - diff --git a/docs/awscc-docs/providers/awscc/ecr/registry_policies/index.md b/docs/awscc-docs/providers/awscc/ecr/registry_policies/index.md deleted file mode 100644 index d22b492f50..0000000000 --- a/docs/awscc-docs/providers/awscc/ecr/registry_policies/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -registry_id -FROM awscc.ecr.registry_policies -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the registry_policies resource, the following permissions are required: - -### Create -```json -ecr:GetRegistryPolicy, -ecr:PutRegistryPolicy -``` - -### List -```json -ecr:GetRegistryPolicy -``` - diff --git a/docs/awscc-docs/providers/awscc/ecr/registry_policy/index.md b/docs/awscc-docs/providers/awscc/ecr/registry_policy/index.md deleted file mode 100644 index 1f300000a7..0000000000 --- a/docs/awscc-docs/providers/awscc/ecr/registry_policy/index.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -registry_id, -policy_text -FROM awscc.ecr.registry_policy -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the registry_policy resource, the following permissions are required: - -### Read -```json -ecr:GetRegistryPolicy -``` - -### Update -```json -ecr:GetRegistryPolicy, -ecr:PutRegistryPolicy -``` - -### Delete -```json -ecr:DeleteRegistryPolicy -``` - diff --git a/docs/awscc-docs/providers/awscc/ecr/replication_configuration/index.md b/docs/awscc-docs/providers/awscc/ecr/replication_configuration/index.md deleted file mode 100644 index c47f27f9c3..0000000000 --- a/docs/awscc-docs/providers/awscc/ecr/replication_configuration/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -replication_configuration, -registry_id -FROM awscc.ecr.replication_configuration -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the replication_configuration resource, the following permissions are required: - -### Read -```json -ecr:DescribeRegistry -``` - -### Update -```json -ecr:DescribeRegistry, -ecr:PutReplicationConfiguration, -iam:CreateServiceLinkedRole -``` - -### Delete -```json -ecr:DescribeRegistry, -ecr:PutReplicationConfiguration, -iam:CreateServiceLinkedRole -``` - diff --git a/docs/awscc-docs/providers/awscc/ecr/replication_configurations/index.md b/docs/awscc-docs/providers/awscc/ecr/replication_configurations/index.md deleted file mode 100644 index 22dd277f86..0000000000 --- a/docs/awscc-docs/providers/awscc/ecr/replication_configurations/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -registry_id -FROM awscc.ecr.replication_configurations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the replication_configurations resource, the following permissions are required: - -### Create -```json -ecr:DescribeRegistry, -ecr:PutReplicationConfiguration, -iam:CreateServiceLinkedRole -``` - -### List -```json -ecr:DescribeRegistry -``` - diff --git a/docs/awscc-docs/providers/awscc/ecr/repositories/index.md b/docs/awscc-docs/providers/awscc/ecr/repositories/index.md deleted file mode 100644 index e164c8bc33..0000000000 --- a/docs/awscc-docs/providers/awscc/ecr/repositories/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -repository_name -FROM awscc.ecr.repositories -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the repositories resource, the following permissions are required: - -### Create -```json -ecr:CreateRepository, -ecr:PutLifecyclePolicy, -ecr:SetRepositoryPolicy, -ecr:TagResource, -kms:DescribeKey, -kms:CreateGrant, -kms:RetireGrant -``` - -### List -```json -ecr:DescribeRepositories -``` - diff --git a/docs/awscc-docs/providers/awscc/ecr/repository/index.md b/docs/awscc-docs/providers/awscc/ecr/repository/index.md deleted file mode 100644 index 13072e9d30..0000000000 --- a/docs/awscc-docs/providers/awscc/ecr/repository/index.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the repository resource, the following permissions are required: - -### Read -```json -ecr:DescribeRepositories, -ecr:GetLifecyclePolicy, -ecr:GetRepositoryPolicy, -ecr:ListTagsForResource -``` - -### Update -```json -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 -```json -ecr:DeleteRepository, -kms:RetireGrant -``` - 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 deleted file mode 100644 index 0a3f36bba3..0000000000 --- a/docs/awscc-docs/providers/awscc/ecs/cluster_capacity_provider_associations/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -capacity_providers, -cluster, -default_capacity_provider_strategy -FROM awscc.ecs.cluster_capacity_provider_associations -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the cluster_capacity_provider_associations resource, the following permissions are required: - -### Read -```json -ecs:DescribeClusters -``` - -### Update -```json -ecs:DescribeClusters, -ecs:PutClusterCapacityProviders -``` - -### Delete -```json -ecs:PutClusterCapacityProviders, -ecs:DescribeClusters -``` - diff --git a/docs/awscc-docs/providers/awscc/ecs/index.md b/docs/awscc-docs/providers/awscc/ecs/index.md deleted file mode 100644 index d0b20bc6e4..0000000000 --- a/docs/awscc-docs/providers/awscc/ecs/index.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -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: 7
-total selectable resources: 7
-total methods: 7
-
-
- -::: - -## Resources -
-
-cluster_capacity_provider_associations
-primary_task_set
-service
-services -
-
-task_definition
-task_definitions
-task_set -
-
\ 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 deleted file mode 100644 index 599c73c228..0000000000 --- a/docs/awscc-docs/providers/awscc/ecs/primary_task_set/index.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -cluster, -task_set_id, -service -FROM awscc.ecs.primary_task_set -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the primary_task_set resource, the following permissions are required: - -### Update -```json -ecs:DescribeTaskSets, -ecs:UpdateServicePrimaryTaskSet -``` - diff --git a/docs/awscc-docs/providers/awscc/ecs/service/index.md b/docs/awscc-docs/providers/awscc/ecs/service/index.md deleted file mode 100644 index 0bc4346e4f..0000000000 --- a/docs/awscc-docs/providers/awscc/ecs/service/index.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -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_ecs_managed_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. - -## Example -```sql -SELECT -region, -service_arn, -capacity_provider_strategy, -cluster, -deployment_configuration, -deployment_controller, -desired_count, -enable_ecs_managed_tags, -enable_execute_command, -health_check_grace_period_seconds, -launch_type, -load_balancers, -name, -network_configuration, -placement_constraints, -placement_strategies, -platform_version, -propagate_tags, -role, -scheduling_strategy, -service_connect_configuration, -service_name, -service_registries, -tags, -task_definition, -volume_configurations -FROM awscc.ecs.service -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the service resource, the following permissions are required: - -### Read -```json -ecs:DescribeServices -``` - -### Update -```json -ecs:DescribeServices, -ecs:ListTagsForResource, -ecs:TagResource, -ecs:UntagResource, -ecs:UpdateService -``` - -### Delete -```json -ecs:DeleteService, -ecs:DescribeServices -``` - diff --git a/docs/awscc-docs/providers/awscc/ecs/services/index.md b/docs/awscc-docs/providers/awscc/ecs/services/index.md deleted file mode 100644 index 2453521aa7..0000000000 --- a/docs/awscc-docs/providers/awscc/ecs/services/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -service_arn, -cluster -FROM awscc.ecs.services -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the services resource, the following permissions are required: - -### Create -```json -ecs:CreateService, -ecs:DescribeServices, -iam:PassRole, -ecs:TagResource -``` - -### List -```json -ecs:DescribeServices, -ecs:ListClusters, -ecs:ListServices -``` - diff --git a/docs/awscc-docs/providers/awscc/ecs/task_definition/index.md b/docs/awscc-docs/providers/awscc/ecs/task_definition/index.md deleted file mode 100644 index 57ac035ba2..0000000000 --- a/docs/awscc-docs/providers/awscc/ecs/task_definition/index.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the task_definition resource, the following permissions are required: - -### Read -```json -ecs:DescribeTaskDefinition -``` - -### Update -```json -ecs:TagResource, -ecs:UntagResource, -ecs:ListTagsForResource, -ecs:DescribeTaskDefinition, -iam:GetRole, -iam:PassRole -``` - -### Delete -```json -ecs:DeregisterTaskDefinition, -ecs:DescribeTaskDefinition, -iam:GetRole, -iam:PassRole -``` - diff --git a/docs/awscc-docs/providers/awscc/ecs/task_definitions/index.md b/docs/awscc-docs/providers/awscc/ecs/task_definitions/index.md deleted file mode 100644 index 960b5ca4b3..0000000000 --- a/docs/awscc-docs/providers/awscc/ecs/task_definitions/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -task_definition_arn -FROM awscc.ecs.task_definitions -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the task_definitions resource, the following permissions are required: - -### Create -```json -ecs:RegisterTaskDefinition, -ecs:DescribeTaskDefinition, -ecs:TagResource, -iam:GetRole, -iam:PassRole -``` - -### List -```json -ecs:ListTaskDefinitions, -ecs:DescribeTaskDefinition -``` - diff --git a/docs/awscc-docs/providers/awscc/ecs/task_set/index.md b/docs/awscc-docs/providers/awscc/ecs/task_set/index.md deleted file mode 100644 index a11bdb9411..0000000000 --- a/docs/awscc-docs/providers/awscc/ecs/task_set/index.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -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. - -## 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 data__Identifier = '||'; -``` - -## Permissions - -To operate on the task_set resource, the following permissions are required: - -### Read -```json -ecs:DescribeTaskSets -``` - -### Update -```json -ecs:DescribeTaskSets, -ecs:TagResource, -ecs:UntagResource, -ecs:UpdateTaskSet -``` - -### Delete -```json -ecs:DeleteTaskSet, -ecs:DescribeTaskSets -``` - diff --git a/docs/awscc-docs/providers/awscc/efs/access_point/index.md b/docs/awscc-docs/providers/awscc/efs/access_point/index.md deleted file mode 100644 index 920691cbd0..0000000000 --- a/docs/awscc-docs/providers/awscc/efs/access_point/index.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the access_point resource, the following permissions are required: - -### Read -```json -elasticfilesystem:DescribeAccessPoints -``` - -### Delete -```json -elasticfilesystem:DeleteAccessPoint, -elasticfilesystem:DescribeAccessPoints -``` - -### Update -```json -elasticfilesystem:DescribeAccessPoints, -elasticfilesystem:ListTagsForResource, -elasticfilesystem:TagResource, -elasticfilesystem:UntagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/efs/access_points/index.md b/docs/awscc-docs/providers/awscc/efs/access_points/index.md deleted file mode 100644 index 3deffa12aa..0000000000 --- a/docs/awscc-docs/providers/awscc/efs/access_points/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -access_point_id -FROM awscc.efs.access_points -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the access_points resource, the following permissions are required: - -### Create -```json -elasticfilesystem:CreateAccessPoint, -elasticfilesystem:TagResource, -elasticfilesystem:DescribeAccessPoints -``` - -### List -```json -elasticfilesystem:DescribeAccessPoints -``` - diff --git a/docs/awscc-docs/providers/awscc/efs/file_system/index.md b/docs/awscc-docs/providers/awscc/efs/file_system/index.md deleted file mode 100644 index 07898b95ae..0000000000 --- a/docs/awscc-docs/providers/awscc/efs/file_system/index.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the file_system resource, the following permissions are required: - -### Read -```json -elasticfilesystem:DescribeBackupPolicy, -elasticfilesystem:DescribeFileSystemPolicy, -elasticfilesystem:DescribeFileSystems, -elasticfilesystem:DescribeLifecycleConfiguration, -elasticfilesystem:DescribeReplicationConfigurations -``` - -### Update -```json -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 -```json -elasticfilesystem:DescribeFileSystems, -elasticfilesystem:DeleteFileSystem, -elasticfilesystem:DeleteReplicationConfiguration, -elasticfilesystem:DescribeReplicationConfigurations -``` - diff --git a/docs/awscc-docs/providers/awscc/efs/file_systems/index.md b/docs/awscc-docs/providers/awscc/efs/file_systems/index.md deleted file mode 100644 index 0686c8d906..0000000000 --- a/docs/awscc-docs/providers/awscc/efs/file_systems/index.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -file_system_id -FROM awscc.efs.file_systems -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the file_systems resource, the following permissions are required: - -### Create -```json -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 -```json -elasticfilesystem:DescribeBackupPolicy, -elasticfilesystem:DescribeFileSystemPolicy, -elasticfilesystem:DescribeFileSystems, -elasticfilesystem:DescribeLifecycleConfiguration, -elasticfilesystem:DescribeReplicationConfigurations -``` - diff --git a/docs/awscc-docs/providers/awscc/efs/index.md b/docs/awscc-docs/providers/awscc/efs/index.md deleted file mode 100644 index d8d3e2ff4f..0000000000 --- a/docs/awscc-docs/providers/awscc/efs/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -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 deleted file mode 100644 index c2640fc8a9..0000000000 --- a/docs/awscc-docs/providers/awscc/efs/mount_target/index.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id, -ip_address, -file_system_id, -security_groups, -subnet_id -FROM awscc.efs.mount_target -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the mount_target resource, the following permissions are required: - -### Read -```json -elasticfilesystem:DescribeMountTargets, -elasticfilesystem:DescribeMountTargetSecurityGroups -``` - -### Update -```json -elasticfilesystem:DescribeMountTargets, -elasticfilesystem:DescribeMountTargetSecurityGroups, -elasticfilesystem:ModifyMountTargetSecurityGroups -``` - -### Delete -```json -elasticfilesystem:DescribeMountTargets, -elasticfilesystem:DeleteMountTarget -``` - diff --git a/docs/awscc-docs/providers/awscc/efs/mount_targets/index.md b/docs/awscc-docs/providers/awscc/efs/mount_targets/index.md deleted file mode 100644 index 7e9b5480bc..0000000000 --- a/docs/awscc-docs/providers/awscc/efs/mount_targets/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.efs.mount_targets -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the mount_targets resource, the following permissions are required: - -### Create -```json -elasticfilesystem:CreateMountTarget, -elasticfilesystem:DescribeMountTargets -``` - -### List -```json -elasticfilesystem:DescribeMountTargets, -elasticfilesystem:DescribeMountTargetSecurityGroups -``` - diff --git a/docs/awscc-docs/providers/awscc/eks/access_entries/index.md b/docs/awscc-docs/providers/awscc/eks/access_entries/index.md deleted file mode 100644 index 59158749c8..0000000000 --- a/docs/awscc-docs/providers/awscc/eks/access_entries/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -principal_arn, -cluster_name -FROM awscc.eks.access_entries -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the access_entries resource, the following permissions are required: - -### Create -```json -eks:CreateAccessEntry, -eks:DescribeAccessEntry, -eks:AssociateAccessPolicy, -eks:TagResource, -eks:ListAssociatedAccessPolicies -``` - -### List -```json -eks:ListAccessEntries -``` - diff --git a/docs/awscc-docs/providers/awscc/eks/access_entry/index.md b/docs/awscc-docs/providers/awscc/eks/access_entry/index.md deleted file mode 100644 index 9497e6d436..0000000000 --- a/docs/awscc-docs/providers/awscc/eks/access_entry/index.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -cluster_name, -principal_arn, -username, -tags, -access_entry_arn, -kubernetes_groups, -access_policies, -type -FROM awscc.eks.access_entry -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the access_entry resource, the following permissions are required: - -### Read -```json -eks:DescribeAccessEntry, -eks:ListAssociatedAccessPolicies -``` - -### Update -```json -eks:DescribeAccessEntry, -eks:ListAssociatedAccessPolicies, -eks:UpdateAccessEntry, -eks:AssociateAccessPolicy, -eks:DisassociateAccessPolicy, -eks:TagResource, -eks:UntagResource -``` - -### Delete -```json -eks:DeleteAccessEntry, -eks:DescribeAccessEntry -``` - diff --git a/docs/awscc-docs/providers/awscc/eks/addon/index.md b/docs/awscc-docs/providers/awscc/eks/addon/index.md deleted file mode 100644 index a8ea36fba0..0000000000 --- a/docs/awscc-docs/providers/awscc/eks/addon/index.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the addon resource, the following permissions are required: - -### Read -```json -eks:DescribeAddon -``` - -### Delete -```json -eks:DeleteAddon, -eks:DescribeAddon -``` - -### Update -```json -iam:PassRole, -eks:UpdateAddon, -eks:DescribeAddon, -eks:DescribeUpdate, -eks:ListTagsForResource, -eks:TagResource, -eks:UntagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/eks/addons/index.md b/docs/awscc-docs/providers/awscc/eks/addons/index.md deleted file mode 100644 index ec9a52c155..0000000000 --- a/docs/awscc-docs/providers/awscc/eks/addons/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -cluster_name, -addon_name -FROM awscc.eks.addons -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the addons resource, the following permissions are required: - -### Create -```json -eks:CreateAddon, -eks:DescribeAddon, -eks:TagResource, -iam:PassRole -``` - -### List -```json -eks:ListAddons -``` - diff --git a/docs/awscc-docs/providers/awscc/eks/cluster/index.md b/docs/awscc-docs/providers/awscc/eks/cluster/index.md deleted file mode 100644 index bec306d234..0000000000 --- a/docs/awscc-docs/providers/awscc/eks/cluster/index.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the cluster resource, the following permissions are required: - -### Read -```json -eks:DescribeCluster -``` - -### Update -```json -iam:PassRole, -eks:UpdateClusterConfig, -eks:UpdateClusterVersion, -eks:DescribeCluster, -eks:DescribeUpdate, -eks:TagResource, -eks:UntagResource -``` - -### Delete -```json -eks:DeleteCluster, -eks:DescribeCluster -``` - diff --git a/docs/awscc-docs/providers/awscc/eks/clusters/index.md b/docs/awscc-docs/providers/awscc/eks/clusters/index.md deleted file mode 100644 index 906ce6e465..0000000000 --- a/docs/awscc-docs/providers/awscc/eks/clusters/index.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.eks.clusters -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the clusters resource, the following permissions are required: - -### Create -```json -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 -```json -eks:ListClusters -``` - diff --git a/docs/awscc-docs/providers/awscc/eks/fargate_profile/index.md b/docs/awscc-docs/providers/awscc/eks/fargate_profile/index.md deleted file mode 100644 index a135c0abce..0000000000 --- a/docs/awscc-docs/providers/awscc/eks/fargate_profile/index.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -cluster_name, -fargate_profile_name, -pod_execution_role_arn, -arn, -subnets, -selectors, -tags -FROM awscc.eks.fargate_profile -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the fargate_profile resource, the following permissions are required: - -### Read -```json -eks:DescribeFargateProfile -``` - -### Delete -```json -eks:DeleteFargateProfile, -eks:DescribeFargateProfile -``` - -### Update -```json -eks:DescribeFargateProfile, -eks:ListTagsForResource, -eks:TagResource, -eks:UntagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/eks/fargate_profiles/index.md b/docs/awscc-docs/providers/awscc/eks/fargate_profiles/index.md deleted file mode 100644 index 34f9e4d2cf..0000000000 --- a/docs/awscc-docs/providers/awscc/eks/fargate_profiles/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -cluster_name, -fargate_profile_name -FROM awscc.eks.fargate_profiles -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the fargate_profiles resource, the following permissions are required: - -### Create -```json -eks:CreateFargateProfile, -eks:DescribeFargateProfile, -iam:GetRole, -iam:PassRole, -iam:CreateServiceLinkedRole, -eks:TagResource -``` - -### List -```json -eks:ListFargateProfiles -``` - 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 deleted file mode 100644 index 2733e3e894..0000000000 --- a/docs/awscc-docs/providers/awscc/eks/identity_provider_config/index.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -cluster_name, -type, -identity_provider_config_name, -oidc, -tags, -identity_provider_config_arn -FROM awscc.eks.identity_provider_config -WHERE data__Identifier = '||'; -``` - -## Permissions - -To operate on the identity_provider_config resource, the following permissions are required: - -### Read -```json -eks:DescribeIdentityProviderConfig -``` - -### Update -```json -eks:DescribeIdentityProviderConfig, -eks:TagResource, -eks:UntagResource -``` - -### Delete -```json -eks:DisassociateIdentityProviderConfig, -eks:DescribeIdentityProviderConfig -``` - 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 deleted file mode 100644 index 562f1ae4f7..0000000000 --- a/docs/awscc-docs/providers/awscc/eks/identity_provider_configs/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -identity_provider_config_name, -cluster_name, -type -FROM awscc.eks.identity_provider_configs -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the identity_provider_configs resource, the following permissions are required: - -### Create -```json -eks:DescribeUpdate, -eks:AssociateIdentityProviderConfig, -eks:DescribeIdentityProviderConfig, -eks:TagResource -``` - -### List -```json -eks:ListIdentityProviderConfigs -``` - diff --git a/docs/awscc-docs/providers/awscc/eks/index.md b/docs/awscc-docs/providers/awscc/eks/index.md deleted file mode 100644 index 9e37fcf273..0000000000 --- a/docs/awscc-docs/providers/awscc/eks/index.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -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 deleted file mode 100644 index 859cee0bbf..0000000000 --- a/docs/awscc-docs/providers/awscc/eks/nodegroup/index.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the nodegroup resource, the following permissions are required: - -### Read -```json -eks:DescribeNodegroup -``` - -### Delete -```json -eks:DeleteNodegroup, -eks:DescribeNodegroup -``` - -### Update -```json -iam:GetRole, -iam:PassRole, -eks:DescribeNodegroup, -eks:DescribeUpdate, -eks:ListUpdates, -eks:TagResource, -eks:UntagResource, -eks:UpdateNodegroupConfig, -eks:UpdateNodegroupVersion -``` - diff --git a/docs/awscc-docs/providers/awscc/eks/nodegroups/index.md b/docs/awscc-docs/providers/awscc/eks/nodegroups/index.md deleted file mode 100644 index 7d692a08f5..0000000000 --- a/docs/awscc-docs/providers/awscc/eks/nodegroups/index.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.eks.nodegroups -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the nodegroups resource, the following permissions are required: - -### Create -```json -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 -```json -eks:ListNodegroups -``` - 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 deleted file mode 100644 index 105910b73c..0000000000 --- a/docs/awscc-docs/providers/awscc/eks/pod_identity_association/index.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -cluster_name, -role_arn, -namespace, -service_account, -association_arn, -association_id, -tags -FROM awscc.eks.pod_identity_association -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the pod_identity_association resource, the following permissions are required: - -### Read -```json -eks:DescribePodIdentityAssociation -``` - -### Update -```json -eks:DescribePodIdentityAssociation, -eks:UpdatePodIdentityAssociation, -eks:TagResource, -eks:UntagResource, -iam:PassRole, -iam:GetRole -``` - -### Delete -```json -eks:DeletePodIdentityAssociation, -eks:DescribePodIdentityAssociation -``` - 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 deleted file mode 100644 index 39dfb86758..0000000000 --- a/docs/awscc-docs/providers/awscc/eks/pod_identity_associations/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -association_arn -FROM awscc.eks.pod_identity_associations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the pod_identity_associations resource, the following permissions are required: - -### Create -```json -eks:CreatePodIdentityAssociation, -eks:DescribePodIdentityAssociation, -eks:TagResource, -iam:PassRole, -iam:GetRole -``` - -### List -```json -eks:ListPodIdentityAssociations -``` - 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 deleted file mode 100644 index 00caf3191b..0000000000 --- a/docs/awscc-docs/providers/awscc/elasticache/global_replication_group/index.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the global_replication_group resource, the following permissions are required: - -### Read -```json -elasticache:DescribeGlobalReplicationGroups -``` - -### Update -```json -elasticache:ModifyGlobalReplicationGroup, -elasticache:FailoverGlobalReplicationGroup, -elasticache:DescribeGlobalReplicationGroups, -elasticache:IncreaseNodeGroupsInGlobalReplicationGroup, -elasticache:DecreaseNodeGroupsInGlobalReplicationGroup, -elasticache:DisassociateGlobalReplicationGroup, -elasticache:RebalanceSlotsInGlobalReplicationGroup -``` - -### Delete -```json -elasticache:DeleteGlobalReplicationGroup, -elasticache:DisassociateGlobalReplicationGroup, -elasticache:DescribeGlobalReplicationGroups -``` - 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 deleted file mode 100644 index 5a3fa09d09..0000000000 --- a/docs/awscc-docs/providers/awscc/elasticache/global_replication_groups/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -global_replication_group_id -FROM awscc.elasticache.global_replication_groups -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the global_replication_groups resource, the following permissions are required: - -### Create -```json -elasticache:CreateGlobalReplicationGroup, -elasticache:DescribeGlobalReplicationGroups -``` - -### List -```json -elasticache:DescribeGlobalReplicationGroups -``` - diff --git a/docs/awscc-docs/providers/awscc/elasticache/index.md b/docs/awscc-docs/providers/awscc/elasticache/index.md deleted file mode 100644 index 60382eca44..0000000000 --- a/docs/awscc-docs/providers/awscc/elasticache/index.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -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 deleted file mode 100644 index 3e365b824c..0000000000 --- a/docs/awscc-docs/providers/awscc/elasticache/serverless_cache/index.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -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
arnstringThe 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. - -## 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, -arn, -final_snapshot_name -FROM awscc.elasticache.serverless_cache -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the serverless_cache resource, the following permissions are required: - -### Read -```json -elasticache:DescribeServerlessCaches, -elasticache:ListTagsForResource -``` - -### Update -```json -elasticache:ModifyServerlessCache, -elasticache:DescribeServerlessCaches, -elasticache:AddTagsToResource, -elasticache:ListTagsForResource, -elasticache:RemoveTagsFromResource -``` - -### Delete -```json -elasticache:DeleteServerlessCache, -elasticache:DescribeServerlessCaches, -elasticache:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/elasticache/serverless_caches/index.md b/docs/awscc-docs/providers/awscc/elasticache/serverless_caches/index.md deleted file mode 100644 index 746f7ce7cd..0000000000 --- a/docs/awscc-docs/providers/awscc/elasticache/serverless_caches/index.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -serverless_cache_name -FROM awscc.elasticache.serverless_caches -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the serverless_caches resource, the following permissions are required: - -### Create -```json -elasticache:CreateServerlessCache, -elasticache:DescribeServerlessCaches, -elasticache:AddTagsToResource, -elasticache:ListTagsForResource, -ec2:CreateTags, -ec2:CreateVpcEndpoint, -kms:CreateGrant, -kms:DescribeKey -``` - -### List -```json -elasticache:DescribeServerlessCaches, -elasticache:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/elasticache/subnet_group/index.md b/docs/awscc-docs/providers/awscc/elasticache/subnet_group/index.md deleted file mode 100644 index 7fb4ef2797..0000000000 --- a/docs/awscc-docs/providers/awscc/elasticache/subnet_group/index.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -description, -subnet_ids, -cache_subnet_group_name, -tags -FROM awscc.elasticache.subnet_group -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the subnet_group resource, the following permissions are required: - -### Read -```json -elasticache:DescribeCacheSubnetGroups, -elasticache:ListTagsForResource -``` - -### Delete -```json -elasticache:DeleteCacheSubnetGroup, -elasticache:DescribeCacheSubnetGroups, -elasticache:ListTagsForResource -``` - -### Update -```json -elasticache:ModifyCacheSubnetGroup, -elasticache:DescribeCacheSubnetGroups, -elasticache:AddTagsToResource, -elasticache:RemoveTagsFromResource -``` - diff --git a/docs/awscc-docs/providers/awscc/elasticache/subnet_groups/index.md b/docs/awscc-docs/providers/awscc/elasticache/subnet_groups/index.md deleted file mode 100644 index c31a375bcb..0000000000 --- a/docs/awscc-docs/providers/awscc/elasticache/subnet_groups/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -cache_subnet_group_name -FROM awscc.elasticache.subnet_groups -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the subnet_groups resource, the following permissions are required: - -### Create -```json -elasticache:CreateCacheSubnetGroup, -elasticache:AddTagsToResource, -elasticache:DescribeCacheSubnetGroups, -elasticache:ListTagsForResource -``` - -### List -```json -elasticache:DescribeCacheSubnetGroups -``` - diff --git a/docs/awscc-docs/providers/awscc/elasticache/user/index.md b/docs/awscc-docs/providers/awscc/elasticache/user/index.md deleted file mode 100644 index 71b436f823..0000000000 --- a/docs/awscc-docs/providers/awscc/elasticache/user/index.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the user resource, the following permissions are required: - -### Read -```json -elasticache:DescribeUsers, -elasticache:ListTagsForResource -``` - -### Update -```json -elasticache:ModifyUser, -elasticache:DescribeUsers, -elasticache:ListTagsForResource, -elasticache:AddTagsToResource, -elasticache:RemoveTagsFromResource -``` - -### Delete -```json -elasticache:DeleteUser, -elasticache:DescribeUsers -``` - diff --git a/docs/awscc-docs/providers/awscc/elasticache/user_group/index.md b/docs/awscc-docs/providers/awscc/elasticache/user_group/index.md deleted file mode 100644 index 93381014a6..0000000000 --- a/docs/awscc-docs/providers/awscc/elasticache/user_group/index.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -status, -user_group_id, -engine, -user_ids, -arn, -tags -FROM awscc.elasticache.user_group -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the user_group resource, the following permissions are required: - -### Read -```json -elasticache:DescribeUserGroups, -elasticache:ListTagsForResource -``` - -### Update -```json -elasticache:ModifyUserGroup, -elasticache:DescribeUserGroups, -elasticache:ListTagsForResource, -elasticache:AddTagsToResource, -elasticache:RemoveTagsFromResource -``` - -### Delete -```json -elasticache:ModifyReplicationGroup, -elasticache:DeleteUserGroup, -elasticache:DescribeUserGroups, -elasticache:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/elasticache/user_groups/index.md b/docs/awscc-docs/providers/awscc/elasticache/user_groups/index.md deleted file mode 100644 index a8952b3f95..0000000000 --- a/docs/awscc-docs/providers/awscc/elasticache/user_groups/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -user_group_id -FROM awscc.elasticache.user_groups -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the user_groups resource, the following permissions are required: - -### Create -```json -elasticache:CreateUserGroup, -elasticache:DescribeUserGroups, -elasticache:ListTagsForResource -``` - -### List -```json -elasticache:DescribeUserGroups, -elasticache:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/elasticache/users/index.md b/docs/awscc-docs/providers/awscc/elasticache/users/index.md deleted file mode 100644 index b91c01b139..0000000000 --- a/docs/awscc-docs/providers/awscc/elasticache/users/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -user_id -FROM awscc.elasticache.users -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the users resource, the following permissions are required: - -### Create -```json -elasticache:CreateUser, -elasticache:DescribeUsers, -elasticache:ListTagsForResource -``` - -### List -```json -elasticache:DescribeUsers, -elasticache:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/elasticbeanstalk/application/index.md b/docs/awscc-docs/providers/awscc/elasticbeanstalk/application/index.md deleted file mode 100644 index ba837af8eb..0000000000 --- a/docs/awscc-docs/providers/awscc/elasticbeanstalk/application/index.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -application_name, -description, -resource_lifecycle_config -FROM awscc.elasticbeanstalk.application -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the application resource, the following permissions are required: - -### Read -```json -elasticbeanstalk:DescribeApplications -``` - -### Update -```json -elasticbeanstalk:UpdateApplication, -elasticbeanstalk:UpdateApplicationResourceLifecycle -``` - -### Delete -```json -elasticbeanstalk:DeleteApplication -``` - diff --git a/docs/awscc-docs/providers/awscc/elasticbeanstalk/application_version/index.md b/docs/awscc-docs/providers/awscc/elasticbeanstalk/application_version/index.md deleted file mode 100644 index fc843c3a85..0000000000 --- a/docs/awscc-docs/providers/awscc/elasticbeanstalk/application_version/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id, -application_name, -description, -source_bundle -FROM awscc.elasticbeanstalk.application_version -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the application_version resource, the following permissions are required: - -### Read -```json -elasticbeanstalk:DescribeApplicationVersions -``` - -### Update -```json -elasticbeanstalk:UpdateApplicationVersion -``` - -### Delete -```json -elasticbeanstalk:DeleteApplicationVersion -``` - diff --git a/docs/awscc-docs/providers/awscc/elasticbeanstalk/application_versions/index.md b/docs/awscc-docs/providers/awscc/elasticbeanstalk/application_versions/index.md deleted file mode 100644 index 0ef7ea0343..0000000000 --- a/docs/awscc-docs/providers/awscc/elasticbeanstalk/application_versions/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -application_name, -id -FROM awscc.elasticbeanstalk.application_versions -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the application_versions resource, the following permissions are required: - -### Create -```json -elasticbeanstalk:CreateApplicationVersion, -elasticbeanstalk:DescribeApplicationVersions, -s3:GetObject, -s3:PutObject -``` - -### List -```json -elasticbeanstalk:DescribeApplicationVersions -``` - diff --git a/docs/awscc-docs/providers/awscc/elasticbeanstalk/applications/index.md b/docs/awscc-docs/providers/awscc/elasticbeanstalk/applications/index.md deleted file mode 100644 index 3aeaae9af9..0000000000 --- a/docs/awscc-docs/providers/awscc/elasticbeanstalk/applications/index.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -application_name -FROM awscc.elasticbeanstalk.applications -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the applications resource, the following permissions are required: - -### Create -```json -elasticbeanstalk:CreateApplication -``` - -### List -```json -elasticbeanstalk:DescribeApplications -``` - diff --git a/docs/awscc-docs/providers/awscc/elasticbeanstalk/configuration_template/index.md b/docs/awscc-docs/providers/awscc/elasticbeanstalk/configuration_template/index.md deleted file mode 100644 index ff7d651a64..0000000000 --- a/docs/awscc-docs/providers/awscc/elasticbeanstalk/configuration_template/index.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the configuration_template resource, the following permissions are required: - -### Read -```json -elasticbeanstalk:DescribeConfigurationSettings -``` - -### Update -```json -elasticbeanstalk:UpdateConfigurationTemplate -``` - -### Delete -```json -elasticbeanstalk:DeleteConfigurationTemplate, -elasticbeanstalk:DescribeConfigurationSettings -``` - diff --git a/docs/awscc-docs/providers/awscc/elasticbeanstalk/configuration_templates/index.md b/docs/awscc-docs/providers/awscc/elasticbeanstalk/configuration_templates/index.md deleted file mode 100644 index 88553660d5..0000000000 --- a/docs/awscc-docs/providers/awscc/elasticbeanstalk/configuration_templates/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -application_name, -template_name -FROM awscc.elasticbeanstalk.configuration_templates -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the configuration_templates resource, the following permissions are required: - -### Create -```json -elasticbeanstalk:CreateConfigurationTemplate -``` - -### List -```json -elasticbeanstalk:DescribeApplications -``` - diff --git a/docs/awscc-docs/providers/awscc/elasticbeanstalk/environment/index.md b/docs/awscc-docs/providers/awscc/elasticbeanstalk/environment/index.md deleted file mode 100644 index 5ec7b470b5..0000000000 --- a/docs/awscc-docs/providers/awscc/elasticbeanstalk/environment/index.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -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_urlstring
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.
cname_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. - -## Example -```sql -SELECT -region, -platform_arn, -application_name, -description, -environment_name, -operations_role, -tier, -version_label, -endpoint_url, -option_settings, -template_name, -solution_stack_name, -cname_prefix, -tags -FROM awscc.elasticbeanstalk.environment -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the environment resource, the following permissions are required: - -### Read -```json -elasticbeanstalk:DescribeEnvironments, -elasticbeanstalk:DescribeConfigurationSettings, -elasticbeanstalk:ListTagsForResource -``` - -### Update -```json -elasticbeanstalk:DescribeEnvironments, -elasticbeanstalk:UpdateEnvironment, -elasticbeanstalk:UpdateTagsForResource, -elasticbeanstalk:AssociateEnvironmentOperationsRole, -elasticbeanstalk:DisassociateEnvironmentOperationsRole, -iam:PassRole -``` - -### Delete -```json -elasticbeanstalk:DescribeEnvironments, -elasticbeanstalk:TerminateEnvironment -``` - diff --git a/docs/awscc-docs/providers/awscc/elasticbeanstalk/environments/index.md b/docs/awscc-docs/providers/awscc/elasticbeanstalk/environments/index.md deleted file mode 100644 index 6a318a304a..0000000000 --- a/docs/awscc-docs/providers/awscc/elasticbeanstalk/environments/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -environment_name -FROM awscc.elasticbeanstalk.environments -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the environments resource, the following permissions are required: - -### Create -```json -elasticbeanstalk:DescribeEnvironments, -elasticbeanstalk:CreateEnvironment, -iam:PassRole -``` - -### List -```json -elasticbeanstalk:DescribeEnvironments -``` - diff --git a/docs/awscc-docs/providers/awscc/elasticbeanstalk/index.md b/docs/awscc-docs/providers/awscc/elasticbeanstalk/index.md deleted file mode 100644 index c8669aefaf..0000000000 --- a/docs/awscc-docs/providers/awscc/elasticbeanstalk/index.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -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 deleted file mode 100644 index 95484f84a5..0000000000 --- a/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/index.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -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 deleted file mode 100644 index 20d63d5360..0000000000 --- a/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/listener/index.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the listener resource, the following permissions are required: - -### Delete -```json -elasticloadbalancing:DeleteListener, -elasticloadbalancing:DescribeListeners -``` - -### Read -```json -elasticloadbalancing:DescribeListeners -``` - -### Update -```json -elasticloadbalancing:ModifyListener, -elasticloadbalancing:DescribeListeners, -cognito-idp:DescribeUserPoolClient -``` - diff --git a/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/listener_rule/index.md b/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/listener_rule/index.md deleted file mode 100644 index 5520c65c5b..0000000000 --- a/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/listener_rule/index.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -listener_arn, -rule_arn, -actions, -priority, -conditions, -is_default -FROM awscc.elasticloadbalancingv2.listener_rule -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the listener_rule resource, the following permissions are required: - -### Delete -```json -elasticloadbalancing:DeleteRule, -elasticloadbalancing:DescribeRules -``` - -### Read -```json -elasticloadbalancing:DescribeRules -``` - -### Update -```json -elasticloadbalancing:ModifyRule, -elasticloadbalancing:SetRulePriorities, -elasticloadbalancing:DescribeRules -``` - diff --git a/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/listener_rules/index.md b/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/listener_rules/index.md deleted file mode 100644 index c8d759d38d..0000000000 --- a/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/listener_rules/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -rule_arn -FROM awscc.elasticloadbalancingv2.listener_rules -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the listener_rules resource, the following permissions are required: - -### Create -```json -elasticloadbalancing:CreateRule, -elasticloadbalancing:DescribeRules, -cognito-idp:DescribeUserPoolClient -``` - -### List -```json -elasticloadbalancing:DescribeRules -``` - diff --git a/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/listeners/index.md b/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/listeners/index.md deleted file mode 100644 index a978df5bd2..0000000000 --- a/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/listeners/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -listener_arn -FROM awscc.elasticloadbalancingv2.listeners -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the listeners resource, the following permissions are required: - -### Create -```json -elasticloadbalancing:CreateListener, -elasticloadbalancing:DescribeListeners, -cognito-idp:DescribeUserPoolClient -``` - -### List -```json -elasticloadbalancing:DescribeListeners -``` - diff --git a/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/load_balancer/index.md b/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/load_balancer/index.md deleted file mode 100644 index 1d20e05bd9..0000000000 --- a/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/load_balancer/index.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -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.
dns_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. - -## Example -```sql -SELECT -region, -ip_address_type, -security_groups, -load_balancer_attributes, -scheme, -dns_name, -name, -load_balancer_name, -load_balancer_full_name, -subnets, -type, -canonical_hosted_zone_id, -tags, -load_balancer_arn, -subnet_mappings, -enforce_security_group_inbound_rules_on_private_link_traffic -FROM awscc.elasticloadbalancingv2.load_balancer -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the load_balancer resource, the following permissions are required: - -### Delete -```json -elasticloadbalancing:DescribeLoadBalancers, -elasticloadbalancing:DeleteLoadBalancer -``` - -### Read -```json -elasticloadbalancing:DescribeLoadBalancers, -elasticloadbalancing:DescribeLoadBalancerAttributes, -elasticloadbalancing:DescribeTags -``` - -### Update -```json -elasticloadbalancing:ModifyLoadBalancerAttributes, -elasticloadbalancing:SetSubnets, -elasticloadbalancing:SetIpAddressType, -elasticloadbalancing:SetSecurityGroups, -elasticloadbalancing:AddTags, -elasticloadbalancing:RemoveTags -``` - diff --git a/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/load_balancers/index.md b/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/load_balancers/index.md deleted file mode 100644 index 2c749abf45..0000000000 --- a/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/load_balancers/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -load_balancer_arn -FROM awscc.elasticloadbalancingv2.load_balancers -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the load_balancers resource, the following permissions are required: - -### Create -```json -elasticloadbalancing:CreateLoadBalancer, -elasticloadbalancing:DescribeLoadBalancers, -elasticloadbalancing:ModifyLoadBalancerAttributes, -elasticloadbalancing:AddTags -``` - -### List -```json -elasticloadbalancing:DescribeLoadBalancers -``` - diff --git a/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/target_group/index.md b/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/target_group/index.md deleted file mode 100644 index bf7ded8c17..0000000000 --- a/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/target_group/index.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the target_group resource, the following permissions are required: - -### Delete -```json -elasticloadbalancing:DeleteTargetGroup, -elasticloadbalancing:DescribeTargetGroups -``` - -### Read -```json -elasticloadbalancing:DescribeTargetGroups, -elasticloadbalancing:DescribeTargetGroupAttributes, -elasticloadbalancing:DescribeTargetHealth, -elasticloadbalancing:DescribeTags -``` - -### Update -```json -elasticloadbalancing:DescribeTargetGroups, -elasticloadbalancing:ModifyTargetGroup, -elasticloadbalancing:ModifyTargetGroupAttributes, -elasticloadbalancing:RegisterTargets, -elasticloadbalancing:DescribeTargetHealth, -elasticloadbalancing:DeregisterTargets, -elasticloadbalancing:AddTags, -elasticloadbalancing:RemoveTags -``` - diff --git a/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/target_groups/index.md b/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/target_groups/index.md deleted file mode 100644 index dca06e9d98..0000000000 --- a/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/target_groups/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -target_group_arn -FROM awscc.elasticloadbalancingv2.target_groups -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the target_groups resource, the following permissions are required: - -### Create -```json -elasticloadbalancing:CreateTargetGroup, -elasticloadbalancing:DescribeTargetGroups, -elasticloadbalancing:RegisterTargets, -elasticloadbalancing:ModifyTargetGroupAttributes, -elasticloadbalancing:DescribeTargetHealth, -elasticloadbalancing:AddTags -``` - -### List -```json -elasticloadbalancing:DescribeTargetGroups -``` - diff --git a/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/trust_store/index.md b/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/trust_store/index.md deleted file mode 100644 index 198a440411..0000000000 --- a/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/trust_store/index.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the trust_store resource, the following permissions are required: - -### Delete -```json -elasticloadbalancing:DescribeTrustStores, -elasticloadbalancing:DeleteTrustStore -``` - -### Read -```json -elasticloadbalancing:DescribeTrustStores, -elasticloadbalancing:DescribeTags -``` - -### Update -```json -elasticloadbalancing:ModifyTrustStore, -elasticloadbalancing:AddTags, -elasticloadbalancing:RemoveTags, -s3:GetObject, -s3:GetObjectVersion -``` - 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 deleted file mode 100644 index f8f0e668d8..0000000000 --- a/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/trust_store_revocation/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -revocation_contents, -trust_store_arn, -revocation_id, -trust_store_revocations -FROM awscc.elasticloadbalancingv2.trust_store_revocation -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the trust_store_revocation resource, the following permissions are required: - -### Delete -```json -elasticloadbalancing:DescribeTrustStoreRevocations, -elasticloadbalancing:RemoveTrustStoreRevocations -``` - -### Read -```json -elasticloadbalancing:DescribeTrustStoreRevocations -``` - 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 deleted file mode 100644 index 9f9c6493d6..0000000000 --- a/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/trust_store_revocations/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -revocation_id, -trust_store_arn -FROM awscc.elasticloadbalancingv2.trust_store_revocations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the trust_store_revocations resource, the following permissions are required: - -### Create -```json -elasticloadbalancing:AddTrustStoreRevocations, -elasticloadbalancing:DescribeTrustStoreRevocations, -s3:GetObject, -s3:GetObjectVersion -``` - -### List -```json -elasticloadbalancing:DescribeTrustStoreRevocations -``` - diff --git a/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/trust_stores/index.md b/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/trust_stores/index.md deleted file mode 100644 index c16934f23d..0000000000 --- a/docs/awscc-docs/providers/awscc/elasticloadbalancingv2/trust_stores/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -trust_store_arn -FROM awscc.elasticloadbalancingv2.trust_stores -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the trust_stores resource, the following permissions are required: - -### Create -```json -elasticloadbalancing:CreateTrustStore, -elasticloadbalancing:DescribeTrustStores, -elasticloadbalancing:AddTags, -s3:GetObject, -s3:GetObjectVersion -``` - -### List -```json -elasticloadbalancing:DescribeTrustStores, -s3:GetObject, -s3:GetObjectVersion -``` - diff --git a/docs/awscc-docs/providers/awscc/emr/index.md b/docs/awscc-docs/providers/awscc/emr/index.md deleted file mode 100644 index 21968a1a69..0000000000 --- a/docs/awscc-docs/providers/awscc/emr/index.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -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: 8
-total selectable resources: 8
-total methods: 8
-
-
- -::: - -## Resources -
-
-security_configuration
-security_configurations
-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 deleted file mode 100644 index c5455cfdf0..0000000000 --- a/docs/awscc-docs/providers/awscc/emr/security_configuration/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -security_configuration -FROM awscc.emr.security_configuration -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the security_configuration resource, the following permissions are required: - -### Read -```json -elasticmapreduce:DescribeSecurityConfiguration -``` - -### Delete -```json -elasticmapreduce:DeleteSecurityConfiguration -``` - diff --git a/docs/awscc-docs/providers/awscc/emr/security_configurations/index.md b/docs/awscc-docs/providers/awscc/emr/security_configurations/index.md deleted file mode 100644 index ec61ef4912..0000000000 --- a/docs/awscc-docs/providers/awscc/emr/security_configurations/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.emr.security_configurations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the security_configurations resource, the following permissions are required: - -### Create -```json -elasticmapreduce:CreateSecurityConfiguration, -elasticmapreduce:DescribeSecurityConfiguration -``` - -### List -```json -elasticmapreduce:ListSecurityConfigurations -``` - diff --git a/docs/awscc-docs/providers/awscc/emr/studio/index.md b/docs/awscc-docs/providers/awscc/emr/studio/index.md deleted file mode 100644 index 306b1b21c4..0000000000 --- a/docs/awscc-docs/providers/awscc/emr/studio/index.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the studio resource, the following permissions are required: - -### Read -```json -elasticmapreduce:DescribeStudio, -sso:GetManagedApplicationInstance -``` - -### Update -```json -elasticmapreduce:UpdateStudio, -elasticmapreduce:DescribeStudio, -elasticmapreduce:AddTags, -elasticmapreduce:RemoveTags -``` - -### Delete -```json -elasticmapreduce:DeleteStudio, -elasticmapreduce:DescribeStudio, -sso:DeleteManagedApplicationInstance -``` - 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 deleted file mode 100644 index c52aa0943e..0000000000 --- a/docs/awscc-docs/providers/awscc/emr/studio_session_mapping/index.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -identity_name, -identity_type, -session_policy_arn, -studio_id -FROM awscc.emr.studio_session_mapping -WHERE data__Identifier = '||'; -``` - -## Permissions - -To operate on the studio_session_mapping resource, the following permissions are required: - -### Read -```json -elasticmapreduce:GetStudioSessionMapping, -sso-directory:SearchUsers, -sso-directory:SearchGroups, -sso-directory:DescribeUser, -sso-directory:DescribeGroup, -sso:GetManagedApplicationInstance, -sso:DescribeInstance -``` - -### Update -```json -elasticmapreduce:GetStudioSessionMapping, -elasticmapreduce:UpdateStudioSessionMapping, -sso-directory:SearchUsers, -sso-directory:SearchGroups, -sso-directory:DescribeUser, -sso-directory:DescribeGroup, -sso:GetManagedApplicationInstance, -sso:DescribeInstance -``` - -### Delete -```json -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 -``` - 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 deleted file mode 100644 index 18ec2862e6..0000000000 --- a/docs/awscc-docs/providers/awscc/emr/studio_session_mappings/index.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -studio_id, -identity_type, -identity_name -FROM awscc.emr.studio_session_mappings -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the studio_session_mappings resource, the following permissions are required: - -### Create -```json -elasticmapreduce:CreateStudioSessionMapping, -sso-directory:SearchUsers, -sso-directory:SearchGroups, -sso-directory:DescribeUser, -sso-directory:DescribeGroup, -sso:ListDirectoryAssociations, -sso:GetProfile, -sso:ListProfiles, -sso:AssociateProfile -``` - -### List -```json -elasticmapreduce:ListStudioSessionMappings -``` - diff --git a/docs/awscc-docs/providers/awscc/emr/studios/index.md b/docs/awscc-docs/providers/awscc/emr/studios/index.md deleted file mode 100644 index 89cfa499d9..0000000000 --- a/docs/awscc-docs/providers/awscc/emr/studios/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -studio_id -FROM awscc.emr.studios -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the studios resource, the following permissions are required: - -### Create -```json -elasticmapreduce:CreateStudio, -elasticmapreduce:DescribeStudio, -elasticmapreduce:AddTags, -sso:CreateManagedApplicationInstance, -sso:DeleteManagedApplicationInstance, -iam:PassRole -``` - -### List -```json -elasticmapreduce:ListStudios -``` - diff --git a/docs/awscc-docs/providers/awscc/emr/wal_workspace/index.md b/docs/awscc-docs/providers/awscc/emr/wal_workspace/index.md deleted file mode 100644 index 9101802575..0000000000 --- a/docs/awscc-docs/providers/awscc/emr/wal_workspace/index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -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
wal_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. - -## Example -```sql -SELECT -region, -wal_workspace_name, -tags -FROM awscc.emr.wal_workspace -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the wal_workspace resource, the following permissions are required: - -### Read -```json -emrwal:ListTagsForResource -``` - -### Delete -```json -emrwal:DeleteWorkspace -``` - -### Update -```json -emrwal:TagResource, -emrwal:UntagResource, -emrwal:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/emr/wal_workspaces/index.md b/docs/awscc-docs/providers/awscc/emr/wal_workspaces/index.md deleted file mode 100644 index 2af9ea6324..0000000000 --- a/docs/awscc-docs/providers/awscc/emr/wal_workspaces/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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
wal_workspace_namestringThe name of the emrwal container
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -wal_workspace_name -FROM awscc.emr.wal_workspaces -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the wal_workspaces resource, the following permissions are required: - -### Create -```json -emrwal:CreateWorkspace, -emrwal:TagResource, -iam:CreateServiceLinkedRole -``` - -### List -```json -emrwal:ListWorkspaces -``` - diff --git a/docs/awscc-docs/providers/awscc/emrcontainers/index.md b/docs/awscc-docs/providers/awscc/emrcontainers/index.md deleted file mode 100644 index 58fc4a3d44..0000000000 --- a/docs/awscc-docs/providers/awscc/emrcontainers/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 deleted file mode 100644 index 99cf5bfd27..0000000000 --- a/docs/awscc-docs/providers/awscc/emrcontainers/virtual_cluster/index.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -container_provider, -id, -name, -tags -FROM awscc.emrcontainers.virtual_cluster -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the virtual_cluster resource, the following permissions are required: - -### Read -```json -emr-containers:DescribeVirtualCluster -``` - -### Delete -```json -emr-containers:DeleteVirtualCluster -``` - -### Update -```json -emr-containers:DescribeVirtualCluster, -emr-containers:ListTagsForResource, -emr-containers:TagResource, -emr-containers:UntagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/emrcontainers/virtual_clusters/index.md b/docs/awscc-docs/providers/awscc/emrcontainers/virtual_clusters/index.md deleted file mode 100644 index cceba12347..0000000000 --- a/docs/awscc-docs/providers/awscc/emrcontainers/virtual_clusters/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.emrcontainers.virtual_clusters -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the virtual_clusters resource, the following permissions are required: - -### Create -```json -emr-containers:CreateVirtualCluster, -emr-containers:TagResource, -iam:CreateServiceLinkedRole -``` - -### List -```json -emr-containers:ListVirtualClusters -``` - diff --git a/docs/awscc-docs/providers/awscc/emrserverless/application/index.md b/docs/awscc-docs/providers/awscc/emrserverless/application/index.md deleted file mode 100644 index 661de3cf59..0000000000 --- a/docs/awscc-docs/providers/awscc/emrserverless/application/index.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the application resource, the following permissions are required: - -### Read -```json -emr-serverless:GetApplication -``` - -### Update -```json -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 -```json -emr-serverless:DeleteApplication, -emr-serverless:GetApplication -``` - diff --git a/docs/awscc-docs/providers/awscc/emrserverless/applications/index.md b/docs/awscc-docs/providers/awscc/emrserverless/applications/index.md deleted file mode 100644 index 6cc21c34b5..0000000000 --- a/docs/awscc-docs/providers/awscc/emrserverless/applications/index.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -application_id -FROM awscc.emrserverless.applications -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the applications resource, the following permissions are required: - -### Create -```json -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 -```json -emr-serverless:ListApplications -``` - diff --git a/docs/awscc-docs/providers/awscc/emrserverless/index.md b/docs/awscc-docs/providers/awscc/emrserverless/index.md deleted file mode 100644 index b70df90cfb..0000000000 --- a/docs/awscc-docs/providers/awscc/emrserverless/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 deleted file mode 100644 index 0f06aaa732..0000000000 --- a/docs/awscc-docs/providers/awscc/entityresolution/id_mapping_workflow/index.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the id_mapping_workflow resource, the following permissions are required: - -### Update -```json -entityresolution:GetIdMappingWorkflow, -entityresolution:UpdateIdMappingWorkflow, -entityresolution:ListTagsForResource, -entityresolution:TagResource, -entityresolution:UntagResource, -iam:PassRole, -kms:CreateGrant, -kms:DescribeKey -``` - -### Read -```json -entityresolution:GetIdMappingWorkflow, -entityresolution:ListTagsForResource -``` - -### Delete -```json -entityresolution:DeleteIdMappingWorkflow, -entityresolution:GetIdMappingWorkflow, -entityresolution:UntagResource -``` - 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 deleted file mode 100644 index 528525afdb..0000000000 --- a/docs/awscc-docs/providers/awscc/entityresolution/id_mapping_workflows/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -workflow_name -FROM awscc.entityresolution.id_mapping_workflows -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the id_mapping_workflows resource, the following permissions are required: - -### Create -```json -entityresolution:CreateIdMappingWorkflow, -entityresolution:GetIdMappingWorkflow, -entityresolution:TagResource, -kms:CreateGrant, -kms:DescribeKey, -iam:PassRole -``` - -### List -```json -entityresolution:ListIdMappingWorkflows -``` - diff --git a/docs/awscc-docs/providers/awscc/entityresolution/index.md b/docs/awscc-docs/providers/awscc/entityresolution/index.md deleted file mode 100644 index f2e07f5168..0000000000 --- a/docs/awscc-docs/providers/awscc/entityresolution/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -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 deleted file mode 100644 index 582c5f98af..0000000000 --- a/docs/awscc-docs/providers/awscc/entityresolution/matching_workflow/index.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the matching_workflow resource, the following permissions are required: - -### Read -```json -entityresolution:GetMatchingWorkflow, -entityresolution:ListTagsForResource -``` - -### Delete -```json -entityresolution:DeleteMatchingWorkflow, -entityresolution:GetMatchingWorkflow, -entityresolution:UntagResource -``` - -### Update -```json -entityresolution:GetMatchingWorkflow, -entityresolution:UpdateMatchingWorkflow, -entityresolution:ListTagsForResource, -entityresolution:TagResource, -entityresolution:UntagResource, -iam:PassRole, -kms:CreateGrant, -kms:DescribeKey -``` - diff --git a/docs/awscc-docs/providers/awscc/entityresolution/matching_workflows/index.md b/docs/awscc-docs/providers/awscc/entityresolution/matching_workflows/index.md deleted file mode 100644 index ac66301955..0000000000 --- a/docs/awscc-docs/providers/awscc/entityresolution/matching_workflows/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -workflow_name -FROM awscc.entityresolution.matching_workflows -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the matching_workflows resource, the following permissions are required: - -### Create -```json -entityresolution:CreateMatchingWorkflow, -entityresolution:GetMatchingWorkflow, -entityresolution:TagResource, -kms:CreateGrant, -kms:DescribeKey, -iam:PassRole -``` - -### List -```json -entityresolution:ListMatchingWorkflows -``` - diff --git a/docs/awscc-docs/providers/awscc/entityresolution/schema_mapping/index.md b/docs/awscc-docs/providers/awscc/entityresolution/schema_mapping/index.md deleted file mode 100644 index def6b81296..0000000000 --- a/docs/awscc-docs/providers/awscc/entityresolution/schema_mapping/index.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the schema_mapping resource, the following permissions are required: - -### Read -```json -entityresolution:GetSchemaMapping, -entityresolution:ListTagsForResource -``` - -### Delete -```json -entityresolution:DeleteSchemaMapping, -entityresolution:GetSchemaMapping -``` - -### Update -```json -entityresolution:GetSchemaMapping, -entityresolution:UpdateSchemaMapping, -entityresolution:ListTagsForResource, -entityresolution:TagResource, -entityresolution:UntagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/entityresolution/schema_mappings/index.md b/docs/awscc-docs/providers/awscc/entityresolution/schema_mappings/index.md deleted file mode 100644 index 17299094a0..0000000000 --- a/docs/awscc-docs/providers/awscc/entityresolution/schema_mappings/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -schema_name -FROM awscc.entityresolution.schema_mappings -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the schema_mappings resource, the following permissions are required: - -### Create -```json -entityresolution:CreateSchemaMapping, -entityresolution:GetSchemaMapping, -entityresolution:TagResource -``` - -### List -```json -entityresolution:ListSchemaMappings -``` - diff --git a/docs/awscc-docs/providers/awscc/events/api_destination/index.md b/docs/awscc-docs/providers/awscc/events/api_destination/index.md deleted file mode 100644 index 646c65c95b..0000000000 --- a/docs/awscc-docs/providers/awscc/events/api_destination/index.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -description, -connection_arn, -arn, -invocation_rate_limit_per_second, -invocation_endpoint, -http_method -FROM awscc.events.api_destination -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the api_destination resource, the following permissions are required: - -### Read -```json -events:DescribeApiDestination -``` - -### Update -```json -events:UpdateApiDestination, -events:DescribeApiDestination -``` - -### Delete -```json -events:DeleteApiDestination, -events:DescribeApiDestination -``` - diff --git a/docs/awscc-docs/providers/awscc/events/api_destinations/index.md b/docs/awscc-docs/providers/awscc/events/api_destinations/index.md deleted file mode 100644 index 6447e6a6c5..0000000000 --- a/docs/awscc-docs/providers/awscc/events/api_destinations/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.events.api_destinations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the api_destinations resource, the following permissions are required: - -### Create -```json -events:CreateApiDestination, -events:DescribeApiDestination -``` - -### List -```json -events:ListApiDestinations -``` - diff --git a/docs/awscc-docs/providers/awscc/events/archive/index.md b/docs/awscc-docs/providers/awscc/events/archive/index.md deleted file mode 100644 index 58ee8b40ca..0000000000 --- a/docs/awscc-docs/providers/awscc/events/archive/index.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -archive_name, -source_arn, -description, -event_pattern, -arn, -retention_days -FROM awscc.events.archive -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the archive resource, the following permissions are required: - -### Delete -```json -events:DescribeArchive, -events:DeleteArchive -``` - -### Update -```json -events:DescribeArchive, -events:UpdateArchive -``` - -### Read -```json -events:DescribeArchive -``` - diff --git a/docs/awscc-docs/providers/awscc/events/archives/index.md b/docs/awscc-docs/providers/awscc/events/archives/index.md deleted file mode 100644 index fb98fc90d1..0000000000 --- a/docs/awscc-docs/providers/awscc/events/archives/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -archive_name -FROM awscc.events.archives -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the archives resource, the following permissions are required: - -### Create -```json -events:DescribeArchive, -events:CreateArchive -``` - -### List -```json -events:ListArchives -``` - diff --git a/docs/awscc-docs/providers/awscc/events/connection/index.md b/docs/awscc-docs/providers/awscc/events/connection/index.md deleted file mode 100644 index c6bf6237fa..0000000000 --- a/docs/awscc-docs/providers/awscc/events/connection/index.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -arn, -secret_arn, -description, -authorization_type, -auth_parameters -FROM awscc.events.connection -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the connection resource, the following permissions are required: - -### Read -```json -events:DescribeConnection -``` - -### Update -```json -events:UpdateConnection, -events:DescribeConnection, -secretsmanager:CreateSecret, -secretsmanager:UpdateSecret, -secretsmanager:GetSecretValue, -secretsmanager:PutSecretValue -``` - -### Delete -```json -events:DeleteConnection, -events:DescribeConnection -``` - diff --git a/docs/awscc-docs/providers/awscc/events/connections/index.md b/docs/awscc-docs/providers/awscc/events/connections/index.md deleted file mode 100644 index 9ecc0bacaf..0000000000 --- a/docs/awscc-docs/providers/awscc/events/connections/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.events.connections -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the connections resource, the following permissions are required: - -### Create -```json -events:CreateConnection, -events:DescribeConnection, -secretsmanager:CreateSecret, -secretsmanager:GetSecretValue, -secretsmanager:PutSecretValue, -iam:CreateServiceLinkedRole -``` - -### List -```json -events:ListConnections -``` - diff --git a/docs/awscc-docs/providers/awscc/events/endpoint/index.md b/docs/awscc-docs/providers/awscc/events/endpoint/index.md deleted file mode 100644 index cf327622c5..0000000000 --- a/docs/awscc-docs/providers/awscc/events/endpoint/index.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the endpoint resource, the following permissions are required: - -### Read -```json -events:DescribeEndpoint -``` - -### Update -```json -events:DescribeEndpoint, -events:UpdateEndpoint, -route53:GetHealthCheck, -iam:PassRole -``` - -### Delete -```json -events:DeleteEndpoint, -events:DescribeEndpoint -``` - diff --git a/docs/awscc-docs/providers/awscc/events/endpoints/index.md b/docs/awscc-docs/providers/awscc/events/endpoints/index.md deleted file mode 100644 index 6d8c65ac87..0000000000 --- a/docs/awscc-docs/providers/awscc/events/endpoints/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.events.endpoints -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the endpoints resource, the following permissions are required: - -### Create -```json -events:CreateEndpoint, -events:DescribeEndpoint, -route53:GetHealthCheck, -iam:PassRole -``` - -### List -```json -events:ListEndpoints -``` - diff --git a/docs/awscc-docs/providers/awscc/events/event_bus/index.md b/docs/awscc-docs/providers/awscc/events/event_bus/index.md deleted file mode 100644 index df64a359c5..0000000000 --- a/docs/awscc-docs/providers/awscc/events/event_bus/index.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -event_source_name, -name, -tags, -policy, -arn -FROM awscc.events.event_bus -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the event_bus resource, the following permissions are required: - -### Read -```json -events:DescribeEventBus, -events:ListTagsForResource -``` - -### Update -```json -events:TagResource, -events:UntagResource, -events:PutPermission, -events:DescribeEventBus -``` - -### Delete -```json -events:DescribeEventBus, -events:DeleteEventBus -``` - diff --git a/docs/awscc-docs/providers/awscc/events/event_buses/index.md b/docs/awscc-docs/providers/awscc/events/event_buses/index.md deleted file mode 100644 index 87c771de48..0000000000 --- a/docs/awscc-docs/providers/awscc/events/event_buses/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.events.event_buses -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the event_buses resource, the following permissions are required: - -### Create -```json -events:CreateEventBus, -events:DescribeEventBus, -events:PutPermission, -events:ListTagsForResource, -events:TagResource -``` - -### List -```json -events:ListEventBuses, -events:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/events/index.md b/docs/awscc-docs/providers/awscc/events/index.md deleted file mode 100644 index 1033e811cd..0000000000 --- a/docs/awscc-docs/providers/awscc/events/index.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -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 deleted file mode 100644 index 5aacc65aec..0000000000 --- a/docs/awscc-docs/providers/awscc/events/rule/index.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -event_bus_name, -event_pattern, -schedule_expression, -description, -state, -targets, -arn, -role_arn, -name -FROM awscc.events.rule -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the rule resource, the following permissions are required: - -### Read -```json -iam:PassRole, -events:DescribeRule, -events:ListTargetsByRule -``` - -### Update -```json -iam:PassRole, -events:DescribeRule, -events:PutRule, -events:RemoveTargets, -events:PutTargets -``` - -### Delete -```json -iam:PassRole, -events:DescribeRule, -events:DeleteRule, -events:RemoveTargets, -events:ListTargetsByRule -``` - diff --git a/docs/awscc-docs/providers/awscc/events/rules/index.md b/docs/awscc-docs/providers/awscc/events/rules/index.md deleted file mode 100644 index 768d3f51a3..0000000000 --- a/docs/awscc-docs/providers/awscc/events/rules/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.events.rules -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the rules resource, the following permissions are required: - -### Create -```json -iam:PassRole, -events:DescribeRule, -events:PutRule, -events:PutTargets -``` - -### List -```json -events:ListRules -``` - diff --git a/docs/awscc-docs/providers/awscc/eventschemas/discoverer/index.md b/docs/awscc-docs/providers/awscc/eventschemas/discoverer/index.md deleted file mode 100644 index 839c1c77e1..0000000000 --- a/docs/awscc-docs/providers/awscc/eventschemas/discoverer/index.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -discoverer_arn, -discoverer_id, -description, -source_arn, -cross_account, -state, -tags -FROM awscc.eventschemas.discoverer -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the discoverer resource, the following permissions are required: - -### Read -```json -schemas:DescribeDiscoverer -``` - -### Update -```json -schemas:DescribeDiscoverer, -schemas:UpdateDiscoverer, -schemas:TagResource, -schemas:UntagResource, -schemas:ListTagsForResource, -events:PutTargets, -events:PutRule -``` - -### Delete -```json -schemas:DescribeDiscoverer, -schemas:DeleteDiscoverer, -events:DeleteRule, -events:DisableRule, -events:RemoveTargets -``` - diff --git a/docs/awscc-docs/providers/awscc/eventschemas/discoverers/index.md b/docs/awscc-docs/providers/awscc/eventschemas/discoverers/index.md deleted file mode 100644 index 7916954577..0000000000 --- a/docs/awscc-docs/providers/awscc/eventschemas/discoverers/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -discoverer_arn -FROM awscc.eventschemas.discoverers -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the discoverers resource, the following permissions are required: - -### Create -```json -schemas:CreateDiscoverer, -schemas:DescribeDiscoverer, -schemas:TagResource, -events:PutRule, -events:PutTargets, -events:EnableRule, -events:ListTargetsByRule, -iam:CreateServiceLinkedRole -``` - -### List -```json -schemas:ListDiscoverers -``` - diff --git a/docs/awscc-docs/providers/awscc/eventschemas/eventschemas_registry/index.md b/docs/awscc-docs/providers/awscc/eventschemas/eventschemas_registry/index.md deleted file mode 100644 index dde7791604..0000000000 --- a/docs/awscc-docs/providers/awscc/eventschemas/eventschemas_registry/index.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -registry_name, -description, -registry_arn, -tags -FROM awscc.eventschemas.eventschemas_registry -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the eventschemas_registry resource, the following permissions are required: - -### Read -```json -schemas:DescribeRegistry -``` - -### Update -```json -schemas:DescribeRegistry, -schemas:UpdateRegistry, -schemas:TagResource, -schemas:UntagResource, -schemas:ListTagsForResource -``` - -### Delete -```json -schemas:DescribeRegistry, -schemas:DeleteRegistry -``` - diff --git a/docs/awscc-docs/providers/awscc/eventschemas/index.md b/docs/awscc-docs/providers/awscc/eventschemas/index.md deleted file mode 100644 index ea234e972c..0000000000 --- a/docs/awscc-docs/providers/awscc/eventschemas/index.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -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: 7
-total selectable resources: 7
-total methods: 7
-
-
- -::: - -## Resources -
-
-discoverer
-discoverers
-eventschemas_registry
-registries -
-
-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 deleted file mode 100644 index c803e5356b..0000000000 --- a/docs/awscc-docs/providers/awscc/eventschemas/registries/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -registry_arn -FROM awscc.eventschemas.registries -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the registries resource, the following permissions are required: - -### Create -```json -schemas:DescribeRegistry, -schemas:CreateRegistry, -schemas:TagResource -``` - -### List -```json -schemas:ListRegistries -``` - diff --git a/docs/awscc-docs/providers/awscc/eventschemas/registry_policy/index.md b/docs/awscc-docs/providers/awscc/eventschemas/registry_policy/index.md deleted file mode 100644 index 85f313e17b..0000000000 --- a/docs/awscc-docs/providers/awscc/eventschemas/registry_policy/index.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id, -policy, -registry_name, -revision_id -FROM awscc.eventschemas.registry_policy -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the registry_policy resource, the following permissions are required: - -### Delete -```json -schemas:DeleteResourcePolicy, -schemas:GetResourcePolicy -``` - -### Update -```json -schemas:PutResourcePolicy, -schemas:GetResourcePolicy -``` - -### Read -```json -schemas:GetResourcePolicy -``` - diff --git a/docs/awscc-docs/providers/awscc/eventschemas/schema/index.md b/docs/awscc-docs/providers/awscc/eventschemas/schema/index.md deleted file mode 100644 index f9ac1e1e88..0000000000 --- a/docs/awscc-docs/providers/awscc/eventschemas/schema/index.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the schema resource, the following permissions are required: - -### Read -```json -schemas:DescribeSchema -``` - -### Update -```json -schemas:DescribeSchema, -schemas:UpdateSchema, -schemas:TagResource, -schemas:UntagResource, -schemas:ListTagsForResource -``` - -### Delete -```json -schemas:DescribeSchema, -schemas:DeleteSchema, -schemas:DeleteSchemaVersion -``` - diff --git a/docs/awscc-docs/providers/awscc/eventschemas/schemata/index.md b/docs/awscc-docs/providers/awscc/eventschemas/schemata/index.md deleted file mode 100644 index a815155528..0000000000 --- a/docs/awscc-docs/providers/awscc/eventschemas/schemata/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -schema_arn -FROM awscc.eventschemas.schemata -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the schemata resource, the following permissions are required: - -### Create -```json -schemas:DescribeSchema, -schemas:CreateSchema, -schemas:TagResource -``` - -### List -```json -schemas:ListSchemas, -schemas:ListSchemaVersions -``` - diff --git a/docs/awscc-docs/providers/awscc/evidently/experiment/index.md b/docs/awscc-docs/providers/awscc/evidently/experiment/index.md deleted file mode 100644 index c0f61caf9b..0000000000 --- a/docs/awscc-docs/providers/awscc/evidently/experiment/index.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the experiment resource, the following permissions are required: - -### Read -```json -evidently:GetExperiment, -evidently:ListTagsForResource -``` - -### Update -```json -evidently:UpdateExperiment, -evidently:TagResource, -evidently:UntagResource, -evidently:GetExperiment, -evidently:StartExperiment, -evidently:StopExperiment -``` - -### Delete -```json -evidently:DeleteExperiment, -evidently:UntagResource, -evidently:GetExperiment -``` - diff --git a/docs/awscc-docs/providers/awscc/evidently/feature/index.md b/docs/awscc-docs/providers/awscc/evidently/feature/index.md deleted file mode 100644 index 9840ee396c..0000000000 --- a/docs/awscc-docs/providers/awscc/evidently/feature/index.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -project, -name, -description, -evaluation_strategy, -variations, -default_variation, -entity_overrides, -tags -FROM awscc.evidently.feature -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the feature resource, the following permissions are required: - -### Read -```json -evidently:GetFeature, -evidently:ListTagsForResource -``` - -### Update -```json -evidently:UpdateFeature, -evidently:ListTagsForResource, -evidently:TagResource, -evidently:UntagResource, -evidently:GetFeature -``` - -### Delete -```json -evidently:DeleteFeature, -evidently:UntagResource, -evidently:GetFeature -``` - diff --git a/docs/awscc-docs/providers/awscc/evidently/index.md b/docs/awscc-docs/providers/awscc/evidently/index.md deleted file mode 100644 index 927aaec26c..0000000000 --- a/docs/awscc-docs/providers/awscc/evidently/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -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: 6
-total selectable resources: 6
-total methods: 6
-
-
- -::: - -## Resources -
-
-experiment
-feature
-launch -
-
-project
-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 deleted file mode 100644 index 3260612df9..0000000000 --- a/docs/awscc-docs/providers/awscc/evidently/launch/index.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -name, -project, -description, -randomization_salt, -scheduled_splits_config, -groups, -metric_monitors, -tags, -execution_status -FROM awscc.evidently.launch -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the launch resource, the following permissions are required: - -### Read -```json -evidently:GetLaunch, -evidently:ListTagsForResource -``` - -### Update -```json -evidently:UpdateLaunch, -evidently:ListTagsForResource, -evidently:TagResource, -evidently:UntagResource, -evidently:GetLaunch, -evidently:StartLaunch, -evidently:StopLaunch -``` - -### Delete -```json -evidently:DeleteLaunch, -evidently:UntagResource, -evidently:GetLaunch -``` - diff --git a/docs/awscc-docs/providers/awscc/evidently/project/index.md b/docs/awscc-docs/providers/awscc/evidently/project/index.md deleted file mode 100644 index 1d4774210a..0000000000 --- a/docs/awscc-docs/providers/awscc/evidently/project/index.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -name, -description, -data_delivery, -app_config_resource, -tags -FROM awscc.evidently.project -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the project resource, the following permissions are required: - -### Read -```json -evidently:GetProject, -logs:GetLogDelivery, -logs:ListLogDeliveries, -s3:GetBucketPolicy, -logs:DescribeResourcePolicies, -logs:DescribeLogGroups, -evidently:ListTagsForResource -``` - -### Update -```json -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 -```json -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 -``` - diff --git a/docs/awscc-docs/providers/awscc/evidently/segment/index.md b/docs/awscc-docs/providers/awscc/evidently/segment/index.md deleted file mode 100644 index 9aadd375f1..0000000000 --- a/docs/awscc-docs/providers/awscc/evidently/segment/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -name, -description, -pattern, -tags -FROM awscc.evidently.segment -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the segment resource, the following permissions are required: - -### Read -```json -evidently:GetSegment, -evidently:ListTagsForResource -``` - -### Delete -```json -evidently:DeleteSegment, -evidently:GetSegment, -evidently:UntagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/evidently/segments/index.md b/docs/awscc-docs/providers/awscc/evidently/segments/index.md deleted file mode 100644 index c24ec30976..0000000000 --- a/docs/awscc-docs/providers/awscc/evidently/segments/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.evidently.segments -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the segments resource, the following permissions are required: - -### Create -```json -evidently:CreateSegment, -evidently:GetSegment, -evidently:TagResource -``` - -### List -```json -evidently:ListSegment, -evidently:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/finspace/environment/index.md b/docs/awscc-docs/providers/awscc/finspace/environment/index.md deleted file mode 100644 index df5fc9f0e7..0000000000 --- a/docs/awscc-docs/providers/awscc/finspace/environment/index.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the environment resource, the following permissions are required: - -### Read -```json -finspace:GetEnvironment -``` - -### Update -```json -finspace:UpdateEnvironment -``` - -### Delete -```json -finspace:DeleteEnvironment, -finspace:GetEnvironment -``` - diff --git a/docs/awscc-docs/providers/awscc/finspace/environments/index.md b/docs/awscc-docs/providers/awscc/finspace/environments/index.md deleted file mode 100644 index cac7f9f03a..0000000000 --- a/docs/awscc-docs/providers/awscc/finspace/environments/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -environment_id -FROM awscc.finspace.environments -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the environments resource, the following permissions are required: - -### Create -```json -finspace:CreateEnvironment, -finspace:GetEnvironment, -finspace:ListEnvironments, -sts:AssumeRole -``` - -### List -```json -finspace:ListEnvironments -``` - diff --git a/docs/awscc-docs/providers/awscc/finspace/index.md b/docs/awscc-docs/providers/awscc/finspace/index.md deleted file mode 100644 index bfa819c62a..0000000000 --- a/docs/awscc-docs/providers/awscc/finspace/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 deleted file mode 100644 index 7149e65131..0000000000 --- a/docs/awscc-docs/providers/awscc/fis/experiment_template/index.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id, -description, -targets, -actions, -stop_conditions, -log_configuration, -role_arn, -tags, -experiment_options -FROM awscc.fis.experiment_template -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the experiment_template resource, the following permissions are required: - -### Read -```json -fis:GetExperimentTemplate, -fis:ListTagsForResource -``` - -### Update -```json -fis:UpdateExperimentTemplate, -fis:TagResource, -fis:UntagResource, -iam:PassRole -``` - -### Delete -```json -fis:DeleteExperimentTemplate -``` - diff --git a/docs/awscc-docs/providers/awscc/fis/experiment_templates/index.md b/docs/awscc-docs/providers/awscc/fis/experiment_templates/index.md deleted file mode 100644 index fc3bb002a5..0000000000 --- a/docs/awscc-docs/providers/awscc/fis/experiment_templates/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.fis.experiment_templates -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the experiment_templates resource, the following permissions are required: - -### Create -```json -fis:CreateExperimentTemplate, -fis:TagResource, -iam:PassRole -``` - -### List -```json -fis:ListExperimentTemplates, -fis:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/fis/index.md b/docs/awscc-docs/providers/awscc/fis/index.md deleted file mode 100644 index 9602738aae..0000000000 --- a/docs/awscc-docs/providers/awscc/fis/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index 34227f5a99..0000000000 --- a/docs/awscc-docs/providers/awscc/fis/target_account_configuration/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -experiment_template_id, -account_id, -role_arn, -description -FROM awscc.fis.target_account_configuration -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the target_account_configuration resource, the following permissions are required: - -### Read -```json -fis:GetTargetAccountConfiguration -``` - -### Update -```json -fis:UpdateTargetAccountConfiguration -``` - -### Delete -```json -fis:DeleteTargetAccountConfiguration -``` - 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 deleted file mode 100644 index c72666b645..0000000000 --- a/docs/awscc-docs/providers/awscc/fis/target_account_configurations/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -experiment_template_id, -account_id -FROM awscc.fis.target_account_configurations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the target_account_configurations resource, the following permissions are required: - -### Create -```json -fis:CreateTargetAccountConfiguration -``` - -### List -```json -fis:ListTargetAccountConfigurations -``` - diff --git a/docs/awscc-docs/providers/awscc/fms/index.md b/docs/awscc-docs/providers/awscc/fms/index.md deleted file mode 100644 index a434d7910a..0000000000 --- a/docs/awscc-docs/providers/awscc/fms/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -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 deleted file mode 100644 index d4f8ede242..0000000000 --- a/docs/awscc-docs/providers/awscc/fms/notification_channel/index.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -sns_role_name, -sns_topic_arn -FROM awscc.fms.notification_channel -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the notification_channel resource, the following permissions are required: - -### Update -```json -fms:PutNotificationChannel, -iam:PassRole -``` - -### Read -```json -fms:GetNotificationChannel -``` - -### Delete -```json -fms:DeleteNotificationChannel -``` - diff --git a/docs/awscc-docs/providers/awscc/fms/notification_channels/index.md b/docs/awscc-docs/providers/awscc/fms/notification_channels/index.md deleted file mode 100644 index 4ec5d22941..0000000000 --- a/docs/awscc-docs/providers/awscc/fms/notification_channels/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -sns_topic_arn -FROM awscc.fms.notification_channels -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the notification_channels resource, the following permissions are required: - -### Create -```json -fms:PutNotificationChannel, -iam:PassRole -``` - -### List -```json -fms:GetNotificationChannel -``` - diff --git a/docs/awscc-docs/providers/awscc/fms/policies/index.md b/docs/awscc-docs/providers/awscc/fms/policies/index.md deleted file mode 100644 index 8f7f4ee6cf..0000000000 --- a/docs/awscc-docs/providers/awscc/fms/policies/index.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.fms.policies -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the policies resource, the following permissions are required: - -### Create -```json -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 -```json -fms:ListPolicies, -fms:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/fms/policy/index.md b/docs/awscc-docs/providers/awscc/fms/policy/index.md deleted file mode 100644 index af3feee765..0000000000 --- a/docs/awscc-docs/providers/awscc/fms/policy/index.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the policy resource, the following permissions are required: - -### Update -```json -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 -```json -fms:GetPolicy, -fms:ListTagsForResource -``` - -### Delete -```json -fms:DeletePolicy -``` - diff --git a/docs/awscc-docs/providers/awscc/fms/resource_set/index.md b/docs/awscc-docs/providers/awscc/fms/resource_set/index.md deleted file mode 100644 index be2dff4122..0000000000 --- a/docs/awscc-docs/providers/awscc/fms/resource_set/index.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id, -name, -description, -resource_type_list, -resources, -tags -FROM awscc.fms.resource_set -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the resource_set resource, the following permissions are required: - -### Update -```json -fms:PutResourceSet, -fms:BatchAssociateResource, -fms:BatchDisassociateResource, -fms:GetResourceSet, -fms:ListResourceSetResources, -fms:TagResource, -fms:UntagResource, -fms:ListTagsForResource -``` - -### Read -```json -fms:GetResourceSet, -fms:ListResourceSetResources, -fms:ListTagsForResource -``` - -### Delete -```json -fms:DeleteResourceSet -``` - diff --git a/docs/awscc-docs/providers/awscc/fms/resource_sets/index.md b/docs/awscc-docs/providers/awscc/fms/resource_sets/index.md deleted file mode 100644 index 7caf7a5323..0000000000 --- a/docs/awscc-docs/providers/awscc/fms/resource_sets/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.fms.resource_sets -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the resource_sets resource, the following permissions are required: - -### Create -```json -fms:PutResourceSet, -fms:BatchAssociateResource, -fms:ListResourceSetResources, -fms:TagResource -``` - -### List -```json -fms:ListResourceSets -``` - diff --git a/docs/awscc-docs/providers/awscc/forecast/dataset/index.md b/docs/awscc-docs/providers/awscc/forecast/dataset/index.md deleted file mode 100644 index fdf561dd78..0000000000 --- a/docs/awscc-docs/providers/awscc/forecast/dataset/index.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -dataset_name, -dataset_type, -data_frequency, -domain, -encryption_config, -schema, -tags -FROM awscc.forecast.dataset -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the dataset resource, the following permissions are required: - -### Read -```json -forecast:DescribeDataset -``` - -### Delete -```json -forecast:DeleteDataset -``` - diff --git a/docs/awscc-docs/providers/awscc/forecast/dataset_group/index.md b/docs/awscc-docs/providers/awscc/forecast/dataset_group/index.md deleted file mode 100644 index 5f98eb7b8d..0000000000 --- a/docs/awscc-docs/providers/awscc/forecast/dataset_group/index.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -dataset_arns, -dataset_group_name, -domain, -tags, -dataset_group_arn -FROM awscc.forecast.dataset_group -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the dataset_group resource, the following permissions are required: - -### Read -```json -forecast:DescribeDatasetGroup -``` - -### Update -```json -forecast:UpdateDatasetGroup -``` - -### Delete -```json -forecast:DeleteDatasetGroup -``` - diff --git a/docs/awscc-docs/providers/awscc/forecast/dataset_groups/index.md b/docs/awscc-docs/providers/awscc/forecast/dataset_groups/index.md deleted file mode 100644 index 789612f83d..0000000000 --- a/docs/awscc-docs/providers/awscc/forecast/dataset_groups/index.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -dataset_group_arn -FROM awscc.forecast.dataset_groups -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the dataset_groups resource, the following permissions are required: - -### Create -```json -forecast:CreateDatasetGroup -``` - -### List -```json -forecast:ListDatasetGroups -``` - diff --git a/docs/awscc-docs/providers/awscc/forecast/datasets/index.md b/docs/awscc-docs/providers/awscc/forecast/datasets/index.md deleted file mode 100644 index ee35f4fe77..0000000000 --- a/docs/awscc-docs/providers/awscc/forecast/datasets/index.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.forecast.datasets -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the datasets resource, the following permissions are required: - -### Create -```json -forecast:CreateDataset -``` - -### List -```json -forecast:ListDatasets -``` - diff --git a/docs/awscc-docs/providers/awscc/forecast/index.md b/docs/awscc-docs/providers/awscc/forecast/index.md deleted file mode 100644 index d17de39e23..0000000000 --- a/docs/awscc-docs/providers/awscc/forecast/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index b122036b46..0000000000 --- a/docs/awscc-docs/providers/awscc/frauddetector/detector/index.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the detector resource, the following permissions are required: - -### Update -```json -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 -```json -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 -```json -frauddetector:GetDetectors, -frauddetector:GetDetectorVersion, -frauddetector:DescribeDetector, -frauddetector:GetRules, -frauddetector:GetVariables, -frauddetector:GetEventTypes, -frauddetector:GetExternalModels, -frauddetector:GetModelVersion, -frauddetector:GetLabels, -frauddetector:GetOutcomes, -frauddetector:GetEntityTypes, -frauddetector:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/frauddetector/detectors/index.md b/docs/awscc-docs/providers/awscc/frauddetector/detectors/index.md deleted file mode 100644 index 48e299eae8..0000000000 --- a/docs/awscc-docs/providers/awscc/frauddetector/detectors/index.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.frauddetector.detectors -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the detectors resource, the following permissions are required: - -### Create -```json -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 -```json -frauddetector:GetDetectors, -frauddetector:GetDetectorVersion, -frauddetector:DescribeDetector, -frauddetector:GetRules, -frauddetector:GetVariables, -frauddetector:GetEventTypes, -frauddetector:GetExternalModels, -frauddetector:GetModelVersion, -frauddetector:GetLabels, -frauddetector:GetOutcomes, -frauddetector:GetEntityTypes, -frauddetector:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/frauddetector/event_type/index.md b/docs/awscc-docs/providers/awscc/frauddetector/event_type/index.md deleted file mode 100644 index 5ef31cbdc0..0000000000 --- a/docs/awscc-docs/providers/awscc/frauddetector/event_type/index.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -tags, -description, -event_variables, -labels, -entity_types, -arn, -created_time, -last_updated_time -FROM awscc.frauddetector.event_type -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the event_type resource, the following permissions are required: - -### Update -```json -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 -```json -frauddetector:BatchGetVariable, -frauddetector:GetVariables, -frauddetector:GetEventTypes, -frauddetector:GetLabels, -frauddetector:GetEntityTypes, -frauddetector:DeleteEventType, -frauddetector:DeleteVariable, -frauddetector:DeleteLabel, -frauddetector:DeleteEntityType, -frauddetector:ListTagsForResource -``` - -### Read -```json -frauddetector:BatchGetVariable, -frauddetector:GetVariables, -frauddetector:GetEventTypes, -frauddetector:GetLabels, -frauddetector:GetEntityTypes, -frauddetector:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/frauddetector/event_types/index.md b/docs/awscc-docs/providers/awscc/frauddetector/event_types/index.md deleted file mode 100644 index 4a78cd7a0a..0000000000 --- a/docs/awscc-docs/providers/awscc/frauddetector/event_types/index.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.frauddetector.event_types -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the event_types resource, the following permissions are required: - -### Create -```json -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 -```json -frauddetector:BatchGetVariable, -frauddetector:GetVariables, -frauddetector:GetEventTypes, -frauddetector:GetLabels, -frauddetector:GetEntityTypes, -frauddetector:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/frauddetector/frauddetector_list/index.md b/docs/awscc-docs/providers/awscc/frauddetector/frauddetector_list/index.md deleted file mode 100644 index 444226c956..0000000000 --- a/docs/awscc-docs/providers/awscc/frauddetector/frauddetector_list/index.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -name, -description, -variable_type, -created_time, -last_updated_time, -tags, -elements -FROM awscc.frauddetector.frauddetector_list -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the frauddetector_list resource, the following permissions are required: - -### Read -```json -frauddetector:GetListElements, -frauddetector:GetListsMetadata, -frauddetector:ListTagsForResource -``` - -### Update -```json -frauddetector:GetListElements, -frauddetector:GetListsMetadata, -frauddetector:ListTagsForResource, -frauddetector:UntagResource, -frauddetector:UpdateList, -frauddetector:TagResource -``` - -### Delete -```json -frauddetector:DeleteList, -frauddetector:GetListsMetadata -``` - diff --git a/docs/awscc-docs/providers/awscc/frauddetector/index.md b/docs/awscc-docs/providers/awscc/frauddetector/index.md deleted file mode 100644 index 277fb67e52..0000000000 --- a/docs/awscc-docs/providers/awscc/frauddetector/index.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -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 deleted file mode 100644 index 134ac3cce2..0000000000 --- a/docs/awscc-docs/providers/awscc/frauddetector/label/index.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -tags, -description, -arn, -created_time, -last_updated_time -FROM awscc.frauddetector.label -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the label resource, the following permissions are required: - -### Read -```json -frauddetector:GetLabels, -frauddetector:ListTagsForResource -``` - -### Update -```json -frauddetector:GetLabels, -frauddetector:PutLabel, -frauddetector:ListTagsForResource, -frauddetector:TagResource, -frauddetector:UntagResource -``` - -### Delete -```json -frauddetector:GetLabels, -frauddetector:DeleteLabel -``` - diff --git a/docs/awscc-docs/providers/awscc/frauddetector/labels/index.md b/docs/awscc-docs/providers/awscc/frauddetector/labels/index.md deleted file mode 100644 index dac6f84e73..0000000000 --- a/docs/awscc-docs/providers/awscc/frauddetector/labels/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.frauddetector.labels -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the labels resource, the following permissions are required: - -### Create -```json -frauddetector:GetLabels, -frauddetector:PutLabel, -frauddetector:ListTagsForResource, -frauddetector:TagResource -``` - -### List -```json -frauddetector:GetLabels, -frauddetector:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/frauddetector/lists/index.md b/docs/awscc-docs/providers/awscc/frauddetector/lists/index.md deleted file mode 100644 index dc14f4dfeb..0000000000 --- a/docs/awscc-docs/providers/awscc/frauddetector/lists/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.frauddetector.lists -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the lists resource, the following permissions are required: - -### Create -```json -frauddetector:CreateList, -frauddetector:GetListElements, -frauddetector:GetListsMetadata, -frauddetector:ListTagsForResource, -frauddetector:TagResource, -frauddetector:UpdateList -``` - -### List -```json -frauddetector:GetListElements, -frauddetector:GetListsMetadata, -frauddetector:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/frauddetector/outcome/index.md b/docs/awscc-docs/providers/awscc/frauddetector/outcome/index.md deleted file mode 100644 index 477d22d5f9..0000000000 --- a/docs/awscc-docs/providers/awscc/frauddetector/outcome/index.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -tags, -description, -arn, -created_time, -last_updated_time -FROM awscc.frauddetector.outcome -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the outcome resource, the following permissions are required: - -### Read -```json -frauddetector:GetOutcomes, -frauddetector:ListTagsForResource -``` - -### Update -```json -frauddetector:GetOutcomes, -frauddetector:PutOutcome, -frauddetector:ListTagsForResource, -frauddetector:TagResource, -frauddetector:UntagResource -``` - -### Delete -```json -frauddetector:GetOutcomes, -frauddetector:DeleteOutcome -``` - diff --git a/docs/awscc-docs/providers/awscc/frauddetector/outcomes/index.md b/docs/awscc-docs/providers/awscc/frauddetector/outcomes/index.md deleted file mode 100644 index c7266bf104..0000000000 --- a/docs/awscc-docs/providers/awscc/frauddetector/outcomes/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.frauddetector.outcomes -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the outcomes resource, the following permissions are required: - -### Create -```json -frauddetector:GetOutcomes, -frauddetector:PutOutcome, -frauddetector:ListTagsForResource, -frauddetector:TagResource -``` - -### List -```json -frauddetector:GetOutcomes, -frauddetector:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/frauddetector/variable/index.md b/docs/awscc-docs/providers/awscc/frauddetector/variable/index.md deleted file mode 100644 index c529b49c6d..0000000000 --- a/docs/awscc-docs/providers/awscc/frauddetector/variable/index.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the variable resource, the following permissions are required: - -### Read -```json -frauddetector:GetVariables, -frauddetector:ListTagsForResource -``` - -### Update -```json -frauddetector:GetVariables, -frauddetector:UpdateVariable, -frauddetector:ListTagsForResource, -frauddetector:TagResource, -frauddetector:UntagResource -``` - -### Delete -```json -frauddetector:GetVariables, -frauddetector:DeleteVariable -``` - diff --git a/docs/awscc-docs/providers/awscc/frauddetector/variables/index.md b/docs/awscc-docs/providers/awscc/frauddetector/variables/index.md deleted file mode 100644 index d4d84c8dba..0000000000 --- a/docs/awscc-docs/providers/awscc/frauddetector/variables/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.frauddetector.variables -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the variables resource, the following permissions are required: - -### Create -```json -frauddetector:GetVariables, -frauddetector:CreateVariable, -frauddetector:ListTagsForResource, -frauddetector:TagResource -``` - -### List -```json -frauddetector:GetVariables, -frauddetector:ListTagsForResource -``` - 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 deleted file mode 100644 index 57e31e117f..0000000000 --- a/docs/awscc-docs/providers/awscc/fsx/data_repository_association/index.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -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_arnstring
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. - -## Example -```sql -SELECT -region, -association_id, -resource_arn, -file_system_id, -file_system_path, -data_repository_path, -batch_import_meta_data_on_create, -imported_file_chunk_size, -s3, -tags -FROM awscc.fsx.data_repository_association -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the data_repository_association resource, the following permissions are required: - -### Read -```json -fsx:DescribeDataRepositoryAssociations -``` - -### Update -```json -fsx:DescribeDataRepositoryAssociations, -fsx:UpdateDataRepositoryAssociation, -fsx:TagResource, -fsx:UntagResource, -s3:ListBucket, -s3:GetBucketPolicy, -s3:PutBucketPolicy, -iam:CreateServiceLinkedRole, -iam:PutRolePolicy -``` - -### Delete -```json -fsx:DescribeDataRepositoryAssociations, -fsx:DeleteDataRepositoryAssociation -``` - 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 deleted file mode 100644 index 6f2ff6570f..0000000000 --- a/docs/awscc-docs/providers/awscc/fsx/data_repository_associations/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -association_id -FROM awscc.fsx.data_repository_associations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the data_repository_associations resource, the following permissions are required: - -### Create -```json -fsx:CreateDataRepositoryAssociation, -fsx:DescribeDataRepositoryAssociations, -fsx:TagResource, -s3:ListBucket, -s3:GetBucketPolicy, -s3:PutBucketPolicy, -iam:CreateServiceLinkedRole, -iam:PutRolePolicy -``` - -### List -```json -fsx:DescribeDataRepositoryAssociations -``` - diff --git a/docs/awscc-docs/providers/awscc/fsx/index.md b/docs/awscc-docs/providers/awscc/fsx/index.md deleted file mode 100644 index e90bd0b193..0000000000 --- a/docs/awscc-docs/providers/awscc/fsx/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 deleted file mode 100644 index 39fae05c84..0000000000 --- a/docs/awscc-docs/providers/awscc/gamelift/alias/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -description, -name, -routing_strategy, -alias_id -FROM awscc.gamelift.alias -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the alias resource, the following permissions are required: - -### Read -```json -gamelift:DescribeAlias -``` - -### Update -```json -gamelift:UpdateAlias -``` - -### Delete -```json -gamelift:DeleteAlias -``` - diff --git a/docs/awscc-docs/providers/awscc/gamelift/aliases/index.md b/docs/awscc-docs/providers/awscc/gamelift/aliases/index.md deleted file mode 100644 index 57c0dbc667..0000000000 --- a/docs/awscc-docs/providers/awscc/gamelift/aliases/index.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -alias_id -FROM awscc.gamelift.aliases -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the aliases resource, the following permissions are required: - -### Create -```json -gamelift:CreateAlias -``` - -### List -```json -gamelift:ListAliases -``` - diff --git a/docs/awscc-docs/providers/awscc/gamelift/build/index.md b/docs/awscc-docs/providers/awscc/gamelift/build/index.md deleted file mode 100644 index 7304a250a4..0000000000 --- a/docs/awscc-docs/providers/awscc/gamelift/build/index.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -build_id, -name, -operating_system, -storage_location, -version, -server_sdk_version -FROM awscc.gamelift.build -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the build resource, the following permissions are required: - -### Read -```json -gamelift:DescribeBuild -``` - -### Update -```json -gamelift:UpdateBuild -``` - -### Delete -```json -gamelift:DescribeBuild, -gamelift:DeleteBuild -``` - diff --git a/docs/awscc-docs/providers/awscc/gamelift/builds/index.md b/docs/awscc-docs/providers/awscc/gamelift/builds/index.md deleted file mode 100644 index bbb4285c92..0000000000 --- a/docs/awscc-docs/providers/awscc/gamelift/builds/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -build_id -FROM awscc.gamelift.builds -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the builds resource, the following permissions are required: - -### Create -```json -gamelift:DescribeBuild, -gamelift:CreateBuild -``` - -### List -```json -gamelift:ListBuilds -``` - diff --git a/docs/awscc-docs/providers/awscc/gamelift/fleet/index.md b/docs/awscc-docs/providers/awscc/gamelift/fleet/index.md deleted file mode 100644 index 8cd124f26d..0000000000 --- a/docs/awscc-docs/providers/awscc/gamelift/fleet/index.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -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_arnstringA 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. - -## Example -```sql -SELECT -region, -scaling_policies, -description, -peer_vpc_id, -apply_capacity, -e_c2_inbound_permissions, -compute_type, -name, -anywhere_configuration, -instance_role_arn, -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 data__Identifier = ''; -``` - -## Permissions - -To operate on the fleet resource, the following permissions are required: - -### Read -```json -gamelift:DescribeFleetAttributes, -gamelift:DescribeFleetLocationAttributes, -gamelift:DescribeFleetCapacity, -gamelift:DescribeFleetPortSettings, -gamelift:DescribeFleetUtilization, -gamelift:DescribeRuntimeConfiguration, -gamelift:DescribeEC2InstanceLimits, -gamelift:DescribeFleetEvents, -gamelift:DescribeScalingPolicies -``` - -### Update -```json -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 -```json -gamelift:DeleteFleet, -gamelift:DescribeFleetLocationCapacity, -gamelift:DescribeScalingPolicies, -gamelift:DeleteScalingPolicy -``` - diff --git a/docs/awscc-docs/providers/awscc/gamelift/fleets/index.md b/docs/awscc-docs/providers/awscc/gamelift/fleets/index.md deleted file mode 100644 index e9b08b13a8..0000000000 --- a/docs/awscc-docs/providers/awscc/gamelift/fleets/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -fleet_id -FROM awscc.gamelift.fleets -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the fleets resource, the following permissions are required: - -### Create -```json -gamelift:CreateFleet, -gamelift:DescribeFleetAttributes, -gamelift:DescribeFleetLocationAttributes, -gamelift:UpdateFleetCapacity, -gamelift:DescribeFleetLocationCapacity, -gamelift:PutScalingPolicy, -gamelift:DescribeScalingPolicies -``` - -### List -```json -gamelift:ListFleets -``` - 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 deleted file mode 100644 index a3a981f219..0000000000 --- a/docs/awscc-docs/providers/awscc/gamelift/game_server_group/index.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the game_server_group resource, the following permissions are required: - -### Read -```json -gamelift:DescribeGameServerGroup -``` - -### Update -```json -gamelift:UpdateGameServerGroup, -iam:assumeRole, -iam:PassRole, -autoscaling:DescribeAutoScalingGroups, -autoscaling:UpdateAutoScalingGroup, -autoscaling:SetInstanceProtection -``` - -### Delete -```json -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 -``` - 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 deleted file mode 100644 index fcdd9fea5c..0000000000 --- a/docs/awscc-docs/providers/awscc/gamelift/game_server_groups/index.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -game_server_group_arn -FROM awscc.gamelift.game_server_groups -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the game_server_groups resource, the following permissions are required: - -### Create -```json -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 -```json -gamelift:ListGameServerGroups -``` - 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 deleted file mode 100644 index 099cfba374..0000000000 --- a/docs/awscc-docs/providers/awscc/gamelift/game_session_queue/index.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the game_session_queue resource, the following permissions are required: - -### Read -```json -gamelift:DescribeGameSessionQueues, -gamelift:ListTagsForResource -``` - -### Delete -```json -gamelift:DescribeGameSessionQueues, -gamelift:DeleteGameSessionQueue -``` - -### Update -```json -gamelift:UpdateGameSessionQueue, -gamelift:ListTagsForResource, -gamelift:TagResource, -gamelift:UntagResource -``` - 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 deleted file mode 100644 index ad3e97e1f2..0000000000 --- a/docs/awscc-docs/providers/awscc/gamelift/game_session_queues/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.gamelift.game_session_queues -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the game_session_queues resource, the following permissions are required: - -### Create -```json -gamelift:CreateGameSessionQueue, -gamelift:ListTagsForResource, -gamelift:TagResource -``` - -### List -```json -gamelift:DescribeGameSessionQueues -``` - diff --git a/docs/awscc-docs/providers/awscc/gamelift/index.md b/docs/awscc-docs/providers/awscc/gamelift/index.md deleted file mode 100644 index 947ef7b593..0000000000 --- a/docs/awscc-docs/providers/awscc/gamelift/index.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -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 deleted file mode 100644 index fff312a38f..0000000000 --- a/docs/awscc-docs/providers/awscc/gamelift/location/index.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -location_name, -location_arn, -tags -FROM awscc.gamelift.location -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the location resource, the following permissions are required: - -### Read -```json -gamelift:ListLocations, -gamelift:ListTagsForResource -``` - -### Delete -```json -gamelift:DeleteLocation -``` - -### Update -```json -gamelift:ListLocations, -gamelift:ListTagsForResource, -gamelift:TagResource, -gamelift:UntagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/gamelift/locations/index.md b/docs/awscc-docs/providers/awscc/gamelift/locations/index.md deleted file mode 100644 index e508948716..0000000000 --- a/docs/awscc-docs/providers/awscc/gamelift/locations/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -location_name -FROM awscc.gamelift.locations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the locations resource, the following permissions are required: - -### Create -```json -gamelift:CreateLocation, -gamelift:ListLocations, -gamelift:ListTagsForResource, -gamelift:TagResource -``` - -### List -```json -gamelift:ListLocations -``` - diff --git a/docs/awscc-docs/providers/awscc/gamelift/matchmaking_configuration/index.md b/docs/awscc-docs/providers/awscc/gamelift/matchmaking_configuration/index.md deleted file mode 100644 index e35d98e908..0000000000 --- a/docs/awscc-docs/providers/awscc/gamelift/matchmaking_configuration/index.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the matchmaking_configuration resource, the following permissions are required: - -### Read -```json -gamelift:DescribeMatchmakingConfigurations, -gamelift:ListTagsForResource -``` - -### Delete -```json -gamelift:DescribeMatchmakingConfigurations, -gamelift:DeleteMatchmakingConfiguration -``` - -### Update -```json -gamelift:DescribeMatchmakingConfigurations, -gamelift:UpdateMatchmakingConfiguration, -gamelift:ListTagsForResource, -gamelift:TagResource, -gamelift:UntagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/gamelift/matchmaking_configurations/index.md b/docs/awscc-docs/providers/awscc/gamelift/matchmaking_configurations/index.md deleted file mode 100644 index fd85ce4606..0000000000 --- a/docs/awscc-docs/providers/awscc/gamelift/matchmaking_configurations/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.gamelift.matchmaking_configurations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the matchmaking_configurations resource, the following permissions are required: - -### Create -```json -gamelift:CreateMatchmakingConfiguration, -gamelift:ListTagsForResource, -gamelift:TagResource, -gamelift:DescribeMatchmakingConfigurations -``` - -### List -```json -gamelift:DescribeMatchmakingConfigurations -``` - 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 deleted file mode 100644 index 65d8e01af9..0000000000 --- a/docs/awscc-docs/providers/awscc/gamelift/matchmaking_rule_set/index.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -rule_set_body, -creation_time, -arn, -tags -FROM awscc.gamelift.matchmaking_rule_set -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the matchmaking_rule_set resource, the following permissions are required: - -### Read -```json -gamelift:DescribeMatchmakingRuleSets, -gamelift:ValidateMatchmakingRuleSet, -gamelift:ListTagsForResource -``` - -### Delete -```json -gamelift:DeleteMatchmakingRuleSet -``` - -### Update -```json -gamelift:DescribeMatchmakingRuleSets, -gamelift:ListTagsForResource, -gamelift:TagResource, -gamelift:UntagResource -``` - 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 deleted file mode 100644 index 77c2824e50..0000000000 --- a/docs/awscc-docs/providers/awscc/gamelift/matchmaking_rule_sets/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.gamelift.matchmaking_rule_sets -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the matchmaking_rule_sets resource, the following permissions are required: - -### Create -```json -gamelift:CreateMatchmakingRuleSet, -gamelift:DescribeMatchmakingRuleSets, -gamelift:ValidateMatchmakingRuleSet, -gamelift:ListTagsForResource, -gamelift:TagResource -``` - -### List -```json -gamelift:DescribeMatchmakingRuleSets -``` - diff --git a/docs/awscc-docs/providers/awscc/gamelift/script/index.md b/docs/awscc-docs/providers/awscc/gamelift/script/index.md deleted file mode 100644 index 0dea12ed05..0000000000 --- a/docs/awscc-docs/providers/awscc/gamelift/script/index.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -storage_location, -version, -tags, -creation_time, -arn, -id, -size_on_disk -FROM awscc.gamelift.script -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the script resource, the following permissions are required: - -### Read -```json -gamelift:DescribeScript, -gamelift:ListScripts, -gamelift:ListTagsForResource -``` - -### Delete -```json -gamelift:DeleteScript -``` - -### Update -```json -gamelift:DescribeScript, -gamelift:UpdateScript, -gamelift:ListTagsForResource, -gamelift:TagResource, -gamelift:UntagResource, -iam:PassRole -``` - diff --git a/docs/awscc-docs/providers/awscc/gamelift/scripts/index.md b/docs/awscc-docs/providers/awscc/gamelift/scripts/index.md deleted file mode 100644 index 736fd0e945..0000000000 --- a/docs/awscc-docs/providers/awscc/gamelift/scripts/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.gamelift.scripts -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the scripts resource, the following permissions are required: - -### Create -```json -gamelift:CreateScript, -gamelift:ListTagsForResource, -gamelift:TagResource, -gamelift:DescribeScript, -iam:PassRole -``` - -### List -```json -gamelift:ListScripts, -gamelift:DescribeScript -``` - diff --git a/docs/awscc-docs/providers/awscc/globalaccelerator/accelerator/index.md b/docs/awscc-docs/providers/awscc/globalaccelerator/accelerator/index.md deleted file mode 100644 index 0072d8cb66..0000000000 --- a/docs/awscc-docs/providers/awscc/globalaccelerator/accelerator/index.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -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. - -## 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 = ''; -``` - -## Permissions - -To operate on the accelerator resource, the following permissions are required: - -### Read -```json -globalaccelerator:DescribeAccelerator -``` - -### Update -```json -globalaccelerator:UpdateAccelerator, -globalaccelerator:TagResource, -globalaccelerator:UntagResource, -globalaccelerator:DescribeAccelerator -``` - -### Delete -```json -globalaccelerator:UpdateAccelerator, -globalaccelerator:DeleteAccelerator, -globalaccelerator:DescribeAccelerator -``` - diff --git a/docs/awscc-docs/providers/awscc/globalaccelerator/accelerators/index.md b/docs/awscc-docs/providers/awscc/globalaccelerator/accelerators/index.md deleted file mode 100644 index 029a92545c..0000000000 --- a/docs/awscc-docs/providers/awscc/globalaccelerator/accelerators/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -accelerator_arn -FROM awscc.globalaccelerator.accelerators - -``` - -## Permissions - -To operate on the accelerators resource, the following permissions are required: - -### Create -```json -globalaccelerator:CreateAccelerator, -globalaccelerator:DescribeAccelerator, -globalaccelerator:TagResource -``` - -### List -```json -globalaccelerator:ListAccelerators -``` - diff --git a/docs/awscc-docs/providers/awscc/globalaccelerator/endpoint_group/index.md b/docs/awscc-docs/providers/awscc/globalaccelerator/endpoint_group/index.md deleted file mode 100644 index 8c357b9cb0..0000000000 --- a/docs/awscc-docs/providers/awscc/globalaccelerator/endpoint_group/index.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -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. - -## 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 = ''; -``` - -## Permissions - -To operate on the endpoint_group resource, the following permissions are required: - -### Read -```json -globalaccelerator:DescribeEndpointGroup -``` - -### Update -```json -globalaccelerator:UpdateEndpointGroup, -globalaccelerator:DescribeEndpointGroup, -globalaccelerator:DescribeListener, -globalaccelerator:DescribeAccelerator -``` - -### Delete -```json -globalaccelerator:DeleteEndpointGroup, -globalaccelerator:DescribeEndpointGroup, -globalaccelerator:DescribeAccelerator -``` - diff --git a/docs/awscc-docs/providers/awscc/globalaccelerator/endpoint_groups/index.md b/docs/awscc-docs/providers/awscc/globalaccelerator/endpoint_groups/index.md deleted file mode 100644 index fcc9771547..0000000000 --- a/docs/awscc-docs/providers/awscc/globalaccelerator/endpoint_groups/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -endpoint_group_arn -FROM awscc.globalaccelerator.endpoint_groups - -``` - -## Permissions - -To operate on the endpoint_groups resource, the following permissions are required: - -### Create -```json -globalaccelerator:CreateEndpointGroup, -globalaccelerator:DescribeEndpointGroup, -globalaccelerator:DescribeAccelerator, -globalaccelerator:DescribeListener, -globalaccelerator:ListAccelerators, -globalaccelerator:ListListeners -``` - -### List -```json -globalaccelerator:ListEndpointGroups -``` - diff --git a/docs/awscc-docs/providers/awscc/globalaccelerator/index.md b/docs/awscc-docs/providers/awscc/globalaccelerator/index.md deleted file mode 100644 index e7e10005f2..0000000000 --- a/docs/awscc-docs/providers/awscc/globalaccelerator/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -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 deleted file mode 100644 index 475f5ed010..0000000000 --- a/docs/awscc-docs/providers/awscc/globalaccelerator/listener/index.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -listener_arn, -accelerator_arn, -port_ranges, -protocol, -client_affinity -FROM awscc.globalaccelerator.listener -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the listener resource, the following permissions are required: - -### Read -```json -globalaccelerator:DescribeListener -``` - -### Update -```json -globalaccelerator:UpdateListener, -globalaccelerator:DescribeListener, -globalaccelerator:DescribeAccelerator -``` - -### Delete -```json -globalaccelerator:DescribeListener, -globalaccelerator:DeleteListener, -globalaccelerator:DescribeAccelerator -``` - diff --git a/docs/awscc-docs/providers/awscc/globalaccelerator/listeners/index.md b/docs/awscc-docs/providers/awscc/globalaccelerator/listeners/index.md deleted file mode 100644 index c1d88b67d7..0000000000 --- a/docs/awscc-docs/providers/awscc/globalaccelerator/listeners/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -listener_arn -FROM awscc.globalaccelerator.listeners - -``` - -## Permissions - -To operate on the listeners resource, the following permissions are required: - -### Create -```json -globalaccelerator:CreateListener, -globalaccelerator:DescribeListener, -globalaccelerator:DescribeAccelerator -``` - -### List -```json -globalaccelerator:ListListeners -``` - diff --git a/docs/awscc-docs/providers/awscc/glue/index.md b/docs/awscc-docs/providers/awscc/glue/index.md deleted file mode 100644 index db596cd241..0000000000 --- a/docs/awscc-docs/providers/awscc/glue/index.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -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 deleted file mode 100644 index 3b924d5163..0000000000 --- a/docs/awscc-docs/providers/awscc/glue/schema_version/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -schema, -schema_definition, -version_id -FROM awscc.glue.schema_version -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the schema_version resource, the following permissions are required: - -### Read -```json -glue:GetSchemaVersion -``` - -### Delete -```json -glue:DeleteSchemaVersions, -glue:GetSchemaVersion -``` - 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 deleted file mode 100644 index 2b33f3ea6e..0000000000 --- a/docs/awscc-docs/providers/awscc/glue/schema_version_metadata/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -schema_version_id, -key, -value -FROM awscc.glue.schema_version_metadata -WHERE data__Identifier = '||'; -``` - -## Permissions - -To operate on the schema_version_metadata resource, the following permissions are required: - -### Read -```json -glue:querySchemaVersionMetadata -``` - -### Delete -```json -glue:removeSchemaVersionMetadata -``` - diff --git a/docs/awscc-docs/providers/awscc/glue/schema_versions/index.md b/docs/awscc-docs/providers/awscc/glue/schema_versions/index.md deleted file mode 100644 index b072e59131..0000000000 --- a/docs/awscc-docs/providers/awscc/glue/schema_versions/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -version_id -FROM awscc.glue.schema_versions -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the schema_versions resource, the following permissions are required: - -### Create -```json -glue:RegisterSchemaVersion, -glue:GetSchemaVersion, -glue:GetSchemaByDefinition -``` - -### List -```json -glue:ListSchemaVersions -``` - diff --git a/docs/awscc-docs/providers/awscc/grafana/index.md b/docs/awscc-docs/providers/awscc/grafana/index.md deleted file mode 100644 index 9957dc8267..0000000000 --- a/docs/awscc-docs/providers/awscc/grafana/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 deleted file mode 100644 index 2cc6cf6b51..0000000000 --- a/docs/awscc-docs/providers/awscc/grafana/workspace/index.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the workspace resource, the following permissions are required: - -### Read -```json -grafana:DescribeWorkspace, -grafana:DescribeWorkspaceAuthentication, -grafana:DescribeWorkspaceConfiguration -``` - -### Update -```json -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 -```json -grafana:DeleteWorkspace, -grafana:DescribeWorkspace, -grafana:DescribeWorkspaceAuthentication, -grafana:DescribeWorkspaceConfiguration, -sso:DeleteManagedApplicationInstance, -sso:DescribeRegisteredRegions -``` - diff --git a/docs/awscc-docs/providers/awscc/grafana/workspaces/index.md b/docs/awscc-docs/providers/awscc/grafana/workspaces/index.md deleted file mode 100644 index 62e092ead5..0000000000 --- a/docs/awscc-docs/providers/awscc/grafana/workspaces/index.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.grafana.workspaces -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the workspaces resource, the following permissions are required: - -### Create -```json -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 -```json -grafana:ListWorkspaces, -grafana:DescribeWorkspaceAuthentication, -grafana:DescribeWorkspaceConfiguration -``` - diff --git a/docs/awscc-docs/providers/awscc/greengrassv2/component_version/index.md b/docs/awscc-docs/providers/awscc/greengrassv2/component_version/index.md deleted file mode 100644 index 68a9a98b4a..0000000000 --- a/docs/awscc-docs/providers/awscc/greengrassv2/component_version/index.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -component_name, -component_version, -inline_recipe, -lambda_function, -tags -FROM awscc.greengrassv2.component_version -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the component_version resource, the following permissions are required: - -### Read -```json -greengrass:DescribeComponent, -greengrass:ListTagsForResource -``` - -### Update -```json -greengrass:DescribeComponent, -greengrass:ListTagsForResource, -greengrass:TagResource, -greengrass:UntagResource -``` - -### Delete -```json -greengrass:DeleteComponent -``` - diff --git a/docs/awscc-docs/providers/awscc/greengrassv2/component_versions/index.md b/docs/awscc-docs/providers/awscc/greengrassv2/component_versions/index.md deleted file mode 100644 index 528eca5e9c..0000000000 --- a/docs/awscc-docs/providers/awscc/greengrassv2/component_versions/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.greengrassv2.component_versions -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the component_versions resource, the following permissions are required: - -### Create -```json -greengrass:CreateComponentVersion, -greengrass:DescribeComponent, -greengrass:ListTagsForResource, -greengrass:TagResource, -lambda:GetFunction, -s3:GetObject -``` - -### List -```json -greengrass:ListComponentVersions -``` - diff --git a/docs/awscc-docs/providers/awscc/greengrassv2/deployment/index.md b/docs/awscc-docs/providers/awscc/greengrassv2/deployment/index.md deleted file mode 100644 index e8c16aa54a..0000000000 --- a/docs/awscc-docs/providers/awscc/greengrassv2/deployment/index.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the deployment resource, the following permissions are required: - -### Read -```json -greengrass:GetDeployment, -iot:DescribeJob, -iot:DescribeThing, -iot:DescribeThingGroup, -iot:GetThingShadow -``` - -### Update -```json -greengrass:GetDeployment, -greengrass:TagResource, -greengrass:UntagResource, -iot:DescribeJob -``` - -### Delete -```json -greengrass:DeleteDeployment, -greengrass:CancelDeployment, -iot:CancelJob, -iot:DeleteJob, -iot:DescribeJob -``` - diff --git a/docs/awscc-docs/providers/awscc/greengrassv2/deployments/index.md b/docs/awscc-docs/providers/awscc/greengrassv2/deployments/index.md deleted file mode 100644 index 03445e2857..0000000000 --- a/docs/awscc-docs/providers/awscc/greengrassv2/deployments/index.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -deployment_id -FROM awscc.greengrassv2.deployments -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the deployments resource, the following permissions are required: - -### Create -```json -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 -```json -greengrass:ListDeployments, -iot:DescribeJob, -iot:DescribeThing, -iot:DescribeThingGroup, -iot:GetThingShadow -``` - diff --git a/docs/awscc-docs/providers/awscc/greengrassv2/index.md b/docs/awscc-docs/providers/awscc/greengrassv2/index.md deleted file mode 100644 index 2e22f5a826..0000000000 --- a/docs/awscc-docs/providers/awscc/greengrassv2/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index a5d9892767..0000000000 --- a/docs/awscc-docs/providers/awscc/groundstation/config/index.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -tags, -type, -config_data, -arn, -id -FROM awscc.groundstation.config -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the config resource, the following permissions are required: - -### Read -```json -groundstation:GetConfig, -groundstation:ListTagsForResource -``` - -### Update -```json -groundstation:UpdateConfig, -groundstation:ListTagsForResource, -groundstation:TagResource, -groundstation:UntagResource, -iam:PassRole -``` - -### Delete -```json -groundstation:DeleteConfig -``` - diff --git a/docs/awscc-docs/providers/awscc/groundstation/configs/index.md b/docs/awscc-docs/providers/awscc/groundstation/configs/index.md deleted file mode 100644 index f39be7ce83..0000000000 --- a/docs/awscc-docs/providers/awscc/groundstation/configs/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.groundstation.configs -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the configs resource, the following permissions are required: - -### Create -```json -groundstation:CreateConfig, -groundstation:TagResource, -iam:PassRole -``` - -### List -```json -groundstation:ListConfigs -``` - 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 deleted file mode 100644 index 2d1c2fa83e..0000000000 --- a/docs/awscc-docs/providers/awscc/groundstation/dataflow_endpoint_group/index.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the dataflow_endpoint_group resource, the following permissions are required: - -### Read -```json -groundstation:GetDataflowEndpointGroup, -groundstation:ListTagsForResource -``` - -### Delete -```json -groundstation:DeleteDataflowEndpointGroup, -groundstation:GetDataflowEndpointGroup -``` - 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 deleted file mode 100644 index 902b17b61f..0000000000 --- a/docs/awscc-docs/providers/awscc/groundstation/dataflow_endpoint_groups/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.groundstation.dataflow_endpoint_groups -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the dataflow_endpoint_groups resource, the following permissions are required: - -### Create -```json -groundstation:CreateDataflowEndpointGroup, -groundstation:GetDataflowEndpointGroup, -groundstation:TagResource, -iam:PassRole, -ec2:describeAddresses, -ec2:describeNetworkInterfaces, -iam:createServiceLinkedRole -``` - -### List -```json -groundstation:ListDataflowEndpointGroups -``` - diff --git a/docs/awscc-docs/providers/awscc/groundstation/index.md b/docs/awscc-docs/providers/awscc/groundstation/index.md deleted file mode 100644 index 35e0f7cc5c..0000000000 --- a/docs/awscc-docs/providers/awscc/groundstation/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -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 deleted file mode 100644 index 56623f6011..0000000000 --- a/docs/awscc-docs/providers/awscc/groundstation/mission_profile/index.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the mission_profile resource, the following permissions are required: - -### Read -```json -groundstation:GetMissionProfile, -groundstation:ListTagsForResource, -kms:DescribeKey, -kms:CreateGrant -``` - -### Update -```json -groundstation:UpdateMissionProfile, -groundstation:GetMissionProfile, -groundstation:ListTagsForResource, -groundstation:TagResource, -groundstation:UntagResource, -iam:PassRole, -kms:DescribeKey, -kms:CreateGrant -``` - -### Delete -```json -groundstation:DeleteMissionProfile, -groundstation:GetMissionProfile -``` - diff --git a/docs/awscc-docs/providers/awscc/groundstation/mission_profiles/index.md b/docs/awscc-docs/providers/awscc/groundstation/mission_profiles/index.md deleted file mode 100644 index b28668bfb6..0000000000 --- a/docs/awscc-docs/providers/awscc/groundstation/mission_profiles/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id, -arn -FROM awscc.groundstation.mission_profiles -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the mission_profiles resource, the following permissions are required: - -### Create -```json -groundstation:CreateMissionProfile, -groundstation:GetMissionProfile, -groundstation:TagResource, -iam:PassRole, -kms:DescribeKey, -kms:CreateGrant -``` - -### List -```json -groundstation:ListMissionProfiles -``` - diff --git a/docs/awscc-docs/providers/awscc/guardduty/detector/index.md b/docs/awscc-docs/providers/awscc/guardduty/detector/index.md deleted file mode 100644 index 9fe2cb3a8c..0000000000 --- a/docs/awscc-docs/providers/awscc/guardduty/detector/index.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -finding_publishing_frequency, -enable, -data_sources, -features, -id, -tags -FROM awscc.guardduty.detector -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the detector resource, the following permissions are required: - -### Read -```json -guardduty:GetDetector -``` - -### Delete -```json -guardduty:ListDetectors, -guardduty:DeleteDetector, -guardduty:GetDetector -``` - -### Update -```json -guardduty:UpdateDetector, -guardduty:GetDetector, -guardduty:ListDetectors, -iam:CreateServiceLinkedRole, -iam:GetRole -``` - diff --git a/docs/awscc-docs/providers/awscc/guardduty/detectors/index.md b/docs/awscc-docs/providers/awscc/guardduty/detectors/index.md deleted file mode 100644 index d583ad83bc..0000000000 --- a/docs/awscc-docs/providers/awscc/guardduty/detectors/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.guardduty.detectors -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the detectors resource, the following permissions are required: - -### Create -```json -guardduty:CreateDetector, -guardduty:GetDetector, -guardduty:TagResource, -iam:CreateServiceLinkedRole, -iam:GetRole -``` - -### List -```json -guardduty:ListDetectors -``` - diff --git a/docs/awscc-docs/providers/awscc/guardduty/filter/index.md b/docs/awscc-docs/providers/awscc/guardduty/filter/index.md deleted file mode 100644 index 772950bc20..0000000000 --- a/docs/awscc-docs/providers/awscc/guardduty/filter/index.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -action, -description, -detector_id, -finding_criteria, -rank, -name, -tags -FROM awscc.guardduty.filter -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the filter resource, the following permissions are required: - -### Read -```json -guardduty:GetFilter -``` - -### Delete -```json -guardduty:ListDetectors, -guardduty:ListFilters, -guardduty:GetFilter, -guardduty:DeleteFilter -``` - -### Update -```json -guardduty:UpdateFilter, -guardduty:GetFilter, -guardduty:ListFilters -``` - diff --git a/docs/awscc-docs/providers/awscc/guardduty/filters/index.md b/docs/awscc-docs/providers/awscc/guardduty/filters/index.md deleted file mode 100644 index ac6b973d50..0000000000 --- a/docs/awscc-docs/providers/awscc/guardduty/filters/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -detector_id, -name -FROM awscc.guardduty.filters -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the filters resource, the following permissions are required: - -### Create -```json -guardduty:CreateFilter, -guardduty:GetFilter, -guardduty:TagResource -``` - -### List -```json -guardduty:ListFilters -``` - diff --git a/docs/awscc-docs/providers/awscc/guardduty/index.md b/docs/awscc-docs/providers/awscc/guardduty/index.md deleted file mode 100644 index 93e0669016..0000000000 --- a/docs/awscc-docs/providers/awscc/guardduty/index.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -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 deleted file mode 100644 index cd6932d1b3..0000000000 --- a/docs/awscc-docs/providers/awscc/guardduty/ip_set/index.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id, -format, -activate, -detector_id, -name, -location, -tags -FROM awscc.guardduty.ip_set -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the ip_set resource, the following permissions are required: - -### Read -```json -guardduty:GetIPSet -``` - -### Delete -```json -guardduty:GetDetector, -guardduty:ListDetectors, -guardduty:ListIPSets, -guardduty:GetIPSet, -guardduty:DeleteIPSet, -iam:DeleteRolePolicy -``` - -### Update -```json -guardduty:UpdateIPSet, -guardduty:GetIPSet, -guardduty:ListIPSets, -iam:PutRolePolicy -``` - diff --git a/docs/awscc-docs/providers/awscc/guardduty/ip_sets/index.md b/docs/awscc-docs/providers/awscc/guardduty/ip_sets/index.md deleted file mode 100644 index a219232f0a..0000000000 --- a/docs/awscc-docs/providers/awscc/guardduty/ip_sets/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id, -detector_id -FROM awscc.guardduty.ip_sets -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the ip_sets resource, the following permissions are required: - -### Create -```json -guardduty:CreateIPSet, -guardduty:GetIPSet, -guardduty:TagResource, -iam:PutRolePolicy -``` - -### List -```json -guardduty:ListIPSets -``` - diff --git a/docs/awscc-docs/providers/awscc/guardduty/master/index.md b/docs/awscc-docs/providers/awscc/guardduty/master/index.md deleted file mode 100644 index e70ccbdb56..0000000000 --- a/docs/awscc-docs/providers/awscc/guardduty/master/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -master_id, -invitation_id, -detector_id -FROM awscc.guardduty.master -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the master resource, the following permissions are required: - -### Read -```json -guardduty:GetMasterAccount -``` - -### Delete -```json -guardduty:DisassociateFromMasterAccount -``` - diff --git a/docs/awscc-docs/providers/awscc/guardduty/masters/index.md b/docs/awscc-docs/providers/awscc/guardduty/masters/index.md deleted file mode 100644 index 2fec0f3e83..0000000000 --- a/docs/awscc-docs/providers/awscc/guardduty/masters/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -detector_id, -master_id -FROM awscc.guardduty.masters -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the masters resource, the following permissions are required: - -### Create -```json -guardduty:ListInvitations, -guardduty:AcceptInvitation, -guardduty:GetMasterAccount -``` - -### List -```json -guardduty:GetMasterAccount -``` - diff --git a/docs/awscc-docs/providers/awscc/guardduty/member/index.md b/docs/awscc-docs/providers/awscc/guardduty/member/index.md deleted file mode 100644 index f92e786454..0000000000 --- a/docs/awscc-docs/providers/awscc/guardduty/member/index.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -status, -member_id, -email, -message, -disable_email_notification, -detector_id -FROM awscc.guardduty.member -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the member resource, the following permissions are required: - -### Read -```json -guardduty:GetMembers -``` - -### Delete -```json -guardduty:GetMembers, -guardduty:DisassociateMembers, -guardduty:DeleteMembers -``` - -### Update -```json -guardduty:GetMembers, -guardduty:CreateMembers, -guardduty:DisassociateMembers, -guardduty:StartMonitoringMembers, -guardduty:StopMonitoringMembers, -guardduty:InviteMembers -``` - diff --git a/docs/awscc-docs/providers/awscc/guardduty/members/index.md b/docs/awscc-docs/providers/awscc/guardduty/members/index.md deleted file mode 100644 index 6b57537ebf..0000000000 --- a/docs/awscc-docs/providers/awscc/guardduty/members/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -detector_id, -member_id -FROM awscc.guardduty.members -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the members resource, the following permissions are required: - -### Create -```json -guardduty:CreateMembers, -guardduty:GetMembers -``` - -### List -```json -guardduty:ListMembers -``` - 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 deleted file mode 100644 index 74d64a50f9..0000000000 --- a/docs/awscc-docs/providers/awscc/guardduty/threat_intel_set/index.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id, -format, -activate, -detector_id, -name, -location, -tags -FROM awscc.guardduty.threat_intel_set -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the threat_intel_set resource, the following permissions are required: - -### Read -```json -guardduty:GetThreatIntelSet -``` - -### Delete -```json -guardduty:ListDetectors, -guardduty:ListThreatIntelSets, -guardduty:DeleteThreatIntelSet, -guardduty:GetThreatIntelSet, -iam:DeleteRolePolicy -``` - -### Update -```json -guardduty:UpdateThreatIntelSet, -guardduty:GetThreatIntelSet, -guardduty:ListThreatIntelSets, -iam:PutRolePolicy -``` - 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 deleted file mode 100644 index 330080baad..0000000000 --- a/docs/awscc-docs/providers/awscc/guardduty/threat_intel_sets/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id, -detector_id -FROM awscc.guardduty.threat_intel_sets -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the threat_intel_sets resource, the following permissions are required: - -### Create -```json -guardduty:CreateThreatIntelSet, -guardduty:GetThreatIntelSet, -guardduty:TagResource, -iam:PutRolePolicy -``` - -### List -```json -guardduty:ListThreatIntelSets -``` - diff --git a/docs/awscc-docs/providers/awscc/healthimaging/datastore/index.md b/docs/awscc-docs/providers/awscc/healthimaging/datastore/index.md deleted file mode 100644 index c1b7e1c54c..0000000000 --- a/docs/awscc-docs/providers/awscc/healthimaging/datastore/index.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the datastore resource, the following permissions are required: - -### Read -```json -medical-imaging:GetDatastore, -medical-imaging:ListTagsForResource -``` - -### Delete -```json -medical-imaging:DeleteDatastore, -medical-imaging:GetDatastore, -medical-imaging:UntagResource, -kms:DescribeKey, -kms:RetireGrant, -kms:GenerateDataKey, -kms:Decrypt -``` - diff --git a/docs/awscc-docs/providers/awscc/healthimaging/datastores/index.md b/docs/awscc-docs/providers/awscc/healthimaging/datastores/index.md deleted file mode 100644 index f43347854d..0000000000 --- a/docs/awscc-docs/providers/awscc/healthimaging/datastores/index.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -datastore_id -FROM awscc.healthimaging.datastores -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the datastores resource, the following permissions are required: - -### Create -```json -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 -```json -medical-imaging:ListDatastores -``` - diff --git a/docs/awscc-docs/providers/awscc/healthimaging/index.md b/docs/awscc-docs/providers/awscc/healthimaging/index.md deleted file mode 100644 index 3f2549dbb6..0000000000 --- a/docs/awscc-docs/providers/awscc/healthimaging/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 deleted file mode 100644 index 8284977780..0000000000 --- a/docs/awscc-docs/providers/awscc/healthlake/fhir_datastore/index.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the fhir_datastore resource, the following permissions are required: - -### Read -```json -healthlake:DescribeFHIRDatastore, -healthlake:ListTagsForResource -``` - -### Update -```json -healthlake:TagResource, -healthlake:UntagResource, -healthlake:ListTagsForResource, -healthlake:DescribeFHIRDatastore, -iam:PassRole, -iam:GetRole, -iam:CreateServiceLinkedRole -``` - -### Delete -```json -healthlake:DeleteFHIRDatastore, -healthlake:DescribeFHIRDatastore, -iam:PassRole, -iam:GetRole, -iam:CreateServiceLinkedRole, -ram:GetResourceShareInvitations, -ram:AcceptResourceShareInvitation, -glue:CreateDatabase, -glue:DeleteDatabase -``` - diff --git a/docs/awscc-docs/providers/awscc/healthlake/fhir_datastores/index.md b/docs/awscc-docs/providers/awscc/healthlake/fhir_datastores/index.md deleted file mode 100644 index 5efc8b29bf..0000000000 --- a/docs/awscc-docs/providers/awscc/healthlake/fhir_datastores/index.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -datastore_id -FROM awscc.healthlake.fhir_datastores -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the fhir_datastores resource, the following permissions are required: - -### Create -```json -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 -```json -healthlake:ListFHIRDatastores -``` - diff --git a/docs/awscc-docs/providers/awscc/healthlake/index.md b/docs/awscc-docs/providers/awscc/healthlake/index.md deleted file mode 100644 index 74a7a40818..0000000000 --- a/docs/awscc-docs/providers/awscc/healthlake/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 deleted file mode 100644 index efe526f6a1..0000000000 --- a/docs/awscc-docs/providers/awscc/iam/group/index.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -group_name, -managed_policy_arns, -path, -policies -FROM awscc.iam.group -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the group resource, the following permissions are required: - -### Read -```json -iam:GetGroup, -iam:ListGroupPolicies, -iam:GetGroupPolicy, -iam:ListAttachedGroupPolicies -``` - -### Update -```json -iam:GetGroup, -iam:UpdateGroup, -iam:DetachGroupPolicy, -iam:AttachGroupPolicy, -iam:DeleteGroupPolicy, -iam:PutGroupPolicy, -iam:GetGroupPolicy -``` - -### Delete -```json -iam:GetGroup, -iam:DeleteGroup, -iam:ListAttachedGroupPolicies, -iam:ListGroupPolicies, -iam:DetachGroupPolicy, -iam:DeleteGroupPolicy, -iam:GetGroupPolicy -``` - diff --git a/docs/awscc-docs/providers/awscc/iam/group_policies/index.md b/docs/awscc-docs/providers/awscc/iam/group_policies/index.md deleted file mode 100644 index 94f08a86c1..0000000000 --- a/docs/awscc-docs/providers/awscc/iam/group_policies/index.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -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 ---- -List of group policies by GroupName (requires `aws` provider to be installed) - -## Overview - - - - - -
Namegroup_policies
TypeResource
DescriptionList of group policies by GroupName (requires `aws` provider to be installed)
Idawscc.iam.group_policies
- -## Fields - - - - - - - - -
NameDatatypeDescription
group_namestringThe IAM group name
policy_namestringThe group policy name
policy_documentstringThe group policy document
regionstring
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -group_name, -policy_name, -policy_document, -region -FROM awscc.iam.group_policies -WHERE GroupName = ''; -``` - - - - diff --git a/docs/awscc-docs/providers/awscc/iam/group_policy/index.md b/docs/awscc-docs/providers/awscc/iam/group_policy/index.md deleted file mode 100644 index 098a59ac93..0000000000 --- a/docs/awscc-docs/providers/awscc/iam/group_policy/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -policy_document, -policy_name, -group_name -FROM awscc.iam.group_policy -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the group_policy resource, the following permissions are required: - -### Read -```json -iam:GetGroupPolicy -``` - -### Update -```json -iam:PutGroupPolicy, -iam:GetGroupPolicy -``` - -### Delete -```json -iam:DeleteGroupPolicy, -iam:GetGroupPolicy -``` - diff --git a/docs/awscc-docs/providers/awscc/iam/groups/index.md b/docs/awscc-docs/providers/awscc/iam/groups/index.md deleted file mode 100644 index 7eb510b16c..0000000000 --- a/docs/awscc-docs/providers/awscc/iam/groups/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -group_name -FROM awscc.iam.groups - -``` - -## Permissions - -To operate on the groups resource, the following permissions are required: - -### Create -```json -iam:CreateGroup, -iam:PutGroupPolicy, -iam:AttachGroupPolicy, -iam:GetGroupPolicy, -iam:GetGroup -``` - -### List -```json -iam:ListGroups -``` - diff --git a/docs/awscc-docs/providers/awscc/iam/index.md b/docs/awscc-docs/providers/awscc/iam/index.md deleted file mode 100644 index ad163a2c80..0000000000 --- a/docs/awscc-docs/providers/awscc/iam/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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
-policies
-role
-role_policies -
-
-role_policy
-roles
-saml_provider
-saml_providers
-server_certificate
-server_certificates
-service_linked_role
-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 deleted file mode 100644 index e9e4d8168c..0000000000 --- a/docs/awscc-docs/providers/awscc/iam/instance_profile/index.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -path, -roles, -instance_profile_name, -arn -FROM awscc.iam.instance_profile -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the instance_profile resource, the following permissions are required: - -### Read -```json -iam:GetInstanceProfile -``` - -### Update -```json -iam:PassRole, -iam:RemoveRoleFromInstanceProfile, -iam:AddRoleToInstanceProfile, -iam:GetInstanceProfile -``` - -### Delete -```json -iam:GetInstanceProfile, -iam:RemoveRoleFromInstanceProfile, -iam:DeleteInstanceProfile -``` - diff --git a/docs/awscc-docs/providers/awscc/iam/instance_profiles/index.md b/docs/awscc-docs/providers/awscc/iam/instance_profiles/index.md deleted file mode 100644 index aa7ff88d78..0000000000 --- a/docs/awscc-docs/providers/awscc/iam/instance_profiles/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -instance_profile_name -FROM awscc.iam.instance_profiles - -``` - -## Permissions - -To operate on the instance_profiles resource, the following permissions are required: - -### Create -```json -iam:CreateInstanceProfile, -iam:PassRole, -iam:AddRoleToInstanceProfile, -iam:GetInstanceProfile -``` - -### List -```json -iam:ListInstanceProfiles -``` - diff --git a/docs/awscc-docs/providers/awscc/iam/managed_policies/index.md b/docs/awscc-docs/providers/awscc/iam/managed_policies/index.md deleted file mode 100644 index d4c07c4c6b..0000000000 --- a/docs/awscc-docs/providers/awscc/iam/managed_policies/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -policy_arn -FROM awscc.iam.managed_policies - -``` - -## Permissions - -To operate on the managed_policies resource, the following permissions are required: - -### Create -```json -iam:CreatePolicy, -iam:AttachGroupPolicy, -iam:AttachUserPolicy, -iam:AttachRolePolicy -``` - -### List -```json -iam:ListPolicies -``` - diff --git a/docs/awscc-docs/providers/awscc/iam/managed_policy/index.md b/docs/awscc-docs/providers/awscc/iam/managed_policy/index.md deleted file mode 100644 index 22475b5dfa..0000000000 --- a/docs/awscc-docs/providers/awscc/iam/managed_policy/index.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -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. - -## 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 = ''; -``` - -## Permissions - -To operate on the managed_policy resource, the following permissions are required: - -### Read -```json -iam:GetPolicy, -iam:ListEntitiesForPolicy, -iam:GetPolicyVersion -``` - -### Update -```json -iam:DetachRolePolicy, -iam:GetPolicy, -iam:ListPolicyVersions, -iam:DetachGroupPolicy, -iam:DetachUserPolicy, -iam:CreatePolicyVersion, -iam:DeletePolicyVersion, -iam:AttachGroupPolicy, -iam:AttachUserPolicy, -iam:AttachRolePolicy -``` - -### Delete -```json -iam:DetachRolePolicy, -iam:GetPolicy, -iam:ListPolicyVersions, -iam:DetachGroupPolicy, -iam:DetachUserPolicy, -iam:DeletePolicyVersion, -iam:DeletePolicy, -iam:ListEntitiesForPolicy -``` - diff --git a/docs/awscc-docs/providers/awscc/iam/oidc_provider/index.md b/docs/awscc-docs/providers/awscc/iam/oidc_provider/index.md deleted file mode 100644 index 8af6a7b11f..0000000000 --- a/docs/awscc-docs/providers/awscc/iam/oidc_provider/index.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -client_id_list, -url, -thumbprint_list, -arn, -tags -FROM awscc.iam.oidc_provider -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the oidc_provider resource, the following permissions are required: - -### Read -```json -iam:GetOpenIDConnectProvider -``` - -### Update -```json -iam:UpdateOpenIDConnectProviderThumbprint, -iam:RemoveClientIDFromOpenIDConnectProvider, -iam:AddClientIDToOpenIDConnectProvider, -iam:GetOpenIDConnectProvider, -iam:TagOpenIDConnectProvider, -iam:UntagOpenIDConnectProvider, -iam:ListOpenIDConnectProviderTags -``` - -### Delete -```json -iam:DeleteOpenIDConnectProvider -``` - diff --git a/docs/awscc-docs/providers/awscc/iam/oidc_providers/index.md b/docs/awscc-docs/providers/awscc/iam/oidc_providers/index.md deleted file mode 100644 index 2fb22ab2f3..0000000000 --- a/docs/awscc-docs/providers/awscc/iam/oidc_providers/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.iam.oidc_providers - -``` - -## Permissions - -To operate on the oidc_providers resource, the following permissions are required: - -### Create -```json -iam:CreateOpenIDConnectProvider, -iam:TagOpenIDConnectProvider, -iam:GetOpenIDConnectProvider -``` - -### List -```json -iam:ListOpenIDConnectProvider, -iam:GetOpenIDConnectProvider -``` - diff --git a/docs/awscc-docs/providers/awscc/iam/policies/index.md b/docs/awscc-docs/providers/awscc/iam/policies/index.md deleted file mode 100644 index e43bfa4b9a..0000000000 --- a/docs/awscc-docs/providers/awscc/iam/policies/index.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -title: policies -hide_title: false -hide_table_of_contents: false -keywords: - - 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 ---- -List of policies (requires `aws` provider to be installed) - -## Overview - - - - - -
Namepolicies
TypeResource
DescriptionList of policies (requires `aws` provider to be installed)
Idawscc.iam.policies
- -## Fields - - - - - - - - - - - - - - - - - -
NameDatatypeDescription
policy_namestringThe name for the policy
arnstringThe ARN
attachment_countnumberThe attachment count for the policy
create_datestringThe creation date for the policy
default_version_idstringThe default version id for the policy
descriptionstringThe description for the policy
is_attachablebooleanIs the policy attachable?
pathstringThe path for the policy
permissions_boundary_usage_countnumberThe permissions boundary usage count for the policy
policy_idstringThe id for the policy
tagsarrayTags for the policy
update_datestringThe update date for the policy
regionstring
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -policy_name, -arn, -attachment_count, -create_date, -default_version_id, -description, -is_attachable, -path, -permissions_boundary_usage_count, -policy_id, -tags, -update_date, -region -FROM awscc.iam.policies - -``` - - - - diff --git a/docs/awscc-docs/providers/awscc/iam/role/index.md b/docs/awscc-docs/providers/awscc/iam/role/index.md deleted file mode 100644 index 60c47d0c2f..0000000000 --- a/docs/awscc-docs/providers/awscc/iam/role/index.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -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. - -## 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 = ''; -``` - -## Permissions - -To operate on the role resource, the following permissions are required: - -### Read -```json -iam:GetRole, -iam:ListAttachedRolePolicies, -iam:ListRolePolicies, -iam:GetRolePolicy -``` - -### Update -```json -iam:UpdateRole, -iam:UpdateRoleDescription, -iam:UpdateAssumeRolePolicy, -iam:DetachRolePolicy, -iam:AttachRolePolicy, -iam:DeleteRolePermissionsBoundary, -iam:PutRolePermissionsBoundary, -iam:DeleteRolePolicy, -iam:PutRolePolicy, -iam:TagRole, -iam:UntagRole -``` - -### Delete -```json -iam:DeleteRole, -iam:DetachRolePolicy, -iam:DeleteRolePolicy, -iam:GetRole, -iam:ListAttachedRolePolicies, -iam:ListRolePolicies, -iam:TagRole, -iam:UntagRole -``` - diff --git a/docs/awscc-docs/providers/awscc/iam/role_policies/index.md b/docs/awscc-docs/providers/awscc/iam/role_policies/index.md deleted file mode 100644 index 61f86e0bb8..0000000000 --- a/docs/awscc-docs/providers/awscc/iam/role_policies/index.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -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 ---- -List of policies by RoleName (requires `aws` provider to be installed) - -## Overview - - - - - -
Namerole_policies
TypeResource
DescriptionList of policies by RoleName (requires `aws` provider to be installed)
Idawscc.iam.role_policies
- -## Fields - - - - - - - - -
NameDatatypeDescription
role_namestringThe IAM role name
policy_namestringThe role policy name
policy_documentstringThe role policy document
regionstring
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -role_name, -policy_name, -policy_document, -region -FROM awscc.iam.role_policies -WHERE RoleName = ''; -``` - - - - diff --git a/docs/awscc-docs/providers/awscc/iam/role_policy/index.md b/docs/awscc-docs/providers/awscc/iam/role_policy/index.md deleted file mode 100644 index ced4f9cdb0..0000000000 --- a/docs/awscc-docs/providers/awscc/iam/role_policy/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -policy_document, -policy_name, -role_name -FROM awscc.iam.role_policy -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the role_policy resource, the following permissions are required: - -### Read -```json -iam:GetRolePolicy -``` - -### Update -```json -iam:PutRolePolicy, -iam:GetRolePolicy -``` - -### Delete -```json -iam:DeleteRolePolicy, -iam:GetRolePolicy -``` - diff --git a/docs/awscc-docs/providers/awscc/iam/roles/index.md b/docs/awscc-docs/providers/awscc/iam/roles/index.md deleted file mode 100644 index e0521bd87e..0000000000 --- a/docs/awscc-docs/providers/awscc/iam/roles/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -role_name -FROM awscc.iam.roles - -``` - -## Permissions - -To operate on the roles resource, the following permissions are required: - -### Create -```json -iam:CreateRole, -iam:PutRolePolicy, -iam:AttachRolePolicy, -iam:GetRolePolicy, -iam:TagRole, -iam:UntagRole, -iam:GetRole -``` - -### List -```json -iam:ListRoles -``` - diff --git a/docs/awscc-docs/providers/awscc/iam/saml_provider/index.md b/docs/awscc-docs/providers/awscc/iam/saml_provider/index.md deleted file mode 100644 index 9cbfa2d393..0000000000 --- a/docs/awscc-docs/providers/awscc/iam/saml_provider/index.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -saml_metadata_document, -arn, -tags -FROM awscc.iam.saml_provider -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the saml_provider resource, the following permissions are required: - -### Read -```json -iam:GetSAMLProvider -``` - -### Update -```json -iam:UpdateSAMLProvider, -iam:GetSAMLProvider, -iam:TagSAMLProvider, -iam:ListSAMLProviderTags, -iam:UntagSAMLProvider -``` - -### Delete -```json -iam:DeleteSAMLProvider -``` - diff --git a/docs/awscc-docs/providers/awscc/iam/saml_providers/index.md b/docs/awscc-docs/providers/awscc/iam/saml_providers/index.md deleted file mode 100644 index 8cab8ba1de..0000000000 --- a/docs/awscc-docs/providers/awscc/iam/saml_providers/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.iam.saml_providers - -``` - -## Permissions - -To operate on the saml_providers resource, the following permissions are required: - -### Create -```json -iam:CreateSAMLProvider, -iam:GetSAMLProvider, -iam:TagSAMLProvider -``` - -### List -```json -iam:ListSAMLProviders, -iam:GetSAMLProvider -``` - diff --git a/docs/awscc-docs/providers/awscc/iam/server_certificate/index.md b/docs/awscc-docs/providers/awscc/iam/server_certificate/index.md deleted file mode 100644 index 16bd00a2c7..0000000000 --- a/docs/awscc-docs/providers/awscc/iam/server_certificate/index.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -certificate_body, -certificate_chain, -server_certificate_name, -path, -private_key, -arn, -tags -FROM awscc.iam.server_certificate -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the server_certificate resource, the following permissions are required: - -### Read -```json -iam:GetServerCertificate -``` - -### Update -```json -iam:TagServerCertificate, -iam:UntagServerCertificate, -iam:ListServerCertificateTags, -iam:GetServerCertificate -``` - -### Delete -```json -iam:DeleteServerCertificate -``` - diff --git a/docs/awscc-docs/providers/awscc/iam/server_certificates/index.md b/docs/awscc-docs/providers/awscc/iam/server_certificates/index.md deleted file mode 100644 index 3d8bfab08d..0000000000 --- a/docs/awscc-docs/providers/awscc/iam/server_certificates/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -server_certificate_name -FROM awscc.iam.server_certificates - -``` - -## Permissions - -To operate on the server_certificates resource, the following permissions are required: - -### Create -```json -iam:UploadServerCertificate, -iam:TagServerCertificate, -iam:GetServerCertificate -``` - -### List -```json -iam:ListServerCertificates, -iam:GetServerCertificate -``` - 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 deleted file mode 100644 index befba89df8..0000000000 --- a/docs/awscc-docs/providers/awscc/iam/service_linked_role/index.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -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.
aws_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. - -## Example -```sql -SELECT -region, -role_name, -custom_suffix, -description, -aws_service_name -FROM awscc.iam.service_linked_role -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the service_linked_role resource, the following permissions are required: - -### Read -```json -iam:GetRole -``` - -### Update -```json -iam:UpdateRole, -iam:GetRole -``` - -### Delete -```json -iam:DeleteServiceLinkedRole, -iam:GetServiceLinkedRoleDeletionStatus, -iam:GetRole -``` - diff --git a/docs/awscc-docs/providers/awscc/iam/user/index.md b/docs/awscc-docs/providers/awscc/iam/user/index.md deleted file mode 100644 index 897c14121a..0000000000 --- a/docs/awscc-docs/providers/awscc/iam/user/index.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -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. - -## 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 = ''; -``` - -## Permissions - -To operate on the user resource, the following permissions are required: - -### Read -```json -iam:GetUserPolicy, -iam:ListGroupsForUser, -iam:ListAttachedUserPolicies, -iam:ListUserPolicies, -iam:GetUser, -iam:GetLoginProfile -``` - -### Update -```json -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 -```json -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 -``` - diff --git a/docs/awscc-docs/providers/awscc/iam/user_policies/index.md b/docs/awscc-docs/providers/awscc/iam/user_policies/index.md deleted file mode 100644 index 00bbace171..0000000000 --- a/docs/awscc-docs/providers/awscc/iam/user_policies/index.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -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 ---- -List of user policies by UserName (requires `aws` provider to be installed) - -## Overview - - - - - -
Nameuser_policies
TypeResource
DescriptionList of user policies by UserName (requires `aws` provider to be installed)
Idawscc.iam.user_policies
- -## Fields - - - - - - - -
NameDatatypeDescription
user_namestringThe IAM user name
memberstringThe user policy name
regionstring
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -user_name, -member, -region -FROM awscc.iam.user_policies -WHERE UserName = ''; -``` - - - - diff --git a/docs/awscc-docs/providers/awscc/iam/user_policy/index.md b/docs/awscc-docs/providers/awscc/iam/user_policy/index.md deleted file mode 100644 index 2c5a3d0236..0000000000 --- a/docs/awscc-docs/providers/awscc/iam/user_policy/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -policy_document, -policy_name, -user_name -FROM awscc.iam.user_policy -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the user_policy resource, the following permissions are required: - -### Read -```json -iam:GetUserPolicy -``` - -### Update -```json -iam:PutUserPolicy, -iam:GetUserPolicy -``` - -### Delete -```json -iam:DeleteUserPolicy, -iam:GetUserPolicy -``` - diff --git a/docs/awscc-docs/providers/awscc/iam/users/index.md b/docs/awscc-docs/providers/awscc/iam/users/index.md deleted file mode 100644 index f797c3332e..0000000000 --- a/docs/awscc-docs/providers/awscc/iam/users/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -user_name -FROM awscc.iam.users - -``` - -## Permissions - -To operate on the users resource, the following permissions are required: - -### Create -```json -iam:CreateLoginProfile, -iam:AddUserToGroup, -iam:PutUserPolicy, -iam:AttachUserPolicy, -iam:CreateUser, -iam:GetUser, -iam:TagUser -``` - -### List -```json -iam:listUsers -``` - diff --git a/docs/awscc-docs/providers/awscc/iam/virtualmfa_device/index.md b/docs/awscc-docs/providers/awscc/iam/virtualmfa_device/index.md deleted file mode 100644 index a11bdd2b90..0000000000 --- a/docs/awscc-docs/providers/awscc/iam/virtualmfa_device/index.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -virtual_mfa_device_name, -path, -serial_number, -users, -tags -FROM awscc.iam.virtualmfa_device -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the virtualmfa_device resource, the following permissions are required: - -### Read -```json -iam:ListVirtualMFADevices -``` - -### Update -```json -iam:TagMFADevice, -iam:UntagMFADevice -``` - -### Delete -```json -iam:DeleteVirtualMFADevice, -iam:DeactivateMFADevice -``` - diff --git a/docs/awscc-docs/providers/awscc/iam/virtualmfa_devices/index.md b/docs/awscc-docs/providers/awscc/iam/virtualmfa_devices/index.md deleted file mode 100644 index 80dfb8f036..0000000000 --- a/docs/awscc-docs/providers/awscc/iam/virtualmfa_devices/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -serial_number -FROM awscc.iam.virtualmfa_devices - -``` - -## Permissions - -To operate on the virtualmfa_devices resource, the following permissions are required: - -### Create -```json -iam:CreateVirtualMFADevice, -iam:EnableMFADevice, -iam:ListVirtualMFADevices -``` - -### List -```json -iam:ListVirtualMFADevices -``` - diff --git a/docs/awscc-docs/providers/awscc/identitystore/group/index.md b/docs/awscc-docs/providers/awscc/identitystore/group/index.md deleted file mode 100644 index f83bf0f137..0000000000 --- a/docs/awscc-docs/providers/awscc/identitystore/group/index.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -description, -display_name, -group_id, -identity_store_id -FROM awscc.identitystore.group -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the group resource, the following permissions are required: - -### Read -```json -identitystore:DescribeGroup -``` - -### Update -```json -identitystore:DescribeGroup, -identitystore:UpdateGroup -``` - -### Delete -```json -identitystore:DescribeGroup, -identitystore:DeleteGroup -``` - diff --git a/docs/awscc-docs/providers/awscc/identitystore/group_membership/index.md b/docs/awscc-docs/providers/awscc/identitystore/group_membership/index.md deleted file mode 100644 index cf482c92bf..0000000000 --- a/docs/awscc-docs/providers/awscc/identitystore/group_membership/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -group_id, -identity_store_id, -member_id, -membership_id -FROM awscc.identitystore.group_membership -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the group_membership resource, the following permissions are required: - -### Read -```json -identitystore:DescribeGroupMembership -``` - -### Delete -```json -identitystore:DeleteGroupMembership, -identitystore:DescribeGroupMembership -``` - diff --git a/docs/awscc-docs/providers/awscc/identitystore/group_memberships/index.md b/docs/awscc-docs/providers/awscc/identitystore/group_memberships/index.md deleted file mode 100644 index 1d32ba42b9..0000000000 --- a/docs/awscc-docs/providers/awscc/identitystore/group_memberships/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -membership_id, -identity_store_id -FROM awscc.identitystore.group_memberships -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the group_memberships resource, the following permissions are required: - -### Create -```json -identitystore:CreateGroupMembership, -identitystore:DescribeGroupMembership -``` - -### List -```json -identitystore:ListGroupMemberships -``` - diff --git a/docs/awscc-docs/providers/awscc/identitystore/groups/index.md b/docs/awscc-docs/providers/awscc/identitystore/groups/index.md deleted file mode 100644 index 8652ac5fb1..0000000000 --- a/docs/awscc-docs/providers/awscc/identitystore/groups/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -group_id, -identity_store_id -FROM awscc.identitystore.groups -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the groups resource, the following permissions are required: - -### Create -```json -identitystore:CreateGroup, -identitystore:DescribeGroup -``` - -### List -```json -identitystore:ListGroups -``` - diff --git a/docs/awscc-docs/providers/awscc/identitystore/index.md b/docs/awscc-docs/providers/awscc/identitystore/index.md deleted file mode 100644 index 37ff252a26..0000000000 --- a/docs/awscc-docs/providers/awscc/identitystore/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index abba749947..0000000000 --- a/docs/awscc-docs/providers/awscc/imagebuilder/component/index.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the component resource, the following permissions are required: - -### Read -```json -imagebuilder:GetComponent -``` - -### Delete -```json -imagebuilder:GetComponent, -imagebuilder:UnTagResource, -imagebuilder:DeleteComponent -``` - diff --git a/docs/awscc-docs/providers/awscc/imagebuilder/components/index.md b/docs/awscc-docs/providers/awscc/imagebuilder/components/index.md deleted file mode 100644 index 960c235a6f..0000000000 --- a/docs/awscc-docs/providers/awscc/imagebuilder/components/index.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.imagebuilder.components -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the components resource, the following permissions are required: - -### Create -```json -iam:CreateServiceLinkedRole, -iam:GetRole, -kms:GenerateDataKey*, -kms:Encrypt, -kms:Decrypt, -s3:GetObject, -s3:HeadBucket, -s3:GetBucketLocation, -imagebuilder:TagResource, -imagebuilder:GetComponent, -imagebuilder:CreateComponent -``` - -### List -```json -imagebuilder:ListComponents -``` - diff --git a/docs/awscc-docs/providers/awscc/imagebuilder/container_recipe/index.md b/docs/awscc-docs/providers/awscc/imagebuilder/container_recipe/index.md deleted file mode 100644 index f4eae70779..0000000000 --- a/docs/awscc-docs/providers/awscc/imagebuilder/container_recipe/index.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the container_recipe resource, the following permissions are required: - -### Read -```json -imagebuilder:GetContainerRecipe -``` - -### Delete -```json -imagebuilder:UnTagResource, -imagebuilder:GetContainerRecipe, -imagebuilder:DeleteContainerRecipe -``` - diff --git a/docs/awscc-docs/providers/awscc/imagebuilder/container_recipes/index.md b/docs/awscc-docs/providers/awscc/imagebuilder/container_recipes/index.md deleted file mode 100644 index ca7869fcc0..0000000000 --- a/docs/awscc-docs/providers/awscc/imagebuilder/container_recipes/index.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.imagebuilder.container_recipes -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the container_recipes resource, the following permissions are required: - -### Create -```json -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 -```json -imagebuilder:ListContainerRecipes -``` - diff --git a/docs/awscc-docs/providers/awscc/imagebuilder/distribution_configuration/index.md b/docs/awscc-docs/providers/awscc/imagebuilder/distribution_configuration/index.md deleted file mode 100644 index 7f528d602c..0000000000 --- a/docs/awscc-docs/providers/awscc/imagebuilder/distribution_configuration/index.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -name, -description, -distributions, -tags -FROM awscc.imagebuilder.distribution_configuration -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the distribution_configuration resource, the following permissions are required: - -### Update -```json -ec2:DescribeLaunchTemplates, -ec2:CreateLaunchTemplateVersion, -ec2:ModifyLaunchTemplate, -imagebuilder:GetDistributionConfiguration, -imagebuilder:UpdateDistributionConfiguration -``` - -### Read -```json -imagebuilder:GetDistributionConfiguration -``` - -### Delete -```json -imagebuilder:GetDistributionConfiguration, -imagebuilder:UnTagResource, -imagebuilder:DeleteDistributionConfiguration -``` - diff --git a/docs/awscc-docs/providers/awscc/imagebuilder/distribution_configurations/index.md b/docs/awscc-docs/providers/awscc/imagebuilder/distribution_configurations/index.md deleted file mode 100644 index 5ce3aa1d85..0000000000 --- a/docs/awscc-docs/providers/awscc/imagebuilder/distribution_configurations/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.imagebuilder.distribution_configurations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the distribution_configurations resource, the following permissions are required: - -### Create -```json -iam:GetRole, -iam:CreateServiceLinkedRole, -ec2:DescribeLaunchTemplates, -ec2:CreateLaunchTemplateVersion, -ec2:ModifyLaunchTemplate, -imagebuilder:TagResource, -imagebuilder:GetDistributionConfiguration, -imagebuilder:CreateDistributionConfiguration -``` - -### List -```json -imagebuilder:ListDistributionConfigurations -``` - diff --git a/docs/awscc-docs/providers/awscc/imagebuilder/image/index.md b/docs/awscc-docs/providers/awscc/imagebuilder/image/index.md deleted file mode 100644 index e498f877f4..0000000000 --- a/docs/awscc-docs/providers/awscc/imagebuilder/image/index.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the image resource, the following permissions are required: - -### Read -```json -imagebuilder:GetImage -``` - -### Delete -```json -imagebuilder:GetImage, -imagebuilder:DeleteImage, -imagebuilder:UnTagResource, -imagebuilder:CancelImageCreation -``` - diff --git a/docs/awscc-docs/providers/awscc/imagebuilder/image_pipeline/index.md b/docs/awscc-docs/providers/awscc/imagebuilder/image_pipeline/index.md deleted file mode 100644 index e2b240ba75..0000000000 --- a/docs/awscc-docs/providers/awscc/imagebuilder/image_pipeline/index.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the image_pipeline resource, the following permissions are required: - -### Update -```json -iam:PassRole, -imagebuilder:GetImagePipeline, -imagebuilder:UpdateImagePipeline, -imagebuilder:GetWorkflow -``` - -### Read -```json -imagebuilder:GetImagePipeline -``` - -### Delete -```json -imagebuilder:UnTagResource, -imagebuilder:GetImagePipeline, -imagebuilder:DeleteImagePipeline -``` - diff --git a/docs/awscc-docs/providers/awscc/imagebuilder/image_pipelines/index.md b/docs/awscc-docs/providers/awscc/imagebuilder/image_pipelines/index.md deleted file mode 100644 index 1f8bf9874e..0000000000 --- a/docs/awscc-docs/providers/awscc/imagebuilder/image_pipelines/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.imagebuilder.image_pipelines -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the image_pipelines resource, the following permissions are required: - -### Create -```json -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 -```json -imagebuilder:ListImagePipelines -``` - diff --git a/docs/awscc-docs/providers/awscc/imagebuilder/image_recipe/index.md b/docs/awscc-docs/providers/awscc/imagebuilder/image_recipe/index.md deleted file mode 100644 index e3f36c163b..0000000000 --- a/docs/awscc-docs/providers/awscc/imagebuilder/image_recipe/index.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the image_recipe resource, the following permissions are required: - -### Read -```json -imagebuilder:GetImageRecipe -``` - -### Delete -```json -imagebuilder:UnTagResource, -imagebuilder:GetImageRecipe, -imagebuilder:DeleteImageRecipe -``` - diff --git a/docs/awscc-docs/providers/awscc/imagebuilder/image_recipes/index.md b/docs/awscc-docs/providers/awscc/imagebuilder/image_recipes/index.md deleted file mode 100644 index 346cd42a3f..0000000000 --- a/docs/awscc-docs/providers/awscc/imagebuilder/image_recipes/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.imagebuilder.image_recipes -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the image_recipes resource, the following permissions are required: - -### Create -```json -iam:GetRole, -iam:CreateServiceLinkedRole, -imagebuilder:GetComponent, -imagebuilder:GetImage, -imagebuilder:TagResource, -imagebuilder:GetImageRecipe, -imagebuilder:CreateImageRecipe, -ec2:DescribeImages -``` - -### List -```json -imagebuilder:ListImageRecipes -``` - diff --git a/docs/awscc-docs/providers/awscc/imagebuilder/images/index.md b/docs/awscc-docs/providers/awscc/imagebuilder/images/index.md deleted file mode 100644 index a1fc022886..0000000000 --- a/docs/awscc-docs/providers/awscc/imagebuilder/images/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.imagebuilder.images -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the images resource, the following permissions are required: - -### Create -```json -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 -```json -imagebuilder:ListImages -``` - diff --git a/docs/awscc-docs/providers/awscc/imagebuilder/index.md b/docs/awscc-docs/providers/awscc/imagebuilder/index.md deleted file mode 100644 index 9e8923744e..0000000000 --- a/docs/awscc-docs/providers/awscc/imagebuilder/index.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -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 deleted file mode 100644 index 3c3391be44..0000000000 --- a/docs/awscc-docs/providers/awscc/imagebuilder/infrastructure_configuration/index.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the infrastructure_configuration resource, the following permissions are required: - -### Update -```json -iam:PassRole, -sns:Publish, -imagebuilder:GetInfrastructureConfiguration, -imagebuilder:UpdateInfrastructureConfiguration -``` - -### Read -```json -imagebuilder:GetInfrastructureConfiguration -``` - -### Delete -```json -imagebuilder:UnTagResource, -imagebuilder:GetInfrastructureConfiguration, -imagebuilder:DeleteInfrastructureConfiguration -``` - diff --git a/docs/awscc-docs/providers/awscc/imagebuilder/infrastructure_configurations/index.md b/docs/awscc-docs/providers/awscc/imagebuilder/infrastructure_configurations/index.md deleted file mode 100644 index baa997af84..0000000000 --- a/docs/awscc-docs/providers/awscc/imagebuilder/infrastructure_configurations/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.imagebuilder.infrastructure_configurations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the infrastructure_configurations resource, the following permissions are required: - -### Create -```json -iam:PassRole, -iam:GetRole, -iam:GetInstanceProfile, -iam:CreateServiceLinkedRole, -sns:Publish, -imagebuilder:TagResource, -imagebuilder:GetInfrastructureConfiguration, -imagebuilder:CreateInfrastructureConfiguration -``` - -### List -```json -imagebuilder:ListInfrastructureConfigurations -``` - diff --git a/docs/awscc-docs/providers/awscc/imagebuilder/lifecycle_policies/index.md b/docs/awscc-docs/providers/awscc/imagebuilder/lifecycle_policies/index.md deleted file mode 100644 index b84b29ac62..0000000000 --- a/docs/awscc-docs/providers/awscc/imagebuilder/lifecycle_policies/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.imagebuilder.lifecycle_policies -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the lifecycle_policies resource, the following permissions are required: - -### Create -```json -iam:PassRole, -imagebuilder:CreateLifecyclePolicy, -imagebuilder:GetLifecyclePolicy, -imagebuilder:TagResource -``` - -### List -```json -imagebuilder:ListLifecyclePolicies -``` - diff --git a/docs/awscc-docs/providers/awscc/imagebuilder/lifecycle_policy/index.md b/docs/awscc-docs/providers/awscc/imagebuilder/lifecycle_policy/index.md deleted file mode 100644 index 4e423161fd..0000000000 --- a/docs/awscc-docs/providers/awscc/imagebuilder/lifecycle_policy/index.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -name, -description, -status, -execution_role, -resource_type, -policy_details, -resource_selection, -tags -FROM awscc.imagebuilder.lifecycle_policy -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the lifecycle_policy resource, the following permissions are required: - -### Update -```json -iam:PassRole, -imagebuilder:GetLifecyclePolicy, -imagebuilder:UpdateLifecyclePolicy -``` - -### Read -```json -imagebuilder:GetLifecyclePolicy -``` - -### Delete -```json -imagebuilder:GetLifecyclePolicy, -imagebuilder:DeleteLifecyclePolicy, -imagebuilder:UnTagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/imagebuilder/workflow/index.md b/docs/awscc-docs/providers/awscc/imagebuilder/workflow/index.md deleted file mode 100644 index ca10fa9e79..0000000000 --- a/docs/awscc-docs/providers/awscc/imagebuilder/workflow/index.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -name, -version, -description, -change_description, -type, -data, -uri, -kms_key_id, -tags -FROM awscc.imagebuilder.workflow -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the workflow resource, the following permissions are required: - -### Read -```json -imagebuilder:GetWorkflow -``` - -### Delete -```json -imagebuilder:GetWorkflow, -imagebuilder:UnTagResource, -imagebuilder:DeleteWorkflow -``` - diff --git a/docs/awscc-docs/providers/awscc/imagebuilder/workflows/index.md b/docs/awscc-docs/providers/awscc/imagebuilder/workflows/index.md deleted file mode 100644 index d8df3dfc5c..0000000000 --- a/docs/awscc-docs/providers/awscc/imagebuilder/workflows/index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.imagebuilder.workflows -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the workflows resource, the following permissions are required: - -### Create -```json -iam:GetRole, -kms:GenerateDataKey*, -kms:Encrypt, -kms:Decrypt, -s3:GetObject, -s3:HeadBucket, -s3:GetBucketLocation, -imagebuilder:TagResource, -imagebuilder:GetWorkflow, -imagebuilder:CreateWorkflow -``` - -### List -```json -imagebuilder:ListWorkflows -``` - diff --git a/docs/awscc-docs/providers/awscc/inspector/assessment_target/index.md b/docs/awscc-docs/providers/awscc/inspector/assessment_target/index.md deleted file mode 100644 index 989d8d21f5..0000000000 --- a/docs/awscc-docs/providers/awscc/inspector/assessment_target/index.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -assessment_target_name, -resource_group_arn -FROM awscc.inspector.assessment_target -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the assessment_target resource, the following permissions are required: - -### Update -```json -inspector:DescribeAssessmentTargets, -inspector:UpdateAssessmentTarget -``` - -### Read -```json -inspector:DescribeAssessmentTargets -``` - -### Delete -```json -inspector:DeleteAssessmentTarget -``` - diff --git a/docs/awscc-docs/providers/awscc/inspector/assessment_targets/index.md b/docs/awscc-docs/providers/awscc/inspector/assessment_targets/index.md deleted file mode 100644 index fb7fc890db..0000000000 --- a/docs/awscc-docs/providers/awscc/inspector/assessment_targets/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.inspector.assessment_targets -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the assessment_targets resource, the following permissions are required: - -### Create -```json -inspector:CreateAssessmentTarget, -inspector:ListAssessmentTargets, -inspector:DescribeAssessmentTargets -``` - -### List -```json -inspector:ListAssessmentTargets -``` - diff --git a/docs/awscc-docs/providers/awscc/inspector/assessment_template/index.md b/docs/awscc-docs/providers/awscc/inspector/assessment_template/index.md deleted file mode 100644 index 770b6b2d18..0000000000 --- a/docs/awscc-docs/providers/awscc/inspector/assessment_template/index.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the assessment_template resource, the following permissions are required: - -### Read -```json -inspector:DescribeAssessmentTemplates -``` - -### Delete -```json -inspector:DeleteAssessmentTemplate -``` - diff --git a/docs/awscc-docs/providers/awscc/inspector/assessment_templates/index.md b/docs/awscc-docs/providers/awscc/inspector/assessment_templates/index.md deleted file mode 100644 index 803daf12d7..0000000000 --- a/docs/awscc-docs/providers/awscc/inspector/assessment_templates/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.inspector.assessment_templates -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the assessment_templates resource, the following permissions are required: - -### Create -```json -inspector:CreateAssessmentTemplate, -inspector:ListAssessmentTemplates, -inspector:DescribeAssessmentTemplates -``` - -### List -```json -inspector:ListAssessmentTemplates -``` - diff --git a/docs/awscc-docs/providers/awscc/inspector/index.md b/docs/awscc-docs/providers/awscc/inspector/index.md deleted file mode 100644 index f35cae52e2..0000000000 --- a/docs/awscc-docs/providers/awscc/inspector/index.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -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: 5
-total selectable resources: 5
-total methods: 5
-
-
- -::: - -## Resources -
-
-assessment_target
-assessment_targets
-assessment_template -
-
-assessment_templates
-resource_group -
-
\ 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 deleted file mode 100644 index 453b9ab0ba..0000000000 --- a/docs/awscc-docs/providers/awscc/inspector/resource_group/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -resource_group_tags -FROM awscc.inspector.resource_group -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the resource_group resource, the following permissions are required: - -### Read -```json -inspector:CreateResourceGroup -``` - -### Delete -```json -inspector:CreateResourceGroup -``` - 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 deleted file mode 100644 index a6f15e2bc5..0000000000 --- a/docs/awscc-docs/providers/awscc/inspectorv2/cis_scan_configuration/index.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -scan_name, -security_level, -schedule, -targets, -arn, -tags -FROM awscc.inspectorv2.cis_scan_configuration -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the cis_scan_configuration resource, the following permissions are required: - -### Read -```json -inspector2:ListCisScanConfigurations, -inspector2:ListTagsForResource -``` - -### Update -```json -inspector2:ListCisScanConfigurations, -inspector2:UpdateCisScanConfiguration, -inspector2:TagResource, -inspector2:UntagResource, -inspector2:ListTagsForResource -``` - -### Delete -```json -inspector2:ListCisScanConfigurations, -inspector2:DeleteCisScanConfiguration, -inspector2:UntagResource -``` - 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 deleted file mode 100644 index 49e6fab7df..0000000000 --- a/docs/awscc-docs/providers/awscc/inspectorv2/cis_scan_configurations/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.inspectorv2.cis_scan_configurations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the cis_scan_configurations resource, the following permissions are required: - -### Create -```json -inspector2:CreateCisScanConfiguration, -inspector2:ListCisScanConfigurations, -inspector2:TagResource -``` - -### List -```json -inspector2:ListCisScanConfigurations, -inspector2:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/inspectorv2/filter/index.md b/docs/awscc-docs/providers/awscc/inspectorv2/filter/index.md deleted file mode 100644 index 984208cff9..0000000000 --- a/docs/awscc-docs/providers/awscc/inspectorv2/filter/index.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -description, -filter_criteria, -filter_action, -arn -FROM awscc.inspectorv2.filter -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the filter resource, the following permissions are required: - -### Read -```json -inspector2:ListFilters -``` - -### Update -```json -inspector2:ListFilters, -inspector2:UpdateFilter -``` - -### Delete -```json -inspector2:DeleteFilter, -inspector2:ListFilters -``` - diff --git a/docs/awscc-docs/providers/awscc/inspectorv2/filters/index.md b/docs/awscc-docs/providers/awscc/inspectorv2/filters/index.md deleted file mode 100644 index 74d25d2fae..0000000000 --- a/docs/awscc-docs/providers/awscc/inspectorv2/filters/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.inspectorv2.filters -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the filters resource, the following permissions are required: - -### Create -```json -inspector2:CreateFilter, -inspector2:ListFilters -``` - -### List -```json -inspector2:ListFilters -``` - diff --git a/docs/awscc-docs/providers/awscc/inspectorv2/index.md b/docs/awscc-docs/providers/awscc/inspectorv2/index.md deleted file mode 100644 index 10b99c3b69..0000000000 --- a/docs/awscc-docs/providers/awscc/inspectorv2/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index c959a8d368..0000000000 --- a/docs/awscc-docs/providers/awscc/internetmonitor/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 deleted file mode 100644 index d11435995e..0000000000 --- a/docs/awscc-docs/providers/awscc/internetmonitor/monitor/index.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the monitor resource, the following permissions are required: - -### Read -```json -internetmonitor:GetMonitor, -internetmonitor:ListTagsForResource, -logs:GetLogDelivery -``` - -### Update -```json -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 -```json -internetmonitor:UpdateMonitor, -internetmonitor:DeleteMonitor, -internetmonitor:GetMonitor, -logs:DeleteLogDelivery -``` - diff --git a/docs/awscc-docs/providers/awscc/internetmonitor/monitors/index.md b/docs/awscc-docs/providers/awscc/internetmonitor/monitors/index.md deleted file mode 100644 index c7b8270794..0000000000 --- a/docs/awscc-docs/providers/awscc/internetmonitor/monitors/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -monitor_name -FROM awscc.internetmonitor.monitors -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the monitors resource, the following permissions are required: - -### Create -```json -internetmonitor:CreateMonitor, -internetmonitor:GetMonitor, -internetmonitor:TagResource, -internetmonitor:UntagResource, -logs:CreateLogDelivery, -logs:GetLogDelivery, -s3:GetBucketPolicy, -s3:PutBucketPolicy, -s3:ListBucket, -iam:PassRole -``` - -### List -```json -internetmonitor:ListMonitors, -internetmonitor:GetMonitor, -logs:GetLogDelivery -``` - 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 deleted file mode 100644 index f6b9b39f8f..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/account_audit_configuration/index.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -account_id, -audit_check_configurations, -audit_notification_target_configurations, -role_arn -FROM awscc.iot.account_audit_configuration -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the account_audit_configuration resource, the following permissions are required: - -### Read -```json -iot:DescribeAccountAuditConfiguration -``` - -### Update -```json -iot:UpdateAccountAuditConfiguration, -iot:DescribeAccountAuditConfiguration, -iam:PassRole -``` - -### Delete -```json -iot:DescribeAccountAuditConfiguration, -iot:DeleteAccountAuditConfiguration -``` - 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 deleted file mode 100644 index fd5e76af9a..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/account_audit_configurations/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -account_id -FROM awscc.iot.account_audit_configurations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the account_audit_configurations resource, the following permissions are required: - -### Create -```json -iot:UpdateAccountAuditConfiguration, -iot:DescribeAccountAuditConfiguration, -iam:PassRole -``` - -### List -```json -iot:DescribeAccountAuditConfiguration -``` - diff --git a/docs/awscc-docs/providers/awscc/iot/authorizer/index.md b/docs/awscc-docs/providers/awscc/iot/authorizer/index.md deleted file mode 100644 index 6a4ad7e9ca..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/authorizer/index.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the authorizer resource, the following permissions are required: - -### Read -```json -iot:DescribeAuthorizer, -iot:ListTagsForResource -``` - -### Update -```json -iot:UpdateAuthorizer, -iot:DescribeAuthorizer, -iot:TagResource, -iot:UntagResource, -iot:ListTagsForResource -``` - -### Delete -```json -iot:UpdateAuthorizer, -iot:DeleteAuthorizer, -iot:DescribeAuthorizer -``` - diff --git a/docs/awscc-docs/providers/awscc/iot/authorizers/index.md b/docs/awscc-docs/providers/awscc/iot/authorizers/index.md deleted file mode 100644 index 5fa3d44546..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/authorizers/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -authorizer_name -FROM awscc.iot.authorizers -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the authorizers resource, the following permissions are required: - -### Create -```json -iot:CreateAuthorizer, -iot:DescribeAuthorizer, -iot:TagResource, -iot:ListTagsForResource -``` - -### List -```json -iot:ListAuthorizers -``` - diff --git a/docs/awscc-docs/providers/awscc/iot/billing_group/index.md b/docs/awscc-docs/providers/awscc/iot/billing_group/index.md deleted file mode 100644 index 104d871a43..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/billing_group/index.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id, -arn, -billing_group_name, -tags, -billing_group_properties -FROM awscc.iot.billing_group -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the billing_group resource, the following permissions are required: - -### Delete -```json -iot:DescribeBillingGroup, -iot:DeleteBillingGroup -``` - -### Read -```json -iot:DescribeBillingGroup, -iot:ListTagsForResource -``` - -### Update -```json -iot:DescribeBillingGroup, -iot:UpdateBillingGroup, -iot:ListTagsForResource, -iot:TagResource, -iot:UntagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/iot/billing_groups/index.md b/docs/awscc-docs/providers/awscc/iot/billing_groups/index.md deleted file mode 100644 index 8827ece045..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/billing_groups/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -billing_group_name -FROM awscc.iot.billing_groups -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the billing_groups resource, the following permissions are required: - -### Create -```json -iot:DescribeBillingGroup, -iot:ListTagsForResource, -iot:CreateBillingGroup, -iot:TagResource -``` - -### List -```json -iot:ListBillingGroups, -iot:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/iot/ca_certificate/index.md b/docs/awscc-docs/providers/awscc/iot/ca_certificate/index.md deleted file mode 100644 index c176f56e9e..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/ca_certificate/index.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -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
ca_certificate_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. - -## Example -```sql -SELECT -region, -ca_certificate_pem, -verification_certificate_pem, -status, -certificate_mode, -auto_registration_status, -remove_auto_registration, -registration_config, -id, -arn, -tags -FROM awscc.iot.ca_certificate -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the ca_certificate resource, the following permissions are required: - -### Read -```json -iot:DescribeCACertificate, -iot:ListTagsForResource -``` - -### Update -```json -iam:GetRole, -iam:PassRole, -iot:UpdateCACertificate, -iot:DescribeCACertificate, -iot:TagResource, -iot:UntagResource, -iot:ListTagsForResource -``` - -### Delete -```json -iot:UpdateCACertificate, -iot:DeleteCACertificate, -iot:DescribeCACertificate -``` - diff --git a/docs/awscc-docs/providers/awscc/iot/ca_certificates/index.md b/docs/awscc-docs/providers/awscc/iot/ca_certificates/index.md deleted file mode 100644 index 5da5286df8..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/ca_certificates/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.iot.ca_certificates -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the ca_certificates resource, the following permissions are required: - -### Create -```json -iam:GetRole, -iam:PassRole, -iot:RegisterCACertificate, -iot:DescribeCACertificate, -iot:TagResource, -iot:ListTagsForResource -``` - -### List -```json -iot:ListCACertificates -``` - diff --git a/docs/awscc-docs/providers/awscc/iot/certificate/index.md b/docs/awscc-docs/providers/awscc/iot/certificate/index.md deleted file mode 100644 index 7fc8ad1380..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/certificate/index.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -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
ca_certificate_pemstring
certificate_pemstring
certificate_signing_requeststring
certificate_modestring
statusstring
idstring
arnstring
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -ca_certificate_pem, -certificate_pem, -certificate_signing_request, -certificate_mode, -status, -id, -arn -FROM awscc.iot.certificate -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the certificate resource, the following permissions are required: - -### Read -```json -iot:DescribeCertificate -``` - -### Update -```json -iot:UpdateCertificate, -iot:DescribeCertificate -``` - -### Delete -```json -iot:DeleteCertificate, -iot:UpdateCertificate, -iot:DescribeCertificate -``` - diff --git a/docs/awscc-docs/providers/awscc/iot/certificate_provider/index.md b/docs/awscc-docs/providers/awscc/iot/certificate_provider/index.md deleted file mode 100644 index a124579d60..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/certificate_provider/index.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -certificate_provider_name, -lambda_function_arn, -account_default_for_operations, -tags, -arn -FROM awscc.iot.certificate_provider -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the certificate_provider resource, the following permissions are required: - -### Read -```json -iot:DescribeCertificateProvider, -iot:ListTagsForResource -``` - -### Update -```json -iot:UpdateCertificateProvider, -iot:DescribeCertificateProvider, -iot:TagResource, -iot:UntagResource, -iot:ListTagsForResource -``` - -### Delete -```json -iot:DeleteCertificateProvider, -iot:DescribeCertificateProvider -``` - diff --git a/docs/awscc-docs/providers/awscc/iot/certificate_providers/index.md b/docs/awscc-docs/providers/awscc/iot/certificate_providers/index.md deleted file mode 100644 index 001b0374c6..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/certificate_providers/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -certificate_provider_name -FROM awscc.iot.certificate_providers -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the certificate_providers resource, the following permissions are required: - -### Create -```json -iot:CreateCertificateProvider, -iot:DescribeCertificateProvider, -iot:TagResource, -iot:ListTagsForResource -``` - -### List -```json -iot:ListCertificateProviders -``` - diff --git a/docs/awscc-docs/providers/awscc/iot/certificates/index.md b/docs/awscc-docs/providers/awscc/iot/certificates/index.md deleted file mode 100644 index cd88b4cce1..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/certificates/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.iot.certificates -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the certificates resource, the following permissions are required: - -### Create -```json -iot:CreateCertificateFromCsr, -iot:RegisterCertificate, -iot:RegisterCertificateWithoutCA, -iot:DescribeCertificate -``` - -### List -```json -iot:ListCertificates -``` - diff --git a/docs/awscc-docs/providers/awscc/iot/custom_metric/index.md b/docs/awscc-docs/providers/awscc/iot/custom_metric/index.md deleted file mode 100644 index b5671a4c01..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/custom_metric/index.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -metric_name, -display_name, -metric_type, -metric_arn, -tags -FROM awscc.iot.custom_metric -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the custom_metric resource, the following permissions are required: - -### Read -```json -iot:DescribeCustomMetric, -iot:ListTagsForResource -``` - -### Update -```json -iot:UpdateCustomMetric, -iot:ListTagsForResource, -iot:UntagResource, -iot:TagResource -``` - -### Delete -```json -iot:DescribeCustomMetric, -iot:DeleteCustomMetric -``` - diff --git a/docs/awscc-docs/providers/awscc/iot/custom_metrics/index.md b/docs/awscc-docs/providers/awscc/iot/custom_metrics/index.md deleted file mode 100644 index 44b9b90f92..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/custom_metrics/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -metric_name -FROM awscc.iot.custom_metrics -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the custom_metrics resource, the following permissions are required: - -### Create -```json -iot:CreateCustomMetric, -iot:TagResource -``` - -### List -```json -iot:ListCustomMetrics -``` - diff --git a/docs/awscc-docs/providers/awscc/iot/dimension/index.md b/docs/awscc-docs/providers/awscc/iot/dimension/index.md deleted file mode 100644 index c74905695d..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/dimension/index.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -type, -string_values, -tags, -arn -FROM awscc.iot.dimension -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the dimension resource, the following permissions are required: - -### Read -```json -iot:DescribeDimension, -iot:ListTagsForResource -``` - -### Update -```json -iot:UpdateDimension, -iot:ListTagsForResource, -iot:UntagResource, -iot:TagResource -``` - -### Delete -```json -iot:DescribeDimension, -iot:DeleteDimension -``` - diff --git a/docs/awscc-docs/providers/awscc/iot/dimensions/index.md b/docs/awscc-docs/providers/awscc/iot/dimensions/index.md deleted file mode 100644 index a2ff3408be..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/dimensions/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.iot.dimensions -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the dimensions resource, the following permissions are required: - -### Create -```json -iot:CreateDimension, -iot:TagResource -``` - -### List -```json -iot:ListDimensions -``` - diff --git a/docs/awscc-docs/providers/awscc/iot/domain_configuration/index.md b/docs/awscc-docs/providers/awscc/iot/domain_configuration/index.md deleted file mode 100644 index 2cf8eb05b5..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/domain_configuration/index.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the domain_configuration resource, the following permissions are required: - -### Read -```json -iot:DescribeDomainConfiguration, -iot:ListTagsForResource -``` - -### Update -```json -iot:UpdateDomainConfiguration, -iot:DescribeDomainConfiguration, -iot:ListTagsForResource, -iot:TagResource, -iot:UntagResource -``` - -### Delete -```json -iot:DescribeDomainConfiguration, -iot:DeleteDomainConfiguration, -iot:UpdateDomainConfiguration -``` - diff --git a/docs/awscc-docs/providers/awscc/iot/domain_configurations/index.md b/docs/awscc-docs/providers/awscc/iot/domain_configurations/index.md deleted file mode 100644 index 1a9bf82c5c..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/domain_configurations/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -domain_configuration_name -FROM awscc.iot.domain_configurations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the domain_configurations resource, the following permissions are required: - -### Create -```json -iot:CreateDomainConfiguration, -iot:UpdateDomainConfiguration, -iot:DescribeDomainConfiguration, -iot:TagResource, -iot:ListTagsForResource, -acm:GetCertificate -``` - -### List -```json -iot:ListDomainConfigurations -``` - diff --git a/docs/awscc-docs/providers/awscc/iot/fleet_metric/index.md b/docs/awscc-docs/providers/awscc/iot/fleet_metric/index.md deleted file mode 100644 index 1e95c3434f..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/fleet_metric/index.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the fleet_metric resource, the following permissions are required: - -### Read -```json -iot:DescribeFleetMetric, -iot:ListTagsForResource -``` - -### Update -```json -iot:UpdateFleetMetric, -iot:DescribeFleetMetric, -iot:ListTagsForResource, -iot:UntagResource, -iot:TagResource -``` - -### Delete -```json -iot:DeleteFleetMetric, -iot:DescribeFleetMetric -``` - diff --git a/docs/awscc-docs/providers/awscc/iot/fleet_metrics/index.md b/docs/awscc-docs/providers/awscc/iot/fleet_metrics/index.md deleted file mode 100644 index 4bb03dc480..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/fleet_metrics/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -metric_name -FROM awscc.iot.fleet_metrics -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the fleet_metrics resource, the following permissions are required: - -### Create -```json -iot:CreateFleetMetric, -iot:DescribeFleetMetric, -iot:TagResource -``` - -### List -```json -iot:ListFleetMetrics -``` - diff --git a/docs/awscc-docs/providers/awscc/iot/index.md b/docs/awscc-docs/providers/awscc/iot/index.md deleted file mode 100644 index 89fd438b32..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/index.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -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 deleted file mode 100644 index 0d7a646818..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/job_template/index.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the job_template resource, the following permissions are required: - -### Read -```json -iot:DescribeJobTemplate -``` - -### Delete -```json -iot:DeleteJobTemplate -``` - diff --git a/docs/awscc-docs/providers/awscc/iot/job_templates/index.md b/docs/awscc-docs/providers/awscc/iot/job_templates/index.md deleted file mode 100644 index 00cfdc0387..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/job_templates/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -job_template_id -FROM awscc.iot.job_templates -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the job_templates resource, the following permissions are required: - -### Create -```json -iot:CreateJobTemplate, -iam:PassRole, -s3:GetObject, -iot:TagResource -``` - -### List -```json -iot:ListJobTemplates -``` - diff --git a/docs/awscc-docs/providers/awscc/iot/logging/index.md b/docs/awscc-docs/providers/awscc/iot/logging/index.md deleted file mode 100644 index 3ec79418c9..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/logging/index.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -account_id, -role_arn, -default_log_level -FROM awscc.iot.logging -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the logging resource, the following permissions are required: - -### Read -```json -iot:GetV2LoggingOptions -``` - -### Update -```json -iot:SetV2LoggingOptions, -iot:GetV2LoggingOptions, -iam:PassRole -``` - -### Delete -```json -iot:SetV2LoggingOptions, -iot:GetV2LoggingOptions -``` - diff --git a/docs/awscc-docs/providers/awscc/iot/loggings/index.md b/docs/awscc-docs/providers/awscc/iot/loggings/index.md deleted file mode 100644 index 13a938952a..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/loggings/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -account_id -FROM awscc.iot.loggings -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the loggings resource, the following permissions are required: - -### Create -```json -iot:SetV2LoggingOptions, -iot:GetV2LoggingOptions, -iam:PassRole -``` - -### List -```json -iot:GetV2LoggingOptions -``` - diff --git a/docs/awscc-docs/providers/awscc/iot/mitigation_action/index.md b/docs/awscc-docs/providers/awscc/iot/mitigation_action/index.md deleted file mode 100644 index 01b526d37d..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/mitigation_action/index.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -action_name, -role_arn, -tags, -action_params, -mitigation_action_arn, -mitigation_action_id -FROM awscc.iot.mitigation_action -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the mitigation_action resource, the following permissions are required: - -### Read -```json -iot:DescribeMitigationAction, -iot:ListTagsForResource -``` - -### Update -```json -iot:UpdateMitigationAction, -iot:ListTagsForResource, -iot:UntagResource, -iot:TagResource, -iam:PassRole -``` - -### Delete -```json -iot:DescribeMitigationAction, -iot:DeleteMitigationAction -``` - diff --git a/docs/awscc-docs/providers/awscc/iot/mitigation_actions/index.md b/docs/awscc-docs/providers/awscc/iot/mitigation_actions/index.md deleted file mode 100644 index c5e547407f..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/mitigation_actions/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -action_name -FROM awscc.iot.mitigation_actions -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the mitigation_actions resource, the following permissions are required: - -### Create -```json -iot:CreateMitigationAction, -iot:DescribeMitigationAction, -iot:TagResource, -iam:PassRole -``` - -### List -```json -iot:ListMitigationActions -``` - diff --git a/docs/awscc-docs/providers/awscc/iot/policies/index.md b/docs/awscc-docs/providers/awscc/iot/policies/index.md deleted file mode 100644 index 87abae9505..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/policies/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.iot.policies -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the policies resource, the following permissions are required: - -### Create -```json -iot:CreatePolicy, -iot:GetPolicy, -iot:TagResource, -iot:ListTagsForResource -``` - -### List -```json -iot:ListPolicies -``` - diff --git a/docs/awscc-docs/providers/awscc/iot/policy/index.md b/docs/awscc-docs/providers/awscc/iot/policy/index.md deleted file mode 100644 index e7137a094a..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/policy/index.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id, -arn, -policy_document, -policy_name, -tags -FROM awscc.iot.policy -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the policy resource, the following permissions are required: - -### Read -```json -iot:GetPolicy, -iot:ListTagsForResource -``` - -### Delete -```json -iot:DeletePolicy, -iot:GetPolicy, -iot:ListPolicyVersions, -iot:DeletePolicyVersion -``` - -### Update -```json -iot:GetPolicy, -iot:ListPolicyVersions, -iot:CreatePolicyVersion, -iot:DeletePolicyVersion, -iot:SetDefaultPolicyVersion, -iot:TagResource, -iot:UntagResource, -iot:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/iot/provisioning_template/index.md b/docs/awscc-docs/providers/awscc/iot/provisioning_template/index.md deleted file mode 100644 index b592e60fbb..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/provisioning_template/index.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the provisioning_template resource, the following permissions are required: - -### Read -```json -iot:DescribeProvisioningTemplate, -iot:ListTagsForResource -``` - -### Update -```json -iam:GetRole, -iam:PassRole, -iot:UpdateProvisioningTemplate, -iot:CreateProvisioningTemplateVersion, -iot:ListProvisioningTemplateVersions, -iot:DeleteProvisioningTemplateVersion, -iot:DescribeProvisioningTemplate, -iot:TagResource, -iot:UntagResource, -iot:ListTagsForResource -``` - -### Delete -```json -iot:DeleteProvisioningTemplate, -iot:DescribeProvisioningTemplate -``` - diff --git a/docs/awscc-docs/providers/awscc/iot/provisioning_templates/index.md b/docs/awscc-docs/providers/awscc/iot/provisioning_templates/index.md deleted file mode 100644 index fcdf4f0e15..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/provisioning_templates/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -template_name -FROM awscc.iot.provisioning_templates -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the provisioning_templates resource, the following permissions are required: - -### Create -```json -iam:GetRole, -iam:PassRole, -iot:CreateProvisioningTemplate, -iot:DescribeProvisioningTemplate, -iot:TagResource, -iot:ListTagsForResource -``` - -### List -```json -iot:ListProvisioningTemplates -``` - 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 deleted file mode 100644 index 3679ab57b4..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/resource_specific_logging/index.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -target_type, -target_name, -log_level, -target_id -FROM awscc.iot.resource_specific_logging -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the resource_specific_logging resource, the following permissions are required: - -### Read -```json -iot:ListV2LoggingLevels -``` - -### Update -```json -iot:ListV2LoggingLevels, -iot:SetV2LoggingLevel -``` - -### Delete -```json -iot:ListV2LoggingLevels, -iot:DeleteV2LoggingLevel -``` - 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 deleted file mode 100644 index 1fdf58893d..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/resource_specific_loggings/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -target_id -FROM awscc.iot.resource_specific_loggings -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the resource_specific_loggings resource, the following permissions are required: - -### Create -```json -iot:ListV2LoggingLevels, -iot:SetV2LoggingLevel -``` - -### List -```json -iot:ListV2LoggingLevels -``` - diff --git a/docs/awscc-docs/providers/awscc/iot/role_alias/index.md b/docs/awscc-docs/providers/awscc/iot/role_alias/index.md deleted file mode 100644 index eee1dd9da5..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/role_alias/index.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -role_alias, -role_alias_arn, -role_arn, -credential_duration_seconds, -tags -FROM awscc.iot.role_alias -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the role_alias resource, the following permissions are required: - -### Read -```json -iam:GetRole, -iam:PassRole, -iot:DescribeRoleAlias, -iot:ListTagsForResource -``` - -### Update -```json -iam:GetRole, -iam:PassRole, -iot:UpdateRoleAlias, -iot:DescribeRoleAlias, -iot:TagResource, -iot:UntagResource, -iot:ListTagsForResource -``` - -### Delete -```json -iot:DeleteRoleAlias, -iot:DescribeRoleAlias -``` - diff --git a/docs/awscc-docs/providers/awscc/iot/role_aliases/index.md b/docs/awscc-docs/providers/awscc/iot/role_aliases/index.md deleted file mode 100644 index cc8812048f..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/role_aliases/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -role_alias -FROM awscc.iot.role_aliases -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the role_aliases resource, the following permissions are required: - -### Create -```json -iam:GetRole, -iam:PassRole, -iot:CreateRoleAlias, -iot:DescribeRoleAlias, -iot:TagResource, -iot:ListTagsForResource -``` - -### List -```json -iot:ListRoleAliases -``` - diff --git a/docs/awscc-docs/providers/awscc/iot/scheduled_audit/index.md b/docs/awscc-docs/providers/awscc/iot/scheduled_audit/index.md deleted file mode 100644 index 585fbe72ad..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/scheduled_audit/index.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the scheduled_audit resource, the following permissions are required: - -### Read -```json -iot:DescribeScheduledAudit, -iot:ListTagsForResource -``` - -### Update -```json -iot:UpdateScheduledAudit, -iot:ListTagsForResource, -iot:UntagResource, -iot:TagResource -``` - -### Delete -```json -iot:DescribeScheduledAudit, -iot:DeleteScheduledAudit -``` - diff --git a/docs/awscc-docs/providers/awscc/iot/scheduled_audits/index.md b/docs/awscc-docs/providers/awscc/iot/scheduled_audits/index.md deleted file mode 100644 index c830bf2e43..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/scheduled_audits/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -scheduled_audit_name -FROM awscc.iot.scheduled_audits -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the scheduled_audits resource, the following permissions are required: - -### Create -```json -iot:CreateScheduledAudit, -iot:DescribeScheduledAudit, -iot:TagResource -``` - -### List -```json -iot:ListScheduledAudits -``` - diff --git a/docs/awscc-docs/providers/awscc/iot/security_profile/index.md b/docs/awscc-docs/providers/awscc/iot/security_profile/index.md deleted file mode 100644 index 85a5109fba..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/security_profile/index.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the security_profile resource, the following permissions are required: - -### Read -```json -iot:DescribeSecurityProfile, -iot:ListTagsForResource, -iot:ListTargetsForSecurityProfile -``` - -### Update -```json -iot:UpdateSecurityProfile, -iot:ListTargetsForSecurityProfile, -iot:AttachSecurityProfile, -iot:DetachSecurityProfile, -iot:ListTagsForResource, -iot:UntagResource, -iot:TagResource, -iam:PassRole -``` - -### Delete -```json -iot:DescribeSecurityProfile, -iot:DeleteSecurityProfile -``` - diff --git a/docs/awscc-docs/providers/awscc/iot/security_profiles/index.md b/docs/awscc-docs/providers/awscc/iot/security_profiles/index.md deleted file mode 100644 index a031992944..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/security_profiles/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -security_profile_name -FROM awscc.iot.security_profiles -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the security_profiles resource, the following permissions are required: - -### Create -```json -iot:CreateSecurityProfile, -iot:AttachSecurityProfile, -iot:DescribeSecurityProfile, -iot:TagResource, -iam:PassRole -``` - -### List -```json -iot:ListSecurityProfiles -``` - diff --git a/docs/awscc-docs/providers/awscc/iot/software_package/index.md b/docs/awscc-docs/providers/awscc/iot/software_package/index.md deleted file mode 100644 index eafac5078f..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/software_package/index.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -description, -package_arn, -package_name, -tags -FROM awscc.iot.software_package -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the software_package resource, the following permissions are required: - -### Read -```json -iot:GetPackage, -iot:ListTagsForResource -``` - -### Update -```json -iot:CreatePackage, -iot:UpdatePackage, -iot:GetPackage, -iot:ListTagsForResource, -iot:TagResource, -iot:UntagResource, -iot:GetIndexingConfiguration -``` - -### Delete -```json -iot:DeletePackage, -iot:DeletePackageVersion, -iot:GetPackage, -iot:GetPackageVersion, -iot:UpdatePackage, -iot:UpdatePackageVersion, -iot:GetIndexingConfiguration, -iot:ListPackageVersions -``` - 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 deleted file mode 100644 index 95d0ae87a4..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/software_package_version/index.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -attributes, -description, -error_reason, -package_name, -package_version_arn, -status, -tags, -version_name -FROM awscc.iot.software_package_version -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the software_package_version resource, the following permissions are required: - -### Read -```json -iot:GetPackageVersion, -iot:ListTagsForResource -``` - -### Update -```json -iot:UpdatePackageVersion, -iot:GetPackageVersion, -iot:ListTagsForResource, -iot:TagResource, -iot:UntagResource, -iot:GetIndexingConfiguration -``` - -### Delete -```json -iot:DeletePackageVersion, -iot:UpdatePackageVersion, -iot:GetPackageVersion, -iot:GetIndexingConfiguration -``` - 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 deleted file mode 100644 index 6905b4454c..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/software_package_versions/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -package_name, -version_name -FROM awscc.iot.software_package_versions -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the software_package_versions resource, the following permissions are required: - -### Create -```json -iot:CreatePackageVersion, -iot:GetPackageVersion, -iot:TagResource, -iot:GetIndexingConfiguration -``` - -### List -```json -iot:ListPackageVersions -``` - diff --git a/docs/awscc-docs/providers/awscc/iot/software_packages/index.md b/docs/awscc-docs/providers/awscc/iot/software_packages/index.md deleted file mode 100644 index 52449d3f24..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/software_packages/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -package_name -FROM awscc.iot.software_packages -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the software_packages resource, the following permissions are required: - -### Create -```json -iot:CreatePackage, -iot:GetPackage, -iot:TagResource, -iot:GetIndexingConfiguration -``` - -### List -```json -iot:ListPackages -``` - diff --git a/docs/awscc-docs/providers/awscc/iot/thing/index.md b/docs/awscc-docs/providers/awscc/iot/thing/index.md deleted file mode 100644 index 777a6a04c0..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/thing/index.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id, -arn, -attribute_payload, -thing_name -FROM awscc.iot.thing -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the thing resource, the following permissions are required: - -### Delete -```json -iot:DeleteThing, -iot:DescribeThing -``` - -### Read -```json -iot:DescribeThing -``` - -### Update -```json -iot:UpdateThing, -iot:DescribeThing -``` - diff --git a/docs/awscc-docs/providers/awscc/iot/thing_group/index.md b/docs/awscc-docs/providers/awscc/iot/thing_group/index.md deleted file mode 100644 index 4f45431b10..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/thing_group/index.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id, -arn, -thing_group_name, -parent_group_name, -query_string, -thing_group_properties, -tags -FROM awscc.iot.thing_group -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the thing_group resource, the following permissions are required: - -### Delete -```json -iot:DescribeThingGroup, -iot:DeleteThingGroup, -iot:DeleteDynamicThingGroup -``` - -### Read -```json -iot:DescribeThingGroup, -iot:ListTagsForResource -``` - -### Update -```json -iot:ListTagsForResource, -iot:DescribeThingGroup, -iot:UpdateThingGroup, -iot:UpdateDynamicThingGroup, -iot:TagResource, -iot:UntagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/iot/thing_groups/index.md b/docs/awscc-docs/providers/awscc/iot/thing_groups/index.md deleted file mode 100644 index da267edafd..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/thing_groups/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -thing_group_name -FROM awscc.iot.thing_groups -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the thing_groups resource, the following permissions are required: - -### Create -```json -iot:DescribeThingGroup, -iot:ListTagsForResource, -iot:CreateThingGroup, -iot:CreateDynamicThingGroup, -iot:TagResource -``` - -### List -```json -iot:ListThingGroups, -iot:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/iot/thing_type/index.md b/docs/awscc-docs/providers/awscc/iot/thing_type/index.md deleted file mode 100644 index 63781206b6..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/thing_type/index.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id, -arn, -thing_type_name, -deprecate_thing_type, -thing_type_properties, -tags -FROM awscc.iot.thing_type -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the thing_type resource, the following permissions are required: - -### Delete -```json -iot:DescribeThingType, -iot:DeleteThingType, -iot:DeprecateThingType -``` - -### Read -```json -iot:DescribeThingType, -iot:ListTagsForResource -``` - -### Update -```json -iot:DescribeThingType, -iot:UpdateThingType, -iot:ListTagsForResource, -iot:TagResource, -iot:UntagResource, -iot:DeprecateThingType -``` - diff --git a/docs/awscc-docs/providers/awscc/iot/thing_types/index.md b/docs/awscc-docs/providers/awscc/iot/thing_types/index.md deleted file mode 100644 index 3bfb6a84a7..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/thing_types/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -thing_type_name -FROM awscc.iot.thing_types -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the thing_types resource, the following permissions are required: - -### Create -```json -iot:DescribeThingType, -iot:ListTagsForResource, -iot:CreateThingType, -iot:DeprecateThingType, -iot:TagResource -``` - -### List -```json -iot:ListThingTypes, -iot:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/iot/things/index.md b/docs/awscc-docs/providers/awscc/iot/things/index.md deleted file mode 100644 index 3078d2f201..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/things/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -thing_name -FROM awscc.iot.things -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the things resource, the following permissions are required: - -### Create -```json -iot:CreateThing, -iot:DescribeThing -``` - -### List -```json -iot:ListThings -``` - diff --git a/docs/awscc-docs/providers/awscc/iot/topic_rule/index.md b/docs/awscc-docs/providers/awscc/iot/topic_rule/index.md deleted file mode 100644 index 00e32106ce..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/topic_rule/index.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -rule_name, -topic_rule_payload, -tags -FROM awscc.iot.topic_rule -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the topic_rule resource, the following permissions are required: - -### Read -```json -iot:GetTopicRule, -iot:ListTagsForResource -``` - -### Update -```json -iam:PassRole, -iot:GetTopicRule, -iot:ListTagsForResource, -iot:ReplaceTopicRule, -iot:TagResource, -iot:UntagResource -``` - -### Delete -```json -iot:GetTopicRule, -iot:DeleteTopicRule -``` - 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 deleted file mode 100644 index 292d1218ac..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/topic_rule_destination/index.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -status, -http_url_properties, -status_reason, -vpc_properties -FROM awscc.iot.topic_rule_destination -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the topic_rule_destination resource, the following permissions are required: - -### Read -```json -iot:GetTopicRuleDestination -``` - -### Update -```json -iam:PassRole, -iot:GetTopicRuleDestination, -iot:UpdateTopicRuleDestination -``` - -### Delete -```json -iot:GetTopicRuleDestination, -iot:DeleteTopicRuleDestination -``` - 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 deleted file mode 100644 index 61bd250e5f..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/topic_rule_destinations/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.iot.topic_rule_destinations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the topic_rule_destinations resource, the following permissions are required: - -### Create -```json -iam:PassRole, -iot:CreateTopicRuleDestination, -iot:GetTopicRuleDestination, -iot:UpdateTopicRuleDestination -``` - -### List -```json -iot:ListTopicRuleDestinations -``` - diff --git a/docs/awscc-docs/providers/awscc/iot/topic_rules/index.md b/docs/awscc-docs/providers/awscc/iot/topic_rules/index.md deleted file mode 100644 index 9f28be1a63..0000000000 --- a/docs/awscc-docs/providers/awscc/iot/topic_rules/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -rule_name -FROM awscc.iot.topic_rules -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the topic_rules resource, the following permissions are required: - -### Create -```json -iam:PassRole, -iot:CreateTopicRule, -iot:GetTopicRule, -iot:TagResource, -iot:ListTagsForResource -``` - -### List -```json -iot:ListTopicRules -``` - diff --git a/docs/awscc-docs/providers/awscc/iotanalytics/dataset/index.md b/docs/awscc-docs/providers/awscc/iotanalytics/dataset/index.md deleted file mode 100644 index 082eb47e0d..0000000000 --- a/docs/awscc-docs/providers/awscc/iotanalytics/dataset/index.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the dataset resource, the following permissions are required: - -### Read -```json -iotanalytics:DescribeDataset, -iotanalytics:ListTagsForResource -``` - -### Update -```json -iotanalytics:UpdateDataset, -iotanalytics:TagResource, -iotanalytics:UntagResource -``` - -### Delete -```json -iotanalytics:DeleteDataset -``` - diff --git a/docs/awscc-docs/providers/awscc/iotanalytics/datasets/index.md b/docs/awscc-docs/providers/awscc/iotanalytics/datasets/index.md deleted file mode 100644 index 7ea327f219..0000000000 --- a/docs/awscc-docs/providers/awscc/iotanalytics/datasets/index.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -dataset_name -FROM awscc.iotanalytics.datasets -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the datasets resource, the following permissions are required: - -### Create -```json -iotanalytics:CreateDataset -``` - -### List -```json -iotanalytics:ListDatasets -``` - diff --git a/docs/awscc-docs/providers/awscc/iotanalytics/index.md b/docs/awscc-docs/providers/awscc/iotanalytics/index.md deleted file mode 100644 index 454725d3dc..0000000000 --- a/docs/awscc-docs/providers/awscc/iotanalytics/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index f8788e404c..0000000000 --- a/docs/awscc-docs/providers/awscc/iotanalytics/pipeline/index.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id, -pipeline_name, -tags, -pipeline_activities -FROM awscc.iotanalytics.pipeline -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the pipeline resource, the following permissions are required: - -### Read -```json -iotanalytics:DescribePipeline, -iotanalytics:ListTagsForResource -``` - -### Update -```json -iotanalytics:UpdatePipeline, -iotanalytics:TagResource, -iotanalytics:UntagResource -``` - -### Delete -```json -iotanalytics:DeletePipeline -``` - diff --git a/docs/awscc-docs/providers/awscc/iotanalytics/pipelines/index.md b/docs/awscc-docs/providers/awscc/iotanalytics/pipelines/index.md deleted file mode 100644 index 8cc5a3c5f6..0000000000 --- a/docs/awscc-docs/providers/awscc/iotanalytics/pipelines/index.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -pipeline_name -FROM awscc.iotanalytics.pipelines -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the pipelines resource, the following permissions are required: - -### Create -```json -iotanalytics:CreatePipeline -``` - -### List -```json -iotanalytics:ListPipelines -``` - diff --git a/docs/awscc-docs/providers/awscc/iotcoredeviceadvisor/index.md b/docs/awscc-docs/providers/awscc/iotcoredeviceadvisor/index.md deleted file mode 100644 index f031fe8339..0000000000 --- a/docs/awscc-docs/providers/awscc/iotcoredeviceadvisor/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 deleted file mode 100644 index 3d57876794..0000000000 --- a/docs/awscc-docs/providers/awscc/iotcoredeviceadvisor/suite_definition/index.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -suite_definition_configuration, -suite_definition_id, -suite_definition_arn, -suite_definition_version, -tags -FROM awscc.iotcoredeviceadvisor.suite_definition -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the suite_definition resource, the following permissions are required: - -### Read -```json -iotdeviceadvisor:GetSuiteDefinition, -iotdeviceadvisor:TagResource -``` - -### Update -```json -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 -```json -iotdeviceadvisor:GetSuiteDefinition, -iotdeviceadvisor:DeleteSuiteDefinition -``` - diff --git a/docs/awscc-docs/providers/awscc/iotcoredeviceadvisor/suite_definitions/index.md b/docs/awscc-docs/providers/awscc/iotcoredeviceadvisor/suite_definitions/index.md deleted file mode 100644 index 84c04dc327..0000000000 --- a/docs/awscc-docs/providers/awscc/iotcoredeviceadvisor/suite_definitions/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -suite_definition_id -FROM awscc.iotcoredeviceadvisor.suite_definitions -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the suite_definitions resource, the following permissions are required: - -### Create -```json -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 -```json -iotdeviceadvisor:ListSuiteDefinitions -``` - diff --git a/docs/awscc-docs/providers/awscc/iotevents/alarm_model/index.md b/docs/awscc-docs/providers/awscc/iotevents/alarm_model/index.md deleted file mode 100644 index 0642539261..0000000000 --- a/docs/awscc-docs/providers/awscc/iotevents/alarm_model/index.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the alarm_model resource, the following permissions are required: - -### Read -```json -iotevents:DescribeAlarmModel, -iotevents:ListTagsForResource -``` - -### Update -```json -iotevents:UpdateAlarmModel, -iotevents:UpdateInputRouting, -iotevents:DescribeAlarmModel, -iotevents:ListTagsForResource, -iotevents:UntagResource, -iotevents:TagResource, -iam:PassRole -``` - -### Delete -```json -iotevents:DeleteAlarmModel, -iotevents:DescribeAlarmModel -``` - diff --git a/docs/awscc-docs/providers/awscc/iotevents/alarm_models/index.md b/docs/awscc-docs/providers/awscc/iotevents/alarm_models/index.md deleted file mode 100644 index 1c7c4189f0..0000000000 --- a/docs/awscc-docs/providers/awscc/iotevents/alarm_models/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -alarm_model_name -FROM awscc.iotevents.alarm_models -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the alarm_models resource, the following permissions are required: - -### Create -```json -iotevents:CreateAlarmModel, -iotevents:UpdateInputRouting, -iotevents:DescribeAlarmModel, -iotevents:ListTagsForResource, -iotevents:TagResource, -iam:PassRole -``` - -### List -```json -iotevents:ListAlarmModels -``` - diff --git a/docs/awscc-docs/providers/awscc/iotevents/detector_model/index.md b/docs/awscc-docs/providers/awscc/iotevents/detector_model/index.md deleted file mode 100644 index 18f12815ac..0000000000 --- a/docs/awscc-docs/providers/awscc/iotevents/detector_model/index.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the detector_model resource, the following permissions are required: - -### Read -```json -iotevents:DescribeDetectorModel, -iotevents:ListTagsForResource -``` - -### Update -```json -iotevents:UpdateDetectorModel, -iotevents:UpdateInputRouting, -iotevents:DescribeDetectorModel, -iotevents:ListTagsForResource, -iotevents:UntagResource, -iotevents:TagResource, -iam:PassRole -``` - -### Delete -```json -iotevents:DeleteDetectorModel, -iotevents:DescribeDetectorModel -``` - diff --git a/docs/awscc-docs/providers/awscc/iotevents/detector_models/index.md b/docs/awscc-docs/providers/awscc/iotevents/detector_models/index.md deleted file mode 100644 index 70ceee54d6..0000000000 --- a/docs/awscc-docs/providers/awscc/iotevents/detector_models/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -detector_model_name -FROM awscc.iotevents.detector_models -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the detector_models resource, the following permissions are required: - -### Create -```json -iotevents:CreateDetectorModel, -iotevents:UpdateInputRouting, -iotevents:DescribeDetectorModel, -iotevents:ListTagsForResource, -iotevents:TagResource, -iam:PassRole -``` - -### List -```json -iotevents:ListDetectorModels -``` - diff --git a/docs/awscc-docs/providers/awscc/iotevents/index.md b/docs/awscc-docs/providers/awscc/iotevents/index.md deleted file mode 100644 index afe1a5f1d0..0000000000 --- a/docs/awscc-docs/providers/awscc/iotevents/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -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 deleted file mode 100644 index 02c394771c..0000000000 --- a/docs/awscc-docs/providers/awscc/iotevents/input/index.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -input_definition, -input_description, -input_name, -tags -FROM awscc.iotevents.input -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the input resource, the following permissions are required: - -### Read -```json -iotevents:DescribeInput, -iotevents:ListTagsForResource -``` - -### Update -```json -iotevents:UpdateInput, -iotevents:DescribeInput, -iotevents:ListTagsForResource, -iotevents:UntagResource, -iotevents:TagResource -``` - -### Delete -```json -iotevents:DeleteInput, -iotevents:DescribeInput -``` - diff --git a/docs/awscc-docs/providers/awscc/iotevents/inputs/index.md b/docs/awscc-docs/providers/awscc/iotevents/inputs/index.md deleted file mode 100644 index be84e0404d..0000000000 --- a/docs/awscc-docs/providers/awscc/iotevents/inputs/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -input_name -FROM awscc.iotevents.inputs -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the inputs resource, the following permissions are required: - -### Create -```json -iotevents:CreateInput, -iotevents:TagResource, -iotevents:DescribeInput, -iotevents:ListTagsForResource -``` - -### List -```json -iotevents:ListInputs -``` - diff --git a/docs/awscc-docs/providers/awscc/iotfleethub/application/index.md b/docs/awscc-docs/providers/awscc/iotfleethub/application/index.md deleted file mode 100644 index b8b9e07b74..0000000000 --- a/docs/awscc-docs/providers/awscc/iotfleethub/application/index.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the application resource, the following permissions are required: - -### Read -```json -iotfleethub:DescribeApplication -``` - -### Update -```json -iotfleethub:UpdateApplication, -iotfleethub:DescribeApplication, -iotfleethub:TagResource, -iotfleethub:UntagResource -``` - -### Delete -```json -iotfleethub:DeleteApplication, -iotfleethub:DescribeApplication, -sso:DeleteManagedApplicationInstance -``` - diff --git a/docs/awscc-docs/providers/awscc/iotfleethub/applications/index.md b/docs/awscc-docs/providers/awscc/iotfleethub/applications/index.md deleted file mode 100644 index a12a42f11d..0000000000 --- a/docs/awscc-docs/providers/awscc/iotfleethub/applications/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -application_id -FROM awscc.iotfleethub.applications -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the applications resource, the following permissions are required: - -### Create -```json -iotfleethub:CreateApplication, -iotfleethub:TagResource, -iam:PassRole, -sso:CreateManagedApplicationInstance, -sso:DescribeRegisteredRegions -``` - -### List -```json -iotfleethub:ListApplications -``` - diff --git a/docs/awscc-docs/providers/awscc/iotfleethub/index.md b/docs/awscc-docs/providers/awscc/iotfleethub/index.md deleted file mode 100644 index cdf604aee7..0000000000 --- a/docs/awscc-docs/providers/awscc/iotfleethub/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 deleted file mode 100644 index 35748f6fa8..0000000000 --- a/docs/awscc-docs/providers/awscc/iotfleetwise/campaign/index.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the campaign resource, the following permissions are required: - -### Read -```json -iotfleetwise:GetCampaign, -iotfleetwise:ListTagsForResource -``` - -### Update -```json -iotfleetwise:GetCampaign, -iotfleetwise:ListTagsForResource, -iotfleetwise:UpdateCampaign, -iotfleetwise:TagResource, -iotfleetwise:UntagResource -``` - -### Delete -```json -iotfleetwise:DeleteCampaign, -iotfleetwise:GetCampaign -``` - diff --git a/docs/awscc-docs/providers/awscc/iotfleetwise/campaigns/index.md b/docs/awscc-docs/providers/awscc/iotfleetwise/campaigns/index.md deleted file mode 100644 index 5443a0ca38..0000000000 --- a/docs/awscc-docs/providers/awscc/iotfleetwise/campaigns/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.iotfleetwise.campaigns -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the campaigns resource, the following permissions are required: - -### Create -```json -iotfleetwise:CreateCampaign, -iotfleetwise:GetCampaign, -iotfleetwise:ListTagsForResource, -iotfleetwise:TagResource, -iam:PassRole, -timestream:DescribeEndpoints, -timestream:DescribeTable -``` - -### List -```json -iotfleetwise:ListCampaigns, -iotfleetwise:GetCampaign -``` - diff --git a/docs/awscc-docs/providers/awscc/iotfleetwise/decoder_manifest/index.md b/docs/awscc-docs/providers/awscc/iotfleetwise/decoder_manifest/index.md deleted file mode 100644 index eeae6c0761..0000000000 --- a/docs/awscc-docs/providers/awscc/iotfleetwise/decoder_manifest/index.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the decoder_manifest resource, the following permissions are required: - -### Read -```json -iotfleetwise:GetDecoderManifest, -iotfleetwise:ListDecoderManifestSignals, -iotfleetwise:ListDecoderManifestNetworkInterfaces, -iotfleetwise:ListTagsForResource -``` - -### Update -```json -iotfleetwise:UpdateDecoderManifest, -iotfleetwise:GetDecoderManifest, -iotfleetwise:ListDecoderManifestSignals, -iotfleetwise:ListDecoderManifestNetworkInterfaces, -iotfleetwise:ListTagsForResource, -iotfleetwise:TagResource, -iotfleetwise:UntagResource -``` - -### Delete -```json -iotfleetwise:DeleteDecoderManifest, -iotfleetwise:GetDecoderManifest -``` - diff --git a/docs/awscc-docs/providers/awscc/iotfleetwise/decoder_manifests/index.md b/docs/awscc-docs/providers/awscc/iotfleetwise/decoder_manifests/index.md deleted file mode 100644 index 290f43a24a..0000000000 --- a/docs/awscc-docs/providers/awscc/iotfleetwise/decoder_manifests/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.iotfleetwise.decoder_manifests -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the decoder_manifests resource, the following permissions are required: - -### Create -```json -iotfleetwise:CreateDecoderManifest, -iotfleetwise:GetDecoderManifest, -iotfleetwise:UpdateDecoderManifest, -iotfleetwise:ListDecoderManifestSignals, -iotfleetwise:ListDecoderManifestNetworkInterfaces, -iotfleetwise:ListTagsForResource, -iotfleetwise:TagResource -``` - -### List -```json -iotfleetwise:ListDecoderManifests -``` - diff --git a/docs/awscc-docs/providers/awscc/iotfleetwise/fleet/index.md b/docs/awscc-docs/providers/awscc/iotfleetwise/fleet/index.md deleted file mode 100644 index bd07c7b625..0000000000 --- a/docs/awscc-docs/providers/awscc/iotfleetwise/fleet/index.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -creation_time, -description, -id, -last_modification_time, -signal_catalog_arn, -tags -FROM awscc.iotfleetwise.fleet -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the fleet resource, the following permissions are required: - -### Read -```json -iotfleetwise:GetFleet, -iotfleetwise:ListTagsForResource -``` - -### Update -```json -iotfleetwise:GetFleet, -iotfleetwise:UpdateFleet, -iotfleetwise:ListTagsForResource, -iotfleetwise:TagResource, -iotfleetwise:UntagResource -``` - -### Delete -```json -iotfleetwise:GetFleet, -iotfleetwise:DeleteFleet -``` - diff --git a/docs/awscc-docs/providers/awscc/iotfleetwise/fleets/index.md b/docs/awscc-docs/providers/awscc/iotfleetwise/fleets/index.md deleted file mode 100644 index c8546e0871..0000000000 --- a/docs/awscc-docs/providers/awscc/iotfleetwise/fleets/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.iotfleetwise.fleets -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the fleets resource, the following permissions are required: - -### Create -```json -iotfleetwise:GetFleet, -iotfleetwise:CreateFleet, -iotfleetwise:ListTagsForResource, -iotfleetwise:ListVehiclesInFleet, -iotfleetwise:TagResource -``` - -### List -```json -iotfleetwise:ListFleets -``` - diff --git a/docs/awscc-docs/providers/awscc/iotfleetwise/index.md b/docs/awscc-docs/providers/awscc/iotfleetwise/index.md deleted file mode 100644 index a7da867f00..0000000000 --- a/docs/awscc-docs/providers/awscc/iotfleetwise/index.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -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 deleted file mode 100644 index 5b37150078..0000000000 --- a/docs/awscc-docs/providers/awscc/iotfleetwise/model_manifest/index.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -creation_time, -description, -last_modification_time, -name, -nodes, -signal_catalog_arn, -status, -tags -FROM awscc.iotfleetwise.model_manifest -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the model_manifest resource, the following permissions are required: - -### Read -```json -iotfleetwise:GetModelManifest, -iotfleetwise:ListModelManifestNodes, -iotfleetwise:ListTagsForResource -``` - -### Update -```json -iotfleetwise:UpdateModelManifest, -iotfleetwise:GetModelManifest, -iotfleetwise:ListModelManifestNodes, -iotfleetwise:ListTagsForResource, -iotfleetwise:TagResource, -iotfleetwise:UntagResource -``` - -### Delete -```json -iotfleetwise:DeleteModelManifest, -iotfleetwise:GetModelManifest -``` - diff --git a/docs/awscc-docs/providers/awscc/iotfleetwise/model_manifests/index.md b/docs/awscc-docs/providers/awscc/iotfleetwise/model_manifests/index.md deleted file mode 100644 index cf3d6d4daa..0000000000 --- a/docs/awscc-docs/providers/awscc/iotfleetwise/model_manifests/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.iotfleetwise.model_manifests -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the model_manifests resource, the following permissions are required: - -### Create -```json -iotfleetwise:CreateModelManifest, -iotfleetwise:GetModelManifest, -iotfleetwise:UpdateModelManifest, -iotfleetwise:ListModelManifestNodes, -iotfleetwise:ListTagsForResource, -iotfleetwise:TagResource -``` - -### List -```json -iotfleetwise:ListModelManifests -``` - diff --git a/docs/awscc-docs/providers/awscc/iotfleetwise/signal_catalog/index.md b/docs/awscc-docs/providers/awscc/iotfleetwise/signal_catalog/index.md deleted file mode 100644 index 237d05e57d..0000000000 --- a/docs/awscc-docs/providers/awscc/iotfleetwise/signal_catalog/index.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -creation_time, -description, -last_modification_time, -name, -node_counts, -nodes, -tags -FROM awscc.iotfleetwise.signal_catalog -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the signal_catalog resource, the following permissions are required: - -### Read -```json -iotfleetwise:GetSignalCatalog, -iotfleetwise:ListSignalCatalogNodes, -iotfleetwise:ListTagsForResource -``` - -### Update -```json -iotfleetwise:GetSignalCatalog, -iotfleetwise:UpdateSignalCatalog, -iotfleetwise:ListSignalCatalogNodes, -iotfleetwise:ListTagsForResource, -iotfleetwise:TagResource, -iotfleetwise:UntagResource -``` - -### Delete -```json -iotfleetwise:GetSignalCatalog, -iotfleetwise:DeleteSignalCatalog -``` - diff --git a/docs/awscc-docs/providers/awscc/iotfleetwise/signal_catalogs/index.md b/docs/awscc-docs/providers/awscc/iotfleetwise/signal_catalogs/index.md deleted file mode 100644 index 9b5a4f074f..0000000000 --- a/docs/awscc-docs/providers/awscc/iotfleetwise/signal_catalogs/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.iotfleetwise.signal_catalogs -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the signal_catalogs resource, the following permissions are required: - -### Create -```json -iotfleetwise:GetSignalCatalog, -iotfleetwise:CreateSignalCatalog, -iotfleetwise:ListSignalCatalogNodes, -iotfleetwise:ListTagsForResource, -iotfleetwise:TagResource -``` - -### List -```json -iotfleetwise:ListSignalCatalogs -``` - diff --git a/docs/awscc-docs/providers/awscc/iotfleetwise/vehicle/index.md b/docs/awscc-docs/providers/awscc/iotfleetwise/vehicle/index.md deleted file mode 100644 index 8a3f8fa59b..0000000000 --- a/docs/awscc-docs/providers/awscc/iotfleetwise/vehicle/index.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the vehicle resource, the following permissions are required: - -### Read -```json -iotfleetwise:GetVehicle, -iotfleetwise:ListTagsForResource -``` - -### Update -```json -iotfleetwise:GetVehicle, -iotfleetwise:UpdateVehicle, -iotfleetwise:ListTagsForResource, -iotfleetwise:TagResource, -iotfleetwise:UntagResource -``` - -### Delete -```json -iotfleetwise:GetVehicle, -iotfleetwise:DeleteVehicle -``` - diff --git a/docs/awscc-docs/providers/awscc/iotfleetwise/vehicles/index.md b/docs/awscc-docs/providers/awscc/iotfleetwise/vehicles/index.md deleted file mode 100644 index 915c272a26..0000000000 --- a/docs/awscc-docs/providers/awscc/iotfleetwise/vehicles/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.iotfleetwise.vehicles -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the vehicles resource, the following permissions are required: - -### Create -```json -iotfleetwise:GetVehicle, -iotfleetwise:CreateVehicle, -iot:CreateThing, -iot:DescribeThing, -iotfleetwise:ListTagsForResource, -iotfleetwise:ListVehicles, -iotfleetwise:TagResource -``` - -### List -```json -iotfleetwise:ListVehicles -``` - diff --git a/docs/awscc-docs/providers/awscc/iotsitewise/access_policies/index.md b/docs/awscc-docs/providers/awscc/iotsitewise/access_policies/index.md deleted file mode 100644 index 86dbdb55ea..0000000000 --- a/docs/awscc-docs/providers/awscc/iotsitewise/access_policies/index.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -access_policy_id -FROM awscc.iotsitewise.access_policies -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the access_policies resource, the following permissions are required: - -### Create -```json -iotsitewise:CreateAccessPolicy -``` - -### List -```json -iotsitewise:ListAccessPolicies -``` - diff --git a/docs/awscc-docs/providers/awscc/iotsitewise/access_policy/index.md b/docs/awscc-docs/providers/awscc/iotsitewise/access_policy/index.md deleted file mode 100644 index 395b9de44d..0000000000 --- a/docs/awscc-docs/providers/awscc/iotsitewise/access_policy/index.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the access_policy resource, the following permissions are required: - -### Read -```json -iotsitewise:DescribeAccessPolicy -``` - -### Update -```json -iotsitewise:DescribeAccessPolicy, -iotsitewise:UpdateAccessPolicy -``` - -### Delete -```json -iotsitewise:DescribeAccessPolicy, -iotsitewise:DeleteAccessPolicy -``` - diff --git a/docs/awscc-docs/providers/awscc/iotsitewise/asset/index.md b/docs/awscc-docs/providers/awscc/iotsitewise/asset/index.md deleted file mode 100644 index 2aa01ff890..0000000000 --- a/docs/awscc-docs/providers/awscc/iotsitewise/asset/index.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the asset resource, the following permissions are required: - -### Read -```json -iotsitewise:DescribeAsset, -iotsitewise:DescribeAssetModel, -iotsitewise:ListAssociatedAssets, -iotsitewise:ListTagsForResource -``` - -### Update -```json -iotsitewise:AssociateAssets, -iotsitewise:DescribeAsset, -iotsitewise:DescribeAssetModel, -iotsitewise:DisassociateAssets, -iotsitewise:ListAssociatedAssets, -iotsitewise:ListTagsForResource, -iotsitewise:TagResource, -iotsitewise:UpdateAsset, -iotsitewise:UpdateAssetProperty, -iotsitewise:UntagResource -``` - -### Delete -```json -iotsitewise:DeleteAsset, -iotsitewise:DescribeAsset, -iotsitewise:DescribeAssetModel, -iotsitewise:DisassociateAssets, -iotsitewise:ListAssociatedAssets, -iotsitewise:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/iotsitewise/asset_model/index.md b/docs/awscc-docs/providers/awscc/iotsitewise/asset_model/index.md deleted file mode 100644 index 8ca7d6f07c..0000000000 --- a/docs/awscc-docs/providers/awscc/iotsitewise/asset_model/index.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the asset_model resource, the following permissions are required: - -### Read -```json -iotsitewise:DescribeAssetModel, -iotsitewise:ListTagsForResource -``` - -### Update -```json -iotsitewise:DescribeAssetModel, -iotsitewise:ListTagsForResource, -iotsitewise:TagResource, -iotsitewise:UntagResource, -iotsitewise:UpdateAssetModel -``` - -### Delete -```json -iotsitewise:DescribeAssetModel, -iotsitewise:DeleteAssetModel -``` - diff --git a/docs/awscc-docs/providers/awscc/iotsitewise/asset_models/index.md b/docs/awscc-docs/providers/awscc/iotsitewise/asset_models/index.md deleted file mode 100644 index d0fc978e60..0000000000 --- a/docs/awscc-docs/providers/awscc/iotsitewise/asset_models/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -asset_model_id -FROM awscc.iotsitewise.asset_models -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the asset_models resource, the following permissions are required: - -### Create -```json -iotsitewise:CreateAssetModel, -iotsitewise:ListTagsForResource, -iotsitewise:TagResource, -iotsitewise:DescribeAssetModel -``` - -### List -```json -iotsitewise:DescribeAssetModel, -iotsitewise:ListAssetModels, -iotsitewise:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/iotsitewise/assets/index.md b/docs/awscc-docs/providers/awscc/iotsitewise/assets/index.md deleted file mode 100644 index 9a132b9d67..0000000000 --- a/docs/awscc-docs/providers/awscc/iotsitewise/assets/index.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -asset_id -FROM awscc.iotsitewise.assets -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the assets resource, the following permissions are required: - -### Create -```json -iotsitewise:AssociateAssets, -iotsitewise:CreateAsset, -iotsitewise:DescribeAsset, -iotsitewise:DescribeAssetModel, -iotsitewise:ListAssociatedAssets, -iotsitewise:ListTagsForResource, -iotsitewise:TagResource, -iotsitewise:UpdateAssetProperty -``` - -### List -```json -iotsitewise:ListAssetModels, -iotsitewise:ListAssets -``` - diff --git a/docs/awscc-docs/providers/awscc/iotsitewise/dashboard/index.md b/docs/awscc-docs/providers/awscc/iotsitewise/dashboard/index.md deleted file mode 100644 index e6394847b4..0000000000 --- a/docs/awscc-docs/providers/awscc/iotsitewise/dashboard/index.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -project_id, -dashboard_id, -dashboard_name, -dashboard_description, -dashboard_definition, -dashboard_arn, -tags -FROM awscc.iotsitewise.dashboard -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the dashboard resource, the following permissions are required: - -### Read -```json -iotsitewise:DescribeDashboard, -iotsitewise:ListTagsForResource -``` - -### Update -```json -iotsitewise:DescribeDashboard, -iotsitewise:UpdateDashboard, -iotsitewise:TagResource, -iotsitewise:UntagResource, -iotsitewise:ListTagsForResource, -iotsitewise:DescribeAsset, -iotsitewise:DescribeAssetModel -``` - -### Delete -```json -iotsitewise:DescribeDashboard, -iotsitewise:DeleteDashboard -``` - diff --git a/docs/awscc-docs/providers/awscc/iotsitewise/dashboards/index.md b/docs/awscc-docs/providers/awscc/iotsitewise/dashboards/index.md deleted file mode 100644 index a3e81b17fe..0000000000 --- a/docs/awscc-docs/providers/awscc/iotsitewise/dashboards/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -dashboard_id -FROM awscc.iotsitewise.dashboards -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the dashboards resource, the following permissions are required: - -### Create -```json -iotsitewise:CreateDashboard, -iotsitewise:DescribeDashboard, -iotsitewise:ListTagsForResource, -iotsitewise:TagResource, -iotsitewise:DescribeAsset, -iotsitewise:DescribeAssetModel -``` - -### List -```json -iotsitewise:ListDashboards -``` - diff --git a/docs/awscc-docs/providers/awscc/iotsitewise/gateway/index.md b/docs/awscc-docs/providers/awscc/iotsitewise/gateway/index.md deleted file mode 100644 index dece89958b..0000000000 --- a/docs/awscc-docs/providers/awscc/iotsitewise/gateway/index.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -gateway_name, -gateway_platform, -tags, -gateway_id, -gateway_capability_summaries -FROM awscc.iotsitewise.gateway -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the gateway resource, the following permissions are required: - -### Read -```json -iotsitewise:DescribeGateway, -iotsitewise:DescribeGatewayCapabilityConfiguration, -iotsitewise:ListTagsForResource -``` - -### Update -```json -iotsitewise:UpdateGateway, -iotsitewise:UpdateGatewayCapabilityConfiguration, -iotsitewise:TagResource, -iotsitewise:UntagResource, -iotsitewise:DescribeGateway, -iotsitewise:DescribeGatewayCapabilityConfiguration, -iotsitewise:ListTagsForResource -``` - -### Delete -```json -iotsitewise:DescribeGateway, -iotsitewise:DescribeGatewayCapabilityConfiguration, -iotsitewise:DeleteGateway -``` - diff --git a/docs/awscc-docs/providers/awscc/iotsitewise/gateways/index.md b/docs/awscc-docs/providers/awscc/iotsitewise/gateways/index.md deleted file mode 100644 index fab876fdb4..0000000000 --- a/docs/awscc-docs/providers/awscc/iotsitewise/gateways/index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -gateway_id -FROM awscc.iotsitewise.gateways -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the gateways resource, the following permissions are required: - -### Create -```json -iotsitewise:CreateGateway, -iotsitewise:DescribeGateway, -iotsitewise:DescribeGatewayCapabilityConfiguration, -iotsitewise:UpdateGatewayCapabilityConfiguration, -iam:PassRole, -iam:GetRole, -greengrass:GetCoreDevice, -iotsitewise:ListTagsForResource, -iotsitewise:TagResource, -iot:DescribeThing -``` - -### List -```json -iotsitewise:ListGateways -``` - diff --git a/docs/awscc-docs/providers/awscc/iotsitewise/index.md b/docs/awscc-docs/providers/awscc/iotsitewise/index.md deleted file mode 100644 index 3220ace893..0000000000 --- a/docs/awscc-docs/providers/awscc/iotsitewise/index.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -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 deleted file mode 100644 index 6d0675d3b0..0000000000 --- a/docs/awscc-docs/providers/awscc/iotsitewise/portal/index.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the portal resource, the following permissions are required: - -### Read -```json -iotsitewise:DescribePortal, -iotsitewise:ListTagsForResource -``` - -### Update -```json -iotsitewise:DescribePortal, -iotsitewise:ListTagsForResource, -iotsitewise:TagResource, -iotsitewise:UpdatePortal, -iotsitewise:UntagResource, -iam:PassRole, -sso:GetManagedApplicationInstance, -sso:UpdateApplicationInstanceDisplayData -``` - -### Delete -```json -iotsitewise:DescribePortal, -iotsitewise:DeletePortal, -sso:DeleteManagedApplicationInstance -``` - diff --git a/docs/awscc-docs/providers/awscc/iotsitewise/portals/index.md b/docs/awscc-docs/providers/awscc/iotsitewise/portals/index.md deleted file mode 100644 index be4e276c39..0000000000 --- a/docs/awscc-docs/providers/awscc/iotsitewise/portals/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -portal_id -FROM awscc.iotsitewise.portals -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the portals resource, the following permissions are required: - -### Create -```json -iotsitewise:CreatePortal, -iotsitewise:DescribePortal, -iotsitewise:ListTagsForResource, -iotsitewise:TagResource, -iam:PassRole, -sso:CreateManagedApplicationInstance, -sso:DescribeRegisteredRegions -``` - -### List -```json -iotsitewise:ListPortals -``` - diff --git a/docs/awscc-docs/providers/awscc/iotsitewise/project/index.md b/docs/awscc-docs/providers/awscc/iotsitewise/project/index.md deleted file mode 100644 index bef04bf840..0000000000 --- a/docs/awscc-docs/providers/awscc/iotsitewise/project/index.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -portal_id, -project_id, -project_name, -project_description, -project_arn, -asset_ids, -tags -FROM awscc.iotsitewise.project -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the project resource, the following permissions are required: - -### Read -```json -iotsitewise:DescribeProject, -iotsitewise:ListTagsForResource, -iotsitewise:ListProjectAssets -``` - -### Update -```json -iotsitewise:DescribeProject, -iotsitewise:UpdateProject, -iotsitewise:BatchAssociateProjectAssets, -iotsitewise:BatchDisAssociateProjectAssets, -iotsitewise:ListProjectAssets, -iotsitewise:TagResource, -iotsitewise:UntagResource, -iotsitewise:ListTagsForResource -``` - -### Delete -```json -iotsitewise:DescribeProject, -iotsitewise:DeleteProject -``` - diff --git a/docs/awscc-docs/providers/awscc/iotsitewise/projects/index.md b/docs/awscc-docs/providers/awscc/iotsitewise/projects/index.md deleted file mode 100644 index 71ed197338..0000000000 --- a/docs/awscc-docs/providers/awscc/iotsitewise/projects/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -project_id -FROM awscc.iotsitewise.projects -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the projects resource, the following permissions are required: - -### Create -```json -iotsitewise:CreateProject, -iotsitewise:DescribeProject, -iotsitewise:ListProjectAssets, -iotsitewise:ListTagsForResource, -iotsitewise:TagResource, -iotsitewise:BatchAssociateProjectAssets -``` - -### List -```json -iotsitewise:ListProjects -``` - diff --git a/docs/awscc-docs/providers/awscc/iottwinmaker/component_type/index.md b/docs/awscc-docs/providers/awscc/iottwinmaker/component_type/index.md deleted file mode 100644 index 2f80db3b6f..0000000000 --- a/docs/awscc-docs/providers/awscc/iottwinmaker/component_type/index.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the component_type resource, the following permissions are required: - -### Read -```json -iottwinmaker:GetComponentType, -iottwinmaker:GetWorkspace, -iottwinmaker:ListTagsForResource -``` - -### Update -```json -iottwinmaker:GetComponentType, -iottwinmaker:GetWorkspace, -iottwinmaker:ListTagsForResource, -iottwinmaker:TagResource, -iottwinmaker:UntagResource, -iottwinmaker:UpdateComponentType -``` - -### Delete -```json -iottwinmaker:DeleteComponentType, -iottwinmaker:GetComponentType, -iottwinmaker:GetWorkspace -``` - diff --git a/docs/awscc-docs/providers/awscc/iottwinmaker/component_types/index.md b/docs/awscc-docs/providers/awscc/iottwinmaker/component_types/index.md deleted file mode 100644 index 868d4417b4..0000000000 --- a/docs/awscc-docs/providers/awscc/iottwinmaker/component_types/index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -workspace_id, -component_type_id -FROM awscc.iottwinmaker.component_types -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the component_types resource, the following permissions are required: - -### Create -```json -iottwinmaker:CreateComponentType, -iottwinmaker:GetComponentType, -iottwinmaker:GetWorkspace, -iottwinmaker:ListTagsForResource, -iottwinmaker:TagResource -``` - -### List -```json -iottwinmaker:GetComponentType, -iottwinmaker:GetWorkspace, -iottwinmaker:ListComponentTypes, -iottwinmaker:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/iottwinmaker/entities/index.md b/docs/awscc-docs/providers/awscc/iottwinmaker/entities/index.md deleted file mode 100644 index cad3bfe85b..0000000000 --- a/docs/awscc-docs/providers/awscc/iottwinmaker/entities/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -workspace_id, -entity_id -FROM awscc.iottwinmaker.entities -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the entities resource, the following permissions are required: - -### Create -```json -iottwinmaker:GetWorkspace, -iottwinmaker:CreateEntity, -iottwinmaker:GetEntity, -iottwinmaker:ListComponents, -iottwinmaker:ListProperties, -iottwinmaker:ListTagsForResource, -iottwinmaker:TagResource -``` - -### List -```json -iottwinmaker:GetWorkspace, -iottwinmaker:ListTagsForResource, -iottwinmaker:GetEntity, -iottwinmaker:ListEntities -``` - diff --git a/docs/awscc-docs/providers/awscc/iottwinmaker/entity/index.md b/docs/awscc-docs/providers/awscc/iottwinmaker/entity/index.md deleted file mode 100644 index ca2f408874..0000000000 --- a/docs/awscc-docs/providers/awscc/iottwinmaker/entity/index.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the entity resource, the following permissions are required: - -### Read -```json -iottwinmaker:GetComponentType, -iottwinmaker:GetEntity, -iottwinmaker:ListComponents, -iottwinmaker:ListProperties, -iottwinmaker:GetWorkspace, -iottwinmaker:ListEntities, -iottwinmaker:ListTagsForResource -``` - -### Update -```json -iottwinmaker:GetComponentType, -iottwinmaker:GetEntity, -iottwinmaker:ListComponents, -iottwinmaker:ListProperties, -iottwinmaker:GetWorkspace, -iottwinmaker:ListTagsForResource, -iottwinmaker:TagResource, -iottwinmaker:UntagResource, -iottwinmaker:UpdateEntity, -iottwinmaker:UpdateComponentType -``` - -### Delete -```json -iottwinmaker:GetEntity, -iottwinmaker:GetWorkspace, -iottwinmaker:DeleteEntity -``` - diff --git a/docs/awscc-docs/providers/awscc/iottwinmaker/index.md b/docs/awscc-docs/providers/awscc/iottwinmaker/index.md deleted file mode 100644 index ebe50b350f..0000000000 --- a/docs/awscc-docs/providers/awscc/iottwinmaker/index.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -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 deleted file mode 100644 index 6548a83993..0000000000 --- a/docs/awscc-docs/providers/awscc/iottwinmaker/scene/index.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the scene resource, the following permissions are required: - -### Read -```json -iottwinmaker:GetWorkspace, -iottwinmaker:GetScene, -iottwinmaker:ListTagsForResource -``` - -### Update -```json -iottwinmaker:GetScene, -iottwinmaker:GetWorkspace, -iottwinmaker:ListTagsForResource, -iottwinmaker:TagResource, -iottwinmaker:UntagResource, -iottwinmaker:UpdateScene -``` - -### Delete -```json -iottwinmaker:DeleteScene, -iottwinmaker:GetScene, -iottwinmaker:GetWorkspace -``` - diff --git a/docs/awscc-docs/providers/awscc/iottwinmaker/scenes/index.md b/docs/awscc-docs/providers/awscc/iottwinmaker/scenes/index.md deleted file mode 100644 index d7a5a2402a..0000000000 --- a/docs/awscc-docs/providers/awscc/iottwinmaker/scenes/index.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -workspace_id, -scene_id -FROM awscc.iottwinmaker.scenes -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the scenes resource, the following permissions are required: - -### Create -```json -iottwinmaker:CreateScene, -iottwinmaker:GetScene, -iottwinmaker:GetWorkspace, -iottwinmaker:ListTagsForResource, -iottwinmaker:TagResource -``` - -### List -```json -iottwinmaker:GetWorkspace, -iottwinmaker:ListTagsForResource, -iottwinmaker:ListScenes -``` - diff --git a/docs/awscc-docs/providers/awscc/iottwinmaker/sync_job/index.md b/docs/awscc-docs/providers/awscc/iottwinmaker/sync_job/index.md deleted file mode 100644 index 16e13aac45..0000000000 --- a/docs/awscc-docs/providers/awscc/iottwinmaker/sync_job/index.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the sync_job resource, the following permissions are required: - -### Read -```json -iottwinmaker:GetSyncJob, -iottwinmaker:GetWorkspace, -iottwinmaker:ListTagsForResource -``` - -### Delete -```json -iottwinmaker:DeleteSyncJob, -iottwinmaker:GetSyncJob, -iottwinmaker:GetWorkspace -``` - diff --git a/docs/awscc-docs/providers/awscc/iottwinmaker/sync_jobs/index.md b/docs/awscc-docs/providers/awscc/iottwinmaker/sync_jobs/index.md deleted file mode 100644 index 48a188384a..0000000000 --- a/docs/awscc-docs/providers/awscc/iottwinmaker/sync_jobs/index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -workspace_id, -sync_source -FROM awscc.iottwinmaker.sync_jobs -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the sync_jobs resource, the following permissions are required: - -### Create -```json -iam:PassRole, -iottwinmaker:CreateSyncJob, -iottwinmaker:GetSyncJob, -iottwinmaker:GetWorkspace, -iottwinmaker:ListTagsForResource, -iottwinmaker:TagResource -``` - -### List -```json -iottwinmaker:GetWorkspace, -iottwinmaker:ListSyncJobs, -iottwinmaker:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/iottwinmaker/workspace/index.md b/docs/awscc-docs/providers/awscc/iottwinmaker/workspace/index.md deleted file mode 100644 index b633306df7..0000000000 --- a/docs/awscc-docs/providers/awscc/iottwinmaker/workspace/index.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -workspace_id, -arn, -description, -role, -s3_location, -creation_date_time, -update_date_time, -tags -FROM awscc.iottwinmaker.workspace -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the workspace resource, the following permissions are required: - -### Read -```json -iottwinmaker:GetWorkspace, -iottwinmaker:ListTagsForResource -``` - -### Update -```json -iottwinmaker:GetWorkspace, -iottwinmaker:ListTagsForResource, -iottwinmaker:TagResource, -iottwinmaker:UntagResource, -iottwinmaker:UpdateWorkspace -``` - -### Delete -```json -iottwinmaker:DeleteWorkspace, -iottwinmaker:GetWorkspace -``` - diff --git a/docs/awscc-docs/providers/awscc/iottwinmaker/workspaces/index.md b/docs/awscc-docs/providers/awscc/iottwinmaker/workspaces/index.md deleted file mode 100644 index 33d21fc24b..0000000000 --- a/docs/awscc-docs/providers/awscc/iottwinmaker/workspaces/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -workspace_id -FROM awscc.iottwinmaker.workspaces -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the workspaces resource, the following permissions are required: - -### Create -```json -iam:PassRole, -iottwinmaker:CreateWorkspace, -iottwinmaker:GetWorkspace, -iottwinmaker:ListTagsForResource, -iottwinmaker:TagResource -``` - -### List -```json -iottwinmaker:GetWorkspace, -iottwinmaker:ListTagsForResource, -iottwinmaker:ListWorkspaces -``` - diff --git a/docs/awscc-docs/providers/awscc/iotwireless/destination/index.md b/docs/awscc-docs/providers/awscc/iotwireless/destination/index.md deleted file mode 100644 index 835df803a7..0000000000 --- a/docs/awscc-docs/providers/awscc/iotwireless/destination/index.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -expression, -expression_type, -description, -tags, -role_arn, -arn -FROM awscc.iotwireless.destination -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the destination resource, the following permissions are required: - -### Read -```json -iotwireless:GetDestination, -iotwireless:ListTagsForResource -``` - -### Update -```json -iam:PassRole, -iotwireless:UpdateDestination, -iotwireless:UntagResource, -iotwireless:ListTagsForResource -``` - -### Delete -```json -iotwireless:DeleteDestination -``` - diff --git a/docs/awscc-docs/providers/awscc/iotwireless/destinations/index.md b/docs/awscc-docs/providers/awscc/iotwireless/destinations/index.md deleted file mode 100644 index 5ce18dc99f..0000000000 --- a/docs/awscc-docs/providers/awscc/iotwireless/destinations/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.iotwireless.destinations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the destinations resource, the following permissions are required: - -### Create -```json -iam:PassRole, -iotwireless:CreateDestination, -iotwireless:TagResource, -iotwireless:ListTagsForResource -``` - -### List -```json -iotwireless:ListDestinations, -iotwireless:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/iotwireless/device_profile/index.md b/docs/awscc-docs/providers/awscc/iotwireless/device_profile/index.md deleted file mode 100644 index 98273b31bf..0000000000 --- a/docs/awscc-docs/providers/awscc/iotwireless/device_profile/index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -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_wanobjectLoRaWANDeviceProfile 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. - -## Example -```sql -SELECT -region, -name, -lo_ra_wan, -tags, -arn, -id -FROM awscc.iotwireless.device_profile -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the device_profile resource, the following permissions are required: - -### Read -```json -iotwireless:GetDeviceProfile, -iotwireless:ListTagsForResource -``` - -### Delete -```json -iotwireless:DeleteDeviceProfile -``` - diff --git a/docs/awscc-docs/providers/awscc/iotwireless/device_profiles/index.md b/docs/awscc-docs/providers/awscc/iotwireless/device_profiles/index.md deleted file mode 100644 index 369910fbff..0000000000 --- a/docs/awscc-docs/providers/awscc/iotwireless/device_profiles/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.iotwireless.device_profiles -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the device_profiles resource, the following permissions are required: - -### Create -```json -iotwireless:CreateDeviceProfile, -iotwireless:TagResource, -iotwireless:ListTagsForResource -``` - -### List -```json -iotwireless:ListDeviceProfiles, -iotwireless:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/iotwireless/fuota_task/index.md b/docs/awscc-docs/providers/awscc/iotwireless/fuota_task/index.md deleted file mode 100644 index 54eeefa980..0000000000 --- a/docs/awscc-docs/providers/awscc/iotwireless/fuota_task/index.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -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_wanobjectFUOTA 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. - -## Example -```sql -SELECT -region, -name, -description, -lo_ra_wan, -firmware_update_image, -firmware_update_role, -arn, -id, -tags, -fuota_task_status, -associate_wireless_device, -disassociate_wireless_device, -associate_multicast_group, -disassociate_multicast_group -FROM awscc.iotwireless.fuota_task -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the fuota_task resource, the following permissions are required: - -### Read -```json -iotwireless:GetFuotaTask, -iotwireless:ListTagsForResource -``` - -### Update -```json -iam:PassRole, -iotwireless:UpdateFuotaTask, -iotwireless:UntagResource, -iotwireless:ListTagsForResource, -iotwireless:AssociateMulticastGroupWithFuotaTask, -iotwireless:DisassociateMulticastGroupFromFuotaTask, -iotwireless:AssociateWirelessDeviceWithFuotaTask, -iotwireless:DisassociateWirelessDeviceFromFuotaTask -``` - -### Delete -```json -iotwireless:DeleteFuotaTask -``` - diff --git a/docs/awscc-docs/providers/awscc/iotwireless/fuota_tasks/index.md b/docs/awscc-docs/providers/awscc/iotwireless/fuota_tasks/index.md deleted file mode 100644 index 057e746ca0..0000000000 --- a/docs/awscc-docs/providers/awscc/iotwireless/fuota_tasks/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.iotwireless.fuota_tasks -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the fuota_tasks resource, the following permissions are required: - -### Create -```json -iotwireless:CreateFuotaTask, -iotwireless:TagResource, -iotwireless:ListTagsForResource, -iam:GetRole, -iam:PassRole -``` - -### List -```json -iotwireless:ListFuotaTasks, -iotwireless:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/iotwireless/index.md b/docs/awscc-docs/providers/awscc/iotwireless/index.md deleted file mode 100644 index d9b13efc82..0000000000 --- a/docs/awscc-docs/providers/awscc/iotwireless/index.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -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 deleted file mode 100644 index d86727bef5..0000000000 --- a/docs/awscc-docs/providers/awscc/iotwireless/multicast_group/index.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -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_wanobjectMulticast 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. - -## Example -```sql -SELECT -region, -name, -description, -lo_ra_wan, -arn, -id, -tags, -status, -associate_wireless_device, -disassociate_wireless_device -FROM awscc.iotwireless.multicast_group -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the multicast_group resource, the following permissions are required: - -### Read -```json -iotwireless:GetMulticastGroup, -iotwireless:ListTagsForResource -``` - -### Update -```json -iotwireless:UpdateMulticastGroup, -iotwireless:UntagResource, -iotwireless:ListTagsForResource, -iotwireless:AssociateWirelessDeviceWithMulticastGroup, -iotwireless:DisassociateWirelessDeviceFromMulticastGroup -``` - -### Delete -```json -iotwireless:DeleteMulticastGroup -``` - diff --git a/docs/awscc-docs/providers/awscc/iotwireless/multicast_groups/index.md b/docs/awscc-docs/providers/awscc/iotwireless/multicast_groups/index.md deleted file mode 100644 index 9792fa284e..0000000000 --- a/docs/awscc-docs/providers/awscc/iotwireless/multicast_groups/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.iotwireless.multicast_groups -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the multicast_groups resource, the following permissions are required: - -### Create -```json -iotwireless:CreateMulticastGroup, -iotwireless:TagResource, -iotwireless:ListTagsForResource -``` - -### List -```json -iotwireless:ListMulticastGroups, -iotwireless:ListTagsForResource -``` - 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 deleted file mode 100644 index 79c3da7efb..0000000000 --- a/docs/awscc-docs/providers/awscc/iotwireless/network_analyzer_configuration/index.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -description, -trace_content, -wireless_devices, -wireless_gateways, -arn, -tags -FROM awscc.iotwireless.network_analyzer_configuration -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the network_analyzer_configuration resource, the following permissions are required: - -### Read -```json -iotwireless:GetNetworkAnalyzerConfiguration, -iotwireless:ListTagsForResource -``` - -### Update -```json -iotwireless:UpdateNetworkAnalyzerConfiguration, -iotwireless:UntagResource, -iotwireless:ListTagsForResource -``` - -### Delete -```json -iotwireless:DeleteNetworkAnalyzerConfiguration -``` - 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 deleted file mode 100644 index fcc721cfe4..0000000000 --- a/docs/awscc-docs/providers/awscc/iotwireless/network_analyzer_configurations/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.iotwireless.network_analyzer_configurations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the network_analyzer_configurations resource, the following permissions are required: - -### Create -```json -iotwireless:CreateNetworkAnalyzerConfiguration, -iotwireless:TagResource, -iotwireless:ListTagsForResource -``` - -### List -```json -iotwireless:ListNetworkAnalyzerConfigurations, -iotwireless:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/iotwireless/partner_account/index.md b/docs/awscc-docs/providers/awscc/iotwireless/partner_account/index.md deleted file mode 100644 index 49f20e1cce..0000000000 --- a/docs/awscc-docs/providers/awscc/iotwireless/partner_account/index.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the partner_account resource, the following permissions are required: - -### Read -```json -iotwireless:GetPartnerAccount, -iotwireless:ListTagsForResource -``` - -### Update -```json -iotwireless:UpdatePartnerAccount, -iotwireless:UntagResource, -iotwireless:ListTagsForResource -``` - -### Delete -```json -iotwireless:DisassociateAwsAccountFromPartnerAccount -``` - diff --git a/docs/awscc-docs/providers/awscc/iotwireless/partner_accounts/index.md b/docs/awscc-docs/providers/awscc/iotwireless/partner_accounts/index.md deleted file mode 100644 index 225d00b046..0000000000 --- a/docs/awscc-docs/providers/awscc/iotwireless/partner_accounts/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -partner_account_id -FROM awscc.iotwireless.partner_accounts -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the partner_accounts resource, the following permissions are required: - -### Create -```json -iotwireless:AssociateAwsAccountWithPartnerAccount, -iotwireless:TagResource, -iotwireless:ListTagsForResource -``` - -### List -```json -iotwireless:ListPartnerAccounts, -iotwireless:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/iotwireless/service_profile/index.md b/docs/awscc-docs/providers/awscc/iotwireless/service_profile/index.md deleted file mode 100644 index add4f0cf79..0000000000 --- a/docs/awscc-docs/providers/awscc/iotwireless/service_profile/index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -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_wanobjectLoRaWAN 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. - -## Example -```sql -SELECT -region, -name, -lo_ra_wan, -tags, -arn, -id -FROM awscc.iotwireless.service_profile -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the service_profile resource, the following permissions are required: - -### Read -```json -iotwireless:GetServiceProfile, -iotwireless:ListTagsForResource -``` - -### Delete -```json -iotwireless:DeleteServiceProfile -``` - diff --git a/docs/awscc-docs/providers/awscc/iotwireless/service_profiles/index.md b/docs/awscc-docs/providers/awscc/iotwireless/service_profiles/index.md deleted file mode 100644 index 641b5d985a..0000000000 --- a/docs/awscc-docs/providers/awscc/iotwireless/service_profiles/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.iotwireless.service_profiles -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the service_profiles resource, the following permissions are required: - -### Create -```json -iotwireless:CreateServiceProfile, -iotwireless:TagResource, -iotwireless:ListTagsForResource -``` - -### List -```json -iotwireless:ListServiceProfiles, -iotwireless:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/iotwireless/task_definition/index.md b/docs/awscc-docs/providers/awscc/iotwireless/task_definition/index.md deleted file mode 100644 index a51de04a48..0000000000 --- a/docs/awscc-docs/providers/awscc/iotwireless/task_definition/index.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -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_wan_update_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. - -## Example -```sql -SELECT -region, -name, -auto_create_tasks, -update, -lo_ra_wan_update_gateway_task_entry, -id, -task_definition_type, -arn, -tags -FROM awscc.iotwireless.task_definition -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the task_definition resource, the following permissions are required: - -### Read -```json -iotwireless:GetWirelessGatewayTaskDefinition, -iotwireless:ListTagsForResource -``` - -### Delete -```json -iotwireless:DeleteWirelessGatewayTaskDefinition -``` - diff --git a/docs/awscc-docs/providers/awscc/iotwireless/task_definitions/index.md b/docs/awscc-docs/providers/awscc/iotwireless/task_definitions/index.md deleted file mode 100644 index c79330264a..0000000000 --- a/docs/awscc-docs/providers/awscc/iotwireless/task_definitions/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.iotwireless.task_definitions -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the task_definitions resource, the following permissions are required: - -### Create -```json -iotwireless:CreateWirelessGatewayTaskDefinition, -iotwireless:TagResource, -iotwireless:ListTagsForResource, -iam:GetRole, -iam:PassRole -``` - -### List -```json -iotwireless:ListWirelessGatewayTaskDefinitions, -iotwireless:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/iotwireless/wireless_device/index.md b/docs/awscc-docs/providers/awscc/iotwireless/wireless_device/index.md deleted file mode 100644 index 8c4e103223..0000000000 --- a/docs/awscc-docs/providers/awscc/iotwireless/wireless_device/index.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -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_wanobjectThe 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. - -## Example -```sql -SELECT -region, -type, -name, -description, -destination_name, -lo_ra_wan, -tags, -arn, -id, -thing_arn, -thing_name, -last_uplink_received_at, -positioning -FROM awscc.iotwireless.wireless_device -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the wireless_device resource, the following permissions are required: - -### Read -```json -iotwireless:GetWirelessDevice, -iotwireless:ListTagsForResource -``` - -### Update -```json -iotwireless:UpdateWirelessDevice, -iotwireless:UntagResource, -iotwireless:ListTagsForResource, -iotwireless:AssociateWirelessDeviceWithThing -``` - -### Delete -```json -iotwireless:DeleteWirelessDevice, -iotwireless:DisassociateWirelessDeviceFromThing -``` - 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 deleted file mode 100644 index ee37e35812..0000000000 --- a/docs/awscc-docs/providers/awscc/iotwireless/wireless_device_import_task/index.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the wireless_device_import_task resource, the following permissions are required: - -### Read -```json -iotwireless:GetWirelessDeviceImportTask, -iotwireless:ListTagsForResource -``` - -### Update -```json -iotwireless:UpdateWirelessDeviceImportTask, -iotwireless:UntagResource, -iotwireless:ListTagsForResource, -iam:PassRole -``` - -### Delete -```json -iotwireless:DeleteWirelessDeviceImportTask -``` - 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 deleted file mode 100644 index 8fbdff6edb..0000000000 --- a/docs/awscc-docs/providers/awscc/iotwireless/wireless_device_import_tasks/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.iotwireless.wireless_device_import_tasks -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the wireless_device_import_tasks resource, the following permissions are required: - -### Create -```json -iotwireless:StartWirelessDeviceImportTask, -iotwireless:StartSingleWirelessDeviceImportTask, -iotwireless:TagResource, -iotwireless:ListTagsForResource, -iam:PassRole -``` - -### List -```json -iotwireless:ListWirelessDeviceImportTasks, -iotwireless:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/iotwireless/wireless_devices/index.md b/docs/awscc-docs/providers/awscc/iotwireless/wireless_devices/index.md deleted file mode 100644 index 2acc7dc552..0000000000 --- a/docs/awscc-docs/providers/awscc/iotwireless/wireless_devices/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.iotwireless.wireless_devices -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the wireless_devices resource, the following permissions are required: - -### Create -```json -iotwireless:CreateWirelessDevice, -iotwireless:TagResource, -iotwireless:ListTagsForResource -``` - -### List -```json -iotwireless:ListWirelessDevices, -iotwireless:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/iotwireless/wireless_gateway/index.md b/docs/awscc-docs/providers/awscc/iotwireless/wireless_gateway/index.md deleted file mode 100644 index 24754e39c3..0000000000 --- a/docs/awscc-docs/providers/awscc/iotwireless/wireless_gateway/index.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -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_wanobjectThe 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. - -## Example -```sql -SELECT -region, -name, -description, -tags, -lo_ra_wan, -arn, -id, -thing_arn, -thing_name, -last_uplink_received_at -FROM awscc.iotwireless.wireless_gateway -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the wireless_gateway resource, the following permissions are required: - -### Read -```json -iotwireless:GetWirelessGateway, -iotwireless:ListTagsForResource -``` - -### Update -```json -iotwireless:UpdateWirelessGateway, -iotwireless:UntagResource, -iotwireless:ListTagsForResource, -iotwireless:AssociateWirelessGatewayWithThing -``` - -### Delete -```json -iotwireless:DeleteWirelessGateway, -iotwireless:DisassociateWirelessGatewayFromThing -``` - diff --git a/docs/awscc-docs/providers/awscc/iotwireless/wireless_gateways/index.md b/docs/awscc-docs/providers/awscc/iotwireless/wireless_gateways/index.md deleted file mode 100644 index 9c18e8b7ed..0000000000 --- a/docs/awscc-docs/providers/awscc/iotwireless/wireless_gateways/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.iotwireless.wireless_gateways -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the wireless_gateways resource, the following permissions are required: - -### Create -```json -iotwireless:CreateWirelessGateway, -iotwireless:TagResource, -iotwireless:ListTagsForResource -``` - -### List -```json -iotwireless:ListWirelessGateways, -iotwireless:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/ivs/channel/index.md b/docs/awscc-docs/providers/awscc/ivs/channel/index.md deleted file mode 100644 index a0c9cb4305..0000000000 --- a/docs/awscc-docs/providers/awscc/ivs/channel/index.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the channel resource, the following permissions are required: - -### Read -```json -ivs:GetChannel, -ivs:ListTagsForResource -``` - -### Update -```json -ivs:GetChannel, -ivs:UpdateChannel, -ivs:TagResource, -ivs:UnTagResource, -ivs:ListTagsForResource -``` - -### Delete -```json -ivs:DeleteChannel, -ivs:UnTagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/ivs/channels/index.md b/docs/awscc-docs/providers/awscc/ivs/channels/index.md deleted file mode 100644 index 693bb72105..0000000000 --- a/docs/awscc-docs/providers/awscc/ivs/channels/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.ivs.channels -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the channels resource, the following permissions are required: - -### Create -```json -ivs:CreateChannel, -ivs:TagResource -``` - -### List -```json -ivs:ListChannels, -ivs:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/ivs/index.md b/docs/awscc-docs/providers/awscc/ivs/index.md deleted file mode 100644 index 6193a087b7..0000000000 --- a/docs/awscc-docs/providers/awscc/ivs/index.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -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 deleted file mode 100644 index 09face0794..0000000000 --- a/docs/awscc-docs/providers/awscc/ivs/playback_key_pair/index.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -public_key_material, -fingerprint, -arn, -tags -FROM awscc.ivs.playback_key_pair -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the playback_key_pair resource, the following permissions are required: - -### Read -```json -ivs:GetPlaybackKeyPair -``` - -### Update -```json -ivs:GetPlaybackKeyPair, -ivs:ListTagsForResource, -ivs:UntagResource, -ivs:TagResource -``` - -### Delete -```json -ivs:DeletePlaybackKeyPair, -ivs:UntagResource -``` - 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 deleted file mode 100644 index e585479abe..0000000000 --- a/docs/awscc-docs/providers/awscc/ivs/playback_key_pairs/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.ivs.playback_key_pairs -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the playback_key_pairs resource, the following permissions are required: - -### Create -```json -ivs:ImportPlaybackKeyPair, -ivs:TagResource -``` - -### List -```json -ivs:ListPlaybackKeyPairs, -ivs:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/ivs/recording_configuration/index.md b/docs/awscc-docs/providers/awscc/ivs/recording_configuration/index.md deleted file mode 100644 index a54445ac1c..0000000000 --- a/docs/awscc-docs/providers/awscc/ivs/recording_configuration/index.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -name, -state, -recording_reconnect_window_seconds, -destination_configuration, -tags, -thumbnail_configuration, -rendition_configuration -FROM awscc.ivs.recording_configuration -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the recording_configuration resource, the following permissions are required: - -### Read -```json -ivs:GetRecordingConfiguration, -s3:GetBucketLocation, -ivs:ListTagsForResource -``` - -### Update -```json -ivs:GetRecordingConfiguration, -sts:AssumeRole, -iam:CreateServiceLinkedRole, -iam:PutRolePolicy, -iam:AttachRolePolicy, -s3:ListBucket, -ivs:TagResource, -ivs:UntagResource, -ivs:ListTagsForResource -``` - -### Delete -```json -ivs:DeleteRecordingConfiguration, -ivs:UntagResource, -iam:CreateServiceLinkedRole -``` - diff --git a/docs/awscc-docs/providers/awscc/ivs/recording_configurations/index.md b/docs/awscc-docs/providers/awscc/ivs/recording_configurations/index.md deleted file mode 100644 index 8c023c8eb7..0000000000 --- a/docs/awscc-docs/providers/awscc/ivs/recording_configurations/index.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.ivs.recording_configurations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the recording_configurations resource, the following permissions are required: - -### Create -```json -ivs:CreateRecordingConfiguration, -ivs:GetRecordingConfiguration, -ivs:TagResource, -iam:CreateServiceLinkedRole, -iam:PutRolePolicy, -iam:AttachRolePolicy, -s3:ListBucket, -s3:GetBucketLocation, -cloudformation:ListExports -``` - -### List -```json -ivs:ListRecordingConfigurations, -s3:GetBucketLocation, -ivs:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/ivs/stage/index.md b/docs/awscc-docs/providers/awscc/ivs/stage/index.md deleted file mode 100644 index ab38d3cf43..0000000000 --- a/docs/awscc-docs/providers/awscc/ivs/stage/index.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -name, -tags, -active_session_id -FROM awscc.ivs.stage -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the stage resource, the following permissions are required: - -### Read -```json -ivs:GetStage, -ivs:ListTagsForResource -``` - -### Update -```json -ivs:GetStage, -ivs:UpdateStage, -ivs:TagResource, -ivs:UnTagResource, -ivs:ListTagsForResource -``` - -### Delete -```json -ivs:DeleteStage, -ivs:UnTagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/ivs/stages/index.md b/docs/awscc-docs/providers/awscc/ivs/stages/index.md deleted file mode 100644 index a507d35108..0000000000 --- a/docs/awscc-docs/providers/awscc/ivs/stages/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.ivs.stages -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the stages resource, the following permissions are required: - -### Create -```json -ivs:CreateStage, -ivs:GetStage, -ivs:TagResource, -ivs:ListTagsForResource -``` - -### List -```json -ivs:ListStages, -ivs:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/ivs/stream_key/index.md b/docs/awscc-docs/providers/awscc/ivs/stream_key/index.md deleted file mode 100644 index d0a316dc34..0000000000 --- a/docs/awscc-docs/providers/awscc/ivs/stream_key/index.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -channel_arn, -tags, -value -FROM awscc.ivs.stream_key -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the stream_key resource, the following permissions are required: - -### Read -```json -ivs:GetStreamKey, -ivs:ListTagsForResource -``` - -### Update -```json -ivs:GetStreamKey, -ivs:TagResource, -ivs:UntagResource, -ivs:ListTagsForResource -``` - -### Delete -```json -ivs:DeleteStreamKey, -ivs:UntagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/ivs/stream_keys/index.md b/docs/awscc-docs/providers/awscc/ivs/stream_keys/index.md deleted file mode 100644 index 97c51b811a..0000000000 --- a/docs/awscc-docs/providers/awscc/ivs/stream_keys/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.ivs.stream_keys -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the stream_keys resource, the following permissions are required: - -### Create -```json -ivs:TagResource, -ivs:UntagResource, -ivs:CreateStreamKey -``` - -### List -```json -ivs:ListStreamKeys, -ivs:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/ivschat/index.md b/docs/awscc-docs/providers/awscc/ivschat/index.md deleted file mode 100644 index d271e9d460..0000000000 --- a/docs/awscc-docs/providers/awscc/ivschat/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index ffd3096d45..0000000000 --- a/docs/awscc-docs/providers/awscc/ivschat/logging_configuration/index.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -id, -destination_configuration, -name, -state, -tags -FROM awscc.ivschat.logging_configuration -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the logging_configuration resource, the following permissions are required: - -### Read -```json -ivschat:GetLoggingConfiguration, -ivschat:ListTagsForResource -``` - -### Update -```json -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 -```json -ivschat:DeleteLoggingConfiguration, -ivschat:GetLoggingConfiguration, -logs:DeleteLogDelivery, -logs:ListLogDeliveries, -ivschat:UntagResource, -logs:GetLogDelivery -``` - diff --git a/docs/awscc-docs/providers/awscc/ivschat/logging_configurations/index.md b/docs/awscc-docs/providers/awscc/ivschat/logging_configurations/index.md deleted file mode 100644 index e8087f15c3..0000000000 --- a/docs/awscc-docs/providers/awscc/ivschat/logging_configurations/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.ivschat.logging_configurations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the logging_configurations resource, the following permissions are required: - -### Create -```json -ivschat:CreateLoggingConfiguration, -ivschat:GetLoggingConfiguration, -logs:CreateLogDelivery, -logs:PutResourcePolicy, -logs:DescribeResourcePolicies, -logs:DescribeLogGroups, -s3:PutBucketPolicy, -s3:GetBucketPolicy, -iam:CreateServiceLinkedRole, -firehose:TagDeliveryStream, -ivschat:TagResource -``` - -### List -```json -ivschat:ListLoggingConfigurations, -ivschat:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/ivschat/room/index.md b/docs/awscc-docs/providers/awscc/ivschat/room/index.md deleted file mode 100644 index 41100c05c5..0000000000 --- a/docs/awscc-docs/providers/awscc/ivschat/room/index.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the room resource, the following permissions are required: - -### Read -```json -ivschat:GetRoom, -ivschat:ListTagsForResource -``` - -### Update -```json -ivschat:UpdateRoom, -ivschat:TagResource, -ivschat:UnTagResource, -ivschat:ListTagsForResource -``` - -### Delete -```json -ivschat:DeleteRoom, -ivschat:UntagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/ivschat/rooms/index.md b/docs/awscc-docs/providers/awscc/ivschat/rooms/index.md deleted file mode 100644 index f3eec5547c..0000000000 --- a/docs/awscc-docs/providers/awscc/ivschat/rooms/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.ivschat.rooms -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the rooms resource, the following permissions are required: - -### Create -```json -ivschat:CreateRoom, -ivschat:TagResource -``` - -### List -```json -ivschat:ListRooms, -ivschat:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/kafkaconnect/connector/index.md b/docs/awscc-docs/providers/awscc/kafkaconnect/connector/index.md deleted file mode 100644 index a7a9054b82..0000000000 --- a/docs/awscc-docs/providers/awscc/kafkaconnect/connector/index.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the connector resource, the following permissions are required: - -### Read -```json -kafkaconnect:DescribeConnector -``` - -### Delete -```json -kafkaconnect:DeleteConnector, -kafkaconnect:DescribeConnector, -logs:DeleteLogDelivery, -logs:GetLogDelivery, -logs:ListLogDeliveries -``` - -### Update -```json -kafkaconnect:UpdateConnector, -kafkaconnect:DescribeConnector, -iam:CreateServiceLinkedRole, -logs:UpdateLogDelivery, -logs:GetLogDelivery, -logs:ListLogDeliveries, -logs:PutResourcePolicy, -logs:DescribeResourcePolicies, -logs:DescribeLogGroups, -s3:GetBucketPolicy, -s3:PutBucketPolicy, -firehose:TagDeliveryStream -``` - diff --git a/docs/awscc-docs/providers/awscc/kafkaconnect/connectors/index.md b/docs/awscc-docs/providers/awscc/kafkaconnect/connectors/index.md deleted file mode 100644 index 75c6ad6344..0000000000 --- a/docs/awscc-docs/providers/awscc/kafkaconnect/connectors/index.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -connector_arn -FROM awscc.kafkaconnect.connectors -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the connectors resource, the following permissions are required: - -### Create -```json -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 -```json -kafkaconnect:ListConnectors -``` - diff --git a/docs/awscc-docs/providers/awscc/kafkaconnect/index.md b/docs/awscc-docs/providers/awscc/kafkaconnect/index.md deleted file mode 100644 index ba85c668f1..0000000000 --- a/docs/awscc-docs/providers/awscc/kafkaconnect/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 deleted file mode 100644 index 289864eadd..0000000000 --- a/docs/awscc-docs/providers/awscc/kendra/data_source/index.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the data_source resource, the following permissions are required: - -### Read -```json -kendra:DescribeDataSource, -kendra:ListTagsForResource -``` - -### Delete -```json -kendra:DescribeDataSource, -kendra:DeleteDataSource -``` - -### Update -```json -kendra:DescribeDataSource, -kendra:UpdateDataSource, -kendra:ListTagsForResource, -kendra:TagResource, -kendra:UntagResource, -iam:PassRole -``` - diff --git a/docs/awscc-docs/providers/awscc/kendra/data_sources/index.md b/docs/awscc-docs/providers/awscc/kendra/data_sources/index.md deleted file mode 100644 index cda382e17e..0000000000 --- a/docs/awscc-docs/providers/awscc/kendra/data_sources/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id, -index_id -FROM awscc.kendra.data_sources -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the data_sources resource, the following permissions are required: - -### Create -```json -kendra:CreateDataSource, -kendra:DescribeDataSource, -kendra:ListTagsForResource, -iam:PassRole, -kendra:TagResource -``` - -### List -```json -kendra:ListDataSources -``` - diff --git a/docs/awscc-docs/providers/awscc/kendra/faq/index.md b/docs/awscc-docs/providers/awscc/kendra/faq/index.md deleted file mode 100644 index 37fba31589..0000000000 --- a/docs/awscc-docs/providers/awscc/kendra/faq/index.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id, -index_id, -name, -description, -file_format, -s3_path, -role_arn, -tags, -arn -FROM awscc.kendra.faq -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the faq resource, the following permissions are required: - -### Update -```json -kendra:ListTagsForResource, -kendra:UntagResource, -kendra:TagResource -``` - -### Read -```json -kendra:DescribeFaq, -kendra:ListTagsForResource -``` - -### Delete -```json -kendra:DeleteFaq, -kendra:DescribeFaq -``` - diff --git a/docs/awscc-docs/providers/awscc/kendra/faqs/index.md b/docs/awscc-docs/providers/awscc/kendra/faqs/index.md deleted file mode 100644 index 0c46ef7058..0000000000 --- a/docs/awscc-docs/providers/awscc/kendra/faqs/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id, -index_id -FROM awscc.kendra.faqs -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the faqs resource, the following permissions are required: - -### Create -```json -kendra:CreateFaq, -kendra:DescribeFaq, -iam:PassRole, -kendra:ListTagsForResource, -kendra:TagResource -``` - -### List -```json -kendra:ListFaqs -``` - diff --git a/docs/awscc-docs/providers/awscc/kendra/index.md b/docs/awscc-docs/providers/awscc/kendra/index.md deleted file mode 100644 index 11690037a6..0000000000 --- a/docs/awscc-docs/providers/awscc/kendra/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -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 deleted file mode 100644 index ca3bdc7e06..0000000000 --- a/docs/awscc-docs/providers/awscc/kendra/index/index.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the index resource, the following permissions are required: - -### Read -```json -kendra:DescribeIndex, -kendra:ListTagsForResource -``` - -### Update -```json -kendra:DescribeIndex, -kendra:UpdateIndex, -kendra:ListTagsForResource, -kendra:TagResource, -kendra:UntagResource, -iam:PassRole -``` - -### Delete -```json -kendra:DescribeIndex, -kendra:DeleteIndex -``` - diff --git a/docs/awscc-docs/providers/awscc/kendra/indices/index.md b/docs/awscc-docs/providers/awscc/kendra/indices/index.md deleted file mode 100644 index 9206ea8cda..0000000000 --- a/docs/awscc-docs/providers/awscc/kendra/indices/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.kendra.indices -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the indices resource, the following permissions are required: - -### Create -```json -kendra:CreateIndex, -kendra:DescribeIndex, -kendra:UpdateIndex, -kendra:ListTagsForResource, -iam:PassRole, -kendra:TagResource -``` - -### List -```json -kendra:ListIndices -``` - diff --git a/docs/awscc-docs/providers/awscc/kendraranking/execution_plan/index.md b/docs/awscc-docs/providers/awscc/kendraranking/execution_plan/index.md deleted file mode 100644 index 22485f257e..0000000000 --- a/docs/awscc-docs/providers/awscc/kendraranking/execution_plan/index.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id, -arn, -description, -tags, -name, -capacity_units -FROM awscc.kendraranking.execution_plan -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the execution_plan resource, the following permissions are required: - -### Read -```json -kendra-ranking:DescribeRescoreExecutionPlan, -kendra-ranking:ListTagsForResource -``` - -### Update -```json -kendra-ranking:DescribeRescoreExecutionPlan, -kendra-ranking:UpdateRescoreExecutionPlan, -kendra-ranking:ListTagsForResource, -kendra-ranking:TagResource, -kendra-ranking:UntagResource -``` - -### Delete -```json -kendra-ranking:DescribeRescoreExecutionPlan, -kendra-ranking:DeleteRescoreExecutionPlan -``` - diff --git a/docs/awscc-docs/providers/awscc/kendraranking/execution_plans/index.md b/docs/awscc-docs/providers/awscc/kendraranking/execution_plans/index.md deleted file mode 100644 index 75ff5f8042..0000000000 --- a/docs/awscc-docs/providers/awscc/kendraranking/execution_plans/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.kendraranking.execution_plans -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the execution_plans resource, the following permissions are required: - -### Create -```json -kendra-ranking:CreateRescoreExecutionPlan, -kendra-ranking:DescribeRescoreExecutionPlan, -kendra-ranking:UpdateRescoreExecutionPlan, -kendra-ranking:ListTagsForResource, -kendra-ranking:TagResource -``` - -### List -```json -kendra-ranking:ListRescoreExecutionPlans -``` - diff --git a/docs/awscc-docs/providers/awscc/kendraranking/index.md b/docs/awscc-docs/providers/awscc/kendraranking/index.md deleted file mode 100644 index 3ab3b79c62..0000000000 --- a/docs/awscc-docs/providers/awscc/kendraranking/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 deleted file mode 100644 index 35d1b76523..0000000000 --- a/docs/awscc-docs/providers/awscc/kinesis/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 deleted file mode 100644 index 14688e038a..0000000000 --- a/docs/awscc-docs/providers/awscc/kinesis/kinesis_stream/index.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -stream_mode_details, -stream_encryption, -arn, -retention_period_hours, -tags, -name, -shard_count -FROM awscc.kinesis.kinesis_stream -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the kinesis_stream resource, the following permissions are required: - -### Read -```json -kinesis:DescribeStreamSummary, -kinesis:ListTagsForStream -``` - -### Update -```json -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 -```json -kinesis:DescribeStreamSummary, -kinesis:DeleteStream, -kinesis:RemoveTagsFromStream -``` - diff --git a/docs/awscc-docs/providers/awscc/kinesis/streams/index.md b/docs/awscc-docs/providers/awscc/kinesis/streams/index.md deleted file mode 100644 index 90fbd70196..0000000000 --- a/docs/awscc-docs/providers/awscc/kinesis/streams/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.kinesis.streams -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the streams resource, the following permissions are required: - -### Create -```json -kinesis:EnableEnhancedMonitoring, -kinesis:DescribeStreamSummary, -kinesis:CreateStream, -kinesis:IncreaseStreamRetentionPeriod, -kinesis:StartStreamEncryption, -kinesis:AddTagsToStream, -kinesis:ListTagsForStream -``` - -### List -```json -kinesis:ListStreams -``` - diff --git a/docs/awscc-docs/providers/awscc/kinesisanalyticsv2/application/index.md b/docs/awscc-docs/providers/awscc/kinesisanalyticsv2/application/index.md deleted file mode 100644 index c3997167a3..0000000000 --- a/docs/awscc-docs/providers/awscc/kinesisanalyticsv2/application/index.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the application resource, the following permissions are required: - -### Read -```json -kinesisanalytics:DescribeApplication, -kinesisanalytics:ListTagsForResource -``` - -### Update -```json -kinesisanalytics:UpdateApplication, -kinesisanalytics:DescribeApplication, -kinesisanalytics:TagResource, -kinesisanalytics:UntagResource, -kinesisanalytics:AddApplicationVpcConfiguration, -kinesisanalytics:DeleteApplicationVpcConfiguration, -kinesisanalytics:UpdateApplicationMaintenanceConfiguration, -kinesisanalytics:ListTagsForResource -``` - -### Delete -```json -kinesisanalytics:DescribeApplication, -kinesisanalytics:DeleteApplication -``` - diff --git a/docs/awscc-docs/providers/awscc/kinesisanalyticsv2/applications/index.md b/docs/awscc-docs/providers/awscc/kinesisanalyticsv2/applications/index.md deleted file mode 100644 index 71d2fef11b..0000000000 --- a/docs/awscc-docs/providers/awscc/kinesisanalyticsv2/applications/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -application_name -FROM awscc.kinesisanalyticsv2.applications -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the applications resource, the following permissions are required: - -### Create -```json -iam:PassRole, -kinesisanalytics:CreateApplication, -kinesisanalytics:DescribeApplication, -kinesisanalytics:ListTagsForResource, -kinesisanalytics:UpdateApplicationMaintenanceConfiguration -``` - -### List -```json -kinesisanalytics:ListApplications -``` - diff --git a/docs/awscc-docs/providers/awscc/kinesisanalyticsv2/index.md b/docs/awscc-docs/providers/awscc/kinesisanalyticsv2/index.md deleted file mode 100644 index 4cd768cdfa..0000000000 --- a/docs/awscc-docs/providers/awscc/kinesisanalyticsv2/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 deleted file mode 100644 index 1ef4b01632..0000000000 --- a/docs/awscc-docs/providers/awscc/kinesisfirehose/delivery_stream/index.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -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
msk_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. - -## 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, -msk_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 data__Identifier = ''; -``` - -## Permissions - -To operate on the delivery_stream resource, the following permissions are required: - -### Read -```json -firehose:DescribeDeliveryStream, -firehose:ListTagsForDeliveryStream -``` - -### Update -```json -firehose:UpdateDestination, -firehose:DescribeDeliveryStream, -firehose:StartDeliveryStreamEncryption, -firehose:StopDeliveryStreamEncryption, -firehose:ListTagsForDeliveryStream, -firehose:TagDeliveryStream, -firehose:UntagDeliveryStream, -kms:CreateGrant, -kms:RevokeGrant, -kms:DescribeKey -``` - -### Delete -```json -firehose:DeleteDeliveryStream, -firehose:DescribeDeliveryStream, -kms:RevokeGrant, -kms:DescribeKey -``` - diff --git a/docs/awscc-docs/providers/awscc/kinesisfirehose/delivery_streams/index.md b/docs/awscc-docs/providers/awscc/kinesisfirehose/delivery_streams/index.md deleted file mode 100644 index 0fb2effe11..0000000000 --- a/docs/awscc-docs/providers/awscc/kinesisfirehose/delivery_streams/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -delivery_stream_name -FROM awscc.kinesisfirehose.delivery_streams -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the delivery_streams resource, the following permissions are required: - -### Create -```json -firehose:CreateDeliveryStream, -firehose:DescribeDeliveryStream, -iam:GetRole, -iam:PassRole, -kms:CreateGrant, -kms:DescribeKey -``` - -### List -```json -firehose:ListDeliveryStreams -``` - diff --git a/docs/awscc-docs/providers/awscc/kinesisfirehose/index.md b/docs/awscc-docs/providers/awscc/kinesisfirehose/index.md deleted file mode 100644 index 1dd82f724d..0000000000 --- a/docs/awscc-docs/providers/awscc/kinesisfirehose/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 deleted file mode 100644 index 85c95000ee..0000000000 --- a/docs/awscc-docs/providers/awscc/kinesisvideo/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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: 2
-total selectable resources: 2
-total methods: 2
-
-
- -::: - -## Resources -
-
-kinesisvideo_stream -
-
-signaling_channel -
-
\ 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 deleted file mode 100644 index cfd2f11dc9..0000000000 --- a/docs/awscc-docs/providers/awscc/kinesisvideo/kinesisvideo_stream/index.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -name, -data_retention_in_hours, -device_name, -kms_key_id, -media_type, -tags -FROM awscc.kinesisvideo.kinesisvideo_stream -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the kinesisvideo_stream resource, the following permissions are required: - -### Read -```json -kinesisvideo:DescribeStream -``` - -### Update -```json -kinesisvideo:DescribeStream, -kinesisvideo:UpdateStream, -kinesisvideo:UpdateDataRetention -``` - -### Delete -```json -kinesisvideo:DescribeStream, -kinesisvideo:DeleteStream -``` - diff --git a/docs/awscc-docs/providers/awscc/kinesisvideo/signaling_channel/index.md b/docs/awscc-docs/providers/awscc/kinesisvideo/signaling_channel/index.md deleted file mode 100644 index ed68454584..0000000000 --- a/docs/awscc-docs/providers/awscc/kinesisvideo/signaling_channel/index.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -name, -type, -message_ttl_seconds, -tags -FROM awscc.kinesisvideo.signaling_channel -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the signaling_channel resource, the following permissions are required: - -### Read -```json -kinesisvideo:DescribeSignalingChannel -``` - -### Update -```json -kinesisvideo:UpdateSignalingChannel, -kinesisvideo:DescribeSignalingChannel -``` - -### Delete -```json -kinesisvideo:DeleteSignalingChannel, -kinesisvideo:DescribeSignalingChannel -``` - diff --git a/docs/awscc-docs/providers/awscc/kms/alias/index.md b/docs/awscc-docs/providers/awscc/kms/alias/index.md deleted file mode 100644 index 76cb1800b0..0000000000 --- a/docs/awscc-docs/providers/awscc/kms/alias/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -target_key_id, -alias_name -FROM awscc.kms.alias -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the alias resource, the following permissions are required: - -### Read -```json -kms:ListAliases -``` - -### Update -```json -kms:UpdateAlias -``` - -### Delete -```json -kms:DeleteAlias -``` - diff --git a/docs/awscc-docs/providers/awscc/kms/aliases/index.md b/docs/awscc-docs/providers/awscc/kms/aliases/index.md deleted file mode 100644 index 0aa0a96499..0000000000 --- a/docs/awscc-docs/providers/awscc/kms/aliases/index.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -alias_name -FROM awscc.kms.aliases -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the aliases resource, the following permissions are required: - -### Create -```json -kms:CreateAlias -``` - -### List -```json -kms:ListAliases -``` - diff --git a/docs/awscc-docs/providers/awscc/kms/index.md b/docs/awscc-docs/providers/awscc/kms/index.md deleted file mode 100644 index d89bcb8668..0000000000 --- a/docs/awscc-docs/providers/awscc/kms/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -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 deleted file mode 100644 index 4e654b3005..0000000000 --- a/docs/awscc-docs/providers/awscc/kms/key/index.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the key resource, the following permissions are required: - -### Read -```json -kms:DescribeKey, -kms:GetKeyPolicy, -kms:GetKeyRotationStatus, -kms:ListResourceTags -``` - -### Update -```json -kms:DescribeKey, -kms:DisableKey, -kms:DisableKeyRotation, -kms:EnableKey, -kms:EnableKeyRotation, -kms:PutKeyPolicy, -kms:TagResource, -kms:UntagResource, -kms:UpdateKeyDescription, -kms:ListResourceTags -``` - -### Delete -```json -kms:DescribeKey, -kms:ScheduleKeyDeletion -``` - diff --git a/docs/awscc-docs/providers/awscc/kms/keys/index.md b/docs/awscc-docs/providers/awscc/kms/keys/index.md deleted file mode 100644 index a591539921..0000000000 --- a/docs/awscc-docs/providers/awscc/kms/keys/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -key_id -FROM awscc.kms.keys -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the keys resource, the following permissions are required: - -### Create -```json -kms:CreateKey, -kms:EnableKeyRotation, -kms:DisableKey, -kms:TagResource, -kms:PutKeyPolicy -``` - -### List -```json -kms:ListKeys, -kms:DescribeKey -``` - diff --git a/docs/awscc-docs/providers/awscc/kms/replica_key/index.md b/docs/awscc-docs/providers/awscc/kms/replica_key/index.md deleted file mode 100644 index 0ed5d04598..0000000000 --- a/docs/awscc-docs/providers/awscc/kms/replica_key/index.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the replica_key resource, the following permissions are required: - -### Read -```json -kms:DescribeKey, -kms:GetKeyPolicy, -kms:ListResourceTags -``` - -### Update -```json -kms:DescribeKey, -kms:DisableKey, -kms:EnableKey, -kms:PutKeyPolicy, -kms:TagResource, -kms:UntagResource, -kms:UpdateKeyDescription -``` - -### Delete -```json -kms:DescribeKey, -kms:ScheduleKeyDeletion -``` - diff --git a/docs/awscc-docs/providers/awscc/kms/replica_keys/index.md b/docs/awscc-docs/providers/awscc/kms/replica_keys/index.md deleted file mode 100644 index bbdd71a161..0000000000 --- a/docs/awscc-docs/providers/awscc/kms/replica_keys/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -key_id -FROM awscc.kms.replica_keys -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the replica_keys resource, the following permissions are required: - -### Create -```json -kms:ReplicateKey, -kms:CreateKey, -kms:DescribeKey, -kms:DisableKey, -kms:TagResource -``` - -### List -```json -kms:ListKeys, -kms:DescribeKey -``` - 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 deleted file mode 100644 index 0ed74b927f..0000000000 --- a/docs/awscc-docs/providers/awscc/lakeformation/data_cells_filter/index.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|||'; -``` - -## Permissions - -To operate on the data_cells_filter resource, the following permissions are required: - -### Delete -```json -lakeformation:DeleteDataCellsFilter -``` - -### Read -```json -lakeformation:ListDataCellsFilter -``` - 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 deleted file mode 100644 index c6abdc123c..0000000000 --- a/docs/awscc-docs/providers/awscc/lakeformation/data_cells_filters/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -table_catalog_id, -database_name, -table_name, -name -FROM awscc.lakeformation.data_cells_filters -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the data_cells_filters resource, the following permissions are required: - -### Create -```json -lakeformation:CreateDataCellsFilter, -glue:GetTable -``` - -### List -```json -lakeformation:ListDataCellsFilter -``` - diff --git a/docs/awscc-docs/providers/awscc/lakeformation/index.md b/docs/awscc-docs/providers/awscc/lakeformation/index.md deleted file mode 100644 index 52842fdfb1..0000000000 --- a/docs/awscc-docs/providers/awscc/lakeformation/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -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: 6
-total selectable resources: 6
-total methods: 6
-
-
- -::: - -## Resources -
-
-data_cells_filter
-data_cells_filters
-principal_permissions -
-
-tag
-tag_association
-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 deleted file mode 100644 index 22ed33863a..0000000000 --- a/docs/awscc-docs/providers/awscc/lakeformation/principal_permissions/index.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -catalog, -principal, -resource, -permissions, -permissions_with_grant_option, -principal_identifier, -resource_identifier -FROM awscc.lakeformation.principal_permissions -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the principal_permissions resource, the following permissions are required: - -### Read -```json -lakeformation:ListPermissions, -glue:GetTable, -glue:GetDatabase -``` - -### Delete -```json -lakeformation:RevokePermissions, -lakeformation:ListPermissions, -glue:GetTable, -glue:GetDatabase -``` - diff --git a/docs/awscc-docs/providers/awscc/lakeformation/tag/index.md b/docs/awscc-docs/providers/awscc/lakeformation/tag/index.md deleted file mode 100644 index b9cf09231e..0000000000 --- a/docs/awscc-docs/providers/awscc/lakeformation/tag/index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -catalog_id, -tag_key, -tag_values -FROM awscc.lakeformation.tag -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the tag resource, the following permissions are required: - -### Read -```json -lakeformation:GetLFTag -``` - -### Update -```json -lakeformation:UpdateLFTag -``` - -### Delete -```json -lakeformation:DeleteLFTag -``` - diff --git a/docs/awscc-docs/providers/awscc/lakeformation/tag_association/index.md b/docs/awscc-docs/providers/awscc/lakeformation/tag_association/index.md deleted file mode 100644 index b8b24ce939..0000000000 --- a/docs/awscc-docs/providers/awscc/lakeformation/tag_association/index.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -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
lf_tagsarrayList 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. - -## Example -```sql -SELECT -region, -resource, -lf_tags, -resource_identifier, -tags_identifier -FROM awscc.lakeformation.tag_association -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the tag_association resource, the following permissions are required: - -### Read -```json -lakeformation:GetResourceLFTags, -glue:GetDatabase, -glue:GetTable -``` - -### Delete -```json -lakeformation:RemoveLFTagsFromResource, -glue:GetDatabase, -glue:GetTable -``` - diff --git a/docs/awscc-docs/providers/awscc/lakeformation/tags/index.md b/docs/awscc-docs/providers/awscc/lakeformation/tags/index.md deleted file mode 100644 index fd58f553dc..0000000000 --- a/docs/awscc-docs/providers/awscc/lakeformation/tags/index.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -tag_key -FROM awscc.lakeformation.tags -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the tags resource, the following permissions are required: - -### Create -```json -lakeformation:CreateLFTag -``` - -### List -```json -lakeformation:ListLFTags -``` - 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 deleted file mode 100644 index 3085a37f3f..0000000000 --- a/docs/awscc-docs/providers/awscc/lambda/code_signing_config/index.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the code_signing_config resource, the following permissions are required: - -### Read -```json -lambda:GetCodeSigningConfig -``` - -### Update -```json -lambda:UpdateCodeSigningConfig -``` - -### Delete -```json -lambda:DeleteCodeSigningConfig -``` - 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 deleted file mode 100644 index 3d46abe15b..0000000000 --- a/docs/awscc-docs/providers/awscc/lambda/code_signing_configs/index.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -code_signing_config_arn -FROM awscc.lambda.code_signing_configs -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the code_signing_configs resource, the following permissions are required: - -### Create -```json -lambda:CreateCodeSigningConfig -``` - -### List -```json -lambda:ListCodeSigningConfigs -``` - 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 deleted file mode 100644 index fe87a04ba8..0000000000 --- a/docs/awscc-docs/providers/awscc/lambda/event_invoke_config/index.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -destination_config, -function_name, -maximum_event_age_in_seconds, -maximum_retry_attempts, -qualifier -FROM awscc.lambda.event_invoke_config -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the event_invoke_config resource, the following permissions are required: - -### Read -```json -lambda:GetFunctionEventInvokeConfig -``` - -### Update -```json -lambda:UpdateFunctionEventInvokeConfig -``` - -### Delete -```json -lambda:DeleteFunctionEventInvokeConfig -``` - 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 deleted file mode 100644 index e4c2dde3f6..0000000000 --- a/docs/awscc-docs/providers/awscc/lambda/event_invoke_configs/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -function_name, -qualifier -FROM awscc.lambda.event_invoke_configs -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the event_invoke_configs resource, the following permissions are required: - -### Create -```json -lambda:PutFunctionEventInvokeConfig -``` - -### List -```json -lambda:ListFunctionEventInvokeConfigs -``` - 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 deleted file mode 100644 index 28bc892bfb..0000000000 --- a/docs/awscc-docs/providers/awscc/lambda/event_source_mapping/index.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the event_source_mapping resource, the following permissions are required: - -### Delete -```json -lambda:DeleteEventSourceMapping, -lambda:GetEventSourceMapping -``` - -### Read -```json -lambda:GetEventSourceMapping -``` - -### Update -```json -lambda:UpdateEventSourceMapping, -lambda:GetEventSourceMapping -``` - 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 deleted file mode 100644 index 6eb815ff55..0000000000 --- a/docs/awscc-docs/providers/awscc/lambda/event_source_mappings/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.lambda.event_source_mappings -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the event_source_mappings resource, the following permissions are required: - -### Create -```json -lambda:CreateEventSourceMapping, -lambda:GetEventSourceMapping -``` - -### List -```json -lambda:ListEventSourceMappings -``` - diff --git a/docs/awscc-docs/providers/awscc/lambda/function/index.md b/docs/awscc-docs/providers/awscc/lambda/function/index.md deleted file mode 100644 index 6ace90d89c..0000000000 --- a/docs/awscc-docs/providers/awscc/lambda/function/index.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the function resource, the following permissions are required: - -### Read -```json -lambda:GetFunction, -lambda:GetFunctionCodeSigningConfig -``` - -### Update -```json -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 -```json -lambda:DeleteFunction, -lambda:GetFunction, -ec2:DescribeNetworkInterfaces -``` - diff --git a/docs/awscc-docs/providers/awscc/lambda/functions/index.md b/docs/awscc-docs/providers/awscc/lambda/functions/index.md deleted file mode 100644 index 173074947a..0000000000 --- a/docs/awscc-docs/providers/awscc/lambda/functions/index.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -function_name -FROM awscc.lambda.functions -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the functions resource, the following permissions are required: - -### Create -```json -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 -```json -lambda:ListFunctions -``` - diff --git a/docs/awscc-docs/providers/awscc/lambda/index.md b/docs/awscc-docs/providers/awscc/lambda/index.md deleted file mode 100644 index d2cb366041..0000000000 --- a/docs/awscc-docs/providers/awscc/lambda/index.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -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 deleted file mode 100644 index a8bb9ccc3d..0000000000 --- a/docs/awscc-docs/providers/awscc/lambda/layer_version/index.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -compatible_runtimes, -license_info, -description, -layer_name, -content, -layer_version_arn, -compatible_architectures -FROM awscc.lambda.layer_version -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the layer_version resource, the following permissions are required: - -### Read -```json -lambda:GetLayerVersion -``` - -### Delete -```json -lambda:GetLayerVersion, -lambda:DeleteLayerVersion -``` - 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 deleted file mode 100644 index 9117e99b8f..0000000000 --- a/docs/awscc-docs/providers/awscc/lambda/layer_version_permission/index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id, -action, -layer_version_arn, -organization_id, -principal -FROM awscc.lambda.layer_version_permission -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the layer_version_permission resource, the following permissions are required: - -### Read -```json -lambda:GetLayerVersionPolicy -``` - -### Delete -```json -lambda:GetLayerVersionPolicy, -lambda:RemoveLayerVersionPermission -``` - 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 deleted file mode 100644 index ea0e538205..0000000000 --- a/docs/awscc-docs/providers/awscc/lambda/layer_version_permissions/index.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.lambda.layer_version_permissions -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the layer_version_permissions resource, the following permissions are required: - -### Create -```json -lambda:AddLayerVersionPermission -``` - -### List -```json -lambda:GetLayerVersionPolicy -``` - diff --git a/docs/awscc-docs/providers/awscc/lambda/layer_versions/index.md b/docs/awscc-docs/providers/awscc/lambda/layer_versions/index.md deleted file mode 100644 index 5be37d7c8a..0000000000 --- a/docs/awscc-docs/providers/awscc/lambda/layer_versions/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -layer_version_arn -FROM awscc.lambda.layer_versions -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the layer_versions resource, the following permissions are required: - -### Create -```json -lambda:PublishLayerVersion, -s3:GetObject, -s3:GetObjectVersion -``` - -### List -```json -lambda:ListLayerVersions -``` - diff --git a/docs/awscc-docs/providers/awscc/lambda/permission/index.md b/docs/awscc-docs/providers/awscc/lambda/permission/index.md deleted file mode 100644 index f3699b212d..0000000000 --- a/docs/awscc-docs/providers/awscc/lambda/permission/index.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the permission resource, the following permissions are required: - -### Read -```json -lambda:GetPolicy -``` - -### Delete -```json -lambda:RemovePermission -``` - diff --git a/docs/awscc-docs/providers/awscc/lambda/permissions/index.md b/docs/awscc-docs/providers/awscc/lambda/permissions/index.md deleted file mode 100644 index cada05bbc7..0000000000 --- a/docs/awscc-docs/providers/awscc/lambda/permissions/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -function_name, -id -FROM awscc.lambda.permissions -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the permissions resource, the following permissions are required: - -### Create -```json -lambda:AddPermission -``` - -### List -```json -lambda:GetPolicy -``` - diff --git a/docs/awscc-docs/providers/awscc/lambda/url/index.md b/docs/awscc-docs/providers/awscc/lambda/url/index.md deleted file mode 100644 index d8be9fc53a..0000000000 --- a/docs/awscc-docs/providers/awscc/lambda/url/index.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -target_function_arn, -qualifier, -auth_type, -invoke_mode, -function_arn, -function_url, -cors -FROM awscc.lambda.url -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the url resource, the following permissions are required: - -### Read -```json -lambda:GetFunctionUrlConfig -``` - -### Update -```json -lambda:UpdateFunctionUrlConfig -``` - -### Delete -```json -lambda:DeleteFunctionUrlConfig -``` - diff --git a/docs/awscc-docs/providers/awscc/lambda/urls/index.md b/docs/awscc-docs/providers/awscc/lambda/urls/index.md deleted file mode 100644 index 78c7a571bc..0000000000 --- a/docs/awscc-docs/providers/awscc/lambda/urls/index.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -function_arn -FROM awscc.lambda.urls -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the urls resource, the following permissions are required: - -### Create -```json -lambda:CreateFunctionUrlConfig -``` - -### List -```json -lambda:ListFunctionUrlConfigs -``` - diff --git a/docs/awscc-docs/providers/awscc/lambda/version/index.md b/docs/awscc-docs/providers/awscc/lambda/version/index.md deleted file mode 100644 index 01f9099f55..0000000000 --- a/docs/awscc-docs/providers/awscc/lambda/version/index.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -function_arn, -version, -code_sha256, -description, -function_name, -provisioned_concurrency_config, -runtime_policy -FROM awscc.lambda.version -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the version resource, the following permissions are required: - -### Read -```json -lambda:GetFunctionConfiguration, -lambda:GetProvisionedConcurrencyConfig, -lambda:GetRuntimeManagementConfig -``` - -### Delete -```json -lambda:GetFunctionConfiguration, -lambda:DeleteFunction -``` - diff --git a/docs/awscc-docs/providers/awscc/lambda/versions/index.md b/docs/awscc-docs/providers/awscc/lambda/versions/index.md deleted file mode 100644 index a662a88720..0000000000 --- a/docs/awscc-docs/providers/awscc/lambda/versions/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -function_arn -FROM awscc.lambda.versions -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the versions resource, the following permissions are required: - -### Create -```json -lambda:PublishVersion, -lambda:GetFunctionConfiguration, -lambda:PutProvisionedConcurrencyConfig, -lambda:GetProvisionedConcurrencyConfig, -lambda:PutRuntimeManagementConfig, -lambda:GetRuntimeManagementConfig -``` - -### List -```json -lambda:ListVersionsByFunction -``` - diff --git a/docs/awscc-docs/providers/awscc/lex/bot/index.md b/docs/awscc-docs/providers/awscc/lex/bot/index.md deleted file mode 100644 index 6987f0b7c8..0000000000 --- a/docs/awscc-docs/providers/awscc/lex/bot/index.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -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_ttl_in_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. - -## Example -```sql -SELECT -region, -id, -arn, -name, -description, -role_arn, -data_privacy, -idle_session_ttl_in_seconds, -bot_locales, -bot_file_s3_location, -bot_tags, -test_bot_alias_tags, -auto_build_bot_locales, -test_bot_alias_settings -FROM awscc.lex.bot -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the bot resource, the following permissions are required: - -### Read -```json -lex:DescribeBot, -lex:ListTagsForResource -``` - -### Update -```json -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 -```json -lex:DeleteBot, -lex:DescribeBot, -lex:DeleteBotLocale, -lex:DeleteIntent, -lex:DeleteSlotType, -lex:DeleteSlot, -lex:DeleteBotVersion, -lex:DeleteBotChannel, -lex:DeleteBotAlias, -lex:DeleteCustomVocabulary -``` - diff --git a/docs/awscc-docs/providers/awscc/lex/bot_alias/index.md b/docs/awscc-docs/providers/awscc/lex/bot_alias/index.md deleted file mode 100644 index 4ed6250bfc..0000000000 --- a/docs/awscc-docs/providers/awscc/lex/bot_alias/index.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the bot_alias resource, the following permissions are required: - -### Update -```json -lex:UpdateBotAlias, -lex:DescribeBotAlias, -lex:ListTagsForResource, -lex:TagResource, -lex:UntagResource -``` - -### Read -```json -lex:DescribeBotAlias -``` - -### Delete -```json -lex:DeleteBotAlias -``` - diff --git a/docs/awscc-docs/providers/awscc/lex/bot_aliases/index.md b/docs/awscc-docs/providers/awscc/lex/bot_aliases/index.md deleted file mode 100644 index 09bd4a4793..0000000000 --- a/docs/awscc-docs/providers/awscc/lex/bot_aliases/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -bot_alias_id, -bot_id -FROM awscc.lex.bot_aliases -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the bot_aliases resource, the following permissions are required: - -### Create -```json -lex:CreateBotAlias, -lex:DescribeBot -``` - -### List -```json -lex:ListBotAliases -``` - diff --git a/docs/awscc-docs/providers/awscc/lex/bot_version/index.md b/docs/awscc-docs/providers/awscc/lex/bot_version/index.md deleted file mode 100644 index 8f3d52409c..0000000000 --- a/docs/awscc-docs/providers/awscc/lex/bot_version/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -bot_id, -bot_version, -description, -bot_version_locale_specification -FROM awscc.lex.bot_version -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the bot_version resource, the following permissions are required: - -### Read -```json -lex:DescribeBotVersion -``` - -### Delete -```json -lex:DeleteBotVersion, -lex:DescribeBotVersion -``` - diff --git a/docs/awscc-docs/providers/awscc/lex/bot_versions/index.md b/docs/awscc-docs/providers/awscc/lex/bot_versions/index.md deleted file mode 100644 index c2f4f25b07..0000000000 --- a/docs/awscc-docs/providers/awscc/lex/bot_versions/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -bot_id, -bot_version -FROM awscc.lex.bot_versions -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the bot_versions resource, the following permissions are required: - -### Create -```json -lex:CreateBotVersion, -lex:DescribeBotVersion, -lex:DescribeBot, -lex:DescribeBotLocale, -lex:BuildBotLocale -``` - -### List -```json -lex:ListBotVersions -``` - diff --git a/docs/awscc-docs/providers/awscc/lex/bots/index.md b/docs/awscc-docs/providers/awscc/lex/bots/index.md deleted file mode 100644 index 4cb3c240fa..0000000000 --- a/docs/awscc-docs/providers/awscc/lex/bots/index.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.lex.bots -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the bots resource, the following permissions are required: - -### Create -```json -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 -```json -lex:ListBots -``` - diff --git a/docs/awscc-docs/providers/awscc/lex/index.md b/docs/awscc-docs/providers/awscc/lex/index.md deleted file mode 100644 index 916c282dd1..0000000000 --- a/docs/awscc-docs/providers/awscc/lex/index.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -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 deleted file mode 100644 index ada7a09e91..0000000000 --- a/docs/awscc-docs/providers/awscc/lex/resource_policies/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.lex.resource_policies -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the resource_policies resource, the following permissions are required: - -### Create -```json -lex:CreateResourcePolicy, -lex:DescribeResourcePolicy -``` - -### List -```json -lex:DescribeResourcePolicy -``` - diff --git a/docs/awscc-docs/providers/awscc/lex/resource_policy/index.md b/docs/awscc-docs/providers/awscc/lex/resource_policy/index.md deleted file mode 100644 index 74a037e794..0000000000 --- a/docs/awscc-docs/providers/awscc/lex/resource_policy/index.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -resource_arn, -revision_id, -policy, -id -FROM awscc.lex.resource_policy -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the resource_policy resource, the following permissions are required: - -### Read -```json -lex:DescribeResourcePolicy -``` - -### Update -```json -lex:UpdateResourcePolicy, -lex:DescribeResourcePolicy -``` - -### Delete -```json -lex:DeleteResourcePolicy, -lex:DescribeResourcePolicy -``` - diff --git a/docs/awscc-docs/providers/awscc/licensemanager/grant/index.md b/docs/awscc-docs/providers/awscc/licensemanager/grant/index.md deleted file mode 100644 index 9c7a40e1b4..0000000000 --- a/docs/awscc-docs/providers/awscc/licensemanager/grant/index.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -grant_arn, -grant_name, -license_arn, -home_region, -version, -allowed_operations, -principals, -status -FROM awscc.licensemanager.grant -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the grant resource, the following permissions are required: - -### Read -```json -license-manager:GetGrant -``` - -### Update -```json -license-manager:CreateGrantVersion -``` - -### Delete -```json -license-manager:DeleteGrant -``` - diff --git a/docs/awscc-docs/providers/awscc/licensemanager/grants/index.md b/docs/awscc-docs/providers/awscc/licensemanager/grants/index.md deleted file mode 100644 index 4d12f171b6..0000000000 --- a/docs/awscc-docs/providers/awscc/licensemanager/grants/index.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -grant_arn -FROM awscc.licensemanager.grants -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the grants resource, the following permissions are required: - -### Create -```json -license-manager:CreateGrant -``` - -### List -```json -license-manager:ListDistributedGrants -``` - diff --git a/docs/awscc-docs/providers/awscc/licensemanager/index.md b/docs/awscc-docs/providers/awscc/licensemanager/index.md deleted file mode 100644 index ef4da62208..0000000000 --- a/docs/awscc-docs/providers/awscc/licensemanager/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index 7f0df21e8b..0000000000 --- a/docs/awscc-docs/providers/awscc/licensemanager/license/index.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -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_skustringProductSKU 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. - -## Example -```sql -SELECT -region, -product_sku, -issuer, -license_name, -product_name, -home_region, -validity, -entitlements, -beneficiary, -consumption_configuration, -license_metadata, -license_arn, -status, -version -FROM awscc.licensemanager.license -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the license resource, the following permissions are required: - -### Read -```json -license-manager:GetLicense -``` - -### Update -```json -license-manager:CreateLicenseVersion -``` - -### Delete -```json -license-manager:DeleteLicense -``` - diff --git a/docs/awscc-docs/providers/awscc/licensemanager/licenses/index.md b/docs/awscc-docs/providers/awscc/licensemanager/licenses/index.md deleted file mode 100644 index a1b2791e05..0000000000 --- a/docs/awscc-docs/providers/awscc/licensemanager/licenses/index.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -license_arn -FROM awscc.licensemanager.licenses -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the licenses resource, the following permissions are required: - -### Create -```json -license-manager:CreateLicense -``` - -### List -```json -license-manager:ListLicenses -``` - diff --git a/docs/awscc-docs/providers/awscc/lightsail/alarm/index.md b/docs/awscc-docs/providers/awscc/lightsail/alarm/index.md deleted file mode 100644 index d4dc52a771..0000000000 --- a/docs/awscc-docs/providers/awscc/lightsail/alarm/index.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the alarm resource, the following permissions are required: - -### Read -```json -lightsail:GetAlarms -``` - -### Update -```json -lightsail:PutAlarm, -lightsail:GetAlarms -``` - -### Delete -```json -lightsail:DeleteAlarm, -lightsail:GetAlarms -``` - diff --git a/docs/awscc-docs/providers/awscc/lightsail/alarms/index.md b/docs/awscc-docs/providers/awscc/lightsail/alarms/index.md deleted file mode 100644 index 2245a21124..0000000000 --- a/docs/awscc-docs/providers/awscc/lightsail/alarms/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -alarm_name -FROM awscc.lightsail.alarms -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the alarms resource, the following permissions are required: - -### Create -```json -lightsail:PutAlarm, -lightsail:GetAlarms -``` - -### List -```json -lightsail:GetAlarms -``` - diff --git a/docs/awscc-docs/providers/awscc/lightsail/bucket/index.md b/docs/awscc-docs/providers/awscc/lightsail/bucket/index.md deleted file mode 100644 index 0ed47d5dd8..0000000000 --- a/docs/awscc-docs/providers/awscc/lightsail/bucket/index.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the bucket resource, the following permissions are required: - -### Read -```json -lightsail:GetBuckets -``` - -### Delete -```json -lightsail:DeleteBucket, -lightsail:GetBuckets -``` - -### Update -```json -lightsail:GetBuckets, -lightsail:GetInstance, -lightsail:UpdateBucket, -lightsail:UpdateBucketBundle, -lightsail:SetResourceAccessForBucket, -lightsail:TagResource, -lightsail:UntagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/lightsail/buckets/index.md b/docs/awscc-docs/providers/awscc/lightsail/buckets/index.md deleted file mode 100644 index a6fcaafab9..0000000000 --- a/docs/awscc-docs/providers/awscc/lightsail/buckets/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -bucket_name -FROM awscc.lightsail.buckets -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the buckets resource, the following permissions are required: - -### Create -```json -lightsail:CreateBucket, -lightsail:GetBuckets, -lightsail:GetInstance, -lightsail:UpdateBucket, -lightsail:UpdateBucketBundle, -lightsail:SetResourceAccessForBucket, -lightsail:TagResource, -lightsail:UntagResource -``` - -### List -```json -lightsail:GetBuckets -``` - diff --git a/docs/awscc-docs/providers/awscc/lightsail/certificate/index.md b/docs/awscc-docs/providers/awscc/lightsail/certificate/index.md deleted file mode 100644 index ff08f1bca5..0000000000 --- a/docs/awscc-docs/providers/awscc/lightsail/certificate/index.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -certificate_name, -domain_name, -subject_alternative_names, -certificate_arn, -status, -tags -FROM awscc.lightsail.certificate -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the certificate resource, the following permissions are required: - -### Read -```json -lightsail:GetCertificates -``` - -### Update -```json -lightsail:GetCertificates, -lightsail:TagResource, -lightsail:UntagResource -``` - -### Delete -```json -lightsail:DeleteCertificate, -lightsail:GetCertificates -``` - diff --git a/docs/awscc-docs/providers/awscc/lightsail/certificates/index.md b/docs/awscc-docs/providers/awscc/lightsail/certificates/index.md deleted file mode 100644 index 48ed1e99ff..0000000000 --- a/docs/awscc-docs/providers/awscc/lightsail/certificates/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -certificate_name -FROM awscc.lightsail.certificates -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the certificates resource, the following permissions are required: - -### Create -```json -lightsail:CreateCertificate, -lightsail:GetCertificates, -lightsail:TagResource, -lightsail:UntagResource -``` - -### List -```json -lightsail:GetCertificates -``` - diff --git a/docs/awscc-docs/providers/awscc/lightsail/container/index.md b/docs/awscc-docs/providers/awscc/lightsail/container/index.md deleted file mode 100644 index c6da4559b9..0000000000 --- a/docs/awscc-docs/providers/awscc/lightsail/container/index.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the container resource, the following permissions are required: - -### Read -```json -lightsail:GetContainerServices -``` - -### Delete -```json -lightsail:DeleteContainerService, -lightsail:GetContainerServices -``` - -### Update -```json -lightsail:CreateContainerServiceDeployment, -lightsail:GetContainerServices, -lightsail:TagResource, -lightsail:UntagResource, -lightsail:UpdateContainerService -``` - diff --git a/docs/awscc-docs/providers/awscc/lightsail/containers/index.md b/docs/awscc-docs/providers/awscc/lightsail/containers/index.md deleted file mode 100644 index dd2c3af0e1..0000000000 --- a/docs/awscc-docs/providers/awscc/lightsail/containers/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -service_name -FROM awscc.lightsail.containers -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the containers resource, the following permissions are required: - -### Create -```json -lightsail:CreateContainerService, -lightsail:CreateContainerServiceDeployment, -lightsail:GetContainerServices, -lightsail:TagResource, -lightsail:UntagResource, -lightsail:UpdateContainerService -``` - -### List -```json -lightsail:GetContainerServices -``` - diff --git a/docs/awscc-docs/providers/awscc/lightsail/database/index.md b/docs/awscc-docs/providers/awscc/lightsail/database/index.md deleted file mode 100644 index 441f289c82..0000000000 --- a/docs/awscc-docs/providers/awscc/lightsail/database/index.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the database resource, the following permissions are required: - -### Read -```json -lightsail:GetRelationalDatabase, -lightsail:GetRelationalDatabases -``` - -### Update -```json -lightsail:GetRelationalDatabase, -lightsail:GetRelationalDatabases, -lightsail:TagResource, -lightsail:UntagResource, -lightsail:UpdateRelationalDatabase, -lightsail:UpdateRelationalDatabaseParameters -``` - -### Delete -```json -lightsail:DeleteRelationalDatabase, -lightsail:GetRelationalDatabase, -lightsail:GetRelationalDatabases -``` - diff --git a/docs/awscc-docs/providers/awscc/lightsail/databases/index.md b/docs/awscc-docs/providers/awscc/lightsail/databases/index.md deleted file mode 100644 index 2ca7fda00a..0000000000 --- a/docs/awscc-docs/providers/awscc/lightsail/databases/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -relational_database_name -FROM awscc.lightsail.databases -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the databases resource, the following permissions are required: - -### Create -```json -lightsail:CreateRelationalDatabase, -lightsail:GetRelationalDatabase, -lightsail:GetRelationalDatabases, -lightsail:GetRegions, -lightsail:TagResource, -lightsail:UntagResource, -lightsail:UpdateRelationalDatabase, -lightsail:UpdateRelationalDatabaseParameters -``` - -### List -```json -lightsail:GetRelationalDatabases -``` - diff --git a/docs/awscc-docs/providers/awscc/lightsail/distribution/index.md b/docs/awscc-docs/providers/awscc/lightsail/distribution/index.md deleted file mode 100644 index 88d9ab56cb..0000000000 --- a/docs/awscc-docs/providers/awscc/lightsail/distribution/index.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the distribution resource, the following permissions are required: - -### Read -```json -lightsail:GetDistributions -``` - -### Update -```json -lightsail:AttachCertificateToDistribution, -lightsail:DetachCertificateFromDistribution, -lightsail:GetCertificates, -lightsail:GetCertificateDetails, -lightsail:GetDistributions, -lightsail:TagResource, -lightsail:UntagResource, -lightsail:UpdateDistribution, -lightsail:UpdateDistributionBundle -``` - -### Delete -```json -lightsail:DeleteDistribution, -lightsail:GetDistributions -``` - diff --git a/docs/awscc-docs/providers/awscc/lightsail/distributions/index.md b/docs/awscc-docs/providers/awscc/lightsail/distributions/index.md deleted file mode 100644 index c6ff76a72e..0000000000 --- a/docs/awscc-docs/providers/awscc/lightsail/distributions/index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -distribution_name -FROM awscc.lightsail.distributions -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the distributions resource, the following permissions are required: - -### Create -```json -lightsail:AttachCertificateToDistribution, -lightsail:CreateDistribution, -lightsail:DetachCertificateFromDistribution, -lightsail:GetCertificates, -lightsail:GetCertificateDetails, -lightsail:GetDistributions, -lightsail:TagResource, -lightsail:UntagResource, -lightsail:UpdateDistribution, -lightsail:UpdateDistributionBundle -``` - -### List -```json -lightsail:GetDistributions -``` - diff --git a/docs/awscc-docs/providers/awscc/lightsail/index.md b/docs/awscc-docs/providers/awscc/lightsail/index.md deleted file mode 100644 index 954e446266..0000000000 --- a/docs/awscc-docs/providers/awscc/lightsail/index.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -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 deleted file mode 100644 index b11f986da3..0000000000 --- a/docs/awscc-docs/providers/awscc/lightsail/instance/index.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the instance resource, the following permissions are required: - -### Read -```json -lightsail:GetInstances, -lightsail:GetInstance -``` - -### Delete -```json -lightsail:GetInstances, -lightsail:GetInstance, -lightsail:DeleteInstance -``` - -### Update -```json -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 -``` - diff --git a/docs/awscc-docs/providers/awscc/lightsail/instances/index.md b/docs/awscc-docs/providers/awscc/lightsail/instances/index.md deleted file mode 100644 index 01207e3bbb..0000000000 --- a/docs/awscc-docs/providers/awscc/lightsail/instances/index.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -instance_name -FROM awscc.lightsail.instances -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the instances resource, the following permissions are required: - -### Create -```json -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 -```json -lightsail:GetInstances -``` - diff --git a/docs/awscc-docs/providers/awscc/lightsail/load_balancer/index.md b/docs/awscc-docs/providers/awscc/lightsail/load_balancer/index.md deleted file mode 100644 index 8e9bca71b2..0000000000 --- a/docs/awscc-docs/providers/awscc/lightsail/load_balancer/index.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the load_balancer resource, the following permissions are required: - -### Read -```json -lightsail:GetLoadBalancer, -lightsail:GetLoadBalancers -``` - -### Update -```json -lightsail:GetLoadBalancer, -lightsail:GetLoadBalancers, -lightsail:GetInstance, -lightsail:AttachInstancesToLoadBalancer, -lightsail:DetachInstancesFromLoadBalancer, -lightsail:UpdateLoadBalancerAttribute, -lightsail:TagResource, -lightsail:UntagResource -``` - -### Delete -```json -lightsail:DeleteLoadBalancer, -lightsail:GetLoadBalancer, -lightsail:GetLoadBalancers -``` - 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 deleted file mode 100644 index 8a999ed1d7..0000000000 --- a/docs/awscc-docs/providers/awscc/lightsail/load_balancer_tls_certificate/index.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the load_balancer_tls_certificate resource, the following permissions are required: - -### Read -```json -lightsail:GetLoadBalancerTlsCertificates, -lightsail:GetLoadBalancer -``` - -### Update -```json -lightsail:AttachLoadBalancerTlsCertificate, -lightsail:GetLoadBalancerTlsCertificates, -lightsail:GetLoadBalancer, -lightsail:UpdateLoadBalancerAttribute -``` - -### Delete -```json -lightsail:DeleteLoadBalancerTlsCertificate, -lightsail:GetLoadBalancerTlsCertificates, -lightsail:GetLoadBalancer -``` - 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 deleted file mode 100644 index dc8d924b6e..0000000000 --- a/docs/awscc-docs/providers/awscc/lightsail/load_balancer_tls_certificates/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -certificate_name, -load_balancer_name -FROM awscc.lightsail.load_balancer_tls_certificates -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the load_balancer_tls_certificates resource, the following permissions are required: - -### Create -```json -lightsail:CreateLoadBalancerTlsCertificate, -lightsail:GetLoadBalancerTlsCertificates, -lightsail:GetLoadBalancer, -lightsail:AttachLoadBalancerTlsCertificate, -lightsail:UpdateLoadBalancerAttribute -``` - -### List -```json -lightsail:GetLoadBalancerTlsCertificates, -lightsail:GetLoadBalancer -``` - diff --git a/docs/awscc-docs/providers/awscc/lightsail/load_balancers/index.md b/docs/awscc-docs/providers/awscc/lightsail/load_balancers/index.md deleted file mode 100644 index 0175b7010a..0000000000 --- a/docs/awscc-docs/providers/awscc/lightsail/load_balancers/index.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -load_balancer_name -FROM awscc.lightsail.load_balancers -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the load_balancers resource, the following permissions are required: - -### Create -```json -lightsail:CreateLoadBalancer, -lightsail:GetLoadBalancer, -lightsail:GetLoadBalancers, -lightsail:GetInstance, -lightsail:AttachInstancesToLoadBalancer, -lightsail:DetachInstancesFromLoadBalancer, -lightsail:UpdateLoadBalancerAttribute, -lightsail:TagResource, -lightsail:UntagResource -``` - -### List -```json -lightsail:GetLoadBalancers -``` - diff --git a/docs/awscc-docs/providers/awscc/lightsail/static_ip/index.md b/docs/awscc-docs/providers/awscc/lightsail/static_ip/index.md deleted file mode 100644 index 887c9ed3db..0000000000 --- a/docs/awscc-docs/providers/awscc/lightsail/static_ip/index.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -static_ip_name, -attached_to, -is_attached, -ip_address, -static_ip_arn -FROM awscc.lightsail.static_ip -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the static_ip resource, the following permissions are required: - -### Read -```json -lightsail:GetStaticIp, -lightsail:GetStaticIps -``` - -### Update -```json -lightsail:AttachStaticIp, -lightsail:DetachStaticIp, -lightsail:GetInstance, -lightsail:GetStaticIp, -lightsail:GetStaticIps -``` - -### Delete -```json -lightsail:GetStaticIp, -lightsail:GetStaticIps, -lightsail:ReleaseStaticIp -``` - diff --git a/docs/awscc-docs/providers/awscc/lightsail/static_ips/index.md b/docs/awscc-docs/providers/awscc/lightsail/static_ips/index.md deleted file mode 100644 index f3fa866008..0000000000 --- a/docs/awscc-docs/providers/awscc/lightsail/static_ips/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -static_ip_name -FROM awscc.lightsail.static_ips -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the static_ips resource, the following permissions are required: - -### Create -```json -lightsail:AllocateStaticIp, -lightsail:AttachStaticIp, -lightsail:DetachStaticIp, -lightsail:GetInstance, -lightsail:GetStaticIp, -lightsail:GetStaticIps -``` - -### List -```json -lightsail:GetStaticIps -``` - diff --git a/docs/awscc-docs/providers/awscc/location/api_key/index.md b/docs/awscc-docs/providers/awscc/location/api_key/index.md deleted file mode 100644 index 7ee2426423..0000000000 --- a/docs/awscc-docs/providers/awscc/location/api_key/index.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the api_key resource, the following permissions are required: - -### Read -```json -geo:DescribeKey -``` - -### Update -```json -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 -```json -geo:DeleteKey, -geo:DescribeKey -``` - diff --git a/docs/awscc-docs/providers/awscc/location/api_keys/index.md b/docs/awscc-docs/providers/awscc/location/api_keys/index.md deleted file mode 100644 index b698ae3089..0000000000 --- a/docs/awscc-docs/providers/awscc/location/api_keys/index.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -key_name -FROM awscc.location.api_keys -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the api_keys resource, the following permissions are required: - -### Create -```json -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 -```json -geo:ListKeys -``` - diff --git a/docs/awscc-docs/providers/awscc/location/geofence_collection/index.md b/docs/awscc-docs/providers/awscc/location/geofence_collection/index.md deleted file mode 100644 index 6449483673..0000000000 --- a/docs/awscc-docs/providers/awscc/location/geofence_collection/index.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the geofence_collection resource, the following permissions are required: - -### Read -```json -geo:DescribeGeofenceCollection, -kms:DescribeKey -``` - -### Update -```json -geo:CreateGeofenceCollection, -geo:DescribeGeofenceCollection, -geo:TagResource, -geo:UntagResource, -kms:DescribeKey, -kms:CreateGrant, -geo:UpdateGeofenceCollection -``` - -### Delete -```json -geo:DeleteGeofenceCollection, -geo:DescribeGeofenceCollection -``` - diff --git a/docs/awscc-docs/providers/awscc/location/geofence_collections/index.md b/docs/awscc-docs/providers/awscc/location/geofence_collections/index.md deleted file mode 100644 index 950e4aab1d..0000000000 --- a/docs/awscc-docs/providers/awscc/location/geofence_collections/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -collection_name -FROM awscc.location.geofence_collections -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the geofence_collections resource, the following permissions are required: - -### Create -```json -geo:CreateGeofenceCollection, -geo:DescribeGeofenceCollection, -geo:TagResource, -geo:UntagResource, -kms:DescribeKey, -kms:CreateGrant -``` - -### List -```json -geo:ListGeofenceCollections -``` - diff --git a/docs/awscc-docs/providers/awscc/location/index.md b/docs/awscc-docs/providers/awscc/location/index.md deleted file mode 100644 index 3e7438f12a..0000000000 --- a/docs/awscc-docs/providers/awscc/location/index.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -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 deleted file mode 100644 index f49cce9c08..0000000000 --- a/docs/awscc-docs/providers/awscc/location/map/index.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -configuration, -create_time, -description, -map_arn, -map_name, -pricing_plan, -tags, -update_time, -arn -FROM awscc.location.map -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the map resource, the following permissions are required: - -### Read -```json -geo:DescribeMap -``` - -### Update -```json -geo:CreateMap, -geo:DescribeMap, -geo:TagResource, -geo:UntagResource, -geo:UpdateMap -``` - -### Delete -```json -geo:DeleteMap, -geo:DescribeMap -``` - diff --git a/docs/awscc-docs/providers/awscc/location/maps/index.md b/docs/awscc-docs/providers/awscc/location/maps/index.md deleted file mode 100644 index 07a8b00093..0000000000 --- a/docs/awscc-docs/providers/awscc/location/maps/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -map_name -FROM awscc.location.maps -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the maps resource, the following permissions are required: - -### Create -```json -geo:CreateMap, -geo:DescribeMap, -geo:TagResource, -geo:UntagResource -``` - -### List -```json -geo:ListMaps -``` - diff --git a/docs/awscc-docs/providers/awscc/location/place_index/index.md b/docs/awscc-docs/providers/awscc/location/place_index/index.md deleted file mode 100644 index 8c5dbe6797..0000000000 --- a/docs/awscc-docs/providers/awscc/location/place_index/index.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the place_index resource, the following permissions are required: - -### Read -```json -geo:DescribePlaceIndex -``` - -### Update -```json -geo:CreatePlaceIndex, -geo:DescribePlaceIndex, -geo:TagResource, -geo:UntagResource, -geo:UpdatePlaceIndex -``` - -### Delete -```json -geo:DeletePlaceIndex, -geo:DescribePlaceIndex -``` - diff --git a/docs/awscc-docs/providers/awscc/location/place_indices/index.md b/docs/awscc-docs/providers/awscc/location/place_indices/index.md deleted file mode 100644 index 5cfde084a1..0000000000 --- a/docs/awscc-docs/providers/awscc/location/place_indices/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -index_name -FROM awscc.location.place_indices -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the place_indices resource, the following permissions are required: - -### Create -```json -geo:CreatePlaceIndex, -geo:DescribePlaceIndex, -geo:TagResource, -geo:UntagResource -``` - -### List -```json -geo:ListPlaceIndexes -``` - diff --git a/docs/awscc-docs/providers/awscc/location/route_calculator/index.md b/docs/awscc-docs/providers/awscc/location/route_calculator/index.md deleted file mode 100644 index 4f2257dd70..0000000000 --- a/docs/awscc-docs/providers/awscc/location/route_calculator/index.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the route_calculator resource, the following permissions are required: - -### Read -```json -geo:DescribeRouteCalculator -``` - -### Update -```json -geo:CreateRouteCalculator, -geo:DescribeRouteCalculator, -geo:TagResource, -geo:UntagResource, -geo:UpdateRouteCalculator -``` - -### Delete -```json -geo:DeleteRouteCalculator, -geo:DescribeRouteCalculator -``` - diff --git a/docs/awscc-docs/providers/awscc/location/route_calculators/index.md b/docs/awscc-docs/providers/awscc/location/route_calculators/index.md deleted file mode 100644 index 2fa902ea84..0000000000 --- a/docs/awscc-docs/providers/awscc/location/route_calculators/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -calculator_name -FROM awscc.location.route_calculators -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the route_calculators resource, the following permissions are required: - -### Create -```json -geo:CreateRouteCalculator, -geo:DescribeRouteCalculator, -geo:TagResource, -geo:UntagResource -``` - -### List -```json -geo:ListRouteCalculators -``` - diff --git a/docs/awscc-docs/providers/awscc/location/tracker/index.md b/docs/awscc-docs/providers/awscc/location/tracker/index.md deleted file mode 100644 index ec0e7c3fdf..0000000000 --- a/docs/awscc-docs/providers/awscc/location/tracker/index.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the tracker resource, the following permissions are required: - -### Read -```json -geo:DescribeTracker, -kms:DescribeKey -``` - -### Update -```json -geo:CreateTracker, -geo:DescribeTracker, -geo:TagResource, -geo:UntagResource, -kms:DescribeKey, -kms:CreateGrant, -geo:UpdateTracker -``` - -### Delete -```json -geo:DeleteTracker, -geo:DescribeTracker -``` - diff --git a/docs/awscc-docs/providers/awscc/location/tracker_consumer/index.md b/docs/awscc-docs/providers/awscc/location/tracker_consumer/index.md deleted file mode 100644 index 9ad2d3210a..0000000000 --- a/docs/awscc-docs/providers/awscc/location/tracker_consumer/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -consumer_arn, -tracker_name -FROM awscc.location.tracker_consumer -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the tracker_consumer resource, the following permissions are required: - -### Delete -```json -geo:DisassociateTrackerConsumer, -geo:ListTrackerConsumers -``` - -### Read -```json -geo:ListTrackerConsumers -``` - diff --git a/docs/awscc-docs/providers/awscc/location/tracker_consumers/index.md b/docs/awscc-docs/providers/awscc/location/tracker_consumers/index.md deleted file mode 100644 index 7352574ad0..0000000000 --- a/docs/awscc-docs/providers/awscc/location/tracker_consumers/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -tracker_name, -consumer_arn -FROM awscc.location.tracker_consumers -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the tracker_consumers resource, the following permissions are required: - -### Create -```json -geo:AssociateTrackerConsumer, -geo:ListTrackerConsumers -``` - -### List -```json -geo:ListTrackerConsumers -``` - diff --git a/docs/awscc-docs/providers/awscc/location/trackers/index.md b/docs/awscc-docs/providers/awscc/location/trackers/index.md deleted file mode 100644 index 1d4af35054..0000000000 --- a/docs/awscc-docs/providers/awscc/location/trackers/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -tracker_name -FROM awscc.location.trackers -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the trackers resource, the following permissions are required: - -### Create -```json -geo:CreateTracker, -geo:DescribeTracker, -geo:TagResource, -geo:UntagResource, -kms:DescribeKey, -kms:CreateGrant -``` - -### List -```json -geo:ListTrackers -``` - diff --git a/docs/awscc-docs/providers/awscc/logs/account_policies/index.md b/docs/awscc-docs/providers/awscc/logs/account_policies/index.md deleted file mode 100644 index bde5ffb77e..0000000000 --- a/docs/awscc-docs/providers/awscc/logs/account_policies/index.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -account_id, -policy_type, -policy_name -FROM awscc.logs.account_policies -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the account_policies resource, the following permissions are required: - -### Create -```json -logs:PutAccountPolicy, -logs:PutDataProtectionPolicy, -logs:DescribeAccountPolicies, -logs:CreateLogDelivery, -s3:REST.PUT.OBJECT, -firehose:TagDeliveryStream, -logs:PutSubscriptionFilter, -logs:DeleteSubscriptionFilter, -iam:PassRole -``` - -### List -```json -logs:DescribeAccountPolicies -``` - diff --git a/docs/awscc-docs/providers/awscc/logs/account_policy/index.md b/docs/awscc-docs/providers/awscc/logs/account_policy/index.md deleted file mode 100644 index 16c4cb6231..0000000000 --- a/docs/awscc-docs/providers/awscc/logs/account_policy/index.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -account_id, -policy_name, -policy_document, -policy_type, -scope, -selection_criteria -FROM awscc.logs.account_policy -WHERE data__Identifier = '||'; -``` - -## Permissions - -To operate on the account_policy resource, the following permissions are required: - -### Read -```json -logs:DescribeAccountPolicies -``` - -### Update -```json -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 -```json -logs:DeleteAccountPolicy, -logs:DeleteDataProtectionPolicy, -logs:DescribeAccountPolicies, -logs:DeleteSubscriptionFilter, -iam:PassRole -``` - diff --git a/docs/awscc-docs/providers/awscc/logs/deliveries/index.md b/docs/awscc-docs/providers/awscc/logs/deliveries/index.md deleted file mode 100644 index e55847393b..0000000000 --- a/docs/awscc-docs/providers/awscc/logs/deliveries/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -delivery_id -FROM awscc.logs.deliveries -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the deliveries resource, the following permissions are required: - -### Create -```json -logs:CreateDelivery, -logs:GetDelivery, -logs:DescribeDeliveries, -logs:ListTagsForResource, -logs:TagResource, -logs:GetDeliverySource, -logs:GetDeliveryDestination -``` - -### List -```json -logs:DescribeDeliveries, -logs:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/logs/delivery/index.md b/docs/awscc-docs/providers/awscc/logs/delivery/index.md deleted file mode 100644 index f1dd18b143..0000000000 --- a/docs/awscc-docs/providers/awscc/logs/delivery/index.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -delivery_id, -arn, -delivery_source_name, -delivery_destination_arn, -delivery_destination_type, -tags -FROM awscc.logs.delivery -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the delivery resource, the following permissions are required: - -### Read -```json -logs:GetDelivery, -logs:ListTagsForResource -``` - -### Update -```json -logs:GetDelivery, -logs:ListTagsForResource, -logs:TagResource, -logs:UntagResource -``` - -### Delete -```json -logs:DeleteDelivery, -logs:ListTagsForResource, -logs:UntagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/logs/delivery_destination/index.md b/docs/awscc-docs/providers/awscc/logs/delivery_destination/index.md deleted file mode 100644 index 7cebdf54b4..0000000000 --- a/docs/awscc-docs/providers/awscc/logs/delivery_destination/index.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -arn, -destination_resource_arn, -tags, -delivery_destination_type, -delivery_destination_policy -FROM awscc.logs.delivery_destination -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the delivery_destination resource, the following permissions are required: - -### Read -```json -logs:GetDeliveryDestination, -logs:ListTagsForResource, -logs:GetDeliveryDestinationPolicy -``` - -### Update -```json -logs:PutDeliveryDestination, -logs:GetDeliveryDestination, -logs:ListTagsForResource, -logs:TagResource, -logs:UntagResource, -logs:DeleteDeliveryDestinationPolicy, -logs:PutDeliveryDestinationPolicy, -logs:GetDeliveryDestinationPolicy -``` - -### Delete -```json -logs:DeleteDeliveryDestination, -logs:DeleteDeliveryDestinationPolicy -``` - diff --git a/docs/awscc-docs/providers/awscc/logs/delivery_destinations/index.md b/docs/awscc-docs/providers/awscc/logs/delivery_destinations/index.md deleted file mode 100644 index a7f34c9b3d..0000000000 --- a/docs/awscc-docs/providers/awscc/logs/delivery_destinations/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.logs.delivery_destinations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the delivery_destinations resource, the following permissions are required: - -### Create -```json -logs:PutDeliveryDestination, -logs:GetDeliveryDestination, -logs:ListTagsForResource, -logs:TagResource, -logs:UntagResource, -logs:PutDeliveryDestinationPolicy, -logs:GetDeliveryDestinationPolicy -``` - -### List -```json -logs:DescribeDeliveryDestinations, -logs:GetDeliveryDestinationPolicy -``` - diff --git a/docs/awscc-docs/providers/awscc/logs/delivery_source/index.md b/docs/awscc-docs/providers/awscc/logs/delivery_source/index.md deleted file mode 100644 index 229e194d24..0000000000 --- a/docs/awscc-docs/providers/awscc/logs/delivery_source/index.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -arn, -resource_arns, -resource_arn, -service, -log_type, -tags -FROM awscc.logs.delivery_source -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the delivery_source resource, the following permissions are required: - -### Read -```json -logs:GetDeliverySource, -logs:ListTagsForResource -``` - -### Update -```json -logs:PutDeliverySource, -logs:GetDeliverySource, -logs:ListTagsForResource, -logs:TagResource, -logs:UntagResource -``` - -### Delete -```json -logs:DeleteDeliverySource -``` - diff --git a/docs/awscc-docs/providers/awscc/logs/delivery_sources/index.md b/docs/awscc-docs/providers/awscc/logs/delivery_sources/index.md deleted file mode 100644 index 2711666812..0000000000 --- a/docs/awscc-docs/providers/awscc/logs/delivery_sources/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.logs.delivery_sources -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the delivery_sources resource, the following permissions are required: - -### Create -```json -logs:PutDeliverySource, -logs:GetDeliverySource, -logs:ListTagsForResource, -logs:TagResource, -logs:AllowVendedLogDeliveryForResource, -codewhisperer:AllowVendedLogDeliveryForResource, -autoloop:AllowVendedLogDeliveryForResource, -workmail:AllowVendedLogDeliveryForResource -``` - -### List -```json -logs:DescribeDeliverySources -``` - diff --git a/docs/awscc-docs/providers/awscc/logs/destination/index.md b/docs/awscc-docs/providers/awscc/logs/destination/index.md deleted file mode 100644 index 1267c173fb..0000000000 --- a/docs/awscc-docs/providers/awscc/logs/destination/index.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -destination_name, -destination_policy, -role_arn, -target_arn -FROM awscc.logs.destination -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the destination resource, the following permissions are required: - -### Read -```json -logs:DescribeDestinations -``` - -### Update -```json -logs:PutDestination, -logs:PutDestinationPolicy, -logs:DescribeDestinations, -iam:PassRole -``` - -### Delete -```json -logs:DeleteDestination -``` - diff --git a/docs/awscc-docs/providers/awscc/logs/destinations/index.md b/docs/awscc-docs/providers/awscc/logs/destinations/index.md deleted file mode 100644 index c4d016cd29..0000000000 --- a/docs/awscc-docs/providers/awscc/logs/destinations/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -destination_name -FROM awscc.logs.destinations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the destinations resource, the following permissions are required: - -### Create -```json -logs:PutDestination, -logs:PutDestinationPolicy, -logs:DescribeDestinations, -iam:PassRole -``` - -### List -```json -logs:DescribeDestinations -``` - diff --git a/docs/awscc-docs/providers/awscc/logs/index.md b/docs/awscc-docs/providers/awscc/logs/index.md deleted file mode 100644 index 7f3c0a5fc6..0000000000 --- a/docs/awscc-docs/providers/awscc/logs/index.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -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 deleted file mode 100644 index 02895071bb..0000000000 --- a/docs/awscc-docs/providers/awscc/logs/log_anomaly_detector/index.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the log_anomaly_detector resource, the following permissions are required: - -### Read -```json -logs:GetLogAnomalyDetector -``` - -### Update -```json -logs:UpdateLogAnomalyDetector -``` - -### Delete -```json -logs:DeleteLogAnomalyDetector -``` - 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 deleted file mode 100644 index 9176474baf..0000000000 --- a/docs/awscc-docs/providers/awscc/logs/log_anomaly_detectors/index.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -anomaly_detector_arn -FROM awscc.logs.log_anomaly_detectors -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the log_anomaly_detectors resource, the following permissions are required: - -### Create -```json -logs:CreateLogAnomalyDetector -``` - -### List -```json -logs:ListLogAnomalyDetectors -``` - diff --git a/docs/awscc-docs/providers/awscc/logs/log_stream/index.md b/docs/awscc-docs/providers/awscc/logs/log_stream/index.md deleted file mode 100644 index 9f77621ce0..0000000000 --- a/docs/awscc-docs/providers/awscc/logs/log_stream/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -log_group_name, -log_stream_name -FROM awscc.logs.log_stream -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the log_stream resource, the following permissions are required: - -### Read -```json -logs:DescribeLogStreams -``` - -### Delete -```json -logs:DeleteLogStream -``` - diff --git a/docs/awscc-docs/providers/awscc/logs/log_streams/index.md b/docs/awscc-docs/providers/awscc/logs/log_streams/index.md deleted file mode 100644 index d21096d27b..0000000000 --- a/docs/awscc-docs/providers/awscc/logs/log_streams/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -log_group_name, -log_stream_name -FROM awscc.logs.log_streams -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the log_streams resource, the following permissions are required: - -### Create -```json -logs:CreateLogStream -``` - -### List -```json -logs:DescribeLogStreams -``` - diff --git a/docs/awscc-docs/providers/awscc/logs/metric_filter/index.md b/docs/awscc-docs/providers/awscc/logs/metric_filter/index.md deleted file mode 100644 index 8b5297ac98..0000000000 --- a/docs/awscc-docs/providers/awscc/logs/metric_filter/index.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -filter_name, -filter_pattern, -log_group_name, -metric_transformations -FROM awscc.logs.metric_filter -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the metric_filter resource, the following permissions are required: - -### Read -```json -logs:DescribeMetricFilters -``` - -### Update -```json -logs:PutMetricFilter, -logs:DescribeMetricFilters -``` - -### Delete -```json -logs:DeleteMetricFilter -``` - diff --git a/docs/awscc-docs/providers/awscc/logs/metric_filters/index.md b/docs/awscc-docs/providers/awscc/logs/metric_filters/index.md deleted file mode 100644 index 4f76fec503..0000000000 --- a/docs/awscc-docs/providers/awscc/logs/metric_filters/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -log_group_name, -filter_name -FROM awscc.logs.metric_filters -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the metric_filters resource, the following permissions are required: - -### Create -```json -logs:PutMetricFilter, -logs:DescribeMetricFilters -``` - -### List -```json -logs:DescribeMetricFilters -``` - diff --git a/docs/awscc-docs/providers/awscc/logs/query_definition/index.md b/docs/awscc-docs/providers/awscc/logs/query_definition/index.md deleted file mode 100644 index b55c412ad6..0000000000 --- a/docs/awscc-docs/providers/awscc/logs/query_definition/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -query_string, -log_group_names, -query_definition_id -FROM awscc.logs.query_definition -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the query_definition resource, the following permissions are required: - -### Read -```json -logs:DescribeQueryDefinitions -``` - -### Update -```json -logs:PutQueryDefinition -``` - -### Delete -```json -logs:DeleteQueryDefinition -``` - diff --git a/docs/awscc-docs/providers/awscc/logs/query_definitions/index.md b/docs/awscc-docs/providers/awscc/logs/query_definitions/index.md deleted file mode 100644 index d9758fc2cb..0000000000 --- a/docs/awscc-docs/providers/awscc/logs/query_definitions/index.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -query_definition_id -FROM awscc.logs.query_definitions -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the query_definitions resource, the following permissions are required: - -### Create -```json -logs:PutQueryDefinition -``` - -### List -```json -logs:DescribeQueryDefinitions -``` - diff --git a/docs/awscc-docs/providers/awscc/logs/resource_policies/index.md b/docs/awscc-docs/providers/awscc/logs/resource_policies/index.md deleted file mode 100644 index ff8899c2a4..0000000000 --- a/docs/awscc-docs/providers/awscc/logs/resource_policies/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -policy_name -FROM awscc.logs.resource_policies -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the resource_policies resource, the following permissions are required: - -### Create -```json -logs:PutResourcePolicy, -logs:DescribeResourcePolicies -``` - -### List -```json -logs:DescribeResourcePolicies -``` - diff --git a/docs/awscc-docs/providers/awscc/logs/resource_policy/index.md b/docs/awscc-docs/providers/awscc/logs/resource_policy/index.md deleted file mode 100644 index 41abdbef2b..0000000000 --- a/docs/awscc-docs/providers/awscc/logs/resource_policy/index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -policy_name, -policy_document -FROM awscc.logs.resource_policy -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the resource_policy resource, the following permissions are required: - -### Read -```json -logs:DescribeResourcePolicies -``` - -### Update -```json -logs:PutResourcePolicy, -logs:DescribeResourcePolicies, -logs:DeleteResourcePolicy -``` - -### Delete -```json -logs:DeleteResourcePolicy -``` - diff --git a/docs/awscc-docs/providers/awscc/logs/subscription_filter/index.md b/docs/awscc-docs/providers/awscc/logs/subscription_filter/index.md deleted file mode 100644 index a13e8f722e..0000000000 --- a/docs/awscc-docs/providers/awscc/logs/subscription_filter/index.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -filter_name, -destination_arn, -filter_pattern, -log_group_name, -role_arn, -distribution -FROM awscc.logs.subscription_filter -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the subscription_filter resource, the following permissions are required: - -### Read -```json -logs:DescribeSubscriptionFilters -``` - -### Update -```json -iam:PassRole, -logs:PutSubscriptionFilter, -logs:DescribeSubscriptionFilters -``` - -### Delete -```json -logs:DeleteSubscriptionFilter -``` - diff --git a/docs/awscc-docs/providers/awscc/logs/subscription_filters/index.md b/docs/awscc-docs/providers/awscc/logs/subscription_filters/index.md deleted file mode 100644 index 8687c275a7..0000000000 --- a/docs/awscc-docs/providers/awscc/logs/subscription_filters/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -filter_name, -log_group_name -FROM awscc.logs.subscription_filters -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the subscription_filters resource, the following permissions are required: - -### Create -```json -iam:PassRole, -logs:PutSubscriptionFilter, -logs:DescribeSubscriptionFilters -``` - -### List -```json -logs:DescribeSubscriptionFilters -``` - diff --git a/docs/awscc-docs/providers/awscc/lookoutequipment/index.md b/docs/awscc-docs/providers/awscc/lookoutequipment/index.md deleted file mode 100644 index e1036bc584..0000000000 --- a/docs/awscc-docs/providers/awscc/lookoutequipment/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 deleted file mode 100644 index 4415d05cba..0000000000 --- a/docs/awscc-docs/providers/awscc/lookoutequipment/inference_scheduler/index.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the inference_scheduler resource, the following permissions are required: - -### Read -```json -lookoutequipment:DescribeInferenceScheduler -``` - -### Delete -```json -lookoutequipment:DeleteInferenceScheduler, -lookoutequipment:StopInferenceScheduler, -lookoutequipment:DescribeInferenceScheduler -``` - -### Update -```json -lookoutequipment:UpdateInferenceScheduler, -lookoutequipment:DescribeInferenceScheduler, -lookoutequipment:StopInferenceScheduler, -lookoutequipment:StartInferenceScheduler -``` - diff --git a/docs/awscc-docs/providers/awscc/lookoutequipment/inference_schedulers/index.md b/docs/awscc-docs/providers/awscc/lookoutequipment/inference_schedulers/index.md deleted file mode 100644 index 842115a37a..0000000000 --- a/docs/awscc-docs/providers/awscc/lookoutequipment/inference_schedulers/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -inference_scheduler_name -FROM awscc.lookoutequipment.inference_schedulers -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the inference_schedulers resource, the following permissions are required: - -### Create -```json -iam:PassRole, -lookoutequipment:CreateInferenceScheduler, -lookoutequipment:DescribeInferenceScheduler -``` - -### List -```json -lookoutequipment:ListInferenceSchedulers -``` - diff --git a/docs/awscc-docs/providers/awscc/lookoutmetrics/alert/index.md b/docs/awscc-docs/providers/awscc/lookoutmetrics/alert/index.md deleted file mode 100644 index 0d32b706ec..0000000000 --- a/docs/awscc-docs/providers/awscc/lookoutmetrics/alert/index.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -alert_name, -arn, -alert_description, -anomaly_detector_arn, -alert_sensitivity_threshold, -action -FROM awscc.lookoutmetrics.alert -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the alert resource, the following permissions are required: - -### Read -```json -lookoutmetrics:DescribeAlert -``` - -### Delete -```json -lookoutmetrics:DeleteAlert -``` - diff --git a/docs/awscc-docs/providers/awscc/lookoutmetrics/alerts/index.md b/docs/awscc-docs/providers/awscc/lookoutmetrics/alerts/index.md deleted file mode 100644 index 7909840e17..0000000000 --- a/docs/awscc-docs/providers/awscc/lookoutmetrics/alerts/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.lookoutmetrics.alerts -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the alerts resource, the following permissions are required: - -### Create -```json -lookoutmetrics:CreateAlert, -iam:PassRole -``` - -### List -```json -lookoutmetrics:ListAlerts -``` - diff --git a/docs/awscc-docs/providers/awscc/lookoutmetrics/anomaly_detector/index.md b/docs/awscc-docs/providers/awscc/lookoutmetrics/anomaly_detector/index.md deleted file mode 100644 index a7a74f25a1..0000000000 --- a/docs/awscc-docs/providers/awscc/lookoutmetrics/anomaly_detector/index.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the anomaly_detector resource, the following permissions are required: - -### Read -```json -lookoutmetrics:DescribeAnomalyDetector, -lookoutmetrics:DescribeMetricSet, -lookoutmetrics:ListMetricSets -``` - -### Update -```json -lookoutmetrics:UpdateAnomalyDetector, -lookoutmetrics:UpdateMetricSet -``` - -### Delete -```json -lookoutmetrics:DescribeAnomalyDetector, -lookoutmetrics:DeleteAnomalyDetector -``` - diff --git a/docs/awscc-docs/providers/awscc/lookoutmetrics/anomaly_detectors/index.md b/docs/awscc-docs/providers/awscc/lookoutmetrics/anomaly_detectors/index.md deleted file mode 100644 index ff66072d94..0000000000 --- a/docs/awscc-docs/providers/awscc/lookoutmetrics/anomaly_detectors/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.lookoutmetrics.anomaly_detectors -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the anomaly_detectors resource, the following permissions are required: - -### Create -```json -lookoutmetrics:CreateAnomalyDetector, -lookoutmetrics:DeleteAnomalyDetector, -lookoutmetrics:CreateMetricSet, -iam:PassRole -``` - -### List -```json -lookoutmetrics:ListAnomalyDetectors -``` - diff --git a/docs/awscc-docs/providers/awscc/lookoutmetrics/index.md b/docs/awscc-docs/providers/awscc/lookoutmetrics/index.md deleted file mode 100644 index f9beb903fc..0000000000 --- a/docs/awscc-docs/providers/awscc/lookoutmetrics/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index a7faef8345..0000000000 --- a/docs/awscc-docs/providers/awscc/lookoutvision/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 deleted file mode 100644 index 1d89c892fb..0000000000 --- a/docs/awscc-docs/providers/awscc/lookoutvision/project/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -project_name -FROM awscc.lookoutvision.project -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the project resource, the following permissions are required: - -### Read -```json -lookoutvision:DescribeProject -``` - -### Delete -```json -lookoutvision:DeleteProject -``` - diff --git a/docs/awscc-docs/providers/awscc/lookoutvision/projects/index.md b/docs/awscc-docs/providers/awscc/lookoutvision/projects/index.md deleted file mode 100644 index 24e6b3049d..0000000000 --- a/docs/awscc-docs/providers/awscc/lookoutvision/projects/index.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -project_name -FROM awscc.lookoutvision.projects -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the projects resource, the following permissions are required: - -### Create -```json -lookoutvision:CreateProject -``` - -### List -```json -lookoutvision:ListProjects -``` - diff --git a/docs/awscc-docs/providers/awscc/m2/application/index.md b/docs/awscc-docs/providers/awscc/m2/application/index.md deleted file mode 100644 index ef876a2f6a..0000000000 --- a/docs/awscc-docs/providers/awscc/m2/application/index.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -application_arn, -application_id, -definition, -description, -engine_type, -kms_key_id, -name, -role_arn, -tags -FROM awscc.m2.application -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the application resource, the following permissions are required: - -### Read -```json -m2:GetApplication, -m2:ListTagsForResource -``` - -### Update -```json -m2:UpdateApplication, -m2:GetApplication, -m2:ListTagsForResource, -m2:TagResource, -m2:UntagResource, -s3:GetObject, -s3:ListBucket -``` - -### Delete -```json -elasticloadbalancing:DeleteListener, -elasticloadbalancing:DeleteTargetGroup, -logs:DeleteLogDelivery, -m2:GetApplication, -m2:DeleteApplication -``` - diff --git a/docs/awscc-docs/providers/awscc/m2/applications/index.md b/docs/awscc-docs/providers/awscc/m2/applications/index.md deleted file mode 100644 index 5ce26093e0..0000000000 --- a/docs/awscc-docs/providers/awscc/m2/applications/index.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -application_arn -FROM awscc.m2.applications -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the applications resource, the following permissions are required: - -### Create -```json -m2:CreateApplication, -m2:GetApplication, -m2:ListTagsForResource, -m2:TagResource, -s3:GetObject, -s3:ListBucket, -kms:DescribeKey, -kms:CreateGrant, -iam:PassRole -``` - -### List -```json -m2:ListApplications -``` - diff --git a/docs/awscc-docs/providers/awscc/m2/environment/index.md b/docs/awscc-docs/providers/awscc/m2/environment/index.md deleted file mode 100644 index 7030c1911d..0000000000 --- a/docs/awscc-docs/providers/awscc/m2/environment/index.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the environment resource, the following permissions are required: - -### Read -```json -m2:ListTagsForResource, -m2:GetEnvironment -``` - -### Update -```json -m2:TagResource, -m2:UntagResource, -m2:ListTagsForResource, -m2:GetEnvironment, -m2:UpdateEnvironment -``` - -### Delete -```json -elasticloadbalancing:DeleteLoadBalancer, -m2:DeleteEnvironment, -m2:GetEnvironment -``` - diff --git a/docs/awscc-docs/providers/awscc/m2/environments/index.md b/docs/awscc-docs/providers/awscc/m2/environments/index.md deleted file mode 100644 index 1be3931e52..0000000000 --- a/docs/awscc-docs/providers/awscc/m2/environments/index.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -environment_arn -FROM awscc.m2.environments -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the environments resource, the following permissions are required: - -### Create -```json -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 -```json -m2:ListEnvironments -``` - diff --git a/docs/awscc-docs/providers/awscc/m2/index.md b/docs/awscc-docs/providers/awscc/m2/index.md deleted file mode 100644 index d47bbaae1c..0000000000 --- a/docs/awscc-docs/providers/awscc/m2/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index 30cfc46904..0000000000 --- a/docs/awscc-docs/providers/awscc/macie/allow_list/index.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -description, -criteria, -id, -arn, -status, -tags -FROM awscc.macie.allow_list -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the allow_list resource, the following permissions are required: - -### Read -```json -macie2:GetAllowList -``` - -### Update -```json -macie2:UpdateAllowList, -macie2:GetAllowList, -macie2:TagResource, -macie2:UntagResource -``` - -### Delete -```json -macie2:DeleteAllowList -``` - diff --git a/docs/awscc-docs/providers/awscc/macie/allow_lists/index.md b/docs/awscc-docs/providers/awscc/macie/allow_lists/index.md deleted file mode 100644 index 90725b4a1c..0000000000 --- a/docs/awscc-docs/providers/awscc/macie/allow_lists/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.macie.allow_lists -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the allow_lists resource, the following permissions are required: - -### Create -```json -macie2:CreateAllowList, -macie2:GetAllowList, -macie2:TagResource -``` - -### List -```json -macie2:ListAllowLists -``` - 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 deleted file mode 100644 index d5ca3c2c3e..0000000000 --- a/docs/awscc-docs/providers/awscc/macie/custom_data_identifier/index.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -description, -regex, -maximum_match_distance, -keywords, -ignore_words, -id, -arn, -tags -FROM awscc.macie.custom_data_identifier -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the custom_data_identifier resource, the following permissions are required: - -### Read -```json -macie2:GetCustomDataIdentifier -``` - -### Delete -```json -macie2:DeleteCustomDataIdentifier -``` - -### Update -```json -macie2:TagResource, -macie2:UntagResource -``` - 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 deleted file mode 100644 index b2993df17f..0000000000 --- a/docs/awscc-docs/providers/awscc/macie/custom_data_identifiers/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.macie.custom_data_identifiers -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the custom_data_identifiers resource, the following permissions are required: - -### Create -```json -macie2:CreateCustomDataIdentifier, -macie2:GetCustomDataIdentifier, -macie2:TagResource -``` - -### List -```json -macie2:ListCustomDataIdentifiers -``` - diff --git a/docs/awscc-docs/providers/awscc/macie/findings_filter/index.md b/docs/awscc-docs/providers/awscc/macie/findings_filter/index.md deleted file mode 100644 index f0a589d9a7..0000000000 --- a/docs/awscc-docs/providers/awscc/macie/findings_filter/index.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -description, -finding_criteria, -action, -position, -id, -arn, -tags -FROM awscc.macie.findings_filter -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the findings_filter resource, the following permissions are required: - -### Read -```json -macie2:GetFindingsFilter -``` - -### Update -```json -macie2:GetFindingsFilter, -macie2:UpdateFindingsFilter, -macie2:TagResource, -macie2:UntagResource -``` - -### Delete -```json -macie2:DeleteFindingsFilter -``` - diff --git a/docs/awscc-docs/providers/awscc/macie/findings_filters/index.md b/docs/awscc-docs/providers/awscc/macie/findings_filters/index.md deleted file mode 100644 index ff8ff41854..0000000000 --- a/docs/awscc-docs/providers/awscc/macie/findings_filters/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.macie.findings_filters -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the findings_filters resource, the following permissions are required: - -### Create -```json -macie2:GetFindingsFilter, -macie2:CreateFindingsFilter, -macie2:TagResource -``` - -### List -```json -macie2:ListFindingsFilters -``` - diff --git a/docs/awscc-docs/providers/awscc/macie/index.md b/docs/awscc-docs/providers/awscc/macie/index.md deleted file mode 100644 index 9ad07552ca..0000000000 --- a/docs/awscc-docs/providers/awscc/macie/index.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -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 deleted file mode 100644 index f47baf9f6c..0000000000 --- a/docs/awscc-docs/providers/awscc/macie/session/index.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -aws_account_id, -status, -finding_publishing_frequency, -service_role -FROM awscc.macie.session -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the session resource, the following permissions are required: - -### Read -```json -macie2:GetMacieSession -``` - -### Update -```json -macie2:GetMacieSession, -macie2:UpdateMacieSession -``` - -### Delete -```json -macie2:DisableMacie -``` - diff --git a/docs/awscc-docs/providers/awscc/macie/sessions/index.md b/docs/awscc-docs/providers/awscc/macie/sessions/index.md deleted file mode 100644 index 2dce634679..0000000000 --- a/docs/awscc-docs/providers/awscc/macie/sessions/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -aws_account_id -FROM awscc.macie.sessions -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the sessions resource, the following permissions are required: - -### Create -```json -macie2:GetMacieSession, -macie2:EnableMacie -``` - -### List -```json -macie2:GetMacieSession -``` - diff --git a/docs/awscc-docs/providers/awscc/managedblockchain/accessor/index.md b/docs/awscc-docs/providers/awscc/managedblockchain/accessor/index.md deleted file mode 100644 index f691f9dbf8..0000000000 --- a/docs/awscc-docs/providers/awscc/managedblockchain/accessor/index.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -billing_token, -creation_date, -id, -status, -accessor_type, -network_type, -tags -FROM awscc.managedblockchain.accessor -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the accessor resource, the following permissions are required: - -### Read -```json -managedblockchain:GetAccessor -``` - -### Update -```json -managedblockchain:GetAccessor, -managedblockchain:CreateAccessor, -managedblockchain:TagResource, -managedblockchain:UntagResource -``` - -### Delete -```json -managedblockchain:DeleteAccessor -``` - diff --git a/docs/awscc-docs/providers/awscc/managedblockchain/accessors/index.md b/docs/awscc-docs/providers/awscc/managedblockchain/accessors/index.md deleted file mode 100644 index 8ec61342d9..0000000000 --- a/docs/awscc-docs/providers/awscc/managedblockchain/accessors/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.managedblockchain.accessors -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the accessors resource, the following permissions are required: - -### Create -```json -managedblockchain:CreateAccessor, -managedblockchain:TagResource, -managedblockchain:GetAccessor -``` - -### List -```json -managedblockchain:ListAccessors -``` - diff --git a/docs/awscc-docs/providers/awscc/managedblockchain/index.md b/docs/awscc-docs/providers/awscc/managedblockchain/index.md deleted file mode 100644 index 50e405d2d7..0000000000 --- a/docs/awscc-docs/providers/awscc/managedblockchain/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 deleted file mode 100644 index 59f334f86b..0000000000 --- a/docs/awscc-docs/providers/awscc/mediaconnect/bridge/index.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the bridge resource, the following permissions are required: - -### Read -```json -mediaconnect:DescribeBridge -``` - -### Update -```json -mediaconnect:DescribeBridge, -mediaconnect:UpdateBridge -``` - -### Delete -```json -mediaconnect:DescribeBridge, -mediaconnect:DeleteBridge -``` - diff --git a/docs/awscc-docs/providers/awscc/mediaconnect/bridge_output/index.md b/docs/awscc-docs/providers/awscc/mediaconnect/bridge_output/index.md deleted file mode 100644 index fb9fa607c6..0000000000 --- a/docs/awscc-docs/providers/awscc/mediaconnect/bridge_output/index.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -bridge_arn, -network_output, -name -FROM awscc.mediaconnect.bridge_output -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the bridge_output resource, the following permissions are required: - -### Read -```json -mediaconnect:DescribeBridge -``` - -### Update -```json -mediaconnect:DescribeBridge, -mediaconnect:UpdateBridgeOutput -``` - -### Delete -```json -mediaconnect:RemoveBridgeOutput -``` - diff --git a/docs/awscc-docs/providers/awscc/mediaconnect/bridge_source/index.md b/docs/awscc-docs/providers/awscc/mediaconnect/bridge_source/index.md deleted file mode 100644 index 90629e822d..0000000000 --- a/docs/awscc-docs/providers/awscc/mediaconnect/bridge_source/index.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -bridge_arn, -flow_source, -network_source -FROM awscc.mediaconnect.bridge_source -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the bridge_source resource, the following permissions are required: - -### Read -```json -mediaconnect:DescribeBridge -``` - -### Update -```json -mediaconnect:DescribeBridge, -mediaconnect:UpdateBridgeSource -``` - -### Delete -```json -mediaconnect:RemoveBridgeSource -``` - diff --git a/docs/awscc-docs/providers/awscc/mediaconnect/bridges/index.md b/docs/awscc-docs/providers/awscc/mediaconnect/bridges/index.md deleted file mode 100644 index edd7c27f5e..0000000000 --- a/docs/awscc-docs/providers/awscc/mediaconnect/bridges/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -bridge_arn -FROM awscc.mediaconnect.bridges -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the bridges resource, the following permissions are required: - -### Create -```json -mediaconnect:CreateBridge, -mediaconnect:DescribeBridge -``` - -### List -```json -mediaconnect:ListBridges -``` - diff --git a/docs/awscc-docs/providers/awscc/mediaconnect/flow/index.md b/docs/awscc-docs/providers/awscc/mediaconnect/flow/index.md deleted file mode 100644 index 50154f7c5e..0000000000 --- a/docs/awscc-docs/providers/awscc/mediaconnect/flow/index.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -flow_arn, -name, -availability_zone, -flow_availability_zone, -source, -source_failover_config -FROM awscc.mediaconnect.flow -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the flow resource, the following permissions are required: - -### Read -```json -mediaconnect:DescribeFlow -``` - -### Update -```json -mediaconnect:DescribeFlow, -mediaconnect:UpdateFlow, -mediaconnect:UpdateFlowSource -``` - -### Delete -```json -mediaconnect:DescribeFlow, -mediaconnect:DeleteFlow -``` - diff --git a/docs/awscc-docs/providers/awscc/mediaconnect/flow_entitlement/index.md b/docs/awscc-docs/providers/awscc/mediaconnect/flow_entitlement/index.md deleted file mode 100644 index 87bcf20de6..0000000000 --- a/docs/awscc-docs/providers/awscc/mediaconnect/flow_entitlement/index.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the flow_entitlement resource, the following permissions are required: - -### Read -```json -mediaconnect:DescribeFlow -``` - -### Update -```json -mediaconnect:DescribeFlow, -mediaconnect:UpdateFlowEntitlement -``` - -### Delete -```json -mediaconnect:DescribeFlow, -mediaconnect:RevokeFlowEntitlement -``` - diff --git a/docs/awscc-docs/providers/awscc/mediaconnect/flow_entitlements/index.md b/docs/awscc-docs/providers/awscc/mediaconnect/flow_entitlements/index.md deleted file mode 100644 index 59dbadb1ac..0000000000 --- a/docs/awscc-docs/providers/awscc/mediaconnect/flow_entitlements/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -entitlement_arn -FROM awscc.mediaconnect.flow_entitlements -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the flow_entitlements resource, the following permissions are required: - -### Create -```json -iam:PassRole, -mediaconnect:GrantFlowEntitlements -``` - -### List -```json -mediaconnect:DescribeFlow -``` - diff --git a/docs/awscc-docs/providers/awscc/mediaconnect/flow_output/index.md b/docs/awscc-docs/providers/awscc/mediaconnect/flow_output/index.md deleted file mode 100644 index 9ec4f1370b..0000000000 --- a/docs/awscc-docs/providers/awscc/mediaconnect/flow_output/index.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the flow_output resource, the following permissions are required: - -### Read -```json -mediaconnect:DescribeFlow -``` - -### Update -```json -mediaconnect:DescribeFlow, -mediaconnect:UpdateFlowOutput -``` - -### Delete -```json -mediaconnect:DescribeFlow, -mediaconnect:RemoveFlowOutput -``` - diff --git a/docs/awscc-docs/providers/awscc/mediaconnect/flow_outputs/index.md b/docs/awscc-docs/providers/awscc/mediaconnect/flow_outputs/index.md deleted file mode 100644 index 45e9474f3b..0000000000 --- a/docs/awscc-docs/providers/awscc/mediaconnect/flow_outputs/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -output_arn -FROM awscc.mediaconnect.flow_outputs -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the flow_outputs resource, the following permissions are required: - -### Create -```json -iam:PassRole, -mediaconnect:AddFlowOutputs -``` - -### List -```json -mediaconnect:DescribeFlow -``` - diff --git a/docs/awscc-docs/providers/awscc/mediaconnect/flow_source/index.md b/docs/awscc-docs/providers/awscc/mediaconnect/flow_source/index.md deleted file mode 100644 index 574d5f6aa5..0000000000 --- a/docs/awscc-docs/providers/awscc/mediaconnect/flow_source/index.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the flow_source resource, the following permissions are required: - -### Read -```json -mediaconnect:DescribeFlow -``` - -### Update -```json -mediaconnect:DescribeFlow, -mediaconnect:UpdateFlowSource -``` - -### Delete -```json -mediaconnect:DescribeFlow, -mediaconnect:RemoveFlowSource -``` - diff --git a/docs/awscc-docs/providers/awscc/mediaconnect/flow_sources/index.md b/docs/awscc-docs/providers/awscc/mediaconnect/flow_sources/index.md deleted file mode 100644 index 145f8c83b2..0000000000 --- a/docs/awscc-docs/providers/awscc/mediaconnect/flow_sources/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -source_arn -FROM awscc.mediaconnect.flow_sources -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the flow_sources resource, the following permissions are required: - -### Create -```json -mediaconnect:CreateFlow, -mediaconnect:DescribeFlow, -mediaconnect:AddFlowSources, -iam:PassRole -``` - -### List -```json -mediaconnect:DescribeFlow -``` - 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 deleted file mode 100644 index 354122624e..0000000000 --- a/docs/awscc-docs/providers/awscc/mediaconnect/flow_vpc_interface/index.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -flow_arn, -name, -role_arn, -security_group_ids, -subnet_id, -network_interface_ids -FROM awscc.mediaconnect.flow_vpc_interface -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the flow_vpc_interface resource, the following permissions are required: - -### Read -```json -mediaconnect:DescribeFlow -``` - -### Update -```json -mediaconnect:DescribeFlow, -mediaconnect:AddFlowVpcInterfaces, -mediaconnect:RemoveFlowVpcInterface -``` - -### Delete -```json -mediaconnect:DescribeFlow, -mediaconnect:RemoveFlowVpcInterface -``` - 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 deleted file mode 100644 index aab40d7a1b..0000000000 --- a/docs/awscc-docs/providers/awscc/mediaconnect/flow_vpc_interfaces/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -flow_arn, -name -FROM awscc.mediaconnect.flow_vpc_interfaces -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the flow_vpc_interfaces resource, the following permissions are required: - -### Create -```json -iam:PassRole, -mediaconnect:DescribeFlow, -mediaconnect:AddFlowVpcInterfaces -``` - -### List -```json -mediaconnect:DescribeFlow -``` - diff --git a/docs/awscc-docs/providers/awscc/mediaconnect/flows/index.md b/docs/awscc-docs/providers/awscc/mediaconnect/flows/index.md deleted file mode 100644 index ba165d4714..0000000000 --- a/docs/awscc-docs/providers/awscc/mediaconnect/flows/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -flow_arn -FROM awscc.mediaconnect.flows -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the flows resource, the following permissions are required: - -### Create -```json -mediaconnect:CreateFlow, -iam:PassRole -``` - -### List -```json -mediaconnect:ListFlows -``` - diff --git a/docs/awscc-docs/providers/awscc/mediaconnect/gateway/index.md b/docs/awscc-docs/providers/awscc/mediaconnect/gateway/index.md deleted file mode 100644 index 96ea2d7da1..0000000000 --- a/docs/awscc-docs/providers/awscc/mediaconnect/gateway/index.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -gateway_arn, -gateway_state, -egress_cidr_blocks, -networks -FROM awscc.mediaconnect.gateway -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the gateway resource, the following permissions are required: - -### Read -```json -mediaconnect:DescribeGateway -``` - -### Delete -```json -iam:CreateServiceLinkedRole, -mediaconnect:DescribeGateway, -mediaconnect:DeleteGateway -``` - diff --git a/docs/awscc-docs/providers/awscc/mediaconnect/gateways/index.md b/docs/awscc-docs/providers/awscc/mediaconnect/gateways/index.md deleted file mode 100644 index b017100413..0000000000 --- a/docs/awscc-docs/providers/awscc/mediaconnect/gateways/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -gateway_arn -FROM awscc.mediaconnect.gateways -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the gateways resource, the following permissions are required: - -### Create -```json -iam:CreateServiceLinkedRole, -mediaconnect:CreateGateway, -mediaconnect:DescribeGateway -``` - -### List -```json -mediaconnect:ListGateways -``` - diff --git a/docs/awscc-docs/providers/awscc/mediaconnect/index.md b/docs/awscc-docs/providers/awscc/mediaconnect/index.md deleted file mode 100644 index 0c4ad717a0..0000000000 --- a/docs/awscc-docs/providers/awscc/mediaconnect/index.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -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: 16
-total selectable resources: 16
-total methods: 16
-
-
- -::: - -## Resources -
-
-bridge
-bridge_output
-bridge_source
-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 deleted file mode 100644 index b9f6bdd92f..0000000000 --- a/docs/awscc-docs/providers/awscc/medialive/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index c4742f621d..0000000000 --- a/docs/awscc-docs/providers/awscc/medialive/multiplex/index.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -availability_zones, -destinations, -id, -multiplex_settings, -name, -pipelines_running_count, -program_count, -state, -tags -FROM awscc.medialive.multiplex -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the multiplex resource, the following permissions are required: - -### Read -```json -medialive:DescribeMultiplex -``` - -### Update -```json -medialive:UpdateMultiplex, -medialive:DescribeMultiplex, -medialive:CreateTags, -medialive:DeleteTags -``` - -### Delete -```json -medialive:DeleteMultiplex, -medialive:DescribeMultiplex -``` - diff --git a/docs/awscc-docs/providers/awscc/medialive/multiplexes/index.md b/docs/awscc-docs/providers/awscc/medialive/multiplexes/index.md deleted file mode 100644 index 432f542d8c..0000000000 --- a/docs/awscc-docs/providers/awscc/medialive/multiplexes/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.medialive.multiplexes -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the multiplexes resource, the following permissions are required: - -### Create -```json -medialive:CreateMultiplex, -medialive:DescribeMultiplex, -medialive:CreateTags -``` - -### List -```json -medialive:ListMultiplexes -``` - diff --git a/docs/awscc-docs/providers/awscc/medialive/multiplexprogram/index.md b/docs/awscc-docs/providers/awscc/medialive/multiplexprogram/index.md deleted file mode 100644 index 6ff75b34e0..0000000000 --- a/docs/awscc-docs/providers/awscc/medialive/multiplexprogram/index.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the multiplexprogram resource, the following permissions are required: - -### Read -```json -medialive:DescribeMultiplexProgram -``` - -### Update -```json -medialive:UpdateMultiplexProgram, -medialive:DescribeMultiplexProgram -``` - -### Delete -```json -medialive:DeleteMultiplexProgram, -medialive:DescribeMultiplexProgram -``` - diff --git a/docs/awscc-docs/providers/awscc/medialive/multiplexprograms/index.md b/docs/awscc-docs/providers/awscc/medialive/multiplexprograms/index.md deleted file mode 100644 index dadcdd02f8..0000000000 --- a/docs/awscc-docs/providers/awscc/medialive/multiplexprograms/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -program_name, -multiplex_id -FROM awscc.medialive.multiplexprograms -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the multiplexprograms resource, the following permissions are required: - -### Create -```json -medialive:CreateMultiplexProgram, -medialive:DescribeMultiplexProgram -``` - -### List -```json -medialive:ListMultiplexPrograms -``` - diff --git a/docs/awscc-docs/providers/awscc/mediapackage/asset/index.md b/docs/awscc-docs/providers/awscc/mediapackage/asset/index.md deleted file mode 100644 index 852ca8ad34..0000000000 --- a/docs/awscc-docs/providers/awscc/mediapackage/asset/index.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the asset resource, the following permissions are required: - -### Read -```json -mediapackage-vod:DescribeAsset -``` - -### Delete -```json -mediapackage-vod:DescribeAsset, -mediapackage-vod:DeleteAsset -``` - diff --git a/docs/awscc-docs/providers/awscc/mediapackage/assets/index.md b/docs/awscc-docs/providers/awscc/mediapackage/assets/index.md deleted file mode 100644 index c3f32cbd46..0000000000 --- a/docs/awscc-docs/providers/awscc/mediapackage/assets/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.mediapackage.assets -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the assets resource, the following permissions are required: - -### Create -```json -mediapackage-vod:CreateAsset, -mediapackage-vod:DescribeAsset, -mediapackage-vod:TagResource, -iam:PassRole -``` - -### List -```json -mediapackage-vod:ListAssets, -mediapackage-vod:DescribePackagingGroup -``` - diff --git a/docs/awscc-docs/providers/awscc/mediapackage/channel/index.md b/docs/awscc-docs/providers/awscc/mediapackage/channel/index.md deleted file mode 100644 index 863e2d3e47..0000000000 --- a/docs/awscc-docs/providers/awscc/mediapackage/channel/index.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -id, -description, -hls_ingest, -tags, -egress_access_logs, -ingress_access_logs -FROM awscc.mediapackage.channel -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the channel resource, the following permissions are required: - -### Read -```json -mediapackage:DescribeChannel -``` - -### Update -```json -mediapackage:UpdateChannel, -mediapackage:ConfigureLogs, -iam:CreateServiceLinkedRole -``` - -### Delete -```json -mediapackage:DeleteChannel -``` - diff --git a/docs/awscc-docs/providers/awscc/mediapackage/channels/index.md b/docs/awscc-docs/providers/awscc/mediapackage/channels/index.md deleted file mode 100644 index 1768dd3434..0000000000 --- a/docs/awscc-docs/providers/awscc/mediapackage/channels/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.mediapackage.channels -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the channels resource, the following permissions are required: - -### Create -```json -mediapackage:CreateChannel, -mediapackage:DescribeChannel, -mediapackage:UpdateChannel, -mediapackage:TagResource, -mediapackage:ConfigureLogs, -iam:CreateServiceLinkedRole -``` - -### List -```json -mediapackage:ListChannels -``` - diff --git a/docs/awscc-docs/providers/awscc/mediapackage/index.md b/docs/awscc-docs/providers/awscc/mediapackage/index.md deleted file mode 100644 index babb4d9694..0000000000 --- a/docs/awscc-docs/providers/awscc/mediapackage/index.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -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 deleted file mode 100644 index bc1fdaf6e7..0000000000 --- a/docs/awscc-docs/providers/awscc/mediapackage/origin_endpoint/index.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the origin_endpoint resource, the following permissions are required: - -### Read -```json -mediapackage:DescribeOriginEndpoint -``` - -### Update -```json -mediapackage:UpdateOriginEndpoint, -iam:PassRole -``` - -### Delete -```json -mediapackage:DeleteOriginEndpoint -``` - diff --git a/docs/awscc-docs/providers/awscc/mediapackage/origin_endpoints/index.md b/docs/awscc-docs/providers/awscc/mediapackage/origin_endpoints/index.md deleted file mode 100644 index dbddd8a672..0000000000 --- a/docs/awscc-docs/providers/awscc/mediapackage/origin_endpoints/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.mediapackage.origin_endpoints -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the origin_endpoints resource, the following permissions are required: - -### Create -```json -mediapackage:CreateOriginEndpoint, -mediapackage:DescribeOriginEndpoint, -mediapackage:DescribeChannel, -mediapackage:TagResource, -iam:PassRole, -acm:DescribeCertificate -``` - -### List -```json -mediapackage:ListOriginEndpoints -``` - diff --git a/docs/awscc-docs/providers/awscc/mediapackage/packaging_configuration/index.md b/docs/awscc-docs/providers/awscc/mediapackage/packaging_configuration/index.md deleted file mode 100644 index 3c42b062d1..0000000000 --- a/docs/awscc-docs/providers/awscc/mediapackage/packaging_configuration/index.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id, -packaging_group_id, -arn, -cmaf_package, -dash_package, -hls_package, -mss_package, -tags -FROM awscc.mediapackage.packaging_configuration -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the packaging_configuration resource, the following permissions are required: - -### Read -```json -mediapackage-vod:DescribePackagingConfiguration -``` - -### Delete -```json -mediapackage-vod:DescribePackagingConfiguration, -mediapackage-vod:DeletePackagingConfiguration -``` - diff --git a/docs/awscc-docs/providers/awscc/mediapackage/packaging_configurations/index.md b/docs/awscc-docs/providers/awscc/mediapackage/packaging_configurations/index.md deleted file mode 100644 index bb5fa220a9..0000000000 --- a/docs/awscc-docs/providers/awscc/mediapackage/packaging_configurations/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.mediapackage.packaging_configurations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the packaging_configurations resource, the following permissions are required: - -### Create -```json -mediapackage-vod:CreatePackagingConfiguration, -mediapackage-vod:DescribePackagingConfiguration, -mediapackage-vod:TagResource, -iam:PassRole -``` - -### List -```json -mediapackage-vod:ListPackagingConfigurations, -mediapackage-vod:DescribePackagingGroup -``` - diff --git a/docs/awscc-docs/providers/awscc/mediapackage/packaging_group/index.md b/docs/awscc-docs/providers/awscc/mediapackage/packaging_group/index.md deleted file mode 100644 index 80f0cf0969..0000000000 --- a/docs/awscc-docs/providers/awscc/mediapackage/packaging_group/index.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id, -arn, -domain_name, -authorization, -tags, -egress_access_logs -FROM awscc.mediapackage.packaging_group -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the packaging_group resource, the following permissions are required: - -### Read -```json -mediapackage-vod:DescribePackagingGroup -``` - -### Update -```json -mediapackage-vod:DescribePackagingGroup, -mediapackage-vod:UpdatePackagingGroup, -mediapackage-vod:ConfigureLogs, -mediapackage-vod:TagResource, -iam:PassRole, -iam:CreateServiceLinkedRole -``` - -### Delete -```json -mediapackage-vod:DescribePackagingGroup, -mediapackage-vod:DeletePackagingGroup -``` - diff --git a/docs/awscc-docs/providers/awscc/mediapackage/packaging_groups/index.md b/docs/awscc-docs/providers/awscc/mediapackage/packaging_groups/index.md deleted file mode 100644 index b6b694917f..0000000000 --- a/docs/awscc-docs/providers/awscc/mediapackage/packaging_groups/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.mediapackage.packaging_groups -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the packaging_groups resource, the following permissions are required: - -### Create -```json -mediapackage-vod:CreatePackagingGroup, -mediapackage-vod:DescribePackagingGroup, -mediapackage-vod:TagResource, -mediapackage-vod:ConfigureLogs, -iam:PassRole, -iam:CreateServiceLinkedRole -``` - -### List -```json -mediapackage-vod:ListPackagingGroups -``` - diff --git a/docs/awscc-docs/providers/awscc/mediapackagev2/channel/index.md b/docs/awscc-docs/providers/awscc/mediapackagev2/channel/index.md deleted file mode 100644 index 44340b1dab..0000000000 --- a/docs/awscc-docs/providers/awscc/mediapackagev2/channel/index.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -channel_group_name, -channel_name, -created_at, -description, -ingest_endpoints, -modified_at, -tags -FROM awscc.mediapackagev2.channel -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the channel resource, the following permissions are required: - -### Read -```json -mediapackagev2:GetChannel -``` - -### Update -```json -mediapackagev2:TagResource, -mediapackagev2:UntagResource, -mediapackagev2:ListTagsForResource, -mediapackagev2:UpdateChannel -``` - -### Delete -```json -mediapackagev2:GetChannel, -mediapackagev2:DeleteChannel -``` - diff --git a/docs/awscc-docs/providers/awscc/mediapackagev2/channel_group/index.md b/docs/awscc-docs/providers/awscc/mediapackagev2/channel_group/index.md deleted file mode 100644 index 9286bbeba7..0000000000 --- a/docs/awscc-docs/providers/awscc/mediapackagev2/channel_group/index.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -channel_group_name, -created_at, -description, -egress_domain, -modified_at, -tags -FROM awscc.mediapackagev2.channel_group -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the channel_group resource, the following permissions are required: - -### Read -```json -mediapackagev2:GetChannelGroup -``` - -### Update -```json -mediapackagev2:TagResource, -mediapackagev2:UntagResource, -mediapackagev2:ListTagsForResource, -mediapackagev2:UpdateChannelGroup -``` - -### Delete -```json -mediapackagev2:GetChannelGroup, -mediapackagev2:DeleteChannelGroup -``` - diff --git a/docs/awscc-docs/providers/awscc/mediapackagev2/channel_groups/index.md b/docs/awscc-docs/providers/awscc/mediapackagev2/channel_groups/index.md deleted file mode 100644 index d9d9beebfb..0000000000 --- a/docs/awscc-docs/providers/awscc/mediapackagev2/channel_groups/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.mediapackagev2.channel_groups -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the channel_groups resource, the following permissions are required: - -### Create -```json -mediapackagev2:TagResource, -mediapackagev2:CreateChannelGroup -``` - -### List -```json -mediapackagev2:ListChannelGroups -``` - diff --git a/docs/awscc-docs/providers/awscc/mediapackagev2/channel_policy/index.md b/docs/awscc-docs/providers/awscc/mediapackagev2/channel_policy/index.md deleted file mode 100644 index 9dd3349782..0000000000 --- a/docs/awscc-docs/providers/awscc/mediapackagev2/channel_policy/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -channel_group_name, -channel_name, -policy -FROM awscc.mediapackagev2.channel_policy -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the channel_policy resource, the following permissions are required: - -### Read -```json -mediapackagev2:GetChannelPolicy -``` - -### Update -```json -mediapackagev2:GetChannelPolicy, -mediapackagev2:PutChannelPolicy -``` - -### Delete -```json -mediapackagev2:GetChannelPolicy, -mediapackagev2:DeleteChannelPolicy -``` - diff --git a/docs/awscc-docs/providers/awscc/mediapackagev2/channels/index.md b/docs/awscc-docs/providers/awscc/mediapackagev2/channels/index.md deleted file mode 100644 index b878aae521..0000000000 --- a/docs/awscc-docs/providers/awscc/mediapackagev2/channels/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.mediapackagev2.channels -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the channels resource, the following permissions are required: - -### Create -```json -mediapackagev2:TagResource, -mediapackagev2:CreateChannel -``` - -### List -```json -mediapackagev2:ListChannels -``` - diff --git a/docs/awscc-docs/providers/awscc/mediapackagev2/index.md b/docs/awscc-docs/providers/awscc/mediapackagev2/index.md deleted file mode 100644 index 15cd77b8e0..0000000000 --- a/docs/awscc-docs/providers/awscc/mediapackagev2/index.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -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: 8
-total selectable resources: 8
-total methods: 8
-
-
- -::: - -## Resources -
-
-channel
-channel_group
-channel_groups
-channel_policy -
-
-channels
-origin_endpoint
-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 deleted file mode 100644 index ba2a83ba37..0000000000 --- a/docs/awscc-docs/providers/awscc/mediapackagev2/origin_endpoint/index.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the origin_endpoint resource, the following permissions are required: - -### Read -```json -mediapackagev2:GetOriginEndpoint -``` - -### Update -```json -mediapackagev2:TagResource, -mediapackagev2:UntagResource, -mediapackagev2:ListTagsForResource, -mediapackagev2:UpdateOriginEndpoint, -iam:PassRole -``` - -### Delete -```json -mediapackagev2:GetOriginEndpoint, -mediapackagev2:DeleteOriginEndpoint -``` - 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 deleted file mode 100644 index 6711bdc76b..0000000000 --- a/docs/awscc-docs/providers/awscc/mediapackagev2/origin_endpoint_policy/index.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -channel_group_name, -channel_name, -origin_endpoint_name, -policy -FROM awscc.mediapackagev2.origin_endpoint_policy -WHERE data__Identifier = '||'; -``` - -## Permissions - -To operate on the origin_endpoint_policy resource, the following permissions are required: - -### Read -```json -mediapackagev2:GetOriginEndpointPolicy -``` - -### Update -```json -mediapackagev2:GetOriginEndpointPolicy, -mediapackagev2:PutOriginEndpointPolicy -``` - -### Delete -```json -mediapackagev2:GetOriginEndpointPolicy, -mediapackagev2:DeleteOriginEndpointPolicy -``` - diff --git a/docs/awscc-docs/providers/awscc/mediapackagev2/origin_endpoints/index.md b/docs/awscc-docs/providers/awscc/mediapackagev2/origin_endpoints/index.md deleted file mode 100644 index 321717426b..0000000000 --- a/docs/awscc-docs/providers/awscc/mediapackagev2/origin_endpoints/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.mediapackagev2.origin_endpoints -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the origin_endpoints resource, the following permissions are required: - -### Create -```json -mediapackagev2:TagResource, -mediapackagev2:CreateOriginEndpoint, -iam:PassRole -``` - -### List -```json -mediapackagev2:ListOriginEndpoints -``` - diff --git a/docs/awscc-docs/providers/awscc/mediatailor/channel/index.md b/docs/awscc-docs/providers/awscc/mediatailor/channel/index.md deleted file mode 100644 index 9b765e16d4..0000000000 --- a/docs/awscc-docs/providers/awscc/mediatailor/channel/index.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -channel_name, -filler_slate, -log_configuration, -outputs, -playback_mode, -tags, -tier, -time_shift_configuration -FROM awscc.mediatailor.channel -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the channel resource, the following permissions are required: - -### Read -```json -mediatailor:DescribeChannel -``` - -### Update -```json -mediatailor:UpdateChannel, -mediatailor:TagResource, -mediatailor:UntagResource, -iam:CreateServiceLinkedRole, -mediatailor:ConfigureLogsForChannel, -mediatailor:DescribeChannel -``` - -### Delete -```json -mediatailor:DeleteChannel, -mediatailor:DescribeChannel -``` - diff --git a/docs/awscc-docs/providers/awscc/mediatailor/channel_policy/index.md b/docs/awscc-docs/providers/awscc/mediatailor/channel_policy/index.md deleted file mode 100644 index c55a0827cc..0000000000 --- a/docs/awscc-docs/providers/awscc/mediatailor/channel_policy/index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -channel_name, -policy -FROM awscc.mediatailor.channel_policy -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the channel_policy resource, the following permissions are required: - -### Read -```json -mediatailor:GetChannelPolicy -``` - -### Update -```json -mediatailor:PutChannelPolicy, -mediatailor:GetChannelPolicy -``` - -### Delete -```json -mediatailor:DeleteChannelPolicy, -mediatailor:GetChannelPolicy -``` - diff --git a/docs/awscc-docs/providers/awscc/mediatailor/channels/index.md b/docs/awscc-docs/providers/awscc/mediatailor/channels/index.md deleted file mode 100644 index 29f6441565..0000000000 --- a/docs/awscc-docs/providers/awscc/mediatailor/channels/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -channel_name -FROM awscc.mediatailor.channels -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the channels resource, the following permissions are required: - -### Create -```json -mediatailor:CreateChannel, -mediatailor:TagResource, -mediatailor:ConfigureLogsForChannel, -iam:CreateServiceLinkedRole, -mediatailor:DescribeChannel -``` - -### List -```json -mediatailor:ListChannels -``` - diff --git a/docs/awscc-docs/providers/awscc/mediatailor/index.md b/docs/awscc-docs/providers/awscc/mediatailor/index.md deleted file mode 100644 index e662dfe612..0000000000 --- a/docs/awscc-docs/providers/awscc/mediatailor/index.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -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: 11
-total selectable resources: 11
-total methods: 11
-
-
- -::: - -## Resources -
-
-channel
-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 deleted file mode 100644 index 3e3290fff8..0000000000 --- a/docs/awscc-docs/providers/awscc/mediatailor/live_source/index.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -http_package_configurations, -live_source_name, -source_location_name, -tags -FROM awscc.mediatailor.live_source -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the live_source resource, the following permissions are required: - -### Read -```json -mediatailor:DescribeLiveSource -``` - -### Update -```json -mediatailor:UpdateLiveSource, -mediatailor:DescribeLiveSource, -mediatailor:TagResource, -mediatailor:UntagResource -``` - -### Delete -```json -mediatailor:DeleteLiveSource, -mediatailor:DescribeLiveSource -``` - diff --git a/docs/awscc-docs/providers/awscc/mediatailor/live_sources/index.md b/docs/awscc-docs/providers/awscc/mediatailor/live_sources/index.md deleted file mode 100644 index ccbbd04ebd..0000000000 --- a/docs/awscc-docs/providers/awscc/mediatailor/live_sources/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -live_source_name, -source_location_name -FROM awscc.mediatailor.live_sources -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the live_sources resource, the following permissions are required: - -### Create -```json -mediatailor:CreateLiveSource, -mediatailor:DescribeLiveSource, -mediatailor:TagResource -``` - -### List -```json -mediatailor:ListLiveSources -``` - diff --git a/docs/awscc-docs/providers/awscc/mediatailor/playback_configuration/index.md b/docs/awscc-docs/providers/awscc/mediatailor/playback_configuration/index.md deleted file mode 100644 index 0d134e101a..0000000000 --- a/docs/awscc-docs/providers/awscc/mediatailor/playback_configuration/index.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the playback_configuration resource, the following permissions are required: - -### Read -```json -mediatailor:GetPlaybackConfiguration -``` - -### Update -```json -mediatailor:PutPlaybackConfiguration, -mediatailor:ConfigureLogsForPlaybackConfiguration, -iam:CreateServiceLinkedRole, -mediatailor:UntagResource, -mediatailor:TagResource -``` - -### Delete -```json -mediatailor:DeletePlaybackConfiguration -``` - diff --git a/docs/awscc-docs/providers/awscc/mediatailor/playback_configurations/index.md b/docs/awscc-docs/providers/awscc/mediatailor/playback_configurations/index.md deleted file mode 100644 index 1c5edac777..0000000000 --- a/docs/awscc-docs/providers/awscc/mediatailor/playback_configurations/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.mediatailor.playback_configurations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the playback_configurations resource, the following permissions are required: - -### Create -```json -mediatailor:PutPlaybackConfiguration, -mediatailor:ConfigureLogsForPlaybackConfiguration, -iam:CreateServiceLinkedRole, -mediatailor:UntagResource, -mediatailor:TagResource -``` - -### List -```json -mediatailor:ListPlaybackConfigurations -``` - diff --git a/docs/awscc-docs/providers/awscc/mediatailor/source_location/index.md b/docs/awscc-docs/providers/awscc/mediatailor/source_location/index.md deleted file mode 100644 index ae46a9a86a..0000000000 --- a/docs/awscc-docs/providers/awscc/mediatailor/source_location/index.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the source_location resource, the following permissions are required: - -### Read -```json -mediatailor:DescribeSourceLocation -``` - -### Update -```json -mediatailor:DescribeSourceLocation, -mediatailor:TagResource, -mediatailor:UntagResource, -mediatailor:UpdateSourceLocation, -secretsmanager:DescribeSecret, -secretsmanager:GetSecretValue, -kms:CreateGrant -``` - -### Delete -```json -mediatailor:DeleteSourceLocation, -mediatailor:DescribeSourceLocation -``` - diff --git a/docs/awscc-docs/providers/awscc/mediatailor/source_locations/index.md b/docs/awscc-docs/providers/awscc/mediatailor/source_locations/index.md deleted file mode 100644 index 1537ea1b83..0000000000 --- a/docs/awscc-docs/providers/awscc/mediatailor/source_locations/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -source_location_name -FROM awscc.mediatailor.source_locations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the source_locations resource, the following permissions are required: - -### Create -```json -mediatailor:CreateSourceLocation, -mediatailor:DescribeSourceLocation, -mediatailor:TagResource, -secretsmanager:DescribeSecret, -secretsmanager:GetSecretValue, -kms:CreateGrant -``` - -### List -```json -mediatailor:ListSourceLocations -``` - diff --git a/docs/awscc-docs/providers/awscc/mediatailor/vod_source/index.md b/docs/awscc-docs/providers/awscc/mediatailor/vod_source/index.md deleted file mode 100644 index 3ead1d1d8e..0000000000 --- a/docs/awscc-docs/providers/awscc/mediatailor/vod_source/index.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -http_package_configurations, -source_location_name, -tags, -vod_source_name -FROM awscc.mediatailor.vod_source -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the vod_source resource, the following permissions are required: - -### Read -```json -mediatailor:DescribeVodSource -``` - -### Update -```json -mediatailor:DescribeVodSource, -mediatailor:TagResource, -mediatailor:UntagResource, -mediatailor:UpdateVodSource -``` - -### Delete -```json -mediatailor:DeleteVodSource, -mediatailor:DescribeVodSource -``` - diff --git a/docs/awscc-docs/providers/awscc/mediatailor/vod_sources/index.md b/docs/awscc-docs/providers/awscc/mediatailor/vod_sources/index.md deleted file mode 100644 index 7e6bee903c..0000000000 --- a/docs/awscc-docs/providers/awscc/mediatailor/vod_sources/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -source_location_name, -vod_source_name -FROM awscc.mediatailor.vod_sources -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the vod_sources resource, the following permissions are required: - -### Create -```json -mediatailor:CreateVodSource, -mediatailor:DescribeVodSource, -mediatailor:TagResource -``` - -### List -```json -mediatailor:ListVodSources -``` - diff --git a/docs/awscc-docs/providers/awscc/memorydb/acl/index.md b/docs/awscc-docs/providers/awscc/memorydb/acl/index.md deleted file mode 100644 index 7b1cbb26ad..0000000000 --- a/docs/awscc-docs/providers/awscc/memorydb/acl/index.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -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".
acl_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. - -## Example -```sql -SELECT -region, -status, -acl_name, -user_names, -arn, -tags -FROM awscc.memorydb.acl -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the acl resource, the following permissions are required: - -### Read -```json -memorydb:DescribeACLs, -memorydb:ListTags -``` - -### Update -```json -memorydb:UpdateACL, -memorydb:DescribeACLs, -memorydb:ListTags, -memorydb:TagResource, -memorydb:UntagResource -``` - -### Delete -```json -memorydb:ModifyReplicationGroup, -memorydb:DeleteACL, -memorydb:DescribeACLs -``` - diff --git a/docs/awscc-docs/providers/awscc/memorydb/acls/index.md b/docs/awscc-docs/providers/awscc/memorydb/acls/index.md deleted file mode 100644 index 1baed0ed53..0000000000 --- a/docs/awscc-docs/providers/awscc/memorydb/acls/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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
acl_namestringThe name of the acl.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -acl_name -FROM awscc.memorydb.acls -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the acls resource, the following permissions are required: - -### Create -```json -memorydb:CreateACL, -memorydb:DescribeACLs, -memorydb:TagResource, -memorydb:ListTags -``` - -### List -```json -memorydb:DescribeACLs, -memorydb:ListTags -``` - diff --git a/docs/awscc-docs/providers/awscc/memorydb/cluster/index.md b/docs/awscc-docs/providers/awscc/memorydb/cluster/index.md deleted file mode 100644 index 65e0fbde6e..0000000000 --- a/docs/awscc-docs/providers/awscc/memorydb/cluster/index.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -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.
acl_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.
tls_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.
arnstringThe 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. - -## 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, -acl_name, -sns_topic_arn, -sns_topic_status, -tls_enabled, -data_tiering, -kms_key_id, -snapshot_arns, -snapshot_name, -final_snapshot_name, -arn, -engine_version, -cluster_endpoint, -auto_minor_version_upgrade, -tags -FROM awscc.memorydb.cluster -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the cluster resource, the following permissions are required: - -### Read -```json -memorydb:DescribeClusters, -memorydb:ListTags -``` - -### Update -```json -memorydb:UpdateCluster, -memorydb:DescribeClusters, -memorydb:ListTags, -memorydb:TagResource, -memorydb:UntagResource -``` - -### Delete -```json -memorydb:DeleteCluster, -memorydb:DescribeClusters -``` - diff --git a/docs/awscc-docs/providers/awscc/memorydb/clusters/index.md b/docs/awscc-docs/providers/awscc/memorydb/clusters/index.md deleted file mode 100644 index 712470d1eb..0000000000 --- a/docs/awscc-docs/providers/awscc/memorydb/clusters/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -cluster_name -FROM awscc.memorydb.clusters -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the clusters resource, the following permissions are required: - -### Create -```json -memorydb:CreateCluster, -memorydb:DescribeClusters, -memorydb:ListTags -``` - -### List -```json -memorydb:DescribeClusters -``` - diff --git a/docs/awscc-docs/providers/awscc/memorydb/index.md b/docs/awscc-docs/providers/awscc/memorydb/index.md deleted file mode 100644 index c16d7ef263..0000000000 --- a/docs/awscc-docs/providers/awscc/memorydb/index.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -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 deleted file mode 100644 index 65844db93d..0000000000 --- a/docs/awscc-docs/providers/awscc/memorydb/parameter_group/index.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -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.
arnstringThe Amazon Resource Name (ARN) of the parameter group.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -parameter_group_name, -family, -description, -tags, -parameters, -arn -FROM awscc.memorydb.parameter_group -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the parameter_group resource, the following permissions are required: - -### Read -```json -memorydb:DescribeParameterGroups, -memorydb:ListTags -``` - -### Update -```json -memorydb:UpdateParameterGroup, -memorydb:DescribeParameterGroups, -memorydb:DescribeParameters, -memorydb:DescribeClusters, -memorydb:ListTags, -memorydb:TagResource, -memorydb:UntagResource -``` - -### Delete -```json -memorydb:DeleteParameterGroup -``` - diff --git a/docs/awscc-docs/providers/awscc/memorydb/parameter_groups/index.md b/docs/awscc-docs/providers/awscc/memorydb/parameter_groups/index.md deleted file mode 100644 index c5645821d1..0000000000 --- a/docs/awscc-docs/providers/awscc/memorydb/parameter_groups/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -parameter_group_name -FROM awscc.memorydb.parameter_groups -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the parameter_groups resource, the following permissions are required: - -### Create -```json -memorydb:CreateParameterGroup, -memorydb:DescribeParameterGroups, -memorydb:TagResource, -memorydb:ListTags -``` - -### List -```json -memorydb:DescribeParameterGroups -``` - diff --git a/docs/awscc-docs/providers/awscc/memorydb/subnet_group/index.md b/docs/awscc-docs/providers/awscc/memorydb/subnet_group/index.md deleted file mode 100644 index 752783cee4..0000000000 --- a/docs/awscc-docs/providers/awscc/memorydb/subnet_group/index.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -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.
arnstringThe Amazon Resource Name (ARN) of the subnet group.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -subnet_group_name, -description, -subnet_ids, -tags, -arn -FROM awscc.memorydb.subnet_group -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the subnet_group resource, the following permissions are required: - -### Read -```json -memorydb:DescribeSubnetGroups, -memorydb:ListTags -``` - -### Update -```json -memorydb:UpdateSubnetGroup, -memorydb:DescribeSubnetGroups, -memorydb:ListTags, -memorydb:TagResource, -memorydb:UntagResource -``` - -### Delete -```json -memorydb:DeleteSubnetGroup, -memorydb:DescribeSubnetGroups -``` - diff --git a/docs/awscc-docs/providers/awscc/memorydb/subnet_groups/index.md b/docs/awscc-docs/providers/awscc/memorydb/subnet_groups/index.md deleted file mode 100644 index d72addc010..0000000000 --- a/docs/awscc-docs/providers/awscc/memorydb/subnet_groups/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -subnet_group_name -FROM awscc.memorydb.subnet_groups -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the subnet_groups resource, the following permissions are required: - -### Create -```json -memorydb:CreateSubnetGroup, -memorydb:DescribeSubnetGroups, -memorydb:TagResource, -memorydb:ListTags -``` - -### List -```json -memorydb:DescribeSubnetGroups -``` - diff --git a/docs/awscc-docs/providers/awscc/memorydb/user/index.md b/docs/awscc-docs/providers/awscc/memorydb/user/index.md deleted file mode 100644 index 7b7c8e6c97..0000000000 --- a/docs/awscc-docs/providers/awscc/memorydb/user/index.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -status, -user_name, -access_string, -authentication_mode, -arn, -tags -FROM awscc.memorydb.user -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the user resource, the following permissions are required: - -### Read -```json -memorydb:DescribeUsers, -memorydb:ListTags -``` - -### Update -```json -memorydb:UpdateUser, -memorydb:DescribeUsers, -memorydb:ListTags, -memorydb:TagResource, -memorydb:UntagResource -``` - -### Delete -```json -memorydb:DeleteUser, -memorydb:DescribeUsers -``` - diff --git a/docs/awscc-docs/providers/awscc/memorydb/users/index.md b/docs/awscc-docs/providers/awscc/memorydb/users/index.md deleted file mode 100644 index b12997c925..0000000000 --- a/docs/awscc-docs/providers/awscc/memorydb/users/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -user_name -FROM awscc.memorydb.users -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the users resource, the following permissions are required: - -### Create -```json -memorydb:CreateUser, -memorydb:DescribeUsers, -memorydb:TagResource, -memorydb:ListTags -``` - -### List -```json -memorydb:DescribeUsers, -memorydb:ListTags -``` - 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 deleted file mode 100644 index f4150880f6..0000000000 --- a/docs/awscc-docs/providers/awscc/msk/batch_scram_secret/index.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -cluster_arn, -secret_arn_list -FROM awscc.msk.batch_scram_secret -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the batch_scram_secret resource, the following permissions are required: - -### Delete -```json -kafka:BatchDisassociateScramSecret, -kafka:ListScramSecrets, -kms:CreateGrant, -kms:DescribeKey -``` - -### Read -```json -kafka:ListScramSecrets, -kms:CreateGrant, -kms:DescribeKey, -secretsmanager:GetSecretValue -``` - -### Update -```json -kafka:BatchAssociateScramSecret, -kafka:BatchDisassociateScramSecret, -kafka:ListScramSecrets, -kms:CreateGrant, -kms:DescribeKey, -secretsmanager:GetSecretValue -``` - 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 deleted file mode 100644 index c748981930..0000000000 --- a/docs/awscc-docs/providers/awscc/msk/batch_scram_secrets/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -cluster_arn -FROM awscc.msk.batch_scram_secrets -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the batch_scram_secrets resource, the following permissions are required: - -### Create -```json -kafka:BatchAssociateScramSecret, -kafka:ListScramSecrets, -kms:CreateGrant, -kms:DescribeKey, -secretsmanager:GetSecretValue -``` - -### List -```json -kafka:ListScramSecrets, -kms:CreateGrant, -kms:DescribeKey, -secretsmanager:GetSecretValue -``` - diff --git a/docs/awscc-docs/providers/awscc/msk/cluster/index.md b/docs/awscc-docs/providers/awscc/msk/cluster/index.md deleted file mode 100644 index 83d3e63f20..0000000000 --- a/docs/awscc-docs/providers/awscc/msk/cluster/index.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the cluster resource, the following permissions are required: - -### Update -```json -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 -```json -kafka:DeleteCluster, -kafka:DescribeCluster -``` - -### Read -```json -kafka:DescribeCluster -``` - diff --git a/docs/awscc-docs/providers/awscc/msk/cluster_policies/index.md b/docs/awscc-docs/providers/awscc/msk/cluster_policies/index.md deleted file mode 100644 index d4d0096183..0000000000 --- a/docs/awscc-docs/providers/awscc/msk/cluster_policies/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -cluster_arn -FROM awscc.msk.cluster_policies -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the cluster_policies resource, the following permissions are required: - -### Create -```json -kafka:PutClusterPolicy, -kafka:GetClusterPolicy -``` - -### List -```json -kafka:GetClusterPolicy -``` - diff --git a/docs/awscc-docs/providers/awscc/msk/cluster_policy/index.md b/docs/awscc-docs/providers/awscc/msk/cluster_policy/index.md deleted file mode 100644 index 1b1b3b709c..0000000000 --- a/docs/awscc-docs/providers/awscc/msk/cluster_policy/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -policy, -cluster_arn, -current_version -FROM awscc.msk.cluster_policy -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the cluster_policy resource, the following permissions are required: - -### Read -```json -kafka:GetClusterPolicy -``` - -### Update -```json -kafka:PutClusterPolicy, -kafka:GetClusterPolicy -``` - -### Delete -```json -kafka:DeleteClusterPolicy, -kafka:GetClusterPolicy -``` - diff --git a/docs/awscc-docs/providers/awscc/msk/clusters/index.md b/docs/awscc-docs/providers/awscc/msk/clusters/index.md deleted file mode 100644 index 9f47fb3ac6..0000000000 --- a/docs/awscc-docs/providers/awscc/msk/clusters/index.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.msk.clusters -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the clusters resource, the following permissions are required: - -### Create -```json -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 -```json -kafka:ListClusters -``` - diff --git a/docs/awscc-docs/providers/awscc/msk/configuration/index.md b/docs/awscc-docs/providers/awscc/msk/configuration/index.md deleted file mode 100644 index 795ec67a05..0000000000 --- a/docs/awscc-docs/providers/awscc/msk/configuration/index.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -description, -server_properties, -kafka_versions_list, -arn, -latest_revision -FROM awscc.msk.configuration -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the configuration resource, the following permissions are required: - -### Delete -```json -kafka:DeleteConfiguration, -kafka:DescribeConfiguration -``` - -### Read -```json -kafka:DescribeConfiguration -``` - -### Update -```json -kafka:UpdateConfiguration, -kafka:DescribeConfiguration -``` - diff --git a/docs/awscc-docs/providers/awscc/msk/configurations/index.md b/docs/awscc-docs/providers/awscc/msk/configurations/index.md deleted file mode 100644 index 3cb8d7df27..0000000000 --- a/docs/awscc-docs/providers/awscc/msk/configurations/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.msk.configurations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the configurations resource, the following permissions are required: - -### Create -```json -kafka:CreateConfiguration, -Kafka:DescribeConfiguration -``` - -### List -```json -kafka:ListConfigurations -``` - diff --git a/docs/awscc-docs/providers/awscc/msk/index.md b/docs/awscc-docs/providers/awscc/msk/index.md deleted file mode 100644 index 7d99ea874b..0000000000 --- a/docs/awscc-docs/providers/awscc/msk/index.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -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 deleted file mode 100644 index eec4d7b50e..0000000000 --- a/docs/awscc-docs/providers/awscc/msk/replicator/index.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the replicator resource, the following permissions are required: - -### Read -```json -kafka:DescribeReplicator, -kafka:ListTagsForResource -``` - -### Update -```json -kafka:DescribeReplicator, -kafka:ListTagsForResource, -kafka:TagResource, -kafka:UntagResource, -kafka:UpdateReplicationInfo -``` - -### Delete -```json -kafka:DeleteReplicator, -kafka:DescribeReplicator, -kafka:ListTagsForResource, -kafka:UntagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/msk/replicators/index.md b/docs/awscc-docs/providers/awscc/msk/replicators/index.md deleted file mode 100644 index d43f7153f2..0000000000 --- a/docs/awscc-docs/providers/awscc/msk/replicators/index.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -replicator_arn -FROM awscc.msk.replicators -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the replicators resource, the following permissions are required: - -### Create -```json -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 -```json -kafka:ListReplicators -``` - diff --git a/docs/awscc-docs/providers/awscc/msk/serverless_cluster/index.md b/docs/awscc-docs/providers/awscc/msk/serverless_cluster/index.md deleted file mode 100644 index c81f36df63..0000000000 --- a/docs/awscc-docs/providers/awscc/msk/serverless_cluster/index.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -cluster_name, -vpc_configs, -client_authentication, -tags -FROM awscc.msk.serverless_cluster -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the serverless_cluster resource, the following permissions are required: - -### Read -```json -kafka:DescribeClusterV2 -``` - -### Delete -```json -kafka:DeleteCluster, -kafka:DescribeClusterV2, -ec2:DeleteVpcEndpoints -``` - diff --git a/docs/awscc-docs/providers/awscc/msk/serverless_clusters/index.md b/docs/awscc-docs/providers/awscc/msk/serverless_clusters/index.md deleted file mode 100644 index 9c50d4164c..0000000000 --- a/docs/awscc-docs/providers/awscc/msk/serverless_clusters/index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.msk.serverless_clusters -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the serverless_clusters resource, the following permissions are required: - -### Create -```json -kafka:CreateClusterV2, -kafka:TagResource, -kafka:DescribeClusterV2, -ec2:CreateVpcEndpoint, -ec2:CreateTags, -ec2:DescribeVpcAttribute, -ec2:DescribeSubnets, -ec2:DescribeVpcEndpoints, -ec2:DescribeVpcs, -ec2:DescribeSecurityGroups -``` - -### List -```json -kafka:ListClustersV2 -``` - diff --git a/docs/awscc-docs/providers/awscc/msk/vpc_connection/index.md b/docs/awscc-docs/providers/awscc/msk/vpc_connection/index.md deleted file mode 100644 index 566cc6d977..0000000000 --- a/docs/awscc-docs/providers/awscc/msk/vpc_connection/index.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -authentication, -client_subnets, -target_cluster_arn, -security_groups, -tags, -vpc_id -FROM awscc.msk.vpc_connection -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the vpc_connection resource, the following permissions are required: - -### Read -```json -kafka:DescribeVpcConnection, -kms:CreateGrant, -kms:DescribeKey -``` - -### Update -```json -kafka:DescribeVpcConnection, -kms:CreateGrant, -kms:DescribeKey, -kafka:TagResource, -kafka:UntagResource -``` - -### Delete -```json -ec2:DeleteVpcEndpoint, -ec2:DeleteVpcEndpoints, -ec2:DescribeVpcEndpoints, -ec2:DescribeVpcEndpointConnections, -kafka:DeleteVpcConnection, -kafka:DescribeVpcConnection, -kms:CreateGrant, -kms:DescribeKey -``` - diff --git a/docs/awscc-docs/providers/awscc/msk/vpc_connections/index.md b/docs/awscc-docs/providers/awscc/msk/vpc_connections/index.md deleted file mode 100644 index 01120deeec..0000000000 --- a/docs/awscc-docs/providers/awscc/msk/vpc_connections/index.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.msk.vpc_connections -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the vpc_connections resource, the following permissions are required: - -### Create -```json -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 -```json -kafka:ListVpcConnections, -kms:CreateGrant, -kms:DescribeKey -``` - diff --git a/docs/awscc-docs/providers/awscc/mwaa/environment/index.md b/docs/awscc-docs/providers/awscc/mwaa/environment/index.md deleted file mode 100644 index 8b1da61e77..0000000000 --- a/docs/awscc-docs/providers/awscc/mwaa/environment/index.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the environment resource, the following permissions are required: - -### Read -```json -airflow:GetEnvironment -``` - -### Update -```json -airflow:UpdateEnvironment, -airflow:TagResource, -airflow:UntagResource -``` - -### Delete -```json -airflow:DeleteEnvironment -``` - diff --git a/docs/awscc-docs/providers/awscc/mwaa/environments/index.md b/docs/awscc-docs/providers/awscc/mwaa/environments/index.md deleted file mode 100644 index 16eb01c041..0000000000 --- a/docs/awscc-docs/providers/awscc/mwaa/environments/index.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.mwaa.environments -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the environments resource, the following permissions are required: - -### Create -```json -airflow:CreateEnvironment -``` - -### List -```json -airflow:ListEnvironments -``` - diff --git a/docs/awscc-docs/providers/awscc/mwaa/index.md b/docs/awscc-docs/providers/awscc/mwaa/index.md deleted file mode 100644 index 710143a5dd..0000000000 --- a/docs/awscc-docs/providers/awscc/mwaa/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 deleted file mode 100644 index 591980c971..0000000000 --- a/docs/awscc-docs/providers/awscc/neptune/db_cluster/index.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -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.
db_cluster_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.
db_cluster_parameter_group_namestringProvides the name of the DB cluster parameter group.
db_instance_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.
db_portintegerThe 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.
db_subnet_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. - -## Example -```sql -SELECT -region, -endpoint, -read_endpoint, -cluster_resource_id, -associated_roles, -availability_zones, -backup_retention_period, -copy_tags_to_snapshot, -db_cluster_identifier, -db_cluster_parameter_group_name, -db_instance_parameter_group_name, -db_port, -db_subnet_group_name, -deletion_protection, -enable_cloudwatch_logs_exports, -engine_version, -iam_auth_enabled, -kms_key_id, -port, -preferred_backup_window, -preferred_maintenance_window, -restore_to_time, -restore_type, -serverless_scaling_configuration, -snapshot_identifier, -source_db_cluster_identifier, -storage_encrypted, -tags, -use_latest_restorable_time, -vpc_security_group_ids -FROM awscc.neptune.db_cluster -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the db_cluster resource, the following permissions are required: - -### Read -```json -rds:DescribeDBClusters, -rds:ListTagsForResource, -kms:* -``` - -### Update -```json -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 -```json -rds:DeleteDBCluster, -rds:DeleteDBInstance, -rds:DescribeDBClusters, -rds:DescribeGlobalClusters, -rds:ListTagsForResource, -rds:RemoveFromGlobalCluster, -rds:CreateDBClusterSnapshot, -kms:* -``` - diff --git a/docs/awscc-docs/providers/awscc/neptune/db_clusters/index.md b/docs/awscc-docs/providers/awscc/neptune/db_clusters/index.md deleted file mode 100644 index 1c39305ae3..0000000000 --- a/docs/awscc-docs/providers/awscc/neptune/db_clusters/index.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -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
db_cluster_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. - -## Example -```sql -SELECT -region, -db_cluster_identifier -FROM awscc.neptune.db_clusters -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the db_clusters resource, the following permissions are required: - -### Create -```json -iam:PassRole, -rds:AddRoleToDBCluster, -rds:AddTagsToResource, -rds:CreateDBCluster, -rds:CreateDBInstance, -rds:DescribeDBClusters, -rds:ListTagsForResource, -rds:ModifyDBCluster, -rds:RestoreDBClusterFromSnapshot, -rds:RestoreDBClusterToPointInTime, -kms:* -``` - -### List -```json -rds:DescribeDBClusters, -rds:ListTagsForResource, -kms:* -``` - diff --git a/docs/awscc-docs/providers/awscc/neptune/index.md b/docs/awscc-docs/providers/awscc/neptune/index.md deleted file mode 100644 index e199f8d5ce..0000000000 --- a/docs/awscc-docs/providers/awscc/neptune/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 deleted file mode 100644 index 9f9af950a5..0000000000 --- a/docs/awscc-docs/providers/awscc/neptunegraph/graph/index.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the graph resource, the following permissions are required: - -### Read -```json -neptune-graph:GetGraph, -neptune-graph:ListTagsForResource, -kms:DescribeKey, -kms:CreateGrant, -kms:Decrypt -``` - -### Update -```json -iam:PassRole, -neptune-graph:GetGraph, -neptune-graph:ListTagsForResource, -neptune-graph:TagResource, -neptune-graph:UntagResource, -neptune-graph:UpdateGraph, -kms:DescribeKey, -kms:CreateGrant, -kms:Decrypt -``` - -### Delete -```json -neptune-graph:DeleteGraph, -neptune-graph:GetGraph, -kms:DescribeKey, -kms:CreateGrant, -kms:Decrypt -``` - diff --git a/docs/awscc-docs/providers/awscc/neptunegraph/graphs/index.md b/docs/awscc-docs/providers/awscc/neptunegraph/graphs/index.md deleted file mode 100644 index 93284ace92..0000000000 --- a/docs/awscc-docs/providers/awscc/neptunegraph/graphs/index.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -graph_id -FROM awscc.neptunegraph.graphs -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the graphs resource, the following permissions are required: - -### Create -```json -iam:PassRole, -neptune-graph:CreateGraph, -neptune-graph:GetGraph, -neptune-graph:ListTagsForResource, -neptune-graph:TagResource, -kms:DescribeKey, -kms:CreateGrant, -kms:Decrypt, -iam:CreateServiceLinkedRole -``` - -### List -```json -neptune-graph:GetGraph, -neptune-graph:ListGraphs, -kms:DescribeKey, -kms:CreateGrant, -kms:Decrypt -``` - diff --git a/docs/awscc-docs/providers/awscc/neptunegraph/index.md b/docs/awscc-docs/providers/awscc/neptunegraph/index.md deleted file mode 100644 index 9ed44e773d..0000000000 --- a/docs/awscc-docs/providers/awscc/neptunegraph/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index 9116a72718..0000000000 --- a/docs/awscc-docs/providers/awscc/neptunegraph/private_graph_endpoint/index.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the private_graph_endpoint resource, the following permissions are required: - -### Read -```json -neptune-graph:GetPrivateGraphEndpoint -``` - -### Update -```json -iam:PassRole, -neptune-graph:GetPrivateGraphEndpoint -``` - -### Delete -```json -ec2:DeleteVpcEndpoints, -ec2:DescribeVpcEndpoints, -ec2:DescribeSecurityGroups, -ec2:DescribeSubnets, -ec2:DescribeVpcs, -ec2:DescribeVpcAttribute, -ec2:DescribeAvailabilityZones, -ec2:ModifyVpcEndpoint, -route53:DisassociateVPCFromHostedZone, -neptune-graph:DeletePrivateGraphEndpoint, -neptune-graph:GetPrivateGraphEndpoint -``` - 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 deleted file mode 100644 index a083d636bc..0000000000 --- a/docs/awscc-docs/providers/awscc/neptunegraph/private_graph_endpoints/index.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -private_graph_endpoint_identifier -FROM awscc.neptunegraph.private_graph_endpoints -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the private_graph_endpoints resource, the following permissions are required: - -### Create -```json -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 -```json -neptune-graph:GetPrivateGraphEndpoint, -neptune-graph:ListPrivateGraphEndpoints -``` - diff --git a/docs/awscc-docs/providers/awscc/networkfirewall/firewall/index.md b/docs/awscc-docs/providers/awscc/networkfirewall/firewall/index.md deleted file mode 100644 index 957da62d48..0000000000 --- a/docs/awscc-docs/providers/awscc/networkfirewall/firewall/index.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the firewall resource, the following permissions are required: - -### Read -```json -network-firewall:DescribeFirewall, -network-firewall:ListTagsForResources -``` - -### Update -```json -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 -```json -ec2:DeleteVpcEndpoints, -ec2:DescribeRouteTables, -logs:DescribeLogGroups, -logs:DescribeResourcePolicies, -logs:GetLogDelivery, -logs:ListLogDeliveries, -network-firewall:DeleteFirewall, -network-firewall:UntagResource, -network-firewall:DescribeFirewall -``` - diff --git a/docs/awscc-docs/providers/awscc/networkfirewall/firewall_policies/index.md b/docs/awscc-docs/providers/awscc/networkfirewall/firewall_policies/index.md deleted file mode 100644 index ff085a5f93..0000000000 --- a/docs/awscc-docs/providers/awscc/networkfirewall/firewall_policies/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -firewall_policy_arn -FROM awscc.networkfirewall.firewall_policies -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the firewall_policies resource, the following permissions are required: - -### Create -```json -network-firewall:CreateFirewallPolicy, -network-firewall:DescribeFirewallPolicy, -network-firewall:ListTLSInspectionConfigurations, -network-firewall:TagResource, -network-firewall:ListRuleGroups -``` - -### List -```json -network-firewall:ListFirewallPolicies -``` - diff --git a/docs/awscc-docs/providers/awscc/networkfirewall/firewall_policy/index.md b/docs/awscc-docs/providers/awscc/networkfirewall/firewall_policy/index.md deleted file mode 100644 index 6db034091d..0000000000 --- a/docs/awscc-docs/providers/awscc/networkfirewall/firewall_policy/index.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -firewall_policy_name, -firewall_policy_arn, -firewall_policy, -firewall_policy_id, -description, -tags -FROM awscc.networkfirewall.firewall_policy -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the firewall_policy resource, the following permissions are required: - -### Read -```json -network-firewall:DescribeFirewallPolicy, -network-firewall:ListTagsForResources -``` - -### Update -```json -network-firewall:UpdateFirewallPolicy, -network-firewall:DescribeFirewallPolicy, -network-firewall:TagResource, -network-firewall:UntagResource, -network-firewall:ListRuleGroups, -network-firewall:ListTLSInspectionConfigurations -``` - -### Delete -```json -network-firewall:DeleteFirewallPolicy, -network-firewall:DescribeFirewallPolicy, -network-firewall:UntagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/networkfirewall/firewalls/index.md b/docs/awscc-docs/providers/awscc/networkfirewall/firewalls/index.md deleted file mode 100644 index cbab2db7ca..0000000000 --- a/docs/awscc-docs/providers/awscc/networkfirewall/firewalls/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -firewall_arn -FROM awscc.networkfirewall.firewalls -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the firewalls resource, the following permissions are required: - -### Create -```json -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 -```json -network-firewall:ListFirewalls -``` - diff --git a/docs/awscc-docs/providers/awscc/networkfirewall/index.md b/docs/awscc-docs/providers/awscc/networkfirewall/index.md deleted file mode 100644 index 3422f4e2cc..0000000000 --- a/docs/awscc-docs/providers/awscc/networkfirewall/index.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -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 deleted file mode 100644 index dd208af9d9..0000000000 --- a/docs/awscc-docs/providers/awscc/networkfirewall/logging_configuration/index.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -firewall_name, -firewall_arn, -logging_configuration -FROM awscc.networkfirewall.logging_configuration -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the logging_configuration resource, the following permissions are required: - -### Read -```json -logs:GetLogDelivery, -logs:ListLogDeliveries, -network-firewall:DescribeLoggingConfiguration -``` - -### Update -```json -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 -```json -logs:DeleteLogDelivery, -logs:ListLogDeliveries, -logs:GetLogDelivery, -network-firewall:UpdateLoggingConfiguration, -network-firewall:DescribeLoggingConfiguration -``` - diff --git a/docs/awscc-docs/providers/awscc/networkfirewall/logging_configurations/index.md b/docs/awscc-docs/providers/awscc/networkfirewall/logging_configurations/index.md deleted file mode 100644 index 4beb882c15..0000000000 --- a/docs/awscc-docs/providers/awscc/networkfirewall/logging_configurations/index.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -firewall_arn -FROM awscc.networkfirewall.logging_configurations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the logging_configurations resource, the following permissions are required: - -### Create -```json -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 -```json -logs:GetLogDelivery, -logs:ListLogDeliveries, -network-firewall:DescribeLoggingConfiguration -``` - diff --git a/docs/awscc-docs/providers/awscc/networkfirewall/rule_group/index.md b/docs/awscc-docs/providers/awscc/networkfirewall/rule_group/index.md deleted file mode 100644 index 6066fcd0b3..0000000000 --- a/docs/awscc-docs/providers/awscc/networkfirewall/rule_group/index.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the rule_group resource, the following permissions are required: - -### Read -```json -network-firewall:DescribeRuleGroup, -network-firewall:ListTagsForResources -``` - -### Update -```json -network-firewall:UpdateRuleGroup, -network-firewall:DescribeRuleGroup, -network-firewall:TagResource, -network-firewall:UntagResource, -iam:CreateServiceLinkedRole, -ec2:GetManagedPrefixListEntries -``` - -### Delete -```json -network-firewall:DeleteRuleGroup, -network-firewall:DescribeRuleGroup, -network-firewall:UntagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/networkfirewall/rule_groups/index.md b/docs/awscc-docs/providers/awscc/networkfirewall/rule_groups/index.md deleted file mode 100644 index 2223b06fb0..0000000000 --- a/docs/awscc-docs/providers/awscc/networkfirewall/rule_groups/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -rule_group_arn -FROM awscc.networkfirewall.rule_groups -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the rule_groups resource, the following permissions are required: - -### Create -```json -network-firewall:CreateRuleGroup, -network-firewall:DescribeRuleGroup, -network-firewall:TagResource, -network-firewall:ListRuleGroups, -iam:CreateServiceLinkedRole, -ec2:GetManagedPrefixListEntries -``` - -### List -```json -network-firewall:ListRuleGroups -``` - 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 deleted file mode 100644 index 2dfb3a46e2..0000000000 --- a/docs/awscc-docs/providers/awscc/networkfirewall/tls_inspection_configuration/index.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -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
tls_inspection_configuration_namestring
tls_inspection_configuration_arnstring
tls_inspection_configurationobject
tls_inspection_configuration_idstring
descriptionstring
tagsarray
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -tls_inspection_configuration_name, -tls_inspection_configuration_arn, -tls_inspection_configuration, -tls_inspection_configuration_id, -description, -tags -FROM awscc.networkfirewall.tls_inspection_configuration -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the tls_inspection_configuration resource, the following permissions are required: - -### Read -```json -network-firewall:DescribeTLSInspectionConfiguration, -network-firewall:ListTagsForResources -``` - -### Update -```json -network-firewall:UpdateTLSInspectionConfiguration, -network-firewall:DescribeTLSInspectionConfiguration, -network-firewall:TagResource, -network-firewall:UntagResource -``` - -### Delete -```json -network-firewall:DeleteTLSInspectionConfiguration, -network-firewall:DescribeTLSInspectionConfiguration, -network-firewall:UntagResource -``` - 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 deleted file mode 100644 index 31cc4e05c6..0000000000 --- a/docs/awscc-docs/providers/awscc/networkfirewall/tls_inspection_configurations/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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
tls_inspection_configuration_arnundefined
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -tls_inspection_configuration_arn -FROM awscc.networkfirewall.tls_inspection_configurations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the tls_inspection_configurations resource, the following permissions are required: - -### Create -```json -network-firewall:CreateTLSInspectionConfiguration, -network-firewall:DescribeTLSInspectionConfiguration, -network-firewall:TagResource -``` - -### List -```json -network-firewall:ListTLSInspectionConfigurations -``` - diff --git a/docs/awscc-docs/providers/awscc/networkmanager/connect_attachment/index.md b/docs/awscc-docs/providers/awscc/networkmanager/connect_attachment/index.md deleted file mode 100644 index 9b26542743..0000000000 --- a/docs/awscc-docs/providers/awscc/networkmanager/connect_attachment/index.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the connect_attachment resource, the following permissions are required: - -### Read -```json -networkmanager:GetConnectAttachment -``` - -### Update -```json -networkmanager:GetConnectAttachment, -networkmanager:ListTagsForResource, -networkmanager:TagResource, -networkmanager:UntagResource, -ec2:DescribeRegions -``` - -### Delete -```json -networkmanager:GetConnectAttachment, -networkmanager:DeleteAttachment, -ec2:DescribeRegions -``` - diff --git a/docs/awscc-docs/providers/awscc/networkmanager/connect_attachments/index.md b/docs/awscc-docs/providers/awscc/networkmanager/connect_attachments/index.md deleted file mode 100644 index eeb1f7daad..0000000000 --- a/docs/awscc-docs/providers/awscc/networkmanager/connect_attachments/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -attachment_id -FROM awscc.networkmanager.connect_attachments -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the connect_attachments resource, the following permissions are required: - -### Create -```json -networkmanager:GetConnectAttachment, -networkmanager:CreateConnectAttachment, -networkmanager:TagResource, -ec2:DescribeRegions -``` - -### List -```json -networkmanager:ListAttachments -``` - diff --git a/docs/awscc-docs/providers/awscc/networkmanager/connect_peer/index.md b/docs/awscc-docs/providers/awscc/networkmanager/connect_peer/index.md deleted file mode 100644 index 8cac9ece54..0000000000 --- a/docs/awscc-docs/providers/awscc/networkmanager/connect_peer/index.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the connect_peer resource, the following permissions are required: - -### Read -```json -networkmanager:GetConnectPeer -``` - -### Update -```json -networkmanager:GetConnectPeer, -networkmanager:ListTagsForResource, -networkmanager:TagResource, -networkmanager:UntagResource, -ec2:DescribeRegions -``` - -### Delete -```json -networkmanager:GetConnectPeer, -networkmanager:DeleteConnectPeer, -ec2:DescribeRegions -``` - diff --git a/docs/awscc-docs/providers/awscc/networkmanager/connect_peers/index.md b/docs/awscc-docs/providers/awscc/networkmanager/connect_peers/index.md deleted file mode 100644 index 97a061bcbe..0000000000 --- a/docs/awscc-docs/providers/awscc/networkmanager/connect_peers/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -connect_peer_id -FROM awscc.networkmanager.connect_peers -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the connect_peers resource, the following permissions are required: - -### Create -```json -networkmanager:GetConnectPeer, -networkmanager:CreateConnectPeer, -networkmanager:TagResource, -ec2:DescribeRegions -``` - -### List -```json -networkmanager:ListConnectPeers -``` - diff --git a/docs/awscc-docs/providers/awscc/networkmanager/core_network/index.md b/docs/awscc-docs/providers/awscc/networkmanager/core_network/index.md deleted file mode 100644 index 281706332b..0000000000 --- a/docs/awscc-docs/providers/awscc/networkmanager/core_network/index.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the core_network resource, the following permissions are required: - -### Read -```json -networkmanager:GetCoreNetwork, -networkmanager:GetCoreNetworkPolicy -``` - -### Update -```json -networkmanager:UpdateCoreNetwork, -networkmanager:GetCoreNetwork, -networkmanager:ListTagsForResource, -networkmanager:PutCoreNetworkPolicy, -networkmanager:GetCoreNetworkPolicy, -networkmanager:ExecuteCoreNetworkChangeSet, -networkmanager:TagResource, -networkmanager:UntagResource, -ec2:DescribeRegions -``` - -### Delete -```json -networkmanager:DeleteCoreNetwork, -networkmanager:UntagResource, -networkmanager:GetCoreNetwork, -networkmanager:GetCoreNetworkPolicy, -ec2:DescribeRegions -``` - diff --git a/docs/awscc-docs/providers/awscc/networkmanager/core_networks/index.md b/docs/awscc-docs/providers/awscc/networkmanager/core_networks/index.md deleted file mode 100644 index e2da2bde15..0000000000 --- a/docs/awscc-docs/providers/awscc/networkmanager/core_networks/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -core_network_id -FROM awscc.networkmanager.core_networks -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the core_networks resource, the following permissions are required: - -### Create -```json -networkmanager:CreateCoreNetwork, -networkmanager:GetCoreNetwork, -networkmanager:GetCoreNetworkPolicy, -networkmanager:TagResource, -ec2:DescribeRegions -``` - -### List -```json -networkmanager:ListCoreNetworks -``` - 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 deleted file mode 100644 index 328ea432dd..0000000000 --- a/docs/awscc-docs/providers/awscc/networkmanager/customer_gateway_association/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -global_network_id, -customer_gateway_arn, -device_id, -link_id -FROM awscc.networkmanager.customer_gateway_association -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the customer_gateway_association resource, the following permissions are required: - -### Read -```json -networkmanager:GetCustomerGatewayAssociations -``` - -### Delete -```json -networkmanager:DisassociateCustomerGateway -``` - 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 deleted file mode 100644 index 6fddab0da3..0000000000 --- a/docs/awscc-docs/providers/awscc/networkmanager/customer_gateway_associations/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -global_network_id, -customer_gateway_arn -FROM awscc.networkmanager.customer_gateway_associations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the customer_gateway_associations resource, the following permissions are required: - -### Create -```json -networkmanager:GetCustomerGatewayAssociations, -networkmanager:AssociateCustomerGateway -``` - -### List -```json -networkmanager:GetCustomerGatewayAssociations -``` - diff --git a/docs/awscc-docs/providers/awscc/networkmanager/device/index.md b/docs/awscc-docs/providers/awscc/networkmanager/device/index.md deleted file mode 100644 index a3ef3cccef..0000000000 --- a/docs/awscc-docs/providers/awscc/networkmanager/device/index.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -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.
aws_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. - -## Example -```sql -SELECT -region, -device_arn, -device_id, -description, -tags, -global_network_id, -aws_location, -location, -model, -serial_number, -site_id, -type, -vendor, -created_at, -state -FROM awscc.networkmanager.device -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the device resource, the following permissions are required: - -### Read -```json -networkmanager:GetDevices -``` - -### Update -```json -networkmanager:UpdateDevice, -networkmanager:ListTagsForResource, -networkmanager:GetDevices, -networkmanager:TagResource, -networkmanager:UntagResource -``` - -### Delete -```json -networkmanager:GetDevices, -networkmanager:DeleteDevice -``` - diff --git a/docs/awscc-docs/providers/awscc/networkmanager/devices/index.md b/docs/awscc-docs/providers/awscc/networkmanager/devices/index.md deleted file mode 100644 index 443262393c..0000000000 --- a/docs/awscc-docs/providers/awscc/networkmanager/devices/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -global_network_id, -device_id -FROM awscc.networkmanager.devices -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the devices resource, the following permissions are required: - -### Create -```json -networkmanager:CreateDevice, -networkmanager:GetDevices, -networkmanager:TagResource -``` - -### List -```json -networkmanager:GetDevices -``` - diff --git a/docs/awscc-docs/providers/awscc/networkmanager/global_network/index.md b/docs/awscc-docs/providers/awscc/networkmanager/global_network/index.md deleted file mode 100644 index 8eefbe3868..0000000000 --- a/docs/awscc-docs/providers/awscc/networkmanager/global_network/index.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -id, -description, -tags, -created_at, -state -FROM awscc.networkmanager.global_network -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the global_network resource, the following permissions are required: - -### Read -```json -networkmanager:DescribeGlobalNetworks -``` - -### Update -```json -networkmanager:UpdateGlobalNetwork, -networkmanager:DescribeGlobalNetworks, -networkmanager:TagResource, -networkmanager:UntagResource, -networkmanager:ListTagsForResource -``` - -### Delete -```json -networkmanager:DeleteGlobalNetwork, -networkmanager:DescribeGlobalNetworks -``` - diff --git a/docs/awscc-docs/providers/awscc/networkmanager/global_networks/index.md b/docs/awscc-docs/providers/awscc/networkmanager/global_networks/index.md deleted file mode 100644 index 5a8a820d94..0000000000 --- a/docs/awscc-docs/providers/awscc/networkmanager/global_networks/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.networkmanager.global_networks -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the global_networks resource, the following permissions are required: - -### Create -```json -networkmanager:CreateGlobalNetwork, -networkmanager:DescribeGlobalNetworks, -networkmanager:TagResource, -iam:CreateServiceLinkedRole -``` - -### List -```json -networkmanager:DescribeGlobalNetworks -``` - diff --git a/docs/awscc-docs/providers/awscc/networkmanager/index.md b/docs/awscc-docs/providers/awscc/networkmanager/index.md deleted file mode 100644 index 786dcfca9f..0000000000 --- a/docs/awscc-docs/providers/awscc/networkmanager/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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 deleted file mode 100644 index 8b0df05673..0000000000 --- a/docs/awscc-docs/providers/awscc/networkmanager/link/index.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the link resource, the following permissions are required: - -### Read -```json -networkmanager:GetLinks -``` - -### Update -```json -networkmanager:ListTagsForResource, -networkmanager:TagResource, -networkmanager:GetLinks, -networkmanager:UntagResource, -networkmanager:UpdateLink -``` - -### Delete -```json -networkmanager:GetLinks, -networkmanager:DeleteLink -``` - diff --git a/docs/awscc-docs/providers/awscc/networkmanager/link_association/index.md b/docs/awscc-docs/providers/awscc/networkmanager/link_association/index.md deleted file mode 100644 index 8d02660e56..0000000000 --- a/docs/awscc-docs/providers/awscc/networkmanager/link_association/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -global_network_id, -device_id, -link_id -FROM awscc.networkmanager.link_association -WHERE data__Identifier = '||'; -``` - -## Permissions - -To operate on the link_association resource, the following permissions are required: - -### Read -```json -networkmanager:GetLinkAssociations -``` - -### Delete -```json -networkmanager:DisassociateLink -``` - diff --git a/docs/awscc-docs/providers/awscc/networkmanager/link_associations/index.md b/docs/awscc-docs/providers/awscc/networkmanager/link_associations/index.md deleted file mode 100644 index 60fa8e3128..0000000000 --- a/docs/awscc-docs/providers/awscc/networkmanager/link_associations/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -global_network_id, -device_id, -link_id -FROM awscc.networkmanager.link_associations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the link_associations resource, the following permissions are required: - -### Create -```json -networkmanager:GetLinkAssociations, -networkmanager:AssociateLink -``` - -### List -```json -networkmanager:GetLinkAssociations -``` - diff --git a/docs/awscc-docs/providers/awscc/networkmanager/links/index.md b/docs/awscc-docs/providers/awscc/networkmanager/links/index.md deleted file mode 100644 index 5a6630009d..0000000000 --- a/docs/awscc-docs/providers/awscc/networkmanager/links/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -global_network_id, -link_id -FROM awscc.networkmanager.links -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the links resource, the following permissions are required: - -### Create -```json -networkmanager:CreateLink, -networkmanager:GetLinks, -networkmanager:TagResource -``` - -### List -```json -networkmanager:GetLinks -``` - diff --git a/docs/awscc-docs/providers/awscc/networkmanager/site/index.md b/docs/awscc-docs/providers/awscc/networkmanager/site/index.md deleted file mode 100644 index d4cec8a5fe..0000000000 --- a/docs/awscc-docs/providers/awscc/networkmanager/site/index.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -site_arn, -site_id, -description, -tags, -global_network_id, -location, -created_at, -state -FROM awscc.networkmanager.site -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the site resource, the following permissions are required: - -### Read -```json -networkmanager:GetSites -``` - -### Update -```json -networkmanager:GetSites, -networkmanager:ListTagsForResource, -networkmanager:TagResource, -networkmanager:UntagResource, -networkmanager:UpdateSite -``` - -### Delete -```json -networkmanager:GetSites, -networkmanager:DeleteSite -``` - 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 deleted file mode 100644 index 216baad053..0000000000 --- a/docs/awscc-docs/providers/awscc/networkmanager/site_to_site_vpn_attachment/index.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the site_to_site_vpn_attachment resource, the following permissions are required: - -### Read -```json -networkmanager:GetSiteToSiteVpnAttachment -``` - -### Update -```json -networkmanager:GetSiteToSiteVpnAttachment, -networkmanager:ListTagsForResource, -networkmanager:TagResource, -networkmanager:UntagResource, -ec2:DescribeRegions -``` - -### Delete -```json -networkmanager:GetSiteToSiteVpnAttachment, -networkmanager:DeleteAttachment, -ec2:DescribeRegions -``` - 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 deleted file mode 100644 index ce15638e0c..0000000000 --- a/docs/awscc-docs/providers/awscc/networkmanager/site_to_site_vpn_attachments/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -attachment_id -FROM awscc.networkmanager.site_to_site_vpn_attachments -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the site_to_site_vpn_attachments resource, the following permissions are required: - -### Create -```json -networkmanager:GetSiteToSiteVpnAttachment, -networkmanager:CreateSiteToSiteVpnAttachment, -ec2:DescribeRegions, -networkmanager:TagResource -``` - -### List -```json -networkmanager:ListAttachments -``` - diff --git a/docs/awscc-docs/providers/awscc/networkmanager/sites/index.md b/docs/awscc-docs/providers/awscc/networkmanager/sites/index.md deleted file mode 100644 index 32c5316516..0000000000 --- a/docs/awscc-docs/providers/awscc/networkmanager/sites/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -global_network_id, -site_id -FROM awscc.networkmanager.sites -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the sites resource, the following permissions are required: - -### Create -```json -networkmanager:CreateSite, -networkmanager:GetSites, -networkmanager:TagResource -``` - -### List -```json -networkmanager:GetSites -``` - 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 deleted file mode 100644 index d33eb70fc7..0000000000 --- a/docs/awscc-docs/providers/awscc/networkmanager/transit_gateway_peering/index.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the transit_gateway_peering resource, the following permissions are required: - -### Read -```json -networkmanager:GetTransitGatewayPeering, -networkmanager:TagResource -``` - -### Update -```json -networkmanager:TagResource, -networkmanager:UntagResource, -networkmanager:ListTagsForResource, -networkmanager:GetTransitGatewayPeering, -ec2:DescribeRegions -``` - -### Delete -```json -networkmanager:DeletePeering, -networkmanager:GetTransitGatewayPeering, -ec2:DescribeRegions -``` - 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 deleted file mode 100644 index eb4d376545..0000000000 --- a/docs/awscc-docs/providers/awscc/networkmanager/transit_gateway_peerings/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -peering_id -FROM awscc.networkmanager.transit_gateway_peerings -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the transit_gateway_peerings resource, the following permissions are required: - -### Create -```json -networkmanager:CreateTransitGatewayPeering, -networkmanager:TagResource, -networkmanager:GetTransitGatewayPeering, -iam:CreateServiceLinkedRole, -ec2:CreateTransitGatewayPeeringAttachment, -ec2:AcceptTransitGatewayPeeringAttachment, -ec2:DescribeRegions -``` - -### List -```json -networkmanager:ListPeerings -``` - 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 deleted file mode 100644 index 14128e4a49..0000000000 --- a/docs/awscc-docs/providers/awscc/networkmanager/transit_gateway_registration/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -global_network_id, -transit_gateway_arn -FROM awscc.networkmanager.transit_gateway_registration -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the transit_gateway_registration resource, the following permissions are required: - -### Read -```json -networkmanager:GetTransitGatewayRegistrations -``` - -### Delete -```json -networkmanager:DeregisterTransitGateway, -networkmanager:GetTransitGatewayRegistrations -``` - 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 deleted file mode 100644 index 406bb300b1..0000000000 --- a/docs/awscc-docs/providers/awscc/networkmanager/transit_gateway_registrations/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -global_network_id, -transit_gateway_arn -FROM awscc.networkmanager.transit_gateway_registrations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the transit_gateway_registrations resource, the following permissions are required: - -### Create -```json -networkmanager:RegisterTransitGateway, -networkmanager:GetTransitGatewayRegistrations -``` - -### List -```json -networkmanager:GetTransitGatewayRegistrations -``` - 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 deleted file mode 100644 index 9d11b8ed96..0000000000 --- a/docs/awscc-docs/providers/awscc/networkmanager/transit_gateway_route_table_attachment/index.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the transit_gateway_route_table_attachment resource, the following permissions are required: - -### Read -```json -networkmanager:GetTransitGatewayRouteTableAttachment -``` - -### Update -```json -networkmanager:GetTransitGatewayRouteTableAttachment, -networkmanager:ListTagsForResource, -networkmanager:TagResource, -networkmanager:UntagResource, -ec2:DescribeRegions -``` - -### Delete -```json -networkmanager:GetTransitGatewayRouteTableAttachment, -networkmanager:DeleteAttachment, -ec2:DescribeRegions -``` - 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 deleted file mode 100644 index 520df81365..0000000000 --- a/docs/awscc-docs/providers/awscc/networkmanager/transit_gateway_route_table_attachments/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -attachment_id -FROM awscc.networkmanager.transit_gateway_route_table_attachments -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the transit_gateway_route_table_attachments resource, the following permissions are required: - -### Create -```json -networkmanager:CreateTransitGatewayRouteTableAttachment, -networkmanager:GetTransitGatewayRouteTableAttachment, -networkmanager:TagResource, -iam:CreateServiceLinkedRole, -ec2:DescribeRegions -``` - -### List -```json -networkmanager:ListAttachments -``` - diff --git a/docs/awscc-docs/providers/awscc/networkmanager/vpc_attachment/index.md b/docs/awscc-docs/providers/awscc/networkmanager/vpc_attachment/index.md deleted file mode 100644 index 0e0410d195..0000000000 --- a/docs/awscc-docs/providers/awscc/networkmanager/vpc_attachment/index.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the vpc_attachment resource, the following permissions are required: - -### Read -```json -networkmanager:GetVpcAttachment -``` - -### Update -```json -networkmanager:UpdateVpcAttachment, -networkmanager:GetVpcAttachment, -networkmanager:ListTagsForResource, -networkmanager:TagResource, -networkmanager:UntagResource, -ec2:DescribeRegions -``` - -### Delete -```json -networkmanager:DeleteAttachment, -networkmanager:GetVpcAttachment, -networkmanager:UntagResource, -ec2:DescribeRegions -``` - diff --git a/docs/awscc-docs/providers/awscc/networkmanager/vpc_attachments/index.md b/docs/awscc-docs/providers/awscc/networkmanager/vpc_attachments/index.md deleted file mode 100644 index 74195ab70f..0000000000 --- a/docs/awscc-docs/providers/awscc/networkmanager/vpc_attachments/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -attachment_id -FROM awscc.networkmanager.vpc_attachments -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the vpc_attachments resource, the following permissions are required: - -### Create -```json -networkmanager:CreateVpcAttachment, -networkmanager:GetVpcAttachment, -networkmanager:TagResource, -ec2:DescribeRegions, -iam:CreateServiceLinkedRole -``` - -### List -```json -networkmanager:ListAttachments -``` - diff --git a/docs/awscc-docs/providers/awscc/nimblestudio/index.md b/docs/awscc-docs/providers/awscc/nimblestudio/index.md deleted file mode 100644 index 4818418bf3..0000000000 --- a/docs/awscc-docs/providers/awscc/nimblestudio/index.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -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 deleted file mode 100644 index b5ea50667f..0000000000 --- a/docs/awscc-docs/providers/awscc/nimblestudio/launch_profile/index.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the launch_profile resource, the following permissions are required: - -### Read -```json -nimble:GetLaunchProfile -``` - -### Update -```json -nimble:UpdateLaunchProfile, -nimble:GetLaunchProfile, -ec2:CreateNetworkInterface, -ec2:CreateNetworkInterfacePermission, -ec2:DescribeSubnets, -ec2:RunInstances -``` - -### Delete -```json -nimble:DeleteLaunchProfile, -nimble:GetLaunchProfile, -nimble:UntagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/nimblestudio/launch_profiles/index.md b/docs/awscc-docs/providers/awscc/nimblestudio/launch_profiles/index.md deleted file mode 100644 index 7f9c7faa0e..0000000000 --- a/docs/awscc-docs/providers/awscc/nimblestudio/launch_profiles/index.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -launch_profile_id, -studio_id -FROM awscc.nimblestudio.launch_profiles -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the launch_profiles resource, the following permissions are required: - -### Create -```json -nimble:CreateLaunchProfile, -nimble:GetLaunchProfile, -nimble:TagResource, -ec2:CreateNetworkInterface, -ec2:CreateNetworkInterfacePermission, -ec2:RunInstances, -ec2:DescribeSubnets -``` - -### List -```json -nimble:ListLaunchProfiles -``` - diff --git a/docs/awscc-docs/providers/awscc/nimblestudio/streaming_image/index.md b/docs/awscc-docs/providers/awscc/nimblestudio/streaming_image/index.md deleted file mode 100644 index ecc7da3047..0000000000 --- a/docs/awscc-docs/providers/awscc/nimblestudio/streaming_image/index.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the streaming_image resource, the following permissions are required: - -### Read -```json -nimble:GetStreamingImage -``` - -### Update -```json -nimble:UpdateStreamingImage, -nimble:GetStreamingImage, -kms:Encrypt, -kms:Decrypt, -kms:CreateGrant, -kms:ListGrants, -kms:GenerateDataKey -``` - -### Delete -```json -nimble:DeleteStreamingImage, -nimble:GetStreamingImage, -nimble:UntagResource, -ec2:ModifyInstanceAttribute, -ec2:ModifySnapshotAttribute, -ec2:DeregisterImage, -ec2:DeleteSnapshot, -kms:ListGrants, -kms:RetireGrant -``` - diff --git a/docs/awscc-docs/providers/awscc/nimblestudio/streaming_images/index.md b/docs/awscc-docs/providers/awscc/nimblestudio/streaming_images/index.md deleted file mode 100644 index 09543c2d7f..0000000000 --- a/docs/awscc-docs/providers/awscc/nimblestudio/streaming_images/index.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -studio_id, -streaming_image_id -FROM awscc.nimblestudio.streaming_images -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the streaming_images resource, the following permissions are required: - -### Create -```json -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 -```json -nimble:ListStreamingImages -``` - diff --git a/docs/awscc-docs/providers/awscc/nimblestudio/studio/index.md b/docs/awscc-docs/providers/awscc/nimblestudio/studio/index.md deleted file mode 100644 index e8f98cff06..0000000000 --- a/docs/awscc-docs/providers/awscc/nimblestudio/studio/index.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the studio resource, the following permissions are required: - -### Read -```json -nimble:GetStudio, -kms:Encrypt, -kms:Decrypt, -kms:ListGrants, -kms:GenerateDataKey -``` - -### Update -```json -iam:PassRole, -nimble:UpdateStudio, -nimble:GetStudio, -kms:Encrypt, -kms:Decrypt, -kms:CreateGrant, -kms:ListGrants, -kms:GenerateDataKey -``` - -### Delete -```json -nimble:DeleteStudio, -nimble:GetStudio, -nimble:UntagResource, -kms:Encrypt, -kms:Decrypt, -kms:ListGrants, -kms:RetireGrant, -kms:GenerateDataKey, -sso:DeleteManagedApplicationInstance, -sso:GetManagedApplicationInstance -``` - diff --git a/docs/awscc-docs/providers/awscc/nimblestudio/studio_component/index.md b/docs/awscc-docs/providers/awscc/nimblestudio/studio_component/index.md deleted file mode 100644 index 079dbe42bb..0000000000 --- a/docs/awscc-docs/providers/awscc/nimblestudio/studio_component/index.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the studio_component resource, the following permissions are required: - -### Read -```json -nimble:GetStudioComponent -``` - -### Update -```json -iam:PassRole, -nimble:UpdateStudioComponent, -nimble:GetStudioComponent, -ds:AuthorizeApplication, -ec2:DescribeSecurityGroups, -fsx:DescribeFilesystems, -ds:DescribeDirectories -``` - -### Delete -```json -nimble:DeleteStudioComponent, -nimble:GetStudioComponent, -nimble:UntagResource, -ds:UnauthorizeApplication -``` - diff --git a/docs/awscc-docs/providers/awscc/nimblestudio/studio_components/index.md b/docs/awscc-docs/providers/awscc/nimblestudio/studio_components/index.md deleted file mode 100644 index 4a5154c086..0000000000 --- a/docs/awscc-docs/providers/awscc/nimblestudio/studio_components/index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -studio_component_id, -studio_id -FROM awscc.nimblestudio.studio_components -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the studio_components resource, the following permissions are required: - -### Create -```json -iam:PassRole, -nimble:CreateStudioComponent, -nimble:GetStudioComponent, -nimble:TagResource, -ds:AuthorizeApplication, -ec2:DescribeSecurityGroups, -fsx:DescribeFilesystems, -ds:DescribeDirectories -``` - -### List -```json -nimble:ListStudioComponents -``` - diff --git a/docs/awscc-docs/providers/awscc/nimblestudio/studios/index.md b/docs/awscc-docs/providers/awscc/nimblestudio/studios/index.md deleted file mode 100644 index ad19eaa824..0000000000 --- a/docs/awscc-docs/providers/awscc/nimblestudio/studios/index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -studio_id -FROM awscc.nimblestudio.studios -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the studios resource, the following permissions are required: - -### Create -```json -iam:PassRole, -nimble:CreateStudio, -nimble:GetStudio, -nimble:TagResource, -sso:CreateManagedApplicationInstance, -kms:Encrypt, -kms:Decrypt, -kms:CreateGrant, -kms:ListGrants, -kms:GenerateDataKey -``` - -### List -```json -nimble:ListStudios -``` - diff --git a/docs/awscc-docs/providers/awscc/oam/index.md b/docs/awscc-docs/providers/awscc/oam/index.md deleted file mode 100644 index 92a1604598..0000000000 --- a/docs/awscc-docs/providers/awscc/oam/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index cfc8bfb7c6..0000000000 --- a/docs/awscc-docs/providers/awscc/oam/link/index.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -label, -label_template, -resource_types, -sink_identifier, -tags -FROM awscc.oam.link -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the link resource, the following permissions are required: - -### Read -```json -oam:GetLink -``` - -### Update -```json -oam:GetLink, -oam:UpdateLink, -cloudwatch:Link, -logs:Link, -xray:Link, -applicationinsights:Link, -oam:TagResource, -oam:UntagResource -``` - -### Delete -```json -oam:DeleteLink, -oam:GetLink -``` - diff --git a/docs/awscc-docs/providers/awscc/oam/links/index.md b/docs/awscc-docs/providers/awscc/oam/links/index.md deleted file mode 100644 index 8011bef5fc..0000000000 --- a/docs/awscc-docs/providers/awscc/oam/links/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.oam.links -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the links resource, the following permissions are required: - -### Create -```json -oam:CreateLink, -oam:GetLink, -cloudwatch:Link, -logs:Link, -xray:Link, -applicationinsights:Link -``` - -### List -```json -oam:ListLinks -``` - diff --git a/docs/awscc-docs/providers/awscc/oam/sink/index.md b/docs/awscc-docs/providers/awscc/oam/sink/index.md deleted file mode 100644 index 4fd34c56b6..0000000000 --- a/docs/awscc-docs/providers/awscc/oam/sink/index.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -name, -policy, -tags -FROM awscc.oam.sink -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the sink resource, the following permissions are required: - -### Delete -```json -oam:DeleteSink, -oam:GetSinkPolicy, -oam:GetSink -``` - -### Read -```json -oam:GetSinkPolicy, -oam:GetSink -``` - -### Update -```json -oam:PutSinkPolicy, -oam:GetSinkPolicy, -oam:GetSink, -oam:TagResource, -oam:UntagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/oam/sinks/index.md b/docs/awscc-docs/providers/awscc/oam/sinks/index.md deleted file mode 100644 index 3b7d35ef70..0000000000 --- a/docs/awscc-docs/providers/awscc/oam/sinks/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.oam.sinks -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the sinks resource, the following permissions are required: - -### Create -```json -oam:CreateSink, -oam:PutSinkPolicy, -oam:GetSinkPolicy, -oam:GetSink -``` - -### List -```json -oam:ListSinks -``` - diff --git a/docs/awscc-docs/providers/awscc/omics/annotation_store/index.md b/docs/awscc-docs/providers/awscc/omics/annotation_store/index.md deleted file mode 100644 index caa575c1a3..0000000000 --- a/docs/awscc-docs/providers/awscc/omics/annotation_store/index.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the annotation_store resource, the following permissions are required: - -### Read -```json -omics:GetAnnotationStore -``` - -### Update -```json -omics:UpdateAnnotationStore, -omics:TagResource, -omics:UntagResource, -omics:GetAnnotationStore, -omics:ListTagsForResource -``` - -### Delete -```json -omics:DeleteAnnotationStore, -omics:ListAnnotationStores -``` - diff --git a/docs/awscc-docs/providers/awscc/omics/annotation_stores/index.md b/docs/awscc-docs/providers/awscc/omics/annotation_stores/index.md deleted file mode 100644 index 34d6696a27..0000000000 --- a/docs/awscc-docs/providers/awscc/omics/annotation_stores/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.omics.annotation_stores -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the annotation_stores resource, the following permissions are required: - -### Create -```json -omics:CreateAnnotationStore, -omics:TagResource, -kms:DescribeKey, -kms:GenerateDataKey, -kms:CreateGrant, -ram:AcceptResourceShareInvitation, -ram:GetResourceShareInvitations, -omics:GetAnnotationStore -``` - -### List -```json -omics:ListAnnotationStores -``` - diff --git a/docs/awscc-docs/providers/awscc/omics/index.md b/docs/awscc-docs/providers/awscc/omics/index.md deleted file mode 100644 index 56ec3b8a8c..0000000000 --- a/docs/awscc-docs/providers/awscc/omics/index.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -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 deleted file mode 100644 index 708d53661e..0000000000 --- a/docs/awscc-docs/providers/awscc/omics/reference_store/index.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -creation_time, -description, -name, -reference_store_id, -sse_config, -tags -FROM awscc.omics.reference_store -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the reference_store resource, the following permissions are required: - -### Read -```json -omics:GetReferenceStore, -omics:ListTagsForResource -``` - -### Delete -```json -omics:DeleteReferenceStore -``` - diff --git a/docs/awscc-docs/providers/awscc/omics/reference_stores/index.md b/docs/awscc-docs/providers/awscc/omics/reference_stores/index.md deleted file mode 100644 index 33dfb7d7f4..0000000000 --- a/docs/awscc-docs/providers/awscc/omics/reference_stores/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -reference_store_id -FROM awscc.omics.reference_stores -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the reference_stores resource, the following permissions are required: - -### Create -```json -omics:CreateReferenceStore, -omics:TagResource -``` - -### List -```json -omics:ListReferenceStores -``` - diff --git a/docs/awscc-docs/providers/awscc/omics/run_group/index.md b/docs/awscc-docs/providers/awscc/omics/run_group/index.md deleted file mode 100644 index 0927dfb082..0000000000 --- a/docs/awscc-docs/providers/awscc/omics/run_group/index.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -creation_time, -id, -max_cpus, -max_gpus, -max_duration, -max_runs, -name, -tags -FROM awscc.omics.run_group -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the run_group resource, the following permissions are required: - -### Read -```json -omics:GetRunGroup -``` - -### Update -```json -omics:UpdateRunGroup, -omics:TagResource, -omics:GetRunGroup, -omics:ListTagsForResource, -omics:UntagResource -``` - -### Delete -```json -omics:DeleteRunGroup, -omics:GetRunGroup -``` - diff --git a/docs/awscc-docs/providers/awscc/omics/run_groups/index.md b/docs/awscc-docs/providers/awscc/omics/run_groups/index.md deleted file mode 100644 index a01067371c..0000000000 --- a/docs/awscc-docs/providers/awscc/omics/run_groups/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.omics.run_groups -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the run_groups resource, the following permissions are required: - -### Create -```json -omics:CreateRunGroup, -omics:TagResource -``` - -### List -```json -omics:ListRunGroups -``` - diff --git a/docs/awscc-docs/providers/awscc/omics/sequence_store/index.md b/docs/awscc-docs/providers/awscc/omics/sequence_store/index.md deleted file mode 100644 index f03afa9e00..0000000000 --- a/docs/awscc-docs/providers/awscc/omics/sequence_store/index.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -creation_time, -description, -name, -fallback_location, -sequence_store_id, -sse_config, -tags -FROM awscc.omics.sequence_store -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the sequence_store resource, the following permissions are required: - -### Read -```json -omics:GetSequenceStore, -omics:ListTagsForResource -``` - -### Delete -```json -omics:DeleteSequenceStore -``` - diff --git a/docs/awscc-docs/providers/awscc/omics/sequence_stores/index.md b/docs/awscc-docs/providers/awscc/omics/sequence_stores/index.md deleted file mode 100644 index de85d8281d..0000000000 --- a/docs/awscc-docs/providers/awscc/omics/sequence_stores/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -sequence_store_id -FROM awscc.omics.sequence_stores -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the sequence_stores resource, the following permissions are required: - -### Create -```json -omics:CreateSequenceStore, -omics:TagResource -``` - -### List -```json -omics:ListSequenceStores -``` - diff --git a/docs/awscc-docs/providers/awscc/omics/variant_store/index.md b/docs/awscc-docs/providers/awscc/omics/variant_store/index.md deleted file mode 100644 index 39ec6fed45..0000000000 --- a/docs/awscc-docs/providers/awscc/omics/variant_store/index.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the variant_store resource, the following permissions are required: - -### Read -```json -omics:GetVariantStore -``` - -### Update -```json -omics:UpdateVariantStore, -omics:TagResource, -omics:UntagResource, -omics:ListTagsForResource, -omics:GetVariantStore -``` - -### Delete -```json -omics:DeleteVariantStore, -omics:ListVariantStores -``` - diff --git a/docs/awscc-docs/providers/awscc/omics/variant_stores/index.md b/docs/awscc-docs/providers/awscc/omics/variant_stores/index.md deleted file mode 100644 index 288e4cab2b..0000000000 --- a/docs/awscc-docs/providers/awscc/omics/variant_stores/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.omics.variant_stores -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the variant_stores resource, the following permissions are required: - -### Create -```json -omics:CreateVariantStore, -omics:TagResource, -kms:DescribeKey, -kms:GenerateDataKey, -kms:CreateGrant, -ram:AcceptResourceShareInvitation, -ram:GetResourceShareInvitations, -omics:GetVariantStore -``` - -### List -```json -omics:ListVariantStores -``` - diff --git a/docs/awscc-docs/providers/awscc/omics/workflow/index.md b/docs/awscc-docs/providers/awscc/omics/workflow/index.md deleted file mode 100644 index 56436ec959..0000000000 --- a/docs/awscc-docs/providers/awscc/omics/workflow/index.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the workflow resource, the following permissions are required: - -### Read -```json -omics:GetWorkflow -``` - -### Update -```json -omics:UpdateWorkflow, -omics:GetWorkflow, -omics:TagResource, -omics:ListTagsForResource, -omics:UntagResource -``` - -### Delete -```json -omics:DeleteWorkflow, -omics:GetWorkflow -``` - diff --git a/docs/awscc-docs/providers/awscc/omics/workflows/index.md b/docs/awscc-docs/providers/awscc/omics/workflows/index.md deleted file mode 100644 index d766df3d58..0000000000 --- a/docs/awscc-docs/providers/awscc/omics/workflows/index.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.omics.workflows -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the workflows resource, the following permissions are required: - -### Create -```json -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 -```json -omics:ListWorkflows -``` - diff --git a/docs/awscc-docs/providers/awscc/opensearchserverless/access_policies/index.md b/docs/awscc-docs/providers/awscc/opensearchserverless/access_policies/index.md deleted file mode 100644 index 1f2934a5b4..0000000000 --- a/docs/awscc-docs/providers/awscc/opensearchserverless/access_policies/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -type, -name -FROM awscc.opensearchserverless.access_policies -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the access_policies resource, the following permissions are required: - -### Create -```json -aoss:CreateAccessPolicy, -aoss:GetAccessPolicy -``` - -### List -```json -aoss:ListAccessPolicies -``` - diff --git a/docs/awscc-docs/providers/awscc/opensearchserverless/access_policy/index.md b/docs/awscc-docs/providers/awscc/opensearchserverless/access_policy/index.md deleted file mode 100644 index 4c1e82456f..0000000000 --- a/docs/awscc-docs/providers/awscc/opensearchserverless/access_policy/index.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -type, -description, -policy -FROM awscc.opensearchserverless.access_policy -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the access_policy resource, the following permissions are required: - -### Read -```json -aoss:GetAccessPolicy -``` - -### Update -```json -aoss:UpdateAccessPolicy, -aoss:GetAccessPolicy -``` - -### Delete -```json -aoss:DeleteAccessPolicy, -aoss:GetAccessPolicy -``` - diff --git a/docs/awscc-docs/providers/awscc/opensearchserverless/collection/index.md b/docs/awscc-docs/providers/awscc/opensearchserverless/collection/index.md deleted file mode 100644 index 85ed4713b4..0000000000 --- a/docs/awscc-docs/providers/awscc/opensearchserverless/collection/index.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -description, -id, -name, -tags, -arn, -collection_endpoint, -dashboard_endpoint, -type, -standby_replicas -FROM awscc.opensearchserverless.collection -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the collection resource, the following permissions are required: - -### Delete -```json -aoss:DeleteCollection, -aoss:BatchGetCollection -``` - -### Read -```json -aoss:BatchGetCollection -``` - -### Update -```json -aoss:UpdateCollection, -aoss:BatchGetCollection -``` - diff --git a/docs/awscc-docs/providers/awscc/opensearchserverless/collections/index.md b/docs/awscc-docs/providers/awscc/opensearchserverless/collections/index.md deleted file mode 100644 index a5502a264f..0000000000 --- a/docs/awscc-docs/providers/awscc/opensearchserverless/collections/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.opensearchserverless.collections -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the collections resource, the following permissions are required: - -### Create -```json -aoss:CreateCollection, -aoss:BatchGetCollection, -iam:CreateServiceLinkedRole -``` - -### List -```json -aoss:ListCollections -``` - diff --git a/docs/awscc-docs/providers/awscc/opensearchserverless/index.md b/docs/awscc-docs/providers/awscc/opensearchserverless/index.md deleted file mode 100644 index a34831c60f..0000000000 --- a/docs/awscc-docs/providers/awscc/opensearchserverless/index.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -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 deleted file mode 100644 index f1eb0622e0..0000000000 --- a/docs/awscc-docs/providers/awscc/opensearchserverless/lifecycle_policies/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -type, -name -FROM awscc.opensearchserverless.lifecycle_policies -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the lifecycle_policies resource, the following permissions are required: - -### Create -```json -aoss:CreateLifecyclePolicy -``` - -### List -```json -aoss:ListLifecyclePolicies -``` - diff --git a/docs/awscc-docs/providers/awscc/opensearchserverless/lifecycle_policy/index.md b/docs/awscc-docs/providers/awscc/opensearchserverless/lifecycle_policy/index.md deleted file mode 100644 index 866a76e507..0000000000 --- a/docs/awscc-docs/providers/awscc/opensearchserverless/lifecycle_policy/index.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -type, -description, -policy -FROM awscc.opensearchserverless.lifecycle_policy -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the lifecycle_policy resource, the following permissions are required: - -### Read -```json -aoss:BatchGetLifecyclePolicy -``` - -### Update -```json -aoss:UpdateLifecyclePolicy, -aoss:BatchGetLifecyclePolicy -``` - -### Delete -```json -aoss:DeleteLifecyclePolicy -``` - diff --git a/docs/awscc-docs/providers/awscc/opensearchserverless/security_config/index.md b/docs/awscc-docs/providers/awscc/opensearchserverless/security_config/index.md deleted file mode 100644 index 15c3dc2c41..0000000000 --- a/docs/awscc-docs/providers/awscc/opensearchserverless/security_config/index.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -description, -id, -name, -saml_options, -type -FROM awscc.opensearchserverless.security_config -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the security_config resource, the following permissions are required: - -### Read -```json -aoss:GetSecurityConfig -``` - -### Update -```json -aoss:GetSecurityConfig, -aoss:UpdateSecurityConfig -``` - -### Delete -```json -aoss:DeleteSecurityConfig -``` - diff --git a/docs/awscc-docs/providers/awscc/opensearchserverless/security_configs/index.md b/docs/awscc-docs/providers/awscc/opensearchserverless/security_configs/index.md deleted file mode 100644 index 01288fa8ed..0000000000 --- a/docs/awscc-docs/providers/awscc/opensearchserverless/security_configs/index.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.opensearchserverless.security_configs -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the security_configs resource, the following permissions are required: - -### Create -```json -aoss:CreateSecurityConfig -``` - -### List -```json -aoss:ListSecurityConfigs -``` - diff --git a/docs/awscc-docs/providers/awscc/opensearchserverless/security_policies/index.md b/docs/awscc-docs/providers/awscc/opensearchserverless/security_policies/index.md deleted file mode 100644 index d75a992f04..0000000000 --- a/docs/awscc-docs/providers/awscc/opensearchserverless/security_policies/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -type, -name -FROM awscc.opensearchserverless.security_policies -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the security_policies resource, the following permissions are required: - -### Create -```json -aoss:GetSecurityPolicy, -aoss:CreateSecurityPolicy, -kms:DescribeKey, -kms:CreateGrant -``` - -### List -```json -aoss:ListSecurityPolicies -``` - diff --git a/docs/awscc-docs/providers/awscc/opensearchserverless/security_policy/index.md b/docs/awscc-docs/providers/awscc/opensearchserverless/security_policy/index.md deleted file mode 100644 index 038a1a560e..0000000000 --- a/docs/awscc-docs/providers/awscc/opensearchserverless/security_policy/index.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -description, -policy, -name, -type -FROM awscc.opensearchserverless.security_policy -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the security_policy resource, the following permissions are required: - -### Update -```json -aoss:GetSecurityPolicy, -aoss:UpdateSecurityPolicy, -kms:DescribeKey, -kms:CreateGrant -``` - -### Delete -```json -aoss:GetSecurityPolicy, -aoss:DeleteSecurityPolicy -``` - -### Read -```json -aoss:GetSecurityPolicy, -kms:DescribeKey -``` - diff --git a/docs/awscc-docs/providers/awscc/opensearchserverless/vpc_endpoint/index.md b/docs/awscc-docs/providers/awscc/opensearchserverless/vpc_endpoint/index.md deleted file mode 100644 index 8eae90639c..0000000000 --- a/docs/awscc-docs/providers/awscc/opensearchserverless/vpc_endpoint/index.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id, -name, -security_group_ids, -subnet_ids, -vpc_id -FROM awscc.opensearchserverless.vpc_endpoint -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the vpc_endpoint resource, the following permissions are required: - -### Read -```json -aoss:BatchGetVpcEndpoint, -ec2:DescribeVpcEndpoints -``` - -### Update -```json -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 -```json -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 -``` - diff --git a/docs/awscc-docs/providers/awscc/opensearchserverless/vpc_endpoints/index.md b/docs/awscc-docs/providers/awscc/opensearchserverless/vpc_endpoints/index.md deleted file mode 100644 index 87cd3538bb..0000000000 --- a/docs/awscc-docs/providers/awscc/opensearchserverless/vpc_endpoints/index.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.opensearchserverless.vpc_endpoints -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the vpc_endpoints resource, the following permissions are required: - -### Create -```json -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 -```json -aoss:ListVpcEndpoints, -ec2:DescribeVpcEndpoints -``` - diff --git a/docs/awscc-docs/providers/awscc/opensearchservice/domain/index.md b/docs/awscc-docs/providers/awscc/opensearchservice/domain/index.md deleted file mode 100644 index ba09c732aa..0000000000 --- a/docs/awscc-docs/providers/awscc/opensearchservice/domain/index.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -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
ip_address_typestring
engine_versionstring
advanced_optionsobject
log_publishing_optionsobject
snapshot_optionsobject
vpc_optionsobject
node_to_node_encryption_optionsobject
domain_endpoint_optionsobject
cognito_optionsobject
advanced_security_optionsobject
domain_endpointstring
domain_endpoint_v2string
domain_endpointsobject
ebs_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. - -## Example -```sql -SELECT -region, -cluster_config, -domain_name, -access_policies, -ip_address_type, -engine_version, -advanced_options, -log_publishing_options, -snapshot_options, -vpc_options, -node_to_node_encryption_options, -domain_endpoint_options, -cognito_options, -advanced_security_options, -domain_endpoint, -domain_endpoint_v2, -domain_endpoints, -ebs_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 data__Identifier = ''; -``` - -## Permissions - -To operate on the domain resource, the following permissions are required: - -### Read -```json -es:DescribeDomain, -es:ListTags -``` - -### Update -```json -es:UpdateDomain, -es:UpgradeDomain, -es:DescribeDomain, -es:AddTags, -es:RemoveTags, -es:ListTags, -es:DescribeDomainChangeProgress -``` - -### Delete -```json -es:DeleteDomain, -es:DescribeDomain -``` - diff --git a/docs/awscc-docs/providers/awscc/opensearchservice/index.md b/docs/awscc-docs/providers/awscc/opensearchservice/index.md deleted file mode 100644 index 0b11041b2d..0000000000 --- a/docs/awscc-docs/providers/awscc/opensearchservice/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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: 1
-total selectable resources: 1
-total methods: 1
-
-
- -::: - -## Resources -
-
-domain -
-
- -
-
\ 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 deleted file mode 100644 index b0887e2d00..0000000000 --- a/docs/awscc-docs/providers/awscc/opsworkscm/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 deleted file mode 100644 index f011aee202..0000000000 --- a/docs/awscc-docs/providers/awscc/opsworkscm/server/index.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the server resource, the following permissions are required: - -### Delete -```json -opsworks-cm:DeleteServer, -opsworks-cm:DescribeServers -``` - -### Update -```json -opsworks-cm:UpdateServer, -opsworks-cm:TagResource, -opsworks-cm:UntagResource, -opsworks-cm:DescribeServers -``` - -### Read -```json -opsworks-cm:DescribeServers -``` - diff --git a/docs/awscc-docs/providers/awscc/opsworkscm/servers/index.md b/docs/awscc-docs/providers/awscc/opsworkscm/servers/index.md deleted file mode 100644 index 783971593b..0000000000 --- a/docs/awscc-docs/providers/awscc/opsworkscm/servers/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -server_name -FROM awscc.opsworkscm.servers -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the servers resource, the following permissions are required: - -### Create -```json -opsworks-cm:CreateServer, -opsworks-cm:DescribeServers, -iam:PassRole -``` - -### List -```json -opsworks-cm:DescribeServers, -opsworks-cm:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/organizations/account/index.md b/docs/awscc-docs/providers/awscc/organizations/account/index.md deleted file mode 100644 index 72ea6dbfb2..0000000000 --- a/docs/awscc-docs/providers/awscc/organizations/account/index.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the account resource, the following permissions are required: - -### Read -```json -organizations:DescribeAccount, -organizations:ListParents, -organizations:ListTagsForResource -``` - -### Update -```json -organizations:MoveAccount, -organizations:TagResource, -organizations:UntagResource, -organizations:ListRoots, -organizations:DescribeAccount, -organizations:ListParents, -organizations:ListTagsForResource -``` - -### Delete -```json -organizations:CloseAccount -``` - diff --git a/docs/awscc-docs/providers/awscc/organizations/accounts/index.md b/docs/awscc-docs/providers/awscc/organizations/accounts/index.md deleted file mode 100644 index d09d19554e..0000000000 --- a/docs/awscc-docs/providers/awscc/organizations/accounts/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -account_id -FROM awscc.organizations.accounts -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the accounts resource, the following permissions are required: - -### Create -```json -organizations:CreateAccount, -organizations:DescribeCreateAccountStatus, -organizations:MoveAccount, -organizations:ListParents, -organizations:TagResource, -organizations:DescribeAccount, -organizations:ListTagsForResource -``` - -### List -```json -organizations:ListAccounts -``` - diff --git a/docs/awscc-docs/providers/awscc/organizations/index.md b/docs/awscc-docs/providers/awscc/organizations/index.md deleted file mode 100644 index cbab210deb..0000000000 --- a/docs/awscc-docs/providers/awscc/organizations/index.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -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 deleted file mode 100644 index 3509b42903..0000000000 --- a/docs/awscc-docs/providers/awscc/organizations/organization/index.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id, -arn, -feature_set, -management_account_arn, -management_account_id, -management_account_email, -root_id -FROM awscc.organizations.organization -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the organization resource, the following permissions are required: - -### Read -```json -organizations:DescribeOrganization, -organizations:ListRoots -``` - -### Delete -```json -organizations:DeleteOrganization, -organizations:DescribeOrganization -``` - diff --git a/docs/awscc-docs/providers/awscc/organizations/organizational_unit/index.md b/docs/awscc-docs/providers/awscc/organizations/organizational_unit/index.md deleted file mode 100644 index 0d5a792ab8..0000000000 --- a/docs/awscc-docs/providers/awscc/organizations/organizational_unit/index.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -id, -name, -parent_id, -tags -FROM awscc.organizations.organizational_unit -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the organizational_unit resource, the following permissions are required: - -### Read -```json -organizations:DescribeOrganizationalUnit, -organizations:ListParents, -organizations:ListTagsForResource -``` - -### Update -```json -organizations:DescribeOrganizationalUnit, -organizations:ListParents, -organizations:ListTagsForResource, -organizations:TagResource, -organizations:UntagResource, -organizations:UpdateOrganizationalUnit -``` - -### Delete -```json -organizations:DeleteOrganizationalUnit -``` - diff --git a/docs/awscc-docs/providers/awscc/organizations/organizational_units/index.md b/docs/awscc-docs/providers/awscc/organizations/organizational_units/index.md deleted file mode 100644 index 868e188b8e..0000000000 --- a/docs/awscc-docs/providers/awscc/organizations/organizational_units/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.organizations.organizational_units -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the organizational_units resource, the following permissions are required: - -### Create -```json -organizations:CreateOrganizationalUnit, -organizations:DescribeOrganizationalUnit, -organizations:ListParents, -organizations:ListTagsForResource, -organizations:TagResource -``` - -### List -```json -organizations:ListOrganizationalUnitsForParent -``` - diff --git a/docs/awscc-docs/providers/awscc/organizations/organizations/index.md b/docs/awscc-docs/providers/awscc/organizations/organizations/index.md deleted file mode 100644 index 784f03ba46..0000000000 --- a/docs/awscc-docs/providers/awscc/organizations/organizations/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.organizations.organizations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the organizations resource, the following permissions are required: - -### Create -```json -organizations:CreateOrganization, -organizations:DescribeOrganization, -iam:CreateServiceLinkedRole, -organizations:ListRoots -``` - -### List -```json -organizations:DescribeOrganization -``` - diff --git a/docs/awscc-docs/providers/awscc/organizations/policies/index.md b/docs/awscc-docs/providers/awscc/organizations/policies/index.md deleted file mode 100644 index 8546d95cd6..0000000000 --- a/docs/awscc-docs/providers/awscc/organizations/policies/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.organizations.policies -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the policies resource, the following permissions are required: - -### Create -```json -organizations:CreatePolicy, -organizations:DescribePolicy, -organizations:AttachPolicy, -organizations:ListTagsForResource, -organizations:ListTargetsForPolicy, -organizations:TagResource -``` - -### List -```json -organizations:ListPolicies -``` - diff --git a/docs/awscc-docs/providers/awscc/organizations/policy/index.md b/docs/awscc-docs/providers/awscc/organizations/policy/index.md deleted file mode 100644 index 3044f0ada3..0000000000 --- a/docs/awscc-docs/providers/awscc/organizations/policy/index.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -type, -content, -description, -target_ids, -tags, -id, -arn, -aws_managed -FROM awscc.organizations.policy -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the policy resource, the following permissions are required: - -### Read -```json -organizations:DescribePolicy, -organizations:ListTargetsForPolicy, -organizations:ListTagsForResource -``` - -### Update -```json -organizations:AttachPolicy, -organizations:DetachPolicy, -organizations:UpdatePolicy, -organizations:ListTagsForResource, -organizations:ListTargetsForPolicy, -organizations:TagResource, -organizations:UntagResource, -organizations:DescribePolicy -``` - -### Delete -```json -organizations:DetachPolicy, -organizations:DeletePolicy -``` - diff --git a/docs/awscc-docs/providers/awscc/organizations/resource_policies/index.md b/docs/awscc-docs/providers/awscc/organizations/resource_policies/index.md deleted file mode 100644 index 08b3f9abd3..0000000000 --- a/docs/awscc-docs/providers/awscc/organizations/resource_policies/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.organizations.resource_policies -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the resource_policies resource, the following permissions are required: - -### Create -```json -organizations:PutResourcePolicy, -organizations:DescribeResourcePolicy, -organizations:ListTagsForResource, -organizations:TagResource -``` - -### List -```json -organizations:DescribeResourcePolicy -``` - diff --git a/docs/awscc-docs/providers/awscc/organizations/resource_policy/index.md b/docs/awscc-docs/providers/awscc/organizations/resource_policy/index.md deleted file mode 100644 index bf05c23826..0000000000 --- a/docs/awscc-docs/providers/awscc/organizations/resource_policy/index.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id, -arn, -content, -tags -FROM awscc.organizations.resource_policy -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the resource_policy resource, the following permissions are required: - -### Read -```json -organizations:DescribeResourcePolicy, -organizations:ListTagsForResource -``` - -### Update -```json -organizations:DescribeResourcePolicy, -organizations:PutResourcePolicy, -organizations:ListTagsForResource, -organizations:TagResource, -organizations:UntagResource -``` - -### Delete -```json -organizations:DeleteResourcePolicy -``` - diff --git a/docs/awscc-docs/providers/awscc/osis/index.md b/docs/awscc-docs/providers/awscc/osis/index.md deleted file mode 100644 index 2fba1eff0e..0000000000 --- a/docs/awscc-docs/providers/awscc/osis/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 deleted file mode 100644 index 47775611c4..0000000000 --- a/docs/awscc-docs/providers/awscc/osis/pipeline/index.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the pipeline resource, the following permissions are required: - -### Read -```json -osis:GetPipeline, -osis:ListTagsForResource -``` - -### Update -```json -osis:UpdatePipeline, -osis:GetPipeline, -osis:ListTagsForResource, -osis:TagResource, -osis:UntagResource, -iam:PassRole, -logs:GetLogDelivery, -logs:UpdateLogDelivery, -logs:ListLogDeliveries, -kms:DescribeKey -``` - -### Delete -```json -osis:DeletePipeline, -osis:GetPipeline, -logs:GetLogDelivery, -logs:DeleteLogDelivery, -logs:ListLogDeliveries -``` - diff --git a/docs/awscc-docs/providers/awscc/osis/pipelines/index.md b/docs/awscc-docs/providers/awscc/osis/pipelines/index.md deleted file mode 100644 index 6173bab703..0000000000 --- a/docs/awscc-docs/providers/awscc/osis/pipelines/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -pipeline_arn -FROM awscc.osis.pipelines -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the pipelines resource, the following permissions are required: - -### Create -```json -osis:CreatePipeline, -osis:GetPipeline, -osis:TagResource, -osis:ListTagsForResource, -iam:PassRole, -iam:CreateServiceLinkedRole, -logs:CreateLogDelivery, -kms:DescribeKey -``` - -### List -```json -osis:ListPipelines -``` - diff --git a/docs/awscc-docs/providers/awscc/panorama/application_instance/index.md b/docs/awscc-docs/providers/awscc/panorama/application_instance/index.md deleted file mode 100644 index 866d500f75..0000000000 --- a/docs/awscc-docs/providers/awscc/panorama/application_instance/index.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the application_instance resource, the following permissions are required: - -### Read -```json -panorama:DescribeApplicationInstance, -panorama:DescribeApplicationInstanceDetails, -panorama:ListTagsForResource, -s3:ListObjects, -s3:GetObject, -s3:GetObjectVersion -``` - -### Update -```json -panorama:ListTagsForResource, -panorama:TagResource, -panorama:UntagResource, -panorama:DescribeApplicationInstance, -panorama:DescribeApplicationInstanceDetails, -s3:ListObjects, -s3:GetObject, -s3:GetObjectVersion -``` - -### Delete -```json -panorama:RemoveApplicationInstance, -panorama:DescribeApplicationInstance, -panorama:DescribeApplicationInstanceDetails, -s3:DeleteObject, -s3:DeleteObjectVersion, -s3:DeleteObjectVersionTagging, -s3:ListObjects, -s3:GetObject, -s3:GetObjectVersion -``` - diff --git a/docs/awscc-docs/providers/awscc/panorama/application_instances/index.md b/docs/awscc-docs/providers/awscc/panorama/application_instances/index.md deleted file mode 100644 index 0e7d828679..0000000000 --- a/docs/awscc-docs/providers/awscc/panorama/application_instances/index.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -application_instance_id -FROM awscc.panorama.application_instances -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the application_instances resource, the following permissions are required: - -### Create -```json -panorama:CreateApplicationInstance, -panorama:ListTagsForResource, -panorama:TagResource, -panorama:DescribeApplicationInstance, -panorama:DescribeApplicationInstanceDetails, -iam:PassRole, -s3:ListBucket, -s3:PutObject, -s3:GetObject, -s3:GetObjectVersion -``` - -### List -```json -panorama:ListApplicationInstances, -s3:ListBucket, -s3:GetObject, -s3:GetObjectVersion -``` - diff --git a/docs/awscc-docs/providers/awscc/panorama/index.md b/docs/awscc-docs/providers/awscc/panorama/index.md deleted file mode 100644 index 660e3c0df4..0000000000 --- a/docs/awscc-docs/providers/awscc/panorama/index.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -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: 5
-total selectable resources: 5
-total methods: 5
-
-
- -::: - -## Resources -
-
-application_instance
-application_instances
-package -
-
-package_version
-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 deleted file mode 100644 index 797ff6803a..0000000000 --- a/docs/awscc-docs/providers/awscc/panorama/package/index.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -package_name, -package_id, -arn, -storage_location, -created_time, -tags -FROM awscc.panorama.package -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the package resource, the following permissions are required: - -### Read -```json -panorama:DescribePackage, -panorama:ListTagsForResource, -s3:ListBucket, -s3:GetObject, -s3:GetObjectVersion -``` - -### Update -```json -panorama:DescribePackage, -panorama:ListTagsForResource, -panorama:TagResource, -panorama:UntagResource, -s3:PutObject, -s3:ListBucket, -s3:GetObject, -s3:GetObjectVersion -``` - -### Delete -```json -panorama:DeletePackage, -panorama:DescribePackage, -s3:DeleteObject, -s3:DeleteObjectVersion, -s3:DeleteObjectVersionTagging, -s3:ListObjects, -s3:ListObjectsV2, -s3:ListBucket, -s3:GetObject, -s3:GetObjectVersion -``` - diff --git a/docs/awscc-docs/providers/awscc/panorama/package_version/index.md b/docs/awscc-docs/providers/awscc/panorama/package_version/index.md deleted file mode 100644 index d2b1fddbf7..0000000000 --- a/docs/awscc-docs/providers/awscc/panorama/package_version/index.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -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. - -## 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 data__Identifier = '||'; -``` - -## Permissions - -To operate on the package_version resource, the following permissions are required: - -### Read -```json -panorama:DescribePackageVersion, -s3:ListBucket, -s3:GetObject, -s3:GetObjectVersion -``` - -### Update -```json -panorama:DescribePackageVersion, -panorama:RegisterPackageVersion, -s3:ListBucket, -s3:PutObject, -s3:GetObject, -s3:GetObjectVersion -``` - -### Delete -```json -panorama:DeregisterPackageVersion, -panorama:DescribePackageVersion, -s3:DeleteObject, -s3:DeleteObjectVersion, -s3:DeleteObjectVersionTagging, -s3:ListBucket, -s3:GetObject, -s3:GetObjectVersion -``` - diff --git a/docs/awscc-docs/providers/awscc/panorama/packages/index.md b/docs/awscc-docs/providers/awscc/panorama/packages/index.md deleted file mode 100644 index 56d63c6520..0000000000 --- a/docs/awscc-docs/providers/awscc/panorama/packages/index.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -package_id -FROM awscc.panorama.packages -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the packages resource, the following permissions are required: - -### Create -```json -panorama:CreatePackage, -panorama:ListTagsForResource, -panorama:TagResource, -panorama:DescribePackage, -s3:ListBucket, -s3:PutObject, -s3:GetObject, -s3:GetObjectVersion -``` - -### List -```json -panorama:ListPackages, -s3:ListBucket, -s3:GetObject, -s3:GetObjectVersion -``` - diff --git a/docs/awscc-docs/providers/awscc/pcaconnectorad/connector/index.md b/docs/awscc-docs/providers/awscc/pcaconnectorad/connector/index.md deleted file mode 100644 index 7726e65092..0000000000 --- a/docs/awscc-docs/providers/awscc/pcaconnectorad/connector/index.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -certificate_authority_arn, -connector_arn, -directory_id, -tags, -vpc_information -FROM awscc.pcaconnectorad.connector -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the connector resource, the following permissions are required: - -### Read -```json -pca-connector-ad:ListTagsForResource, -pca-connector-ad:GetConnector -``` - -### Delete -```json -pca-connector-ad:GetConnector, -pca-connector-ad:DeleteConnector, -ec2:DeleteVpcEndpoints, -ec2:DescribeVpcEndpoints -``` - -### Update -```json -pca-connector-ad:ListTagsForResource, -pca-connector-ad:TagResource, -pca-connector-ad:UntagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/pcaconnectorad/connectors/index.md b/docs/awscc-docs/providers/awscc/pcaconnectorad/connectors/index.md deleted file mode 100644 index c41678e814..0000000000 --- a/docs/awscc-docs/providers/awscc/pcaconnectorad/connectors/index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -connector_arn -FROM awscc.pcaconnectorad.connectors -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the connectors resource, the following permissions are required: - -### Create -```json -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 -```json -pca-connector-ad:ListConnectors -``` - diff --git a/docs/awscc-docs/providers/awscc/pcaconnectorad/directory_registration/index.md b/docs/awscc-docs/providers/awscc/pcaconnectorad/directory_registration/index.md deleted file mode 100644 index f0445fd65a..0000000000 --- a/docs/awscc-docs/providers/awscc/pcaconnectorad/directory_registration/index.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -directory_id, -directory_registration_arn, -tags -FROM awscc.pcaconnectorad.directory_registration -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the directory_registration resource, the following permissions are required: - -### Read -```json -pca-connector-ad:ListTagsForResource, -pca-connector-ad:GetDirectoryRegistration -``` - -### Delete -```json -pca-connector-ad:GetDirectoryRegistration, -pca-connector-ad:DeleteDirectoryRegistration, -ds:DescribeDirectories, -ds:UnauthorizeApplication, -ds:UpdateAuthorizedApplication -``` - -### Update -```json -pca-connector-ad:ListTagsForResource, -pca-connector-ad:TagResource, -pca-connector-ad:UntagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/pcaconnectorad/directory_registrations/index.md b/docs/awscc-docs/providers/awscc/pcaconnectorad/directory_registrations/index.md deleted file mode 100644 index e802dbc9c1..0000000000 --- a/docs/awscc-docs/providers/awscc/pcaconnectorad/directory_registrations/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -directory_registration_arn -FROM awscc.pcaconnectorad.directory_registrations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the directory_registrations resource, the following permissions are required: - -### Create -```json -pca-connector-ad:GetDirectoryRegistration, -pca-connector-ad:CreateDirectoryRegistration, -ds:AuthorizeApplication, -ds:DescribeDirectories -``` - -### List -```json -pca-connector-ad:ListDirectoryRegistrations -``` - diff --git a/docs/awscc-docs/providers/awscc/pcaconnectorad/index.md b/docs/awscc-docs/providers/awscc/pcaconnectorad/index.md deleted file mode 100644 index 6028d45e51..0000000000 --- a/docs/awscc-docs/providers/awscc/pcaconnectorad/index.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -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 deleted file mode 100644 index 8e21a8ee59..0000000000 --- a/docs/awscc-docs/providers/awscc/pcaconnectorad/service_principal_name/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -connector_arn, -directory_registration_arn -FROM awscc.pcaconnectorad.service_principal_name -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the service_principal_name resource, the following permissions are required: - -### Read -```json -pca-connector-ad:GetServicePrincipalName -``` - -### Delete -```json -ds:UpdateAuthorizedApplication, -pca-connector-ad:GetServicePrincipalName, -pca-connector-ad:DeleteServicePrincipalName -``` - 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 deleted file mode 100644 index 781b850552..0000000000 --- a/docs/awscc-docs/providers/awscc/pcaconnectorad/service_principal_names/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -connector_arn, -directory_registration_arn -FROM awscc.pcaconnectorad.service_principal_names -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the service_principal_names resource, the following permissions are required: - -### Create -```json -ds:UpdateAuthorizedApplication, -pca-connector-ad:GetServicePrincipalName, -pca-connector-ad:CreateServicePrincipalName -``` - -### List -```json -pca-connector-ad:ListServicePrincipalNames -``` - diff --git a/docs/awscc-docs/providers/awscc/pcaconnectorad/template/index.md b/docs/awscc-docs/providers/awscc/pcaconnectorad/template/index.md deleted file mode 100644 index f369df93d3..0000000000 --- a/docs/awscc-docs/providers/awscc/pcaconnectorad/template/index.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -connector_arn, -definition, -name, -reenroll_all_certificate_holders, -tags, -template_arn -FROM awscc.pcaconnectorad.template -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the template resource, the following permissions are required: - -### Read -```json -pca-connector-ad:GetTemplate, -pca-connector-ad:ListTagsForResource -``` - -### Update -```json -pca-connector-ad:ListTagsForResource, -pca-connector-ad:TagResource, -pca-connector-ad:UntagResource, -pca-connector-ad:UpdateTemplate -``` - -### Delete -```json -pca-connector-ad:GetTemplate, -pca-connector-ad:DeleteTemplate -``` - 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 deleted file mode 100644 index 2be2d95555..0000000000 --- a/docs/awscc-docs/providers/awscc/pcaconnectorad/template_group_access_control_entries/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -group_security_identifier, -template_arn -FROM awscc.pcaconnectorad.template_group_access_control_entries -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the template_group_access_control_entries resource, the following permissions are required: - -### Create -```json -pca-connector-ad:CreateTemplateGroupAccessControlEntry -``` - -### List -```json -pca-connector-ad:ListTemplateGroupAccessControlEntries -``` - 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 deleted file mode 100644 index 37dd56eafe..0000000000 --- a/docs/awscc-docs/providers/awscc/pcaconnectorad/template_group_access_control_entry/index.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -access_rights, -group_display_name, -group_security_identifier, -template_arn -FROM awscc.pcaconnectorad.template_group_access_control_entry -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the template_group_access_control_entry resource, the following permissions are required: - -### Read -```json -pca-connector-ad:GetTemplateGroupAccessControlEntry -``` - -### Update -```json -pca-connector-ad:UpdateTemplateGroupAccessControlEntry -``` - -### Delete -```json -pca-connector-ad:DeleteTemplateGroupAccessControlEntry, -pca-connector-ad:GetTemplateGroupAccessControlEntry -``` - diff --git a/docs/awscc-docs/providers/awscc/pcaconnectorad/templates/index.md b/docs/awscc-docs/providers/awscc/pcaconnectorad/templates/index.md deleted file mode 100644 index 185c0a5dad..0000000000 --- a/docs/awscc-docs/providers/awscc/pcaconnectorad/templates/index.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -template_arn -FROM awscc.pcaconnectorad.templates -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the templates resource, the following permissions are required: - -### Create -```json -pca-connector-ad:CreateTemplate -``` - -### List -```json -pca-connector-ad:ListTemplates -``` - diff --git a/docs/awscc-docs/providers/awscc/personalize/dataset/index.md b/docs/awscc-docs/providers/awscc/personalize/dataset/index.md deleted file mode 100644 index a2dce2d969..0000000000 --- a/docs/awscc-docs/providers/awscc/personalize/dataset/index.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -dataset_arn, -dataset_type, -dataset_group_arn, -schema_arn, -dataset_import_job -FROM awscc.personalize.dataset -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the dataset resource, the following permissions are required: - -### Read -```json -personalize:DescribeDataset -``` - -### Update -```json -personalize:DescribeDataset, -personalize:CreateDatasetImportJob, -personalize:DescribeDatasetImportJob, -iam:PassRole -``` - -### Delete -```json -personalize:DeleteDataset, -personalize:DescribeDataset -``` - diff --git a/docs/awscc-docs/providers/awscc/personalize/dataset_group/index.md b/docs/awscc-docs/providers/awscc/personalize/dataset_group/index.md deleted file mode 100644 index 16cad05165..0000000000 --- a/docs/awscc-docs/providers/awscc/personalize/dataset_group/index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -dataset_group_arn, -name, -kms_key_arn, -role_arn, -domain -FROM awscc.personalize.dataset_group -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the dataset_group resource, the following permissions are required: - -### Read -```json -personalize:DescribeDatasetGroup -``` - -### Delete -```json -personalize:DescribeDatasetGroup, -personalize:DeleteDatasetGroup -``` - diff --git a/docs/awscc-docs/providers/awscc/personalize/dataset_groups/index.md b/docs/awscc-docs/providers/awscc/personalize/dataset_groups/index.md deleted file mode 100644 index 59c2fe2212..0000000000 --- a/docs/awscc-docs/providers/awscc/personalize/dataset_groups/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -dataset_group_arn -FROM awscc.personalize.dataset_groups -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the dataset_groups resource, the following permissions are required: - -### Create -```json -personalize:CreateDatasetGroup, -personalize:DescribeDatasetGroup, -iam:PassRole -``` - -### List -```json -personalize:ListDatasetGroups -``` - diff --git a/docs/awscc-docs/providers/awscc/personalize/datasets/index.md b/docs/awscc-docs/providers/awscc/personalize/datasets/index.md deleted file mode 100644 index 254127eefe..0000000000 --- a/docs/awscc-docs/providers/awscc/personalize/datasets/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -dataset_arn -FROM awscc.personalize.datasets -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the datasets resource, the following permissions are required: - -### Create -```json -personalize:CreateDataset, -personalize:DescribeDataset, -personalize:CreateDatasetImportJob, -personalize:DescribeDatasetImportJob, -iam:PassRole -``` - -### List -```json -personalize:ListDatasets -``` - diff --git a/docs/awscc-docs/providers/awscc/personalize/index.md b/docs/awscc-docs/providers/awscc/personalize/index.md deleted file mode 100644 index 8df4cab633..0000000000 --- a/docs/awscc-docs/providers/awscc/personalize/index.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -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 deleted file mode 100644 index 154e871f9b..0000000000 --- a/docs/awscc-docs/providers/awscc/personalize/schema/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -schema_arn, -schema, -domain -FROM awscc.personalize.schema -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the schema resource, the following permissions are required: - -### Read -```json -personalize:DescribeSchema -``` - -### Delete -```json -personalize:DeleteSchema, -personalize:DescribeSchema -``` - diff --git a/docs/awscc-docs/providers/awscc/personalize/schemata/index.md b/docs/awscc-docs/providers/awscc/personalize/schemata/index.md deleted file mode 100644 index 48162e4ae1..0000000000 --- a/docs/awscc-docs/providers/awscc/personalize/schemata/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -schema_arn -FROM awscc.personalize.schemata -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the schemata resource, the following permissions are required: - -### Create -```json -personalize:CreateSchema, -personalize:DescribeSchema -``` - -### List -```json -personalize:ListSchemas -``` - diff --git a/docs/awscc-docs/providers/awscc/personalize/solution/index.md b/docs/awscc-docs/providers/awscc/personalize/solution/index.md deleted file mode 100644 index 736dfd0006..0000000000 --- a/docs/awscc-docs/providers/awscc/personalize/solution/index.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -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_hpobooleanWhether 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. - -## Example -```sql -SELECT -region, -name, -solution_arn, -event_type, -dataset_group_arn, -perform_auto_ml, -perform_hpo, -recipe_arn, -solution_config -FROM awscc.personalize.solution -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the solution resource, the following permissions are required: - -### Read -```json -personalize:DescribeSolution -``` - -### Delete -```json -personalize:DeleteSolution, -personalize:DescribeSolution -``` - diff --git a/docs/awscc-docs/providers/awscc/personalize/solutions/index.md b/docs/awscc-docs/providers/awscc/personalize/solutions/index.md deleted file mode 100644 index 4faacf5edb..0000000000 --- a/docs/awscc-docs/providers/awscc/personalize/solutions/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -solution_arn -FROM awscc.personalize.solutions -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the solutions resource, the following permissions are required: - -### Create -```json -personalize:CreateSolution, -personalize:DescribeSolution -``` - -### List -```json -personalize:ListSolutions -``` - 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 deleted file mode 100644 index 3ca29a0b21..0000000000 --- a/docs/awscc-docs/providers/awscc/pinpoint/in_app_template/index.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -content, -custom_config, -layout, -tags, -template_description, -template_name -FROM awscc.pinpoint.in_app_template -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the in_app_template resource, the following permissions are required: - -### Delete -```json -mobiletargeting:DeleteInAppTemplate, -mobiletargeting:GetInAppTemplate -``` - -### Read -```json -mobiletargeting:GetInAppTemplate, -mobiletargeting:ListTemplates -``` - -### Update -```json -mobiletargeting:UpdateInAppTemplate, -mobiletargeting:GetInAppTemplate -``` - 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 deleted file mode 100644 index 65b56b859c..0000000000 --- a/docs/awscc-docs/providers/awscc/pinpoint/in_app_templates/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -template_name -FROM awscc.pinpoint.in_app_templates -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the in_app_templates resource, the following permissions are required: - -### Create -```json -mobiletargeting:CreateInAppTemplate, -mobiletargeting:GetInAppTemplate, -mobiletargeting:TagResource -``` - -### List -```json -mobiletargeting:GetInAppTemplate, -mobiletargeting:ListTemplates -``` - diff --git a/docs/awscc-docs/providers/awscc/pinpoint/index.md b/docs/awscc-docs/providers/awscc/pinpoint/index.md deleted file mode 100644 index e90b2b52ec..0000000000 --- a/docs/awscc-docs/providers/awscc/pinpoint/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 deleted file mode 100644 index 39e4398cae..0000000000 --- a/docs/awscc-docs/providers/awscc/pipes/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 deleted file mode 100644 index 8b153a3188..0000000000 --- a/docs/awscc-docs/providers/awscc/pipes/pipe/index.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the pipe resource, the following permissions are required: - -### Read -```json -pipes:DescribePipe -``` - -### Update -```json -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 -```json -pipes:DeletePipe, -pipes:DescribePipe, -logs:CreateLogDelivery, -logs:UpdateLogDelivery, -logs:DeleteLogDelivery, -logs:GetLogDelivery, -logs:ListLogDeliveries -``` - diff --git a/docs/awscc-docs/providers/awscc/pipes/pipes/index.md b/docs/awscc-docs/providers/awscc/pipes/pipes/index.md deleted file mode 100644 index 094787a218..0000000000 --- a/docs/awscc-docs/providers/awscc/pipes/pipes/index.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.pipes.pipes -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the pipes resource, the following permissions are required: - -### Create -```json -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 -```json -pipes:ListPipes -``` - 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 deleted file mode 100644 index 3f5f6e3c94..0000000000 --- a/docs/awscc-docs/providers/awscc/proton/environment_account_connection/index.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the environment_account_connection resource, the following permissions are required: - -### Read -```json -proton:GetEnvironmentAccountConnection, -proton:ListTagsForResource, -iam:PassRole, -proton:GetEnvironmentAccountConnection -``` - -### Update -```json -proton:CreateEnvironmentAccountConnection, -proton:ListTagsForResource, -proton:TagResource, -proton:UntagResource, -proton:UpdateEnvironmentAccountConnection, -iam:PassRole, -proton:GetEnvironmentAccountConnection -``` - -### Delete -```json -proton:DeleteEnvironmentAccountConnection, -proton:UntagResource, -iam:PassRole, -proton:ListTagsForResource, -proton:GetEnvironmentAccountConnection -``` - 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 deleted file mode 100644 index 9d41dfc216..0000000000 --- a/docs/awscc-docs/providers/awscc/proton/environment_account_connections/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.proton.environment_account_connections -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the environment_account_connections resource, the following permissions are required: - -### Create -```json -proton:CreateEnvironmentAccountConnection, -proton:TagResource, -iam:PassRole, -proton:ListTagsForResource, -proton:GetEnvironmentAccountConnection -``` - -### List -```json -proton:ListEnvironmentAccountConnections -``` - diff --git a/docs/awscc-docs/providers/awscc/proton/environment_template/index.md b/docs/awscc-docs/providers/awscc/proton/environment_template/index.md deleted file mode 100644 index b009c6b056..0000000000 --- a/docs/awscc-docs/providers/awscc/proton/environment_template/index.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -description, -display_name, -encryption_key, -name, -provisioning, -tags -FROM awscc.proton.environment_template -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the environment_template resource, the following permissions are required: - -### Read -```json -proton:GetEnvironmentTemplate, -proton:ListTagsForResource, -kms:* -``` - -### Update -```json -proton:CreateEnvironmentTemplate, -proton:ListTagsForResource, -proton:TagResource, -proton:UntagResource, -proton:UpdateEnvironmentTemplate, -proton:GetEnvironmentTemplate, -kms:* -``` - -### Delete -```json -proton:DeleteEnvironmentTemplate, -proton:GetEnvironmentTemplate, -kms:* -``` - diff --git a/docs/awscc-docs/providers/awscc/proton/environment_templates/index.md b/docs/awscc-docs/providers/awscc/proton/environment_templates/index.md deleted file mode 100644 index 0d0d25eb3a..0000000000 --- a/docs/awscc-docs/providers/awscc/proton/environment_templates/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.proton.environment_templates -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the environment_templates resource, the following permissions are required: - -### Create -```json -proton:CreateEnvironmentTemplate, -proton:TagResource, -proton:GetEnvironmentTemplate, -kms:* -``` - -### List -```json -proton:ListEnvironmentTemplates -``` - diff --git a/docs/awscc-docs/providers/awscc/proton/index.md b/docs/awscc-docs/providers/awscc/proton/index.md deleted file mode 100644 index aa09f31302..0000000000 --- a/docs/awscc-docs/providers/awscc/proton/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -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 deleted file mode 100644 index c1e5ee539d..0000000000 --- a/docs/awscc-docs/providers/awscc/proton/service_template/index.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -description, -display_name, -encryption_key, -name, -pipeline_provisioning, -tags -FROM awscc.proton.service_template -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the service_template resource, the following permissions are required: - -### Read -```json -proton:GetServiceTemplate, -proton:ListTagsForResource, -kms:* -``` - -### Update -```json -proton:GetServiceTemplate, -proton:CreateServiceTemplate, -proton:ListTagsForResource, -proton:TagResource, -proton:UntagResource, -proton:UpdateServiceTemplate, -kms:* -``` - -### Delete -```json -proton:DeleteServiceTemplate, -proton:UntagResource, -kms:*, -proton:GetServiceTemplate -``` - diff --git a/docs/awscc-docs/providers/awscc/proton/service_templates/index.md b/docs/awscc-docs/providers/awscc/proton/service_templates/index.md deleted file mode 100644 index 6b7ce5d6a2..0000000000 --- a/docs/awscc-docs/providers/awscc/proton/service_templates/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.proton.service_templates -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the service_templates resource, the following permissions are required: - -### Create -```json -proton:CreateServiceTemplate, -proton:TagResource, -kms:*, -proton:GetServiceTemplate -``` - -### List -```json -proton:ListServiceTemplates -``` - diff --git a/docs/awscc-docs/providers/awscc/qldb/index.md b/docs/awscc-docs/providers/awscc/qldb/index.md deleted file mode 100644 index ec8363bcd2..0000000000 --- a/docs/awscc-docs/providers/awscc/qldb/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 deleted file mode 100644 index 857eaf1fef..0000000000 --- a/docs/awscc-docs/providers/awscc/qldb/qldb_stream/index.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the qldb_stream resource, the following permissions are required: - -### Delete -```json -qldb:CancelJournalKinesisStream, -qldb:DescribeJournalKinesisStream -``` - -### Read -```json -qldb:DescribeJournalKinesisStream, -qldb:ListTagsForResource -``` - -### Update -```json -qldb:DescribeJournalKinesisStream, -qldb:UntagResource, -qldb:TagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/qldb/streams/index.md b/docs/awscc-docs/providers/awscc/qldb/streams/index.md deleted file mode 100644 index fadda857e5..0000000000 --- a/docs/awscc-docs/providers/awscc/qldb/streams/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -ledger_name, -id -FROM awscc.qldb.streams -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the streams resource, the following permissions are required: - -### Create -```json -iam:PassRole, -qldb:StreamJournalToKinesis, -qldb:DescribeJournalKinesisStream -``` - -### List -```json -qldb:listJournalKinesisStreamsForLedger -``` - diff --git a/docs/awscc-docs/providers/awscc/quicksight/analyses/index.md b/docs/awscc-docs/providers/awscc/quicksight/analyses/index.md deleted file mode 100644 index fe8c97e7bd..0000000000 --- a/docs/awscc-docs/providers/awscc/quicksight/analyses/index.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -analysis_id, -aws_account_id -FROM awscc.quicksight.analyses -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the analyses resource, the following permissions are required: - -### Create -```json -quicksight:DescribeAnalysis, -quicksight:DescribeAnalysisPermissions, -quicksight:CreateAnalysis, -quicksight:DescribeTemplate, -quicksight:DescribeTheme, -quicksight:PassDataSet, -quicksight:TagResource, -quicksight:UntagResource, -quicksight:ListTagsForResource -``` - -### List -```json -quicksight:ListAnalyses -``` - diff --git a/docs/awscc-docs/providers/awscc/quicksight/analysis/index.md b/docs/awscc-docs/providers/awscc/quicksight/analysis/index.md deleted file mode 100644 index a04e551770..0000000000 --- a/docs/awscc-docs/providers/awscc/quicksight/analysis/index.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the analysis resource, the following permissions are required: - -### Read -```json -quicksight:DescribeAnalysis, -quicksight:DescribeAnalysisPermissions, -quicksight:ListTagsForResource -``` - -### Update -```json -quicksight:DescribeAnalysis, -quicksight:DescribeAnalysisPermissions, -quicksight:UpdateAnalysis, -quicksight:UpdateAnalysisPermissions, -quicksight:DescribeTemplate, -quicksight:DescribeTheme, -quicksight:PassDataSet, -quicksight:TagResource, -quicksight:UntagResource, -quicksight:ListTagsForResource -``` - -### Delete -```json -quicksight:DescribeAnalysis, -quicksight:DeleteAnalysis -``` - diff --git a/docs/awscc-docs/providers/awscc/quicksight/dashboard/index.md b/docs/awscc-docs/providers/awscc/quicksight/dashboard/index.md deleted file mode 100644 index 19839c4cb0..0000000000 --- a/docs/awscc-docs/providers/awscc/quicksight/dashboard/index.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the dashboard resource, the following permissions are required: - -### Read -```json -quicksight:DescribeDashboard, -quicksight:DescribeDashboardPermissions, -quicksight:ListTagsForResource -``` - -### Update -```json -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 -```json -quicksight:DescribeDashboard, -quicksight:DeleteDashboard -``` - diff --git a/docs/awscc-docs/providers/awscc/quicksight/dashboards/index.md b/docs/awscc-docs/providers/awscc/quicksight/dashboards/index.md deleted file mode 100644 index 637da161b4..0000000000 --- a/docs/awscc-docs/providers/awscc/quicksight/dashboards/index.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -aws_account_id, -dashboard_id -FROM awscc.quicksight.dashboards -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the dashboards resource, the following permissions are required: - -### Create -```json -quicksight:DescribeDashboard, -quicksight:DescribeDashboardPermissions, -quicksight:CreateDashboard, -quicksight:DescribeTemplate, -quicksight:DescribeTheme, -quicksight:PassDataSet, -quicksight:TagResource, -quicksight:UntagResource, -quicksight:ListTagsForResource -``` - -### List -```json -quicksight:ListDashboards -``` - diff --git a/docs/awscc-docs/providers/awscc/quicksight/data_set/index.md b/docs/awscc-docs/providers/awscc/quicksight/data_set/index.md deleted file mode 100644 index 2db63688b5..0000000000 --- a/docs/awscc-docs/providers/awscc/quicksight/data_set/index.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the data_set resource, the following permissions are required: - -### Read -```json -quicksight:DescribeDataSet, -quicksight:DescribeDataSetPermissions, -quicksight:ListTagsForResource, -quicksight:DescribeDataSetRefreshProperties -``` - -### Update -```json -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 -```json -quicksight:DescribeDataSet, -quicksight:DeleteDataSet, -quicksight:ListTagsForResource, -quicksight:DescribeIngestion, -quicksight:DeleteDataSetRefreshProperties, -quicksight:DescribeDataSetRefreshProperties -``` - diff --git a/docs/awscc-docs/providers/awscc/quicksight/data_sets/index.md b/docs/awscc-docs/providers/awscc/quicksight/data_sets/index.md deleted file mode 100644 index 859bd3ff18..0000000000 --- a/docs/awscc-docs/providers/awscc/quicksight/data_sets/index.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -aws_account_id, -data_set_id -FROM awscc.quicksight.data_sets -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the data_sets resource, the following permissions are required: - -### Create -```json -quicksight:DescribeDataSet, -quicksight:DescribeDataSetPermissions, -quicksight:DescribeIngestion, -quicksight:ListIngestions, -quicksight:CreateDataSet, -quicksight:PassDataSource, -quicksight:PassDataSet, -quicksight:TagResource, -quicksight:ListTagsForResource, -quicksight:DescribeDataSetRefreshProperties, -quicksight:PutDataSetRefreshProperties -``` - -### List -```json -quicksight:DescribeDataSet, -quicksight:ListDataSets -``` - diff --git a/docs/awscc-docs/providers/awscc/quicksight/data_source/index.md b/docs/awscc-docs/providers/awscc/quicksight/data_source/index.md deleted file mode 100644 index be168d5ba3..0000000000 --- a/docs/awscc-docs/providers/awscc/quicksight/data_source/index.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the data_source resource, the following permissions are required: - -### Read -```json -quicksight:DescribeDataSource, -quicksight:DescribeDataSourcePermissions, -quicksight:ListTagsForResource -``` - -### Update -```json -quicksight:DescribeDataSource, -quicksight:DescribeDataSourcePermissions, -quicksight:UpdateDataSource, -quicksight:UpdateDataSourcePermissions, -quicksight:TagResource, -quicksight:UntagResource, -quicksight:ListTagsForResource -``` - -### Delete -```json -quicksight:DescribeDataSource, -quicksight:DescribeDataSourcePermissions, -quicksight:DeleteDataSource, -quicksight:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/quicksight/data_sources/index.md b/docs/awscc-docs/providers/awscc/quicksight/data_sources/index.md deleted file mode 100644 index 8c40e98cd5..0000000000 --- a/docs/awscc-docs/providers/awscc/quicksight/data_sources/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -aws_account_id, -data_source_id -FROM awscc.quicksight.data_sources -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the data_sources resource, the following permissions are required: - -### Create -```json -quicksight:CreateDataSource, -quicksight:DescribeDataSource, -quicksight:DescribeDataSourcePermissions, -quicksight:TagResource, -quicksight:ListTagsForResource -``` - -### List -```json -quicksight:DescribeDataSource, -quicksight:ListDataSources -``` - diff --git a/docs/awscc-docs/providers/awscc/quicksight/index.md b/docs/awscc-docs/providers/awscc/quicksight/index.md deleted file mode 100644 index adbdf7e459..0000000000 --- a/docs/awscc-docs/providers/awscc/quicksight/index.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -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 deleted file mode 100644 index 01e7ec5684..0000000000 --- a/docs/awscc-docs/providers/awscc/quicksight/refresh_schedule/index.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -aws_account_id, -data_set_id, -schedule -FROM awscc.quicksight.refresh_schedule -WHERE data__Identifier = '||'; -``` - -## Permissions - -To operate on the refresh_schedule resource, the following permissions are required: - -### Update -```json -quicksight:UpdateRefreshSchedule, -quicksight:DescribeRefreshSchedule -``` - -### Delete -```json -quicksight:DeleteRefreshSchedule, -quicksight:DescribeRefreshSchedule -``` - -### Read -```json -quicksight:DescribeRefreshSchedule -``` - diff --git a/docs/awscc-docs/providers/awscc/quicksight/refresh_schedules/index.md b/docs/awscc-docs/providers/awscc/quicksight/refresh_schedules/index.md deleted file mode 100644 index e35fb27f0b..0000000000 --- a/docs/awscc-docs/providers/awscc/quicksight/refresh_schedules/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -aws_account_id, -data_set_id, -schedule/schedule_id -FROM awscc.quicksight.refresh_schedules -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the refresh_schedules resource, the following permissions are required: - -### Create -```json -quicksight:CreateRefreshSchedule, -quicksight:DescribeRefreshSchedule -``` - -### List -```json -quicksight:ListRefreshSchedules -``` - diff --git a/docs/awscc-docs/providers/awscc/quicksight/template/index.md b/docs/awscc-docs/providers/awscc/quicksight/template/index.md deleted file mode 100644 index d69c474586..0000000000 --- a/docs/awscc-docs/providers/awscc/quicksight/template/index.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the template resource, the following permissions are required: - -### Read -```json -quicksight:DescribeTemplate, -quicksight:DescribeTemplatePermissions, -quicksight:ListTagsForResource -``` - -### Update -```json -quicksight:DescribeTemplate, -quicksight:DescribeTemplatePermissions, -quicksight:UpdateTemplate, -quicksight:UpdateTemplatePermissions, -quicksight:PassDataSet, -quicksight:TagResource, -quicksight:UntagResource, -quicksight:ListTagsForResource -``` - -### Delete -```json -quicksight:DescribeTemplate, -quicksight:DeleteTemplate -``` - diff --git a/docs/awscc-docs/providers/awscc/quicksight/templates/index.md b/docs/awscc-docs/providers/awscc/quicksight/templates/index.md deleted file mode 100644 index be01249129..0000000000 --- a/docs/awscc-docs/providers/awscc/quicksight/templates/index.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -aws_account_id, -template_id -FROM awscc.quicksight.templates -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the templates resource, the following permissions are required: - -### Create -```json -quicksight:DescribeTemplate, -quicksight:DescribeTemplatePermissions, -quicksight:CreateTemplate, -quicksight:DescribeAnalysis, -quicksight:TagResource, -quicksight:UntagResource, -quicksight:ListTagsForResource -``` - -### List -```json -quicksight:ListTemplates -``` - diff --git a/docs/awscc-docs/providers/awscc/quicksight/theme/index.md b/docs/awscc-docs/providers/awscc/quicksight/theme/index.md deleted file mode 100644 index 8fe7f918fb..0000000000 --- a/docs/awscc-docs/providers/awscc/quicksight/theme/index.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the theme resource, the following permissions are required: - -### Read -```json -quicksight:DescribeTheme, -quicksight:DescribeThemePermissions, -quicksight:ListTagsForResource -``` - -### Update -```json -quicksight:DescribeTheme, -quicksight:DescribeThemePermissions, -quicksight:UpdateTheme, -quicksight:UpdateThemePermissions, -quicksight:TagResource, -quicksight:UntagResource, -quicksight:ListTagsForResource -``` - -### Delete -```json -quicksight:DescribeTheme, -quicksight:DeleteTheme -``` - diff --git a/docs/awscc-docs/providers/awscc/quicksight/themes/index.md b/docs/awscc-docs/providers/awscc/quicksight/themes/index.md deleted file mode 100644 index 441fcc13ee..0000000000 --- a/docs/awscc-docs/providers/awscc/quicksight/themes/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -theme_id, -aws_account_id -FROM awscc.quicksight.themes -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the themes resource, the following permissions are required: - -### Create -```json -quicksight:DescribeTheme, -quicksight:DescribeThemePermissions, -quicksight:CreateTheme, -quicksight:TagResource, -quicksight:UntagResource, -quicksight:ListTagsForResource -``` - -### List -```json -quicksight:ListThemes -``` - diff --git a/docs/awscc-docs/providers/awscc/quicksight/topic/index.md b/docs/awscc-docs/providers/awscc/quicksight/topic/index.md deleted file mode 100644 index 280332794c..0000000000 --- a/docs/awscc-docs/providers/awscc/quicksight/topic/index.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -aws_account_id, -data_sets, -description, -name, -topic_id, -user_experience_version -FROM awscc.quicksight.topic -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the topic resource, the following permissions are required: - -### Read -```json -quicksight:DescribeTopic -``` - -### Update -```json -quicksight:UpdateTopic, -quicksight:PassDataSet, -quicksight:DescribeTopicRefresh -``` - -### Delete -```json -quicksight:DeleteTopic -``` - diff --git a/docs/awscc-docs/providers/awscc/quicksight/topics/index.md b/docs/awscc-docs/providers/awscc/quicksight/topics/index.md deleted file mode 100644 index 715e29c808..0000000000 --- a/docs/awscc-docs/providers/awscc/quicksight/topics/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -aws_account_id, -topic_id -FROM awscc.quicksight.topics -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the topics resource, the following permissions are required: - -### Create -```json -quicksight:CreateTopic, -quicksight:PassDataSet, -quicksight:DescribeTopicRefresh -``` - -### List -```json -quicksight:ListTopics -``` - diff --git a/docs/awscc-docs/providers/awscc/quicksight/vpc_connection/index.md b/docs/awscc-docs/providers/awscc/quicksight/vpc_connection/index.md deleted file mode 100644 index e0d61f917e..0000000000 --- a/docs/awscc-docs/providers/awscc/quicksight/vpc_connection/index.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -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
vpc_connection_idstring
vpc_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. - -## Example -```sql -SELECT -region, -arn, -aws_account_id, -name, -vpc_connection_id, -vpc_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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the vpc_connection resource, the following permissions are required: - -### Read -```json -quicksight:DescribeVPCConnection, -quicksight:ListTagsForResource -``` - -### Update -```json -quicksight:DescribeVPCConnection, -quicksight:UpdateVPCConnection, -quicksight:TagResource, -quicksight:UntagResource, -quicksight:ListTagsForResource, -iam:PassRole -``` - -### Delete -```json -quicksight:DescribeVPCConnection, -quicksight:DeleteVPCConnection, -quicksight:ListTagsForResource, -iam:PassRole -``` - diff --git a/docs/awscc-docs/providers/awscc/quicksight/vpc_connections/index.md b/docs/awscc-docs/providers/awscc/quicksight/vpc_connections/index.md deleted file mode 100644 index f78aee3f3d..0000000000 --- a/docs/awscc-docs/providers/awscc/quicksight/vpc_connections/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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
vpc_connection_idundefined
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -aws_account_id, -vpc_connection_id -FROM awscc.quicksight.vpc_connections -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the vpc_connections resource, the following permissions are required: - -### Create -```json -quicksight:CreateVPCConnection, -quicksight:DescribeVPCConnection, -quicksight:ListTagsForResource, -quicksight:TagResource, -iam:PassRole -``` - -### List -```json -quicksight:ListVPCConnections -``` - diff --git a/docs/awscc-docs/providers/awscc/ram/index.md b/docs/awscc-docs/providers/awscc/ram/index.md deleted file mode 100644 index c322cc2600..0000000000 --- a/docs/awscc-docs/providers/awscc/ram/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 deleted file mode 100644 index 2d7289954a..0000000000 --- a/docs/awscc-docs/providers/awscc/ram/permission/index.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -name, -version, -is_resource_type_default, -permission_type, -resource_type, -policy_template, -tags -FROM awscc.ram.permission -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the permission resource, the following permissions are required: - -### Read -```json -ram:GetPermission -``` - -### Update -```json -ram:CreatePermissionVersion, -ram:DeletePermissionVersion, -ram:SetDefaultPermissionVersion, -ram:GetPermission, -ram:ReplacePermissionAssociations, -ram:ListReplacePermissionAssociationsWork, -ram:ListPermissionVersions, -ram:UntagResource, -ram:TagResource -``` - -### Delete -```json -ram:DeletePermissionVersion, -ram:DeletePermission -``` - diff --git a/docs/awscc-docs/providers/awscc/ram/permissions/index.md b/docs/awscc-docs/providers/awscc/ram/permissions/index.md deleted file mode 100644 index 3353c8f01e..0000000000 --- a/docs/awscc-docs/providers/awscc/ram/permissions/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.ram.permissions -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the permissions resource, the following permissions are required: - -### Create -```json -ram:CreatePermission, -ram:TagResource -``` - -### List -```json -ram:ListPermissions, -ram:ListPermissionVersions -``` - 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 deleted file mode 100644 index 2227659bde..0000000000 --- a/docs/awscc-docs/providers/awscc/rds/customdb_engine_version/index.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -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.
kms_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.
db_engine_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. - -## Example -```sql -SELECT -region, -database_installation_files_s3_bucket_name, -database_installation_files_s3_prefix, -description, -engine, -engine_version, -kms_key_id, -manifest, -db_engine_version_arn, -status, -tags -FROM awscc.rds.customdb_engine_version -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the customdb_engine_version resource, the following permissions are required: - -### Read -```json -rds:DescribeDBEngineVersions -``` - -### Update -```json -rds:AddTagsToResource, -rds:DescribeDBEngineVersions, -rds:ModifyCustomDBEngineVersion, -rds:RemoveTagsFromResource -``` - -### Delete -```json -rds:DeleteCustomDBEngineVersion, -rds:DescribeDBEngineVersions -``` - 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 deleted file mode 100644 index 3e7520a673..0000000000 --- a/docs/awscc-docs/providers/awscc/rds/customdb_engine_versions/index.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -engine, -engine_version -FROM awscc.rds.customdb_engine_versions -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the customdb_engine_versions resource, the following permissions are required: - -### Create -```json -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 -```json -rds:DescribeDBEngineVersions -``` - diff --git a/docs/awscc-docs/providers/awscc/rds/db_cluster/index.md b/docs/awscc-docs/providers/awscc/rds/db_cluster/index.md deleted file mode 100644 index 6a82b17e0d..0000000000 --- a/docs/awscc-docs/providers/awscc/rds/db_cluster/index.md +++ /dev/null @@ -1,200 +0,0 @@ ---- -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.
db_cluster_arnstringThe Amazon Resource Name (ARN) for the DB cluster.
db_cluster_instance_classstringThe compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.
db_cluster_resource_idstringThe AWS Region-unique, immutable identifier for the DB cluster.
db_instance_parameter_group_namestringThe name of the DB parameter group to apply to all instances of the DB cluster.
db_system_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.
db_cluster_identifierstringThe DB cluster identifier. This parameter is stored as a lowercase string.
db_cluster_parameter_group_namestringThe name of the DB cluster parameter group to associate with this DB cluster.
db_subnet_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_iam_role_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_iam_database_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. - -## 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, -db_cluster_arn, -db_cluster_instance_class, -db_cluster_resource_id, -db_instance_parameter_group_name, -db_system_id, -global_cluster_identifier, -db_cluster_identifier, -db_cluster_parameter_group_name, -db_subnet_group_name, -deletion_protection, -domain, -domain_iam_role_name, -enable_cloudwatch_logs_exports, -enable_global_write_forwarding, -enable_http_endpoint, -enable_iam_database_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 data__Identifier = ''; -``` - -## Permissions - -To operate on the db_cluster resource, the following permissions are required: - -### Read -```json -rds:DescribeDBClusters -``` - -### Update -```json -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 -```json -rds:CreateDBClusterSnapshot, -rds:DeleteDBCluster, -rds:DeleteDBInstance, -rds:DescribeDBClusters, -rds:DescribeGlobalClusters, -rds:RemoveFromGlobalCluster -``` - 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 deleted file mode 100644 index 20f92a300c..0000000000 --- a/docs/awscc-docs/providers/awscc/rds/db_cluster_parameter_group/index.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -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.
db_cluster_parameter_group_namestring
tagsarrayThe list of tags for the cluster parameter group.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -description, -family, -parameters, -db_cluster_parameter_group_name, -tags -FROM awscc.rds.db_cluster_parameter_group -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the db_cluster_parameter_group resource, the following permissions are required: - -### Read -```json -rds:DescribeDBClusterParameterGroups, -rds:DescribeDBClusterParameters, -rds:DescribeEngineDefaultClusterParameters, -rds:ListTagsForResource -``` - -### Update -```json -rds:AddTagsToResource, -rds:DescribeDBClusterParameterGroups, -rds:DescribeDBClusterParameters, -rds:DescribeDBClusters, -rds:DescribeEngineDefaultClusterParameters, -rds:ListTagsForResource, -rds:ModifyDBClusterParameterGroup, -rds:RemoveTagsFromResource, -rds:ResetDBClusterParameterGroup -``` - -### Delete -```json -rds:DeleteDBClusterParameterGroup -``` - 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 deleted file mode 100644 index a1d7a66b94..0000000000 --- a/docs/awscc-docs/providers/awscc/rds/db_cluster_parameter_groups/index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -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
db_cluster_parameter_group_namestring
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -db_cluster_parameter_group_name -FROM awscc.rds.db_cluster_parameter_groups -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the db_cluster_parameter_groups resource, the following permissions are required: - -### Create -```json -iam:CreateServiceLinkedRole, -rds:AddTagsToResource, -rds:CreateDBClusterParameterGroup, -rds:DescribeDBClusterParameterGroups, -rds:DescribeDBClusterParameters, -rds:DescribeDBClusters, -rds:DescribeEngineDefaultClusterParameters, -rds:ListTagsForResource, -rds:ModifyDBClusterParameterGroup, -rds:RemoveTagsFromResource -``` - -### List -```json -rds:DescribeDBClusterParameterGroups -``` - diff --git a/docs/awscc-docs/providers/awscc/rds/db_clusters/index.md b/docs/awscc-docs/providers/awscc/rds/db_clusters/index.md deleted file mode 100644 index 6c26c247f4..0000000000 --- a/docs/awscc-docs/providers/awscc/rds/db_clusters/index.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -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
db_cluster_identifierstringThe DB cluster identifier. This parameter is stored as a lowercase string.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -db_cluster_identifier -FROM awscc.rds.db_clusters -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the db_clusters resource, the following permissions are required: - -### Create -```json -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 -```json -rds:DescribeDBClusters -``` - diff --git a/docs/awscc-docs/providers/awscc/rds/db_instance/index.md b/docs/awscc-docs/providers/awscc/rds/db_instance/index.md deleted file mode 100644 index 19aadaf89b..0000000000 --- a/docs/awscc-docs/providers/awscc/rds/db_instance/index.md +++ /dev/null @@ -1,258 +0,0 @@ ---- -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
ca_certificate_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_iam_instance_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*.
db_cluster_identifierstringThe identifier of the DB cluster that the instance will belong to.
db_cluster_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.
db_instance_arnstring
db_instance_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/).
db_instance_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
db_namestringThe 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
db_parameter_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.
db_security_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/> +
db_snapshot_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
db_subnet_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.
db_system_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_iam_role_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_iam_database_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_kms_key_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.
vpc_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. - -## 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, -ca_certificate_identifier, -certificate_details, -certificate_rotation_restart, -character_set_name, -copy_tags_to_snapshot, -custom_iam_instance_profile, -db_cluster_identifier, -db_cluster_snapshot_identifier, -db_instance_arn, -db_instance_class, -db_instance_identifier, -dbi_resource_id, -db_name, -db_parameter_group_name, -db_security_groups, -db_snapshot_identifier, -db_subnet_group_name, -db_system_id, -dedicated_log_volume, -delete_automated_backups, -deletion_protection, -domain, -domain_auth_secret_arn, -domain_dns_ips, -domain_fqdn, -domain_iam_role_name, -domain_ou, -enable_cloudwatch_logs_exports, -enable_iam_database_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_kms_key_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, -vpc_security_groups -FROM awscc.rds.db_instance -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the db_instance resource, the following permissions are required: - -### Read -```json -ec2:DescribeAccountAttributes, -ec2:DescribeAvailabilityZones, -ec2:DescribeInternetGateways, -ec2:DescribeSecurityGroups, -ec2:DescribeSubnets, -ec2:DescribeVpcAttribute, -ec2:DescribeVpcs, -rds:DescribeDBInstances -``` - -### Update -```json -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 -```json -rds:CreateDBSnapshot, -rds:DeleteDBInstance, -rds:DescribeDBInstances -``` - diff --git a/docs/awscc-docs/providers/awscc/rds/db_instances/index.md b/docs/awscc-docs/providers/awscc/rds/db_instances/index.md deleted file mode 100644 index afd95c16cb..0000000000 --- a/docs/awscc-docs/providers/awscc/rds/db_instances/index.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -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
db_instance_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. - -## Example -```sql -SELECT -region, -db_instance_identifier -FROM awscc.rds.db_instances -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the db_instances resource, the following permissions are required: - -### Create -```json -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 -```json -rds:DescribeDBInstances -``` - 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 deleted file mode 100644 index a23c098108..0000000000 --- a/docs/awscc-docs/providers/awscc/rds/db_parameter_group/index.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -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
db_parameter_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. - -## Example -```sql -SELECT -region, -db_parameter_group_name, -description, -family, -parameters, -tags -FROM awscc.rds.db_parameter_group -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the db_parameter_group resource, the following permissions are required: - -### Read -```json -rds:DescribeDBParameterGroups, -rds:DescribeDBParameters, -rds:DescribeEngineDefaultParameters, -rds:ListTagsForResource -``` - -### Update -```json -rds:AddTagsToResource, -rds:DescribeDBParameterGroups, -rds:DescribeDBParameters, -rds:DescribeEngineDefaultParameters, -rds:ListTagsForResource, -rds:ModifyDBParameterGroup, -rds:ResetDBParameterGroup, -rds:RemoveTagsFromResource -``` - -### Delete -```json -rds:DeleteDBParameterGroup -``` - 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 deleted file mode 100644 index cba055ffbd..0000000000 --- a/docs/awscc-docs/providers/awscc/rds/db_parameter_groups/index.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -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
db_parameter_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. - -## Example -```sql -SELECT -region, -db_parameter_group_name -FROM awscc.rds.db_parameter_groups -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the db_parameter_groups resource, the following permissions are required: - -### Create -```json -iam:CreateServiceLinkedRole, -rds:AddTagsToResource, -rds:CreateDBParameterGroup, -rds:DescribeDBParameterGroups, -rds:DescribeDBParameters, -rds:DescribeEngineDefaultParameters, -rds:ListTagsForResource, -rds:ModifyDBParameterGroup, -rds:RemoveTagsFromResource -``` - -### List -```json -rds:DescribeDBParameterGroups -``` - diff --git a/docs/awscc-docs/providers/awscc/rds/db_proxies/index.md b/docs/awscc-docs/providers/awscc/rds/db_proxies/index.md deleted file mode 100644 index e01aaa71dd..0000000000 --- a/docs/awscc-docs/providers/awscc/rds/db_proxies/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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
db_proxy_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. - -## Example -```sql -SELECT -region, -db_proxy_name -FROM awscc.rds.db_proxies -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the db_proxies resource, the following permissions are required: - -### Create -```json -rds:CreateDBProxy, -rds:DescribeDBProxies, -iam:PassRole -``` - -### List -```json -rds:DescribeDBProxies -``` - diff --git a/docs/awscc-docs/providers/awscc/rds/db_proxy/index.md b/docs/awscc-docs/providers/awscc/rds/db_proxy/index.md deleted file mode 100644 index 2ad863b75b..0000000000 --- a/docs/awscc-docs/providers/awscc/rds/db_proxy/index.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -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.
db_proxy_arnstringThe Amazon Resource Name (ARN) for the proxy.
db_proxy_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_tlsbooleanA 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. - -## Example -```sql -SELECT -region, -auth, -db_proxy_arn, -db_proxy_name, -debug_logging, -endpoint, -engine_family, -idle_client_timeout, -require_tls, -role_arn, -tags, -vpc_id, -vpc_security_group_ids, -vpc_subnet_ids -FROM awscc.rds.db_proxy -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the db_proxy resource, the following permissions are required: - -### Read -```json -rds:DescribeDBProxies -``` - -### Update -```json -rds:ModifyDBProxy, -rds:AddTagsToResource, -rds:RemoveTagsFromResource, -iam:PassRole -``` - -### Delete -```json -rds:DescribeDBProxies, -rds:DeleteDBProxy -``` - 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 deleted file mode 100644 index c5f35a6f3d..0000000000 --- a/docs/awscc-docs/providers/awscc/rds/db_proxy_endpoint/index.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -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
db_proxy_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.
db_proxy_endpoint_arnstringThe Amazon Resource Name (ARN) for the DB proxy endpoint.
db_proxy_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. - -## Example -```sql -SELECT -region, -db_proxy_endpoint_name, -db_proxy_endpoint_arn, -db_proxy_name, -vpc_id, -vpc_security_group_ids, -vpc_subnet_ids, -endpoint, -target_role, -is_default, -tags -FROM awscc.rds.db_proxy_endpoint -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the db_proxy_endpoint resource, the following permissions are required: - -### Read -```json -rds:DescribeDBProxyEndpoints, -rds:ListTagsForResource -``` - -### Update -```json -rds:ModifyDBProxyEndpoint, -rds:AddTagsToResource, -rds:RemoveTagsFromResource -``` - -### Delete -```json -rds:DescribeDBProxyEndpoints, -rds:DeleteDBProxyEndpoint -``` - 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 deleted file mode 100644 index 743c965f16..0000000000 --- a/docs/awscc-docs/providers/awscc/rds/db_proxy_endpoints/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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
db_proxy_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. - -## Example -```sql -SELECT -region, -db_proxy_endpoint_name -FROM awscc.rds.db_proxy_endpoints -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the db_proxy_endpoints resource, the following permissions are required: - -### Create -```json -rds:CreateDBProxyEndpoint, -rds:DescribeDBProxyEndpoints -``` - -### List -```json -rds:DescribeDBProxyEndpoints -``` - 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 deleted file mode 100644 index aa4eacce77..0000000000 --- a/docs/awscc-docs/providers/awscc/rds/db_proxy_target_group/index.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -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
db_proxy_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
db_instance_identifiersarray
db_cluster_identifiersarray
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -db_proxy_name, -target_group_arn, -target_group_name, -connection_pool_configuration_info, -db_instance_identifiers, -db_cluster_identifiers -FROM awscc.rds.db_proxy_target_group -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the db_proxy_target_group resource, the following permissions are required: - -### Read -```json -rds:DescribeDBProxyTargetGroups, -rds:DescribeDBProxyTargets -``` - -### Update -```json -rds:DescribeDBProxyTargetGroups, -rds:ModifyDBProxyTargetGroup, -rds:RegisterDBProxyTargets, -rds:DeregisterDBProxyTargets -``` - -### Delete -```json -rds:DeregisterDBProxyTargets -``` - 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 deleted file mode 100644 index 052441c2c9..0000000000 --- a/docs/awscc-docs/providers/awscc/rds/db_proxy_target_groups/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -target_group_arn -FROM awscc.rds.db_proxy_target_groups -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the db_proxy_target_groups resource, the following permissions are required: - -### Create -```json -rds:DescribeDBProxies, -rds:DescribeDBProxyTargetGroups, -rds:ModifyDBProxyTargetGroup, -rds:RegisterDBProxyTargets -``` - -### List -```json -rds:DescribeDBProxyTargetGroups -``` - 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 deleted file mode 100644 index a13bca48b1..0000000000 --- a/docs/awscc-docs/providers/awscc/rds/db_subnet_group/index.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -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
db_subnet_group_descriptionstringThe description for the DB subnet group.
db_subnet_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. - -## Example -```sql -SELECT -region, -db_subnet_group_description, -db_subnet_group_name, -subnet_ids, -tags -FROM awscc.rds.db_subnet_group -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the db_subnet_group resource, the following permissions are required: - -### Read -```json -rds:DescribeDBSubnetGroups, -rds:ListTagsForResource -``` - -### Update -```json -rds:ModifyDBSubnetGroup, -rds:DescribeDBSubnetGroups, -rds:AddTagsToResource, -rds:RemoveTagsFromResource, -rds:ListTagsForResource -``` - -### Delete -```json -rds:DeleteDBSubnetGroup, -rds:DescribeDBSubnetGroups, -rds:ListTagsForResource -``` - 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 deleted file mode 100644 index 53b76a8b37..0000000000 --- a/docs/awscc-docs/providers/awscc/rds/db_subnet_groups/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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
db_subnet_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. - -## Example -```sql -SELECT -region, -db_subnet_group_name -FROM awscc.rds.db_subnet_groups -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the db_subnet_groups resource, the following permissions are required: - -### Create -```json -iam:CreateServiceLinkedRole, -rds:CreateDBSubnetGroup, -rds:DescribeDBSubnetGroups, -rds:AddTagsToResource, -rds:RemoveTagsFromResource, -rds:ListTagsForResource -``` - -### List -```json -rds:DescribeDBSubnetGroups -``` - diff --git a/docs/awscc-docs/providers/awscc/rds/event_subscription/index.md b/docs/awscc-docs/providers/awscc/rds/event_subscription/index.md deleted file mode 100644 index f36814ff46..0000000000 --- a/docs/awscc-docs/providers/awscc/rds/event_subscription/index.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -tags, -subscription_name, -enabled, -event_categories, -sns_topic_arn, -source_ids, -source_type -FROM awscc.rds.event_subscription -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the event_subscription resource, the following permissions are required: - -### Read -```json -rds:DescribeEventSubscriptions, -rds:ListTagsForResource -``` - -### Update -```json -rds:ModifyEventSubscription, -rds:AddSourceIdentifierToSubscription, -rds:RemoveSourceIdentifierFromSubscription, -rds:DescribeEventSubscriptions, -rds:ListTagsForResource, -rds:AddTagsToResource, -rds:RemoveTagsFromResource -``` - -### Delete -```json -rds:DeleteEventSubscription, -rds:DescribeEventSubscriptions -``` - diff --git a/docs/awscc-docs/providers/awscc/rds/event_subscriptions/index.md b/docs/awscc-docs/providers/awscc/rds/event_subscriptions/index.md deleted file mode 100644 index 14ea688c76..0000000000 --- a/docs/awscc-docs/providers/awscc/rds/event_subscriptions/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -subscription_name -FROM awscc.rds.event_subscriptions -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the event_subscriptions resource, the following permissions are required: - -### Create -```json -iam:CreateServiceLinkedRole, -rds:CreateEventSubscription, -rds:DescribeEventSubscriptions, -rds:ListTagsForResource, -rds:AddTagsToResource, -rds:RemoveTagsFromResource -``` - -### List -```json -rds:DescribeEventSubscriptions -``` - diff --git a/docs/awscc-docs/providers/awscc/rds/global_cluster/index.md b/docs/awscc-docs/providers/awscc/rds/global_cluster/index.md deleted file mode 100644 index 02c66a6fc1..0000000000 --- a/docs/awscc-docs/providers/awscc/rds/global_cluster/index.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -engine, -engine_version, -deletion_protection, -global_cluster_identifier, -source_db_cluster_identifier, -storage_encrypted -FROM awscc.rds.global_cluster -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the global_cluster resource, the following permissions are required: - -### Read -```json -rds:DescribeGlobalClusters -``` - -### Update -```json -rds:ModifyGlobalCluster, -rds:DescribeGlobalClusters -``` - -### Delete -```json -rds:DescribeGlobalClusters, -rds:DeleteGlobalCluster, -rds:RemoveFromGlobalCluster, -rds:DescribeDBClusters -``` - diff --git a/docs/awscc-docs/providers/awscc/rds/global_clusters/index.md b/docs/awscc-docs/providers/awscc/rds/global_clusters/index.md deleted file mode 100644 index 8725635061..0000000000 --- a/docs/awscc-docs/providers/awscc/rds/global_clusters/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -global_cluster_identifier -FROM awscc.rds.global_clusters -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the global_clusters resource, the following permissions are required: - -### Create -```json -rds:CreateGlobalCluster, -rds:DescribeDBClusters, -rds:DescribeGlobalClusters -``` - -### List -```json -rds:DescribeGlobalClusters -``` - diff --git a/docs/awscc-docs/providers/awscc/rds/index.md b/docs/awscc-docs/providers/awscc/rds/index.md deleted file mode 100644 index 3455945033..0000000000 --- a/docs/awscc-docs/providers/awscc/rds/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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 deleted file mode 100644 index c73081b2d2..0000000000 --- a/docs/awscc-docs/providers/awscc/rds/integration/index.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -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.
kms_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. - -## Example -```sql -SELECT -region, -integration_name, -tags, -source_arn, -target_arn, -integration_arn, -kms_key_id, -additional_encryption_context, -create_time -FROM awscc.rds.integration -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the integration resource, the following permissions are required: - -### Read -```json -rds:DescribeIntegrations -``` - -### Update -```json -rds:DescribeIntegrations, -rds:AddTagsToResource, -rds:RemoveTagsFromResource -``` - -### Delete -```json -rds:DeleteIntegration, -rds:DescribeIntegrations -``` - diff --git a/docs/awscc-docs/providers/awscc/rds/integrations/index.md b/docs/awscc-docs/providers/awscc/rds/integrations/index.md deleted file mode 100644 index 2570f0d25f..0000000000 --- a/docs/awscc-docs/providers/awscc/rds/integrations/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -integration_arn -FROM awscc.rds.integrations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the integrations resource, the following permissions are required: - -### Create -```json -rds:CreateIntegration, -rds:DescribeIntegrations, -rds:AddTagsToResource, -kms:CreateGrant, -kms:DescribeKey, -redshift:CreateInboundIntegration -``` - -### List -```json -rds:DescribeIntegrations -``` - diff --git a/docs/awscc-docs/providers/awscc/rds/option_group/index.md b/docs/awscc-docs/providers/awscc/rds/option_group/index.md deleted file mode 100644 index 22deba2009..0000000000 --- a/docs/awscc-docs/providers/awscc/rds/option_group/index.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -option_group_name, -option_group_description, -engine_name, -major_engine_version, -option_configurations, -tags -FROM awscc.rds.option_group -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the option_group resource, the following permissions are required: - -### Read -```json -rds:DescribeOptionGroups, -rds:ListTagsForResource -``` - -### Update -```json -rds:AddTagsToResource, -rds:DescribeOptionGroups, -rds:ListTagsForResource, -rds:ModifyOptionGroup, -rds:RemoveTagsFromResource -``` - -### Delete -```json -rds:DeleteOptionGroup, -rds:DescribeOptionGroups, -rds:ListTagsForResource, -rds:RemoveTagsFromResource -``` - diff --git a/docs/awscc-docs/providers/awscc/rds/option_groups/index.md b/docs/awscc-docs/providers/awscc/rds/option_groups/index.md deleted file mode 100644 index 1c721338e1..0000000000 --- a/docs/awscc-docs/providers/awscc/rds/option_groups/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -option_group_name -FROM awscc.rds.option_groups -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the option_groups resource, the following permissions are required: - -### Create -```json -iam:CreateServiceLinkedRole, -rds:AddTagsToResource, -rds:CreateOptionGroup, -rds:DescribeOptionGroups, -rds:ListTagsForResource, -rds:ModifyOptionGroup, -rds:RemoveTagsFromResource -``` - -### List -```json -rds:DescribeOptionGroups -``` - diff --git a/docs/awscc-docs/providers/awscc/redshift/cluster/index.md b/docs/awscc-docs/providers/awscc/redshift/cluster/index.md deleted file mode 100644 index e1a4b35eb9..0000000000 --- a/docs/awscc-docs/providers/awscc/redshift/cluster/index.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -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.
db_namestringThe 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. - -## 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, -db_name, -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 data__Identifier = ''; -``` - -## Permissions - -To operate on the cluster resource, the following permissions are required: - -### Read -```json -redshift:DescribeClusters, -redshift:DescribeLoggingStatus, -redshift:DescribeSnapshotCopyGrant, -redshift:DescribeClusterDbRevisions, -redshift:DescribeTags, -redshift:GetResourcePolicy -``` - -### Update -```json -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 -```json -redshift:DescribeTags, -redshift:DescribeClusters, -redshift:DeleteCluster -``` - 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 deleted file mode 100644 index 324a90298c..0000000000 --- a/docs/awscc-docs/providers/awscc/redshift/cluster_parameter_group/index.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -parameter_group_name, -description, -parameter_group_family, -parameters, -tags -FROM awscc.redshift.cluster_parameter_group -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the cluster_parameter_group resource, the following permissions are required: - -### Read -```json -redshift:DescribeClusterParameterGroups, -initech:DescribeReport, -redshift:DescribeClusterParameters, -redshift:DescribeTags -``` - -### Update -```json -redshift:DescribeClusterParameterGroups, -redshift:ResetClusterParameterGroup, -redshift:ModifyClusterParameterGroup, -redshift:DescribeClusterParameters, -redshift:DescribeTags, -redshift:CreateTags, -redshift:DeleteTags, -initech:UpdateReport -``` - -### Delete -```json -redshift:DescribeTags, -redshift:DescribeClusterParameterGroups, -redshift:DeleteClusterParameterGroup, -redshift:DescribeClusterParameters, -initech:DeleteReport -``` - 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 deleted file mode 100644 index 97597f8838..0000000000 --- a/docs/awscc-docs/providers/awscc/redshift/cluster_parameter_groups/index.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -parameter_group_name -FROM awscc.redshift.cluster_parameter_groups -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the cluster_parameter_groups resource, the following permissions are required: - -### Create -```json -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 -```json -redshift:DescribeTags, -redshift:DescribeClusterParameterGroups, -redshift:DescribeClusterParameters, -initech:ListReports -``` - 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 deleted file mode 100644 index 816fd91851..0000000000 --- a/docs/awscc-docs/providers/awscc/redshift/cluster_subnet_group/index.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -description, -subnet_ids, -tags, -cluster_subnet_group_name -FROM awscc.redshift.cluster_subnet_group -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the cluster_subnet_group resource, the following permissions are required: - -### Read -```json -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 -```json -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 -```json -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 -``` - 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 deleted file mode 100644 index 8022d6f054..0000000000 --- a/docs/awscc-docs/providers/awscc/redshift/cluster_subnet_groups/index.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -cluster_subnet_group_name -FROM awscc.redshift.cluster_subnet_groups -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the cluster_subnet_groups resource, the following permissions are required: - -### Create -```json -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 -```json -redshift:DescribeClusterSubnetGroups, -redshift:DescribeTags, -ec2:AllocateAddress, -ec2:AssociateAddress, -ec2:AttachNetworkInterface, -ec2:DescribeAccountAttributes, -ec2:DescribeAddresses, -ec2:DescribeAvailabilityZones, -ec2:DescribeInternetGateways, -ec2:DescribeSecurityGroups, -ec2:DescribeSubnets, -ec2:DescribeVpcs -``` - diff --git a/docs/awscc-docs/providers/awscc/redshift/clusters/index.md b/docs/awscc-docs/providers/awscc/redshift/clusters/index.md deleted file mode 100644 index 7f85c6e9f4..0000000000 --- a/docs/awscc-docs/providers/awscc/redshift/clusters/index.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -cluster_identifier -FROM awscc.redshift.clusters -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the clusters resource, the following permissions are required: - -### Create -```json -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 -```json -redshift:DescribeTags, -redshift:DescribeClusters -``` - diff --git a/docs/awscc-docs/providers/awscc/redshift/endpoint_access/index.md b/docs/awscc-docs/providers/awscc/redshift/endpoint_access/index.md deleted file mode 100644 index 6d47dc5bd5..0000000000 --- a/docs/awscc-docs/providers/awscc/redshift/endpoint_access/index.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the endpoint_access resource, the following permissions are required: - -### Read -```json -redshift:DescribeEndpointAccess, -ec2:DescribeClientVpnEndpoints, -ec2:DescribeVpcEndpoint, -ec2:DescribeVpcAttribute, -ec2:DescribeSecurityGroups, -ec2:DescribeAddresses, -ec2:DescribeInternetGateways, -ec2:DescribeSubnets -``` - -### Update -```json -redshift:DescribeEndpointAccess, -redshift:ModifyEndpointAccess, -ec2:ModifyClientVpnEndpoint, -ec2:ModifyVpcEndpoint, -ec2:DescribeVpcAttribute, -ec2:DescribeSecurityGroups, -ec2:DescribeAddresses, -ec2:DescribeInternetGateways, -ec2:DescribeSubnets -``` - -### Delete -```json -redshift:DeleteEndpointAccess, -redshift:DescribeEndpointAccess, -ec2:DeleteClientVpnEndpoint, -ec2:DeleteVpcEndpoint, -ec2:DescribeVpcAttribute, -ec2:DescribeSecurityGroups, -ec2:DescribeAddresses, -ec2:DescribeInternetGateways, -ec2:DescribeSubnets, -ec2:DescribeVpcEndpoint -``` - diff --git a/docs/awscc-docs/providers/awscc/redshift/endpoint_accesses/index.md b/docs/awscc-docs/providers/awscc/redshift/endpoint_accesses/index.md deleted file mode 100644 index eee54f1655..0000000000 --- a/docs/awscc-docs/providers/awscc/redshift/endpoint_accesses/index.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -endpoint_name -FROM awscc.redshift.endpoint_accesses -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the endpoint_accesses resource, the following permissions are required: - -### Create -```json -redshift:CreateEndpointAccess, -redshift:DescribeEndpointAccess, -ec2:CreateClientVpnEndpoint, -ec2:CreateVpcEndpoint, -ec2:DescribeVpcAttribute, -ec2:DescribeSecurityGroups, -ec2:DescribeAddresses, -ec2:DescribeInternetGateways, -ec2:DescribeSubnets -``` - -### List -```json -redshift:DescribeEndpointAccess, -ec2:DescribeClientVpnEndpoints, -ec2:DescribeVpcEndpoints, -ec2:DescribeVpcAttribute, -ec2:DescribeSecurityGroups, -ec2:DescribeAddresses, -ec2:DescribeInternetGateways, -ec2:DescribeSubnets -``` - diff --git a/docs/awscc-docs/providers/awscc/redshift/endpoint_authorization/index.md b/docs/awscc-docs/providers/awscc/redshift/endpoint_authorization/index.md deleted file mode 100644 index 4df70c00d3..0000000000 --- a/docs/awscc-docs/providers/awscc/redshift/endpoint_authorization/index.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -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_vpcsbooleanIndicates whether all VPCs in the grantee account are allowed access to the cluster.
allowed_vpcsarrayThe 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. - -## Example -```sql -SELECT -region, -grantor, -grantee, -cluster_identifier, -authorize_time, -cluster_status, -status, -allowed_all_vpcs, -allowed_vpcs, -endpoint_count, -account, -vpc_ids, -force -FROM awscc.redshift.endpoint_authorization -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the endpoint_authorization resource, the following permissions are required: - -### Read -```json -redshift:DescribeEndpointAuthorization -``` - -### Update -```json -redshift:AuthorizeEndpointAccess, -redshift:DescribeEndpointAuthorization, -redshift:RevokeEndpointAccess -``` - -### Delete -```json -redshift:RevokeEndpointAccess, -redshift:DeleteEndpointAccess, -redshift:DescribeEndpointAuthorization, -ec2:DeleteClientVpnEndpoint, -ec2:DescribeVpcAttribute, -ec2:DescribeSecurityGroups, -ec2:DescribeAddresses, -ec2:DescribeInternetGateways, -ec2:DescribeSubnets -``` - diff --git a/docs/awscc-docs/providers/awscc/redshift/endpoint_authorizations/index.md b/docs/awscc-docs/providers/awscc/redshift/endpoint_authorizations/index.md deleted file mode 100644 index 6d6ef9e8cb..0000000000 --- a/docs/awscc-docs/providers/awscc/redshift/endpoint_authorizations/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -cluster_identifier, -account -FROM awscc.redshift.endpoint_authorizations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the endpoint_authorizations resource, the following permissions are required: - -### Create -```json -redshift:AuthorizeEndpointAccess, -redshift:DescribeEndpointAuthorization -``` - -### List -```json -redshift:DescribeEndpointAuthorization -``` - diff --git a/docs/awscc-docs/providers/awscc/redshift/event_subscription/index.md b/docs/awscc-docs/providers/awscc/redshift/event_subscription/index.md deleted file mode 100644 index 7ddfb1ee0a..0000000000 --- a/docs/awscc-docs/providers/awscc/redshift/event_subscription/index.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the event_subscription resource, the following permissions are required: - -### Read -```json -redshift:DescribeEventSubscriptions, -redshift:DescribeTags -``` - -### Update -```json -redshift:ModifyEventSubscription, -redshift:CreateTags, -redshift:DescribeTags, -redshift:DescribeEventSubscriptions, -redshift:DeleteTags -``` - -### Delete -```json -redshift:DescribeEventSubscriptions, -redshift:DeleteEventSubscription, -redshift:DescribeTags, -redshift:DeleteTags -``` - diff --git a/docs/awscc-docs/providers/awscc/redshift/event_subscriptions/index.md b/docs/awscc-docs/providers/awscc/redshift/event_subscriptions/index.md deleted file mode 100644 index 2825e99ba8..0000000000 --- a/docs/awscc-docs/providers/awscc/redshift/event_subscriptions/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -subscription_name -FROM awscc.redshift.event_subscriptions -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the event_subscriptions resource, the following permissions are required: - -### Create -```json -redshift:CreateEventSubscription, -redshift:CreateTags, -redshift:DescribeTags, -redshift:DescribeEventSubscriptions -``` - -### List -```json -redshift:DescribeTags, -redshift:DescribeEventSubscriptions -``` - diff --git a/docs/awscc-docs/providers/awscc/redshift/index.md b/docs/awscc-docs/providers/awscc/redshift/index.md deleted file mode 100644 index 46cb6cc67d..0000000000 --- a/docs/awscc-docs/providers/awscc/redshift/index.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -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 deleted file mode 100644 index c25e2c7c10..0000000000 --- a/docs/awscc-docs/providers/awscc/redshift/scheduled_action/index.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the scheduled_action resource, the following permissions are required: - -### Read -```json -redshift:DescribeScheduledActions, -redshift:DescribeTags -``` - -### Update -```json -redshift:DescribeScheduledActions, -redshift:ModifyScheduledAction, -redshift:PauseCluster, -redshift:ResumeCluster, -redshift:ResizeCluster, -redshift:DescribeTags, -iam:PassRole -``` - -### Delete -```json -redshift:DescribeTags, -redshift:DescribeScheduledActions, -redshift:DeleteScheduledAction -``` - diff --git a/docs/awscc-docs/providers/awscc/redshift/scheduled_actions/index.md b/docs/awscc-docs/providers/awscc/redshift/scheduled_actions/index.md deleted file mode 100644 index cfc3cf2043..0000000000 --- a/docs/awscc-docs/providers/awscc/redshift/scheduled_actions/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -scheduled_action_name -FROM awscc.redshift.scheduled_actions -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the scheduled_actions resource, the following permissions are required: - -### Create -```json -redshift:CreateScheduledAction, -redshift:DescribeScheduledActions, -redshift:DescribeTags, -redshift:PauseCluster, -redshift:ResumeCluster, -redshift:ResizeCluster, -iam:PassRole -``` - -### List -```json -redshift:DescribeTags, -redshift:DescribeScheduledActions -``` - diff --git a/docs/awscc-docs/providers/awscc/redshiftserverless/index.md b/docs/awscc-docs/providers/awscc/redshiftserverless/index.md deleted file mode 100644 index ee37f76562..0000000000 --- a/docs/awscc-docs/providers/awscc/redshiftserverless/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index 1729d0573b..0000000000 --- a/docs/awscc-docs/providers/awscc/redshiftserverless/namespace/index.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the namespace resource, the following permissions are required: - -### Read -```json -iam:PassRole, -redshift-serverless:GetNamespace, -redshift:GetResourcePolicy, -redshift-serverless:ListSnapshotCopyConfigurations -``` - -### Update -```json -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 -```json -iam:PassRole, -redshift-serverless:DeleteNamespace, -redshift-serverless:GetNamespace, -kms:RetireGrant, -secretsmanager:DescribeSecret, -secretsmanager:DeleteSecret, -redshift:DeleteResourcePolicy -``` - diff --git a/docs/awscc-docs/providers/awscc/redshiftserverless/namespaces/index.md b/docs/awscc-docs/providers/awscc/redshiftserverless/namespaces/index.md deleted file mode 100644 index 37b0242278..0000000000 --- a/docs/awscc-docs/providers/awscc/redshiftserverless/namespaces/index.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -namespace_name -FROM awscc.redshiftserverless.namespaces -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the namespaces resource, the following permissions are required: - -### Create -```json -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 -```json -iam:PassRole, -redshift-serverless:ListNamespaces -``` - diff --git a/docs/awscc-docs/providers/awscc/redshiftserverless/workgroup/index.md b/docs/awscc-docs/providers/awscc/redshiftserverless/workgroup/index.md deleted file mode 100644 index bd9c9b9e44..0000000000 --- a/docs/awscc-docs/providers/awscc/redshiftserverless/workgroup/index.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the workgroup resource, the following permissions are required: - -### Read -```json -ec2:DescribeVpcAttribute, -ec2:DescribeSecurityGroups, -ec2:DescribeAddresses, -ec2:DescribeInternetGateways, -ec2:DescribeSubnets, -ec2:DescribeAccountAttributes, -ec2:DescribeAvailabilityZones, -redshift-serverless:GetWorkgroup -``` - -### Update -```json -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 -```json -ec2:DescribeVpcAttribute, -ec2:DescribeSecurityGroups, -ec2:DescribeAddresses, -ec2:DescribeInternetGateways, -ec2:DescribeSubnets, -ec2:DescribeAccountAttributes, -ec2:DescribeAvailabilityZones, -redshift-serverless:GetWorkgroup, -redshift-serverless:DeleteWorkgroup -``` - diff --git a/docs/awscc-docs/providers/awscc/redshiftserverless/workgroups/index.md b/docs/awscc-docs/providers/awscc/redshiftserverless/workgroups/index.md deleted file mode 100644 index 10a385708f..0000000000 --- a/docs/awscc-docs/providers/awscc/redshiftserverless/workgroups/index.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -workgroup_name -FROM awscc.redshiftserverless.workgroups -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the workgroups resource, the following permissions are required: - -### Create -```json -ec2:DescribeVpcAttribute, -ec2:DescribeSecurityGroups, -ec2:DescribeAddresses, -ec2:DescribeInternetGateways, -ec2:DescribeSubnets, -ec2:DescribeAccountAttributes, -ec2:DescribeAvailabilityZones, -redshift-serverless:CreateNamespace, -redshift-serverless:CreateWorkgroup, -redshift-serverless:GetWorkgroup -``` - -### List -```json -ec2:DescribeVpcAttribute, -ec2:DescribeSecurityGroups, -ec2:DescribeAddresses, -ec2:DescribeInternetGateways, -ec2:DescribeSubnets, -ec2:DescribeAccountAttributes, -ec2:DescribeAvailabilityZones, -redshift-serverless:ListWorkgroups -``` - diff --git a/docs/awscc-docs/providers/awscc/refactorspaces/application/index.md b/docs/awscc-docs/providers/awscc/refactorspaces/application/index.md deleted file mode 100644 index 8ee63afd93..0000000000 --- a/docs/awscc-docs/providers/awscc/refactorspaces/application/index.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the application resource, the following permissions are required: - -### Read -```json -refactor-spaces:GetApplication, -refactor-spaces:ListTagsForResource -``` - -### Delete -```json -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* -``` - diff --git a/docs/awscc-docs/providers/awscc/refactorspaces/applications/index.md b/docs/awscc-docs/providers/awscc/refactorspaces/applications/index.md deleted file mode 100644 index 285b496f49..0000000000 --- a/docs/awscc-docs/providers/awscc/refactorspaces/applications/index.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -environment_identifier, -application_identifier -FROM awscc.refactorspaces.applications -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the applications resource, the following permissions are required: - -### Create -```json -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 -```json -refactor-spaces:ListApplications, -refactor-spaces:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/refactorspaces/environment/index.md b/docs/awscc-docs/providers/awscc/refactorspaces/environment/index.md deleted file mode 100644 index 8888de9ea7..0000000000 --- a/docs/awscc-docs/providers/awscc/refactorspaces/environment/index.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -description, -environment_identifier, -name, -network_fabric_type, -arn, -transit_gateway_id, -tags -FROM awscc.refactorspaces.environment -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the environment resource, the following permissions are required: - -### Read -```json -refactor-spaces:GetEnvironment, -refactor-spaces:ListTagsForResource -``` - -### Delete -```json -refactor-spaces:GetEnvironment, -refactor-spaces:DeleteEnvironment, -refactor-spaces:UntagResource, -ec2:DescribeTransitGateways, -ec2:DescribeTransitGatewayVpcAttachments, -ec2:DeleteTransitGateway, -ec2:DeleteTransitGatewayVpcAttachment, -ec2:DeleteTags, -ram:GetResourceShareAssociations, -ram:DeleteResourceShare -``` - diff --git a/docs/awscc-docs/providers/awscc/refactorspaces/environments/index.md b/docs/awscc-docs/providers/awscc/refactorspaces/environments/index.md deleted file mode 100644 index 513e14f399..0000000000 --- a/docs/awscc-docs/providers/awscc/refactorspaces/environments/index.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -environment_identifier -FROM awscc.refactorspaces.environments -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the environments resource, the following permissions are required: - -### Create -```json -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 -```json -refactor-spaces:ListEnvironments, -refactor-spaces:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/refactorspaces/index.md b/docs/awscc-docs/providers/awscc/refactorspaces/index.md deleted file mode 100644 index 039d404210..0000000000 --- a/docs/awscc-docs/providers/awscc/refactorspaces/index.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -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 deleted file mode 100644 index e2ebce0f2b..0000000000 --- a/docs/awscc-docs/providers/awscc/refactorspaces/route/index.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -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. - -## 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 data__Identifier = '||'; -``` - -## Permissions - -To operate on the route resource, the following permissions are required: - -### Read -```json -refactor-spaces:GetRoute, -refactor-spaces:ListTagsForResource -``` - -### Delete -```json -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 -```json -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 -``` - diff --git a/docs/awscc-docs/providers/awscc/refactorspaces/routes/index.md b/docs/awscc-docs/providers/awscc/refactorspaces/routes/index.md deleted file mode 100644 index a7e354a1d7..0000000000 --- a/docs/awscc-docs/providers/awscc/refactorspaces/routes/index.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -environment_identifier, -application_identifier, -route_identifier -FROM awscc.refactorspaces.routes -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the routes resource, the following permissions are required: - -### Create -```json -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 -```json -refactor-spaces:ListRoutes, -refactor-spaces:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/refactorspaces/service/index.md b/docs/awscc-docs/providers/awscc/refactorspaces/service/index.md deleted file mode 100644 index 68b13edf31..0000000000 --- a/docs/awscc-docs/providers/awscc/refactorspaces/service/index.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -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. - -## 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 data__Identifier = '||'; -``` - -## Permissions - -To operate on the service resource, the following permissions are required: - -### Read -```json -refactor-spacess:GetService, -refactor-spaces:ListTagsForResource -``` - -### Delete -```json -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 -``` - diff --git a/docs/awscc-docs/providers/awscc/refactorspaces/services/index.md b/docs/awscc-docs/providers/awscc/refactorspaces/services/index.md deleted file mode 100644 index a5443c4e48..0000000000 --- a/docs/awscc-docs/providers/awscc/refactorspaces/services/index.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -environment_identifier, -application_identifier, -service_identifier -FROM awscc.refactorspaces.services -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the services resource, the following permissions are required: - -### Create -```json -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 -```json -refactor-spaces:ListServices, -refactor-spaces:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/rekognition/collection/index.md b/docs/awscc-docs/providers/awscc/rekognition/collection/index.md deleted file mode 100644 index 970b868df2..0000000000 --- a/docs/awscc-docs/providers/awscc/rekognition/collection/index.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -collection_id, -tags -FROM awscc.rekognition.collection -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the collection resource, the following permissions are required: - -### Read -```json -rekognition:DescribeCollection, -rekognition:ListTagsForResource -``` - -### Update -```json -rekognition:TagResource, -rekognition:UntagResource, -rekognition:DescribeCollection, -rekognition:ListTagsForResource -``` - -### Delete -```json -rekognition:DeleteCollection -``` - diff --git a/docs/awscc-docs/providers/awscc/rekognition/collections/index.md b/docs/awscc-docs/providers/awscc/rekognition/collections/index.md deleted file mode 100644 index 3d250c7ded..0000000000 --- a/docs/awscc-docs/providers/awscc/rekognition/collections/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -collection_id -FROM awscc.rekognition.collections -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the collections resource, the following permissions are required: - -### Create -```json -rekognition:CreateCollection, -rekognition:DescribeCollection, -rekognition:ListTagsForResource, -rekognition:TagResource -``` - -### List -```json -rekognition:ListCollections -``` - diff --git a/docs/awscc-docs/providers/awscc/rekognition/index.md b/docs/awscc-docs/providers/awscc/rekognition/index.md deleted file mode 100644 index 092dc796f8..0000000000 --- a/docs/awscc-docs/providers/awscc/rekognition/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -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 deleted file mode 100644 index 9a1c9e4a04..0000000000 --- a/docs/awscc-docs/providers/awscc/rekognition/project/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -project_name -FROM awscc.rekognition.project -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the project resource, the following permissions are required: - -### Read -```json -rekognition:DescribeProjects -``` - -### Delete -```json -rekognition:DescribeProjects, -rekognition:DeleteProject -``` - diff --git a/docs/awscc-docs/providers/awscc/rekognition/projects/index.md b/docs/awscc-docs/providers/awscc/rekognition/projects/index.md deleted file mode 100644 index e5f1978619..0000000000 --- a/docs/awscc-docs/providers/awscc/rekognition/projects/index.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -project_name -FROM awscc.rekognition.projects -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the projects resource, the following permissions are required: - -### Create -```json -rekognition:CreateProject -``` - -### List -```json -rekognition:DescribeProjects -``` - diff --git a/docs/awscc-docs/providers/awscc/rekognition/stream_processor/index.md b/docs/awscc-docs/providers/awscc/rekognition/stream_processor/index.md deleted file mode 100644 index b31a98bdcf..0000000000 --- a/docs/awscc-docs/providers/awscc/rekognition/stream_processor/index.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the stream_processor resource, the following permissions are required: - -### Read -```json -rekognition:DescribeStreamProcessor, -rekognition:ListTagsForResource -``` - -### Update -```json -rekognition:TagResource, -rekognition:UntagResource, -rekognition:ListTagsForResource, -rekognition:DescribeStreamProcessor -``` - -### Delete -```json -rekognition:DeleteStreamProcessor -``` - diff --git a/docs/awscc-docs/providers/awscc/rekognition/stream_processors/index.md b/docs/awscc-docs/providers/awscc/rekognition/stream_processors/index.md deleted file mode 100644 index 59a3bfaaae..0000000000 --- a/docs/awscc-docs/providers/awscc/rekognition/stream_processors/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.rekognition.stream_processors -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the stream_processors resource, the following permissions are required: - -### Create -```json -rekognition:CreateStreamProcessor, -iam:PassRole, -rekognition:DescribeStreamProcessor, -rekognition:ListTagsForResource, -rekognition:TagResource -``` - -### List -```json -rekognition:ListStreamProcessors -``` - diff --git a/docs/awscc-docs/providers/awscc/resiliencehub/app/index.md b/docs/awscc-docs/providers/awscc/resiliencehub/app/index.md deleted file mode 100644 index 8d42010293..0000000000 --- a/docs/awscc-docs/providers/awscc/resiliencehub/app/index.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the app resource, the following permissions are required: - -### Read -```json -resiliencehub:DescribeApp, -resiliencehub:DescribeAppVersionTemplate, -resiliencehub:ListAppVersionResourceMappings, -resiliencehub:ListTagsForResource -``` - -### Update -```json -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 -```json -resiliencehub:DeleteApp, -resiliencehub:UntagResource, -resiliencehub:ListApps -``` - diff --git a/docs/awscc-docs/providers/awscc/resiliencehub/apps/index.md b/docs/awscc-docs/providers/awscc/resiliencehub/apps/index.md deleted file mode 100644 index 215ff6d3ed..0000000000 --- a/docs/awscc-docs/providers/awscc/resiliencehub/apps/index.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -app_arn -FROM awscc.resiliencehub.apps -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the apps resource, the following permissions are required: - -### Create -```json -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 -```json -resiliencehub:ListApps -``` - diff --git a/docs/awscc-docs/providers/awscc/resiliencehub/index.md b/docs/awscc-docs/providers/awscc/resiliencehub/index.md deleted file mode 100644 index 26b7110c23..0000000000 --- a/docs/awscc-docs/providers/awscc/resiliencehub/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index cbc25628a6..0000000000 --- a/docs/awscc-docs/providers/awscc/resiliencehub/resiliency_policies/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -policy_arn -FROM awscc.resiliencehub.resiliency_policies -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the resiliency_policies resource, the following permissions are required: - -### Create -```json -resiliencehub:CreateResiliencyPolicy, -resiliencehub:DescribeResiliencyPolicy, -resiliencehub:TagResource -``` - -### List -```json -resiliencehub:ListResiliencyPolicies -``` - diff --git a/docs/awscc-docs/providers/awscc/resiliencehub/resiliency_policy/index.md b/docs/awscc-docs/providers/awscc/resiliencehub/resiliency_policy/index.md deleted file mode 100644 index 36f6a5464c..0000000000 --- a/docs/awscc-docs/providers/awscc/resiliencehub/resiliency_policy/index.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -policy_name, -policy_description, -data_location_constraint, -tier, -policy, -policy_arn, -tags -FROM awscc.resiliencehub.resiliency_policy -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the resiliency_policy resource, the following permissions are required: - -### Update -```json -resiliencehub:DescribeResiliencyPolicy, -resiliencehub:UpdateResiliencyPolicy, -resiliencehub:TagResource, -resiliencehub:UntagResource, -resiliencehub:ListTagsForResource -``` - -### Read -```json -resiliencehub:DescribeResiliencyPolicy, -resiliencehub:ListTagsForResource -``` - -### Delete -```json -resiliencehub:DeleteResiliencyPolicy, -resiliencehub:UntagResource -``` - 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 deleted file mode 100644 index 1d285742b9..0000000000 --- a/docs/awscc-docs/providers/awscc/resourceexplorer2/default_view_association/index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -view_arn, -associated_aws_principal -FROM awscc.resourceexplorer2.default_view_association -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the default_view_association resource, the following permissions are required: - -### Update -```json -resource-explorer-2:GetDefaultView, -resource-explorer-2:AssociateDefaultView -``` - -### Read -```json -resource-explorer-2:GetDefaultView -``` - -### Delete -```json -resource-explorer-2:GetDefaultView, -resource-explorer-2:DisassociateDefaultView -``` - diff --git a/docs/awscc-docs/providers/awscc/resourceexplorer2/index.md b/docs/awscc-docs/providers/awscc/resourceexplorer2/index.md deleted file mode 100644 index 5643e2b033..0000000000 --- a/docs/awscc-docs/providers/awscc/resourceexplorer2/index.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -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: 5
-total selectable resources: 5
-total methods: 5
-
-
- -::: - -## Resources -
-
-default_view_association
-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 deleted file mode 100644 index 6d643b48df..0000000000 --- a/docs/awscc-docs/providers/awscc/resourceexplorer2/index/index.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -tags, -type, -index_state -FROM awscc.resourceexplorer2.index -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the index resource, the following permissions are required: - -### Update -```json -resource-explorer-2:GetIndex, -resource-explorer-2:UpdateIndexType, -resource-explorer-2:TagResource, -resource-explorer-2:UntagResource, -resource-explorer-2:ListTagsForResource -``` - -### Delete -```json -resource-explorer-2:DeleteIndex, -resource-explorer-2:GetIndex, -resource-explorer-2:UntagResource -``` - -### Read -```json -resource-explorer-2:GetIndex -``` - diff --git a/docs/awscc-docs/providers/awscc/resourceexplorer2/indices/index.md b/docs/awscc-docs/providers/awscc/resourceexplorer2/indices/index.md deleted file mode 100644 index 006dd6086c..0000000000 --- a/docs/awscc-docs/providers/awscc/resourceexplorer2/indices/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.resourceexplorer2.indices -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the indices resource, the following permissions are required: - -### Create -```json -resource-explorer-2:CreateIndex, -resource-explorer-2:GetIndex, -resource-explorer-2:TagResource, -resource-explorer-2:UpdateIndexType, -resource-explorer-2:DeleteIndex, -iam:CreateServiceLinkedRole -``` - -### List -```json -resource-explorer-2:ListIndexes -``` - diff --git a/docs/awscc-docs/providers/awscc/resourceexplorer2/view/index.md b/docs/awscc-docs/providers/awscc/resourceexplorer2/view/index.md deleted file mode 100644 index 2ed8191888..0000000000 --- a/docs/awscc-docs/providers/awscc/resourceexplorer2/view/index.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -filters, -included_properties, -scope, -tags, -view_arn, -view_name -FROM awscc.resourceexplorer2.view -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the view resource, the following permissions are required: - -### Read -```json -resource-explorer-2:GetView -``` - -### Update -```json -resource-explorer-2:UpdateView, -resource-explorer-2:TagResource, -resource-explorer-2:UntagResource, -resource-explorer-2:ListTagsForResource -``` - -### Delete -```json -resource-explorer-2:DeleteView, -resource-explorer-2:GetView, -resource-explorer-2:UntagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/resourceexplorer2/views/index.md b/docs/awscc-docs/providers/awscc/resourceexplorer2/views/index.md deleted file mode 100644 index 565b14b9d5..0000000000 --- a/docs/awscc-docs/providers/awscc/resourceexplorer2/views/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -view_arn -FROM awscc.resourceexplorer2.views -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the views resource, the following permissions are required: - -### Create -```json -resource-explorer-2:CreateView, -resource-explorer-2:TagResource -``` - -### List -```json -resource-explorer-2:ListViews -``` - diff --git a/docs/awscc-docs/providers/awscc/resourcegroups/group/index.md b/docs/awscc-docs/providers/awscc/resourcegroups/group/index.md deleted file mode 100644 index a1bf018384..0000000000 --- a/docs/awscc-docs/providers/awscc/resourcegroups/group/index.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -description, -resource_query, -tags, -arn, -configuration, -resources -FROM awscc.resourcegroups.group -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the group resource, the following permissions are required: - -### Read -```json -resource-groups:GetGroup, -resource-groups:GetGroupQuery, -resource-groups:GetTags, -resource-groups:GetGroupConfiguration, -resource-groups:ListGroupResources -``` - -### Update -```json -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 -```json -resource-groups:DeleteGroup, -resource-groups:UnGroupResources -``` - diff --git a/docs/awscc-docs/providers/awscc/resourcegroups/groups/index.md b/docs/awscc-docs/providers/awscc/resourcegroups/groups/index.md deleted file mode 100644 index 37f96dd24c..0000000000 --- a/docs/awscc-docs/providers/awscc/resourcegroups/groups/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.resourcegroups.groups -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the groups resource, the following permissions are required: - -### Create -```json -resource-groups:CreateGroup, -resource-groups:Tag, -cloudformation:DescribeStacks, -cloudformation:ListStackResources, -resource-groups:ListGroupResources, -resource-groups:GroupResources -``` - -### List -```json -resource-groups:ListGroups -``` - diff --git a/docs/awscc-docs/providers/awscc/resourcegroups/index.md b/docs/awscc-docs/providers/awscc/resourcegroups/index.md deleted file mode 100644 index 0281c37377..0000000000 --- a/docs/awscc-docs/providers/awscc/resourcegroups/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 deleted file mode 100644 index 6ae5e436e0..0000000000 --- a/docs/awscc-docs/providers/awscc/robomaker/fleet/index.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -tags, -name -FROM awscc.robomaker.fleet -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the fleet resource, the following permissions are required: - -### Read -```json -robomaker:DescribeFleet -``` - -### Delete -```json -robomaker:DeleteFleet -``` - -### Update -```json -robomaker:TagResource, -robomaker:UntagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/robomaker/fleets/index.md b/docs/awscc-docs/providers/awscc/robomaker/fleets/index.md deleted file mode 100644 index cd24602d8c..0000000000 --- a/docs/awscc-docs/providers/awscc/robomaker/fleets/index.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.robomaker.fleets -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the fleets resource, the following permissions are required: - -### Create -```json -robomaker:CreateFleet -``` - -### List -```json -robomaker:ListFleets -``` - diff --git a/docs/awscc-docs/providers/awscc/robomaker/index.md b/docs/awscc-docs/providers/awscc/robomaker/index.md deleted file mode 100644 index 5274016d02..0000000000 --- a/docs/awscc-docs/providers/awscc/robomaker/index.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -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: 10
-total selectable resources: 10
-total methods: 10
-
-
- -::: - -## Resources -
-
-fleet
-fleets
-robot
-robot_application
-robot_application_version -
-
-robot_applications
-robots
-simulation_application
-simulation_application_version
-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 deleted file mode 100644 index a178c426df..0000000000 --- a/docs/awscc-docs/providers/awscc/robomaker/robot/index.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -fleet, -architecture, -greengrass_group_id, -tags, -name -FROM awscc.robomaker.robot -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the robot resource, the following permissions are required: - -### Read -```json -robomaker:DescribeRobot -``` - -### Delete -```json -robomaker:DescribeRobot, -robomaker:DeleteRobot, -robomaker:DeregisterRobot -``` - -### Update -```json -robomaker:TagResource, -robomaker:UntagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/robomaker/robot_application/index.md b/docs/awscc-docs/providers/awscc/robomaker/robot_application/index.md deleted file mode 100644 index 3b6c7a6841..0000000000 --- a/docs/awscc-docs/providers/awscc/robomaker/robot_application/index.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -sources, -environment, -robot_software_suite, -current_revision_id, -arn, -tags -FROM awscc.robomaker.robot_application -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the robot_application resource, the following permissions are required: - -### Read -```json -robomaker:DescribeRobotApplication -``` - -### Update -```json -robomaker:TagResource, -robomaker:UntagResource, -robomaker:UpdateRobotApplication, -ecr:BatchGetImage, -ecr:GetAuthorizationToken, -ecr:BatchCheckLayerAvailability, -ecr-public:GetAuthorizationToken -``` - -### Delete -```json -robomaker:DescribeRobotApplication, -robomaker:DeleteRobotApplication -``` - 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 deleted file mode 100644 index 6d980f5558..0000000000 --- a/docs/awscc-docs/providers/awscc/robomaker/robot_application_version/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -application, -current_revision_id, -application_version, -arn -FROM awscc.robomaker.robot_application_version -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the robot_application_version resource, the following permissions are required: - -### Delete -```json -robomaker:DeleteRobotApplication, -robomaker:DescribeRobotApplication -``` - -### Read -```json -robomaker:DescribeRobotApplication -``` - diff --git a/docs/awscc-docs/providers/awscc/robomaker/robot_applications/index.md b/docs/awscc-docs/providers/awscc/robomaker/robot_applications/index.md deleted file mode 100644 index be5bba7576..0000000000 --- a/docs/awscc-docs/providers/awscc/robomaker/robot_applications/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.robomaker.robot_applications -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the robot_applications resource, the following permissions are required: - -### Create -```json -robomaker:CreateRobotApplication, -robomaker:TagResource, -robomaker:UntagResource, -ecr:BatchGetImage, -ecr:GetAuthorizationToken, -ecr:BatchCheckLayerAvailability, -ecr-public:GetAuthorizationToken, -sts:GetServiceBearerToken -``` - -### List -```json -robomaker:ListRobotApplications -``` - diff --git a/docs/awscc-docs/providers/awscc/robomaker/robots/index.md b/docs/awscc-docs/providers/awscc/robomaker/robots/index.md deleted file mode 100644 index b52bbc8e99..0000000000 --- a/docs/awscc-docs/providers/awscc/robomaker/robots/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.robomaker.robots -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the robots resource, the following permissions are required: - -### Create -```json -robomaker:CreateRobot, -robomaker:RegisterRobot -``` - -### List -```json -robomaker:ListRobots -``` - diff --git a/docs/awscc-docs/providers/awscc/robomaker/simulation_application/index.md b/docs/awscc-docs/providers/awscc/robomaker/simulation_application/index.md deleted file mode 100644 index acf227b02a..0000000000 --- a/docs/awscc-docs/providers/awscc/robomaker/simulation_application/index.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the simulation_application resource, the following permissions are required: - -### Read -```json -robomaker:DescribeSimulationApplication -``` - -### Update -```json -robomaker:TagResource, -robomaker:UntagResource, -robomaker:UpdateSimulationApplication, -ecr:BatchGetImage, -ecr:GetAuthorizationToken, -ecr:BatchCheckLayerAvailability, -ecr-public:GetAuthorizationToken -``` - -### Delete -```json -robomaker:DescribeSimulationApplication, -robomaker:DeleteSimulationApplication -``` - 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 deleted file mode 100644 index 0f062a2eac..0000000000 --- a/docs/awscc-docs/providers/awscc/robomaker/simulation_application_version/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -application, -current_revision_id, -application_version, -arn -FROM awscc.robomaker.simulation_application_version -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the simulation_application_version resource, the following permissions are required: - -### Delete -```json -robomaker:DeleteSimulationApplication, -robomaker:DescribeSimulationApplication -``` - -### Read -```json -robomaker:DescribeSimulationApplication -``` - diff --git a/docs/awscc-docs/providers/awscc/robomaker/simulation_applications/index.md b/docs/awscc-docs/providers/awscc/robomaker/simulation_applications/index.md deleted file mode 100644 index 7fd67d30d0..0000000000 --- a/docs/awscc-docs/providers/awscc/robomaker/simulation_applications/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.robomaker.simulation_applications -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the simulation_applications resource, the following permissions are required: - -### Create -```json -robomaker:CreateSimulationApplication, -robomaker:TagResource, -robomaker:UntagResource, -ecr:BatchGetImage, -ecr:GetAuthorizationToken, -ecr:BatchCheckLayerAvailability, -ecr-public:GetAuthorizationToken, -sts:GetServiceBearerToken -``` - -### List -```json -robomaker:ListSimulationApplications -``` - diff --git a/docs/awscc-docs/providers/awscc/rolesanywhere/crl/index.md b/docs/awscc-docs/providers/awscc/rolesanywhere/crl/index.md deleted file mode 100644 index 5a3f599832..0000000000 --- a/docs/awscc-docs/providers/awscc/rolesanywhere/crl/index.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -crl_data, -crl_id, -enabled, -name, -trust_anchor_arn, -tags -FROM awscc.rolesanywhere.crl -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the crl resource, the following permissions are required: - -### Read -```json -rolesanywhere:GetCrl, -rolesanywhere:ListTagsForResource -``` - -### Update -```json -rolesanywhere:EnableCrl, -rolesanywhere:DisableCrl, -rolesanywhere:UpdateCrl, -rolesanywhere:TagResource, -rolesanywhere:UntagResource, -rolesanywhere:ListTagsForResource -``` - -### Delete -```json -rolesanywhere:DeleteCrl -``` - diff --git a/docs/awscc-docs/providers/awscc/rolesanywhere/crls/index.md b/docs/awscc-docs/providers/awscc/rolesanywhere/crls/index.md deleted file mode 100644 index 745672f638..0000000000 --- a/docs/awscc-docs/providers/awscc/rolesanywhere/crls/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -crl_id -FROM awscc.rolesanywhere.crls -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the crls resource, the following permissions are required: - -### Create -```json -rolesanywhere:ImportCrl, -rolesanywhere:TagResource, -rolesanywhere:ListTagsForResource -``` - -### List -```json -rolesanywhere:ListCrls, -rolesanywhere:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/rolesanywhere/index.md b/docs/awscc-docs/providers/awscc/rolesanywhere/index.md deleted file mode 100644 index 60f51c847d..0000000000 --- a/docs/awscc-docs/providers/awscc/rolesanywhere/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -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 deleted file mode 100644 index 7cefe1c837..0000000000 --- a/docs/awscc-docs/providers/awscc/rolesanywhere/profile/index.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the profile resource, the following permissions are required: - -### Read -```json -rolesanywhere:GetProfile, -rolesanywhere:ListTagsForResource -``` - -### Update -```json -iam:GetRole, -iam:GetPolicy, -iam:PassRole, -rolesanywhere:UpdateProfile, -rolesanywhere:EnableProfile, -rolesanywhere:DisableProfile, -rolesanywhere:TagResource, -rolesanywhere:UntagResource, -rolesanywhere:ListTagsForResource -``` - -### Delete -```json -rolesanywhere:DeleteProfile -``` - diff --git a/docs/awscc-docs/providers/awscc/rolesanywhere/profiles/index.md b/docs/awscc-docs/providers/awscc/rolesanywhere/profiles/index.md deleted file mode 100644 index 63fa37abf8..0000000000 --- a/docs/awscc-docs/providers/awscc/rolesanywhere/profiles/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -profile_id -FROM awscc.rolesanywhere.profiles -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the profiles resource, the following permissions are required: - -### Create -```json -iam:GetRole, -iam:GetPolicy, -iam:PassRole, -rolesanywhere:CreateProfile, -rolesanywhere:TagResource, -rolesanywhere:ListTagsForResource -``` - -### List -```json -rolesanywhere:ListProfiles, -rolesanywhere:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/rolesanywhere/trust_anchor/index.md b/docs/awscc-docs/providers/awscc/rolesanywhere/trust_anchor/index.md deleted file mode 100644 index 27ccd4ed19..0000000000 --- a/docs/awscc-docs/providers/awscc/rolesanywhere/trust_anchor/index.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -enabled, -name, -notification_settings, -source, -tags, -trust_anchor_id, -trust_anchor_arn -FROM awscc.rolesanywhere.trust_anchor -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the trust_anchor resource, the following permissions are required: - -### Read -```json -rolesanywhere:GetTrustAnchor, -rolesanywhere:ListTagsForResource -``` - -### Update -```json -acm-pca:GetCertificateAuthorityCertificate, -rolesanywhere:ListTagsForResource, -rolesanywhere:TagResource, -rolesanywhere:UntagResource, -rolesanywhere:EnableTrustAnchor, -rolesanywhere:DisableTrustAnchor, -rolesanywhere:UpdateTrustAnchor, -rolesanywhere:GetTrustAnchor, -rolesanywhere:PutNotificationSettings, -rolesanywhere:ResetNotificationSettings -``` - -### Delete -```json -rolesanywhere:DeleteTrustAnchor -``` - diff --git a/docs/awscc-docs/providers/awscc/rolesanywhere/trust_anchors/index.md b/docs/awscc-docs/providers/awscc/rolesanywhere/trust_anchors/index.md deleted file mode 100644 index a883437769..0000000000 --- a/docs/awscc-docs/providers/awscc/rolesanywhere/trust_anchors/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -trust_anchor_id -FROM awscc.rolesanywhere.trust_anchors -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the trust_anchors resource, the following permissions are required: - -### Create -```json -iam:CreateServiceLinkedRole, -rolesanywhere:CreateTrustAnchor, -rolesanywhere:TagResource, -rolesanywhere:ListTagsForResource -``` - -### List -```json -rolesanywhere:ListTrustAnchors, -rolesanywhere:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/route53/cidr_collection/index.md b/docs/awscc-docs/providers/awscc/route53/cidr_collection/index.md deleted file mode 100644 index 7a64c99c59..0000000000 --- a/docs/awscc-docs/providers/awscc/route53/cidr_collection/index.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id, -name, -arn, -locations -FROM awscc.route53.cidr_collection -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the cidr_collection resource, the following permissions are required: - -### Read -```json -route53:ListCidrCollections, -route53:ListCidrBlocks -``` - -### Update -```json -route53:ChangeCidrCollection -``` - -### Delete -```json -route53:DeleteCidrCollection, -route53:ChangeCidrCollection -``` - diff --git a/docs/awscc-docs/providers/awscc/route53/cidr_collections/index.md b/docs/awscc-docs/providers/awscc/route53/cidr_collections/index.md deleted file mode 100644 index 7f9bf27e45..0000000000 --- a/docs/awscc-docs/providers/awscc/route53/cidr_collections/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.route53.cidr_collections - -``` - -## Permissions - -To operate on the cidr_collections resource, the following permissions are required: - -### Create -```json -route53:CreateCidrCollection, -route53:ChangeCidrCollection -``` - -### List -```json -route53:ListCidrCollections, -route53:ListCidrBlocks -``` - diff --git a/docs/awscc-docs/providers/awscc/route53/dnssec/index.md b/docs/awscc-docs/providers/awscc/route53/dnssec/index.md deleted file mode 100644 index 47645c4c40..0000000000 --- a/docs/awscc-docs/providers/awscc/route53/dnssec/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -hosted_zone_id -FROM awscc.route53.dnssec -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the dnssec resource, the following permissions are required: - -### Read -```json -route53:GetDNSSEC -``` - -### Delete -```json -route53:GetDNSSEC, -route53:DisableHostedZoneDNSSEC, -kms:DescribeKey, -kms:GetPublicKey, -kms:Sign, -kms:CreateGrant -``` - diff --git a/docs/awscc-docs/providers/awscc/route53/dnssecs/index.md b/docs/awscc-docs/providers/awscc/route53/dnssecs/index.md deleted file mode 100644 index 7a171640f9..0000000000 --- a/docs/awscc-docs/providers/awscc/route53/dnssecs/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -hosted_zone_id -FROM awscc.route53.dnssecs - -``` - -## Permissions - -To operate on the dnssecs resource, the following permissions are required: - -### Create -```json -route53:GetDNSSEC, -route53:EnableHostedZoneDNSSEC, -kms:DescribeKey, -kms:GetPublicKey, -kms:Sign, -kms:CreateGrant -``` - -### List -```json -route53:GetDNSSEC, -route53:ListHostedZones -``` - diff --git a/docs/awscc-docs/providers/awscc/route53/health_check/index.md b/docs/awscc-docs/providers/awscc/route53/health_check/index.md deleted file mode 100644 index 0acae94909..0000000000 --- a/docs/awscc-docs/providers/awscc/route53/health_check/index.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -health_check_id, -health_check_config, -health_check_tags -FROM awscc.route53.health_check -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the health_check resource, the following permissions are required: - -### Read -```json -route53:GetHealthCheck, -route53:ListTagsForResource -``` - -### Update -```json -route53:UpdateHealthCheck, -route53:ChangeTagsForResource, -route53:ListTagsForResource, -cloudwatch:DescribeAlarms -``` - -### Delete -```json -route53:DeleteHealthCheck -``` - diff --git a/docs/awscc-docs/providers/awscc/route53/health_checks/index.md b/docs/awscc-docs/providers/awscc/route53/health_checks/index.md deleted file mode 100644 index 6f2695132f..0000000000 --- a/docs/awscc-docs/providers/awscc/route53/health_checks/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -health_check_id -FROM awscc.route53.health_checks - -``` - -## Permissions - -To operate on the health_checks resource, the following permissions are required: - -### Create -```json -route53:CreateHealthCheck, -route53:ChangeTagsForResource, -cloudwatch:DescribeAlarms, -route53-recovery-control-config:DescribeRoutingControl -``` - -### List -```json -route53:ListHealthChecks, -route53:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/route53/hosted_zone/index.md b/docs/awscc-docs/providers/awscc/route53/hosted_zone/index.md deleted file mode 100644 index 6aed184b18..0000000000 --- a/docs/awscc-docs/providers/awscc/route53/hosted_zone/index.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -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
vpcsarrayA 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. - -## Example -```sql -SELECT -region, -id, -hosted_zone_config, -hosted_zone_tags, -name, -query_logging_config, -vpcs, -name_servers -FROM awscc.route53.hosted_zone -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the hosted_zone resource, the following permissions are required: - -### Read -```json -route53:GetHostedZone, -route53:ListTagsForResource, -route53:ListQueryLoggingConfigs -``` - -### Update -```json -route53:GetChange, -route53:ListTagsForResource, -route53:UpdateHostedZoneComment, -route53:ChangeTagsForResource, -route53:AssociateVPCWithHostedZone, -route53:DisassociateVPCFromHostedZone, -route53:CreateQueryLoggingConfig, -route53:DeleteQueryLoggingConfig, -ec2:DescribeVpcs -``` - -### Delete -```json -route53:DeleteHostedZone, -route53:DeleteQueryLoggingConfig, -route53:ListQueryLoggingConfigs, -route53:GetChange -``` - diff --git a/docs/awscc-docs/providers/awscc/route53/hosted_zones/index.md b/docs/awscc-docs/providers/awscc/route53/hosted_zones/index.md deleted file mode 100644 index fdf3bd2303..0000000000 --- a/docs/awscc-docs/providers/awscc/route53/hosted_zones/index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.route53.hosted_zones - -``` - -## Permissions - -To operate on the hosted_zones resource, the following permissions are required: - -### Create -```json -route53:CreateHostedZone, -route53:CreateQueryLoggingConfig, -route53:ChangeTagsForResource, -route53:GetChange, -route53:AssociateVPCWithHostedZone, -ec2:DescribeVpcs -``` - -### List -```json -route53:GetHostedZone, -route53:ListHostedZones, -route53:ListHostedZonesByName, -route53:ListQueryLoggingConfigs, -route53:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/route53/index.md b/docs/awscc-docs/providers/awscc/route53/index.md deleted file mode 100644 index 3796e6832c..0000000000 --- a/docs/awscc-docs/providers/awscc/route53/index.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -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 deleted file mode 100644 index b50ea9c388..0000000000 --- a/docs/awscc-docs/providers/awscc/route53/key_signing_key/index.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -hosted_zone_id, -status, -name, -key_management_service_arn -FROM awscc.route53.key_signing_key -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the key_signing_key resource, the following permissions are required: - -### Read -```json -route53:GetDNSSEC -``` - -### Update -```json -route53:GetDNSSEC, -route53:ActivateKeySigningKey, -route53:DeactivateKeySigningKey, -kms:DescribeKey, -kms:GetPublicKey, -kms:Sign, -kms:CreateGrant -``` - -### Delete -```json -route53:DeactivateKeySigningKey, -route53:DeleteKeySigningKey, -kms:DescribeKey, -kms:GetPublicKey, -kms:Sign, -kms:CreateGrant -``` - 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 deleted file mode 100644 index db9b993ae3..0000000000 --- a/docs/awscc-docs/providers/awscc/route53/key_signing_keys/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -hosted_zone_id, -name -FROM awscc.route53.key_signing_keys - -``` - -## Permissions - -To operate on the key_signing_keys resource, the following permissions are required: - -### Create -```json -route53:CreateKeySigningKey, -kms:DescribeKey, -kms:GetPublicKey, -kms:Sign, -kms:CreateGrant -``` - -### List -```json -route53:GetDNSSEC, -route53:ListHostedZones -``` - diff --git a/docs/awscc-docs/providers/awscc/route53recoverycontrol/cluster/index.md b/docs/awscc-docs/providers/awscc/route53recoverycontrol/cluster/index.md deleted file mode 100644 index 473977f6f4..0000000000 --- a/docs/awscc-docs/providers/awscc/route53recoverycontrol/cluster/index.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -cluster_arn, -status, -cluster_endpoints, -tags -FROM awscc.route53recoverycontrol.cluster -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the cluster resource, the following permissions are required: - -### Read -```json -route53-recovery-control-config:DescribeCluster, -route53-recovery-control-config:ListTagsForResource -``` - -### Delete -```json -route53-recovery-control-config:DescribeCluster, -route53-recovery-control-config:DeleteCluster -``` - diff --git a/docs/awscc-docs/providers/awscc/route53recoverycontrol/clusters/index.md b/docs/awscc-docs/providers/awscc/route53recoverycontrol/clusters/index.md deleted file mode 100644 index 05601090c5..0000000000 --- a/docs/awscc-docs/providers/awscc/route53recoverycontrol/clusters/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -cluster_arn -FROM awscc.route53recoverycontrol.clusters -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the clusters resource, the following permissions are required: - -### Create -```json -route53-recovery-control-config:CreateCluster, -route53-recovery-control-config:DescribeCluster, -route53-recovery-control-config:ListTagsForResource, -route53-recovery-control-config:TagResource -``` - -### List -```json -route53-recovery-control-config:ListClusters -``` - diff --git a/docs/awscc-docs/providers/awscc/route53recoverycontrol/control_panel/index.md b/docs/awscc-docs/providers/awscc/route53recoverycontrol/control_panel/index.md deleted file mode 100644 index e4db0d74f3..0000000000 --- a/docs/awscc-docs/providers/awscc/route53recoverycontrol/control_panel/index.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -cluster_arn, -control_panel_arn, -name, -status, -default_control_panel, -routing_control_count, -tags -FROM awscc.route53recoverycontrol.control_panel -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the control_panel resource, the following permissions are required: - -### Read -```json -route53-recovery-control-config:DescribeControlPanel, -route53-recovery-control-config:ListTagsForResource -``` - -### Update -```json -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 -```json -route53-recovery-control-config:DeleteControlPanel, -route53-recovery-control-config:DescribeControlPanel -``` - diff --git a/docs/awscc-docs/providers/awscc/route53recoverycontrol/control_panels/index.md b/docs/awscc-docs/providers/awscc/route53recoverycontrol/control_panels/index.md deleted file mode 100644 index b399805a8d..0000000000 --- a/docs/awscc-docs/providers/awscc/route53recoverycontrol/control_panels/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -control_panel_arn -FROM awscc.route53recoverycontrol.control_panels -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the control_panels resource, the following permissions are required: - -### Create -```json -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 -```json -route53-recovery-control-config:ListControlPanels -``` - diff --git a/docs/awscc-docs/providers/awscc/route53recoverycontrol/index.md b/docs/awscc-docs/providers/awscc/route53recoverycontrol/index.md deleted file mode 100644 index 016f43a324..0000000000 --- a/docs/awscc-docs/providers/awscc/route53recoverycontrol/index.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -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 deleted file mode 100644 index b98f0eed4b..0000000000 --- a/docs/awscc-docs/providers/awscc/route53recoverycontrol/routing_control/index.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -routing_control_arn, -control_panel_arn, -name, -status, -cluster_arn -FROM awscc.route53recoverycontrol.routing_control -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the routing_control resource, the following permissions are required: - -### Read -```json -route53-recovery-control-config:DescribeRoutingControl -``` - -### Update -```json -route53-recovery-control-config:UpdateRoutingControl, -route53-recovery-control-config:DescribeRoutingControl, -route53-recovery-control-config:DescribeControlPanel -``` - -### Delete -```json -route53-recovery-control-config:DescribeRoutingControl, -route53-recovery-control-config:DeleteRoutingControl -``` - diff --git a/docs/awscc-docs/providers/awscc/route53recoverycontrol/routing_controls/index.md b/docs/awscc-docs/providers/awscc/route53recoverycontrol/routing_controls/index.md deleted file mode 100644 index 5d755af0a7..0000000000 --- a/docs/awscc-docs/providers/awscc/route53recoverycontrol/routing_controls/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -routing_control_arn -FROM awscc.route53recoverycontrol.routing_controls -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the routing_controls resource, the following permissions are required: - -### Create -```json -route53-recovery-control-config:CreateRoutingControl, -route53-recovery-control-config:DescribeRoutingControl, -route53-recovery-control-config:DescribeControlPanel, -route53-recovery-control-config:DescribeCluster -``` - -### List -```json -route53-recovery-control-config:ListRoutingControls -``` - diff --git a/docs/awscc-docs/providers/awscc/route53recoverycontrol/safety_rule/index.md b/docs/awscc-docs/providers/awscc/route53recoverycontrol/safety_rule/index.md deleted file mode 100644 index 22bfc06b79..0000000000 --- a/docs/awscc-docs/providers/awscc/route53recoverycontrol/safety_rule/index.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the safety_rule resource, the following permissions are required: - -### Read -```json -route53-recovery-control-config:DescribeSafetyRule, -route53-recovery-control-config:ListTagsForResource -``` - -### Update -```json -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 -```json -route53-recovery-control-config:DescribeSafetyRule, -route53-recovery-control-config:DeleteSafetyRule -``` - diff --git a/docs/awscc-docs/providers/awscc/route53recoverycontrol/safety_rules/index.md b/docs/awscc-docs/providers/awscc/route53recoverycontrol/safety_rules/index.md deleted file mode 100644 index d7f1c559d4..0000000000 --- a/docs/awscc-docs/providers/awscc/route53recoverycontrol/safety_rules/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -safety_rule_arn -FROM awscc.route53recoverycontrol.safety_rules -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the safety_rules resource, the following permissions are required: - -### Create -```json -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 -```json -route53-recovery-control-config:ListSafetyRules -``` - diff --git a/docs/awscc-docs/providers/awscc/route53recoveryreadiness/cell/index.md b/docs/awscc-docs/providers/awscc/route53recoveryreadiness/cell/index.md deleted file mode 100644 index eed6e93bed..0000000000 --- a/docs/awscc-docs/providers/awscc/route53recoveryreadiness/cell/index.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -cell_name, -cell_arn, -cells, -parent_readiness_scopes, -tags -FROM awscc.route53recoveryreadiness.cell -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the cell resource, the following permissions are required: - -### Read -```json -route53-recovery-readiness:GetCell, -route53-recovery-readiness:ListTagsForResources -``` - -### Update -```json -route53-recovery-readiness:GetCell, -route53-recovery-readiness:ListTagsForResources, -route53-recovery-readiness:TagResource, -route53-recovery-readiness:UntagResource, -route53-recovery-readiness:UpdateCell -``` - -### Delete -```json -route53-recovery-readiness:DeleteCell, -route53-recovery-readiness:GetCell -``` - diff --git a/docs/awscc-docs/providers/awscc/route53recoveryreadiness/cells/index.md b/docs/awscc-docs/providers/awscc/route53recoveryreadiness/cells/index.md deleted file mode 100644 index 2795f3e9ad..0000000000 --- a/docs/awscc-docs/providers/awscc/route53recoveryreadiness/cells/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -cell_name -FROM awscc.route53recoveryreadiness.cells -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the cells resource, the following permissions are required: - -### Create -```json -route53-recovery-readiness:CreateCell, -route53-recovery-readiness:GetCell, -route53-recovery-readiness:ListTagsForResources, -route53-recovery-readiness:TagResource -``` - -### List -```json -route53-recovery-readiness:ListCells -``` - diff --git a/docs/awscc-docs/providers/awscc/route53recoveryreadiness/index.md b/docs/awscc-docs/providers/awscc/route53recoveryreadiness/index.md deleted file mode 100644 index 67bc0d77d4..0000000000 --- a/docs/awscc-docs/providers/awscc/route53recoveryreadiness/index.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -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 deleted file mode 100644 index a7f63730aa..0000000000 --- a/docs/awscc-docs/providers/awscc/route53recoveryreadiness/readiness_check/index.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -resource_set_name, -readiness_check_name, -readiness_check_arn, -tags -FROM awscc.route53recoveryreadiness.readiness_check -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the readiness_check resource, the following permissions are required: - -### Read -```json -route53-recovery-readiness:GetReadinessCheck, -route53-recovery-readiness:ListTagsForResources -``` - -### Update -```json -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 -```json -route53-recovery-readiness:DeleteReadinessCheck, -route53-recovery-readiness:GetReadinessCheck -``` - diff --git a/docs/awscc-docs/providers/awscc/route53recoveryreadiness/readiness_checks/index.md b/docs/awscc-docs/providers/awscc/route53recoveryreadiness/readiness_checks/index.md deleted file mode 100644 index 679f586d80..0000000000 --- a/docs/awscc-docs/providers/awscc/route53recoveryreadiness/readiness_checks/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -readiness_check_name -FROM awscc.route53recoveryreadiness.readiness_checks -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the readiness_checks resource, the following permissions are required: - -### Create -```json -route53-recovery-readiness:CreateReadinessCheck, -route53-recovery-readiness:GetResourceSet, -route53-recovery-readiness:GetReadinessCheck, -route53-recovery-readiness:ListTagsForResources, -route53-recovery-readiness:TagResource -``` - -### List -```json -route53-recovery-readiness:ListReadinessChecks, -route53-recovery-readiness:GetReadinessChecks -``` - diff --git a/docs/awscc-docs/providers/awscc/route53recoveryreadiness/recovery_group/index.md b/docs/awscc-docs/providers/awscc/route53recoveryreadiness/recovery_group/index.md deleted file mode 100644 index fb998a19f2..0000000000 --- a/docs/awscc-docs/providers/awscc/route53recoveryreadiness/recovery_group/index.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -recovery_group_name, -cells, -recovery_group_arn, -tags -FROM awscc.route53recoveryreadiness.recovery_group -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the recovery_group resource, the following permissions are required: - -### Read -```json -route53-recovery-readiness:GetRecoveryGroup, -route53-recovery-readiness:ListTagsForResources -``` - -### Update -```json -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 -```json -route53-recovery-readiness:DeleteRecoveryGroup, -route53-recovery-readiness:GetRecoveryGroup -``` - diff --git a/docs/awscc-docs/providers/awscc/route53recoveryreadiness/recovery_groups/index.md b/docs/awscc-docs/providers/awscc/route53recoveryreadiness/recovery_groups/index.md deleted file mode 100644 index 1f04a93698..0000000000 --- a/docs/awscc-docs/providers/awscc/route53recoveryreadiness/recovery_groups/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -recovery_group_name -FROM awscc.route53recoveryreadiness.recovery_groups -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the recovery_groups resource, the following permissions are required: - -### Create -```json -route53-recovery-readiness:CreateRecoveryGroup, -route53-recovery-readiness:GetRecoveryGroup, -route53-recovery-readiness:GetCell, -route53-recovery-readiness:ListTagsForResources, -route53-recovery-readiness:TagResource -``` - -### List -```json -route53-recovery-readiness:ListRecoveryGroups -``` - diff --git a/docs/awscc-docs/providers/awscc/route53recoveryreadiness/resource_set/index.md b/docs/awscc-docs/providers/awscc/route53recoveryreadiness/resource_set/index.md deleted file mode 100644 index 74766d6981..0000000000 --- a/docs/awscc-docs/providers/awscc/route53recoveryreadiness/resource_set/index.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -resource_set_name, -resources, -resource_set_arn, -resource_set_type, -tags -FROM awscc.route53recoveryreadiness.resource_set -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the resource_set resource, the following permissions are required: - -### Read -```json -route53-recovery-readiness:GetResourceSet, -route53-recovery-readiness:ListTagsForResources -``` - -### Update -```json -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 -```json -route53-recovery-readiness:DeleteResourceSet, -route53-recovery-readiness:GetResourceSet -``` - diff --git a/docs/awscc-docs/providers/awscc/route53recoveryreadiness/resource_sets/index.md b/docs/awscc-docs/providers/awscc/route53recoveryreadiness/resource_sets/index.md deleted file mode 100644 index 7099fbf844..0000000000 --- a/docs/awscc-docs/providers/awscc/route53recoveryreadiness/resource_sets/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -resource_set_name -FROM awscc.route53recoveryreadiness.resource_sets -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the resource_sets resource, the following permissions are required: - -### Create -```json -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 -```json -route53-recovery-readiness:ListResourceSets -``` - 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 deleted file mode 100644 index 1757c9b695..0000000000 --- a/docs/awscc-docs/providers/awscc/route53resolver/firewall_domain_list/index.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the firewall_domain_list resource, the following permissions are required: - -### Read -```json -route53resolver:*, -ec2:*, -logs:*, -iam:*, -lambda:*, -s3:* -``` - -### Delete -```json -route53resolver:*, -ec2:*, -logs:*, -iam:*, -lambda:*, -s3:* -``` - -### Update -```json -route53resolver:*, -ec2:*, -logs:*, -iam:*, -lambda:*, -s3:* -``` - 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 deleted file mode 100644 index 6d702dab47..0000000000 --- a/docs/awscc-docs/providers/awscc/route53resolver/firewall_domain_lists/index.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.route53resolver.firewall_domain_lists -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the firewall_domain_lists resource, the following permissions are required: - -### Create -```json -route53resolver:*, -ec2:*, -logs:*, -iam:*, -lambda:*, -s3:* -``` - -### List -```json -route53resolver:*, -ec2:*, -logs:*, -iam:*, -lambda:*, -s3:* -``` - 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 deleted file mode 100644 index 189fc41f6e..0000000000 --- a/docs/awscc-docs/providers/awscc/route53resolver/firewall_rule_group/index.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the firewall_rule_group resource, the following permissions are required: - -### Read -```json -route53resolver:*, -ec2:*, -logs:*, -iam:*, -lambda:*, -s3:* -``` - -### Delete -```json -route53resolver:*, -ec2:*, -logs:*, -iam:*, -lambda:*, -s3:* -``` - -### Update -```json -route53resolver:*, -ec2:*, -logs:*, -iam:*, -lambda:*, -s3:* -``` - 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 deleted file mode 100644 index 1909a96b01..0000000000 --- a/docs/awscc-docs/providers/awscc/route53resolver/firewall_rule_group_association/index.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the firewall_rule_group_association resource, the following permissions are required: - -### Read -```json -route53resolver:*, -ec2:*, -logs:*, -iam:*, -lambda:*, -s3:* -``` - -### Delete -```json -route53resolver:*, -ec2:*, -logs:*, -iam:*, -lambda:*, -s3:* -``` - -### Update -```json -route53resolver:*, -ec2:*, -logs:*, -iam:*, -lambda:*, -s3:* -``` - 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 deleted file mode 100644 index b9e1b06170..0000000000 --- a/docs/awscc-docs/providers/awscc/route53resolver/firewall_rule_group_associations/index.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.route53resolver.firewall_rule_group_associations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the firewall_rule_group_associations resource, the following permissions are required: - -### Create -```json -route53resolver:*, -ec2:*, -logs:*, -iam:*, -lambda:*, -s3:* -``` - -### List -```json -route53resolver:*, -ec2:*, -logs:*, -iam:*, -lambda:*, -s3:* -``` - 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 deleted file mode 100644 index 2bf5df4544..0000000000 --- a/docs/awscc-docs/providers/awscc/route53resolver/firewall_rule_groups/index.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.route53resolver.firewall_rule_groups -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the firewall_rule_groups resource, the following permissions are required: - -### Create -```json -route53resolver:*, -ec2:*, -logs:*, -iam:*, -lambda:*, -s3:* -``` - -### List -```json -route53resolver:*, -ec2:*, -logs:*, -iam:*, -lambda:*, -s3:* -``` - diff --git a/docs/awscc-docs/providers/awscc/route53resolver/index.md b/docs/awscc-docs/providers/awscc/route53resolver/index.md deleted file mode 100644 index 575d9a3928..0000000000 --- a/docs/awscc-docs/providers/awscc/route53resolver/index.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -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 deleted file mode 100644 index 3f1d4a6e8a..0000000000 --- a/docs/awscc-docs/providers/awscc/route53resolver/outpost_resolver/index.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the outpost_resolver resource, the following permissions are required: - -### Read -```json -route53resolver:GetOutpostResolver, -route53resolver:ListTagsForResource -``` - -### Update -```json -route53resolver:UpdateOutpostResolver, -route53resolver:GetOutpostResolver, -route53resolver:UntagResource, -route53resolver:TagResource, -route53resolver:ListTagsForResource -``` - -### Delete -```json -route53resolver:DeleteOutpostResolver, -route53resolver:GetOutpostResolver, -route53resolver:ListOutpostResolvers, -route53resolver:ListResolverEndpoints -``` - diff --git a/docs/awscc-docs/providers/awscc/route53resolver/outpost_resolvers/index.md b/docs/awscc-docs/providers/awscc/route53resolver/outpost_resolvers/index.md deleted file mode 100644 index a95e335e91..0000000000 --- a/docs/awscc-docs/providers/awscc/route53resolver/outpost_resolvers/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.route53resolver.outpost_resolvers -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the outpost_resolvers resource, the following permissions are required: - -### Create -```json -route53resolver:CreateOutpostResolver, -route53resolver:GetOutpostResolver, -route53resolver:ListTagsForResource, -outposts:GetOutpost -``` - -### List -```json -route53resolver:ListOutpostResolvers, -route53resolver:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/route53resolver/resolver_config/index.md b/docs/awscc-docs/providers/awscc/route53resolver/resolver_config/index.md deleted file mode 100644 index 06cdec30c0..0000000000 --- a/docs/awscc-docs/providers/awscc/route53resolver/resolver_config/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id, -owner_id, -resource_id, -autodefined_reverse, -autodefined_reverse_flag -FROM awscc.route53resolver.resolver_config -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the resolver_config resource, the following permissions are required: - -### Read -```json -route53resolver:GetResolverConfig, -ec2:DescribeVpcs -``` - -### Delete -```json -route53resolver:UpdateResolverConfig, -route53resolver:ListResolverConfigs, -ec2:DescribeVpcs -``` - diff --git a/docs/awscc-docs/providers/awscc/route53resolver/resolver_configs/index.md b/docs/awscc-docs/providers/awscc/route53resolver/resolver_configs/index.md deleted file mode 100644 index 22a6d4a2f2..0000000000 --- a/docs/awscc-docs/providers/awscc/route53resolver/resolver_configs/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -resource_id -FROM awscc.route53resolver.resolver_configs -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the resolver_configs resource, the following permissions are required: - -### Create -```json -route53resolver:UpdateResolverConfig, -route53resolver:GetResolverConfig, -ec2:DescribeVpcs -``` - -### List -```json -route53resolver:ListResolverConfigs, -ec2:DescribeVpcs -``` - 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 deleted file mode 100644 index 1aa42ea4cc..0000000000 --- a/docs/awscc-docs/providers/awscc/route53resolver/resolver_query_logging_config/index.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the resolver_query_logging_config resource, the following permissions are required: - -### Read -```json -resolverquerylogging:GetConfig, -route53resolver:GetResolverQueryLogConfig -``` - -### Delete -```json -resolverquerylogging:DeleteConfig, -resolverquerylogging:ListConfig, -route53resolver:DeleteResolverQueryLogConfig, -route53resolver:ListResolverQueryLogConfigs -``` - 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 deleted file mode 100644 index 07a02edc7e..0000000000 --- a/docs/awscc-docs/providers/awscc/route53resolver/resolver_query_logging_config_association/index.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the resolver_query_logging_config_association resource, the following permissions are required: - -### Read -```json -resolverquerylogging:GetConfigAssociation, -route53resolver:GetResolverQueryLogConfigAssociation -``` - -### Delete -```json -resolverquerylogging:DisassociateConfig, -resolverquerylogging:ListConfigAssociation, -route53resolver:DisassociateResolverQueryLogConfig, -route53resolver:ListResolverQueryLogConfigAssociations, -route53resolver:GetResolverQueryLogConfigAssociation -``` - 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 deleted file mode 100644 index 4071539968..0000000000 --- a/docs/awscc-docs/providers/awscc/route53resolver/resolver_query_logging_config_associations/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.route53resolver.resolver_query_logging_config_associations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the resolver_query_logging_config_associations resource, the following permissions are required: - -### Create -```json -resolverquerylogging:AssociateConfig, -resolverquerylogging:GetConfigAssociation, -route53resolver:AssociateResolverQueryLogConfig, -ec2:DescribeVpcs, -route53resolver:GetResolverQueryLogConfigAssociation -``` - -### List -```json -resolverquerylogging:ListConfigAssociations, -route53resolver:ListResolverQueryLogConfigAssociations -``` - 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 deleted file mode 100644 index 5bb17dbef8..0000000000 --- a/docs/awscc-docs/providers/awscc/route53resolver/resolver_query_logging_configs/index.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.route53resolver.resolver_query_logging_configs -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the resolver_query_logging_configs resource, the following permissions are required: - -### Create -```json -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 -```json -resolverquerylogging:ListConfig, -route53resolver:ListResolverQueryLogConfigs -``` - diff --git a/docs/awscc-docs/providers/awscc/route53resolver/resolver_rule/index.md b/docs/awscc-docs/providers/awscc/route53resolver/resolver_rule/index.md deleted file mode 100644 index 3d703e261f..0000000000 --- a/docs/awscc-docs/providers/awscc/route53resolver/resolver_rule/index.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the resolver_rule resource, the following permissions are required: - -### Read -```json -route53resolver:GetResolverRule, -route53resolver:ListTagsForResource -``` - -### Update -```json -route53resolver:UpdateResolverRule, -route53resolver:GetResolverRule, -route53resolver:ListTagsForResource, -route53resolver:TagResource, -route53resolver:UntagResource -``` - -### Delete -```json -route53resolver:DeleteResolverRule, -route53resolver:GetResolverRule -``` - 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 deleted file mode 100644 index 7f89fa7a0b..0000000000 --- a/docs/awscc-docs/providers/awscc/route53resolver/resolver_rule_association/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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
vpc_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. - -## Example -```sql -SELECT -region, -vpc_id, -resolver_rule_id, -resolver_rule_association_id, -name -FROM awscc.route53resolver.resolver_rule_association -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the resolver_rule_association resource, the following permissions are required: - -### Read -```json -route53resolver:GetResolverRuleAssociation -``` - -### Delete -```json -route53resolver:DisassociateResolverRule, -route53resolver:GetResolverRuleAssociation -``` - 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 deleted file mode 100644 index f1e44d9fdf..0000000000 --- a/docs/awscc-docs/providers/awscc/route53resolver/resolver_rule_associations/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -resolver_rule_association_id -FROM awscc.route53resolver.resolver_rule_associations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the resolver_rule_associations resource, the following permissions are required: - -### Create -```json -route53resolver:AssociateResolverRule, -route53resolver:GetResolverRuleAssociation, -ec2:DescribeVpcs -``` - -### List -```json -route53resolver:ListResolverRuleAssociations -``` - diff --git a/docs/awscc-docs/providers/awscc/route53resolver/resolver_rules/index.md b/docs/awscc-docs/providers/awscc/route53resolver/resolver_rules/index.md deleted file mode 100644 index 7b660dc99d..0000000000 --- a/docs/awscc-docs/providers/awscc/route53resolver/resolver_rules/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -resolver_rule_id -FROM awscc.route53resolver.resolver_rules -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the resolver_rules resource, the following permissions are required: - -### Create -```json -route53resolver:CreateResolverRule, -route53resolver:GetResolverRule, -route53resolver:ListTagsForResource, -route53resolver:TagResource -``` - -### List -```json -route53resolver:ListResolverRules -``` - diff --git a/docs/awscc-docs/providers/awscc/route53resolver/resolverdnssec_config/index.md b/docs/awscc-docs/providers/awscc/route53resolver/resolverdnssec_config/index.md deleted file mode 100644 index 37ad881f2e..0000000000 --- a/docs/awscc-docs/providers/awscc/route53resolver/resolverdnssec_config/index.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id, -owner_id, -resource_id, -validation_status -FROM awscc.route53resolver.resolverdnssec_config -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the resolverdnssec_config resource, the following permissions are required: - -### Read -```json -resolverdnssec:GetConfig, -route53resolver:ListResolverDnssecConfigs -``` - -### Delete -```json -resolverdnssec:DeleteConfig, -route53resolver:UpdateResolverDnssecConfig, -route53resolver:ListResolverDnssecConfigs, -ec2:DescribeVpcs -``` - diff --git a/docs/awscc-docs/providers/awscc/route53resolver/resolverdnssec_configs/index.md b/docs/awscc-docs/providers/awscc/route53resolver/resolverdnssec_configs/index.md deleted file mode 100644 index 6ebbec4007..0000000000 --- a/docs/awscc-docs/providers/awscc/route53resolver/resolverdnssec_configs/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.route53resolver.resolverdnssec_configs -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the resolverdnssec_configs resource, the following permissions are required: - -### Create -```json -resolverdnssec:CreateConfig, -route53resolver:UpdateResolverDnssecConfig, -route53resolver:GetResolverDnssecConfig, -ec2:DescribeVpcs -``` - -### List -```json -resolverdnssec:ListConfig, -route53resolver:ListResolverDnssecConfigs -``` - diff --git a/docs/awscc-docs/providers/awscc/rum/app_monitor/index.md b/docs/awscc-docs/providers/awscc/rum/app_monitor/index.md deleted file mode 100644 index 091e189220..0000000000 --- a/docs/awscc-docs/providers/awscc/rum/app_monitor/index.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id, -name, -domain, -cw_log_enabled, -tags, -app_monitor_configuration, -custom_events -FROM awscc.rum.app_monitor -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the app_monitor resource, the following permissions are required: - -### Read -```json -rum:GetAppMonitor, -dynamodb:GetItem, -s3:GetObject, -s3:DoesObjectExist, -s3:GetObjectAcl, -rum:ListTagsForResource, -rum:ListRumMetricsDestinations, -rum:BatchGetRumMetricDefinitions -``` - -### Update -```json -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 -```json -rum:DeleteAppMonitor, -dynamodb:DeleteItem, -dynamodb:Query, -logs:DeleteLogDelivery, -s3:DeleteObject, -s3:DoesObjectExist, -rum:UntagResource, -rum:DeleteRumMetricsDestination, -rum:BatchDeleteRumMetricDefinitions -``` - diff --git a/docs/awscc-docs/providers/awscc/rum/app_monitors/index.md b/docs/awscc-docs/providers/awscc/rum/app_monitors/index.md deleted file mode 100644 index b1cfeb3e4c..0000000000 --- a/docs/awscc-docs/providers/awscc/rum/app_monitors/index.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.rum.app_monitors -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the app_monitors resource, the following permissions are required: - -### Create -```json -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 -```json -rum:ListAppMonitors, -dynamodb:DescribeTable, -rum:GetAppMonitor, -dynamodb:GetItem, -dynamodb:BatchGetItem, -dynamodb:Query, -s3:GetObject, -s3:DoesObjectExist, -s3:GetObjectAcl, -logs:DescribeLogGroups, -rum:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/rum/index.md b/docs/awscc-docs/providers/awscc/rum/index.md deleted file mode 100644 index 918df15544..0000000000 --- a/docs/awscc-docs/providers/awscc/rum/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 deleted file mode 100644 index bd48947c38..0000000000 --- a/docs/awscc-docs/providers/awscc/s3/access_grant/index.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the access_grant resource, the following permissions are required: - -### Read -```json -s3:GetAccessGrant -``` - -### Delete -```json -s3:DeleteAccessGrant -``` - -### Update -```json -s3:TagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/s3/access_grants/index.md b/docs/awscc-docs/providers/awscc/s3/access_grants/index.md deleted file mode 100644 index 553a2413f3..0000000000 --- a/docs/awscc-docs/providers/awscc/s3/access_grants/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -access_grant_id -FROM awscc.s3.access_grants -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the access_grants resource, the following permissions are required: - -### Create -```json -s3:CreateAccessGrant, -s3:TagResource -``` - -### List -```json -s3:ListAccessGrants -``` - 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 deleted file mode 100644 index c5c17e4fd7..0000000000 --- a/docs/awscc-docs/providers/awscc/s3/access_grants_instance/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -access_grants_instance_arn, -identity_center_arn, -access_grants_instance_id, -tags -FROM awscc.s3.access_grants_instance -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the access_grants_instance resource, the following permissions are required: - -### Read -```json -s3:GetAccessGrantsInstance -``` - -### Delete -```json -s3:DeleteAccessGrantsInstance -``` - -### Update -```json -s3:TagResource -``` - 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 deleted file mode 100644 index fbf30bcecf..0000000000 --- a/docs/awscc-docs/providers/awscc/s3/access_grants_instances/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -access_grants_instance_arn -FROM awscc.s3.access_grants_instances -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the access_grants_instances resource, the following permissions are required: - -### Create -```json -s3:CreateAccessGrantsInstance, -s3:TagResource -``` - -### List -```json -s3:ListAccessGrantsInstances -``` - 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 deleted file mode 100644 index 3cd58ee942..0000000000 --- a/docs/awscc-docs/providers/awscc/s3/access_grants_location/index.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the access_grants_location resource, the following permissions are required: - -### Read -```json -s3:GetAccessGrantsLocation -``` - -### Delete -```json -s3:DeleteAccessGrantsLocation -``` - -### Update -```json -s3:UpdateAccessGrantsLocation, -s3:TagResource, -iam:PassRole -``` - 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 deleted file mode 100644 index c2e9b7e114..0000000000 --- a/docs/awscc-docs/providers/awscc/s3/access_grants_locations/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -access_grants_location_id -FROM awscc.s3.access_grants_locations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the access_grants_locations resource, the following permissions are required: - -### Create -```json -s3:CreateAccessGrantsLocation, -iam:PassRole, -s3:TagResource -``` - -### List -```json -s3:ListAccessGrantsLocations -``` - diff --git a/docs/awscc-docs/providers/awscc/s3/access_point/index.md b/docs/awscc-docs/providers/awscc/s3/access_point/index.md deleted file mode 100644 index be5f9d7c36..0000000000 --- a/docs/awscc-docs/providers/awscc/s3/access_point/index.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the access_point resource, the following permissions are required: - -### Read -```json -s3:GetAccessPoint, -s3:GetAccessPointPolicy -``` - -### Update -```json -s3:PutAccessPointPolicy, -s3:PutAccessPointPublicAccessBlock, -s3:DeleteAccessPointPolicy, -s3:GetAccessPoint, -s3:GetAccessPointPolicy -``` - -### Delete -```json -s3:DeleteAccessPointPolicy, -s3:DeleteAccessPoint -``` - diff --git a/docs/awscc-docs/providers/awscc/s3/access_points/index.md b/docs/awscc-docs/providers/awscc/s3/access_points/index.md deleted file mode 100644 index b6d09df5cd..0000000000 --- a/docs/awscc-docs/providers/awscc/s3/access_points/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.s3.access_points -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the access_points resource, the following permissions are required: - -### Create -```json -s3:CreateAccessPoint, -s3:PutAccessPointPolicy, -s3:PutAccessPointPublicAccessBlock -``` - -### List -```json -s3:ListAccessPoints -``` - diff --git a/docs/awscc-docs/providers/awscc/s3/bucket/index.md b/docs/awscc-docs/providers/awscc/s3/bucket/index.md deleted file mode 100644 index eb88410fe4..0000000000 --- a/docs/awscc-docs/providers/awscc/s3/bucket/index.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -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_urlstringThe Amazon S3 website endpoint for the specified bucket.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## 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_url -FROM awscc.s3.bucket -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the bucket resource, the following permissions are required: - -### Read -```json -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 -```json -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 -```json -s3:DeleteBucket, -s3:ListBucket -``` - diff --git a/docs/awscc-docs/providers/awscc/s3/bucket_policies/index.md b/docs/awscc-docs/providers/awscc/s3/bucket_policies/index.md deleted file mode 100644 index 67eea9e820..0000000000 --- a/docs/awscc-docs/providers/awscc/s3/bucket_policies/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -bucket -FROM awscc.s3.bucket_policies -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the bucket_policies resource, the following permissions are required: - -### Create -```json -s3:GetBucketPolicy, -s3:PutBucketPolicy -``` - -### List -```json -s3:GetBucketPolicy, -s3:ListAllMyBuckets -``` - diff --git a/docs/awscc-docs/providers/awscc/s3/bucket_policy/index.md b/docs/awscc-docs/providers/awscc/s3/bucket_policy/index.md deleted file mode 100644 index 0ce61d6538..0000000000 --- a/docs/awscc-docs/providers/awscc/s3/bucket_policy/index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -bucket, -policy_document -FROM awscc.s3.bucket_policy -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the bucket_policy resource, the following permissions are required: - -### Read -```json -s3:GetBucketPolicy -``` - -### Update -```json -s3:GetBucketPolicy, -s3:PutBucketPolicy -``` - -### Delete -```json -s3:GetBucketPolicy, -s3:DeleteBucketPolicy -``` - diff --git a/docs/awscc-docs/providers/awscc/s3/buckets/index.md b/docs/awscc-docs/providers/awscc/s3/buckets/index.md deleted file mode 100644 index 9ab3887ceb..0000000000 --- a/docs/awscc-docs/providers/awscc/s3/buckets/index.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -bucket_name -FROM awscc.s3.buckets -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the buckets resource, the following permissions are required: - -### Create -```json -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 -```json -s3:ListAllMyBuckets -``` - diff --git a/docs/awscc-docs/providers/awscc/s3/index.md b/docs/awscc-docs/providers/awscc/s3/index.md deleted file mode 100644 index 24a6f43a4f..0000000000 --- a/docs/awscc-docs/providers/awscc/s3/index.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -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 deleted file mode 100644 index 095de5f95f..0000000000 --- a/docs/awscc-docs/providers/awscc/s3/multi_region_access_point/index.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -alias, -created_at, -public_access_block_configuration, -regions -FROM awscc.s3.multi_region_access_point -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the multi_region_access_point resource, the following permissions are required: - -### Read -```json -s3:GetMultiRegionAccessPoint -``` - -### Delete -```json -s3:DeleteMultiRegionAccessPoint, -s3:DescribeMultiRegionAccessPointOperation, -s3:GetMultiRegionAccessPoint -``` - 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 deleted file mode 100644 index 2b762793ce..0000000000 --- a/docs/awscc-docs/providers/awscc/s3/multi_region_access_point_policies/index.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -mrap_name -FROM awscc.s3.multi_region_access_point_policies -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the multi_region_access_point_policies resource, the following permissions are required: - -### Create -```json -s3:PutMultiRegionAccessPointPolicy, -s3:DescribeMultiRegionAccessPointOperation -``` - 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 deleted file mode 100644 index 8d690441ca..0000000000 --- a/docs/awscc-docs/providers/awscc/s3/multi_region_access_point_policy/index.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -mrap_name, -policy, -policy_status -FROM awscc.s3.multi_region_access_point_policy -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the multi_region_access_point_policy resource, the following permissions are required: - -### Update -```json -s3:PutMultiRegionAccessPointPolicy, -s3:DescribeMultiRegionAccessPointOperation -``` - -### Read -```json -s3:GetMultiRegionAccessPointPolicy, -s3:GetMultiRegionAccessPointPolicyStatus -``` - -### Delete -```json -s3:GetMultiRegionAccessPointPolicy, -s3:GetMultiRegionAccessPoint -``` - 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 deleted file mode 100644 index c25102c72a..0000000000 --- a/docs/awscc-docs/providers/awscc/s3/multi_region_access_points/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.s3.multi_region_access_points -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the multi_region_access_points resource, the following permissions are required: - -### Create -```json -s3:CreateMultiRegionAccessPoint, -s3:DescribeMultiRegionAccessPointOperation, -s3:GetMultiRegionAccessPoint -``` - -### List -```json -s3:ListMultiRegionAccessPoints -``` - diff --git a/docs/awscc-docs/providers/awscc/s3/storage_lens/index.md b/docs/awscc-docs/providers/awscc/s3/storage_lens/index.md deleted file mode 100644 index 97413dbb34..0000000000 --- a/docs/awscc-docs/providers/awscc/s3/storage_lens/index.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -storage_lens_configuration, -tags -FROM awscc.s3.storage_lens -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the storage_lens resource, the following permissions are required: - -### Read -```json -s3:GetStorageLensConfiguration, -s3:GetStorageLensConfigurationTagging -``` - -### Update -```json -s3:PutStorageLensConfiguration, -s3:PutStorageLensConfigurationTagging, -s3:GetStorageLensConfiguration, -s3:GetStorageLensConfigurationTagging, -organizations:DescribeOrganization, -organizations:ListAccounts, -organizations:ListAWSServiceAccessForOrganization, -organizations:ListDelegatedAdministrators, -iam:CreateServiceLinkedRole -``` - -### Delete -```json -s3:DeleteStorageLensConfiguration, -s3:DeleteStorageLensConfigurationTagging -``` - 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 deleted file mode 100644 index 7840516697..0000000000 --- a/docs/awscc-docs/providers/awscc/s3/storage_lens_group/index.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -filter, -storage_lens_group_arn, -tags -FROM awscc.s3.storage_lens_group -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the storage_lens_group resource, the following permissions are required: - -### Read -```json -s3:GetStorageLensGroup, -s3:ListTagsForResource -``` - -### Update -```json -s3:GetStorageLensGroup, -s3:UpdateStorageLensGroup, -s3:TagResource, -s3:UntagResource, -s3:ListTagsForResource -``` - -### Delete -```json -s3:DeleteStorageLensGroup -``` - 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 deleted file mode 100644 index 2f702122de..0000000000 --- a/docs/awscc-docs/providers/awscc/s3/storage_lens_groups/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.s3.storage_lens_groups -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the storage_lens_groups resource, the following permissions are required: - -### Create -```json -s3:CreateStorageLensGroup, -s3:GetStorageLensGroup, -s3:TagResource, -s3:ListTagsForResource -``` - -### List -```json -s3:ListStorageLensGroups -``` - diff --git a/docs/awscc-docs/providers/awscc/s3express/bucket_policies/index.md b/docs/awscc-docs/providers/awscc/s3express/bucket_policies/index.md deleted file mode 100644 index ec06d8629e..0000000000 --- a/docs/awscc-docs/providers/awscc/s3express/bucket_policies/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -bucket -FROM awscc.s3express.bucket_policies -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the bucket_policies resource, the following permissions are required: - -### Create -```json -s3express:GetBucketPolicy, -s3express:PutBucketPolicy -``` - -### List -```json -s3express:GetBucketPolicy, -s3express:ListAllMyDirectoryBuckets -``` - diff --git a/docs/awscc-docs/providers/awscc/s3express/bucket_policy/index.md b/docs/awscc-docs/providers/awscc/s3express/bucket_policy/index.md deleted file mode 100644 index 79b1af14ab..0000000000 --- a/docs/awscc-docs/providers/awscc/s3express/bucket_policy/index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -bucket, -policy_document -FROM awscc.s3express.bucket_policy -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the bucket_policy resource, the following permissions are required: - -### Read -```json -s3express:GetBucketPolicy -``` - -### Update -```json -s3express:GetBucketPolicy, -s3express:PutBucketPolicy -``` - -### Delete -```json -s3express:GetBucketPolicy, -s3express:DeleteBucketPolicy -``` - diff --git a/docs/awscc-docs/providers/awscc/s3express/directory_bucket/index.md b/docs/awscc-docs/providers/awscc/s3express/directory_bucket/index.md deleted file mode 100644 index ea89c46d60..0000000000 --- a/docs/awscc-docs/providers/awscc/s3express/directory_bucket/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -bucket_name, -location_name, -data_redundancy, -arn -FROM awscc.s3express.directory_bucket -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the directory_bucket resource, the following permissions are required: - -### Read -```json -s3express:ListAllMyDirectoryBuckets -``` - -### Delete -```json -s3express:DeleteBucket, -s3express:ListAllMyDirectoryBuckets -``` - diff --git a/docs/awscc-docs/providers/awscc/s3express/directory_buckets/index.md b/docs/awscc-docs/providers/awscc/s3express/directory_buckets/index.md deleted file mode 100644 index 5b687ed149..0000000000 --- a/docs/awscc-docs/providers/awscc/s3express/directory_buckets/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -bucket_name -FROM awscc.s3express.directory_buckets -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the directory_buckets resource, the following permissions are required: - -### Create -```json -s3express:CreateBucket, -s3express:ListAllMyDirectoryBuckets -``` - -### List -```json -s3express:ListAllMyDirectoryBuckets -``` - diff --git a/docs/awscc-docs/providers/awscc/s3express/index.md b/docs/awscc-docs/providers/awscc/s3express/index.md deleted file mode 100644 index 4899d4e113..0000000000 --- a/docs/awscc-docs/providers/awscc/s3express/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index a49c68bb4c..0000000000 --- a/docs/awscc-docs/providers/awscc/s3objectlambda/access_point/index.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -alias, -arn, -creation_date, -public_access_block_configuration, -policy_status, -object_lambda_configuration -FROM awscc.s3objectlambda.access_point -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the access_point resource, the following permissions are required: - -### Read -```json -s3:GetAccessPointForObjectLambda, -s3:GetAccessPointPolicyStatusForObjectLambda, -s3:GetAccessPointConfigurationForObjectLambda -``` - -### Update -```json -s3:PutAccessPointConfigurationForObjectLambda, -s3:GetAccessPointForObjectLambda, -s3:GetAccessPointPolicyStatusForObjectLambda, -s3:GetAccessPointConfigurationForObjectLambda -``` - -### Delete -```json -s3:DeleteAccessPointForObjectLambda -``` - 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 deleted file mode 100644 index 40d597fcd9..0000000000 --- a/docs/awscc-docs/providers/awscc/s3objectlambda/access_point_policy/index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -object_lambda_access_point, -policy_document -FROM awscc.s3objectlambda.access_point_policy -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the access_point_policy resource, the following permissions are required: - -### Read -```json -s3:GetAccessPointPolicyForObjectLambda -``` - -### Update -```json -s3:PutAccessPointPolicyForObjectLambda, -s3:GetAccessPointPolicyForObjectLambda -``` - -### Delete -```json -s3:DeleteAccessPointPolicyForObjectLambda, -s3:GetAccessPointPolicyForObjectLambda -``` - diff --git a/docs/awscc-docs/providers/awscc/s3objectlambda/access_points/index.md b/docs/awscc-docs/providers/awscc/s3objectlambda/access_points/index.md deleted file mode 100644 index 303a724598..0000000000 --- a/docs/awscc-docs/providers/awscc/s3objectlambda/access_points/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.s3objectlambda.access_points -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the access_points resource, the following permissions are required: - -### Create -```json -s3:CreateAccessPointForObjectLambda, -s3:PutAccessPointConfigurationForObjectLambda, -s3:GetAccessPointForObjectLambda, -s3:GetAccessPointPolicyStatusForObjectLambda, -s3:GetAccessPointConfigurationForObjectLambda -``` - -### List -```json -s3:ListAccessPointsForObjectLambda -``` - diff --git a/docs/awscc-docs/providers/awscc/s3objectlambda/index.md b/docs/awscc-docs/providers/awscc/s3objectlambda/index.md deleted file mode 100644 index d8eae730f2..0000000000 --- a/docs/awscc-docs/providers/awscc/s3objectlambda/index.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -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: 3
-total selectable resources: 3
-total methods: 3
-
-
- -::: - -## Resources -
-
-access_point
-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 deleted file mode 100644 index b68fc71b35..0000000000 --- a/docs/awscc-docs/providers/awscc/s3outposts/access_point/index.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -bucket, -name, -vpc_configuration, -policy -FROM awscc.s3outposts.access_point -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the access_point resource, the following permissions are required: - -### Read -```json -s3-outposts:GetAccessPoint, -s3-outposts:GetAccessPointPolicy -``` - -### Update -```json -s3-outposts:GetAccessPoint, -s3-outposts:PutAccessPointPolicy, -s3-outposts:GetAccessPointPolicy, -s3-outposts:DeleteAccessPointPolicy -``` - -### Delete -```json -s3-outposts:DeleteAccessPoint, -s3-outposts:DeleteAccessPointPolicy -``` - diff --git a/docs/awscc-docs/providers/awscc/s3outposts/access_points/index.md b/docs/awscc-docs/providers/awscc/s3outposts/access_points/index.md deleted file mode 100644 index 9b515a730b..0000000000 --- a/docs/awscc-docs/providers/awscc/s3outposts/access_points/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.s3outposts.access_points -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the access_points resource, the following permissions are required: - -### Create -```json -s3-outposts:CreateAccessPoint, -s3-outposts:GetAccessPoint, -s3-outposts:PutAccessPointPolicy, -s3-outposts:GetAccessPointPolicy -``` - -### List -```json -s3-outposts:ListAccessPoints -``` - diff --git a/docs/awscc-docs/providers/awscc/s3outposts/bucket/index.md b/docs/awscc-docs/providers/awscc/s3outposts/bucket/index.md deleted file mode 100644 index d87c493048..0000000000 --- a/docs/awscc-docs/providers/awscc/s3outposts/bucket/index.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -bucket_name, -outpost_id, -tags, -lifecycle_configuration -FROM awscc.s3outposts.bucket -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the bucket resource, the following permissions are required: - -### Read -```json -s3-outposts:GetBucket, -s3-outposts:GetBucketTagging, -s3-outposts:GetLifecycleConfiguration -``` - -### Update -```json -s3-outposts:PutBucketTagging, -s3-outposts:DeleteBucketTagging, -s3-outposts:PutLifecycleConfiguration -``` - -### Delete -```json -s3-outposts:DeleteBucket -``` - diff --git a/docs/awscc-docs/providers/awscc/s3outposts/bucket_policy/index.md b/docs/awscc-docs/providers/awscc/s3outposts/bucket_policy/index.md deleted file mode 100644 index fe73c32c85..0000000000 --- a/docs/awscc-docs/providers/awscc/s3outposts/bucket_policy/index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -bucket, -policy_document -FROM awscc.s3outposts.bucket_policy -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the bucket_policy resource, the following permissions are required: - -### Read -```json -s3-outposts:GetBucketPolicy -``` - -### Update -```json -s3-outposts:PutBucketPolicy, -s3-outposts:GetBucketPolicy -``` - -### Delete -```json -s3-outposts:DeleteBucketPolicy, -s3-outposts:GetBucketPolicy -``` - diff --git a/docs/awscc-docs/providers/awscc/s3outposts/buckets/index.md b/docs/awscc-docs/providers/awscc/s3outposts/buckets/index.md deleted file mode 100644 index 8300b6ba59..0000000000 --- a/docs/awscc-docs/providers/awscc/s3outposts/buckets/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.s3outposts.buckets -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the buckets resource, the following permissions are required: - -### Create -```json -s3-outposts:CreateBucket, -s3-outposts:PutBucketTagging, -s3-outposts:PutLifecycleConfiguration -``` - -### List -```json -s3-outposts:ListRegionalBuckets -``` - diff --git a/docs/awscc-docs/providers/awscc/s3outposts/endpoint/index.md b/docs/awscc-docs/providers/awscc/s3outposts/endpoint/index.md deleted file mode 100644 index ee843e61d3..0000000000 --- a/docs/awscc-docs/providers/awscc/s3outposts/endpoint/index.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the endpoint resource, the following permissions are required: - -### Read -```json -s3-outposts:ListEndpoints -``` - -### Delete -```json -s3-outposts:DeleteEndpoint -``` - diff --git a/docs/awscc-docs/providers/awscc/s3outposts/endpoints/index.md b/docs/awscc-docs/providers/awscc/s3outposts/endpoints/index.md deleted file mode 100644 index ce6868dddd..0000000000 --- a/docs/awscc-docs/providers/awscc/s3outposts/endpoints/index.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.s3outposts.endpoints -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the endpoints resource, the following permissions are required: - -### Create -```json -s3-outposts:CreateEndpoint -``` - -### List -```json -s3-outposts:ListEndpoints -``` - diff --git a/docs/awscc-docs/providers/awscc/s3outposts/index.md b/docs/awscc-docs/providers/awscc/s3outposts/index.md deleted file mode 100644 index 8d6b979387..0000000000 --- a/docs/awscc-docs/providers/awscc/s3outposts/index.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -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: 7
-total selectable resources: 7
-total methods: 7
-
-
- -::: - -## Resources -
-
-access_point
-access_points
-bucket
-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 deleted file mode 100644 index 82d03a54af..0000000000 --- a/docs/awscc-docs/providers/awscc/sagemaker/app/index.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -app_arn, -app_name, -app_type, -domain_id, -resource_spec, -tags, -user_profile_name -FROM awscc.sagemaker.app -WHERE data__Identifier = '|||'; -``` - -## Permissions - -To operate on the app resource, the following permissions are required: - -### Read -```json -sagemaker:DescribeApp, -sagemaker:DescribeApp -``` - -### Delete -```json -sagemaker:DeleteApp, -sagemaker:DescribeApp -``` - 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 deleted file mode 100644 index 67f97a69cc..0000000000 --- a/docs/awscc-docs/providers/awscc/sagemaker/app_image_config/index.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the app_image_config resource, the following permissions are required: - -### Read -```json -sagemaker:DescribeAppImageConfig -``` - -### Update -```json -sagemaker:UpdateAppImageConfig, -sagemaker:DescribeAppImageConfig -``` - -### Delete -```json -sagemaker:DeleteAppImageConfig, -sagemaker:DescribeAppImageConfig -``` - 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 deleted file mode 100644 index e859cee8ff..0000000000 --- a/docs/awscc-docs/providers/awscc/sagemaker/app_image_configs/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -app_image_config_name -FROM awscc.sagemaker.app_image_configs -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the app_image_configs resource, the following permissions are required: - -### Create -```json -sagemaker:CreateAppImageConfig, -sagemaker:DescribeAppImageConfig -``` - -### List -```json -sagemaker:ListAppImageConfigs -``` - diff --git a/docs/awscc-docs/providers/awscc/sagemaker/apps/index.md b/docs/awscc-docs/providers/awscc/sagemaker/apps/index.md deleted file mode 100644 index cc5cd65ae9..0000000000 --- a/docs/awscc-docs/providers/awscc/sagemaker/apps/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -app_name, -app_type, -domain_id, -user_profile_name -FROM awscc.sagemaker.apps -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the apps resource, the following permissions are required: - -### Create -```json -sagemaker:CreateApp, -sagemaker:DescribeApp -``` - -### List -```json -sagemaker:ListApps -``` - 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 deleted file mode 100644 index f3aca436a5..0000000000 --- a/docs/awscc-docs/providers/awscc/sagemaker/data_quality_job_definition/index.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the data_quality_job_definition resource, the following permissions are required: - -### Delete -```json -sagemaker:DeleteDataQualityJobDefinition -``` - -### Read -```json -sagemaker:DescribeDataQualityJobDefinition -``` - 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 deleted file mode 100644 index 752264fa9e..0000000000 --- a/docs/awscc-docs/providers/awscc/sagemaker/data_quality_job_definitions/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -job_definition_arn -FROM awscc.sagemaker.data_quality_job_definitions -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the data_quality_job_definitions resource, the following permissions are required: - -### Create -```json -sagemaker:CreateDataQualityJobDefinition, -sagemaker:DescribeDataQualityJobDefinition, -sagemaker:AddTags, -iam:PassRole -``` - -### List -```json -sagemaker:ListDataQualityJobDefinitions, -sagemaker:ListTags -``` - diff --git a/docs/awscc-docs/providers/awscc/sagemaker/device/index.md b/docs/awscc-docs/providers/awscc/sagemaker/device/index.md deleted file mode 100644 index a8a88ac6b8..0000000000 --- a/docs/awscc-docs/providers/awscc/sagemaker/device/index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -device_fleet_name, -device, -tags -FROM awscc.sagemaker.device -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the device resource, the following permissions are required: - -### Read -```json -sagemaker:DescribeDevice -``` - -### Update -```json -sagemaker:UpdateDevices -``` - -### Delete -```json -sagemaker:DeregisterDevices -``` - diff --git a/docs/awscc-docs/providers/awscc/sagemaker/device_fleet/index.md b/docs/awscc-docs/providers/awscc/sagemaker/device_fleet/index.md deleted file mode 100644 index 82cf50da55..0000000000 --- a/docs/awscc-docs/providers/awscc/sagemaker/device_fleet/index.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -description, -device_fleet_name, -output_config, -role_arn, -tags -FROM awscc.sagemaker.device_fleet -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the device_fleet resource, the following permissions are required: - -### Read -```json -sagemaker:DescribeDeviceFleet -``` - -### Update -```json -sagemaker:UpdateDeviceFleet, -iam:PassRole -``` - -### Delete -```json -sagemaker:DeleteDeviceFleet -``` - diff --git a/docs/awscc-docs/providers/awscc/sagemaker/feature_group/index.md b/docs/awscc-docs/providers/awscc/sagemaker/feature_group/index.md deleted file mode 100644 index c28ccc7738..0000000000 --- a/docs/awscc-docs/providers/awscc/sagemaker/feature_group/index.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the feature_group resource, the following permissions are required: - -### Update -```json -sagemaker:UpdateFeatureGroup, -sagemaker:DescribeFeatureGroup, -sagemaker:AddTags, -sagemaker:ListTags, -sagemaker:DeleteTags -``` - -### Read -```json -sagemaker:DescribeFeatureGroup, -sagemaker:ListTags -``` - -### Delete -```json -sagemaker:DeleteFeatureGroup, -sagemaker:DescribeFeatureGroup -``` - diff --git a/docs/awscc-docs/providers/awscc/sagemaker/feature_groups/index.md b/docs/awscc-docs/providers/awscc/sagemaker/feature_groups/index.md deleted file mode 100644 index f60d74d94b..0000000000 --- a/docs/awscc-docs/providers/awscc/sagemaker/feature_groups/index.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -feature_group_name -FROM awscc.sagemaker.feature_groups -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the feature_groups resource, the following permissions are required: - -### Create -```json -iam:PassRole, -kms:CreateGrant, -kms:DescribeKey, -glue:CreateTable, -glue:GetTable, -glue:CreateDatabase, -glue:GetDatabase, -sagemaker:CreateFeatureGroup, -sagemaker:DescribeFeatureGroup, -sagemaker:AddTags, -sagemaker:ListTags -``` - -### List -```json -sagemaker:ListFeatureGroups -``` - diff --git a/docs/awscc-docs/providers/awscc/sagemaker/image/index.md b/docs/awscc-docs/providers/awscc/sagemaker/image/index.md deleted file mode 100644 index f21f69c7b5..0000000000 --- a/docs/awscc-docs/providers/awscc/sagemaker/image/index.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -image_name, -image_arn, -image_role_arn, -image_display_name, -image_description, -tags -FROM awscc.sagemaker.image -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the image resource, the following permissions are required: - -### Read -```json -sagemaker:DescribeImage, -sagemaker:ListTags -``` - -### Update -```json -sagemaker:UpdateImage, -sagemaker:DescribeImage, -sagemaker:ListTags, -sagemaker:AddTags, -sagemaker:DeleteTags, -iam:PassRole -``` - -### Delete -```json -sagemaker:DeleteImage, -sagemaker:DescribeImage -``` - diff --git a/docs/awscc-docs/providers/awscc/sagemaker/image_version/index.md b/docs/awscc-docs/providers/awscc/sagemaker/image_version/index.md deleted file mode 100644 index b0f39da019..0000000000 --- a/docs/awscc-docs/providers/awscc/sagemaker/image_version/index.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -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
ml_frameworkstring
programming_langstring
processorstring
horovodboolean
release_notesstring
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -image_name, -image_arn, -image_version_arn, -base_image, -container_image, -version, -alias, -aliases, -vendor_guidance, -job_type, -ml_framework, -programming_lang, -processor, -horovod, -release_notes -FROM awscc.sagemaker.image_version -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the image_version resource, the following permissions are required: - -### Read -```json -sagemaker:DescribeImageVersion -``` - -### Update -```json -sagemaker:UpdateImageVersion, -sagemaker:DescribeImageVersion, -sagemaker:ListAliases -``` - -### Delete -```json -sagemaker:DeleteImageVersion, -sagemaker:DescribeImageVersion -``` - diff --git a/docs/awscc-docs/providers/awscc/sagemaker/image_versions/index.md b/docs/awscc-docs/providers/awscc/sagemaker/image_versions/index.md deleted file mode 100644 index 36eef3e6a6..0000000000 --- a/docs/awscc-docs/providers/awscc/sagemaker/image_versions/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -image_version_arn -FROM awscc.sagemaker.image_versions -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the image_versions resource, the following permissions are required: - -### Create -```json -sagemaker:CreateImageVersion, -sagemaker:DescribeImageVersion -``` - -### List -```json -sagemaker:ListImageVersions -``` - diff --git a/docs/awscc-docs/providers/awscc/sagemaker/images/index.md b/docs/awscc-docs/providers/awscc/sagemaker/images/index.md deleted file mode 100644 index 0039b1cdca..0000000000 --- a/docs/awscc-docs/providers/awscc/sagemaker/images/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -image_arn -FROM awscc.sagemaker.images -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the images resource, the following permissions are required: - -### Create -```json -sagemaker:CreateImage, -sagemaker:DescribeImage, -iam:PassRole, -sagemaker:AddTags, -sagemaker:ListTags -``` - -### List -```json -sagemaker:ListImages -``` - diff --git a/docs/awscc-docs/providers/awscc/sagemaker/index.md b/docs/awscc-docs/providers/awscc/sagemaker/index.md deleted file mode 100644 index 8fac670b6f..0000000000 --- a/docs/awscc-docs/providers/awscc/sagemaker/index.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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: 40
-total selectable resources: 40
-total methods: 40
-
-
- -::: - -## Resources -
-
-app
-app_image_config
-app_image_configs
-apps
-data_quality_job_definition
-data_quality_job_definitions
-device
-device_fleet
-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 deleted file mode 100644 index 33a1b4bcd5..0000000000 --- a/docs/awscc-docs/providers/awscc/sagemaker/inference_component/index.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the inference_component resource, the following permissions are required: - -### Update -```json -sagemaker:UpdateInferenceComponent, -sagemaker:UpdateInferenceComponentRuntimeConfig, -sagemaker:DescribeInferenceComponent, -sagemaker:AddTags, -sagemaker:ListTags, -sagemaker:DeleteTags -``` - -### Delete -```json -sagemaker:DescribeInferenceComponent, -sagemaker:DeleteInferenceComponent, -sagemaker:DeleteTags -``` - -### Read -```json -sagemaker:DescribeInferenceComponent, -sagemaker:ListTags -``` - diff --git a/docs/awscc-docs/providers/awscc/sagemaker/inference_components/index.md b/docs/awscc-docs/providers/awscc/sagemaker/inference_components/index.md deleted file mode 100644 index c63d564851..0000000000 --- a/docs/awscc-docs/providers/awscc/sagemaker/inference_components/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -inference_component_arn -FROM awscc.sagemaker.inference_components -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the inference_components resource, the following permissions are required: - -### Create -```json -sagemaker:AddTags, -sagemaker:ListTags, -sagemaker:CreateInferenceComponent, -sagemaker:DescribeInferenceComponent -``` - -### List -```json -sagemaker:ListInferenceComponents, -sagemaker:DescribeInferenceComponent, -sagemaker:ListTags -``` - diff --git a/docs/awscc-docs/providers/awscc/sagemaker/inference_experiment/index.md b/docs/awscc-docs/providers/awscc/sagemaker/inference_experiment/index.md deleted file mode 100644 index b7a84854f5..0000000000 --- a/docs/awscc-docs/providers/awscc/sagemaker/inference_experiment/index.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the inference_experiment resource, the following permissions are required: - -### Delete -```json -sagemaker:DeleteInferenceExperiment, -sagemaker:DescribeInferenceExperiment, -sagemaker:StopInferenceExperiment, -sagemaker:ListTags -``` - -### Read -```json -sagemaker:DescribeInferenceExperiment, -sagemaker:ListTags -``` - -### Update -```json -sagemaker:UpdateInferenceExperiment, -sagemaker:StartInferenceExperiment, -sagemaker:StopInferenceExperiment, -sagemaker:DescribeInferenceExperiment, -sagemaker:AddTags, -sagemaker:DeleteTags, -sagemaker:ListTags -``` - diff --git a/docs/awscc-docs/providers/awscc/sagemaker/inference_experiments/index.md b/docs/awscc-docs/providers/awscc/sagemaker/inference_experiments/index.md deleted file mode 100644 index 8ebce09249..0000000000 --- a/docs/awscc-docs/providers/awscc/sagemaker/inference_experiments/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.sagemaker.inference_experiments -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the inference_experiments resource, the following permissions are required: - -### Create -```json -sagemaker:CreateInferenceExperiment, -sagemaker:DescribeInferenceExperiment, -sagemaker:AddTags, -sagemaker:ListTags, -iam:PassRole -``` - -### List -```json -sagemaker:ListInferenceExperiments -``` - 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 deleted file mode 100644 index 754e61f5fc..0000000000 --- a/docs/awscc-docs/providers/awscc/sagemaker/model_bias_job_definition/index.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the model_bias_job_definition resource, the following permissions are required: - -### Delete -```json -sagemaker:DeleteModelBiasJobDefinition -``` - -### Read -```json -sagemaker:DescribeModelBiasJobDefinition -``` - 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 deleted file mode 100644 index bb95ab9376..0000000000 --- a/docs/awscc-docs/providers/awscc/sagemaker/model_bias_job_definitions/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -job_definition_arn -FROM awscc.sagemaker.model_bias_job_definitions -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the model_bias_job_definitions resource, the following permissions are required: - -### Create -```json -sagemaker:CreateModelBiasJobDefinition, -sagemaker:DescribeModelBiasJobDefinition, -iam:PassRole, -sagemaker:AddTags -``` - -### List -```json -sagemaker:ListModelBiasJobDefinitions, -sagemaker:ListTags -``` - diff --git a/docs/awscc-docs/providers/awscc/sagemaker/model_card/index.md b/docs/awscc-docs/providers/awscc/sagemaker/model_card/index.md deleted file mode 100644 index 79b51b88f9..0000000000 --- a/docs/awscc-docs/providers/awscc/sagemaker/model_card/index.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the model_card resource, the following permissions are required: - -### Read -```json -sagemaker:DescribeModelCard, -sagemaker:DescribeModelPackageGroup, -sagemaker:DescribeModelPackage, -kms:Decrypt, -sagemaker:ListTags -``` - -### Update -```json -sagemaker:UpdateModelCard, -sagemaker:DescribeModelCard, -kms:GenerateDataKey, -kms:Decrypt, -sagemaker:DescribeModelPackageGroup, -sagemaker:DescribeModelPackage, -sagemaker:ListTags, -sagemaker:AddTags, -sagemaker:DeleteTags -``` - -### Delete -```json -sagemaker:DescribeModelCard, -sagemaker:DeleteModelCard, -sagemaker:DescribeModelPackageGroup, -sagemaker:DescribeModelPackage, -kms:RetireGrant, -kms:Decrypt, -sagemaker:ListTags, -sagemaker:DeleteTags -``` - diff --git a/docs/awscc-docs/providers/awscc/sagemaker/model_cards/index.md b/docs/awscc-docs/providers/awscc/sagemaker/model_cards/index.md deleted file mode 100644 index 9bdfa8ac1a..0000000000 --- a/docs/awscc-docs/providers/awscc/sagemaker/model_cards/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -model_card_name -FROM awscc.sagemaker.model_cards -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the model_cards resource, the following permissions are required: - -### Create -```json -sagemaker:CreateModelCard, -kms:DescribeKey, -kms:GenerateDataKey, -kms:CreateGrant, -sagemaker:DescribeModelPackageGroup, -sagemaker:DescribeModelPackage, -sagemaker:AddTags -``` - -### List -```json -sagemaker:ListModelCards, -sagemaker:ListModelCardVersions -``` - 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 deleted file mode 100644 index 10196256e8..0000000000 --- a/docs/awscc-docs/providers/awscc/sagemaker/model_explainability_job_definition/index.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the model_explainability_job_definition resource, the following permissions are required: - -### Delete -```json -sagemaker:DeleteModelExplainabilityJobDefinition -``` - -### Read -```json -sagemaker:DescribeModelExplainabilityJobDefinition -``` - 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 deleted file mode 100644 index ba35ab80a2..0000000000 --- a/docs/awscc-docs/providers/awscc/sagemaker/model_explainability_job_definitions/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -job_definition_arn -FROM awscc.sagemaker.model_explainability_job_definitions -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the model_explainability_job_definitions resource, the following permissions are required: - -### Create -```json -sagemaker:CreateModelExplainabilityJobDefinition, -sagemaker:DescribeModelExplainabilityJobDefinition, -iam:PassRole, -sagemaker:AddTags -``` - -### List -```json -sagemaker:ListModelExplainabilityJobDefinitions, -sagemaker:ListTags -``` - diff --git a/docs/awscc-docs/providers/awscc/sagemaker/model_package/index.md b/docs/awscc-docs/providers/awscc/sagemaker/model_package/index.md deleted file mode 100644 index 9cc3683b02..0000000000 --- a/docs/awscc-docs/providers/awscc/sagemaker/model_package/index.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the model_package resource, the following permissions are required: - -### Read -```json -sagemaker:DescribeModelPackage, -sagemaker:ListTags -``` - -### Update -```json -sagemaker:UpdateModelPackage, -sagemaker:DescribeModelPackage, -sagemaker:ListTags, -sagemaker:AddTags, -sagemaker:DeleteTags -``` - -### Delete -```json -sagemaker:DeleteModelPackage, -sagemaker:DescribeModelPackage -``` - 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 deleted file mode 100644 index 597b466673..0000000000 --- a/docs/awscc-docs/providers/awscc/sagemaker/model_package_group/index.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the model_package_group resource, the following permissions are required: - -### Delete -```json -sagemaker:DeleteModelPackageGroup, -sagemaker:DescribeModelPackageGroup, -sagemaker:GetModelPackageGroupPolicy, -sagemaker:DeleteModelPackageGroupPolicy -``` - -### Read -```json -sagemaker:DescribeModelPackageGroup, -sagemaker:GetModelPackageGroupPolicy, -sagemaker:PutModelPackageGroupPolicy, -sagemaker:ListTags -``` - -### Update -```json -sagemaker:DescribeModelPackageGroup, -sagemaker:GetModelPackageGroupPolicy, -sagemaker:DeleteModelPackageGroupPolicy, -sagemaker:PutModelPackageGroupPolicy, -sagemaker:ListTags, -sagemaker:AddTags, -sagemaker:DeleteTags -``` - 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 deleted file mode 100644 index 8d6275355f..0000000000 --- a/docs/awscc-docs/providers/awscc/sagemaker/model_package_groups/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -model_package_group_arn -FROM awscc.sagemaker.model_package_groups -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the model_package_groups resource, the following permissions are required: - -### Create -```json -sagemaker:CreateModelPackageGroup, -sagemaker:DescribeModelPackageGroup, -sagemaker:GetModelPackageGroupPolicy, -sagemaker:PutModelPackageGroupPolicy, -sagemaker:ListTags, -sagemaker:AddTags -``` - -### List -```json -sagemaker:ListModelPackageGroups -``` - diff --git a/docs/awscc-docs/providers/awscc/sagemaker/model_packages/index.md b/docs/awscc-docs/providers/awscc/sagemaker/model_packages/index.md deleted file mode 100644 index ce92d965bb..0000000000 --- a/docs/awscc-docs/providers/awscc/sagemaker/model_packages/index.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -model_package_arn -FROM awscc.sagemaker.model_packages -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the model_packages resource, the following permissions are required: - -### Create -```json -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 -```json -sagemaker:ListModelPackages -``` - 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 deleted file mode 100644 index 8c18fa3b77..0000000000 --- a/docs/awscc-docs/providers/awscc/sagemaker/model_quality_job_definition/index.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the model_quality_job_definition resource, the following permissions are required: - -### Delete -```json -sagemaker:DeleteModelQualityJobDefinition -``` - -### Read -```json -sagemaker:DescribeModelQualityJobDefinition -``` - 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 deleted file mode 100644 index aaa81a5ce8..0000000000 --- a/docs/awscc-docs/providers/awscc/sagemaker/model_quality_job_definitions/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -job_definition_arn -FROM awscc.sagemaker.model_quality_job_definitions -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the model_quality_job_definitions resource, the following permissions are required: - -### Create -```json -sagemaker:CreateModelQualityJobDefinition, -sagemaker:DescribeModelQualityJobDefinition, -sagemaker:AddTags, -iam:PassRole -``` - -### List -```json -sagemaker:ListModelQualityJobDefinitions, -sagemaker:ListTags -``` - diff --git a/docs/awscc-docs/providers/awscc/sagemaker/monitoring_schedule/index.md b/docs/awscc-docs/providers/awscc/sagemaker/monitoring_schedule/index.md deleted file mode 100644 index dfee3a2967..0000000000 --- a/docs/awscc-docs/providers/awscc/sagemaker/monitoring_schedule/index.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the monitoring_schedule resource, the following permissions are required: - -### Delete -```json -sagemaker:DeleteMonitoringSchedule, -sagemaker:DescribeMonitoringSchedule -``` - -### Read -```json -sagemaker:DescribeMonitoringSchedule -``` - -### Update -```json -sagemaker:UpdateMonitoringSchedule, -sagemaker:DescribeMonitoringSchedule -``` - diff --git a/docs/awscc-docs/providers/awscc/sagemaker/monitoring_schedules/index.md b/docs/awscc-docs/providers/awscc/sagemaker/monitoring_schedules/index.md deleted file mode 100644 index 6d008f1f2a..0000000000 --- a/docs/awscc-docs/providers/awscc/sagemaker/monitoring_schedules/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -monitoring_schedule_arn -FROM awscc.sagemaker.monitoring_schedules -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the monitoring_schedules resource, the following permissions are required: - -### Create -```json -sagemaker:CreateMonitoringSchedule, -sagemaker:DescribeMonitoringSchedule, -iam:PassRole -``` - -### List -```json -sagemaker:ListMonitoringSchedule -``` - diff --git a/docs/awscc-docs/providers/awscc/sagemaker/pipeline/index.md b/docs/awscc-docs/providers/awscc/sagemaker/pipeline/index.md deleted file mode 100644 index 46baeba096..0000000000 --- a/docs/awscc-docs/providers/awscc/sagemaker/pipeline/index.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -pipeline_name, -pipeline_display_name, -pipeline_description, -pipeline_definition, -role_arn, -tags, -parallelism_configuration -FROM awscc.sagemaker.pipeline -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the pipeline resource, the following permissions are required: - -### Read -```json -sagemaker:DescribePipeline, -sagemaker:ListTags -``` - -### Update -```json -iam:PassRole, -s3:GetObject, -sagemaker:UpdatePipeline, -sagemaker:DescribePipeline, -sagemaker:AddTags, -sagemaker:DeleteTags, -sagemaker:ListTags -``` - -### Delete -```json -sagemaker:DeletePipeline -``` - diff --git a/docs/awscc-docs/providers/awscc/sagemaker/pipelines/index.md b/docs/awscc-docs/providers/awscc/sagemaker/pipelines/index.md deleted file mode 100644 index 1a543a3972..0000000000 --- a/docs/awscc-docs/providers/awscc/sagemaker/pipelines/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -pipeline_name -FROM awscc.sagemaker.pipelines -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the pipelines resource, the following permissions are required: - -### Create -```json -iam:PassRole, -s3:GetObject, -sagemaker:CreatePipeline, -sagemaker:DescribePipeline, -sagemaker:AddTags, -sagemaker:ListTags -``` - -### List -```json -sagemaker:ListPipelines -``` - diff --git a/docs/awscc-docs/providers/awscc/sagemaker/project/index.md b/docs/awscc-docs/providers/awscc/sagemaker/project/index.md deleted file mode 100644 index 3f0f7a777e..0000000000 --- a/docs/awscc-docs/providers/awscc/sagemaker/project/index.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the project resource, the following permissions are required: - -### Read -```json -sagemaker:DescribeProject, -sagemaker:ListTags -``` - -### Update -```json -sagemaker:DescribeProject, -sagemaker:ListTags, -sagemaker:AddTags, -sagemaker:DeleteTags -``` - -### Delete -```json -sagemaker:DeleteProject, -sagemaker:DescribeProject, -servicecatalog:TerminateProvisionedProduct, -servicecatalog:DescribeRecord -``` - diff --git a/docs/awscc-docs/providers/awscc/sagemaker/projects/index.md b/docs/awscc-docs/providers/awscc/sagemaker/projects/index.md deleted file mode 100644 index 6648ecbb02..0000000000 --- a/docs/awscc-docs/providers/awscc/sagemaker/projects/index.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -project_arn -FROM awscc.sagemaker.projects -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the projects resource, the following permissions are required: - -### Create -```json -sagemaker:AddTags, -sagemaker:CreateProject, -sagemaker:DescribeProject, -sagemaker:ListTags, -servicecatalog:DescribeProduct, -servicecatalog:DescribeProvisioningArtifact, -servicecatalog:ProvisionProduct, -servicecatalog:DescribeProvisionedProduct, -servicecatalog:TerminateProvisionedProduct -``` - -### List -```json -sagemaker:ListProjects -``` - diff --git a/docs/awscc-docs/providers/awscc/sagemaker/space/index.md b/docs/awscc-docs/providers/awscc/sagemaker/space/index.md deleted file mode 100644 index 04dbcce466..0000000000 --- a/docs/awscc-docs/providers/awscc/sagemaker/space/index.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the space resource, the following permissions are required: - -### Read -```json -sagemaker:DescribeSpace -``` - -### Update -```json -sagemaker:UpdateSpace, -sagemaker:DescribeSpace -``` - -### Delete -```json -sagemaker:DeleteSpace, -sagemaker:DescribeSpace -``` - diff --git a/docs/awscc-docs/providers/awscc/sagemaker/spaces/index.md b/docs/awscc-docs/providers/awscc/sagemaker/spaces/index.md deleted file mode 100644 index df78f5a38f..0000000000 --- a/docs/awscc-docs/providers/awscc/sagemaker/spaces/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -domain_id, -space_name -FROM awscc.sagemaker.spaces -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the spaces resource, the following permissions are required: - -### Create -```json -sagemaker:CreateSpace, -sagemaker:DescribeSpace -``` - -### List -```json -sagemaker:ListSpaces -``` - diff --git a/docs/awscc-docs/providers/awscc/sagemaker/user_profile/index.md b/docs/awscc-docs/providers/awscc/sagemaker/user_profile/index.md deleted file mode 100644 index 546c2b14b3..0000000000 --- a/docs/awscc-docs/providers/awscc/sagemaker/user_profile/index.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the user_profile resource, the following permissions are required: - -### Read -```json -sagemaker:DescribeUserProfile -``` - -### Update -```json -sagemaker:UpdateUserProfile, -sagemaker:DescribeUserProfile, -sagemaker:DescribeImage, -sagemaker:DescribeImageVersion, -iam:PassRole -``` - -### Delete -```json -sagemaker:DeleteUserProfile, -sagemaker:DescribeUserProfile -``` - diff --git a/docs/awscc-docs/providers/awscc/sagemaker/user_profiles/index.md b/docs/awscc-docs/providers/awscc/sagemaker/user_profiles/index.md deleted file mode 100644 index 5b89584888..0000000000 --- a/docs/awscc-docs/providers/awscc/sagemaker/user_profiles/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -user_profile_name, -domain_id -FROM awscc.sagemaker.user_profiles -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the user_profiles resource, the following permissions are required: - -### Create -```json -sagemaker:CreateUserProfile, -sagemaker:DescribeUserProfile, -sagemaker:DescribeImage, -sagemaker:DescribeImageVersion, -iam:PassRole -``` - -### List -```json -sagemaker:ListUserProfiles -``` - diff --git a/docs/awscc-docs/providers/awscc/scheduler/index.md b/docs/awscc-docs/providers/awscc/scheduler/index.md deleted file mode 100644 index 239c23a5ea..0000000000 --- a/docs/awscc-docs/providers/awscc/scheduler/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index b56e7376c3..0000000000 --- a/docs/awscc-docs/providers/awscc/scheduler/schedule/index.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the schedule resource, the following permissions are required: - -### Read -```json -scheduler:GetSchedule -``` - -### Update -```json -scheduler:UpdateSchedule, -scheduler:GetSchedule, -iam:PassRole -``` - -### Delete -```json -scheduler:DeleteSchedule, -scheduler:GetSchedule -``` - diff --git a/docs/awscc-docs/providers/awscc/scheduler/schedule_group/index.md b/docs/awscc-docs/providers/awscc/scheduler/schedule_group/index.md deleted file mode 100644 index 933fe8c592..0000000000 --- a/docs/awscc-docs/providers/awscc/scheduler/schedule_group/index.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -creation_date, -last_modification_date, -name, -state, -tags -FROM awscc.scheduler.schedule_group -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the schedule_group resource, the following permissions are required: - -### Read -```json -scheduler:GetScheduleGroup, -scheduler:ListTagsForResource -``` - -### Update -```json -scheduler:TagResource, -scheduler:UntagResource, -scheduler:ListTagsForResource, -scheduler:GetScheduleGroup -``` - -### Delete -```json -scheduler:DeleteScheduleGroup, -scheduler:GetScheduleGroup, -scheduler:DeleteSchedule -``` - diff --git a/docs/awscc-docs/providers/awscc/scheduler/schedule_groups/index.md b/docs/awscc-docs/providers/awscc/scheduler/schedule_groups/index.md deleted file mode 100644 index f26d352ba1..0000000000 --- a/docs/awscc-docs/providers/awscc/scheduler/schedule_groups/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.scheduler.schedule_groups -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the schedule_groups resource, the following permissions are required: - -### Create -```json -scheduler:TagResource, -scheduler:CreateScheduleGroup, -scheduler:GetScheduleGroup, -scheduler:ListTagsForResource -``` - -### List -```json -scheduler:ListScheduleGroups -``` - diff --git a/docs/awscc-docs/providers/awscc/scheduler/schedules/index.md b/docs/awscc-docs/providers/awscc/scheduler/schedules/index.md deleted file mode 100644 index 41958fa2ad..0000000000 --- a/docs/awscc-docs/providers/awscc/scheduler/schedules/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.scheduler.schedules -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the schedules resource, the following permissions are required: - -### Create -```json -scheduler:CreateSchedule, -scheduler:GetSchedule, -iam:PassRole -``` - -### List -```json -scheduler:ListSchedules -``` - diff --git a/docs/awscc-docs/providers/awscc/secretsmanager/index.md b/docs/awscc-docs/providers/awscc/secretsmanager/index.md deleted file mode 100644 index 0895daf3a0..0000000000 --- a/docs/awscc-docs/providers/awscc/secretsmanager/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 deleted file mode 100644 index f97cff9533..0000000000 --- a/docs/awscc-docs/providers/awscc/secretsmanager/secret/index.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -description, -kms_key_id, -secret_string, -generate_secret_string, -replica_regions, -id, -tags, -name -FROM awscc.secretsmanager.secret -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the secret resource, the following permissions are required: - -### Delete -```json -secretsmanager:DeleteSecret, -secretsmanager:DescribeSecret, -secretsmanager:RemoveRegionsFromReplication -``` - -### Read -```json -secretsmanager:DescribeSecret, -secretsmanager:GetSecretValue -``` - -### Update -```json -secretsmanager:UpdateSecret, -secretsmanager:TagResource, -secretsmanager:UntagResource, -secretsmanager:GetRandomPassword, -secretsmanager:GetSecretValue, -secretsmanager:ReplicateSecretToRegions, -secretsmanager:RemoveRegionsFromReplication -``` - diff --git a/docs/awscc-docs/providers/awscc/secretsmanager/secrets/index.md b/docs/awscc-docs/providers/awscc/secretsmanager/secrets/index.md deleted file mode 100644 index 62f32dbad8..0000000000 --- a/docs/awscc-docs/providers/awscc/secretsmanager/secrets/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.secretsmanager.secrets -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the secrets resource, the following permissions are required: - -### Create -```json -secretsmanager:DescribeSecret, -secretsmanager:GetRandomPassword, -secretsmanager:CreateSecret, -secretsmanager:TagResource -``` - -### List -```json -secretsmanager:ListSecrets -``` - diff --git a/docs/awscc-docs/providers/awscc/securityhub/automation_rule/index.md b/docs/awscc-docs/providers/awscc/securityhub/automation_rule/index.md deleted file mode 100644 index 0421abea2f..0000000000 --- a/docs/awscc-docs/providers/awscc/securityhub/automation_rule/index.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the automation_rule resource, the following permissions are required: - -### Read -```json -securityhub:ListAutomationRules, -securityhub:BatchGetAutomationRules, -securityhub:ListTagsForResource -``` - -### Update -```json -securityhub:BatchUpdateAutomationRules, -securityhub:TagResource, -securityhub:UntagResource, -securityhub:ListTagsForResource -``` - -### Delete -```json -securityhub:BatchDeleteAutomationRules, -securityhub:BatchGetAutomationRules -``` - diff --git a/docs/awscc-docs/providers/awscc/securityhub/automation_rules/index.md b/docs/awscc-docs/providers/awscc/securityhub/automation_rules/index.md deleted file mode 100644 index da6bd6e9b2..0000000000 --- a/docs/awscc-docs/providers/awscc/securityhub/automation_rules/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -rule_arn -FROM awscc.securityhub.automation_rules -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the automation_rules resource, the following permissions are required: - -### Create -```json -securityhub:CreateAutomationRule, -securityhub:TagResource, -securityhub:ListTagsForResource -``` - -### List -```json -securityhub:ListAutomationRules, -securityhub:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/securityhub/hub/index.md b/docs/awscc-docs/providers/awscc/securityhub/hub/index.md deleted file mode 100644 index 401c7b8f88..0000000000 --- a/docs/awscc-docs/providers/awscc/securityhub/hub/index.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -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
arnstringAn 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. - -## Example -```sql -SELECT -region, -arn, -enable_default_standards, -control_finding_generator, -auto_enable_controls, -tags, -subscribed_at -FROM awscc.securityhub.hub -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the hub resource, the following permissions are required: - -### Read -```json -securityhub:DescribeHub, -securityhub:ListTagsForResource -``` - -### Update -```json -securityhub:DescribeHub, -securityhub:UpdateSecurityHubConfiguration, -securityhub:TagResource, -securityhub:UntagResource, -securityhub:ListTagsForResource -``` - -### Delete -```json -securityhub:DisableSecurityHub -``` - diff --git a/docs/awscc-docs/providers/awscc/securityhub/hubs/index.md b/docs/awscc-docs/providers/awscc/securityhub/hubs/index.md deleted file mode 100644 index a44b8ff885..0000000000 --- a/docs/awscc-docs/providers/awscc/securityhub/hubs/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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
arnstringAn ARN is automatically created for the customer.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -arn -FROM awscc.securityhub.hubs -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the hubs resource, the following permissions are required: - -### Create -```json -securityhub:EnableSecurityHub, -securityhub:UpdateSecurityHubConfiguration, -securityhub:TagResource, -securityhub:ListTagsForResource -``` - -### List -```json -securityhub:DescribeHub, -securityhub:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/securityhub/index.md b/docs/awscc-docs/providers/awscc/securityhub/index.md deleted file mode 100644 index 86c03e0078..0000000000 --- a/docs/awscc-docs/providers/awscc/securityhub/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -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 deleted file mode 100644 index 59dac8047e..0000000000 --- a/docs/awscc-docs/providers/awscc/securityhub/standard/index.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -standards_subscription_arn, -standards_arn, -disabled_standards_controls -FROM awscc.securityhub.standard -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the standard resource, the following permissions are required: - -### Read -```json -securityhub:GetEnabledStandards, -securityhub:DescribeStandardsControls -``` - -### Update -```json -securityhub:GetEnabledStandards, -securityhub:UpdateStandardsControl -``` - -### Delete -```json -securityhub:GetEnabledStandards, -securityhub:BatchDisableStandards -``` - diff --git a/docs/awscc-docs/providers/awscc/securityhub/standards/index.md b/docs/awscc-docs/providers/awscc/securityhub/standards/index.md deleted file mode 100644 index aef6e62bc6..0000000000 --- a/docs/awscc-docs/providers/awscc/securityhub/standards/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -standards_subscription_arn -FROM awscc.securityhub.standards -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the standards resource, the following permissions are required: - -### Create -```json -securityhub:GetEnabledStandards, -securityhub:BatchEnableStandards, -securityhub:UpdateStandardsControl -``` - -### List -```json -securityhub:GetEnabledStandards -``` - 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 deleted file mode 100644 index 471a264760..0000000000 --- a/docs/awscc-docs/providers/awscc/servicecatalog/cloud_formation_provisioned_product/index.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the cloud_formation_provisioned_product resource, the following permissions are required: - -### Read -```json -* -``` - -### Update -```json -* -``` - -### Delete -```json -* -``` - diff --git a/docs/awscc-docs/providers/awscc/servicecatalog/index.md b/docs/awscc-docs/providers/awscc/servicecatalog/index.md deleted file mode 100644 index 81fde74538..0000000000 --- a/docs/awscc-docs/providers/awscc/servicecatalog/index.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -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: 5
-total selectable resources: 5
-total methods: 5
-
-
- -::: - -## Resources -
-
-cloud_formation_provisioned_product
-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 deleted file mode 100644 index 84b2f603dd..0000000000 --- a/docs/awscc-docs/providers/awscc/servicecatalog/service_action/index.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -accept_language, -name, -definition_type, -definition, -description, -id -FROM awscc.servicecatalog.service_action -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the service_action resource, the following permissions are required: - -### Read -```json -servicecatalog:DescribeServiceAction -``` - -### Update -```json -servicecatalog:UpdateServiceAction, -iam:GetRole, -ssm:DescribeDocument -``` - -### Delete -```json -servicecatalog:DeleteServiceAction -``` - 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 deleted file mode 100644 index c21f14885e..0000000000 --- a/docs/awscc-docs/providers/awscc/servicecatalog/service_action_association/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -product_id, -provisioning_artifact_id, -service_action_id -FROM awscc.servicecatalog.service_action_association -WHERE data__Identifier = '||'; -``` - -## Permissions - -To operate on the service_action_association resource, the following permissions are required: - -### Read -```json -servicecatalog:ListServiceActionsForProvisioningArtifact -``` - -### Delete -```json -servicecatalog:DisassociateServiceActionFromProvisioningArtifact, -servicecatalog:ListServiceActionsForProvisioningArtifact -``` - 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 deleted file mode 100644 index 0d707207d8..0000000000 --- a/docs/awscc-docs/providers/awscc/servicecatalog/service_action_associations/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -product_id, -provisioning_artifact_id, -service_action_id -FROM awscc.servicecatalog.service_action_associations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the service_action_associations resource, the following permissions are required: - -### Create -```json -servicecatalog:AssociateServiceActionWithProvisioningArtifact, -servicecatalog:ListServiceActionsForProvisioningArtifact -``` - -### List -```json -servicecatalog:ListServiceActionsForProvisioningArtifact -``` - diff --git a/docs/awscc-docs/providers/awscc/servicecatalog/service_actions/index.md b/docs/awscc-docs/providers/awscc/servicecatalog/service_actions/index.md deleted file mode 100644 index 3b2f62b682..0000000000 --- a/docs/awscc-docs/providers/awscc/servicecatalog/service_actions/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.servicecatalog.service_actions -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the service_actions resource, the following permissions are required: - -### Create -```json -servicecatalog:CreateServiceAction, -ssm:DescribeDocument, -iam:GetRole -``` - -### List -```json -servicecatalog:ListServiceActions -``` - diff --git a/docs/awscc-docs/providers/awscc/servicecatalogappregistry/application/index.md b/docs/awscc-docs/providers/awscc/servicecatalogappregistry/application/index.md deleted file mode 100644 index a7e4a084b8..0000000000 --- a/docs/awscc-docs/providers/awscc/servicecatalogappregistry/application/index.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id, -arn, -name, -description, -tags, -application_tag_key, -application_tag_value, -application_name -FROM awscc.servicecatalogappregistry.application -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the application resource, the following permissions are required: - -### Read -```json -servicecatalog:GetApplication -``` - -### Update -```json -servicecatalog:GetApplication, -servicecatalog:ListTagsForResource, -servicecatalog:TagResource, -servicecatalog:UntagResource, -servicecatalog:UpdateApplication, -iam:CreateServiceLinkedRole -``` - -### Delete -```json -servicecatalog:DeleteApplication -``` - diff --git a/docs/awscc-docs/providers/awscc/servicecatalogappregistry/applications/index.md b/docs/awscc-docs/providers/awscc/servicecatalogappregistry/applications/index.md deleted file mode 100644 index b450c8f9cf..0000000000 --- a/docs/awscc-docs/providers/awscc/servicecatalogappregistry/applications/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.servicecatalogappregistry.applications -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the applications resource, the following permissions are required: - -### Create -```json -servicecatalog:CreateApplication, -servicecatalog:TagResource, -iam:CreateServiceLinkedRole -``` - -### List -```json -servicecatalog:ListApplications -``` - diff --git a/docs/awscc-docs/providers/awscc/servicecatalogappregistry/attribute_group/index.md b/docs/awscc-docs/providers/awscc/servicecatalogappregistry/attribute_group/index.md deleted file mode 100644 index 6ee0a665ff..0000000000 --- a/docs/awscc-docs/providers/awscc/servicecatalogappregistry/attribute_group/index.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id, -arn, -name, -description, -attributes, -tags -FROM awscc.servicecatalogappregistry.attribute_group -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the attribute_group resource, the following permissions are required: - -### Read -```json -servicecatalog:GetAttributeGroup -``` - -### Update -```json -servicecatalog:GetAttributeGroup, -servicecatalog:UpdateAttributeGroup, -servicecatalog:ListTagsForResource, -servicecatalog:TagResource, -servicecatalog:UntagResource -``` - -### Delete -```json -servicecatalog:DeleteAttributeGroup -``` - 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 deleted file mode 100644 index b6d113e44d..0000000000 --- a/docs/awscc-docs/providers/awscc/servicecatalogappregistry/attribute_group_association/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -application, -attribute_group, -application_arn, -attribute_group_arn -FROM awscc.servicecatalogappregistry.attribute_group_association -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the attribute_group_association resource, the following permissions are required: - -### Read -```json -servicecatalog:ListAttributeGroupsForApplication -``` - -### Delete -```json -servicecatalog:DisassociateAttributeGroup -``` - 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 deleted file mode 100644 index 83aedd30ec..0000000000 --- a/docs/awscc-docs/providers/awscc/servicecatalogappregistry/attribute_group_associations/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -application_arn, -attribute_group_arn -FROM awscc.servicecatalogappregistry.attribute_group_associations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the attribute_group_associations resource, the following permissions are required: - -### Create -```json -servicecatalog:AssociateAttributeGroup -``` - -### List -```json -servicecatalog:ListAttributeGroupsForApplication -``` - diff --git a/docs/awscc-docs/providers/awscc/servicecatalogappregistry/attribute_groups/index.md b/docs/awscc-docs/providers/awscc/servicecatalogappregistry/attribute_groups/index.md deleted file mode 100644 index ff7c539056..0000000000 --- a/docs/awscc-docs/providers/awscc/servicecatalogappregistry/attribute_groups/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.servicecatalogappregistry.attribute_groups -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the attribute_groups resource, the following permissions are required: - -### Create -```json -servicecatalog:CreateAttributeGroup, -servicecatalog:TagResource -``` - -### List -```json -servicecatalog:ListAttributeGroups -``` - diff --git a/docs/awscc-docs/providers/awscc/servicecatalogappregistry/index.md b/docs/awscc-docs/providers/awscc/servicecatalogappregistry/index.md deleted file mode 100644 index 6dc87b7a4c..0000000000 --- a/docs/awscc-docs/providers/awscc/servicecatalogappregistry/index.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -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 deleted file mode 100644 index f8143e379f..0000000000 --- a/docs/awscc-docs/providers/awscc/servicecatalogappregistry/resource_association/index.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -application, -resource, -resource_type, -application_arn, -resource_arn -FROM awscc.servicecatalogappregistry.resource_association -WHERE data__Identifier = '||'; -``` - -## Permissions - -To operate on the resource_association resource, the following permissions are required: - -### Read -```json -servicecatalog:ListAssociatedResources -``` - -### Delete -```json -servicecatalog:DisassociateResource -``` - diff --git a/docs/awscc-docs/providers/awscc/servicecatalogappregistry/resource_associations/index.md b/docs/awscc-docs/providers/awscc/servicecatalogappregistry/resource_associations/index.md deleted file mode 100644 index 3937c14d10..0000000000 --- a/docs/awscc-docs/providers/awscc/servicecatalogappregistry/resource_associations/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -application_arn, -resource_arn, -resource_type -FROM awscc.servicecatalogappregistry.resource_associations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the resource_associations resource, the following permissions are required: - -### Create -```json -servicecatalog:AssociateResource, -cloudformation:DescribeStacks -``` - -### List -```json -servicecatalog:ListAssociatedResources -``` - diff --git a/docs/awscc-docs/providers/awscc/ses/configuration_set/index.md b/docs/awscc-docs/providers/awscc/ses/configuration_set/index.md deleted file mode 100644 index 9930a591a4..0000000000 --- a/docs/awscc-docs/providers/awscc/ses/configuration_set/index.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -tracking_options, -delivery_options, -reputation_options, -sending_options, -suppression_options, -vdm_options -FROM awscc.ses.configuration_set -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the configuration_set resource, the following permissions are required: - -### Read -```json -ses:GetConfigurationSet, -ses:DescribeConfigurationSet -``` - -### Update -```json -ses:PutConfigurationSetTrackingOptions, -ses:PutConfigurationSetDeliveryOptions, -ses:PutConfigurationSetReputationOptions, -ses:PutConfigurationSetSendingOptions, -ses:PutConfigurationSetSuppressionOptions, -ses:PutConfigurationSetVdmOptions -``` - -### Delete -```json -ses:DeleteConfigurationSet -``` - 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 deleted file mode 100644 index 292aa54089..0000000000 --- a/docs/awscc-docs/providers/awscc/ses/configuration_set_event_destination/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id, -configuration_set_name, -event_destination -FROM awscc.ses.configuration_set_event_destination -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the configuration_set_event_destination resource, the following permissions are required: - -### Update -```json -ses:UpdateConfigurationSetEventDestination, -ses:GetConfigurationSetEventDestinations -``` - -### Delete -```json -ses:DeleteConfigurationSetEventDestination -``` - -### Read -```json -ses:GetConfigurationSetEventDestinations, -ses:DescribeConfigurationSet -``` - diff --git a/docs/awscc-docs/providers/awscc/ses/configuration_sets/index.md b/docs/awscc-docs/providers/awscc/ses/configuration_sets/index.md deleted file mode 100644 index 1c0ded471f..0000000000 --- a/docs/awscc-docs/providers/awscc/ses/configuration_sets/index.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.ses.configuration_sets -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the configuration_sets resource, the following permissions are required: - -### Create -```json -ses:CreateConfigurationSet -``` - -### List -```json -ses:ListConfigurationSets -``` - diff --git a/docs/awscc-docs/providers/awscc/ses/contact_list/index.md b/docs/awscc-docs/providers/awscc/ses/contact_list/index.md deleted file mode 100644 index 9581d83a47..0000000000 --- a/docs/awscc-docs/providers/awscc/ses/contact_list/index.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -contact_list_name, -description, -topics, -tags -FROM awscc.ses.contact_list -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the contact_list resource, the following permissions are required: - -### Read -```json -ses:GetContactList -``` - -### Update -```json -ses:UpdateContactList, -ses:UntagResource, -ses:TagResource -``` - -### Delete -```json -ses:DeleteContactList -``` - diff --git a/docs/awscc-docs/providers/awscc/ses/contact_lists/index.md b/docs/awscc-docs/providers/awscc/ses/contact_lists/index.md deleted file mode 100644 index 35249ad004..0000000000 --- a/docs/awscc-docs/providers/awscc/ses/contact_lists/index.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -contact_list_name -FROM awscc.ses.contact_lists -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the contact_lists resource, the following permissions are required: - -### Create -```json -ses:CreateContactList -``` - -### List -```json -ses:ListContactLists -``` - 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 deleted file mode 100644 index 631bd2ed82..0000000000 --- a/docs/awscc-docs/providers/awscc/ses/dedicated_ip_pool/index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -pool_name, -scaling_mode -FROM awscc.ses.dedicated_ip_pool -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the dedicated_ip_pool resource, the following permissions are required: - -### Read -```json -ses:GetDedicatedIpPool, -ses:GetDedicatedIps -``` - -### Update -```json -ses:PutDedicatedIpPoolScalingAttributes, -ses:GetDedicatedIpPool -``` - -### Delete -```json -ses:DeleteDedicatedIpPool -``` - 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 deleted file mode 100644 index c44e110a99..0000000000 --- a/docs/awscc-docs/providers/awscc/ses/dedicated_ip_pools/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -pool_name -FROM awscc.ses.dedicated_ip_pools -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the dedicated_ip_pools resource, the following permissions are required: - -### Create -```json -ses:CreateDedicatedIpPool, -ses:GetDedicatedIpPool, -ses:GetDedicatedIps -``` - -### List -```json -ses:ListDedicatedIpPools -``` - diff --git a/docs/awscc-docs/providers/awscc/ses/email_identities/index.md b/docs/awscc-docs/providers/awscc/ses/email_identities/index.md deleted file mode 100644 index 6b44268c28..0000000000 --- a/docs/awscc-docs/providers/awscc/ses/email_identities/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -email_identity -FROM awscc.ses.email_identities -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the email_identities resource, the following permissions are required: - -### Create -```json -ses:CreateEmailIdentity, -ses:PutEmailIdentityMailFromAttributes, -ses:PutEmailIdentityFeedbackAttributes, -ses:PutEmailIdentityDkimAttributes, -ses:GetEmailIdentity -``` - -### List -```json -ses:ListEmailIdentities -``` - diff --git a/docs/awscc-docs/providers/awscc/ses/email_identity/index.md b/docs/awscc-docs/providers/awscc/ses/email_identity/index.md deleted file mode 100644 index b5943240b1..0000000000 --- a/docs/awscc-docs/providers/awscc/ses/email_identity/index.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -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_dns_token_name1string
dkim_dns_token_name2string
dkim_dns_token_name3string
dkim_dns_token_value1string
dkim_dns_token_value2string
dkim_dns_token_value3string
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -email_identity, -configuration_set_attributes, -dkim_signing_attributes, -dkim_attributes, -mail_from_attributes, -feedback_attributes, -dkim_dns_token_name1, -dkim_dns_token_name2, -dkim_dns_token_name3, -dkim_dns_token_value1, -dkim_dns_token_value2, -dkim_dns_token_value3 -FROM awscc.ses.email_identity -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the email_identity resource, the following permissions are required: - -### Read -```json -ses:GetEmailIdentity -``` - -### Update -```json -ses:PutEmailIdentityMailFromAttributes, -ses:PutEmailIdentityFeedbackAttributes, -ses:PutEmailIdentityConfigurationSetAttributes, -ses:PutEmailIdentityDkimSigningAttributes, -ses:PutEmailIdentityDkimAttributes, -ses:GetEmailIdentity -``` - -### Delete -```json -ses:DeleteEmailIdentity -``` - diff --git a/docs/awscc-docs/providers/awscc/ses/index.md b/docs/awscc-docs/providers/awscc/ses/index.md deleted file mode 100644 index c776c7aa7f..0000000000 --- a/docs/awscc-docs/providers/awscc/ses/index.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -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: 12
-total selectable resources: 12
-total methods: 12
-
-
- -::: - -## Resources -
-
-configuration_set
-configuration_set_event_destination
-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 deleted file mode 100644 index 6ba69f39e5..0000000000 --- a/docs/awscc-docs/providers/awscc/ses/template/index.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id, -template -FROM awscc.ses.template -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the template resource, the following permissions are required: - -### Read -```json -ses:GetEmailTemplate, -ses:GetTemplate -``` - -### Delete -```json -ses:DeleteEmailTemplate, -ses:DeleteTemplate -``` - -### Update -```json -ses:GetEmailTemplate, -ses:UpdateEmailTemplate, -ses:GetTemplate, -ses:UpdateTemplate -``` - diff --git a/docs/awscc-docs/providers/awscc/ses/templates/index.md b/docs/awscc-docs/providers/awscc/ses/templates/index.md deleted file mode 100644 index 2888b3fcb6..0000000000 --- a/docs/awscc-docs/providers/awscc/ses/templates/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.ses.templates -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the templates resource, the following permissions are required: - -### Create -```json -ses:CreateEmailTemplate, -ses:GetEmailTemplate, -ses:CreateTemplate, -ses:GetTemplate -``` - -### List -```json -ses:ListEmailTemplates, -ses:ListTemplates -``` - diff --git a/docs/awscc-docs/providers/awscc/ses/vdm_attributes/index.md b/docs/awscc-docs/providers/awscc/ses/vdm_attributes/index.md deleted file mode 100644 index 386ca1a77b..0000000000 --- a/docs/awscc-docs/providers/awscc/ses/vdm_attributes/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -vdm_attributes_resource_id, -dashboard_attributes, -guardian_attributes -FROM awscc.ses.vdm_attributes -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the vdm_attributes resource, the following permissions are required: - -### Read -```json -ses:GetAccount -``` - -### Update -```json -ses:PutAccountVdmAttributes, -ses:GetAccount -``` - -### Delete -```json -ses:PutAccountVdmAttributes, -ses:GetAccount -``` - diff --git a/docs/awscc-docs/providers/awscc/shield/drt_access/index.md b/docs/awscc-docs/providers/awscc/shield/drt_access/index.md deleted file mode 100644 index 992f27f1dd..0000000000 --- a/docs/awscc-docs/providers/awscc/shield/drt_access/index.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -account_id, -log_bucket_list, -role_arn -FROM awscc.shield.drt_access -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the drt_access resource, the following permissions are required: - -### Delete -```json -shield:DescribeDRTAccess, -shield:DisassociateDRTLogBucket, -shield:DisassociateDRTRole, -iam:PassRole, -iam:GetRole, -iam:ListAttachedRolePolicies, -s3:GetBucketPolicy, -s3:PutBucketPolicy, -s3:DeleteBucketPolicy -``` - -### Read -```json -shield:DescribeDRTAccess -``` - -### Update -```json -shield:DescribeDRTAccess, -shield:AssociateDRTLogBucket, -shield:AssociateDRTRole, -shield:DisassociateDRTLogBucket, -shield:DisassociateDRTRole, -iam:PassRole, -iam:GetRole, -iam:ListAttachedRolePolicies, -s3:GetBucketPolicy, -s3:PutBucketPolicy, -s3:DeleteBucketPolicy -``` - diff --git a/docs/awscc-docs/providers/awscc/shield/drt_accesses/index.md b/docs/awscc-docs/providers/awscc/shield/drt_accesses/index.md deleted file mode 100644 index befac915be..0000000000 --- a/docs/awscc-docs/providers/awscc/shield/drt_accesses/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -account_id -FROM awscc.shield.drt_accesses - -``` - -## Permissions - -To operate on the drt_accesses resource, the following permissions are required: - -### Create -```json -shield:DescribeDRTAccess, -shield:AssociateDRTLogBucket, -shield:AssociateDRTRole, -iam:PassRole, -iam:GetRole, -iam:ListAttachedRolePolicies, -s3:GetBucketPolicy, -s3:PutBucketPolicy -``` - diff --git a/docs/awscc-docs/providers/awscc/shield/index.md b/docs/awscc-docs/providers/awscc/shield/index.md deleted file mode 100644 index 287bde833c..0000000000 --- a/docs/awscc-docs/providers/awscc/shield/index.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -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 deleted file mode 100644 index e0a96270ba..0000000000 --- a/docs/awscc-docs/providers/awscc/shield/proactive_engagement/index.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -account_id, -proactive_engagement_status, -emergency_contact_list -FROM awscc.shield.proactive_engagement -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the proactive_engagement resource, the following permissions are required: - -### Delete -```json -shield:DescribeSubscription, -shield:DescribeEmergencyContactSettings, -shield:UpdateEmergencyContactSettings, -shield:DisableProactiveEngagement -``` - -### Read -```json -shield:DescribeSubscription, -shield:DescribeEmergencyContactSettings -``` - -### Update -```json -shield:DescribeSubscription, -shield:DescribeEmergencyContactSettings, -shield:UpdateEmergencyContactSettings, -shield:EnableProactiveEngagement, -shield:DisableProactiveEngagement -``` - diff --git a/docs/awscc-docs/providers/awscc/shield/proactive_engagements/index.md b/docs/awscc-docs/providers/awscc/shield/proactive_engagements/index.md deleted file mode 100644 index fc17e5d832..0000000000 --- a/docs/awscc-docs/providers/awscc/shield/proactive_engagements/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -account_id -FROM awscc.shield.proactive_engagements - -``` - -## Permissions - -To operate on the proactive_engagements resource, the following permissions are required: - -### Create -```json -shield:DescribeSubscription, -shield:DescribeEmergencyContactSettings, -shield:AssociateProactiveEngagementDetails, -shield:UpdateEmergencyContactSettings, -shield:EnableProactiveEngagement -``` - -### List -```json -shield:DescribeSubscription, -shield:DescribeEmergencyContactSettings -``` - diff --git a/docs/awscc-docs/providers/awscc/shield/protection/index.md b/docs/awscc-docs/providers/awscc/shield/protection/index.md deleted file mode 100644 index cb448f1938..0000000000 --- a/docs/awscc-docs/providers/awscc/shield/protection/index.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -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. - -## 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 = ''; -``` - -## Permissions - -To operate on the protection resource, the following permissions are required: - -### Delete -```json -shield:DeleteProtection, -shield:UntagResource -``` - -### Read -```json -shield:DescribeProtection, -shield:ListTagsForResource -``` - -### Update -```json -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 -``` - diff --git a/docs/awscc-docs/providers/awscc/shield/protection_group/index.md b/docs/awscc-docs/providers/awscc/shield/protection_group/index.md deleted file mode 100644 index 09e384df4c..0000000000 --- a/docs/awscc-docs/providers/awscc/shield/protection_group/index.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -protection_group_id, -protection_group_arn, -aggregation, -pattern, -members, -resource_type, -tags -FROM awscc.shield.protection_group -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the protection_group resource, the following permissions are required: - -### Delete -```json -shield:DeleteProtectionGroup, -shield:UntagResource -``` - -### Read -```json -shield:DescribeProtectionGroup, -shield:ListTagsForResource -``` - -### Update -```json -shield:UpdateProtectionGroup, -shield:ListTagsForResource, -shield:TagResource, -shield:UntagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/shield/protection_groups/index.md b/docs/awscc-docs/providers/awscc/shield/protection_groups/index.md deleted file mode 100644 index 1124dca7ef..0000000000 --- a/docs/awscc-docs/providers/awscc/shield/protection_groups/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -protection_group_arn -FROM awscc.shield.protection_groups - -``` - -## Permissions - -To operate on the protection_groups resource, the following permissions are required: - -### Create -```json -shield:CreateProtectionGroup, -shield:TagResource -``` - -### List -```json -shield:ListProtectionGroups -``` - diff --git a/docs/awscc-docs/providers/awscc/shield/protections/index.md b/docs/awscc-docs/providers/awscc/shield/protections/index.md deleted file mode 100644 index 6ffb958759..0000000000 --- a/docs/awscc-docs/providers/awscc/shield/protections/index.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -protection_arn -FROM awscc.shield.protections - -``` - -## Permissions - -To operate on the protections resource, the following permissions are required: - -### Create -```json -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 -```json -shield:ListProtections -``` - diff --git a/docs/awscc-docs/providers/awscc/signer/index.md b/docs/awscc-docs/providers/awscc/signer/index.md deleted file mode 100644 index 64e177c1dc..0000000000 --- a/docs/awscc-docs/providers/awscc/signer/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index ddf06eecbc..0000000000 --- a/docs/awscc-docs/providers/awscc/signer/profile_permission/index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -profile_name, -profile_version, -action, -principal, -statement_id -FROM awscc.signer.profile_permission -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the profile_permission resource, the following permissions are required: - -### Read -```json -signer:ListProfilePermissions -``` - -### Delete -```json -signer:RemoveProfilePermission, -signer:ListProfilePermissions -``` - diff --git a/docs/awscc-docs/providers/awscc/signer/profile_permissions/index.md b/docs/awscc-docs/providers/awscc/signer/profile_permissions/index.md deleted file mode 100644 index 2a05c69b6c..0000000000 --- a/docs/awscc-docs/providers/awscc/signer/profile_permissions/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -statement_id, -profile_name -FROM awscc.signer.profile_permissions -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the profile_permissions resource, the following permissions are required: - -### Create -```json -signer:AddProfilePermission, -signer:ListProfilePermissions -``` - -### List -```json -signer:ListProfilePermissions, -signer:GetSigningProfile -``` - diff --git a/docs/awscc-docs/providers/awscc/signer/signing_profile/index.md b/docs/awscc-docs/providers/awscc/signer/signing_profile/index.md deleted file mode 100644 index af713bc00b..0000000000 --- a/docs/awscc-docs/providers/awscc/signer/signing_profile/index.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -profile_name, -profile_version, -arn, -profile_version_arn, -signature_validity_period, -platform_id, -tags -FROM awscc.signer.signing_profile -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the signing_profile resource, the following permissions are required: - -### Read -```json -signer:GetSigningProfile -``` - -### Delete -```json -signer:CancelSigningProfile, -signer:GetSigningProfile -``` - -### Update -```json -signer:TagResource, -signer:UntagResource, -signer:GetSigningProfile -``` - diff --git a/docs/awscc-docs/providers/awscc/signer/signing_profiles/index.md b/docs/awscc-docs/providers/awscc/signer/signing_profiles/index.md deleted file mode 100644 index 6fbca72612..0000000000 --- a/docs/awscc-docs/providers/awscc/signer/signing_profiles/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.signer.signing_profiles -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the signing_profiles resource, the following permissions are required: - -### Create -```json -signer:PutSigningProfile, -signer:TagResource -``` - -### List -```json -signer:ListSigningProfiles -``` - diff --git a/docs/awscc-docs/providers/awscc/simspaceweaver/index.md b/docs/awscc-docs/providers/awscc/simspaceweaver/index.md deleted file mode 100644 index 3c382e40a0..0000000000 --- a/docs/awscc-docs/providers/awscc/simspaceweaver/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 deleted file mode 100644 index ed735d960f..0000000000 --- a/docs/awscc-docs/providers/awscc/simspaceweaver/simulation/index.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -role_arn, -schema_s3_location, -describe_payload, -maximum_duration, -snapshot_s3_location -FROM awscc.simspaceweaver.simulation -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the simulation resource, the following permissions are required: - -### Read -```json -simspaceweaver:DescribeSimulation -``` - -### Update -```json -simspaceweaver:StartSimulation, -simspaceweaver:StopSimulation, -simspaceweaver:DeleteSimulation, -simspaceweaver:DescribeSimulation -``` - -### Delete -```json -simspaceweaver:StopSimulation, -simspaceweaver:DeleteSimulation, -simspaceweaver:DescribeSimulation -``` - diff --git a/docs/awscc-docs/providers/awscc/simspaceweaver/simulations/index.md b/docs/awscc-docs/providers/awscc/simspaceweaver/simulations/index.md deleted file mode 100644 index 89b55ee62f..0000000000 --- a/docs/awscc-docs/providers/awscc/simspaceweaver/simulations/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.simspaceweaver.simulations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the simulations resource, the following permissions are required: - -### Create -```json -simspaceweaver:StartSimulation, -simspaceweaver:DescribeSimulation, -iam:GetRole, -iam:PassRole -``` - -### List -```json -simspaceweaver:ListSimulations -``` - diff --git a/docs/awscc-docs/providers/awscc/sns/index.md b/docs/awscc-docs/providers/awscc/sns/index.md deleted file mode 100644 index bb81548ed8..0000000000 --- a/docs/awscc-docs/providers/awscc/sns/index.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -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: 3
-total selectable resources: 3
-total methods: 3
-
-
- -::: - -## Resources -
-
-topic
-topic_inline_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 deleted file mode 100644 index c1eecd8e8f..0000000000 --- a/docs/awscc-docs/providers/awscc/sns/topic/index.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the topic resource, the following permissions are required: - -### Read -```json -sns:GetTopicAttributes, -sns:ListTagsForResource, -sns:ListSubscriptionsByTopic, -sns:GetDataProtectionPolicy -``` - -### Update -```json -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 -```json -sns:GetTopicAttributes, -sns:DeleteTopic -``` - 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 deleted file mode 100644 index 8d76028a19..0000000000 --- a/docs/awscc-docs/providers/awscc/sns/topic_inline_policy/index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -policy_document, -topic_arn -FROM awscc.sns.topic_inline_policy -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the topic_inline_policy resource, the following permissions are required: - -### Read -```json -sns:GetTopicAttributes -``` - -### Delete -```json -sns:SetTopicAttributes, -sns:GetTopicAttributes -``` - -### Update -```json -sns:SetTopicAttributes, -sns:GetTopicAttributes -``` - diff --git a/docs/awscc-docs/providers/awscc/sns/topics/index.md b/docs/awscc-docs/providers/awscc/sns/topics/index.md deleted file mode 100644 index 1d73886e8e..0000000000 --- a/docs/awscc-docs/providers/awscc/sns/topics/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -topic_arn -FROM awscc.sns.topics -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the topics resource, the following permissions are required: - -### Create -```json -sns:CreateTopic, -sns:TagResource, -sns:Subscribe, -sns:GetTopicAttributes, -sns:PutDataProtectionPolicy, -iam:GetRole, -iam:PassRole -``` - -### List -```json -sns:ListTopics -``` - diff --git a/docs/awscc-docs/providers/awscc/sqs/index.md b/docs/awscc-docs/providers/awscc/sqs/index.md deleted file mode 100644 index 111cb8b707..0000000000 --- a/docs/awscc-docs/providers/awscc/sqs/index.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -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: 3
-total selectable resources: 3
-total methods: 3
-
-
- -::: - -## Resources -
-
-queue
-queue_inline_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 deleted file mode 100644 index b1a26a4359..0000000000 --- a/docs/awscc-docs/providers/awscc/sqs/queue/index.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the queue resource, the following permissions are required: - -### Read -```json -sqs:GetQueueAttributes, -sqs:ListQueueTags -``` - -### Update -```json -sqs:SetQueueAttributes, -sqs:GetQueueAttributes, -sqs:ListQueueTags, -sqs:TagQueue, -sqs:UntagQueue -``` - -### Delete -```json -sqs:DeleteQueue, -sqs:GetQueueAttributes -``` - 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 deleted file mode 100644 index 1e16a18208..0000000000 --- a/docs/awscc-docs/providers/awscc/sqs/queue_inline_policy/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -policy_document, -queue -FROM awscc.sqs.queue_inline_policy -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the queue_inline_policy resource, the following permissions are required: - -### Read -```json -sqs:GetQueueAttributes, -sqs:GetQueueUrl -``` - -### Delete -```json -sqs:SetQueueAttributes, -sqs:GetQueueAttributes -``` - -### Update -```json -sqs:SetQueueAttributes, -sqs:GetQueueAttributes, -sqs:GetQueueUrl -``` - diff --git a/docs/awscc-docs/providers/awscc/sqs/queues/index.md b/docs/awscc-docs/providers/awscc/sqs/queues/index.md deleted file mode 100644 index 2851da58f4..0000000000 --- a/docs/awscc-docs/providers/awscc/sqs/queues/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -queue_url -FROM awscc.sqs.queues -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the queues resource, the following permissions are required: - -### Create -```json -sqs:CreateQueue, -sqs:GetQueueUrl, -sqs:GetQueueAttributes, -sqs:ListQueueTags, -sqs:TagQueue -``` - -### List -```json -sqs:ListQueues -``` - diff --git a/docs/awscc-docs/providers/awscc/ssm/association/index.md b/docs/awscc-docs/providers/awscc/ssm/association/index.md deleted file mode 100644 index b7479564de..0000000000 --- a/docs/awscc-docs/providers/awscc/ssm/association/index.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the association resource, the following permissions are required: - -### Delete -```json -ssm:DeleteAssociation -``` - -### Update -```json -iam:PassRole, -ssm:UpdateAssociation, -ssm:GetCalendarState -``` - -### Read -```json -ssm:DescribeAssociation, -resource-groups:GetGroupQuery, -resource-groups:ListGroups, -resource-groups:ListGroupResources -``` - diff --git a/docs/awscc-docs/providers/awscc/ssm/associations/index.md b/docs/awscc-docs/providers/awscc/ssm/associations/index.md deleted file mode 100644 index 7991e610b2..0000000000 --- a/docs/awscc-docs/providers/awscc/ssm/associations/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -association_id -FROM awscc.ssm.associations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the associations resource, the following permissions are required: - -### Create -```json -ec2:DescribeInstanceStatus, -iam:PassRole, -iam:CreateServiceLinkedRole, -ssm:CreateAssociation, -ssm:DescribeAssociation, -ssm:GetCalendarState -``` - -### List -```json -ssm:ListAssociations -``` - diff --git a/docs/awscc-docs/providers/awscc/ssm/document/index.md b/docs/awscc-docs/providers/awscc/ssm/document/index.md deleted file mode 100644 index a259b193e0..0000000000 --- a/docs/awscc-docs/providers/awscc/ssm/document/index.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -content, -attachments, -name, -version_name, -document_type, -document_format, -target_type, -tags, -requires, -update_method -FROM awscc.ssm.document -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the document resource, the following permissions are required: - -### Read -```json -ssm:GetDocument, -ssm:ListTagsForResource -``` - -### Update -```json -ssm:UpdateDocument, -s3:GetObject, -ssm:AddTagsToResource, -ssm:RemoveTagsFromResource, -ssm:ListTagsForResource, -iam:PassRole, -ssm:UpdateDocumentDefaultVersion, -ssm:DescribeDocument -``` - -### Delete -```json -ssm:DeleteDocument, -ssm:GetDocument -``` - diff --git a/docs/awscc-docs/providers/awscc/ssm/documents/index.md b/docs/awscc-docs/providers/awscc/ssm/documents/index.md deleted file mode 100644 index cb61bd644e..0000000000 --- a/docs/awscc-docs/providers/awscc/ssm/documents/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.ssm.documents -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the documents resource, the following permissions are required: - -### Create -```json -ssm:CreateDocument, -ssm:GetDocument, -ssm:AddTagsToResource, -ssm:ListTagsForResource, -s3:GetObject, -iam:PassRole -``` - -### List -```json -ssm:ListDocuments -``` - diff --git a/docs/awscc-docs/providers/awscc/ssm/index.md b/docs/awscc-docs/providers/awscc/ssm/index.md deleted file mode 100644 index 5e36fadec3..0000000000 --- a/docs/awscc-docs/providers/awscc/ssm/index.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -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 deleted file mode 100644 index 02ad25b29d..0000000000 --- a/docs/awscc-docs/providers/awscc/ssm/parameter/index.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -type, -value, -description, -policies, -allowed_pattern, -tier, -tags, -data_type, -name -FROM awscc.ssm.parameter -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the parameter resource, the following permissions are required: - -### Read -```json -ssm:GetParameters -``` - -### Update -```json -ssm:PutParameter, -ssm:AddTagsToResource, -ssm:RemoveTagsFromResource, -ssm:GetParameters -``` - -### Delete -```json -ssm:DeleteParameter -``` - diff --git a/docs/awscc-docs/providers/awscc/ssm/parameters/index.md b/docs/awscc-docs/providers/awscc/ssm/parameters/index.md deleted file mode 100644 index 747caeadec..0000000000 --- a/docs/awscc-docs/providers/awscc/ssm/parameters/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.ssm.parameters -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the parameters resource, the following permissions are required: - -### Create -```json -ssm:PutParameter, -ssm:AddTagsToResource, -ssm:GetParameters -``` - -### List -```json -ssm:DescribeParameters -``` - diff --git a/docs/awscc-docs/providers/awscc/ssm/patch_baseline/index.md b/docs/awscc-docs/providers/awscc/ssm/patch_baseline/index.md deleted file mode 100644 index de3b321cce..0000000000 --- a/docs/awscc-docs/providers/awscc/ssm/patch_baseline/index.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the patch_baseline resource, the following permissions are required: - -### Delete -```json -ssm:DeletePatchBaseline, -ssm:GetPatchBaseline, -ssm:DeregisterPatchBaselineForPatchGroup -``` - -### Read -```json -ssm:GetDefaultPatchBaseline, -ssm:GetPatchBaseline, -ssm:ListTagsForResource -``` - -### Update -```json -ssm:UpdatePatchBaseline, -ssm:DeregisterPatchBaselineForPatchGroup, -ssm:AddTagsToResource, -ssm:RemoveTagsFromResource, -ssm:ListTagsForResource, -ssm:GetDefaultPatchBaseline, -ssm:RegisterDefaultPatchBaseline -``` - diff --git a/docs/awscc-docs/providers/awscc/ssm/patch_baselines/index.md b/docs/awscc-docs/providers/awscc/ssm/patch_baselines/index.md deleted file mode 100644 index aef5252cbb..0000000000 --- a/docs/awscc-docs/providers/awscc/ssm/patch_baselines/index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.ssm.patch_baselines -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the patch_baselines resource, the following permissions are required: - -### Create -```json -ssm:CreatePatchBaseline, -ssm:RegisterPatchBaselineForPatchGroup, -ssm:AddTagsToResource, -ssm:RemoveTagsFromResource, -ssm:ListTagsForResource, -ssm:GetDefaultPatchBaseline, -ssm:RegisterDefaultPatchBaseline -``` - -### List -```json -ssm:DescribePatchBaselines, -ssm:GetDefaultPatchBaseline, -ssm:GetPatchBaseline, -ssm:ListTagsForResource -``` - 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 deleted file mode 100644 index ebdcd6c56d..0000000000 --- a/docs/awscc-docs/providers/awscc/ssm/resource_data_sync/index.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -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
kms_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. - -## Example -```sql -SELECT -region, -s3_destination, -kms_key_arn, -sync_source, -bucket_name, -bucket_region, -sync_format, -sync_name, -sync_type, -bucket_prefix -FROM awscc.ssm.resource_data_sync -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the resource_data_sync resource, the following permissions are required: - -### Delete -```json -ssm:ListResourceDataSync, -ssm:DeleteResourceDataSync -``` - -### Update -```json -ssm:ListResourceDataSync, -ssm:UpdateResourceDataSync -``` - -### Read -```json -ssm:ListResourceDataSync -``` - 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 deleted file mode 100644 index f4887d4900..0000000000 --- a/docs/awscc-docs/providers/awscc/ssm/resource_data_syncs/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -sync_name -FROM awscc.ssm.resource_data_syncs -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the resource_data_syncs resource, the following permissions are required: - -### Create -```json -ssm:CreateResourceDataSync, -ssm:ListResourceDataSync -``` - -### List -```json -ssm:ListResourceDataSync -``` - diff --git a/docs/awscc-docs/providers/awscc/ssm/resource_policies/index.md b/docs/awscc-docs/providers/awscc/ssm/resource_policies/index.md deleted file mode 100644 index 943cfdb9f4..0000000000 --- a/docs/awscc-docs/providers/awscc/ssm/resource_policies/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -policy_id, -resource_arn -FROM awscc.ssm.resource_policies -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the resource_policies resource, the following permissions are required: - -### Create -```json -ssm:PutResourcePolicy -``` - -### List -```json -ssm:GetResourcePolicies -``` - diff --git a/docs/awscc-docs/providers/awscc/ssm/resource_policy/index.md b/docs/awscc-docs/providers/awscc/ssm/resource_policy/index.md deleted file mode 100644 index 0f7e69f8f5..0000000000 --- a/docs/awscc-docs/providers/awscc/ssm/resource_policy/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -resource_arn, -policy, -policy_id, -policy_hash -FROM awscc.ssm.resource_policy -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the resource_policy resource, the following permissions are required: - -### Read -```json -ssm:GetResourcePolicies -``` - -### Update -```json -ssm:PutResourcePolicy -``` - -### Delete -```json -ssm:DeleteResourcePolicy -``` - diff --git a/docs/awscc-docs/providers/awscc/ssmcontacts/contact/index.md b/docs/awscc-docs/providers/awscc/ssmcontacts/contact/index.md deleted file mode 100644 index 87a8616df1..0000000000 --- a/docs/awscc-docs/providers/awscc/ssmcontacts/contact/index.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -alias, -display_name, -type, -plan, -arn -FROM awscc.ssmcontacts.contact -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the contact resource, the following permissions are required: - -### Read -```json -ssm-contacts:GetContact -``` - -### Update -```json -ssm-contacts:UpdateContact, -ssm-contacts:GetContact, -ssm-contacts:AssociateContact -``` - -### Delete -```json -ssm-contacts:DeleteContact, -ssm-contacts:GetContact, -ssm-contacts:AssociateContact -``` - diff --git a/docs/awscc-docs/providers/awscc/ssmcontacts/contact_channel/index.md b/docs/awscc-docs/providers/awscc/ssmcontacts/contact_channel/index.md deleted file mode 100644 index 6455f57996..0000000000 --- a/docs/awscc-docs/providers/awscc/ssmcontacts/contact_channel/index.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -contact_id, -channel_name, -channel_type, -defer_activation, -channel_address, -arn -FROM awscc.ssmcontacts.contact_channel -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the contact_channel resource, the following permissions are required: - -### Read -```json -ssm-contacts:GetContactChannel -``` - -### Update -```json -ssm-contacts:UpdateContactChannel, -ssm-contacts:GetContactChannel -``` - -### Delete -```json -ssm-contacts:DeleteContactChannel, -ssm-contacts:GetContactChannel -``` - diff --git a/docs/awscc-docs/providers/awscc/ssmcontacts/contact_channels/index.md b/docs/awscc-docs/providers/awscc/ssmcontacts/contact_channels/index.md deleted file mode 100644 index daa507e2ac..0000000000 --- a/docs/awscc-docs/providers/awscc/ssmcontacts/contact_channels/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.ssmcontacts.contact_channels -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the contact_channels resource, the following permissions are required: - -### Create -```json -ssm-contacts:CreateContactChannel, -ssm-contacts:GetContactChannel -``` - -### List -```json -ssm-contacts:ListContactChannels -``` - diff --git a/docs/awscc-docs/providers/awscc/ssmcontacts/contacts/index.md b/docs/awscc-docs/providers/awscc/ssmcontacts/contacts/index.md deleted file mode 100644 index fe97d09395..0000000000 --- a/docs/awscc-docs/providers/awscc/ssmcontacts/contacts/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.ssmcontacts.contacts -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the contacts resource, the following permissions are required: - -### Create -```json -ssm-contacts:CreateContact, -ssm-contacts:GetContact, -ssm-contacts:AssociateContact -``` - -### List -```json -ssm-contacts:ListContacts -``` - diff --git a/docs/awscc-docs/providers/awscc/ssmcontacts/index.md b/docs/awscc-docs/providers/awscc/ssmcontacts/index.md deleted file mode 100644 index 0bf65c2509..0000000000 --- a/docs/awscc-docs/providers/awscc/ssmcontacts/index.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -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: 7
-total selectable resources: 7
-total methods: 7
-
-
- -::: - -## Resources -
-
-contact
-contact_channel
-contact_channels
-contacts -
-
-plan
-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 deleted file mode 100644 index 4a03ab43d1..0000000000 --- a/docs/awscc-docs/providers/awscc/ssmcontacts/plan/index.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -contact_id, -stages, -rotation_ids, -arn -FROM awscc.ssmcontacts.plan -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the plan resource, the following permissions are required: - -### Read -```json -ssm-contacts:GetContact -``` - -### Update -```json -ssm-contacts:UpdateContact, -ssm-contacts:GetContact, -ssm-contacts:AssociateContact -``` - -### Delete -```json -ssm-contacts:UpdateContact, -ssm-contacts:GetContact, -ssm-contacts:AssociateContact -``` - diff --git a/docs/awscc-docs/providers/awscc/ssmcontacts/rotation/index.md b/docs/awscc-docs/providers/awscc/ssmcontacts/rotation/index.md deleted file mode 100644 index d91231cca9..0000000000 --- a/docs/awscc-docs/providers/awscc/ssmcontacts/rotation/index.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -contact_ids, -start_time, -time_zone_id, -recurrence, -tags, -arn -FROM awscc.ssmcontacts.rotation -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the rotation resource, the following permissions are required: - -### Read -```json -ssm-contacts:GetRotation, -ssm-contacts:TagResource, -ssm-contacts:ListTagsForResource, -ssm-contacts:UntagResource -``` - -### Update -```json -ssm-contacts:UpdateRotation, -ssm-contacts:GetRotation, -ssm-contacts:TagResource, -ssm-contacts:ListTagsForResource, -ssm-contacts:UntagResource -``` - -### Delete -```json -ssm-contacts:DeleteRotation, -ssm-contacts:GetRotation, -ssm-contacts:ListTagsForResource, -ssm-contacts:UntagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/ssmcontacts/rotations/index.md b/docs/awscc-docs/providers/awscc/ssmcontacts/rotations/index.md deleted file mode 100644 index e938025a43..0000000000 --- a/docs/awscc-docs/providers/awscc/ssmcontacts/rotations/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.ssmcontacts.rotations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the rotations resource, the following permissions are required: - -### Create -```json -ssm-contacts:CreateRotation, -ssm-contacts:GetRotation, -ssm-contacts:TagResource, -ssm-contacts:ListTagsForResource, -ssm-contacts:UntagResource -``` - -### List -```json -ssm-contacts:ListRotations, -ssm-contacts:GetRotation, -ssm-contacts:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/ssmincidents/index.md b/docs/awscc-docs/providers/awscc/ssmincidents/index.md deleted file mode 100644 index 64ffeb3607..0000000000 --- a/docs/awscc-docs/providers/awscc/ssmincidents/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index 2031a7fb19..0000000000 --- a/docs/awscc-docs/providers/awscc/ssmincidents/replication_set/index.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -regions, -deletion_protected, -tags -FROM awscc.ssmincidents.replication_set -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the replication_set resource, the following permissions are required: - -### Read -```json -ssm-incidents:ListReplicationSets, -ssm-incidents:GetReplicationSet, -ssm-incidents:ListTagsForResource -``` - -### Update -```json -ssm-incidents:UpdateReplicationSet, -ssm-incidents:UpdateDeletionProtection, -ssm-incidents:GetReplicationSet, -ssm-incidents:TagResource, -ssm-incidents:UntagResource, -ssm-incidents:ListTagsForResource -``` - -### Delete -```json -ssm-incidents:DeleteReplicationSet, -ssm-incidents:GetReplicationSet -``` - diff --git a/docs/awscc-docs/providers/awscc/ssmincidents/replication_sets/index.md b/docs/awscc-docs/providers/awscc/ssmincidents/replication_sets/index.md deleted file mode 100644 index 00c39ca24c..0000000000 --- a/docs/awscc-docs/providers/awscc/ssmincidents/replication_sets/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.ssmincidents.replication_sets -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the replication_sets resource, the following permissions are required: - -### Create -```json -ssm-incidents:CreateReplicationSet, -ssm-incidents:ListReplicationSets, -ssm-incidents:UpdateDeletionProtection, -ssm-incidents:GetReplicationSet, -ssm-incidents:TagResource, -ssm-incidents:ListTagsForResource, -iam:CreateServiceLinkedRole -``` - -### List -```json -ssm-incidents:ListReplicationSets -``` - diff --git a/docs/awscc-docs/providers/awscc/ssmincidents/response_plan/index.md b/docs/awscc-docs/providers/awscc/ssmincidents/response_plan/index.md deleted file mode 100644 index 87269e6c49..0000000000 --- a/docs/awscc-docs/providers/awscc/ssmincidents/response_plan/index.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -name, -display_name, -chat_channel, -engagements, -actions, -integrations, -tags, -incident_template -FROM awscc.ssmincidents.response_plan -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the response_plan resource, the following permissions are required: - -### Read -```json -ssm-incidents:GetResponsePlan, -ssm-incidents:ListTagsForResource -``` - -### Update -```json -ssm-incidents:UpdateResponsePlan, -ssm-incidents:GetResponsePlan, -ssm-incidents:TagResource, -ssm-incidents:UntagResource, -ssm-incidents:ListTagsForResource, -iam:PassRole, -secretsmanager:GetSecretValue, -kms:Decrypt, -kms:GenerateDataKey* -``` - -### Delete -```json -ssm-incidents:DeleteResponsePlan, -ssm-incidents:GetResponsePlan -``` - diff --git a/docs/awscc-docs/providers/awscc/ssmincidents/response_plans/index.md b/docs/awscc-docs/providers/awscc/ssmincidents/response_plans/index.md deleted file mode 100644 index b3962b0842..0000000000 --- a/docs/awscc-docs/providers/awscc/ssmincidents/response_plans/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.ssmincidents.response_plans -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the response_plans resource, the following permissions are required: - -### Create -```json -ssm-incidents:CreateResponsePlan, -ssm-incidents:GetResponsePlan, -ssm-incidents:TagResource, -ssm-incidents:ListTagsForResource, -iam:PassRole, -secretsmanager:GetSecretValue, -kms:Decrypt, -kms:GenerateDataKey* -``` - -### List -```json -ssm-incidents:ListResponsePlans -``` - diff --git a/docs/awscc-docs/providers/awscc/sso/assignment/index.md b/docs/awscc-docs/providers/awscc/sso/assignment/index.md deleted file mode 100644 index f78e973d87..0000000000 --- a/docs/awscc-docs/providers/awscc/sso/assignment/index.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -instance_arn, -target_id, -target_type, -permission_set_arn, -principal_type, -principal_id -FROM awscc.sso.assignment -WHERE data__Identifier = '|||||'; -``` - -## Permissions - -To operate on the assignment resource, the following permissions are required: - -### Read -```json -sso:ListAccountAssignments, -iam:GetSAMLProvider, -iam:ListRolePolicies -``` - -### Delete -```json -sso:ListAccountAssignments, -sso:DeleteAccountAssignment, -sso:DescribeAccountAssignmentDeletionStatus, -iam:GetSAMLProvider, -iam:ListRolePolicies -``` - diff --git a/docs/awscc-docs/providers/awscc/sso/assignments/index.md b/docs/awscc-docs/providers/awscc/sso/assignments/index.md deleted file mode 100644 index a06dcb70bd..0000000000 --- a/docs/awscc-docs/providers/awscc/sso/assignments/index.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -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. - -## 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' -``` - -## Permissions - -To operate on the assignments resource, the following permissions are required: - -### Create -```json -sso:CreateAccountAssignment, -sso:DescribeAccountAssignmentCreationStatus, -sso:ListAccountAssignments, -iam:GetSAMLProvider, -iam:CreateSAMLProvider, -iam:AttachRolePolicy, -iam:PutRolePolicy, -iam:CreateRole, -iam:ListRolePolicies -``` - -### List -```json -sso:ListAccountAssignments, -iam:ListRolePolicies -``` - diff --git a/docs/awscc-docs/providers/awscc/sso/index.md b/docs/awscc-docs/providers/awscc/sso/index.md deleted file mode 100644 index ea607e11b4..0000000000 --- a/docs/awscc-docs/providers/awscc/sso/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -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 deleted file mode 100644 index 9c157bea85..0000000000 --- a/docs/awscc-docs/providers/awscc/sso/instance_access_control_attribute_configuration/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -instance_arn, -instance_access_control_attribute_configuration, -access_control_attributes -FROM awscc.sso.instance_access_control_attribute_configuration -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the instance_access_control_attribute_configuration resource, the following permissions are required: - -### Read -```json -sso:DescribeInstanceAccessControlAttributeConfiguration -``` - -### Update -```json -sso:UpdateInstanceAccessControlAttributeConfiguration, -sso:DescribeInstanceAccessControlAttributeConfiguration -``` - -### Delete -```json -sso:DeleteInstanceAccessControlAttributeConfiguration, -sso:DescribeInstanceAccessControlAttributeConfiguration -``` - 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 deleted file mode 100644 index 5671c04006..0000000000 --- a/docs/awscc-docs/providers/awscc/sso/instance_access_control_attribute_configurations/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -instance_arn -FROM awscc.sso.instance_access_control_attribute_configurations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the instance_access_control_attribute_configurations resource, the following permissions are required: - -### Create -```json -sso:CreateInstanceAccessControlAttributeConfiguration, -sso:UpdateApplicationProfileForAWSAccountInstance, -sso:DescribeInstanceAccessControlAttributeConfiguration -``` - -### List -```json -sso:DescribeInstanceAccessControlAttributeConfiguration -``` - diff --git a/docs/awscc-docs/providers/awscc/sso/permission_set/index.md b/docs/awscc-docs/providers/awscc/sso/permission_set/index.md deleted file mode 100644 index 20fe84b8aa..0000000000 --- a/docs/awscc-docs/providers/awscc/sso/permission_set/index.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the permission_set resource, the following permissions are required: - -### Read -```json -sso:DescribePermissionSet, -sso:ListTagsForResource, -sso:ListManagedPoliciesInPermissionSet, -sso:ListCustomerManagedPolicyReferencesInPermissionSet, -sso:GetInlinePolicyForPermissionSet, -sso:GetPermissionsBoundaryForPermissionSet -``` - -### Update -```json -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 -```json -sso:DeletePermissionSet -``` - diff --git a/docs/awscc-docs/providers/awscc/sso/permission_sets/index.md b/docs/awscc-docs/providers/awscc/sso/permission_sets/index.md deleted file mode 100644 index 7e7b6365e4..0000000000 --- a/docs/awscc-docs/providers/awscc/sso/permission_sets/index.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -instance_arn, -permission_set_arn -FROM awscc.sso.permission_sets -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the permission_sets resource, the following permissions are required: - -### Create -```json -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 -```json -sso:DescribePermissionSet -``` - diff --git a/docs/awscc-docs/providers/awscc/stepfunctions/activity/index.md b/docs/awscc-docs/providers/awscc/stepfunctions/activity/index.md deleted file mode 100644 index 69e088ef40..0000000000 --- a/docs/awscc-docs/providers/awscc/stepfunctions/activity/index.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -name, -tags -FROM awscc.stepfunctions.activity -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the activity resource, the following permissions are required: - -### Read -```json -states:DescribeActivity, -states:ListTagsForResource -``` - -### Update -```json -states:ListTagsForResource, -states:TagResource, -states:UntagResource -``` - -### Delete -```json -states:DeleteActivity -``` - diff --git a/docs/awscc-docs/providers/awscc/stepfunctions/index.md b/docs/awscc-docs/providers/awscc/stepfunctions/index.md deleted file mode 100644 index aa3cc70117..0000000000 --- a/docs/awscc-docs/providers/awscc/stepfunctions/index.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -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: 7
-total selectable resources: 7
-total methods: 7
-
-
- -::: - -## Resources -
-
-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 deleted file mode 100644 index 8284c7e422..0000000000 --- a/docs/awscc-docs/providers/awscc/stepfunctions/state_machine/index.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the state_machine resource, the following permissions are required: - -### Read -```json -states:DescribeStateMachine, -states:ListTagsForResource -``` - -### Update -```json -states:UpdateStateMachine, -states:TagResource, -states:UntagResource, -states:ListTagsForResource, -iam:PassRole -``` - -### Delete -```json -states:DeleteStateMachine, -states:DescribeStateMachine -``` - 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 deleted file mode 100644 index d7411c3c32..0000000000 --- a/docs/awscc-docs/providers/awscc/stepfunctions/state_machine_alias/index.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -name, -description, -routing_configuration, -deployment_preference -FROM awscc.stepfunctions.state_machine_alias -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the state_machine_alias resource, the following permissions are required: - -### Read -```json -states:DescribeStateMachineAlias -``` - -### Update -```json -cloudwatch:DescribeAlarms, -states:UpdateStateMachineAlias, -states:DescribeStateMachineAlias -``` - -### Delete -```json -states:DescribeStateMachineAlias, -states:DeleteStateMachineAlias -``` - 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 deleted file mode 100644 index 3493377727..0000000000 --- a/docs/awscc-docs/providers/awscc/stepfunctions/state_machine_aliases/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.stepfunctions.state_machine_aliases -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the state_machine_aliases resource, the following permissions are required: - -### Create -```json -states:CreateStateMachineAlias, -states:DescribeStateMachineAlias -``` - -### List -```json -states:ListStateMachineAliases -``` - 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 deleted file mode 100644 index f6be754b36..0000000000 --- a/docs/awscc-docs/providers/awscc/stepfunctions/state_machine_version/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -state_machine_arn, -state_machine_revision_id, -description -FROM awscc.stepfunctions.state_machine_version -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the state_machine_version resource, the following permissions are required: - -### Read -```json -states:DescribeStateMachine -``` - -### Delete -```json -states:DeleteStateMachineVersion, -states:DescribeStateMachine -``` - 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 deleted file mode 100644 index 92bbcda712..0000000000 --- a/docs/awscc-docs/providers/awscc/stepfunctions/state_machine_versions/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.stepfunctions.state_machine_versions -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the state_machine_versions resource, the following permissions are required: - -### Create -```json -states:PublishStateMachineVersion, -states:ListStateMachineVersions, -states:DescribeStateMachine -``` - -### List -```json -states:ListStateMachineVersions -``` - diff --git a/docs/awscc-docs/providers/awscc/stepfunctions/state_machines/index.md b/docs/awscc-docs/providers/awscc/stepfunctions/state_machines/index.md deleted file mode 100644 index cec2d6df0d..0000000000 --- a/docs/awscc-docs/providers/awscc/stepfunctions/state_machines/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.stepfunctions.state_machines -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the state_machines resource, the following permissions are required: - -### Create -```json -states:CreateStateMachine, -states:DescribeStateMachine, -states:TagResource, -iam:PassRole, -s3:GetObject -``` - -### List -```json -states:ListStateMachines -``` - diff --git a/docs/awscc-docs/providers/awscc/supportapp/account_alias/index.md b/docs/awscc-docs/providers/awscc/supportapp/account_alias/index.md deleted file mode 100644 index 4ccd4a6e76..0000000000 --- a/docs/awscc-docs/providers/awscc/supportapp/account_alias/index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -account_alias, -account_alias_resource_id -FROM awscc.supportapp.account_alias -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the account_alias resource, the following permissions are required: - -### Read -```json -supportapp:GetAccountAlias -``` - -### Update -```json -supportapp:PutAccountAlias, -supportapp:GetAccountAlias -``` - -### Delete -```json -supportapp:DeleteAccountAlias, -supportapp:GetAccountAlias -``` - diff --git a/docs/awscc-docs/providers/awscc/supportapp/account_aliases/index.md b/docs/awscc-docs/providers/awscc/supportapp/account_aliases/index.md deleted file mode 100644 index 4f14c3a599..0000000000 --- a/docs/awscc-docs/providers/awscc/supportapp/account_aliases/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -account_alias_resource_id -FROM awscc.supportapp.account_aliases -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the account_aliases resource, the following permissions are required: - -### Create -```json -supportapp:PutAccountAlias, -supportapp:GetAccountAlias -``` - -### List -```json -supportapp:GetAccountAlias -``` - diff --git a/docs/awscc-docs/providers/awscc/supportapp/index.md b/docs/awscc-docs/providers/awscc/supportapp/index.md deleted file mode 100644 index 7c910e271e..0000000000 --- a/docs/awscc-docs/providers/awscc/supportapp/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -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 deleted file mode 100644 index 46f6c8c48b..0000000000 --- a/docs/awscc-docs/providers/awscc/supportapp/slack_channel_configuration/index.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the slack_channel_configuration resource, the following permissions are required: - -### Read -```json -supportapp:ListSlackChannelConfigurations -``` - -### Update -```json -supportapp:UpdateSlackChannelConfiguration, -supportapp:ListSlackChannelConfigurations -``` - -### Delete -```json -supportapp:DeleteSlackChannelConfiguration, -supportapp:ListSlackChannelConfigurations -``` - 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 deleted file mode 100644 index 30c3df24f3..0000000000 --- a/docs/awscc-docs/providers/awscc/supportapp/slack_channel_configurations/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -team_id, -channel_id -FROM awscc.supportapp.slack_channel_configurations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the slack_channel_configurations resource, the following permissions are required: - -### Create -```json -supportapp:CreateSlackChannelConfiguration, -supportapp:ListSlackChannelConfigurations -``` - -### List -```json -supportapp:ListSlackChannelConfigurations -``` - 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 deleted file mode 100644 index c9b8290b59..0000000000 --- a/docs/awscc-docs/providers/awscc/supportapp/slack_workspace_configuration/index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -team_id, -version_id -FROM awscc.supportapp.slack_workspace_configuration -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the slack_workspace_configuration resource, the following permissions are required: - -### Read -```json -supportapp:ListSlackWorkspaceConfigurations -``` - -### Update -```json -supportapp:RegisterSlackWorkspaceForOrganization, -supportapp:ListSlackWorkspaceConfigurations -``` - -### Delete -```json -supportapp:ListSlackWorkspaceConfigurations, -supportapp:DeleteSlackWorkspaceConfiguration -``` - 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 deleted file mode 100644 index 883f203c42..0000000000 --- a/docs/awscc-docs/providers/awscc/supportapp/slack_workspace_configurations/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -team_id -FROM awscc.supportapp.slack_workspace_configurations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the slack_workspace_configurations resource, the following permissions are required: - -### Create -```json -supportapp:RegisterSlackWorkspaceForOrganization, -supportapp:ListSlackWorkspaceConfigurations -``` - -### List -```json -supportapp:ListSlackWorkspaceConfigurations -``` - diff --git a/docs/awscc-docs/providers/awscc/synthetics/canaries/index.md b/docs/awscc-docs/providers/awscc/synthetics/canaries/index.md deleted file mode 100644 index fb6f702dca..0000000000 --- a/docs/awscc-docs/providers/awscc/synthetics/canaries/index.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.synthetics.canaries -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the canaries resource, the following permissions are required: - -### Create -```json -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 -```json -synthetics:DescribeCanaries -``` - diff --git a/docs/awscc-docs/providers/awscc/synthetics/canary/index.md b/docs/awscc-docs/providers/awscc/synthetics/canary/index.md deleted file mode 100644 index 93d9298961..0000000000 --- a/docs/awscc-docs/providers/awscc/synthetics/canary/index.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -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
vpc_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. - -## 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, -vpc_config, -run_config, -start_canary_after_creation, -visual_reference, -delete_lambda_resources_on_canary_deletion -FROM awscc.synthetics.canary -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the canary resource, the following permissions are required: - -### Update -```json -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 -```json -synthetics:GetCanary, -synthetics:DescribeCanaries, -synthetics:ListTagsForResource, -iam:ListRoles, -s3:ListAllMyBuckets, -s3:GetBucketLocation -``` - -### Delete -```json -synthetics:DeleteCanary, -synthetics:GetCanary -``` - diff --git a/docs/awscc-docs/providers/awscc/synthetics/group/index.md b/docs/awscc-docs/providers/awscc/synthetics/group/index.md deleted file mode 100644 index 4baec6c5af..0000000000 --- a/docs/awscc-docs/providers/awscc/synthetics/group/index.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -id, -tags, -resource_arns -FROM awscc.synthetics.group -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the group resource, the following permissions are required: - -### Update -```json -synthetics:AssociateResource, -synthetics:DisassociateResource, -synthetics:TagResource, -synthetics:UntagResource, -synthetics:GetGroup, -synthetics:ListGroupResources -``` - -### Read -```json -synthetics:GetGroup, -synthetics:ListTagsForResource, -synthetics:ListGroupResources -``` - -### Delete -```json -synthetics:DeleteGroup, -synthetics:GetGroup -``` - diff --git a/docs/awscc-docs/providers/awscc/synthetics/groups/index.md b/docs/awscc-docs/providers/awscc/synthetics/groups/index.md deleted file mode 100644 index bf6ab1bcaa..0000000000 --- a/docs/awscc-docs/providers/awscc/synthetics/groups/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name -FROM awscc.synthetics.groups -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the groups resource, the following permissions are required: - -### Create -```json -synthetics:CreateGroup, -synthetics:AssociateResource, -synthetics:TagResource, -synthetics:GetGroup -``` - -### List -```json -synthetics:ListGroups -``` - diff --git a/docs/awscc-docs/providers/awscc/synthetics/index.md b/docs/awscc-docs/providers/awscc/synthetics/index.md deleted file mode 100644 index 007fb99b46..0000000000 --- a/docs/awscc-docs/providers/awscc/synthetics/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index 232381ee6c..0000000000 --- a/docs/awscc-docs/providers/awscc/systemsmanagersap/application/index.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -application_id, -application_type, -arn, -credentials, -instances, -sap_instance_number, -sid, -tags -FROM awscc.systemsmanagersap.application -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the application resource, the following permissions are required: - -### Read -```json -ssm-sap:GetApplication, -ssm-sap:ListTagsForResource -``` - -### Update -```json -ssm-sap:TagResource, -ssm-sap:UntagResource, -ssm-sap:ListTagsForResource, -ssm-sap:GetApplication -``` - -### Delete -```json -ssm-sap:DeregisterApplication, -ssm-sap:GetApplication -``` - diff --git a/docs/awscc-docs/providers/awscc/systemsmanagersap/applications/index.md b/docs/awscc-docs/providers/awscc/systemsmanagersap/applications/index.md deleted file mode 100644 index e61ba47d5a..0000000000 --- a/docs/awscc-docs/providers/awscc/systemsmanagersap/applications/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.systemsmanagersap.applications -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the applications resource, the following permissions are required: - -### Create -```json -ssm-sap:RegisterApplication, -ssm-sap:GetApplication, -ssm-sap:TagResource, -ssm-sap:ListTagsForResource -``` - -### List -```json -ssm-sap:ListApplications -``` - diff --git a/docs/awscc-docs/providers/awscc/systemsmanagersap/index.md b/docs/awscc-docs/providers/awscc/systemsmanagersap/index.md deleted file mode 100644 index ce77ad5dcd..0000000000 --- a/docs/awscc-docs/providers/awscc/systemsmanagersap/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 deleted file mode 100644 index 8f532d2b8b..0000000000 --- a/docs/awscc-docs/providers/awscc/timestream/database/index.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -database_name, -kms_key_id, -tags -FROM awscc.timestream.database -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the database resource, the following permissions are required: - -### Read -```json -timestream:DescribeDatabase, -timestream:DescribeEndpoints, -timestream:ListTagsForResource -``` - -### Update -```json -timestream:UpdateDatabase, -timestream:DescribeDatabase, -timestream:DescribeEndpoints, -timestream:TagResource, -timestream:UntagResource -``` - -### Delete -```json -timestream:DeleteDatabase, -timestream:DescribeEndpoints -``` - diff --git a/docs/awscc-docs/providers/awscc/timestream/databases/index.md b/docs/awscc-docs/providers/awscc/timestream/databases/index.md deleted file mode 100644 index 13ceb48266..0000000000 --- a/docs/awscc-docs/providers/awscc/timestream/databases/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -database_name -FROM awscc.timestream.databases -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the databases resource, the following permissions are required: - -### Create -```json -timestream:CreateDatabase, -timestream:DescribeEndpoints, -timestream:TagResource, -kms:CreateGrant, -kms:DescribeKey, -kms:Decrypt -``` - -### List -```json -timestream:ListDatabases, -timestream:DescribeEndpoints -``` - diff --git a/docs/awscc-docs/providers/awscc/timestream/index.md b/docs/awscc-docs/providers/awscc/timestream/index.md deleted file mode 100644 index 0002dfce82..0000000000 --- a/docs/awscc-docs/providers/awscc/timestream/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -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 deleted file mode 100644 index 0030d78df5..0000000000 --- a/docs/awscc-docs/providers/awscc/timestream/scheduled_queries/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.timestream.scheduled_queries -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the scheduled_queries resource, the following permissions are required: - -### Create -```json -timestream:CreateScheduledQuery, -timestream:DescribeEndpoints -``` - -### List -```json -timestream:ListScheduledQueries, -timestream:DescribeEndpoints -``` - diff --git a/docs/awscc-docs/providers/awscc/timestream/scheduled_query/index.md b/docs/awscc-docs/providers/awscc/timestream/scheduled_query/index.md deleted file mode 100644 index 8a3735247f..0000000000 --- a/docs/awscc-docs/providers/awscc/timestream/scheduled_query/index.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -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
sq_namestringThe name of the scheduled query. Scheduled query names must be unique within each Region.
sq_query_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.
sq_schedule_configurationstringConfiguration for when the scheduled query is executed.
sq_notification_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.
sq_scheduled_query_execution_role_arnstringThe ARN for the IAM role that Timestream will assume when running the scheduled query.
sq_target_configurationstringConfiguration of target store where scheduled query results are written to.
sq_error_report_configurationstringConfiguration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
sq_kms_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. - -## 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, -sq_name, -sq_query_string, -sq_schedule_configuration, -sq_notification_configuration, -sq_scheduled_query_execution_role_arn, -sq_target_configuration, -sq_error_report_configuration, -sq_kms_key_id, -tags -FROM awscc.timestream.scheduled_query -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the scheduled_query resource, the following permissions are required: - -### Read -```json -timestream:DescribeScheduledQuery, -timestream:ListTagsForResource, -timestream:DescribeEndpoints -``` - -### Update -```json -timestream:UpdateScheduledQuery, -timestream:TagResource, -timestream:UntagResource, -timestream:DescribeEndpoints -``` - -### Delete -```json -timestream:DeleteScheduledQuery, -timestream:DescribeEndpoints -``` - diff --git a/docs/awscc-docs/providers/awscc/timestream/table/index.md b/docs/awscc-docs/providers/awscc/timestream/table/index.md deleted file mode 100644 index 8c4f290f6c..0000000000 --- a/docs/awscc-docs/providers/awscc/timestream/table/index.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -name, -database_name, -table_name, -retention_properties, -schema, -magnetic_store_write_properties, -tags -FROM awscc.timestream.table -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the table resource, the following permissions are required: - -### Read -```json -timestream:DescribeTable, -timestream:DescribeEndpoints, -timestream:ListTagsForResource -``` - -### Update -```json -timestream:UpdateTable, -timestream:DescribeEndpoints, -timestream:TagResource, -timestream:UntagResource, -s3:PutObject, -s3:GetObject, -s3:GetBucketAcl, -kms:GenerateDataKey*, -kms:DescribeKey, -kms:Encrypt -``` - -### Delete -```json -timestream:DeleteTable, -timestream:DescribeEndpoints, -timestream:DescribeTable -``` - diff --git a/docs/awscc-docs/providers/awscc/timestream/tables/index.md b/docs/awscc-docs/providers/awscc/timestream/tables/index.md deleted file mode 100644 index 911ef883cf..0000000000 --- a/docs/awscc-docs/providers/awscc/timestream/tables/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -database_name, -table_name -FROM awscc.timestream.tables -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the tables resource, the following permissions are required: - -### Create -```json -timestream:CreateTable, -timestream:DescribeEndpoints, -timestream:TagResource, -s3:PutObject, -s3:GetObject, -s3:GetBucketAcl, -kms:GenerateDataKey*, -kms:DescribeKey, -kms:Encrypt -``` - -### List -```json -timestream:ListTables, -timestream:DescribeEndpoints -``` - diff --git a/docs/awscc-docs/providers/awscc/transfer/agreement/index.md b/docs/awscc-docs/providers/awscc/transfer/agreement/index.md deleted file mode 100644 index 6be34a0a53..0000000000 --- a/docs/awscc-docs/providers/awscc/transfer/agreement/index.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -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. - -## 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 data__Identifier = '|'; -``` - -## Permissions - -To operate on the agreement resource, the following permissions are required: - -### Read -```json -transfer:DescribeAgreement -``` - -### Update -```json -transfer:UpdateAgreement, -transfer:UnTagResource, -transfer:TagResource, -iam:PassRole -``` - -### Delete -```json -transfer:DeleteAgreement -``` - diff --git a/docs/awscc-docs/providers/awscc/transfer/agreements/index.md b/docs/awscc-docs/providers/awscc/transfer/agreements/index.md deleted file mode 100644 index d67ff013a5..0000000000 --- a/docs/awscc-docs/providers/awscc/transfer/agreements/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -agreement_id, -server_id -FROM awscc.transfer.agreements -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the agreements resource, the following permissions are required: - -### Create -```json -transfer:CreateAgreement, -transfer:TagResource, -iam:PassRole -``` - -### List -```json -transfer:ListAgreements -``` - diff --git a/docs/awscc-docs/providers/awscc/transfer/certificate/index.md b/docs/awscc-docs/providers/awscc/transfer/certificate/index.md deleted file mode 100644 index 7c6bfff6dc..0000000000 --- a/docs/awscc-docs/providers/awscc/transfer/certificate/index.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the certificate resource, the following permissions are required: - -### Read -```json -transfer:DescribeCertificate -``` - -### Update -```json -transfer:UpdateCertificate, -transfer:UnTagResource, -transfer:TagResource -``` - -### Delete -```json -transfer:DeleteCertificate -``` - diff --git a/docs/awscc-docs/providers/awscc/transfer/certificates/index.md b/docs/awscc-docs/providers/awscc/transfer/certificates/index.md deleted file mode 100644 index 7b6d4b5d79..0000000000 --- a/docs/awscc-docs/providers/awscc/transfer/certificates/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -certificate_id -FROM awscc.transfer.certificates -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the certificates resource, the following permissions are required: - -### Create -```json -transfer:ImportCertificate, -transfer:TagResource -``` - -### List -```json -transfer:ListCertificates -``` - diff --git a/docs/awscc-docs/providers/awscc/transfer/connector/index.md b/docs/awscc-docs/providers/awscc/transfer/connector/index.md deleted file mode 100644 index 498f2eb975..0000000000 --- a/docs/awscc-docs/providers/awscc/transfer/connector/index.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -access_role, -as2_config, -sftp_config, -arn, -connector_id, -logging_role, -tags, -url -FROM awscc.transfer.connector -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the connector resource, the following permissions are required: - -### Read -```json -transfer:DescribeConnector -``` - -### Update -```json -transfer:UpdateConnector, -transfer:UnTagResource, -transfer:TagResource, -iam:PassRole -``` - -### Delete -```json -transfer:DeleteConnector -``` - diff --git a/docs/awscc-docs/providers/awscc/transfer/connectors/index.md b/docs/awscc-docs/providers/awscc/transfer/connectors/index.md deleted file mode 100644 index 209f46f378..0000000000 --- a/docs/awscc-docs/providers/awscc/transfer/connectors/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -connector_id -FROM awscc.transfer.connectors -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the connectors resource, the following permissions are required: - -### Create -```json -transfer:CreateConnector, -transfer:TagResource, -iam:PassRole -``` - -### List -```json -transfer:ListConnectors -``` - diff --git a/docs/awscc-docs/providers/awscc/transfer/index.md b/docs/awscc-docs/providers/awscc/transfer/index.md deleted file mode 100644 index 6ba379da3a..0000000000 --- a/docs/awscc-docs/providers/awscc/transfer/index.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -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 deleted file mode 100644 index 3c762efff7..0000000000 --- a/docs/awscc-docs/providers/awscc/transfer/profile/index.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -as2_id, -profile_type, -tags, -certificate_ids, -arn, -profile_id -FROM awscc.transfer.profile -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the profile resource, the following permissions are required: - -### Read -```json -transfer:DescribeProfile -``` - -### Update -```json -transfer:UpdateProfile, -transfer:UnTagResource, -transfer:TagResource -``` - -### Delete -```json -transfer:DeleteProfile -``` - diff --git a/docs/awscc-docs/providers/awscc/transfer/profiles/index.md b/docs/awscc-docs/providers/awscc/transfer/profiles/index.md deleted file mode 100644 index 9ff71b1fc5..0000000000 --- a/docs/awscc-docs/providers/awscc/transfer/profiles/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -profile_id -FROM awscc.transfer.profiles -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the profiles resource, the following permissions are required: - -### Create -```json -transfer:CreateProfile, -transfer:TagResource -``` - -### List -```json -transfer:ListProfiles -``` - diff --git a/docs/awscc-docs/providers/awscc/transfer/workflow/index.md b/docs/awscc-docs/providers/awscc/transfer/workflow/index.md deleted file mode 100644 index 440e69a9f4..0000000000 --- a/docs/awscc-docs/providers/awscc/transfer/workflow/index.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -on_exception_steps, -steps, -tags, -description, -workflow_id, -arn -FROM awscc.transfer.workflow -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the workflow resource, the following permissions are required: - -### Read -```json -transfer:DescribeWorkflow -``` - -### Delete -```json -transfer:DeleteWorkflow -``` - -### Update -```json -transfer:UnTagResource, -transfer:TagResource -``` - diff --git a/docs/awscc-docs/providers/awscc/transfer/workflows/index.md b/docs/awscc-docs/providers/awscc/transfer/workflows/index.md deleted file mode 100644 index 394a35afc1..0000000000 --- a/docs/awscc-docs/providers/awscc/transfer/workflows/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -workflow_id -FROM awscc.transfer.workflows -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the workflows resource, the following permissions are required: - -### Create -```json -transfer:CreateWorkflow, -transfer:TagResource -``` - -### List -```json -transfer:ListWorkflows -``` - diff --git a/docs/awscc-docs/providers/awscc/verifiedpermissions/identity_source/index.md b/docs/awscc-docs/providers/awscc/verifiedpermissions/identity_source/index.md deleted file mode 100644 index 09629f5680..0000000000 --- a/docs/awscc-docs/providers/awscc/verifiedpermissions/identity_source/index.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -configuration, -details, -identity_source_id, -policy_store_id, -principal_entity_type -FROM awscc.verifiedpermissions.identity_source -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the identity_source resource, the following permissions are required: - -### Read -```json -verifiedpermissions:CreateIdentitySource, -verifiedpermissions:GetIdentitySource, -verifiedpermissions:UpdateIdentitySource, -verifiedpermissions:DeleteIdentitySource, -verifiedpermissions:ListIdentitySources, -cognito-idp:DescribeUserPool, -cognito-idp:ListUserPoolClients -``` - -### Update -```json -verifiedpermissions:CreateIdentitySource, -verifiedpermissions:GetIdentitySource, -verifiedpermissions:UpdateIdentitySource, -verifiedpermissions:DeleteIdentitySource, -verifiedpermissions:ListIdentitySources, -cognito-idp:DescribeUserPool, -cognito-idp:ListUserPoolClients -``` - -### Delete -```json -verifiedpermissions:CreateIdentitySource, -verifiedpermissions:GetIdentitySource, -verifiedpermissions:UpdateIdentitySource, -verifiedpermissions:DeleteIdentitySource, -verifiedpermissions:ListIdentitySources, -cognito-idp:DescribeUserPool, -cognito-idp:ListUserPoolClients -``` - diff --git a/docs/awscc-docs/providers/awscc/verifiedpermissions/identity_sources/index.md b/docs/awscc-docs/providers/awscc/verifiedpermissions/identity_sources/index.md deleted file mode 100644 index d939565d0d..0000000000 --- a/docs/awscc-docs/providers/awscc/verifiedpermissions/identity_sources/index.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -identity_source_id, -policy_store_id -FROM awscc.verifiedpermissions.identity_sources -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the identity_sources resource, the following permissions are required: - -### Create -```json -verifiedpermissions:CreateIdentitySource, -verifiedpermissions:GetIdentitySource, -verifiedpermissions:UpdateIdentitySource, -verifiedpermissions:DeleteIdentitySource, -verifiedpermissions:ListIdentitySources, -cognito-idp:DescribeUserPool, -cognito-idp:ListUserPoolClients -``` - -### List -```json -verifiedpermissions:CreateIdentitySource, -verifiedpermissions:GetIdentitySource, -verifiedpermissions:UpdateIdentitySource, -verifiedpermissions:DeleteIdentitySource, -verifiedpermissions:ListIdentitySources, -cognito-idp:DescribeUserPool, -cognito-idp:ListUserPoolClients -``` - diff --git a/docs/awscc-docs/providers/awscc/verifiedpermissions/index.md b/docs/awscc-docs/providers/awscc/verifiedpermissions/index.md deleted file mode 100644 index 3179be3609..0000000000 --- a/docs/awscc-docs/providers/awscc/verifiedpermissions/index.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -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 deleted file mode 100644 index 70251db3e9..0000000000 --- a/docs/awscc-docs/providers/awscc/verifiedpermissions/policies/index.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -policy_id, -policy_store_id -FROM awscc.verifiedpermissions.policies -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the policies resource, the following permissions are required: - -### Create -```json -verifiedpermissions:CreatePolicy, -verifiedpermissions:GetPolicy, -verifiedpermissions:UpdatePolicy, -verifiedpermissions:DeletePolicy -``` - -### List -```json -verifiedpermissions:CreatePolicy, -verifiedpermissions:GetPolicy, -verifiedpermissions:UpdatePolicy, -verifiedpermissions:DeletePolicy -``` - diff --git a/docs/awscc-docs/providers/awscc/verifiedpermissions/policy/index.md b/docs/awscc-docs/providers/awscc/verifiedpermissions/policy/index.md deleted file mode 100644 index 6fb2185734..0000000000 --- a/docs/awscc-docs/providers/awscc/verifiedpermissions/policy/index.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -definition, -policy_id, -policy_store_id, -policy_type -FROM awscc.verifiedpermissions.policy -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the policy resource, the following permissions are required: - -### Read -```json -verifiedpermissions:CreatePolicy, -verifiedpermissions:GetPolicy, -verifiedpermissions:UpdatePolicy, -verifiedpermissions:DeletePolicy -``` - -### Update -```json -verifiedpermissions:CreatePolicy, -verifiedpermissions:GetPolicy, -verifiedpermissions:UpdatePolicy, -verifiedpermissions:DeletePolicy -``` - -### Delete -```json -verifiedpermissions:CreatePolicy, -verifiedpermissions:GetPolicy, -verifiedpermissions:UpdatePolicy, -verifiedpermissions:DeletePolicy -``` - diff --git a/docs/awscc-docs/providers/awscc/verifiedpermissions/policy_store/index.md b/docs/awscc-docs/providers/awscc/verifiedpermissions/policy_store/index.md deleted file mode 100644 index 47f34a2340..0000000000 --- a/docs/awscc-docs/providers/awscc/verifiedpermissions/policy_store/index.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -description, -policy_store_id, -validation_settings, -schema -FROM awscc.verifiedpermissions.policy_store -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the policy_store resource, the following permissions are required: - -### Read -```json -verifiedpermissions:CreatePolicyStore, -verifiedpermissions:GetPolicyStore, -verifiedpermissions:UpdatePolicyStore, -verifiedpermissions:DeletePolicyStore, -verifiedpermissions:GetSchema -``` - -### Update -```json -verifiedpermissions:CreatePolicyStore, -verifiedpermissions:GetPolicyStore, -verifiedpermissions:UpdatePolicyStore, -verifiedpermissions:DeletePolicyStore, -verifiedpermissions:GetSchema, -verifiedpermissions:PutSchema -``` - -### Delete -```json -verifiedpermissions:CreatePolicyStore, -verifiedpermissions:GetPolicyStore, -verifiedpermissions:UpdatePolicyStore, -verifiedpermissions:DeletePolicyStore -``` - diff --git a/docs/awscc-docs/providers/awscc/verifiedpermissions/policy_stores/index.md b/docs/awscc-docs/providers/awscc/verifiedpermissions/policy_stores/index.md deleted file mode 100644 index cca5935dbb..0000000000 --- a/docs/awscc-docs/providers/awscc/verifiedpermissions/policy_stores/index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -policy_store_id -FROM awscc.verifiedpermissions.policy_stores -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the policy_stores resource, the following permissions are required: - -### Create -```json -verifiedpermissions:CreatePolicyStore, -verifiedpermissions:GetPolicyStore, -verifiedpermissions:UpdatePolicyStore, -verifiedpermissions:DeletePolicyStore, -verifiedpermissions:PutSchema -``` - -### List -```json -verifiedpermissions:CreatePolicyStore, -verifiedpermissions:GetPolicyStore, -verifiedpermissions:UpdatePolicyStore, -verifiedpermissions:DeletePolicyStore, -verifiedpermissions:ListPolicyStores, -verifiedpermissions:GetSchema -``` - diff --git a/docs/awscc-docs/providers/awscc/verifiedpermissions/policy_template/index.md b/docs/awscc-docs/providers/awscc/verifiedpermissions/policy_template/index.md deleted file mode 100644 index 59e5541b91..0000000000 --- a/docs/awscc-docs/providers/awscc/verifiedpermissions/policy_template/index.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -description, -policy_store_id, -policy_template_id, -statement -FROM awscc.verifiedpermissions.policy_template -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the policy_template resource, the following permissions are required: - -### Read -```json -verifiedpermissions:CreatePolicyTemplate, -verifiedpermissions:GetPolicyTemplate, -verifiedpermissions:UpdatePolicyTemplate, -verifiedpermissions:DeletePolicyTemplate -``` - -### Update -```json -verifiedpermissions:CreatePolicyTemplate, -verifiedpermissions:GetPolicyTemplate, -verifiedpermissions:UpdatePolicyTemplate, -verifiedpermissions:DeletePolicyTemplate -``` - -### Delete -```json -verifiedpermissions:CreatePolicyTemplate, -verifiedpermissions:GetPolicyTemplate, -verifiedpermissions:UpdatePolicyTemplate, -verifiedpermissions:DeletePolicyTemplate -``` - diff --git a/docs/awscc-docs/providers/awscc/verifiedpermissions/policy_templates/index.md b/docs/awscc-docs/providers/awscc/verifiedpermissions/policy_templates/index.md deleted file mode 100644 index bac63e9542..0000000000 --- a/docs/awscc-docs/providers/awscc/verifiedpermissions/policy_templates/index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -policy_store_id, -policy_template_id -FROM awscc.verifiedpermissions.policy_templates -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the policy_templates resource, the following permissions are required: - -### Create -```json -verifiedpermissions:CreatePolicyTemplate, -verifiedpermissions:GetPolicyTemplate, -verifiedpermissions:UpdatePolicyTemplate, -verifiedpermissions:DeletePolicyTemplate -``` - -### List -```json -verifiedpermissions:CreatePolicyTemplate, -verifiedpermissions:GetPolicyTemplate, -verifiedpermissions:UpdatePolicyTemplate, -verifiedpermissions:DeletePolicyTemplate, -verifiedpermissions:ListPolicyTemplates -``` - diff --git a/docs/awscc-docs/providers/awscc/voiceid/domain/index.md b/docs/awscc-docs/providers/awscc/voiceid/domain/index.md deleted file mode 100644 index bb3adda20f..0000000000 --- a/docs/awscc-docs/providers/awscc/voiceid/domain/index.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -description, -domain_id, -name, -server_side_encryption_configuration, -tags -FROM awscc.voiceid.domain -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the domain resource, the following permissions are required: - -### Read -```json -voiceid:DescribeDomain, -voiceid:ListTagsForResource, -kms:Decrypt -``` - -### Update -```json -voiceid:DescribeDomain, -voiceid:UpdateDomain, -voiceid:TagResource, -voiceid:UntagResource, -voiceid:ListTagsForResource, -kms:CreateGrant, -kms:Decrypt, -kms:DescribeKey -``` - -### Delete -```json -voiceid:DeleteDomain, -voiceid:DescribeDomain, -kms:Decrypt -``` - diff --git a/docs/awscc-docs/providers/awscc/voiceid/domains/index.md b/docs/awscc-docs/providers/awscc/voiceid/domains/index.md deleted file mode 100644 index 14b3457d57..0000000000 --- a/docs/awscc-docs/providers/awscc/voiceid/domains/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -domain_id -FROM awscc.voiceid.domains -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the domains resource, the following permissions are required: - -### Create -```json -voiceid:CreateDomain, -voiceid:DescribeDomain, -voiceid:TagResource, -voiceid:ListTagsForResource, -kms:CreateGrant, -kms:DescribeKey, -kms:Decrypt -``` - -### List -```json -voiceid:ListDomains, -kms:Decrypt -``` - diff --git a/docs/awscc-docs/providers/awscc/voiceid/index.md b/docs/awscc-docs/providers/awscc/voiceid/index.md deleted file mode 100644 index 41bb546b13..0000000000 --- a/docs/awscc-docs/providers/awscc/voiceid/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 deleted file mode 100644 index 0b9a846160..0000000000 --- a/docs/awscc-docs/providers/awscc/vpclattice/access_log_subscription/index.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -destination_arn, -id, -resource_arn, -resource_id, -resource_identifier, -tags -FROM awscc.vpclattice.access_log_subscription -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the access_log_subscription resource, the following permissions are required: - -### Read -```json -vpc-lattice:GetAccessLogSubscription, -vpc-lattice:ListTagsForResource, -logs:GetLogDelivery -``` - -### Update -```json -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 -```json -vpc-lattice:DeleteAccessLogSubscription, -vpc-lattice:UntagResource, -logs:DeleteLogDelivery, -logs:DeleteLogStream, -logs:GetLogDelivery, -logs:DeleteDestination, -s3:PutBucketLogging, -iam:GetServiceLinkedRoleDeletionStatus, -iam:DeleteServiceLinkedRole, -firehose:DeleteDeliveryStream, -firehose:UntagDeliveryStream -``` - 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 deleted file mode 100644 index e867eec213..0000000000 --- a/docs/awscc-docs/providers/awscc/vpclattice/access_log_subscriptions/index.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.vpclattice.access_log_subscriptions -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the access_log_subscriptions resource, the following permissions are required: - -### Create -```json -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 -```json -vpc-lattice:ListAccessLogSubscriptions -``` - diff --git a/docs/awscc-docs/providers/awscc/vpclattice/auth_policy/index.md b/docs/awscc-docs/providers/awscc/vpclattice/auth_policy/index.md deleted file mode 100644 index df4f8413c8..0000000000 --- a/docs/awscc-docs/providers/awscc/vpclattice/auth_policy/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -resource_identifier, -policy, -state -FROM awscc.vpclattice.auth_policy -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the auth_policy resource, the following permissions are required: - -### Read -```json -vpc-lattice:GetAuthPolicy -``` - -### Update -```json -vpc-lattice:GetAuthPolicy, -vpc-lattice:PutAuthPolicy -``` - -### Delete -```json -vpc-lattice:GetAuthPolicy, -vpc-lattice:DeleteAuthPolicy -``` - diff --git a/docs/awscc-docs/providers/awscc/vpclattice/index.md b/docs/awscc-docs/providers/awscc/vpclattice/index.md deleted file mode 100644 index ab85b8d6e9..0000000000 --- a/docs/awscc-docs/providers/awscc/vpclattice/index.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -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: 18
-total selectable resources: 18
-total methods: 18
-
-
- -::: - -## Resources -
-
-access_log_subscription
-access_log_subscriptions
-auth_policy
-listener
-listeners
-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 deleted file mode 100644 index 0ebfb3b438..0000000000 --- a/docs/awscc-docs/providers/awscc/vpclattice/listener/index.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -default_action, -id, -name, -port, -protocol, -service_arn, -service_id, -service_identifier, -tags -FROM awscc.vpclattice.listener -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the listener resource, the following permissions are required: - -### Read -```json -vpc-lattice:GetListener, -vpc-lattice:ListTagsForResource -``` - -### Update -```json -vpc-lattice:UpdateListener, -vpc-lattice:TagResource, -vpc-lattice:UntagResource, -vpc-lattice:GetListener, -vpc-lattice:ListTagsForResource -``` - -### Delete -```json -vpc-lattice:DeleteListener -``` - diff --git a/docs/awscc-docs/providers/awscc/vpclattice/listeners/index.md b/docs/awscc-docs/providers/awscc/vpclattice/listeners/index.md deleted file mode 100644 index dd17387c33..0000000000 --- a/docs/awscc-docs/providers/awscc/vpclattice/listeners/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.vpclattice.listeners -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the listeners resource, the following permissions are required: - -### Create -```json -vpc-lattice:CreateListener, -vpc-lattice:TagResource, -vpc-lattice:GetListener, -vpc-lattice:ListTagsForResource -``` - -### List -```json -vpc-lattice:ListListeners -``` - diff --git a/docs/awscc-docs/providers/awscc/vpclattice/resource_policy/index.md b/docs/awscc-docs/providers/awscc/vpclattice/resource_policy/index.md deleted file mode 100644 index b9929c9780..0000000000 --- a/docs/awscc-docs/providers/awscc/vpclattice/resource_policy/index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -resource_arn, -policy -FROM awscc.vpclattice.resource_policy -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the resource_policy resource, the following permissions are required: - -### Read -```json -vpc-lattice:GetResourcePolicy -``` - -### Update -```json -vpc-lattice:GetResourcePolicy, -vpc-lattice:PutResourcePolicy -``` - -### Delete -```json -vpc-lattice:GetResourcePolicy, -vpc-lattice:DeleteResourcePolicy -``` - diff --git a/docs/awscc-docs/providers/awscc/vpclattice/rule/index.md b/docs/awscc-docs/providers/awscc/vpclattice/rule/index.md deleted file mode 100644 index 572734f3e7..0000000000 --- a/docs/awscc-docs/providers/awscc/vpclattice/rule/index.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -action, -arn, -id, -listener_identifier, -match, -name, -priority, -service_identifier, -tags -FROM awscc.vpclattice.rule -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the rule resource, the following permissions are required: - -### Read -```json -vpc-lattice:GetRule, -vpc-lattice:ListTagsForResource -``` - -### Update -```json -vpc-lattice:UpdateRule, -vpc-lattice:GetRule, -vpc-lattice:TagResource, -vpc-lattice:UntagResource -``` - -### Delete -```json -vpc-lattice:DeleteRule -``` - diff --git a/docs/awscc-docs/providers/awscc/vpclattice/rules/index.md b/docs/awscc-docs/providers/awscc/vpclattice/rules/index.md deleted file mode 100644 index 2af99b06b5..0000000000 --- a/docs/awscc-docs/providers/awscc/vpclattice/rules/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.vpclattice.rules -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the rules resource, the following permissions are required: - -### Create -```json -vpc-lattice:CreateRule, -vpc-lattice:GetRule, -vpc-lattice:ListTagsForResource, -vpc-lattice:TagResource -``` - -### List -```json -vpc-lattice:ListRules -``` - diff --git a/docs/awscc-docs/providers/awscc/vpclattice/service/index.md b/docs/awscc-docs/providers/awscc/vpclattice/service/index.md deleted file mode 100644 index c8444fdcd8..0000000000 --- a/docs/awscc-docs/providers/awscc/vpclattice/service/index.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the service resource, the following permissions are required: - -### Read -```json -vpc-lattice:GetService, -vpc-lattice:ListTagsForResource -``` - -### Update -```json -vpc-lattice:UpdateService, -vpc-lattice:TagResource, -vpc-lattice:UntagResource, -vpc-lattice:GetService, -vpc-lattice:ListTagsForResource -``` - -### Delete -```json -vpc-lattice:DeleteService, -vpc-lattice:GetService -``` - diff --git a/docs/awscc-docs/providers/awscc/vpclattice/service_network/index.md b/docs/awscc-docs/providers/awscc/vpclattice/service_network/index.md deleted file mode 100644 index 1a94a71447..0000000000 --- a/docs/awscc-docs/providers/awscc/vpclattice/service_network/index.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -created_at, -id, -last_updated_at, -name, -auth_type, -tags -FROM awscc.vpclattice.service_network -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the service_network resource, the following permissions are required: - -### Read -```json -vpc-lattice:GetServiceNetwork, -vpc-lattice:ListTagsForResource -``` - -### Update -```json -vpc-lattice:GetServiceNetwork, -vpc-lattice:UpdateServiceNetwork, -vpc-lattice:TagResource, -vpc-lattice:UntagResource -``` - -### Delete -```json -vpc-lattice:DeleteServiceNetwork -``` - 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 deleted file mode 100644 index 9a71061947..0000000000 --- a/docs/awscc-docs/providers/awscc/vpclattice/service_network_service_association/index.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the service_network_service_association resource, the following permissions are required: - -### Read -```json -vpc-lattice:GetServiceNetworkServiceAssociation, -vpc-lattice:ListTagsForResource -``` - -### Update -```json -vpc-lattice:TagResource, -vpc-lattice:UntagResource, -vpc-lattice:GetServiceNetworkServiceAssociation, -vpc-lattice:ListTagsForResource -``` - -### Delete -```json -vpc-lattice:DeleteServiceNetworkServiceAssociation, -vpc-lattice:GetServiceNetworkServiceAssociation -``` - 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 deleted file mode 100644 index 848ccfcca2..0000000000 --- a/docs/awscc-docs/providers/awscc/vpclattice/service_network_service_associations/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.vpclattice.service_network_service_associations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the service_network_service_associations resource, the following permissions are required: - -### Create -```json -vpc-lattice:CreateServiceNetworkServiceAssociation, -vpc-lattice:GetServiceNetworkServiceAssociation, -vpc-lattice:TagResource, -vpc-lattice:ListTagsForResource -``` - -### List -```json -vpc-lattice:ListServiceNetworkServiceAssociations -``` - 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 deleted file mode 100644 index 371da10770..0000000000 --- a/docs/awscc-docs/providers/awscc/vpclattice/service_network_vpc_association/index.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the service_network_vpc_association resource, the following permissions are required: - -### Read -```json -vpc-lattice:GetServiceNetworkVpcAssociation, -vpc-lattice:ListTagsForResource -``` - -### Update -```json -vpc-lattice:TagResource, -vpc-lattice:UntagResource, -vpc-lattice:GetServiceNetworkVpcAssociation, -vpc-lattice:UpdateServiceNetworkVpcAssociation, -ec2:DescribeSecurityGroups, -vpc-lattice:ListTagsForResource -``` - -### Delete -```json -vpc-lattice:DeleteServiceNetworkVpcAssociation, -vpc-lattice:GetServiceNetworkVpcAssociation -``` - 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 deleted file mode 100644 index 21de56af4a..0000000000 --- a/docs/awscc-docs/providers/awscc/vpclattice/service_network_vpc_associations/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.vpclattice.service_network_vpc_associations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the service_network_vpc_associations resource, the following permissions are required: - -### Create -```json -vpc-lattice:CreateServiceNetworkVpcAssociation, -vpc-lattice:GetServiceNetworkVpcAssociation, -vpc-lattice:ListServiceNetworkVpcAssociations, -vpc-lattice:ListTagsForResource, -ec2:DescribeSecurityGroups, -ec2:DescribeVpcs, -vpc-lattice:TagResource -``` - -### List -```json -vpc-lattice:ListServiceNetworkVpcAssociations -``` - diff --git a/docs/awscc-docs/providers/awscc/vpclattice/service_networks/index.md b/docs/awscc-docs/providers/awscc/vpclattice/service_networks/index.md deleted file mode 100644 index 4d8f0122f2..0000000000 --- a/docs/awscc-docs/providers/awscc/vpclattice/service_networks/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.vpclattice.service_networks -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the service_networks resource, the following permissions are required: - -### Create -```json -vpc-lattice:GetServiceNetwork, -vpc-lattice:ListTagsForResource, -vpc-lattice:CreateServiceNetwork, -vpc-lattice:TagResource, -iam:CreateServiceLinkedRole -``` - -### List -```json -vpc-lattice:ListServiceNetworks -``` - diff --git a/docs/awscc-docs/providers/awscc/vpclattice/services/index.md b/docs/awscc-docs/providers/awscc/vpclattice/services/index.md deleted file mode 100644 index 1038eabb11..0000000000 --- a/docs/awscc-docs/providers/awscc/vpclattice/services/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.vpclattice.services -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the services resource, the following permissions are required: - -### Create -```json -vpc-lattice:CreateService, -vpc-lattice:GetService, -vpc-lattice:ListTagsForResource, -vpc-lattice:TagResource, -acm:DescribeCertificate, -acm:ListCertificates, -iam:CreateServiceLinkedRole -``` - -### List -```json -vpc-lattice:ListServices -``` - diff --git a/docs/awscc-docs/providers/awscc/vpclattice/target_group/index.md b/docs/awscc-docs/providers/awscc/vpclattice/target_group/index.md deleted file mode 100644 index f949e9954e..0000000000 --- a/docs/awscc-docs/providers/awscc/vpclattice/target_group/index.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -config, -created_at, -id, -last_updated_at, -name, -status, -type, -targets, -tags -FROM awscc.vpclattice.target_group -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the target_group resource, the following permissions are required: - -### Read -```json -vpc-lattice:GetTargetGroup, -vpc-lattice:ListTargets, -vpc-lattice:ListTagsForResource -``` - -### Update -```json -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 -```json -vpc-lattice:DeleteTargetGroup, -vpc-lattice:GetTargetGroup, -vpc-lattice:DeregisterTargets, -vpc-lattice:ListTargets, -lambda:RemovePermission -``` - diff --git a/docs/awscc-docs/providers/awscc/vpclattice/target_groups/index.md b/docs/awscc-docs/providers/awscc/vpclattice/target_groups/index.md deleted file mode 100644 index 30bdfef50f..0000000000 --- a/docs/awscc-docs/providers/awscc/vpclattice/target_groups/index.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn -FROM awscc.vpclattice.target_groups -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the target_groups resource, the following permissions are required: - -### Create -```json -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 -```json -vpc-lattice:ListTargetGroups -``` - diff --git a/docs/awscc-docs/providers/awscc/wafv2/index.md b/docs/awscc-docs/providers/awscc/wafv2/index.md deleted file mode 100644 index 6ea98ce7dc..0000000000 --- a/docs/awscc-docs/providers/awscc/wafv2/index.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -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: 11
-total selectable resources: 11
-total methods: 11
-
-
- -::: - -## 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 -
-
\ 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 deleted file mode 100644 index e9486896e0..0000000000 --- a/docs/awscc-docs/providers/awscc/wafv2/ip_set/index.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -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
ip_address_versionstring
addressesarrayList of IPAddresses.
tagsarray
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -arn, -description, -name, -id, -scope, -ip_address_version, -addresses, -tags -FROM awscc.wafv2.ip_set -WHERE data__Identifier = '||'; -``` - -## Permissions - -To operate on the ip_set resource, the following permissions are required: - -### Delete -```json -wafv2:DeleteIPSet, -wafv2:GetIPSet -``` - -### Read -```json -wafv2:GetIPSet, -wafv2:ListTagsForResource -``` - -### Update -```json -wafv2:UpdateIPSet, -wafv2:GetIPSet, -wafv2:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/wafv2/ip_sets/index.md b/docs/awscc-docs/providers/awscc/wafv2/ip_sets/index.md deleted file mode 100644 index c2a10ebbc1..0000000000 --- a/docs/awscc-docs/providers/awscc/wafv2/ip_sets/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -id, -scope -FROM awscc.wafv2.ip_sets - -``` - -## Permissions - -To operate on the ip_sets resource, the following permissions are required: - -### Create -```json -wafv2:CreateIPSet, -wafv2:GetIPSet, -wafv2:ListTagsForResource -``` - -### List -```json -wafv2:listIPSets -``` - diff --git a/docs/awscc-docs/providers/awscc/wafv2/logging_configuration/index.md b/docs/awscc-docs/providers/awscc/wafv2/logging_configuration/index.md deleted file mode 100644 index 5e83545d15..0000000000 --- a/docs/awscc-docs/providers/awscc/wafv2/logging_configuration/index.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -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. - -## 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 = ''; -``` - -## Permissions - -To operate on the logging_configuration resource, the following permissions are required: - -### Read -```json -wafv2:GetLoggingConfiguration -``` - -### Update -```json -wafv2:PutLoggingConfiguration, -wafv2:GetLoggingConfiguration, -firehose:ListDeliveryStreams, -iam:CreateServiceLinkedRole, -iam:DescribeOrganization, -logs:CreateLogDelivery, -s3:PutBucketPolicy, -s3:GetBucketPolicy, -logs:PutResourcePolicy, -logs:DescribeResourcePolicies, -logs:DescribeLogGroups -``` - -### Delete -```json -wafv2:DeleteLoggingConfiguration, -wafv2:GetLoggingConfiguration, -logs:DeleteLogDelivery -``` - diff --git a/docs/awscc-docs/providers/awscc/wafv2/logging_configurations/index.md b/docs/awscc-docs/providers/awscc/wafv2/logging_configurations/index.md deleted file mode 100644 index fa2e05fcb5..0000000000 --- a/docs/awscc-docs/providers/awscc/wafv2/logging_configurations/index.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -resource_arn -FROM awscc.wafv2.logging_configurations - -``` - -## Permissions - -To operate on the logging_configurations resource, the following permissions are required: - -### Create -```json -wafv2:PutLoggingConfiguration, -wafv2:GetLoggingConfiguration, -firehose:ListDeliveryStreams, -iam:CreateServiceLinkedRole, -iam:DescribeOrganization, -logs:CreateLogDelivery, -s3:PutBucketPolicy, -s3:GetBucketPolicy, -logs:PutResourcePolicy, -logs:DescribeResourcePolicies, -logs:DescribeLogGroups -``` - -### List -```json -wafv2:ListLoggingConfigurations -``` - 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 deleted file mode 100644 index bc9450fae6..0000000000 --- a/docs/awscc-docs/providers/awscc/wafv2/regex_pattern_set/index.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -arn, -description, -name, -id, -regular_expression_list, -scope, -tags -FROM awscc.wafv2.regex_pattern_set -WHERE data__Identifier = '||'; -``` - -## Permissions - -To operate on the regex_pattern_set resource, the following permissions are required: - -### Delete -```json -wafv2:DeleteRegexPatternSet, -wafv2:GetRegexPatternSet -``` - -### Read -```json -wafv2:GetRegexPatternSet, -wafv2:ListTagsForResource -``` - -### Update -```json -wafv2:UpdateRegexPatternSet, -wafv2:GetRegexPatternSet, -wafv2:ListTagsForResource -``` - 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 deleted file mode 100644 index 1b462804b0..0000000000 --- a/docs/awscc-docs/providers/awscc/wafv2/regex_pattern_sets/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -id, -scope -FROM awscc.wafv2.regex_pattern_sets - -``` - -## Permissions - -To operate on the regex_pattern_sets resource, the following permissions are required: - -### Create -```json -wafv2:CreateRegexPatternSet, -wafv2:GetRegexPatternSet, -wafv2:ListTagsForResource -``` - -### List -```json -wafv2:listRegexPatternSets -``` - diff --git a/docs/awscc-docs/providers/awscc/wafv2/rule_group/index.md b/docs/awscc-docs/providers/awscc/wafv2/rule_group/index.md deleted file mode 100644 index e8a4308c9e..0000000000 --- a/docs/awscc-docs/providers/awscc/wafv2/rule_group/index.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -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. - -## 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 = '||'; -``` - -## Permissions - -To operate on the rule_group resource, the following permissions are required: - -### Delete -```json -wafv2:DeleteRuleGroup, -wafv2:GetRuleGroup -``` - -### Read -```json -wafv2:GetRuleGroup, -wafv2:ListTagsForResource -``` - -### Update -```json -wafv2:UpdateRuleGroup, -wafv2:GetRuleGroup, -wafv2:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/wafv2/rule_groups/index.md b/docs/awscc-docs/providers/awscc/wafv2/rule_groups/index.md deleted file mode 100644 index 4181c28d3c..0000000000 --- a/docs/awscc-docs/providers/awscc/wafv2/rule_groups/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -id, -scope -FROM awscc.wafv2.rule_groups - -``` - -## Permissions - -To operate on the rule_groups resource, the following permissions are required: - -### Create -```json -wafv2:CreateRuleGroup, -wafv2:GetRuleGroup, -wafv2:ListTagsForResource -``` - -### List -```json -wafv2:listRuleGroups -``` - diff --git a/docs/awscc-docs/providers/awscc/wafv2/web_acl/index.md b/docs/awscc-docs/providers/awscc/wafv2/web_acl/index.md deleted file mode 100644 index ae7384d0e8..0000000000 --- a/docs/awscc-docs/providers/awscc/wafv2/web_acl/index.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -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. - -## 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 = '||'; -``` - -## Permissions - -To operate on the web_acl resource, the following permissions are required: - -### Delete -```json -wafv2:DeleteWebACL, -wafv2:GetWebACL -``` - -### Read -```json -wafv2:GetWebACL, -wafv2:ListTagsForResource -``` - -### Update -```json -wafv2:UpdateWebACL, -wafv2:GetWebACL, -wafv2:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/wafv2/web_acls/index.md b/docs/awscc-docs/providers/awscc/wafv2/web_acls/index.md deleted file mode 100644 index 21097ac1d5..0000000000 --- a/docs/awscc-docs/providers/awscc/wafv2/web_acls/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -name, -id, -scope -FROM awscc.wafv2.web_acls - -``` - -## Permissions - -To operate on the web_acls resource, the following permissions are required: - -### Create -```json -wafv2:CreateWebACL, -wafv2:GetWebACL, -wafv2:ListTagsForResource -``` - -### List -```json -wafv2:listWebACLs -``` - diff --git a/docs/awscc-docs/providers/awscc/wafv2/webacl_association/index.md b/docs/awscc-docs/providers/awscc/wafv2/webacl_association/index.md deleted file mode 100644 index dd88b354b3..0000000000 --- a/docs/awscc-docs/providers/awscc/wafv2/webacl_association/index.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -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_acl_arnstring
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -resource_arn, -web_acl_arn -FROM awscc.wafv2.webacl_association -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the webacl_association resource, the following permissions are required: - -### Delete -```json -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 -```json -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 -```json -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 -``` - diff --git a/docs/awscc-docs/providers/awscc/wisdom/assistant/index.md b/docs/awscc-docs/providers/awscc/wisdom/assistant/index.md deleted file mode 100644 index 44f165255c..0000000000 --- a/docs/awscc-docs/providers/awscc/wisdom/assistant/index.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -type, -description, -assistant_arn, -assistant_id, -server_side_encryption_configuration, -tags, -name -FROM awscc.wisdom.assistant -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the assistant resource, the following permissions are required: - -### Update -```json -wisdom:GetAssistant -``` - -### Read -```json -wisdom:GetAssistant -``` - -### Delete -```json -wisdom:DeleteAssistant -``` - diff --git a/docs/awscc-docs/providers/awscc/wisdom/assistant_association/index.md b/docs/awscc-docs/providers/awscc/wisdom/assistant_association/index.md deleted file mode 100644 index b403cec975..0000000000 --- a/docs/awscc-docs/providers/awscc/wisdom/assistant_association/index.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -assistant_association_arn, -assistant_arn, -assistant_association_id, -assistant_id, -association, -association_type, -tags -FROM awscc.wisdom.assistant_association -WHERE data__Identifier = '|'; -``` - -## Permissions - -To operate on the assistant_association resource, the following permissions are required: - -### Update -```json -wisdom:GetAssistantAssociation -``` - -### Read -```json -wisdom:GetAssistantAssociation -``` - -### Delete -```json -wisdom:DeleteAssistantAssociation -``` - diff --git a/docs/awscc-docs/providers/awscc/wisdom/assistant_associations/index.md b/docs/awscc-docs/providers/awscc/wisdom/assistant_associations/index.md deleted file mode 100644 index 61236c713b..0000000000 --- a/docs/awscc-docs/providers/awscc/wisdom/assistant_associations/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -assistant_association_id, -assistant_id -FROM awscc.wisdom.assistant_associations -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the assistant_associations resource, the following permissions are required: - -### Create -```json -wisdom:CreateAssistantAssociation, -wisdom:TagResource -``` - -### List -```json -wisdom:ListAssistantAssociations -``` - diff --git a/docs/awscc-docs/providers/awscc/wisdom/assistants/index.md b/docs/awscc-docs/providers/awscc/wisdom/assistants/index.md deleted file mode 100644 index 05894f6fbe..0000000000 --- a/docs/awscc-docs/providers/awscc/wisdom/assistants/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -assistant_id -FROM awscc.wisdom.assistants -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the assistants resource, the following permissions are required: - -### Create -```json -kms:CreateGrant, -kms:DescribeKey, -wisdom:CreateAssistant, -wisdom:TagResource -``` - -### List -```json -wisdom:ListAssistants -``` - diff --git a/docs/awscc-docs/providers/awscc/wisdom/index.md b/docs/awscc-docs/providers/awscc/wisdom/index.md deleted file mode 100644 index 6ece5e265c..0000000000 --- a/docs/awscc-docs/providers/awscc/wisdom/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -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 deleted file mode 100644 index dd110379a1..0000000000 --- a/docs/awscc-docs/providers/awscc/wisdom/knowledge_base/index.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the knowledge_base resource, the following permissions are required: - -### Update -```json -wisdom:GetKnowledgeBase -``` - -### Delete -```json -appflow:DeleteFlow, -appflow:StopFlow, -app-integrations:DeleteDataIntegrationAssociation, -wisdom:DeleteKnowledgeBase -``` - -### Read -```json -wisdom:GetKnowledgeBase -``` - diff --git a/docs/awscc-docs/providers/awscc/wisdom/knowledge_bases/index.md b/docs/awscc-docs/providers/awscc/wisdom/knowledge_bases/index.md deleted file mode 100644 index 02a390e35b..0000000000 --- a/docs/awscc-docs/providers/awscc/wisdom/knowledge_bases/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -knowledge_base_id -FROM awscc.wisdom.knowledge_bases -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the knowledge_bases resource, the following permissions are required: - -### Create -```json -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 -```json -wisdom:ListKnowledgeBases -``` - diff --git a/docs/awscc-docs/providers/awscc/workspaces/connection_alias/index.md b/docs/awscc-docs/providers/awscc/workspaces/connection_alias/index.md deleted file mode 100644 index ae93c38388..0000000000 --- a/docs/awscc-docs/providers/awscc/workspaces/connection_alias/index.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -associations, -alias_id, -connection_string, -connection_alias_state, -tags -FROM awscc.workspaces.connection_alias -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the connection_alias resource, the following permissions are required: - -### Read -```json -workspaces:DescribeConnectionAliases -``` - -### Delete -```json -workspaces:DeleteConnectionAlias -``` - diff --git a/docs/awscc-docs/providers/awscc/workspaces/index.md b/docs/awscc-docs/providers/awscc/workspaces/index.md deleted file mode 100644 index eeb9f6a830..0000000000 --- a/docs/awscc-docs/providers/awscc/workspaces/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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: 1
-total selectable resources: 1
-total methods: 1
-
-
- -::: - -## Resources -
-
-connection_alias -
-
- -
-
\ 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 deleted file mode 100644 index 2bb0fb67c2..0000000000 --- a/docs/awscc-docs/providers/awscc/workspacesthinclient/environment/index.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the environment resource, the following permissions are required: - -### Read -```json -thinclient:GetEnvironment, -thinclient:ListTagsForResource, -kms:DescribeKey, -kms:Encrypt, -kms:Decrypt -``` - -### Update -```json -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 -```json -thinclient:DeleteEnvironment, -thinclient:UntagResource, -kms:DescribeKey, -kms:RetireGrant -``` - diff --git a/docs/awscc-docs/providers/awscc/workspacesthinclient/environments/index.md b/docs/awscc-docs/providers/awscc/workspacesthinclient/environments/index.md deleted file mode 100644 index 91d121a294..0000000000 --- a/docs/awscc-docs/providers/awscc/workspacesthinclient/environments/index.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -id -FROM awscc.workspacesthinclient.environments -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the environments resource, the following permissions are required: - -### Create -```json -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 -```json -thinclient:ListEnvironment, -thinclient:ListTagsForResource, -kms:DescribeKey, -kms:Encrypt, -kms:Decrypt -``` - diff --git a/docs/awscc-docs/providers/awscc/workspacesthinclient/index.md b/docs/awscc-docs/providers/awscc/workspacesthinclient/index.md deleted file mode 100644 index edab35d048..0000000000 --- a/docs/awscc-docs/providers/awscc/workspacesthinclient/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 deleted file mode 100644 index 25115cb0d3..0000000000 --- a/docs/awscc-docs/providers/awscc/workspacesweb/browser_settings/index.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the browser_settings resource, the following permissions are required: - -### Read -```json -workspaces-web:GetBrowserSettings, -workspaces-web:ListBrowserSettings, -workspaces-web:ListTagsForResource, -kms:CreateGrant, -kms:DescribeKey, -kms:GenerateDataKey, -kms:Decrypt -``` - -### Update -```json -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 -```json -workspaces-web:GetBrowserSettings, -workspaces-web:DeleteBrowserSettings, -kms:CreateGrant, -kms:DescribeKey, -kms:GenerateDataKey, -kms:Decrypt -``` - diff --git a/docs/awscc-docs/providers/awscc/workspacesweb/identity_provider/index.md b/docs/awscc-docs/providers/awscc/workspacesweb/identity_provider/index.md deleted file mode 100644 index adfac031b1..0000000000 --- a/docs/awscc-docs/providers/awscc/workspacesweb/identity_provider/index.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -identity_provider_arn, -identity_provider_details, -identity_provider_name, -identity_provider_type, -portal_arn -FROM awscc.workspacesweb.identity_provider -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the identity_provider resource, the following permissions are required: - -### Read -```json -workspaces-web:GetIdentityProvider, -workspaces-web:ListIdentityProviders, -workspaces-web:ListTagsForResource -``` - -### Update -```json -workspaces-web:UpdateIdentityProvider, -workspaces-web:TagResource, -workspaces-web:UntagResource, -workspaces-web:GetIdentityProvider, -workspaces-web:ListIdentityProviders, -workspaces-web:ListTagsForResource -``` - -### Delete -```json -workspaces-web:GetIdentityProvider, -workspaces-web:DeleteIdentityProvider -``` - diff --git a/docs/awscc-docs/providers/awscc/workspacesweb/identity_providers/index.md b/docs/awscc-docs/providers/awscc/workspacesweb/identity_providers/index.md deleted file mode 100644 index ef72dfbac2..0000000000 --- a/docs/awscc-docs/providers/awscc/workspacesweb/identity_providers/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -identity_provider_arn -FROM awscc.workspacesweb.identity_providers -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the identity_providers resource, the following permissions are required: - -### Create -```json -workspaces-web:CreateIdentityProvider, -workspaces-web:GetIdentityProvider, -workspaces-web:ListTagsForResource, -workspaces-web:TagResource -``` - -### List -```json -workspaces-web:ListIdentityProviders -``` - diff --git a/docs/awscc-docs/providers/awscc/workspacesweb/index.md b/docs/awscc-docs/providers/awscc/workspacesweb/index.md deleted file mode 100644 index cc3d5eab34..0000000000 --- a/docs/awscc-docs/providers/awscc/workspacesweb/index.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -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 deleted file mode 100644 index 90497c278a..0000000000 --- a/docs/awscc-docs/providers/awscc/workspacesweb/ip_access_settings/index.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the ip_access_settings resource, the following permissions are required: - -### Read -```json -workspaces-web:GetIpAccessSettings, -workspaces-web:ListIpAccessSettings, -workspaces-web:ListTagsForResource, -kms:CreateGrant, -kms:DescribeKey, -kms:GenerateDataKey, -kms:Decrypt -``` - -### Update -```json -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 -```json -workspaces-web:GetIpAccessSettings, -workspaces-web:ListIpAccessSettings, -workspaces-web:DeleteIpAccessSettings, -kms:CreateGrant, -kms:DescribeKey, -kms:GenerateDataKey, -kms:Decrypt -``` - diff --git a/docs/awscc-docs/providers/awscc/workspacesweb/network_settings/index.md b/docs/awscc-docs/providers/awscc/workspacesweb/network_settings/index.md deleted file mode 100644 index c239497a3b..0000000000 --- a/docs/awscc-docs/providers/awscc/workspacesweb/network_settings/index.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -associated_portal_arns, -network_settings_arn, -security_group_ids, -subnet_ids, -tags, -vpc_id -FROM awscc.workspacesweb.network_settings -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the network_settings resource, the following permissions are required: - -### Read -```json -workspaces-web:GetNetworkSettings, -workspaces-web:ListTagsForResource -``` - -### Update -```json -workspaces-web:UpdateNetworkSettings, -workspaces-web:UpdateResource, -workspaces-web:TagResource, -workspaces-web:UntagResource, -workspaces-web:GetNetworkSettings, -workspaces-web:ListTagsForResource -``` - -### Delete -```json -workspaces-web:GetNetworkSettings, -workspaces-web:DeleteNetworkSettings -``` - diff --git a/docs/awscc-docs/providers/awscc/workspacesweb/portal/index.md b/docs/awscc-docs/providers/awscc/workspacesweb/portal/index.md deleted file mode 100644 index 7c25ba38a5..0000000000 --- a/docs/awscc-docs/providers/awscc/workspacesweb/portal/index.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the portal resource, the following permissions are required: - -### Read -```json -workspaces-web:GetPortal, -workspaces-web:GetPortalServiceProviderMetadata, -workspaces-web:ListTagsForResource, -kms:Decrypt -``` - -### Update -```json -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 -```json -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 -``` - diff --git a/docs/awscc-docs/providers/awscc/workspacesweb/portals/index.md b/docs/awscc-docs/providers/awscc/workspacesweb/portals/index.md deleted file mode 100644 index 926bb45d1f..0000000000 --- a/docs/awscc-docs/providers/awscc/workspacesweb/portals/index.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -portal_arn -FROM awscc.workspacesweb.portals -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the portals resource, the following permissions are required: - -### Create -```json -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 -```json -workspaces-web:ListPortals, -kms:Decrypt -``` - diff --git a/docs/awscc-docs/providers/awscc/workspacesweb/trust_store/index.md b/docs/awscc-docs/providers/awscc/workspacesweb/trust_store/index.md deleted file mode 100644 index 77f6d7660c..0000000000 --- a/docs/awscc-docs/providers/awscc/workspacesweb/trust_store/index.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -associated_portal_arns, -certificate_list, -tags, -trust_store_arn -FROM awscc.workspacesweb.trust_store -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the trust_store resource, the following permissions are required: - -### Read -```json -workspaces-web:GetTrustStore, -workspaces-web:GetTrustStoreCertificate, -workspaces-web:ListTagsForResource, -workspaces-web:ListTrustStoreCertificates -``` - -### Update -```json -workspaces-web:UpdateTrustStore, -workspaces-web:TagResource, -workspaces-web:UntagResource, -workspaces-web:GetTrustStore, -workspaces-web:GetTrustStoreCertificate, -workspaces-web:ListTagsForResource, -workspaces-web:ListTrustStoreCertificates -``` - -### Delete -```json -workspaces-web:GetTrustStore, -workspaces-web:GetTrustStoreCertificate, -workspaces-web:DeleteTrustStore -``` - diff --git a/docs/awscc-docs/providers/awscc/workspacesweb/trust_stores/index.md b/docs/awscc-docs/providers/awscc/workspacesweb/trust_stores/index.md deleted file mode 100644 index e89714cc95..0000000000 --- a/docs/awscc-docs/providers/awscc/workspacesweb/trust_stores/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -trust_store_arn -FROM awscc.workspacesweb.trust_stores -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the trust_stores resource, the following permissions are required: - -### Create -```json -workspaces-web:CreateTrustStore, -workspaces-web:GetTrustStore, -workspaces-web:GetTrustStoreCertificate, -workspaces-web:ListTrustStoreCertificates, -workspaces-web:ListTagsForResource, -workspaces-web:TagResource -``` - -### List -```json -workspaces-web:ListTrustStores, -workspaces-web:ListTrustStoreCertificates -``` - 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 deleted file mode 100644 index e972698069..0000000000 --- a/docs/awscc-docs/providers/awscc/workspacesweb/user_access_logging_settings/index.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -associated_portal_arns, -kinesis_stream_arn, -tags, -user_access_logging_settings_arn -FROM awscc.workspacesweb.user_access_logging_settings -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the user_access_logging_settings resource, the following permissions are required: - -### Read -```json -workspaces-web:GetUserAccessLoggingSettings, -workspaces-web:ListTagsForResource -``` - -### Update -```json -workspaces-web:UpdateUserAccessLoggingSettings, -workspaces-web:TagResource, -workspaces-web:UntagResource, -workspaces-web:GetUserAccessLoggingSettings, -workspaces-web:ListTagsForResource, -kinesis:PutRecord, -kinesis:PutRecords -``` - -### Delete -```json -workspaces-web:GetUserAccessLoggingSettings, -workspaces-web:DeleteUserAccessLoggingSettings -``` - diff --git a/docs/awscc-docs/providers/awscc/workspacesweb/user_settings/index.md b/docs/awscc-docs/providers/awscc/workspacesweb/user_settings/index.md deleted file mode 100644 index f1ec186cdf..0000000000 --- a/docs/awscc-docs/providers/awscc/workspacesweb/user_settings/index.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -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. - -## 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 data__Identifier = ''; -``` - -## Permissions - -To operate on the user_settings resource, the following permissions are required: - -### Read -```json -workspaces-web:GetUserSettings, -workspaces-web:ListTagsForResource, -kms:CreateGrant, -kms:DescribeKey, -kms:GenerateDataKey, -kms:Decrypt -``` - -### Update -```json -workspaces-web:UpdateUserSettings, -workspaces-web:TagResource, -workspaces-web:UntagResource, -workspaces-web:GetUserSettings, -workspaces-web:ListTagsForResource, -kms:CreateGrant, -kms:DescribeKey, -kms:GenerateDataKey, -kms:Decrypt -``` - -### Delete -```json -workspaces-web:GetUserSettings, -workspaces-web:DeleteUserSettings, -kms:CreateGrant, -kms:DescribeKey, -kms:GenerateDataKey, -kms:Decrypt -``` - diff --git a/docs/awscc-docs/providers/awscc/xray/group/index.md b/docs/awscc-docs/providers/awscc/xray/group/index.md deleted file mode 100644 index e4640514ca..0000000000 --- a/docs/awscc-docs/providers/awscc/xray/group/index.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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_arnstringThe ARN of the group that was generated on creation.
insights_configurationobject
tagsarray
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -filter_expression, -group_name, -group_arn, -insights_configuration, -tags -FROM awscc.xray.group -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the group resource, the following permissions are required: - -### Read -```json -xray:GetGroup, -xray:ListTagsForResource -``` - -### Update -```json -xray:UpdateGroup, -xray:TagResource, -xray:UntagResource, -xray:ListTagsForResource -``` - -### Delete -```json -xray:DeleteGroup -``` - diff --git a/docs/awscc-docs/providers/awscc/xray/groups/index.md b/docs/awscc-docs/providers/awscc/xray/groups/index.md deleted file mode 100644 index b4187f4328..0000000000 --- a/docs/awscc-docs/providers/awscc/xray/groups/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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_arnstringThe ARN of the group that was generated on creation.
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -group_arn -FROM awscc.xray.groups -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the groups resource, the following permissions are required: - -### Create -```json -xray:CreateGroup, -xray:TagResource -``` - -### List -```json -xray:GetGroups, -xray:ListTagsForResource -``` - diff --git a/docs/awscc-docs/providers/awscc/xray/index.md b/docs/awscc-docs/providers/awscc/xray/index.md deleted file mode 100644 index 2ea66c07e3..0000000000 --- a/docs/awscc-docs/providers/awscc/xray/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -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 deleted file mode 100644 index fab7198932..0000000000 --- a/docs/awscc-docs/providers/awscc/xray/resource_policies/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -policy_name -FROM awscc.xray.resource_policies -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the resource_policies resource, the following permissions are required: - -### Create -```json -xray:PutResourcePolicy, -xray:ListResourcePolicies -``` - -### List -```json -xray:ListResourcePolicies -``` - diff --git a/docs/awscc-docs/providers/awscc/xray/resource_policy/index.md b/docs/awscc-docs/providers/awscc/xray/resource_policy/index.md deleted file mode 100644 index 5e08ddfa4c..0000000000 --- a/docs/awscc-docs/providers/awscc/xray/resource_policy/index.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -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. - -## Example -```sql -SELECT -region, -policy_name, -policy_document, -bypass_policy_lockout_check -FROM awscc.xray.resource_policy -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the resource_policy resource, the following permissions are required: - -### Read -```json -xray:ListResourcePolicies -``` - -### Update -```json -xray:PutResourcePolicy, -xray:ListResourcePolicies -``` - -### Delete -```json -xray:DeleteResourcePolicy -``` - diff --git a/docs/awscc-docs/providers/awscc/xray/sampling_rule/index.md b/docs/awscc-docs/providers/awscc/xray/sampling_rule/index.md deleted file mode 100644 index 7863178400..0000000000 --- a/docs/awscc-docs/providers/awscc/xray/sampling_rule/index.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -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_arnstring
rule_namestring
tagsarray
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -sampling_rule, -sampling_rule_record, -sampling_rule_update, -rule_arn, -rule_name, -tags -FROM awscc.xray.sampling_rule -WHERE data__Identifier = ''; -``` - -## Permissions - -To operate on the sampling_rule resource, the following permissions are required: - -### Read -```json -xray:GetSamplingRules, -xray:ListTagsForResource -``` - -### Update -```json -xray:UpdateSamplingRule, -xray:TagResource, -xray:UntagResource, -xray:ListTagsForResource -``` - -### Delete -```json -xray:DeleteSamplingRule -``` - diff --git a/docs/awscc-docs/providers/awscc/xray/sampling_rules/index.md b/docs/awscc-docs/providers/awscc/xray/sampling_rules/index.md deleted file mode 100644 index 3792bf6da5..0000000000 --- a/docs/awscc-docs/providers/awscc/xray/sampling_rules/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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_arnundefined
regionstringAWS region.
- -## Methods -Currently only SELECT is supported for this resource resource. - -## Example -```sql -SELECT -region, -rule_arn -FROM awscc.xray.sampling_rules -WHERE region = 'us-east-1' -``` - -## Permissions - -To operate on the sampling_rules resource, the following permissions are required: - -### Create -```json -xray:CreateSamplingRule, -xray:TagResource -``` - -### List -```json -xray:GetSamplingRules, -xray:ListTagsForResource -``` - diff --git a/docs/awscc-docs/stackql-provider-registry.mdx b/docs/awscc-docs/stackql-provider-registry.mdx deleted file mode 100644 index 2e8227bf17..0000000000 --- a/docs/awscc-docs/stackql-provider-registry.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: StackQL Provider Registry -hide_title: true -hide_table_of_contents: true -keywords: - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query and Deploy Cloud Infrastructure and Resources using SQL -custom_edit_url: null -image: https://storage.googleapis.com/stackql-web-assets/blog/stackql-blog-post-featured-image.png -slug: / ---- -import RegistryPage from '@site/src/shared/shared-stackql-provider-registry.mdx'; - - - ---- - diff --git a/package.json b/package.json index 2285e8be59..15d38d8d9d 100644 --- a/package.json +++ b/package.json @@ -6,7 +6,6 @@ "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", @@ -28,7 +27,6 @@ "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.sh b/scripts/docgen.sh index 117a2712c5..8fb9d1b689 100644 --- a/scripts/docgen.sh +++ b/scripts/docgen.sh @@ -28,7 +28,11 @@ fi chmod +x stackql # clear .stackql folder -rm -rf ./.stackql +if [ "$version" = "local" ]; then + echo "using local doc version" +else + rm -rf ./.stackql +fi # start server if not running echo "checking if server is running" diff --git a/scripts/docgen/generate_docs.py b/scripts/docgen/generate_docs.py index 1e8827cbaf..d125ea53c5 100644 --- a/scripts/docgen/generate_docs.py +++ b/scripts/docgen/generate_docs.py @@ -55,11 +55,12 @@ def run_command(query): # pull docs for provider print('pulling docs for %s %s' % (provider, provider_ver)) -if provider_ver == "latest": - iql_query = "REGISTRY PULL %s" % provider +if provider_ver == "local": + print("INFO [using local provider docs]") +elif provider_ver == "latest": + run_command("REGISTRY PULL %s" % provider) else: - iql_query = "REGISTRY PULL %s %s" % (provider, provider_ver) -run_command(iql_query) + run_command("REGISTRY PULL %s %s" % (provider, provider_ver)) # get version pulled if provider_ver == "latest": diff --git a/scripts/docgen/provider_data.py b/scripts/docgen/provider_data.py index 43d163c4c3..3ccd0d3f1e 100644 --- a/scripts/docgen/provider_data.py +++ b/scripts/docgen/provider_data.py @@ -178,13 +178,7 @@ }, 'aws': { 'meta_description': 'Query, deploy and manage AWS resources using SQL', - 'description': """EC2, IAM and S3 core AWS Services. -:::tip - -All AWS Services (incl Lambda, DynamoDB, RDS, etc) are supported by the [__`awscc`__](https://awscc.stackql.io/providers/awscc/) (AWS Cloud Control API) provider in StackQL. - -::: - """, + 'description': 'Cloud services by AWS.', 'image': '/img/providers/aws/stackql-aws-provider-featured-image.png' }, 'azure': { diff --git a/sidebars.js b/sidebars.js index 6b5b4bc8be..2e960556cd 100644 --- a/sidebars.js +++ b/sidebars.js @@ -18,7 +18,6 @@ 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 71456a0b8c..87f6d33214 100644 --- a/src/configs/providers.ts +++ b/src/configs/providers.ts @@ -4,8 +4,7 @@ export const providers = [ {name: 'google', description: 'Cloud computing services offered by Google.', title: 'Google'}, {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: 'Core EC2, S3 and IAM services by AWS.', title: 'AWS'}, - {name: 'awscc', description: 'All Cloud computing by Amazon Web Services.', title: 'AWS Cloud Control'}, + {name: 'aws', description: 'Cloud computing services by AWS.', title: 'AWS'}, {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'}, From 2c554651be12619cf692cfcda998253162f1a77d Mon Sep 17 00:00:00 2001 From: Jeffrey Aven Date: Thu, 2 May 2024 18:19:46 +1000 Subject: [PATCH 2/2] new aws --- ci-scripts/get-providers-to-deploy.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ci-scripts/get-providers-to-deploy.js b/ci-scripts/get-providers-to-deploy.js index 0c3e5e6bbe..aa3a4d6ac9 100644 --- a/ci-scripts/get-providers-to-deploy.js +++ b/ci-scripts/get-providers-to-deploy.js @@ -52,7 +52,7 @@ module.exports = async ({ github, context, core, pathOutput }) => { // if(!(diff.startsWith('.github')) || !(diff.startsWith('scripts'))) globalChange = true; - globalChange = false; + globalChange = true; }).filter(Boolean)